(in m32rx patch): Replace "." with "@." when preceeded by a capital letter
[official-gcc.git] / gcc / doc / invoke.texi
blobbf05c075bfde3b479c845dc11cc4f3e74dae364b
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001 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 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 -a  -ax  -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+  -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 @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  -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  -mthreads  -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 -mabi=altivec @gol
445 -mprototype  -mno-prototype @gol
446 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
447 -msdata=@var{opt}  -mvxworks -G @var{num}}
449 @emph{RT Options}
450 @gccoptlist{
451 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
452 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
453 -mminimum-fp-blocks  -mnohc-struct-return}
455 @emph{MIPS Options}
456 @gccoptlist{
457 -mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
458 -mcpu=@var{cpu-type} -membedded-data  -muninit-const-in-rodata @gol
459 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
460 -mgas  -mgp32  -mgp64 @gol
461 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
462 -mips2  -mips3  -mips4  -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
463 -mmips-as  -mmips-tfile  -mno-abicalls @gol
464 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
465 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
466 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
467 -mrnames  -msoft-float @gol
468 -m4650  -msingle-float  -mmad @gol
469 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
470 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi @gol
471 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func}
473 @emph{i386 and x86-64 Options}
474 @gccoptlist{
475 -mcpu=@var{cpu-type}  -march=@var{cpu-type} @gol
476 -mintel-syntax -mieee-fp  -mno-fancy-math-387 @gol
477 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
478 -mno-wide-multiply  -mrtd  -malign-double @gol
479 -mpreferred-stack-boundary=@var{num} @gol
480 -mmmx  -msse  -m3dnow @gol
481 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
482 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
483 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
484 -mno-red-zone@gol
485 -m32 -m64}
487 @emph{HPPA Options}
488 @gccoptlist{
489 -march=@var{architecture-type} @gol
490 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
491 -mfast-indirect-calls  -mgas  -mjump-in-delay @gol
492 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
493 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
494 -mno-jump-in-delay  -mno-long-load-store @gol
495 -mno-portable-runtime  -mno-soft-float @gol
496 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
497 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
498 -mschedule=@var{cpu-type}  -mspace-regs}
500 @emph{Intel 960 Options}
501 @gccoptlist{
502 -m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
503 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
504 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
505 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
506 -mno-complex-addr  -mno-leaf-procedures @gol
507 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
508 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
509 -mtail-call}
511 @emph{DEC Alpha Options}
512 @gccoptlist{
513 -mfp-regs  -mno-fp-regs  -mno-soft-float  -msoft-float @gol
514 -malpha-as  -mgas @gol
515 -mieee  -mieee-with-inexact  -mieee-conformant @gol
516 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
517 -mtrap-precision=@var{mode}  -mbuild-constants @gol
518 -mcpu=@var{cpu-type} @gol
519 -mbwx  -mno-bwx  -mcix  -mno-cix  -mmax  -mno-max @gol
520 -mmemory-latency=@var{time}}
522 @emph{Clipper Options}
523 @gccoptlist{
524 -mc300  -mc400}
526 @emph{H8/300 Options}
527 @gccoptlist{
528 -mrelax  -mh  -ms  -mint32  -malign-300}
530 @emph{SH Options}
531 @gccoptlist{
532 -m1  -m2  -m3  -m3e @gol
533 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
534 -mb  -ml  -mdalign  -mrelax @gol
535 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
536 -mieee  -misize  -mpadstruct  -mspace @gol
537 -mprefergot  -musermode}
539 @emph{System V Options}
540 @gccoptlist{
541 -Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
543 @emph{ARC Options}
544 @gccoptlist{
545 -EB  -EL @gol
546 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
547 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
549 @emph{TMS320C3x/C4x Options}
550 @gccoptlist{
551 -mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
552 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
553 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
554 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
556 @emph{V850 Options}
557 @gccoptlist{
558 -mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
559 -mprolog-function  -mno-prolog-function  -mspace @gol
560 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
561 -mv850  -mbig-switch}
563 @emph{NS32K Options}
564 @gccoptlist{
565 -m32032  -m32332  -m32532  -m32081  -m32381 @gol
566 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
567 -mregparam  -mnoregparam  -msb  -mnosb @gol
568 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
570 @emph{AVR Options}
571 @gccoptlist{
572 -mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
573 -mcall-prologues  -mno-tablejump  -mtiny-stack}
575 @emph{MCore Options}
576 @gccoptlist{
577 -mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
578 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
579 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
580 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
581 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
583 @emph{MMIX Options}
584 @gccoptlist{
585 -mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
586 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
587 -melf}
589 @emph{IA-64 Options}
590 @gccoptlist{
591 -mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
592 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
593 -mconstant-gp  -mauto-pic  -minline-divide-min-latency @gol
594 -minline-divide-max-throughput  -mno-dwarf2-asm @gol
595 -mfixed-range=@var{register-range}}
597 @emph{S/390 and zSeries Options}
598 @gccoptlist{
599 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
600 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
601 -m64 -m31 -mdebug -mno-debug}
603 @emph{CRIS Options}
604 @gccoptlist{
605 -mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
606 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
607 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
608 -mstack-align -mdata-align -mconst-align @gol
609 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
610 -melf -maout -melinux -mlinux -sim -sim2}
612 @item Code Generation Options
613 @xref{Code Gen Options,,Options for Code Generation Conventions}.
614 @gccoptlist{
615 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
616 -ffixed-@var{reg} -fexceptions @gol
617 -fnon-call-exceptions  -funwind-tables -fasynchronous-unwind-tables @gol
618 -finhibit-size-directive  -finstrument-functions @gol
619 -fcheck-memory-usage  -fprefix-function-name @gol
620 -fno-common  -fno-ident  -fno-gnu-linker @gol
621 -fpcc-struct-return  -fpic  -fPIC @gol
622 -freg-struct-return  -fshared-data  -fshort-enums @gol
623 -fshort-double  -fvolatile @gol
624 -fvolatile-global  -fvolatile-static @gol
625 -fverbose-asm  -fpack-struct  -fstack-check @gol
626 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
627 -fargument-alias  -fargument-noalias @gol
628 -fargument-noalias-global  -fleading-underscore}
629 @end table
631 @menu
632 * Overall Options::     Controlling the kind of output:
633                         an executable, object files, assembler files,
634                         or preprocessed source.
635 * C Dialect Options::   Controlling the variant of C language compiled.
636 * C++ Dialect Options:: Variations on C++.
637 * Objective-C Dialect Options:: Variations on Objective-C.
638 * Language Independent Options:: Controlling how diagnostics should be
639                         formatted.
640 * Warning Options::     How picky should the compiler be?
641 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
642 * Optimize Options::    How much optimization?
643 * Preprocessor Options:: Controlling header files and macro definitions.
644                          Also, getting dependency information for Make.
645 * Assembler Options::   Passing options to the assembler.
646 * Link Options::        Specifying libraries and so on.
647 * Directory Options::   Where to find header files and libraries.
648                         Where to find the compiler executable files.
649 * Spec Files::          How to pass switches to sub-processes.
650 * Target Options::      Running a cross-compiler, or an old version of GCC.
651 @end menu
653 @node Overall Options
654 @section Options Controlling the Kind of Output
656 Compilation can involve up to four stages: preprocessing, compilation
657 proper, assembly and linking, always in that order.  The first three
658 stages apply to an individual source file, and end by producing an
659 object file; linking combines all the object files (those newly
660 compiled, and those specified as input) into an executable file.
662 @cindex file name suffix
663 For any given input file, the file name suffix determines what kind of
664 compilation is done:
666 @table @gcctabopt
667 @item @var{file}.c
668 C source code which must be preprocessed.
670 @item @var{file}.i
671 C source code which should not be preprocessed.
673 @item @var{file}.ii
674 C++ source code which should not be preprocessed.
676 @item @var{file}.m
677 Objective-C source code.  Note that you must link with the library
678 @file{libobjc.a} to make an Objective-C program work.
680 @item @var{file}.mi
681 Objective-C source code which should not be preprocessed.
683 @item @var{file}.h
684 C header file (not to be compiled or linked).
686 @item @var{file}.cc
687 @itemx @var{file}.cp
688 @itemx @var{file}.cxx
689 @itemx @var{file}.cpp
690 @itemx @var{file}.c++
691 @itemx @var{file}.C
692 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
693 the last two letters must both be literally @samp{x}.  Likewise,
694 @samp{.C} refers to a literal capital C@.
696 @item @var{file}.f
697 @itemx @var{file}.for
698 @itemx @var{file}.FOR
699 Fortran source code which should not be preprocessed.
701 @item @var{file}.F
702 @itemx @var{file}.fpp
703 @itemx @var{file}.FPP
704 Fortran source code which must be preprocessed (with the traditional
705 preprocessor).
707 @item @var{file}.r
708 Fortran source code which must be preprocessed with a RATFOR
709 preprocessor (not included with GCC)@.
711 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
712 Using and Porting GNU Fortran}, for more details of the handling of
713 Fortran input files.
715 @c FIXME: Descriptions of Java file types.
716 @c @var{file}.java
717 @c @var{file}.class
718 @c @var{file}.zip
719 @c @var{file}.jar
721 @item @var{file}.ads
722 Ada source code file which contains a library unit declaration (a
723 declaration of a package, subprogram, or generic, or a generic
724 instantiation), or a library unit renaming declaration (a package,
725 generic, or subprogram renaming declaration).  Such files are also
726 called @dfn{specs}.
728 @itemx @var{file}.adb
729 Ada source code file containing a library unit body (a subprogram or
730 package body).  Such files are also called @dfn{bodies}.
732 @c GCC also knows about some suffixes for languages not yet included:
733 @c Pascal:
734 @c @var{file}.p
735 @c @var{file}.pas
737 @item @var{file}.ch
738 @itemx @var{file}.chi
739 CHILL source code (preprocessed with the traditional preprocessor).
741 @item @var{file}.s
742 Assembler code.
744 @item @var{file}.S
745 Assembler code which must be preprocessed.
747 @item @var{other}
748 An object file to be fed straight into linking.
749 Any file name with no recognized suffix is treated this way.
750 @end table
752 @opindex x
753 You can specify the input language explicitly with the @option{-x} option:
755 @table @gcctabopt
756 @item -x @var{language}
757 Specify explicitly the @var{language} for the following input files
758 (rather than letting the compiler choose a default based on the file
759 name suffix).  This option applies to all following input files until
760 the next @option{-x} option.  Possible values for @var{language} are:
761 @example
762 c  c-header  cpp-output
763 c++  c++-cpp-output
764 objective-c  objc-cpp-output
765 assembler  assembler-with-cpp
767 chill
768 f77  f77-cpp-input  ratfor
769 java
770 @end example
772 @item -x none
773 Turn off any specification of a language, so that subsequent files are
774 handled according to their file name suffixes (as they are if @option{-x}
775 has not been used at all).
777 @item -pass-exit-codes
778 @opindex pass-exit-codes
779 Normally the @command{gcc} program will exit with the code of 1 if any
780 phase of the compiler returns a non-success return code.  If you specify
781 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
782 numerically highest error produced by any phase that returned an error
783 indication.
784 @end table
786 If you only want some of the stages of compilation, you can use
787 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
788 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
789 @command{gcc} is to stop.  Note that some combinations (for example,
790 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
792 @table @gcctabopt
793 @item -c
794 @opindex c
795 Compile or assemble the source files, but do not link.  The linking
796 stage simply is not done.  The ultimate output is in the form of an
797 object file for each source file.
799 By default, the object file name for a source file is made by replacing
800 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
802 Unrecognized input files, not requiring compilation or assembly, are
803 ignored.
805 @item -S
806 @opindex S
807 Stop after the stage of compilation proper; do not assemble.  The output
808 is in the form of an assembler code file for each non-assembler input
809 file specified.
811 By default, the assembler file name for a source file is made by
812 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
814 Input files that don't require compilation are ignored.
816 @item -E
817 @opindex E
818 Stop after the preprocessing stage; do not run the compiler proper.  The
819 output is in the form of preprocessed source code, which is sent to the
820 standard output.
822 Input files which don't require preprocessing are ignored.
824 @cindex output file option
825 @item -o @var{file}
826 @opindex o
827 Place output in file @var{file}.  This applies regardless to whatever
828 sort of output is being produced, whether it be an executable file,
829 an object file, an assembler file or preprocessed C code.
831 Since only one output file can be specified, it does not make sense to
832 use @option{-o} when compiling more than one input file, unless you are
833 producing an executable file as output.
835 If @option{-o} is not specified, the default is to put an executable file
836 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
837 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
838 all preprocessed C source on standard output.
840 @item -v
841 @opindex v
842 Print (on standard error output) the commands executed to run the stages
843 of compilation.  Also print the version number of the compiler driver
844 program and of the preprocessor and the compiler proper.
846 @item -pipe
847 @opindex pipe
848 Use pipes rather than temporary files for communication between the
849 various stages of compilation.  This fails to work on some systems where
850 the assembler is unable to read from a pipe; but the GNU assembler has
851 no trouble.
853 @item --help
854 @opindex help
855 Print (on the standard output) a description of the command line options
856 understood by @command{gcc}.  If the @option{-v} option is also specified
857 then @option{--help} will also be passed on to the various processes
858 invoked by @command{gcc}, so that they can display the command line options
859 they accept.  If the @option{-W} option is also specified then command
860 line options which have no documentation associated with them will also
861 be displayed.
863 @item --target-help
864 @opindex target-help
865 Print (on the standard output) a description of target specific command
866 line options for each tool.
867 @end table
869 @node Invoking G++
870 @section Compiling C++ Programs
872 @cindex suffixes for C++ source
873 @cindex C++ source file suffixes
874 C++ source files conventionally use one of the suffixes @samp{.C},
875 @samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
876 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
877 files with these names and compiles them as C++ programs even if you
878 call the compiler the same way as for compiling C programs (usually with
879 the name @command{gcc}).
881 @findex g++
882 @findex c++
883 However, C++ programs often require class libraries as well as a
884 compiler that understands the C++ language---and under some
885 circumstances, you might want to compile programs from standard input,
886 or otherwise without a suffix that flags them as C++ programs.
887 @command{g++} is a program that calls GCC with the default language
888 set to C++, and automatically specifies linking against the C++
889 library.  On many systems, @command{g++} is also
890 installed with the name @command{c++}.
892 @cindex invoking @command{g++}
893 When you compile C++ programs, you may specify many of the same
894 command-line options that you use for compiling programs in any
895 language; or command-line options meaningful for C and related
896 languages; or options that are meaningful only for C++ programs.
897 @xref{C Dialect Options,,Options Controlling C Dialect}, for
898 explanations of options for languages related to C@.
899 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
900 explanations of options that are meaningful only for C++ programs.
902 @node C Dialect Options
903 @section Options Controlling C Dialect
904 @cindex dialect options
905 @cindex language dialect options
906 @cindex options, dialect
908 The following options control the dialect of C (or languages derived
909 from C, such as C++ and Objective-C) that the compiler accepts:
911 @table @gcctabopt
912 @cindex ANSI support
913 @cindex ISO support
914 @item -ansi
915 @opindex ansi
916 In C mode, support all ISO C89 programs.  In C++ mode,
917 remove GNU extensions that conflict with ISO C++.
919 This turns off certain features of GCC that are incompatible with ISO
920 C89 (when compiling C code), or of standard C++ (when compiling C++ code),
921 such as the @code{asm} and @code{typeof} keywords, and
922 predefined macros such as @code{unix} and @code{vax} that identify the
923 type of system you are using.  It also enables the undesirable and
924 rarely used ISO trigraph feature.  For the C compiler,
925 it disables recognition of C++ style @samp{//} comments as well as
926 the @code{inline} keyword.
928 The alternate keywords @code{__asm__}, @code{__extension__},
929 @code{__inline__} and @code{__typeof__} continue to work despite
930 @option{-ansi}.  You would not want to use them in an ISO C program, of
931 course, but it is useful to put them in header files that might be included
932 in compilations done with @option{-ansi}.  Alternate predefined macros
933 such as @code{__unix__} and @code{__vax__} are also available, with or
934 without @option{-ansi}.
936 The @option{-ansi} option does not cause non-ISO programs to be
937 rejected gratuitously.  For that, @option{-pedantic} is required in
938 addition to @option{-ansi}.  @xref{Warning Options}.
940 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
941 option is used.  Some header files may notice this macro and refrain
942 from declaring certain functions or defining certain macros that the
943 ISO standard doesn't call for; this is to avoid interfering with any
944 programs that might use these names for other things.
946 Functions which would normally be built in but do not have semantics
947 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
948 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
949 built-in functions provided by GCC}, for details of the functions
950 affected.
952 @item -std=
953 @opindex std
954 Determine the language standard.  This option is currently only
955 supported when compiling C@.  A value for this option must be provided;
956 possible values are
958 @table @samp
959 @item c89
960 @itemx iso9899:1990
961 ISO C89 (same as @option{-ansi}).
963 @item iso9899:199409
964 ISO C89 as modified in amendment 1.
966 @item c99
967 @itemx c9x
968 @itemx iso9899:1999
969 @itemx iso9899:199x
970 ISO C99.  Note that this standard is not yet fully supported; see
971 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
972 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
974 @item gnu89
975 Default, ISO C89 plus GNU extensions (including some C99 features).
977 @item gnu99
978 @item gnu9x
979 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
980 this will become the default.  The name @samp{gnu9x} is deprecated.
982 @end table
984 Even when this option is not specified, you can still use some of the
985 features of newer standards in so far as they do not conflict with
986 previous C standards.  For example, you may use @code{__restrict__} even
987 when @option{-std=c99} is not specified.
989 The @option{-std} options specifying some version of ISO C have the same
990 effects as @option{-ansi}, except that features that were not in ISO C89
991 but are in the specified version (for example, @samp{//} comments and
992 the @code{inline} keyword in ISO C99) are not disabled.
994 @xref{Standards,,Language Standards Supported by GCC}, for details of
995 these standard versions.
997 @item -aux-info @var{filename}
998 @opindex aux-info
999 Output to the given filename prototyped declarations for all functions
1000 declared and/or defined in a translation unit, including those in header
1001 files.  This option is silently ignored in any language other than C@.
1003 Besides declarations, the file indicates, in comments, the origin of
1004 each declaration (source file and line), whether the declaration was
1005 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1006 @samp{O} for old, respectively, in the first character after the line
1007 number and the colon), and whether it came from a declaration or a
1008 definition (@samp{C} or @samp{F}, respectively, in the following
1009 character).  In the case of function definitions, a K&R-style list of
1010 arguments followed by their declarations is also provided, inside
1011 comments, after the declaration.
1013 @item -fno-asm
1014 @opindex fno-asm
1015 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1016 keyword, so that code can use these words as identifiers.  You can use
1017 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1018 instead.  @option{-ansi} implies @option{-fno-asm}.
1020 In C++, this switch only affects the @code{typeof} keyword, since
1021 @code{asm} and @code{inline} are standard keywords.  You may want to
1022 use the @option{-fno-gnu-keywords} flag instead, which has the same
1023 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1024 switch only affects the @code{asm} and @code{typeof} keywords, since
1025 @code{inline} is a standard keyword in ISO C99.
1027 @item -fno-builtin
1028 @itemx -fno-builtin-@var{function} @r{(C and Objective-C only)}
1029 @opindex fno-builtin
1030 @cindex built-in functions
1031 Don't recognize built-in functions that do not begin with
1032 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1033 functions provided by GCC}, for details of the functions affected,
1034 including those which are not built-in functions when @option{-ansi} or
1035 @option{-std} options for strict ISO C conformance are used because they
1036 do not have an ISO standard meaning.
1038 GCC normally generates special code to handle certain built-in functions
1039 more efficiently; for instance, calls to @code{alloca} may become single
1040 instructions that adjust the stack directly, and calls to @code{memcpy}
1041 may become inline copy loops.  The resulting code is often both smaller
1042 and faster, but since the function calls no longer appear as such, you
1043 cannot set a breakpoint on those calls, nor can you change the behavior
1044 of the functions by linking with a different library.
1046 In C++, @option{-fno-builtin} is always in effect.  The @option{-fbuiltin}
1047 option has no effect.  Therefore, in C++, the only way to get the
1048 optimization benefits of built-in functions is to call the function
1049 using the @samp{__builtin_} prefix.  The GNU C++ Standard Library uses
1050 built-in functions to implement many functions (like
1051 @code{std::strchr}), so that you automatically get efficient code.
1053 With the @option{-fno-builtin-@var{function}} option, not available
1054 when compiling C++, only the built-in function @var{function} is
1055 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1056 function is named this is not built-in in this version of GCC, this
1057 option is ignored.  There is no corresponding
1058 @option{-fbuiltin-@var{function}} option; if you wish to enable
1059 built-in functions selectively when using @option{-fno-builtin} or
1060 @option{-ffreestanding}, you may define macros such as:
1062 @smallexample
1063 #define abs(n)          __builtin_abs ((n))
1064 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1065 @end smallexample
1067 @item -fhosted
1068 @opindex fhosted
1069 @cindex hosted environment
1071 Assert that compilation takes place in a hosted environment.  This implies
1072 @option{-fbuiltin}.  A hosted environment is one in which the
1073 entire standard library is available, and in which @code{main} has a return
1074 type of @code{int}.  Examples are nearly everything except a kernel.
1075 This is equivalent to @option{-fno-freestanding}.
1077 @item -ffreestanding
1078 @opindex ffreestanding
1079 @cindex hosted environment
1081 Assert that compilation takes place in a freestanding environment.  This
1082 implies @option{-fno-builtin}.  A freestanding environment
1083 is one in which the standard library may not exist, and program startup may
1084 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1085 This is equivalent to @option{-fno-hosted}.
1087 @xref{Standards,,Language Standards Supported by GCC}, for details of
1088 freestanding and hosted environments.
1090 @item -trigraphs
1091 @opindex trigraphs
1092 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1093 options for strict ISO C conformance) implies @option{-trigraphs}.
1095 @cindex traditional C language
1096 @cindex C language, traditional
1097 @item -traditional
1098 @opindex traditional
1099 Attempt to support some aspects of traditional C compilers.
1100 Specifically:
1102 @itemize @bullet
1103 @item
1104 All @code{extern} declarations take effect globally even if they
1105 are written inside of a function definition.  This includes implicit
1106 declarations of functions.
1108 @item
1109 The newer keywords @code{typeof}, @code{inline}, @code{signed}, @code{const}
1110 and @code{volatile} are not recognized.  (You can still use the
1111 alternative keywords such as @code{__typeof__}, @code{__inline__}, and
1112 so on.)
1114 @item
1115 Comparisons between pointers and integers are always allowed.
1117 @item
1118 Integer types @code{unsigned short} and @code{unsigned char} promote
1119 to @code{unsigned int}.
1121 @item
1122 Out-of-range floating point literals are not an error.
1124 @item
1125 Certain constructs which ISO regards as a single invalid preprocessing
1126 number, such as @samp{0xe-0xd}, are treated as expressions instead.
1128 @item
1129 String ``constants'' are not necessarily constant; they are stored in
1130 writable space, and identical looking constants are allocated
1131 separately.  (This is the same as the effect of
1132 @option{-fwritable-strings}.)
1134 @cindex @code{longjmp} and automatic variables
1135 @item
1136 All automatic variables not declared @code{register} are preserved by
1137 @code{longjmp}.  Ordinarily, GNU C follows ISO C: automatic variables
1138 not declared @code{volatile} may be clobbered.
1140 @item
1141 @cindex @samp{\x}
1142 @cindex @samp{\a}
1143 @cindex escape sequences, traditional
1144 The character escape sequences @samp{\x} and @samp{\a} evaluate as the
1145 literal characters @samp{x} and @samp{a} respectively.  Without
1146 @w{@option{-traditional}}, @samp{\x} is a prefix for the hexadecimal
1147 representation of a character, and @samp{\a} produces a bell.
1148 @end itemize
1150 This option is deprecated and may be removed.
1152 You may wish to use @option{-fno-builtin} as well as @option{-traditional}
1153 if your program uses names that are normally GNU C built-in functions for
1154 other purposes of its own.
1156 You cannot use @option{-traditional} if you include any header files that
1157 rely on ISO C features.  Some vendors are starting to ship systems with
1158 ISO C header files and you cannot use @option{-traditional} on such
1159 systems to compile files that include any system headers.
1161 The @option{-traditional} option also enables @option{-traditional-cpp}.
1163 @item -traditional-cpp
1164 @opindex traditional-cpp
1165 Attempt to support some aspects of traditional C preprocessors.
1166 See the GNU CPP manual for details.
1168 @item -fcond-mismatch
1169 @opindex fcond-mismatch
1170 Allow conditional expressions with mismatched types in the second and
1171 third arguments.  The value of such an expression is void.  This option
1172 is not supported for C++.
1174 @item -funsigned-char
1175 @opindex funsigned-char
1176 Let the type @code{char} be unsigned, like @code{unsigned char}.
1178 Each kind of machine has a default for what @code{char} should
1179 be.  It is either like @code{unsigned char} by default or like
1180 @code{signed char} by default.
1182 Ideally, a portable program should always use @code{signed char} or
1183 @code{unsigned char} when it depends on the signedness of an object.
1184 But many programs have been written to use plain @code{char} and
1185 expect it to be signed, or expect it to be unsigned, depending on the
1186 machines they were written for.  This option, and its inverse, let you
1187 make such a program work with the opposite default.
1189 The type @code{char} is always a distinct type from each of
1190 @code{signed char} or @code{unsigned char}, even though its behavior
1191 is always just like one of those two.
1193 @item -fsigned-char
1194 @opindex fsigned-char
1195 Let the type @code{char} be signed, like @code{signed char}.
1197 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1198 the negative form of @option{-funsigned-char}.  Likewise, the option
1199 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1201 @item -fsigned-bitfields
1202 @itemx -funsigned-bitfields
1203 @itemx -fno-signed-bitfields
1204 @itemx -fno-unsigned-bitfields
1205 @opindex fsigned-bitfields
1206 @opindex funsigned-bitfields
1207 @opindex fno-signed-bitfields
1208 @opindex fno-unsigned-bitfields
1209 These options control whether a bit-field is signed or unsigned, when the
1210 declaration does not use either @code{signed} or @code{unsigned}.  By
1211 default, such a bit-field is signed, because this is consistent: the
1212 basic integer types such as @code{int} are signed types.
1214 However, when @option{-traditional} is used, bit-fields are all unsigned
1215 no matter what.
1217 @item -fwritable-strings
1218 @opindex fwritable-strings
1219 Store string constants in the writable data segment and don't uniquize
1220 them.  This is for compatibility with old programs which assume they can
1221 write into string constants.  The option @option{-traditional} also has
1222 this effect.
1224 Writing into string constants is a very bad idea; ``constants'' should
1225 be constant.
1227 @item -fallow-single-precision
1228 @opindex fallow-single-precision
1229 Do not promote single precision math operations to double precision,
1230 even when compiling with @option{-traditional}.
1232 Traditional K&R C promotes all floating point operations to double
1233 precision, regardless of the sizes of the operands.   On the
1234 architecture for which you are compiling, single precision may be faster
1235 than double precision.   If you must use @option{-traditional}, but want
1236 to use single precision operations when the operands are single
1237 precision, use this option.   This option has no effect when compiling
1238 with ISO or GNU C conventions (the default).
1240 @item -fshort-wchar
1241 @opindex fshort-wchar
1242 Override the underlying type for @samp{wchar_t} to be @samp{short
1243 unsigned int} instead of the default for the target.  This option is
1244 useful for building programs to run under WINE@.
1245 @end table
1247 @node C++ Dialect Options
1248 @section Options Controlling C++ Dialect
1250 @cindex compiler options, C++
1251 @cindex C++ options, command line
1252 @cindex options, C++
1253 This section describes the command-line options that are only meaningful
1254 for C++ programs; but you can also use most of the GNU compiler options
1255 regardless of what language your program is in.  For example, you
1256 might compile a file @code{firstClass.C} like this:
1258 @example
1259 g++ -g -frepo -O -c firstClass.C
1260 @end example
1262 @noindent
1263 In this example, only @option{-frepo} is an option meant
1264 only for C++ programs; you can use the other options with any
1265 language supported by GCC@.
1267 Here is a list of options that are @emph{only} for compiling C++ programs:
1269 @table @gcctabopt
1270 @item -fno-access-control
1271 @opindex fno-access-control
1272 Turn off all access checking.  This switch is mainly useful for working
1273 around bugs in the access control code.
1275 @item -fcheck-new
1276 @opindex fcheck-new
1277 Check that the pointer returned by @code{operator new} is non-null
1278 before attempting to modify the storage allocated.  The current Working
1279 Paper requires that @code{operator new} never return a null pointer, so
1280 this check is normally unnecessary.
1282 An alternative to using this option is to specify that your
1283 @code{operator new} does not throw any exceptions; if you declare it
1284 @samp{throw()}, G++ will check the return value.  See also @samp{new
1285 (nothrow)}.
1287 @item -fconserve-space
1288 @opindex fconserve-space
1289 Put uninitialized or runtime-initialized global variables into the
1290 common segment, as C does.  This saves space in the executable at the
1291 cost of not diagnosing duplicate definitions.  If you compile with this
1292 flag and your program mysteriously crashes after @code{main()} has
1293 completed, you may have an object that is being destroyed twice because
1294 two definitions were merged.
1296 This option is no longer useful on most targets, now that support has
1297 been added for putting variables into BSS without making them common.
1299 @item -fno-const-strings
1300 @opindex fno-const-strings
1301 Give string constants type @code{char *} instead of type @code{const
1302 char *}.  By default, G++ uses type @code{const char *} as required by
1303 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1304 actually modify the value of a string constant, unless you also use
1305 @option{-fwritable-strings}.
1307 This option might be removed in a future release of G++.  For maximum
1308 portability, you should structure your code so that it works with
1309 string constants that have type @code{const char *}.
1311 @item -fdollars-in-identifiers
1312 @opindex fdollars-in-identifiers
1313 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1314 @samp{$} with the option @option{-fno-dollars-in-identifiers}.  (GNU C allows
1315 @samp{$} by default on most target systems, but there are a few exceptions.)
1316 Traditional C allowed the character @samp{$} to form part of
1317 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1319 @item -fno-elide-constructors
1320 @opindex fno-elide-constructors
1321 The C++ standard allows an implementation to omit creating a temporary
1322 which is only used to initialize another object of the same type.
1323 Specifying this option disables that optimization, and forces G++ to
1324 call the copy constructor in all cases.
1326 @item -fno-enforce-eh-specs
1327 @opindex fno-enforce-eh-specs
1328 Don't check for violation of exception specifications at runtime.  This
1329 option violates the C++ standard, but may be useful for reducing code
1330 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1331 will still optimize based on the exception specifications.
1333 @item -fexternal-templates
1334 @opindex fexternal-templates
1336 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1337 template instantiation; template instances are emitted or not according
1338 to the location of the template definition.  @xref{Template
1339 Instantiation}, for more information.
1341 This option is deprecated.
1343 @item -falt-external-templates
1344 @opindex falt-external-templates
1345 Similar to @option{-fexternal-templates}, but template instances are
1346 emitted or not according to the place where they are first instantiated.
1347 @xref{Template Instantiation}, for more information.
1349 This option is deprecated.
1351 @item -ffor-scope
1352 @itemx -fno-for-scope
1353 @opindex ffor-scope
1354 @opindex fno-for-scope
1355 If @option{-ffor-scope} is specified, the scope of variables declared in
1356 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1357 as specified by the C++ standard.
1358 If @option{-fno-for-scope} is specified, the scope of variables declared in
1359 a @i{for-init-statement} extends to the end of the enclosing scope,
1360 as was the case in old versions of G++, and other (traditional)
1361 implementations of C++.
1363 The default if neither flag is given to follow the standard,
1364 but to allow and give a warning for old-style code that would
1365 otherwise be invalid, or have different behavior.
1367 @item -fno-gnu-keywords
1368 @opindex fno-gnu-keywords
1369 Do not recognize @code{typeof} as a keyword, so that code can use this
1370 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1371 @option{-ansi} implies @option{-fno-gnu-keywords}.
1373 @item -fno-implicit-templates
1374 @opindex fno-implicit-templates
1375 Never emit code for non-inline templates which are instantiated
1376 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1377 @xref{Template Instantiation}, for more information.
1379 @item -fno-implicit-inline-templates
1380 @opindex fno-implicit-inline-templates
1381 Don't emit code for implicit instantiations of inline templates, either.
1382 The default is to handle inlines differently so that compiles with and
1383 without optimization will need the same set of explicit instantiations.
1385 @item -fno-implement-inlines
1386 @opindex fno-implement-inlines
1387 To save space, do not emit out-of-line copies of inline functions
1388 controlled by @samp{#pragma implementation}.  This will cause linker
1389 errors if these functions are not inlined everywhere they are called.
1391 @item -fms-extensions
1392 @opindex fms-extensions
1393 Disable pedantic warnings about constructs used in MFC, such as implicit
1394 int and getting a pointer to member function via non-standard syntax.
1396 @item -fno-nonansi-builtins
1397 @opindex fno-nonansi-builtins
1398 Disable built-in declarations of functions that are not mandated by
1399 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1400 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1402 @item -fno-operator-names
1403 @opindex fno-operator-names
1404 Do not treat the operator name keywords @code{and}, @code{bitand},
1405 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1406 synonyms as keywords.
1408 @item -fno-optional-diags
1409 @opindex fno-optional-diags
1410 Disable diagnostics that the standard says a compiler does not need to
1411 issue.  Currently, the only such diagnostic issued by G++ is the one for
1412 a name having multiple meanings within a class.
1414 @item -fpermissive
1415 @opindex fpermissive
1416 Downgrade messages about nonconformant code from errors to warnings.  By
1417 default, G++ effectively sets @option{-pedantic-errors} without
1418 @option{-pedantic}; this option reverses that.  This behavior and this
1419 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1421 @item -frepo
1422 @opindex frepo
1423 Enable automatic template instantiation at link time.  This option also
1424 implies @option{-fno-implicit-templates}.  @xref{Template
1425 Instantiation}, for more information.
1427 @item -fno-rtti
1428 @opindex fno-rtti
1429 Disable generation of information about every class with virtual
1430 functions for use by the C++ runtime type identification features
1431 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1432 of the language, you can save some space by using this flag.  Note that
1433 exception handling uses the same information, but it will generate it as
1434 needed.
1436 @item -fstats
1437 @opindex fstats
1438 Emit statistics about front-end processing at the end of the compilation.
1439 This information is generally only useful to the G++ development team.
1441 @item -ftemplate-depth-@var{n}
1442 @opindex ftemplate-depth
1443 Set the maximum instantiation depth for template classes to @var{n}.
1444 A limit on the template instantiation depth is needed to detect
1445 endless recursions during template class instantiation.  ANSI/ISO C++
1446 conforming programs must not rely on a maximum depth greater than 17.
1448 @item -fuse-cxa-atexit
1449 @opindex fuse-cxa-atexit
1450 Register destructors for objects with static storage duration with the
1451 @code{__cxa_atexit} function rather than the @code{atexit} function.
1452 This option is required for fully standards-compliant handling of static
1453 destructors, but will only work if your C library supports
1454 @code{__cxa_atexit}.
1456 @item -fvtable-gc
1457 @opindex fvtable-gc
1458 Emit special relocations for vtables and virtual function references
1459 so that the linker can identify unused virtual functions and zero out
1460 vtable slots that refer to them.  This is most useful with
1461 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1462 also discard the functions themselves.
1464 This optimization requires GNU as and GNU ld.  Not all systems support
1465 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1467 @item -fno-weak
1468 @opindex fno-weak
1469 Do not use weak symbol support, even if it is provided by the linker.
1470 By default, G++ will use weak symbols if they are available.  This
1471 option exists only for testing, and should not be used by end-users;
1472 it will result in inferior code and has no benefits.  This option may
1473 be removed in a future release of G++.
1475 @item -nostdinc++
1476 @opindex nostdinc++
1477 Do not search for header files in the standard directories specific to
1478 C++, but do still search the other standard directories.  (This option
1479 is used when building the C++ library.)
1480 @end table
1482 In addition, these optimization, warning, and code generation options
1483 have meanings only for C++ programs:
1485 @table @gcctabopt
1486 @item -fno-default-inline
1487 @opindex fno-default-inline
1488 Do not assume @samp{inline} for functions defined inside a class scope.
1489 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1490 functions will have linkage like inline functions; they just won't be
1491 inlined by default.
1493 @item -Wctor-dtor-privacy @r{(C++ only)}
1494 @opindex Wctor-dtor-privacy
1495 Warn when a class seems unusable, because all the constructors or
1496 destructors in a class are private and the class has no friends or
1497 public static member functions.
1499 @item -Wnon-virtual-dtor @r{(C++ only)}
1500 @opindex Wnon-virtual-dtor
1501 Warn when a class declares a non-virtual destructor that should probably
1502 be virtual, because it looks like the class will be used polymorphically.
1504 @item -Wreorder @r{(C++ only)}
1505 @opindex Wreorder
1506 @cindex reordering, warning
1507 @cindex warning for reordering of member initializers
1508 Warn when the order of member initializers given in the code does not
1509 match the order in which they must be executed.  For instance:
1511 @smallexample
1512 struct A @{
1513   int i;
1514   int j;
1515   A(): j (0), i (1) @{ @}
1517 @end smallexample
1519 Here the compiler will warn that the member initializers for @samp{i}
1520 and @samp{j} will be rearranged to match the declaration order of the
1521 members.
1522 @end table
1524 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1526 @table @gcctabopt
1527 @item -Weffc++ @r{(C++ only)}
1528 @opindex Weffc++
1529 Warn about violations of various style guidelines from Scott Meyers'
1530 @cite{Effective C++} books.  If you use this option, you should be aware
1531 that the standard library headers do not obey all of these guidelines;
1532 you can use @samp{grep -v} to filter out those warnings.
1534 @item -Wno-deprecated @r{(C++ only)}
1535 @opindex Wno-deprecated
1536 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1538 @item -Wno-non-template-friend @r{(C++ only)}
1539 @opindex Wno-non-template-friend
1540 Disable warnings when non-templatized friend functions are declared
1541 within a template.  With the advent of explicit template specification
1542 support in G++, if the name of the friend is an unqualified-id (i.e.,
1543 @samp{friend foo(int)}), the C++ language specification demands that the
1544 friend declare or define an ordinary, nontemplate function.  (Section
1545 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1546 could be interpreted as a particular specialization of a templatized
1547 function.  Because this non-conforming behavior is no longer the default
1548 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1549 check existing code for potential trouble spots, and is on by default.
1550 This new compiler behavior can be turned off with
1551 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1552 but disables the helpful warning.
1554 @item -Wold-style-cast @r{(C++ only)}
1555 @opindex Wold-style-cast
1556 Warn if an old-style (C-style) cast is used within a C++ program.  The
1557 new-style casts (@samp{static_cast}, @samp{reinterpret_cast}, and
1558 @samp{const_cast}) are less vulnerable to unintended effects, and much
1559 easier to grep for.
1561 @item -Woverloaded-virtual @r{(C++ only)}
1562 @opindex Woverloaded-virtual
1563 @cindex overloaded virtual fn, warning
1564 @cindex warning for overloaded virtual fn
1565 Warn when a function declaration hides virtual functions from a
1566 base class.  For example, in:
1568 @smallexample
1569 struct A @{
1570   virtual void f();
1573 struct B: public A @{
1574   void f(int);
1576 @end smallexample
1578 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1579 like this:
1581 @smallexample
1582 B* b;
1583 b->f();
1584 @end smallexample
1586 will fail to compile.
1588 @item -Wno-pmf-conversions @r{(C++ only)}
1589 @opindex Wno-pmf-conversions
1590 Disable the diagnostic for converting a bound pointer to member function
1591 to a plain pointer.
1593 @item -Wsign-promo @r{(C++ only)}
1594 @opindex Wsign-promo
1595 Warn when overload resolution chooses a promotion from unsigned or
1596 enumeral type to a signed type over a conversion to an unsigned type of
1597 the same size.  Previous versions of G++ would try to preserve
1598 unsignedness, but the standard mandates the current behavior.
1600 @item -Wsynth @r{(C++ only)}
1601 @opindex Wsynth
1602 @cindex warning for synthesized methods
1603 @cindex synthesized methods, warning
1604 Warn when G++'s synthesis behavior does not match that of cfront.  For
1605 instance:
1607 @smallexample
1608 struct A @{
1609   operator int ();
1610   A& operator = (int);
1613 main ()
1615   A a,b;
1616   a = b;
1618 @end smallexample
1620 In this example, G++ will synthesize a default @samp{A& operator =
1621 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1622 @end table
1624 @node Objective-C Dialect Options
1625 @section Options Controlling Objective-C Dialect
1627 @cindex compiler options, Objective-C
1628 @cindex Objective-C options, command line
1629 @cindex options, Objective-C
1630 This section describes the command-line options that are only meaningful
1631 for Objective-C programs; but you can also use most of the GNU compiler
1632 options regardless of what language your program is in.  For example,
1633 you might compile a file @code{some_class.m} like this:
1635 @example
1636 gcc -g -fgnu-runtime -O -c some_class.m
1637 @end example
1639 @noindent
1640 In this example, only @option{-fgnu-runtime} is an option meant only for
1641 Objective-C programs; you can use the other options with any language
1642 supported by GCC@.
1644 Here is a list of options that are @emph{only} for compiling Objective-C
1645 programs:
1647 @table @gcctabopt
1648 @item -fconstant-string-class=@var{class-name}
1649 @opindex fconstant-string-class
1650 Use @var{class-name} as the name of the class to instantiate for each
1651 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1652 class name is @code{NXConstantString}.
1654 @item -fgnu-runtime
1655 @opindex fgnu-runtime
1656 Generate object code compatible with the standard GNU Objective-C
1657 runtime.  This is the default for most types of systems.
1659 @item -fnext-runtime
1660 @opindex fnext-runtime
1661 Generate output compatible with the NeXT runtime.  This is the default
1662 for NeXT-based systems, including Darwin and Mac OS X@.
1664 @item -gen-decls
1665 @opindex gen-decls
1666 Dump interface declarations for all classes seen in the source file to a
1667 file named @file{@var{sourcename}.decl}.
1669 @item -Wno-protocol
1670 @opindex Wno-protocol
1671 Do not warn if methods required by a protocol are not implemented
1672 in the class adopting it.
1674 @item -Wselector
1675 @opindex Wselector
1676 Warn if a selector has multiple methods of different types defined.
1678 @c not documented because only avail via -Wp
1679 @c @item -print-objc-runtime-info
1681 @end table
1683 @node Language Independent Options
1684 @section Options to Control Diagnostic Messages Formatting
1685 @cindex options to control diagnostics formatting
1686 @cindex diagnostic messages
1687 @cindex message formatting
1689 Traditionally, diagnostic messages have been formatted irrespective of
1690 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1691 below can be used to control the diagnostic messages formatting
1692 algorithm, e.g.@: how many characters per line, how often source location
1693 information should be reported.  Right now, only the C++ front end can
1694 honor these options.  However it is expected, in the near future, that
1695 the remaining front ends would be able to digest them correctly.
1697 @table @gcctabopt
1698 @item -fmessage-length=@var{n}
1699 @opindex fmessage-length
1700 Try to format error messages so that they fit on lines of about @var{n}
1701 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1702 the front ends supported by GCC@.  If @var{n} is zero, then no
1703 line-wrapping will be done; each error message will appear on a single
1704 line.
1706 @opindex fdiagnostics-show-location
1707 @item -fdiagnostics-show-location=once
1708 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1709 reporter to emit @emph{once} source location information; that is, in
1710 case the message is too long to fit on a single physical line and has to
1711 be wrapped, the source location won't be emitted (as prefix) again,
1712 over and over, in subsequent continuation lines.  This is the default
1713 behaviour.
1715 @item -fdiagnostics-show-location=every-line
1716 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1717 messages reporter to emit the same source location information (as
1718 prefix) for physical lines that result from the process of breaking
1719 a message which is too long to fit on a single line.
1721 @end table
1723 @node Warning Options
1724 @section Options to Request or Suppress Warnings
1725 @cindex options to control warnings
1726 @cindex warning messages
1727 @cindex messages, warning
1728 @cindex suppressing warnings
1730 Warnings are diagnostic messages that report constructions which
1731 are not inherently erroneous but which are risky or suggest there
1732 may have been an error.
1734 You can request many specific warnings with options beginning @samp{-W},
1735 for example @option{-Wimplicit} to request warnings on implicit
1736 declarations.  Each of these specific warning options also has a
1737 negative form beginning @samp{-Wno-} to turn off warnings;
1738 for example, @option{-Wno-implicit}.  This manual lists only one of the
1739 two forms, whichever is not the default.
1741 These options control the amount and kinds of warnings produced by GCC:
1743 @table @gcctabopt
1744 @cindex syntax checking
1745 @item -fsyntax-only
1746 @opindex fsyntax-only
1747 Check the code for syntax errors, but don't do anything beyond that.
1749 @item -pedantic
1750 @opindex pedantic
1751 Issue all the warnings demanded by strict ISO C and ISO C++;
1752 reject all programs that use forbidden extensions, and some other
1753 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1754 version of the ISO C standard specified by any @option{-std} option used.
1756 Valid ISO C and ISO C++ programs should compile properly with or without
1757 this option (though a rare few will require @option{-ansi} or a
1758 @option{-std} option specifying the required version of ISO C)@.  However,
1759 without this option, certain GNU extensions and traditional C and C++
1760 features are supported as well.  With this option, they are rejected.
1762 @option{-pedantic} does not cause warning messages for use of the
1763 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1764 warnings are also disabled in the expression that follows
1765 @code{__extension__}.  However, only system header files should use
1766 these escape routes; application programs should avoid them.
1767 @xref{Alternate Keywords}.
1769 Some users try to use @option{-pedantic} to check programs for strict ISO
1770 C conformance.  They soon find that it does not do quite what they want:
1771 it finds some non-ISO practices, but not all---only those for which
1772 ISO C @emph{requires} a diagnostic, and some others for which
1773 diagnostics have been added.
1775 A feature to report any failure to conform to ISO C might be useful in
1776 some instances, but would require considerable additional work and would
1777 be quite different from @option{-pedantic}.  We don't have plans to
1778 support such a feature in the near future.
1780 Where the standard specified with @option{-std} represents a GNU
1781 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1782 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1783 extended dialect is based.  Warnings from @option{-pedantic} are given
1784 where they are required by the base standard.  (It would not make sense
1785 for such warnings to be given only for features not in the specified GNU
1786 C dialect, since by definition the GNU dialects of C include all
1787 features the compiler supports with the given option, and there would be
1788 nothing to warn about.)
1790 @item -pedantic-errors
1791 @opindex pedantic-errors
1792 Like @option{-pedantic}, except that errors are produced rather than
1793 warnings.
1795 @item -w
1796 @opindex w
1797 Inhibit all warning messages.
1799 @item -Wno-import
1800 @opindex Wno-import
1801 Inhibit warning messages about the use of @samp{#import}.
1803 @item -Wchar-subscripts
1804 @opindex Wchar-subscripts
1805 Warn if an array subscript has type @code{char}.  This is a common cause
1806 of error, as programmers often forget that this type is signed on some
1807 machines.
1809 @item -Wcomment
1810 @opindex Wcomment
1811 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1812 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1814 @item -Wformat
1815 @opindex Wformat
1816 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1817 the arguments supplied have types appropriate to the format string
1818 specified, and that the conversions specified in the format string make
1819 sense.  This includes standard functions, and others specified by format
1820 attributes (@pxref{Function Attributes}), in the @code{printf},
1821 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1822 not in the C standard) families.
1824 The formats are checked against the format features supported by GNU
1825 libc version 2.2.  These include all ISO C89 and C99 features, as well
1826 as features from the Single Unix Specification and some BSD and GNU
1827 extensions.  Other library implementations may not support all these
1828 features; GCC does not support warning about features that go beyond a
1829 particular library's limitations.  However, if @option{-pedantic} is used
1830 with @option{-Wformat}, warnings will be given about format features not
1831 in the selected standard version (but not for @code{strfmon} formats,
1832 since those are not in any version of the C standard).  @xref{C Dialect
1833 Options,,Options Controlling C Dialect}.
1835 @option{-Wformat} is included in @option{-Wall}.  For more control over some
1836 aspects of format checking, the options @option{-Wno-format-y2k},
1837 @option{-Wno-format-extra-args}, @option{-Wformat-nonliteral},
1838 @option{-Wformat-security} and @option{-Wformat=2} are available, but are
1839 not included in @option{-Wall}.
1841 @item -Wno-format-y2k
1842 @opindex Wno-format-y2k
1843 If @option{-Wformat} is specified, do not warn about @code{strftime}
1844 formats which may yield only a two-digit year.
1846 @item -Wno-format-extra-args
1847 @opindex Wno-format-extra-args
1848 If @option{-Wformat} is specified, do not warn about excess arguments to a
1849 @code{printf} or @code{scanf} format function.  The C standard specifies
1850 that such arguments are ignored.
1852 @item -Wformat-nonliteral
1853 @opindex Wformat-nonliteral
1854 If @option{-Wformat} is specified, also warn if the format string is not a
1855 string literal and so cannot be checked, unless the format function
1856 takes its format arguments as a @code{va_list}.
1858 @item -Wformat-security
1859 @opindex Wformat-security
1860 If @option{-Wformat} is specified, also warn about uses of format
1861 functions that represent possible security problems.  At present, this
1862 warns about calls to @code{printf} and @code{scanf} functions where the
1863 format string is not a string literal and there are no format arguments,
1864 as in @code{printf (foo);}.  This may be a security hole if the format
1865 string came from untrusted input and contains @samp{%n}.  (This is
1866 currently a subset of what @option{-Wformat-nonliteral} warns about, but
1867 in future warnings may be added to @option{-Wformat-security} that are not
1868 included in @option{-Wformat-nonliteral}.)
1870 @item -Wformat=2
1871 @opindex Wformat=2
1872 Enable @option{-Wformat} plus format checks not included in
1873 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
1874 -Wformat-nonliteral -Wformat-security}.
1876 @item -Wimplicit-int
1877 @opindex Wimplicit-int
1878 Warn when a declaration does not specify a type.
1880 @item -Wimplicit-function-declaration
1881 @itemx -Werror-implicit-function-declaration
1882 @opindex Wimplicit-function-declaration
1883 @opindex Werror-implicit-function-declaration
1884 Give a warning (or error) whenever a function is used before being
1885 declared.
1887 @item -Wimplicit
1888 @opindex Wimplicit
1889 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
1891 @item -Wmain
1892 @opindex Wmain
1893 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
1894 function with external linkage, returning int, taking either zero
1895 arguments, two, or three arguments of appropriate types.
1897 @item -Wmissing-braces
1898 @opindex Wmissing-braces
1899 Warn if an aggregate or union initializer is not fully bracketed.  In
1900 the following example, the initializer for @samp{a} is not fully
1901 bracketed, but that for @samp{b} is fully bracketed.
1903 @smallexample
1904 int a[2][2] = @{ 0, 1, 2, 3 @};
1905 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
1906 @end smallexample
1908 @item -Wparentheses
1909 @opindex Wparentheses
1910 Warn if parentheses are omitted in certain contexts, such
1911 as when there is an assignment in a context where a truth value
1912 is expected, or when operators are nested whose precedence people
1913 often get confused about.
1915 Also warn about constructions where there may be confusion to which
1916 @code{if} statement an @code{else} branch belongs.  Here is an example of
1917 such a case:
1919 @smallexample
1920 @group
1922   if (a)
1923     if (b)
1924       foo ();
1925   else
1926     bar ();
1928 @end group
1929 @end smallexample
1931 In C, every @code{else} branch belongs to the innermost possible @code{if}
1932 statement, which in this example is @code{if (b)}.  This is often not
1933 what the programmer expected, as illustrated in the above example by
1934 indentation the programmer chose.  When there is the potential for this
1935 confusion, GCC will issue a warning when this flag is specified.
1936 To eliminate the warning, add explicit braces around the innermost
1937 @code{if} statement so there is no way the @code{else} could belong to
1938 the enclosing @code{if}.  The resulting code would look like this:
1940 @smallexample
1941 @group
1943   if (a)
1944     @{
1945       if (b)
1946         foo ();
1947       else
1948         bar ();
1949     @}
1951 @end group
1952 @end smallexample
1954 @item -Wsequence-point
1955 @opindex Wsequence-point
1956 Warn about code that may have undefined semantics because of violations
1957 of sequence point rules in the C standard.
1959 The C standard defines the order in which expressions in a C program are
1960 evaluated in terms of @dfn{sequence points}, which represent a partial
1961 ordering between the execution of parts of the program: those executed
1962 before the sequence point, and those executed after it.  These occur
1963 after the evaluation of a full expression (one which is not part of a
1964 larger expression), after the evaluation of the first operand of a
1965 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
1966 function is called (but after the evaluation of its arguments and the
1967 expression denoting the called function), and in certain other places.
1968 Other than as expressed by the sequence point rules, the order of
1969 evaluation of subexpressions of an expression is not specified.  All
1970 these rules describe only a partial order rather than a total order,
1971 since, for example, if two functions are called within one expression
1972 with no sequence point between them, the order in which the functions
1973 are called is not specified.  However, the standards committee have
1974 ruled that function calls do not overlap.
1976 It is not specified when between sequence points modifications to the
1977 values of objects take effect.  Programs whose behavior depends on this
1978 have undefined behavior; the C standard specifies that ``Between the
1979 previous and next sequence point an object shall have its stored value
1980 modified at most once by the evaluation of an expression.  Furthermore,
1981 the prior value shall be read only to determine the value to be
1982 stored.''.  If a program breaks these rules, the results on any
1983 particular implementation are entirely unpredictable.
1985 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
1986 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
1987 diagnosed by this option, and it may give an occasional false positive
1988 result, but in general it has been found fairly effective at detecting
1989 this sort of problem in programs.
1991 The present implementation of this option only works for C programs.  A
1992 future implementation may also work for C++ programs.
1994 The C standard is worded confusingly, therefore there is some debate
1995 over the precise meaning of the sequence point rules in subtle cases.
1996 Links to discussions of the problem, including proposed formal
1997 definitions, may be found on our readings page, at
1998 @w{@uref{http://gcc.gnu.org/readings.html}}.
2000 @item -Wreturn-type
2001 @opindex Wreturn-type
2002 Warn whenever a function is defined with a return-type that defaults to
2003 @code{int}.  Also warn about any @code{return} statement with no
2004 return-value in a function whose return-type is not @code{void}.
2006 For C++, a function without return type always produces a diagnostic
2007 message, even when @option{-Wno-return-type} is specified.  The only
2008 exceptions are @samp{main} and functions defined in system headers.
2010 @item -Wswitch
2011 @opindex Wswitch
2012 Warn whenever a @code{switch} statement has an index of enumeral type
2013 and lacks a @code{case} for one or more of the named codes of that
2014 enumeration.  (The presence of a @code{default} label prevents this
2015 warning.)  @code{case} labels outside the enumeration range also
2016 provoke warnings when this option is used.
2018 @item -Wtrigraphs
2019 @opindex Wtrigraphs
2020 Warn if any trigraphs are encountered that might change the meaning of
2021 the program (trigraphs within comments are not warned about).
2023 @item -Wunused-function
2024 @opindex Wunused-function
2025 Warn whenever a static function is declared but not defined or a
2026 non\-inline static function is unused.
2028 @item -Wunused-label
2029 @opindex Wunused-label
2030 Warn whenever a label is declared but not used.
2032 To suppress this warning use the @samp{unused} attribute
2033 (@pxref{Variable Attributes}).
2035 @item -Wunused-parameter
2036 @opindex Wunused-parameter
2037 Warn whenever a function parameter is unused aside from its declaration.
2039 To suppress this warning use the @samp{unused} attribute
2040 (@pxref{Variable Attributes}).
2042 @item -Wunused-variable
2043 @opindex Wunused-variable
2044 Warn whenever a local variable or non-constant static variable is unused
2045 aside from its declaration
2047 To suppress this warning use the @samp{unused} attribute
2048 (@pxref{Variable Attributes}).
2050 @item -Wunused-value
2051 @opindex Wunused-value
2052 Warn whenever a statement computes a result that is explicitly not used.
2054 To suppress this warning cast the expression to @samp{void}.
2056 @item -Wunused
2057 @opindex Wunused
2058 All all the above @option{-Wunused} options combined.
2060 In order to get a warning about an unused function parameter, you must
2061 either specify @samp{-W -Wunused} or separately specify
2062 @option{-Wunused-parameter}.
2064 @item -Wuninitialized
2065 @opindex Wuninitialized
2066 Warn if an automatic variable is used without first being initialized or
2067 if a variable may be clobbered by a @code{setjmp} call.
2069 These warnings are possible only in optimizing compilation,
2070 because they require data flow information that is computed only
2071 when optimizing.  If you don't specify @option{-O}, you simply won't
2072 get these warnings.
2074 These warnings occur only for variables that are candidates for
2075 register allocation.  Therefore, they do not occur for a variable that
2076 is declared @code{volatile}, or whose address is taken, or whose size
2077 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2078 structures, unions or arrays, even when they are in registers.
2080 Note that there may be no warning about a variable that is used only
2081 to compute a value that itself is never used, because such
2082 computations may be deleted by data flow analysis before the warnings
2083 are printed.
2085 These warnings are made optional because GCC is not smart
2086 enough to see all the reasons why the code might be correct
2087 despite appearing to have an error.  Here is one example of how
2088 this can happen:
2090 @smallexample
2091 @group
2093   int x;
2094   switch (y)
2095     @{
2096     case 1: x = 1;
2097       break;
2098     case 2: x = 4;
2099       break;
2100     case 3: x = 5;
2101     @}
2102   foo (x);
2104 @end group
2105 @end smallexample
2107 @noindent
2108 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2109 always initialized, but GCC doesn't know this.  Here is
2110 another common case:
2112 @smallexample
2114   int save_y;
2115   if (change_y) save_y = y, y = new_y;
2116   @dots{}
2117   if (change_y) y = save_y;
2119 @end smallexample
2121 @noindent
2122 This has no bug because @code{save_y} is used only if it is set.
2124 @cindex @code{longjmp} warnings
2125 This option also warns when a non-volatile automatic variable might be
2126 changed by a call to @code{longjmp}.  These warnings as well are possible
2127 only in optimizing compilation.
2129 The compiler sees only the calls to @code{setjmp}.  It cannot know
2130 where @code{longjmp} will be called; in fact, a signal handler could
2131 call it at any point in the code.  As a result, you may get a warning
2132 even when there is in fact no problem because @code{longjmp} cannot
2133 in fact be called at the place which would cause a problem.
2135 Some spurious warnings can be avoided if you declare all the functions
2136 you use that never return as @code{noreturn}.  @xref{Function
2137 Attributes}.
2139 @item -Wreorder @r{(C++ only)}
2140 @opindex Wreorder
2141 @cindex reordering, warning
2142 @cindex warning for reordering of member initializers
2143 Warn when the order of member initializers given in the code does not
2144 match the order in which they must be executed.  For instance:
2146 @item -Wunknown-pragmas
2147 @opindex Wunknown-pragmas
2148 @cindex warning for unknown pragmas
2149 @cindex unknown pragmas, warning
2150 @cindex pragmas, warning of unknown
2151 Warn when a #pragma directive is encountered which is not understood by
2152 GCC@.  If this command line option is used, warnings will even be issued
2153 for unknown pragmas in system header files.  This is not the case if
2154 the warnings were only enabled by the @option{-Wall} command line option.
2156 @item -Wall
2157 @opindex Wall
2158 All of the above @samp{-W} options combined.  This enables all the
2159 warnings about constructions that some users consider questionable, and
2160 that are easy to avoid (or modify to prevent the warning), even in
2161 conjunction with macros.
2163 @item -Wdiv-by-zero
2164 @opindex Wno-div-by-zero
2165 @opindex Wdiv-by-zero
2166 Warn about compile-time integer division by zero.  This is default.  To
2167 inhibit the warning messages, use @option{-Wno-div-by-zero}.  Floating
2168 point division by zero is not warned about, as it can be a legitimate
2169 way of obtaining infinities and NaNs.
2171 @item -Wmultichar
2172 @opindex Wno-multichar
2173 @opindex Wmultichar
2174 Warn if a multicharacter constant (@samp{'FOOF'}) is used.  This is
2175 default.  To inhibit the warning messages, use @option{-Wno-multichar}.
2176 Usually they indicate a typo in the user's code, as they have
2177 implementation-defined values, and should not be used in portable code.
2179 @item -Wsystem-headers
2180 @opindex Wsystem-headers
2181 @cindex warnings from system headers
2182 @cindex system headers, warnings from
2183 Print warning messages for constructs found in system header files.
2184 Warnings from system headers are normally suppressed, on the assumption
2185 that they usually do not indicate real problems and would only make the
2186 compiler output harder to read.  Using this command line option tells
2187 GCC to emit warnings from system headers as if they occurred in user
2188 code.  However, note that using @option{-Wall} in conjunction with this
2189 option will @emph{not} warn about unknown pragmas in system
2190 headers---for that, @option{-Wunknown-pragmas} must also be used.
2191 @end table
2193 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2194 Some of them warn about constructions that users generally do not
2195 consider questionable, but which occasionally you might wish to check
2196 for; others warn about constructions that are necessary or hard to avoid
2197 in some cases, and there is no simple way to modify the code to suppress
2198 the warning.
2200 @table @gcctabopt
2201 @item -W
2202 @opindex W
2203 Print extra warning messages for these events:
2205 @itemize @bullet
2206 @item
2207 A function can return either with or without a value.  (Falling
2208 off the end of the function body is considered returning without
2209 a value.)  For example, this function would evoke such a
2210 warning:
2212 @smallexample
2213 @group
2214 foo (a)
2216   if (a > 0)
2217     return a;
2219 @end group
2220 @end smallexample
2222 @item
2223 An expression-statement or the left-hand side of a comma expression
2224 contains no side effects.
2225 To suppress the warning, cast the unused expression to void.
2226 For example, an expression such as @samp{x[i,j]} will cause a warning,
2227 but @samp{x[(void)i,j]} will not.
2229 @item
2230 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
2232 @item
2233 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2234 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2235 that of ordinary mathematical notation.
2237 @item
2238 Storage-class specifiers like @code{static} are not the first things in
2239 a declaration.  According to the C Standard, this usage is obsolescent.
2241 @item
2242 The return type of a function has a type qualifier such as @code{const}.
2243 Such a type qualifier has no effect, since the value returned by a
2244 function is not an lvalue.  (But don't warn about the GNU extension of
2245 @code{volatile void} return types.  That extension will be warned about
2246 if @option{-pedantic} is specified.)
2248 @item
2249 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2250 arguments.
2252 @item
2253 A comparison between signed and unsigned values could produce an
2254 incorrect result when the signed value is converted to unsigned.
2255 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2257 @item
2258 An aggregate has a partly bracketed initializer.
2259 For example, the following code would evoke such a warning,
2260 because braces are missing around the initializer for @code{x.h}:
2262 @smallexample
2263 struct s @{ int f, g; @};
2264 struct t @{ struct s h; int i; @};
2265 struct t x = @{ 1, 2, 3 @};
2266 @end smallexample
2268 @item
2269 An aggregate has an initializer which does not initialize all members.
2270 For example, the following code would cause such a warning, because
2271 @code{x.h} would be implicitly initialized to zero:
2273 @smallexample
2274 struct s @{ int f, g, h; @};
2275 struct s x = @{ 3, 4 @};
2276 @end smallexample
2277 @end itemize
2279 @item -Wfloat-equal
2280 @opindex Wfloat-equal
2281 Warn if floating point values are used in equality comparisons.
2283 The idea behind this is that sometimes it is convenient (for the
2284 programmer) to consider floating-point values as approximations to
2285 infinitely precise real numbers.  If you are doing this, then you need
2286 to compute (by analysing the code, or in some other way) the maximum or
2287 likely maximum error that the computation introduces, and allow for it
2288 when performing comparisons (and when producing output, but that's a
2289 different problem).  In particular, instead of testing for equality, you
2290 would check to see whether the two values have ranges that overlap; and
2291 this is done with the relational operators, so equality comparisons are
2292 probably mistaken.
2294 @item -Wtraditional @r{(C only)}
2295 @opindex Wtraditional
2296 Warn about certain constructs that behave differently in traditional and
2297 ISO C@.  Also warn about ISO C constructs that have no traditional C
2298 equivalent, and/or problematic constructs which should be avoided.
2300 @itemize @bullet
2301 @item
2302 Macro parameters that appear within string literals in the macro body.
2303 In traditional C macro replacement takes place within string literals,
2304 but does not in ISO C@.
2306 @item
2307 In traditional C, some preprocessor directives did not exist.
2308 Traditional preprocessors would only consider a line to be a directive
2309 if the @samp{#} appeared in column 1 on the line.  Therefore
2310 @option{-Wtraditional} warns about directives that traditional C
2311 understands but would ignore because the @samp{#} does not appear as the
2312 first character on the line.  It also suggests you hide directives like
2313 @samp{#pragma} not understood by traditional C by indenting them.  Some
2314 traditional implementations would not recognise @samp{#elif}, so it
2315 suggests avoiding it altogether.
2317 @item
2318 A function-like macro that appears without arguments.
2320 @item
2321 The unary plus operator.
2323 @item
2324 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2325 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2326 constants.)  Note, these suffixes appear in macros defined in the system
2327 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2328 Use of these macros in user code might normally lead to spurious
2329 warnings, however gcc's integrated preprocessor has enough context to
2330 avoid warning in these cases.
2332 @item
2333 A function declared external in one block and then used after the end of
2334 the block.
2336 @item
2337 A @code{switch} statement has an operand of type @code{long}.
2339 @item
2340 A non-@code{static} function declaration follows a @code{static} one.
2341 This construct is not accepted by some traditional C compilers.
2343 @item
2344 The ISO type of an integer constant has a different width or
2345 signedness from its traditional type.  This warning is only issued if
2346 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2347 typically represent bit patterns, are not warned about.
2349 @item
2350 Usage of ISO string concatenation is detected.
2352 @item
2353 Initialization of automatic aggregates.
2355 @item
2356 Identifier conflicts with labels.  Traditional C lacks a separate
2357 namespace for labels.
2359 @item
2360 Initialization of unions.  If the initializer is zero, the warning is
2361 omitted.  This is done under the assumption that the zero initializer in
2362 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2363 initializer warnings and relies on default initialization to zero in the
2364 traditional C case.
2366 @item
2367 Conversions by prototypes between fixed/floating point values and vice
2368 versa.  The absence of these prototypes when compiling with traditional
2369 C would cause serious problems.  This is a subset of the possible
2370 conversion warnings, for the full set use @option{-Wconversion}.
2371 @end itemize
2373 @item -Wundef
2374 @opindex Wundef
2375 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2377 @item -Wshadow
2378 @opindex Wshadow
2379 Warn whenever a local variable shadows another local variable, parameter or
2380 global variable or whenever a built-in function is shadowed.
2382 @item -Wlarger-than-@var{len}
2383 @opindex Wlarger-than
2384 Warn whenever an object of larger than @var{len} bytes is defined.
2386 @item -Wpointer-arith
2387 @opindex Wpointer-arith
2388 Warn about anything that depends on the ``size of'' a function type or
2389 of @code{void}.  GNU C assigns these types a size of 1, for
2390 convenience in calculations with @code{void *} pointers and pointers
2391 to functions.
2393 @item -Wbad-function-cast @r{(C only)}
2394 @opindex Wbad-function-cast
2395 Warn whenever a function call is cast to a non-matching type.
2396 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2398 @item -Wcast-qual
2399 @opindex Wcast-qual
2400 Warn whenever a pointer is cast so as to remove a type qualifier from
2401 the target type.  For example, warn if a @code{const char *} is cast
2402 to an ordinary @code{char *}.
2404 @item -Wcast-align
2405 @opindex Wcast-align
2406 Warn whenever a pointer is cast such that the required alignment of the
2407 target is increased.  For example, warn if a @code{char *} is cast to
2408 an @code{int *} on machines where integers can only be accessed at
2409 two- or four-byte boundaries.
2411 @item -Wwrite-strings
2412 @opindex Wwrite-strings
2413 When compiling C, give string constants the type @code{const
2414 char[@var{length}]} so that
2415 copying the address of one into a non-@code{const} @code{char *}
2416 pointer will get a warning; when compiling C++, warn about the
2417 deprecated conversion from string constants to @code{char *}.
2418 These warnings will help you find at
2419 compile time code that can try to write into a string constant, but
2420 only if you have been very careful about using @code{const} in
2421 declarations and prototypes.  Otherwise, it will just be a nuisance;
2422 this is why we did not make @option{-Wall} request these warnings.
2424 @item -Wconversion
2425 @opindex Wconversion
2426 Warn if a prototype causes a type conversion that is different from what
2427 would happen to the same argument in the absence of a prototype.  This
2428 includes conversions of fixed point to floating and vice versa, and
2429 conversions changing the width or signedness of a fixed point argument
2430 except when the same as the default promotion.
2432 Also, warn if a negative integer constant expression is implicitly
2433 converted to an unsigned type.  For example, warn about the assignment
2434 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2435 casts like @code{(unsigned) -1}.
2437 @item -Wsign-compare
2438 @opindex Wsign-compare
2439 @cindex warning for comparison of signed and unsigned values
2440 @cindex comparison of signed and unsigned values, warning
2441 @cindex signed and unsigned values, comparison warning
2442 Warn when a comparison between signed and unsigned values could produce
2443 an incorrect result when the signed value is converted to unsigned.
2444 This warning is also enabled by @option{-W}; to get the other warnings
2445 of @option{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2447 @item -Waggregate-return
2448 @opindex Waggregate-return
2449 Warn if any functions that return structures or unions are defined or
2450 called.  (In languages where you can return an array, this also elicits
2451 a warning.)
2453 @item -Wstrict-prototypes @r{(C only)}
2454 @opindex Wstrict-prototypes
2455 Warn if a function is declared or defined without specifying the
2456 argument types.  (An old-style function definition is permitted without
2457 a warning if preceded by a declaration which specifies the argument
2458 types.)
2460 @item -Wmissing-prototypes @r{(C only)}
2461 @opindex Wmissing-prototypes
2462 Warn if a global function is defined without a previous prototype
2463 declaration.  This warning is issued even if the definition itself
2464 provides a prototype.  The aim is to detect global functions that fail
2465 to be declared in header files.
2467 @item -Wmissing-declarations
2468 @opindex Wmissing-declarations
2469 Warn if a global function is defined without a previous declaration.
2470 Do so even if the definition itself provides a prototype.
2471 Use this option to detect global functions that are not declared in
2472 header files.
2474 @item -Wmissing-noreturn
2475 @opindex Wmissing-noreturn
2476 Warn about functions which might be candidates for attribute @code{noreturn}.
2477 Note these are only possible candidates, not absolute ones.  Care should
2478 be taken to manually verify functions actually do not ever return before
2479 adding the @code{noreturn} attribute, otherwise subtle code generation
2480 bugs could be introduced.  You will not get a warning for @code{main} in
2481 hosted C environments.
2483 @item -Wmissing-format-attribute
2484 @opindex Wmissing-format-attribute
2485 @opindex Wformat
2486 If @option{-Wformat} is enabled, also warn about functions which might be
2487 candidates for @code{format} attributes.  Note these are only possible
2488 candidates, not absolute ones.  GCC will guess that @code{format}
2489 attributes might be appropriate for any function that calls a function
2490 like @code{vprintf} or @code{vscanf}, but this might not always be the
2491 case, and some functions for which @code{format} attributes are
2492 appropriate may not be detected.  This option has no effect unless
2493 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2495 @item -Wpacked
2496 @opindex Wpacked
2497 Warn if a structure is given the packed attribute, but the packed
2498 attribute has no effect on the layout or size of the structure.
2499 Such structures may be mis-aligned for little benefit.  For
2500 instance, in this code, the variable @code{f.x} in @code{struct bar}
2501 will be misaligned even though @code{struct bar} does not itself
2502 have the packed attribute:
2504 @smallexample
2505 @group
2506 struct foo @{
2507   int x;
2508   char a, b, c, d;
2509 @} __attribute__((packed));
2510 struct bar @{
2511   char z;
2512   struct foo f;
2514 @end group
2515 @end smallexample
2517 @item -Wpadded
2518 @opindex Wpadded
2519 Warn if padding is included in a structure, either to align an element
2520 of the structure or to align the whole structure.  Sometimes when this
2521 happens it is possible to rearrange the fields of the structure to
2522 reduce the padding and so make the structure smaller.
2524 @item -Wredundant-decls
2525 @opindex Wredundant-decls
2526 Warn if anything is declared more than once in the same scope, even in
2527 cases where multiple declaration is valid and changes nothing.
2529 @item -Wnested-externs @r{(C only)}
2530 @opindex Wnested-externs
2531 Warn if an @code{extern} declaration is encountered within a function.
2533 @item -Wunreachable-code
2534 @opindex Wunreachable-code
2535 Warn if the compiler detects that code will never be executed.
2537 This option is intended to warn when the compiler detects that at
2538 least a whole line of source code will never be executed, because
2539 some condition is never satisfied or because it is after a
2540 procedure that never returns.
2542 It is possible for this option to produce a warning even though there
2543 are circumstances under which part of the affected line can be executed,
2544 so care should be taken when removing apparently-unreachable code.
2546 For instance, when a function is inlined, a warning may mean that the
2547 line is unreachable in only one inlined copy of the function.
2549 This option is not made part of @option{-Wall} because in a debugging
2550 version of a program there is often substantial code which checks
2551 correct functioning of the program and is, hopefully, unreachable
2552 because the program does work.  Another common use of unreachable
2553 code is to provide behaviour which is selectable at compile-time.
2555 @item -Winline
2556 @opindex Winline
2557 Warn if a function can not be inlined and it was declared as inline.
2559 @item -Wlong-long
2560 @opindex Wlong-long
2561 @opindex Wno-long-long
2562 Warn if @samp{long long} type is used.  This is default.  To inhibit
2563 the warning messages, use @option{-Wno-long-long}.  Flags
2564 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2565 only when @option{-pedantic} flag is used.
2567 @item -Wdisabled-optimization
2568 @opindex Wdisabled-optimization
2569 Warn if a requested optimization pass is disabled.  This warning does
2570 not generally indicate that there is anything wrong with your code; it
2571 merely indicates that GCC's optimizers were unable to handle the code
2572 effectively.  Often, the problem is that your code is too big or too
2573 complex; GCC will refuse to optimize programs when the optimization
2574 itself is likely to take inordinate amounts of time.
2576 @item -Werror
2577 @opindex Werror
2578 Make all warnings into errors.
2579 @end table
2581 @node Debugging Options
2582 @section Options for Debugging Your Program or GCC
2583 @cindex options, debugging
2584 @cindex debugging information options
2586 GCC has various special options that are used for debugging
2587 either your program or GCC:
2589 @table @gcctabopt
2590 @item -g
2591 @opindex g
2592 Produce debugging information in the operating system's native format
2593 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2594 information.
2596 On most systems that use stabs format, @option{-g} enables use of extra
2597 debugging information that only GDB can use; this extra information
2598 makes debugging work better in GDB but will probably make other debuggers
2599 crash or
2600 refuse to read the program.  If you want to control for certain whether
2601 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2602 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, or @option{-gdwarf-1}
2603 (see below).
2605 Unlike most other C compilers, GCC allows you to use @option{-g} with
2606 @option{-O}.  The shortcuts taken by optimized code may occasionally
2607 produce surprising results: some variables you declared may not exist
2608 at all; flow of control may briefly move where you did not expect it;
2609 some statements may not be executed because they compute constant
2610 results or their values were already at hand; some statements may
2611 execute in different places because they were moved out of loops.
2613 Nevertheless it proves possible to debug optimized output.  This makes
2614 it reasonable to use the optimizer for programs that might have bugs.
2616 The following options are useful when GCC is generated with the
2617 capability for more than one debugging format.
2619 @item -ggdb
2620 @opindex ggdb
2621 Produce debugging information for use by GDB@.  This means to use the
2622 most expressive format available (DWARF 2, stabs, or the native format
2623 if neither of those are supported), including GDB extensions if at all
2624 possible.
2626 @item -gstabs
2627 @opindex gstabs
2628 Produce debugging information in stabs format (if that is supported),
2629 without GDB extensions.  This is the format used by DBX on most BSD
2630 systems.  On MIPS, Alpha and System V Release 4 systems this option
2631 produces stabs debugging output which is not understood by DBX or SDB@.
2632 On System V Release 4 systems this option requires the GNU assembler.
2634 @item -gstabs+
2635 @opindex gstabs+
2636 Produce debugging information in stabs format (if that is supported),
2637 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2638 use of these extensions is likely to make other debuggers crash or
2639 refuse to read the program.
2641 @item -gcoff
2642 @opindex gcoff
2643 Produce debugging information in COFF format (if that is supported).
2644 This is the format used by SDB on most System V systems prior to
2645 System V Release 4.
2647 @item -gxcoff
2648 @opindex gxcoff
2649 Produce debugging information in XCOFF format (if that is supported).
2650 This is the format used by the DBX debugger on IBM RS/6000 systems.
2652 @item -gxcoff+
2653 @opindex gxcoff+
2654 Produce debugging information in XCOFF format (if that is supported),
2655 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2656 use of these extensions is likely to make other debuggers crash or
2657 refuse to read the program, and may cause assemblers other than the GNU
2658 assembler (GAS) to fail with an error.
2660 @item -gdwarf
2661 @opindex gdwarf
2662 Produce debugging information in DWARF version 1 format (if that is
2663 supported).  This is the format used by SDB on most System V Release 4
2664 systems.
2666 @item -gdwarf+
2667 @opindex gdwarf+
2668 Produce debugging information in DWARF version 1 format (if that is
2669 supported), using GNU extensions understood only by the GNU debugger
2670 (GDB)@.  The use of these extensions is likely to make other debuggers
2671 crash or refuse to read the program.
2673 @item -gdwarf-2
2674 @opindex gdwarf-2
2675 Produce debugging information in DWARF version 2 format (if that is
2676 supported).  This is the format used by DBX on IRIX 6.
2678 @item -g@var{level}
2679 @itemx -ggdb@var{level}
2680 @itemx -gstabs@var{level}
2681 @itemx -gcoff@var{level}
2682 @itemx -gxcoff@var{level}
2683 @itemx -gdwarf@var{level}
2684 @itemx -gdwarf-2@var{level}
2685 Request debugging information and also use @var{level} to specify how
2686 much information.  The default level is 2.
2688 Level 1 produces minimal information, enough for making backtraces in
2689 parts of the program that you don't plan to debug.  This includes
2690 descriptions of functions and external variables, but no information
2691 about local variables and no line numbers.
2693 Level 3 includes extra information, such as all the macro definitions
2694 present in the program.  Some debuggers support macro expansion when
2695 you use @option{-g3}.
2697 @cindex @code{prof}
2698 @item -p
2699 @opindex p
2700 Generate extra code to write profile information suitable for the
2701 analysis program @code{prof}.  You must use this option when compiling
2702 the source files you want data about, and you must also use it when
2703 linking.
2705 @cindex @code{gprof}
2706 @item -pg
2707 @opindex pg
2708 Generate extra code to write profile information suitable for the
2709 analysis program @code{gprof}.  You must use this option when compiling
2710 the source files you want data about, and you must also use it when
2711 linking.
2713 @cindex @code{tcov}
2714 @item -a
2715 @opindex a
2716 Generate extra code to write profile information for basic blocks, which will
2717 record the number of times each basic block is executed, the basic block start
2718 address, and the function name containing the basic block.  If @option{-g} is
2719 used, the line number and filename of the start of the basic block will also be
2720 recorded.  If not overridden by the machine description, the default action is
2721 to append to the text file @file{bb.out}.
2723 This data could be analyzed by a program like @code{tcov}.  Note,
2724 however, that the format of the data is not what @code{tcov} expects.
2725 Eventually GNU @code{gprof} should be extended to process this data.
2727 @item -Q
2728 @opindex Q
2729 Makes the compiler print out each function name as it is compiled, and
2730 print some statistics about each pass when it finishes.
2732 @item -ftime-report
2733 @opindex ftime-report
2734 Makes the compiler print some statistics about the time consumed by each
2735 pass when it finishes.
2737 @item -fmem-report
2738 @opindex fmem-report
2739 Makes the compiler print some statistics about permanent memory
2740 allocation when it finishes.
2742 @item -ax
2743 @opindex ax
2744 Generate extra code to profile basic blocks.  Your executable will
2745 produce output that is a superset of that produced when @option{-a} is
2746 used.  Additional output is the source and target address of the basic
2747 blocks where a jump takes place, the number of times a jump is executed,
2748 and (optionally) the complete sequence of basic blocks being executed.
2749 The output is appended to file @file{bb.out}.
2751 You can examine different profiling aspects without recompilation.  Your
2752 executable will read a list of function names from file @file{bb.in}.
2753 Profiling starts when a function on the list is entered and stops when
2754 that invocation is exited.  To exclude a function from profiling, prefix
2755 its name with @samp{-}.  If a function name is not unique, you can
2756 disambiguate it by writing it in the form
2757 @samp{/path/filename.d:functionname}.  Your executable will write the
2758 available paths and filenames in file @file{bb.out}.
2760 Several function names have a special meaning:
2761 @table @code
2762 @item __bb_jumps__
2763 Write source, target and frequency of jumps to file @file{bb.out}.
2764 @item __bb_hidecall__
2765 Exclude function calls from frequency count.
2766 @item __bb_showret__
2767 Include function returns in frequency count.
2768 @item __bb_trace__
2769 Write the sequence of basic blocks executed to file @file{bbtrace.gz}.
2770 The file will be compressed using the program @samp{gzip}, which must
2771 exist in your @env{PATH}.  On systems without the @samp{popen}
2772 function, the file will be named @file{bbtrace} and will not be
2773 compressed.  @strong{Profiling for even a few seconds on these systems
2774 will produce a very large file.}  Note: @code{__bb_hidecall__} and
2775 @code{__bb_showret__} will not affect the sequence written to
2776 @file{bbtrace.gz}.
2777 @end table
2779 Here's a short example using different profiling parameters
2780 in file @file{bb.in}.  Assume function @code{foo} consists of basic blocks
2781 1 and 2 and is called twice from block 3 of function @code{main}.  After
2782 the calls, block 3 transfers control to block 4 of @code{main}.
2784 With @code{__bb_trace__} and @code{main} contained in file @file{bb.in},
2785 the following sequence of blocks is written to file @file{bbtrace.gz}:
2786 0 3 1 2 1 2 4.  The return from block 2 to block 3 is not shown, because
2787 the return is to a point inside the block and not to the top.  The
2788 block address 0 always indicates, that control is transferred
2789 to the trace from somewhere outside the observed functions.  With
2790 @samp{-foo} added to @file{bb.in}, the blocks of function
2791 @code{foo} are removed from the trace, so only 0 3 4 remains.
2793 With @code{__bb_jumps__} and @code{main} contained in file @file{bb.in},
2794 jump frequencies will be written to file @file{bb.out}.  The
2795 frequencies are obtained by constructing a trace of blocks
2796 and incrementing a counter for every neighbouring pair of blocks
2797 in the trace.  The trace 0 3 1 2 1 2 4 displays the following
2798 frequencies:
2800 @example
2801 Jump from block 0x0 to block 0x3 executed 1 time(s)
2802 Jump from block 0x3 to block 0x1 executed 1 time(s)
2803 Jump from block 0x1 to block 0x2 executed 2 time(s)
2804 Jump from block 0x2 to block 0x1 executed 1 time(s)
2805 Jump from block 0x2 to block 0x4 executed 1 time(s)
2806 @end example
2808 With @code{__bb_hidecall__}, control transfer due to call instructions
2809 is removed from the trace, that is the trace is cut into three parts: 0
2810 3 4, 0 1 2 and 0 1 2.  With @code{__bb_showret__}, control transfer due
2811 to return instructions is added to the trace.  The trace becomes: 0 3 1
2812 2 3 1 2 3 4.  Note, that this trace is not the same, as the sequence
2813 written to @file{bbtrace.gz}.  It is solely used for counting jump
2814 frequencies.
2816 @item -fprofile-arcs
2817 @opindex fprofile-arcs
2818 Instrument @dfn{arcs} during compilation to generate coverage data
2819 or for profile-directed block ordering.  During execution the program
2820 records how many times each branch is executed and how many times it is
2821 taken.  When the compiled program exits it saves this data to a file
2822 called @file{@var{sourcename}.da} for each source file.
2824 For profile-directed block ordering, compile the program with
2825 @option{-fprofile-arcs} plus optimization and code generation options,
2826 generate the arc profile information by running the program on a
2827 selected workload, and then compile the program again with the same
2828 optimization and code generation options plus
2829 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2830 Control Optimization}).
2832 The other use of @option{-fprofile-arcs} is for use with @code{gcov},
2833 when it is used with the @option{-ftest-coverage} option.  GCC
2834 supports two methods of determining code coverage: the options that
2835 support @code{gcov}, and options @option{-a} and @option{-ax}, which
2836 write information to text files.  The options that support @code{gcov}
2837 do not need to instrument every arc in the program, so a program compiled
2838 with them runs faster than a program compiled with @option{-a}, which
2839 adds instrumentation code to every basic block in the program.  The
2840 tradeoff: since @code{gcov} does not have execution counts for all
2841 branches, it must start with the execution counts for the instrumented
2842 branches, and then iterate over the program flow graph until the entire
2843 graph has been solved.  Hence, @code{gcov} runs a little more slowly than
2844 a program which uses information from @option{-a} and @option{-ax}.
2846 With @option{-fprofile-arcs}, for each function of your program GCC
2847 creates a program flow graph, then finds a spanning tree for the graph.
2848 Only arcs that are not on the spanning tree have to be instrumented: the
2849 compiler adds code to count the number of times that these arcs are
2850 executed.  When an arc is the only exit or only entrance to a block, the
2851 instrumentation code can be added to the block; otherwise, a new basic
2852 block must be created to hold the instrumentation code.
2854 This option makes it possible to estimate branch probabilities and to
2855 calculate basic block execution counts.  In general, basic block
2856 execution counts as provided by @option{-a} do not give enough
2857 information to estimate all branch probabilities.
2859 @need 2000
2860 @item -ftest-coverage
2861 @opindex ftest-coverage
2862 Create data files for the @code{gcov} code-coverage utility
2863 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
2864 The data file names begin with the name of your source file:
2866 @table @gcctabopt
2867 @item @var{sourcename}.bb
2868 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2869 associate basic block execution counts with line numbers.
2871 @item @var{sourcename}.bbg
2872 A list of all arcs in the program flow graph.  This allows @code{gcov}
2873 to reconstruct the program flow graph, so that it can compute all basic
2874 block and arc execution counts from the information in the
2875 @code{@var{sourcename}.da} file.
2876 @end table
2878 Use @option{-ftest-coverage} with @option{-fprofile-arcs}; the latter
2879 option adds instrumentation to the program, which then writes
2880 execution counts to another data file:
2882 @table @gcctabopt
2883 @item @var{sourcename}.da
2884 Runtime arc execution counts, used in conjunction with the arc
2885 information in the file @code{@var{sourcename}.bbg}.
2886 @end table
2888 Coverage data will map better to the source files if
2889 @option{-ftest-coverage} is used without optimization.
2891 @item -d@var{letters}
2892 @opindex d
2893 Says to make debugging dumps during compilation at times specified by
2894 @var{letters}.  This is used for debugging the compiler.  The file names
2895 for most of the dumps are made by appending a pass number and a word to
2896 the source file name (e.g.  @file{foo.c.00.rtl} or @file{foo.c.01.sibling}).
2897 Here are the possible letters for use in @var{letters}, and their meanings:
2899 @table @samp
2900 @item A
2901 @opindex dA
2902 Annotate the assembler output with miscellaneous debugging information.
2903 @item b
2904 @opindex db
2905 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
2906 @item B
2907 @opindex dB
2908 Dump after block reordering, to @file{@var{file}.28.bbro}.
2909 @item c
2910 @opindex dc
2911 Dump after instruction combination, to the file @file{@var{file}.16.combine}.
2912 @item C
2913 @opindex dC
2914 Dump after the first if conversion, to the file @file{@var{file}.17.ce}.
2915 @item d
2916 @opindex dd
2917 Dump after delayed branch scheduling, to @file{@var{file}.31.dbr}.
2918 @item D
2919 @opindex dD
2920 Dump all macro definitions, at the end of preprocessing, in addition to
2921 normal output.
2922 @item e
2923 @opindex de
2924 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
2925 @file{@var{file}.07.ussa}.
2926 @item E
2927 @opindex dE
2928 Dump after the second if conversion, to @file{@var{file}.26.ce2}.
2929 @item f
2930 @opindex df
2931 Dump after life analysis, to @file{@var{file}.15.life}.
2932 @item F
2933 @opindex dF
2934 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.09.addressof}.
2935 @item g
2936 @opindex dg
2937 Dump after global register allocation, to @file{@var{file}.21.greg}.
2938 @item h
2939 @opindex dh
2940 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
2941 @item o
2942 @opindex do
2943 Dump after post-reload optimizations, to @file{@var{file}.22.postreload}.
2944 @item G
2945 @opindex dG
2946 Dump after GCSE, to @file{@var{file}.10.gcse}.
2947 @item i
2948 @opindex di
2949 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
2950 @item j
2951 @opindex dj
2952 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
2953 @item k
2954 @opindex dk
2955 Dump after conversion from registers to stack, to @file{@var{file}.32.stack}.
2956 @item l
2957 @opindex dl
2958 Dump after local register allocation, to @file{@var{file}.20.lreg}.
2959 @item L
2960 @opindex dL
2961 Dump after loop optimization, to @file{@var{file}.11.loop}.
2962 @item M
2963 @opindex dM
2964 Dump after performing the machine dependent reorganisation pass, to
2965 @file{@var{file}.30.mach}.
2966 @item n
2967 @opindex dn
2968 Dump after register renumbering, to @file{@var{file}.25.rnreg}.
2969 @item N
2970 @opindex dN
2971 Dump after the register move pass, to @file{@var{file}.18.regmove}.
2972 @item r
2973 @opindex dr
2974 Dump after RTL generation, to @file{@var{file}.00.rtl}.
2975 @item R
2976 @opindex dR
2977 Dump after the second scheduling pass, to @file{@var{file}.27.sched2}.
2978 @item s
2979 @opindex ds
2980 Dump after CSE (including the jump optimization that sometimes follows
2981 CSE), to @file{@var{file}.08.cse}.
2982 @item S
2983 @opindex dS
2984 Dump after the first scheduling pass, to @file{@var{file}.19.sched}.
2985 @item t
2986 @opindex dt
2987 Dump after the second CSE pass (including the jump optimization that
2988 sometimes follows CSE), to @file{@var{file}.12.cse2}.
2989 @item w
2990 @opindex dw
2991 Dump after the second flow pass, to @file{@var{file}.23.flow2}.
2992 @item X
2993 @opindex dX
2994 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
2995 @item z
2996 @opindex dz
2997 Dump after the peephole pass, to @file{@var{file}.24.peephole2}.
2998 @item a
2999 @opindex da
3000 Produce all the dumps listed above.
3001 @item m
3002 @opindex dm
3003 Print statistics on memory usage, at the end of the run, to
3004 standard error.
3005 @item p
3006 @opindex dp
3007 Annotate the assembler output with a comment indicating which
3008 pattern and alternative was used.  The length of each instruction is
3009 also printed.
3010 @item P
3011 @opindex dP
3012 Dump the RTL in the assembler output as a comment before each instruction.
3013 Also turns on @option{-dp} annotation.
3014 @item v
3015 @opindex dv
3016 For each of the other indicated dump files (except for
3017 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3018 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3019 @item x
3020 @opindex dx
3021 Just generate RTL for a function instead of compiling it.  Usually used
3022 with @samp{r}.
3023 @item y
3024 @opindex dy
3025 Dump debugging information during parsing, to standard error.
3026 @end table
3028 @item -fdump-unnumbered
3029 @opindex fdump-unnumbered
3030 When doing debugging dumps (see @option{-d} option above), suppress instruction
3031 numbers and line number note output.  This makes it more feasible to
3032 use diff on debugging dumps for compiler invocations with different
3033 options, in particular with and without @option{-g}.
3035 @item -fdump-class-hierarchy @r{(C++ only)}
3036 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3037 @opindex fdump-class-hierarchy
3038 Dump a representation of each class's hierarchy and virtual function
3039 table layout to a file.  The file name is made by appending @file{.class}
3040 to the source file name.  If the @samp{-@var{options}} form is used,
3041 @var{options} controls the details of the dump as described for the
3042 @option{-fdump-tree} options.
3044 @item -fdump-tree-@var{switch} @r{(C++ only)}
3045 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3046 @opindex fdump-tree
3047 Control the dumping at various stages of processing the intermediate
3048 language tree to a file.  The file name is generated by appending a switch
3049 specific suffix to the source file name.  If the @samp{-@var{options}}
3050 form is used, @var{options} is a list of @samp{-} separated options that
3051 control the details of the dump. Not all options are applicable to all
3052 dumps, those which are not meaningful will be ignored. The following
3053 options are available
3055 @table @samp
3056 @item address
3057 Print the address of each node.  Usually this is not meaningful as it
3058 changes according to the environment and source file. Its primary use
3059 is for tying up a dump file with a debug environment.
3060 @item slim
3061 Inhibit dumping of members of a scope or body of a function merely
3062 because that scope has been reached. Only dump such items when they
3063 are directly reachable by some other path.
3064 @item all
3065 Turn on all options.
3066 @end table
3068 The following tree dumps are possible:
3069 @table @samp
3070 @item original
3071 Dump before any tree based optimization, to @file{@var{file}.original}.
3072 @item optimized
3073 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3074 @item inlined
3075 Dump after function inlining, to @file{@var{file}.inlined}.
3076 @end table
3078 @item -fpretend-float
3079 @opindex fpretend-float
3080 When running a cross-compiler, pretend that the target machine uses the
3081 same floating point format as the host machine.  This causes incorrect
3082 output of the actual floating constants, but the actual instruction
3083 sequence will probably be the same as GCC would make when running on
3084 the target machine.
3086 @item -save-temps
3087 @opindex save-temps
3088 Store the usual ``temporary'' intermediate files permanently; place them
3089 in the current directory and name them based on the source file.  Thus,
3090 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3091 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3092 preprocessed @file{foo.i} output file even though the compiler now
3093 normally uses an integrated preprocessor.
3095 @item -time
3096 @opindex time
3097 Report the CPU time taken by each subprocess in the compilation
3098 sequence.  For C source files, this is the compiler proper and assembler
3099 (plus the linker if linking is done).  The output looks like this:
3101 @smallexample
3102 # cc1 0.12 0.01
3103 # as 0.00 0.01
3104 @end smallexample
3106 The first number on each line is the ``user time,'' that is time spent
3107 executing the program itself.  The second number is ``system time,''
3108 time spent executing operating system routines on behalf of the program.
3109 Both numbers are in seconds.
3111 @item -print-file-name=@var{library}
3112 @opindex print-file-name
3113 Print the full absolute name of the library file @var{library} that
3114 would be used when linking---and don't do anything else.  With this
3115 option, GCC does not compile or link anything; it just prints the
3116 file name.
3118 @item -print-multi-directory
3119 @opindex print-multi-directory
3120 Print the directory name corresponding to the multilib selected by any
3121 other switches present in the command line.  This directory is supposed
3122 to exist in @env{GCC_EXEC_PREFIX}.
3124 @item -print-multi-lib
3125 @opindex print-multi-lib
3126 Print the mapping from multilib directory names to compiler switches
3127 that enable them.  The directory name is separated from the switches by
3128 @samp{;}, and each switch starts with an @samp{@@} instead of the
3129 @samp{-}, without spaces between multiple switches.  This is supposed to
3130 ease shell-processing.
3132 @item -print-prog-name=@var{program}
3133 @opindex print-prog-name
3134 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3136 @item -print-libgcc-file-name
3137 @opindex print-libgcc-file-name
3138 Same as @option{-print-file-name=libgcc.a}.
3140 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3141 but you do want to link with @file{libgcc.a}.  You can do
3143 @example
3144 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3145 @end example
3147 @item -print-search-dirs
3148 @opindex print-search-dirs
3149 Print the name of the configured installation directory and a list of
3150 program and library directories gcc will search---and don't do anything else.
3152 This is useful when gcc prints the error message
3153 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3154 To resolve this you either need to put @file{cpp0} and the other compiler
3155 components where gcc expects to find them, or you can set the environment
3156 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3157 Don't forget the trailing '/'.
3158 @xref{Environment Variables}.
3160 @item -dumpmachine
3161 @opindex dumpmachine
3162 Print the compiler's target machine (for example,
3163 @samp{i686-pc-linux-gnu})---and don't do anything else.
3165 @item -dumpversion
3166 @opindex dumpversion
3167 Print the compiler version (for example, @samp{3.0})---and don't do
3168 anything else.
3170 @item -dumpspecs
3171 @opindex dumpspecs
3172 Print the compiler's built-in specs---and don't do anything else.  (This
3173 is used when GCC itself is being built.)  @xref{Spec Files}.
3174 @end table
3176 @node Optimize Options
3177 @section Options That Control Optimization
3178 @cindex optimize options
3179 @cindex options, optimization
3181 These options control various sorts of optimizations:
3183 @table @gcctabopt
3184 @item -O
3185 @itemx -O1
3186 @opindex O
3187 @opindex O1
3188 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3189 more memory for a large function.
3191 Without @option{-O}, the compiler's goal is to reduce the cost of
3192 compilation and to make debugging produce the expected results.
3193 Statements are independent: if you stop the program with a breakpoint
3194 between statements, you can then assign a new value to any variable or
3195 change the program counter to any other statement in the function and
3196 get exactly the results you would expect from the source code.
3198 With @option{-O}, the compiler tries to reduce code size and execution
3199 time, without performing any optimizations that take a great deal of
3200 compilation time.
3202 @item -O2
3203 @opindex O2
3204 Optimize even more.  GCC performs nearly all supported optimizations
3205 that do not involve a space-speed tradeoff.  The compiler does not
3206 perform loop unrolling or function inlining when you specify @option{-O2}.
3207 As compared to @option{-O}, this option increases both compilation time
3208 and the performance of the generated code.
3210 @option{-O2} turns on all optional optimizations except for loop unrolling,
3211 function inlining, and register renaming.  It also turns on the
3212 @option{-fforce-mem} option on all machines and frame pointer elimination
3213 on machines where doing so does not interfere with debugging.
3215 Please note the warning under @option{-fgcse} about
3216 invoking @option{-O2} on programs that use computed gotos.
3218 @item -O3
3219 @opindex O3
3220 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3221 @option{-O2} and also turns on the @option{-finline-functions} and
3222 @option{-frename-registers} options.
3224 @item -O0
3225 @opindex O0
3226 Do not optimize.
3228 @item -Os
3229 @opindex Os
3230 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3231 do not typically increase code size.  It also performs further
3232 optimizations designed to reduce code size.
3234 If you use multiple @option{-O} options, with or without level numbers,
3235 the last such option is the one that is effective.
3236 @end table
3238 Options of the form @option{-f@var{flag}} specify machine-independent
3239 flags.  Most flags have both positive and negative forms; the negative
3240 form of @option{-ffoo} would be @option{-fno-foo}.  In the table below,
3241 only one of the forms is listed---the one which is not the default.
3242 You can figure out the other form by either removing @samp{no-} or
3243 adding it.
3245 @table @gcctabopt
3246 @item -ffloat-store
3247 @opindex ffloat-store
3248 Do not store floating point variables in registers, and inhibit other
3249 options that might change whether a floating point value is taken from a
3250 register or memory.
3252 @cindex floating point precision
3253 This option prevents undesirable excess precision on machines such as
3254 the 68000 where the floating registers (of the 68881) keep more
3255 precision than a @code{double} is supposed to have.  Similarly for the
3256 x86 architecture.  For most programs, the excess precision does only
3257 good, but a few programs rely on the precise definition of IEEE floating
3258 point.  Use @option{-ffloat-store} for such programs, after modifying
3259 them to store all pertinent intermediate computations into variables.
3261 @item -fno-default-inline
3262 @opindex fno-default-inline
3263 Do not make member functions inline by default merely because they are
3264 defined inside the class scope (C++ only).  Otherwise, when you specify
3265 @w{@option{-O}}, member functions defined inside class scope are compiled
3266 inline by default; i.e., you don't need to add @samp{inline} in front of
3267 the member function name.
3269 @item -fno-defer-pop
3270 @opindex fno-defer-pop
3271 Always pop the arguments to each function call as soon as that function
3272 returns.  For machines which must pop arguments after a function call,
3273 the compiler normally lets arguments accumulate on the stack for several
3274 function calls and pops them all at once.
3276 @item -fforce-mem
3277 @opindex fforce-mem
3278 Force memory operands to be copied into registers before doing
3279 arithmetic on them.  This produces better code by making all memory
3280 references potential common subexpressions.  When they are not common
3281 subexpressions, instruction combination should eliminate the separate
3282 register-load.  The @option{-O2} option turns on this option.
3284 @item -fforce-addr
3285 @opindex fforce-addr
3286 Force memory address constants to be copied into registers before
3287 doing arithmetic on them.  This may produce better code just as
3288 @option{-fforce-mem} may.
3290 @item -fomit-frame-pointer
3291 @opindex fomit-frame-pointer
3292 Don't keep the frame pointer in a register for functions that
3293 don't need one.  This avoids the instructions to save, set up and
3294 restore frame pointers; it also makes an extra register available
3295 in many functions.  @strong{It also makes debugging impossible on
3296 some machines.}
3298 @ifset INTERNALS
3299 On some machines, such as the VAX, this flag has no effect, because
3300 the standard calling sequence automatically handles the frame pointer
3301 and nothing is saved by pretending it doesn't exist.  The
3302 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3303 whether a target machine supports this flag.  @xref{Registers}.
3304 @end ifset
3305 @ifclear INTERNALS
3306 On some machines, such as the VAX, this flag has no effect, because
3307 the standard calling sequence automatically handles the frame pointer
3308 and nothing is saved by pretending it doesn't exist.  The
3309 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3310 whether a target machine supports this flag.  @xref{Registers,,Register
3311 Usage, gcc.info, Using and Porting GCC}.
3312 @end ifclear
3314 @item -foptimize-sibling-calls
3315 @opindex foptimize-sibling-calls
3316 Optimize sibling and tail recursive calls.
3318 @item -ftrapv
3319 @opindex ftrapv
3320 This option generates traps for signed overflow on addition, subtraction,
3321 multiplication operations.
3323 @item -fno-inline
3324 @opindex fno-inline
3325 Don't pay attention to the @code{inline} keyword.  Normally this option
3326 is used to keep the compiler from expanding any functions inline.
3327 Note that if you are not optimizing, no functions can be expanded inline.
3329 @item -finline-functions
3330 @opindex finline-functions
3331 Integrate all simple functions into their callers.  The compiler
3332 heuristically decides which functions are simple enough to be worth
3333 integrating in this way.
3335 If all calls to a given function are integrated, and the function is
3336 declared @code{static}, then the function is normally not output as
3337 assembler code in its own right.
3339 @item -finline-limit=@var{n}
3340 @opindex finline-limit
3341 By default, gcc limits the size of functions that can be inlined.  This flag
3342 allows the control of this limit for functions that are explicitly marked as
3343 inline (ie marked with the inline keyword or defined within the class
3344 definition in c++).  @var{n} is the size of functions that can be inlined in
3345 number of pseudo instructions (not counting parameter handling).  The default
3346 value of @var{n} is 600.
3347 Increasing this value can result in more inlined code at
3348 the cost of compilation time and memory consumption.  Decreasing usually makes
3349 the compilation faster and less code will be inlined (which presumably
3350 means slower programs).  This option is particularly useful for programs that
3351 use inlining heavily such as those based on recursive templates with C++.
3353 @emph{Note:} pseudo instruction represents, in this particular context, an
3354 abstract measurement of function's size.  In no way, it represents a count
3355 of assembly instructions and as such its exact meaning might change from one
3356 release to an another.
3358 @item -fkeep-inline-functions
3359 @opindex fkeep-inline-functions
3360 Even if all calls to a given function are integrated, and the function
3361 is declared @code{static}, nevertheless output a separate run-time
3362 callable version of the function.  This switch does not affect
3363 @code{extern inline} functions.
3365 @item -fkeep-static-consts
3366 @opindex fkeep-static-consts
3367 Emit variables declared @code{static const} when optimization isn't turned
3368 on, even if the variables aren't referenced.
3370 GCC enables this option by default.  If you want to force the compiler to
3371 check if the variable was referenced, regardless of whether or not
3372 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3374 @item -fmerge-constants
3375 Attempt to merge identical constants (string constants and floating point
3376 constants) accross compilation units.
3378 This option is default for optimized compilation if assembler and linker
3379 support it.  Use @option{-fno-merge-constants} to inhibit this behaviour.
3381 @item -fmerge-all-constants
3382 Attempt to merge identical constants and identical variables.
3384 This option implies @option{-fmerge-constants}.  In addition to
3385 @option{-fmerge-constants} this considers e.g. even constant initialized
3386 arrays or initialized constant variables with integral or floating point
3387 types.  Languages like C or C++ require each non-automatic variable to
3388 have distinct location, so using this option will result in non-conforming
3389 behaviour.
3391 @item -fno-function-cse
3392 @opindex fno-function-cse
3393 Do not put function addresses in registers; make each instruction that
3394 calls a constant function contain the function's address explicitly.
3396 This option results in less efficient code, but some strange hacks
3397 that alter the assembler output may be confused by the optimizations
3398 performed when this option is not used.
3400 @item -ffast-math
3401 @opindex ffast-math
3402 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, and @*
3403 @option{-fno-trapping-math}.
3405 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
3407 This option should never be turned on by any @option{-O} option since
3408 it can result in incorrect output for programs which depend on
3409 an exact implementation of IEEE or ISO rules/specifications for
3410 math functions.
3412 @item -fno-math-errno
3413 @opindex fno-math-errno
3414 Do not set ERRNO after calling math functions that are executed
3415 with a single instruction, e.g., sqrt.  A program that relies on
3416 IEEE exceptions for math error handling may want to use this flag
3417 for speed while maintaining IEEE arithmetic compatibility.
3419 This option should never be turned on by any @option{-O} option since
3420 it can result in incorrect output for programs which depend on
3421 an exact implementation of IEEE or ISO rules/specifications for
3422 math functions.
3424 The default is @option{-fmath-errno}.
3426 @item -funsafe-math-optimizations
3427 @opindex funsafe-math-optimizations
3428 Allow optimizations for floating-point arithmetic that (a) assume
3429 that arguments and results are valid and (b) may violate IEEE or
3430 ANSI standards.  When used at link-time, it may include libraries
3431 or startup files that change the default FPU control word or other
3432 similar optimizations.
3434 This option should never be turned on by any @option{-O} option since
3435 it can result in incorrect output for programs which depend on
3436 an exact implementation of IEEE or ISO rules/specifications for
3437 math functions.
3439 The default is @option{-fno-unsafe-math-optimizations}.
3441 @item -fno-trapping-math
3442 @opindex fno-trapping-math
3443 Compile code assuming that floating-point operations cannot generate
3444 user-visible traps.  Setting this option may allow faster code
3445 if one relies on ``non-stop'' IEEE arithmetic, for example.
3447 This option should never be turned on by any @option{-O} option since
3448 it can result in incorrect output for programs which depend on
3449 an exact implementation of IEEE or ISO rules/specifications for
3450 math functions.
3452 The default is @option{-ftrapping-math}.
3453 @end table
3455 The following options control specific optimizations.  The @option{-O2}
3456 option turns on all of these optimizations except @option{-funroll-loops}
3457 and @option{-funroll-all-loops}.  On most machines, the @option{-O} option
3458 turns on the @option{-fthread-jumps} and @option{-fdelayed-branch} options,
3459 but specific machines may handle it differently.
3461 You can use the following flags in the rare cases when ``fine-tuning''
3462 of optimizations to be performed is desired.
3464 Not all of the optimizations performed by GCC have @option{-f} options
3465 to control them.
3467 @table @gcctabopt
3468 @item -fstrength-reduce
3469 @opindex fstrength-reduce
3470 Perform the optimizations of loop strength reduction and
3471 elimination of iteration variables.
3473 @item -fthread-jumps
3474 @opindex fthread-jumps
3475 Perform optimizations where we check to see if a jump branches to a
3476 location where another comparison subsumed by the first is found.  If
3477 so, the first branch is redirected to either the destination of the
3478 second branch or a point immediately following it, depending on whether
3479 the condition is known to be true or false.
3481 @item -fcse-follow-jumps
3482 @opindex fcse-follow-jumps
3483 In common subexpression elimination, scan through jump instructions
3484 when the target of the jump is not reached by any other path.  For
3485 example, when CSE encounters an @code{if} statement with an
3486 @code{else} clause, CSE will follow the jump when the condition
3487 tested is false.
3489 @item -fcse-skip-blocks
3490 @opindex fcse-skip-blocks
3491 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3492 follow jumps which conditionally skip over blocks.  When CSE
3493 encounters a simple @code{if} statement with no else clause,
3494 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3495 body of the @code{if}.
3497 @item -frerun-cse-after-loop
3498 @opindex frerun-cse-after-loop
3499 Re-run common subexpression elimination after loop optimizations has been
3500 performed.
3502 @item -frerun-loop-opt
3503 @opindex frerun-loop-opt
3504 Run the loop optimizer twice.
3506 @item -fgcse
3507 @opindex fgcse
3508 Perform a global common subexpression elimination pass.
3509 This pass also performs global constant and copy propagation.
3511 @emph{Note:} When compiling a program using computed gotos, a GCC
3512 extension, you may get better runtime performance if you disable
3513 the global common subexpression elmination pass by adding
3514 @option{-fno-gcse} to the command line.
3516 @item -fgcse-lm
3517 @opindex fgcse-lm
3518 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3519 attempt to move loads which are only killed by stores into themselves.  This
3520 allows a loop containing a load/store sequence to be changed to a load outside
3521 the loop, and a copy/store within the loop.
3523 @item -fgcse-sm
3524 @opindex fgcse-sm
3525 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3526 subexpression elimination.  This pass will attempt to move stores out of loops.
3527 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3528 can be changed to a load before the loop and a store after the loop.
3530 @item -fdelete-null-pointer-checks
3531 @opindex fdelete-null-pointer-checks
3532 Use global dataflow analysis to identify and eliminate useless checks
3533 for null pointers.  The compiler assumes that dereferencing a null
3534 pointer would have halted the program.  If a pointer is checked after
3535 it has already been dereferenced, it cannot be null.
3537 In some environments, this assumption is not true, and programs can
3538 safely dereference null pointers.  Use
3539 @option{-fno-delete-null-pointer-checks} to disable this optimization
3540 for programs which depend on that behavior.
3542 @item -fexpensive-optimizations
3543 @opindex fexpensive-optimizations
3544 Perform a number of minor optimizations that are relatively expensive.
3546 @item -foptimize-register-move
3547 @itemx -fregmove
3548 @opindex foptimize-register-move
3549 @opindex fregmove
3550 Attempt to reassign register numbers in move instructions and as
3551 operands of other simple instructions in order to maximize the amount of
3552 register tying.  This is especially helpful on machines with two-operand
3553 instructions.  GCC enables this optimization by default with @option{-O2}
3554 or higher.
3556 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3557 optimization.
3559 @item -fdelayed-branch
3560 @opindex fdelayed-branch
3561 If supported for the target machine, attempt to reorder instructions
3562 to exploit instruction slots available after delayed branch
3563 instructions.
3565 @item -fschedule-insns
3566 @opindex fschedule-insns
3567 If supported for the target machine, attempt to reorder instructions to
3568 eliminate execution stalls due to required data being unavailable.  This
3569 helps machines that have slow floating point or memory load instructions
3570 by allowing other instructions to be issued until the result of the load
3571 or floating point instruction is required.
3573 @item -fschedule-insns2
3574 @opindex fschedule-insns2
3575 Similar to @option{-fschedule-insns}, but requests an additional pass of
3576 instruction scheduling after register allocation has been done.  This is
3577 especially useful on machines with a relatively small number of
3578 registers and where memory load instructions take more than one cycle.
3580 @item -ffunction-sections
3581 @itemx -fdata-sections
3582 @opindex ffunction-sections
3583 @opindex fdata-sections
3584 Place each function or data item into its own section in the output
3585 file if the target supports arbitrary sections.  The name of the
3586 function or the name of the data item determines the section's name
3587 in the output file.
3589 Use these options on systems where the linker can perform optimizations
3590 to improve locality of reference in the instruction space.  HPPA
3591 processors running HP-UX and Sparc processors running Solaris 2 have
3592 linkers with such optimizations.  Other systems using the ELF object format
3593 as well as AIX may have these optimizations in the future.
3595 Only use these options when there are significant benefits from doing
3596 so.  When you specify these options, the assembler and linker will
3597 create larger object and executable files and will also be slower.
3598 You will not be able to use @code{gprof} on all systems if you
3599 specify this option and you may have problems with debugging if
3600 you specify both this option and @option{-g}.
3602 @item -fcaller-saves
3603 @opindex fcaller-saves
3604 Enable values to be allocated in registers that will be clobbered by
3605 function calls, by emitting extra instructions to save and restore the
3606 registers around such calls.  Such allocation is done only when it
3607 seems to result in better code than would otherwise be produced.
3609 This option is always enabled by default on certain machines, usually
3610 those which have no call-preserved registers to use instead.
3612 For all machines, optimization level 2 and higher enables this flag by
3613 default.
3615 @item -funroll-loops
3616 @opindex funroll-loops
3617 Unroll loops whose number of iterations can be determined at compile
3618 time or upon entry to the loop.  @option{-funroll-loops} implies both
3619 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
3620 option makes code larger, and may or may not make it run faster.
3622 @item -funroll-all-loops
3623 @opindex funroll-all-loops
3624 Unroll all loops, even if their number of iterations is uncertain when
3625 the loop is entered.  This usually makes programs run more slowly.
3626 @option{-funroll-all-loops} implies the same options as
3627 @option{-funroll-loops},
3630 @item -fmove-all-movables
3631 @opindex fmove-all-movables
3632 Forces all invariant computations in loops to be moved
3633 outside the loop.
3635 @item -freduce-all-givs
3636 @opindex freduce-all-givs
3637 Forces all general-induction variables in loops to be
3638 strength-reduced.
3640 @emph{Note:} When compiling programs written in Fortran,
3641 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3642 by default when you use the optimizer.
3644 These options may generate better or worse code; results are highly
3645 dependent on the structure of loops within the source code.
3647 These two options are intended to be removed someday, once
3648 they have helped determine the efficacy of various
3649 approaches to improving loop optimizations.
3651 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3652 know how use of these options affects
3653 the performance of your production code.
3654 We're very interested in code that runs @emph{slower}
3655 when these options are @emph{enabled}.
3657 @item -fno-peephole
3658 @itemx -fno-peephole2
3659 @opindex fno-peephole
3660 @opindex fno-peephole2
3661 Disable any machine-specific peephole optimizations.  The difference
3662 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3663 are implemented in the compiler; some targets use one, some use the
3664 other, a few use both.
3666 @item -fbranch-probabilities
3667 @opindex fbranch-probabilities
3668 After running a program compiled with @option{-fprofile-arcs}
3669 (@pxref{Debugging Options,, Options for Debugging Your Program or
3670 @command{gcc}}), you can compile it a second time using
3671 @option{-fbranch-probabilities}, to improve optimizations based on
3672 the number of times each branch was taken.  When the program
3673 compiled with @option{-fprofile-arcs} exits it saves arc execution
3674 counts to a file called @file{@var{sourcename}.da} for each source
3675 file  The information in this data file is very dependent on the
3676 structure of the generated code, so you must use the same source code
3677 and the same optimization options for both compilations.
3679 @ifset INTERNALS
3680 With @option{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
3681 note on the first instruction of each basic block, and a
3682 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3683 These can be used to improve optimization.  Currently, they are only
3684 used in one place: in @file{reorg.c}, instead of guessing which path a
3685 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3686 exactly determine which path is taken more often.
3687 @end ifset
3689 @item -fno-guess-branch-probability
3690 @opindex fno-guess-branch-probability
3691 Do not guess branch probabilities using a randomized model.
3693 Sometimes gcc will opt to use a randomized model to guess branch
3694 probabilities, when none are available from either profiling feedback
3695 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
3696 different runs of the compiler on the same program may produce different
3697 object code.
3699 In a hard real-time system, people don't want different runs of the
3700 compiler to produce code that has different behavior; minimizing
3701 non-determinism is of paramount import.  This switch allows users to
3702 reduce non-determinism, possibly at the expense of inferior
3703 optimization.
3705 @item -fstrict-aliasing
3706 @opindex fstrict-aliasing
3707 Allows the compiler to assume the strictest aliasing rules applicable to
3708 the language being compiled.  For C (and C++), this activates
3709 optimizations based on the type of expressions.  In particular, an
3710 object of one type is assumed never to reside at the same address as an
3711 object of a different type, unless the types are almost the same.  For
3712 example, an @code{unsigned int} can alias an @code{int}, but not a
3713 @code{void*} or a @code{double}.  A character type may alias any other
3714 type.
3716 Pay special attention to code like this:
3717 @example
3718 union a_union @{
3719   int i;
3720   double d;
3723 int f() @{
3724   a_union t;
3725   t.d = 3.0;
3726   return t.i;
3728 @end example
3729 The practice of reading from a different union member than the one most
3730 recently written to (called ``type-punning'') is common.  Even with
3731 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
3732 is accessed through the union type.  So, the code above will work as
3733 expected.  However, this code might not:
3734 @example
3735 int f() @{
3736   a_union t;
3737   int* ip;
3738   t.d = 3.0;
3739   ip = &t.i;
3740   return *ip;
3742 @end example
3744 @ifset INTERNALS
3745 Every language that wishes to perform language-specific alias analysis
3746 should define a function that computes, given an @code{tree}
3747 node, an alias set for the node.  Nodes in different alias sets are not
3748 allowed to alias.  For an example, see the C front-end function
3749 @code{c_get_alias_set}.
3750 @end ifset
3752 @item -falign-functions
3753 @itemx -falign-functions=@var{n}
3754 @opindex falign-functions
3755 Align the start of functions to the next power-of-two greater than
3756 @var{n}, skipping up to @var{n} bytes.  For instance,
3757 @option{-falign-functions=32} aligns functions to the next 32-byte
3758 boundary, but @option{-falign-functions=24} would align to the next
3759 32-byte boundary only if this can be done by skipping 23 bytes or less.
3761 @option{-fno-align-functions} and @option{-falign-functions=1} are
3762 equivalent and mean that functions will not be aligned.
3764 Some assemblers only support this flag when @var{n} is a power of two;
3765 in that case, it is rounded up.
3767 If @var{n} is not specified, use a machine-dependent default.
3769 @item -falign-labels
3770 @itemx -falign-labels=@var{n}
3771 @opindex falign-labels
3772 Align all branch targets to a power-of-two boundary, skipping up to
3773 @var{n} bytes like @option{-falign-functions}.  This option can easily
3774 make code slower, because it must insert dummy operations for when the
3775 branch target is reached in the usual flow of the code.
3777 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
3778 are greater than this value, then their values are used instead.
3780 If @var{n} is not specified, use a machine-dependent default which is
3781 very likely to be @samp{1}, meaning no alignment.
3783 @item -falign-loops
3784 @itemx -falign-loops=@var{n}
3785 @opindex falign-loops
3786 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
3787 like @option{-falign-functions}.  The hope is that the loop will be
3788 executed many times, which will make up for any execution of the dummy
3789 operations.
3791 If @var{n} is not specified, use a machine-dependent default.
3793 @item -falign-jumps
3794 @itemx -falign-jumps=@var{n}
3795 @opindex falign-jumps
3796 Align branch targets to a power-of-two boundary, for branch targets
3797 where the targets can only be reached by jumping, skipping up to @var{n}
3798 bytes like @option{-falign-functions}.  In this case, no dummy operations
3799 need be executed.
3801 If @var{n} is not specified, use a machine-dependent default.
3803 @item -fssa
3804 @opindex fssa
3805 Perform optimizations in static single assignment form.  Each function's
3806 flow graph is translated into SSA form, optimizations are performed, and
3807 the flow graph is translated back from SSA form.  Users should not
3808 specify this option, since it is not yet ready for production use.
3810 @item -fssa-ccp
3811 @opindex fssa-ccp
3812 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
3813 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
3815 @item -fssa-dce
3816 @opindex fssa-dce
3817 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
3818 Like @option{-fssa}, this is an experimental feature.
3820 @item -fsingle-precision-constant
3821 @opindex fsingle-precision-constant
3822 Treat floating point constant as single precision constant instead of
3823 implicitly converting it to double precision constant.
3825 @item -frename-registers
3826 @opindex frename-registers
3827 Attempt to avoid false dependencies in scheduled code by making use
3828 of registers left over after register allocation.  This optimization
3829 will most benefit processors with lots of registers.  It can, however,
3830 make debugging impossible, since variables will no longer stay in
3831 a ``home register''.
3833 @item --param @var{name}=@var{value}
3834 @opindex param
3835 In some places, GCC uses various constants to control the amount of
3836 optimization that is done.  For example, GCC will not inline functions
3837 that contain more that a certain number of instructions.  You can
3838 control some of these constants on the command-line using the
3839 @option{--param} option.
3841 In each case, the @var{value} is an integer.  The allowable choices for
3842 @var{name} are given in the following table:
3844 @table @gcctabopt
3845 @item max-delay-slot-insn-search
3846 The maximum number of instructions to consider when looking for an
3847 instruction to fill a delay slot.  If more than this arbitrary number of
3848 instructions is searched, the time savings from filling the delay slot
3849 will be minimal so stop searching.  Increasing values mean more
3850 aggressive optimization, making the compile time increase with probably
3851 small improvement in executable run time.
3853 @item max-delay-slot-live-search
3854 When trying to fill delay slots, the maximum number of instructions to
3855 consider when searching for a block with valid live register
3856 information.  Increasing this arbitrarily chosen value means more
3857 aggressive optimization, increasing the compile time.  This parameter
3858 should be removed when the delay slot code is rewritten to maintain the
3859 control-flow graph.
3861 @item max-gcse-memory
3862 The approximate maximum amount of memory that will be allocated in
3863 order to perform the global common subexpression elimination
3864 optimization.  If more memory than specified is required, the
3865 optimization will not be done.
3867 @item max-gcse-passes
3868 The maximum number of passes of GCSE to run.
3870 @item max-pending-list-length
3871 The maximum number of pending dependencies scheduling will allow
3872 before flushing the current state and starting over.  Large functions
3873 with few branches or calls can create excessively large lists which
3874 needlessly consume memory and resources.
3876 @item max-inline-insns
3877 If an function contains more than this many instructions, it
3878 will not be inlined.  This option is precisely equivalent to
3879 @option{-finline-limit}.
3881 @end table
3882 @end table
3884 @node Preprocessor Options
3885 @section Options Controlling the Preprocessor
3886 @cindex preprocessor options
3887 @cindex options, preprocessor
3889 These options control the C preprocessor, which is run on each C source
3890 file before actual compilation.
3892 If you use the @option{-E} option, nothing is done except preprocessing.
3893 Some of these options make sense only together with @option{-E} because
3894 they cause the preprocessor output to be unsuitable for actual
3895 compilation.
3897 @table @gcctabopt
3898 @item -include @var{file}
3899 @opindex include
3900 Process @var{file} as input before processing the regular input file.
3901 In effect, the contents of @var{file} are compiled first.  Any @option{-D}
3902 and @option{-U} options on the command line are always processed before
3903 @option{-include @var{file}}, regardless of the order in which they are
3904 written.  All the @option{-include} and @option{-imacros} options are
3905 processed in the order in which they are written.
3907 @item -imacros @var{file}
3908 @opindex imacros
3909 Process @var{file} as input, discarding the resulting output, before
3910 processing the regular input file.  Because the output generated from
3911 @var{file} is discarded, the only effect of @option{-imacros @var{file}}
3912 is to make the macros defined in @var{file} available for use in the
3913 main input.  All the @option{-include} and @option{-imacros} options are
3914 processed in the order in which they are written.
3916 @item -idirafter @var{dir}
3917 @opindex idirafter
3918 @cindex second include path
3919 Add the directory @var{dir} to the second include path.  The directories
3920 on the second include path are searched when a header file is not found
3921 in any of the directories in the main include path (the one that
3922 @option{-I} adds to).
3924 @item -iprefix @var{prefix}
3925 @opindex iprefix
3926 Specify @var{prefix} as the prefix for subsequent @option{-iwithprefix}
3927 options.
3929 @item -iwithprefix @var{dir}
3930 @opindex iwithprefix
3931 Add a directory to the second include path.  The directory's name is
3932 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
3933 specified previously with @option{-iprefix}.  If you have not specified a
3934 prefix yet, the directory containing the installed passes of the
3935 compiler is used as the default.
3937 @item -iwithprefixbefore @var{dir}
3938 @opindex iwithprefixbefore
3939 Add a directory to the main include path.  The directory's name is made
3940 by concatenating @var{prefix} and @var{dir}, as in the case of
3941 @option{-iwithprefix}.
3943 @item -isystem @var{dir}
3944 @opindex isystem
3945 Add a directory to the beginning of the second include path, marking it
3946 as a system directory, so that it gets the same special treatment as
3947 is applied to the standard system directories.
3949 @item -nostdinc
3950 @opindex nostdinc
3951 Do not search the standard system directories for header files.  Only
3952 the directories you have specified with @option{-I} options (and the
3953 current directory, if appropriate) are searched.  @xref{Directory
3954 Options}, for information on @option{-I}.
3956 By using both @option{-nostdinc} and @option{-I-}, you can limit the include-file
3957 search path to only those directories you specify explicitly.
3959 @item -remap
3960 @opindex remap
3961 When searching for a header file in a directory, remap file names if a
3962 file named @file{header.gcc} exists in that directory.  This can be used
3963 to work around limitations of file systems with file name restrictions.
3964 The @file{header.gcc} file should contain a series of lines with two
3965 tokens on each line: the first token is the name to map, and the second
3966 token is the actual name to use.
3968 @item -undef
3969 @opindex undef
3970 Do not predefine any nonstandard macros.  (Including architecture flags).
3972 @item -E
3973 @opindex E
3974 Run only the C preprocessor.  Preprocess all the C source files
3975 specified and output the results to standard output or to the
3976 specified output file.
3978 @item -C
3979 @opindex C
3980 Tell the preprocessor not to discard comments.  Used with the
3981 @option{-E} option.
3983 @item -P
3984 @opindex P
3985 Tell the preprocessor not to generate @samp{#line} directives.
3986 Used with the @option{-E} option.
3988 @cindex make
3989 @cindex dependencies, make
3990 @item -M
3991 @opindex M
3992 Instead of outputting the result of preprocessing, output a rule
3993 suitable for @code{make} describing the dependencies of the main source
3994 file.  The preprocessor outputs one @code{make} rule containing the
3995 object file name for that source file, a colon, and the names of all the
3996 included files.  Unless overridden explicitly, the object file name
3997 consists of the basename of the source file with any suffix replaced with
3998 object file suffix.  If there are many included files then the
3999 rule is split into several lines using @samp{\}-newline.
4001 @option{-M} implies @option{-E}.
4003 @item -MM
4004 @opindex MM
4005 Like @option{-M}, but mention only the files included with @samp{#include
4006 "@var{file}"}.  System header files included with @samp{#include
4007 <@var{file}>} are omitted.
4009 @item -MD
4010 @opindex MD
4011 Like @option{-M} but the dependency information is written to a file
4012 rather than stdout.  @code{gcc} will use the same file name and
4013 directory as the object file, but with the suffix @file{.d} instead.
4015 This is in addition to compiling the main file as specified---@option{-MD}
4016 does not inhibit ordinary compilation the way @option{-M} does,
4017 unless you also specify @option{-MG}.
4019 With Mach, you can use the utility @code{md} to merge multiple
4020 dependency files into a single dependency file suitable for using with
4021 the @samp{make} command.
4023 @item -MMD
4024 @opindex MMD
4025 Like @option{-MD} except mention only user header files, not system
4026 -header files.
4028 @item -MF @var{file}
4029 @opindex MF
4030 When used with @option{-M} or @option{-MM}, specifies a file to write the
4031 dependencies to.  This allows the preprocessor to write the preprocessed
4032 file to stdout normally.  If no @option{-MF} switch is given, CPP sends
4033 the rules to stdout and suppresses normal preprocessed output.
4035 Another way to specify output of a @code{make} rule is by setting
4036 the environment variable @env{DEPENDENCIES_OUTPUT} (@pxref{Environment
4037 Variables}).
4039 @item -MG
4040 @opindex MG
4041 When used with @option{-M} or @option{-MM}, @option{-MG} says to treat missing
4042 header files as generated files and assume they live in the same
4043 directory as the source file.  It suppresses preprocessed output, as a
4044 missing header file is ordinarily an error.
4046 This feature is used in automatic updating of makefiles.
4048 @item -MP
4049 @opindex MP
4050 This option instructs CPP to add a phony target for each dependency
4051 other than the main file, causing each to depend on nothing.  These
4052 dummy rules work around errors @code{make} gives if you remove header
4053 files without updating the @code{Makefile} to match.
4055 This is typical output:-
4057 @smallexample
4058 /tmp/test.o: /tmp/test.c /tmp/test.h
4060 /tmp/test.h:
4061 @end smallexample
4063 @item -MQ @var{target}
4064 @item -MT @var{target}
4065 @opindex MQ
4066 @opindex MT
4067 By default CPP uses the main file name, including any path, and appends
4068 the object suffix, normally ``.o'', to it to obtain the name of the
4069 target for dependency generation.  With @option{-MT} you can specify a
4070 target yourself, overriding the default one.
4072 If you want multiple targets, you can specify them as a single argument
4073 to @option{-MT}, or use multiple @option{-MT} options.
4075 The targets you specify are output in the order they appear on the
4076 command line.  @option{-MQ} is identical to @option{-MT}, except that the
4077 target name is quoted for Make, but with @option{-MT} it isn't.  For
4078 example, @option{-MT '$(objpfx)foo.o'} gives
4080 @smallexample
4081 $(objpfx)foo.o: /tmp/foo.c
4082 @end smallexample
4084 but @option{-MQ '$(objpfx)foo.o'} gives
4086 @smallexample
4087 $$(objpfx)foo.o: /tmp/foo.c
4088 @end smallexample
4090 The default target is automatically quoted, as if it were given with
4091 @option{-MQ}.
4093 @item -H
4094 @opindex H
4095 Print the name of each header file used, in addition to other normal
4096 activities.
4098 @item -A@var{question}(@var{answer})
4099 @opindex A
4100 Assert the answer @var{answer} for @var{question}, in case it is tested
4101 with a preprocessing conditional such as @samp{#if
4102 #@var{question}(@var{answer})}.  @option{-A-} disables the standard
4103 assertions that normally describe the target machine.
4105 @item -D@var{macro}
4106 @opindex D
4107 Define macro @var{macro} with the string @samp{1} as its definition.
4109 @item -D@var{macro}=@var{defn}
4110 Define macro @var{macro} as @var{defn}.  All instances of @option{-D} on
4111 the command line are processed before any @option{-U} options.
4113 Any @option{-D} and @option{-U} options on the command line are processed in
4114 order, and always before @option{-imacros @var{file}}, regardless of the
4115 order in which they are written.
4117 @item -U@var{macro}
4118 @opindex U
4119 Undefine macro @var{macro}.  @option{-U} options are evaluated after all
4120 @option{-D} options, but before any @option{-include} and @option{-imacros}
4121 options.
4123 Any @option{-D} and @option{-U} options on the command line are processed in
4124 order, and always before @option{-imacros @var{file}}, regardless of the
4125 order in which they are written.
4127 @item -dM
4128 @opindex dM
4129 Tell the preprocessor to output only a list of the macro definitions
4130 that are in effect at the end of preprocessing.  Used with the @option{-E}
4131 option.
4133 @item -dD
4134 @opindex dD
4135 Tell the preprocessing to pass all macro definitions into the output, in
4136 their proper sequence in the rest of the output.
4138 @item -dN
4139 @opindex dN
4140 Like @option{-dD} except that the macro arguments and contents are omitted.
4141 Only @samp{#define @var{name}} is included in the output.
4143 @item -dI
4144 @opindex dI
4145 Output @samp{#include} directives in addition to the result of
4146 preprocessing.
4148 @item -fpreprocessed
4149 @opindex fpreprocessed
4150 Indicate to the preprocessor that the input file has already been
4151 preprocessed.  This suppresses things like macro expansion, trigraph
4152 conversion, escaped newline splicing, and processing of most directives.
4153 The preprocessor still recognizes and removes comments, so that you can
4154 pass a file preprocessed with @option{-C} to the compiler without
4155 problems.  In this mode the integrated preprocessor is little more than
4156 a tokenizer for the front ends.
4158 @option{-fpreprocessed} is implicit if the input file has one of the
4159 extensions @samp{i}, @samp{ii} or @samp{mi}.  These are the extensions
4160 that GCC uses for preprocessed files created by @option{-save-temps}.
4162 @item -trigraphs
4163 @opindex trigraphs
4164 Process ISO standard trigraph sequences.  These are three-character
4165 sequences, all starting with @samp{??}, that are defined by ISO C to
4166 stand for single characters.  For example, @samp{??/} stands for
4167 @samp{\}, so @samp{'??/n'} is a character constant for a newline.  By
4168 default, GCC ignores trigraphs, but in standard-conforming modes it
4169 converts them.  See the @option{-std} and @option{-ansi} options.
4171 The nine trigraph sequences are
4172 @table @samp
4173 @item ??(
4174 @expansion{} @samp{[}
4176 @item ??)
4177 @expansion{} @samp{]}
4179 @item ??<
4180 @expansion{} @samp{@{}
4182 @item ??>
4183 @expansion{} @samp{@}}
4185 @item ??=
4186 @expansion{} @samp{#}
4188 @item ??/
4189 @expansion{} @samp{\}
4191 @item ??'
4192 @expansion{} @samp{^}
4194 @item ??!
4195 @expansion{} @samp{|}
4197 @item ??-
4198 @expansion{} @samp{~}
4200 @end table
4202 Trigraph support is not popular, so many compilers do not implement it
4203 properly.  Portable code should not rely on trigraphs being either
4204 converted or ignored.
4206 @item -Wp,@var{option}
4207 @opindex Wp
4208 Pass @var{option} as an option to the preprocessor.  If @var{option}
4209 contains commas, it is split into multiple options at the commas.
4210 @end table
4212 @node Assembler Options
4213 @section Passing Options to the Assembler
4215 @c prevent bad page break with this line
4216 You can pass options to the assembler.
4218 @table @gcctabopt
4219 @item -Wa,@var{option}
4220 @opindex Wa
4221 Pass @var{option} as an option to the assembler.  If @var{option}
4222 contains commas, it is split into multiple options at the commas.
4223 @end table
4225 @node Link Options
4226 @section Options for Linking
4227 @cindex link options
4228 @cindex options, linking
4230 These options come into play when the compiler links object files into
4231 an executable output file.  They are meaningless if the compiler is
4232 not doing a link step.
4234 @table @gcctabopt
4235 @cindex file names
4236 @item @var{object-file-name}
4237 A file name that does not end in a special recognized suffix is
4238 considered to name an object file or library.  (Object files are
4239 distinguished from libraries by the linker according to the file
4240 contents.)  If linking is done, these object files are used as input
4241 to the linker.
4243 @item -c
4244 @itemx -S
4245 @itemx -E
4246 @opindex c
4247 @opindex S
4248 @opindex E
4249 If any of these options is used, then the linker is not run, and
4250 object file names should not be used as arguments.  @xref{Overall
4251 Options}.
4253 @cindex Libraries
4254 @item -l@var{library}
4255 @itemx -l @var{library}
4256 @opindex l
4257 Search the library named @var{library} when linking.  (The second
4258 alternative with the library as a separate argument is only for
4259 POSIX compliance and is not recommended.)
4261 It makes a difference where in the command you write this option; the
4262 linker searches and processes libraries and object files in the order they
4263 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4264 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4265 to functions in @samp{z}, those functions may not be loaded.
4267 The linker searches a standard list of directories for the library,
4268 which is actually a file named @file{lib@var{library}.a}.  The linker
4269 then uses this file as if it had been specified precisely by name.
4271 The directories searched include several standard system directories
4272 plus any that you specify with @option{-L}.
4274 Normally the files found this way are library files---archive files
4275 whose members are object files.  The linker handles an archive file by
4276 scanning through it for members which define symbols that have so far
4277 been referenced but not defined.  But if the file that is found is an
4278 ordinary object file, it is linked in the usual fashion.  The only
4279 difference between using an @option{-l} option and specifying a file name
4280 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4281 and searches several directories.
4283 @item -lobjc
4284 @opindex lobjc
4285 You need this special case of the @option{-l} option in order to
4286 link an Objective-C program.
4288 @item -nostartfiles
4289 @opindex nostartfiles
4290 Do not use the standard system startup files when linking.
4291 The standard system libraries are used normally, unless @option{-nostdlib}
4292 or @option{-nodefaultlibs} is used.
4294 @item -nodefaultlibs
4295 @opindex nodefaultlibs
4296 Do not use the standard system libraries when linking.
4297 Only the libraries you specify will be passed to the linker.
4298 The standard startup files are used normally, unless @option{-nostartfiles}
4299 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4300 for System V (and ISO C) environments or to bcopy and bzero for
4301 BSD environments.  These entries are usually resolved by entries in
4302 libc.  These entry points should be supplied through some other
4303 mechanism when this option is specified.
4305 @item -nostdlib
4306 @opindex nostdlib
4307 Do not use the standard system startup files or libraries when linking.
4308 No startup files and only the libraries you specify will be passed to
4309 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4310 for System V (and ISO C) environments or to bcopy and bzero for
4311 BSD environments.  These entries are usually resolved by entries in
4312 libc.  These entry points should be supplied through some other
4313 mechanism when this option is specified.
4315 @cindex @option{-lgcc}, use with @option{-nostdlib}
4316 @cindex @option{-nostdlib} and unresolved references
4317 @cindex unresolved references and @option{-nostdlib}
4318 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4319 @cindex @option{-nodefaultlibs} and unresolved references
4320 @cindex unresolved references and @option{-nodefaultlibs}
4321 One of the standard libraries bypassed by @option{-nostdlib} and
4322 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4323 that GCC uses to overcome shortcomings of particular machines, or special
4324 needs for some languages.
4325 @ifset INTERNALS
4326 (@xref{Interface,,Interfacing to GCC Output}, for more discussion of
4327 @file{libgcc.a}.)
4328 @end ifset
4329 @ifclear INTERNALS
4330 (@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
4331 for more discussion of @file{libgcc.a}.)
4332 @end ifclear
4333 In most cases, you need @file{libgcc.a} even when you want to avoid
4334 other standard libraries.  In other words, when you specify @option{-nostdlib}
4335 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4336 This ensures that you have no unresolved references to internal GCC
4337 library subroutines.  (For example, @samp{__main}, used to ensure C++
4338 constructors will be called; @pxref{Collect2,,@command{collect2}}.)
4340 @item -s
4341 @opindex s
4342 Remove all symbol table and relocation information from the executable.
4344 @item -static
4345 @opindex static
4346 On systems that support dynamic linking, this prevents linking with the shared
4347 libraries.  On other systems, this option has no effect.
4349 @item -shared
4350 @opindex shared
4351 Produce a shared object which can then be linked with other objects to
4352 form an executable.  Not all systems support this option.  For predictable
4353 results, you must also specify the same set of options that were used to
4354 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4355 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4356 needs to build supplementary stub code for constructors to work.  On
4357 multi-libbed systems, @samp{gcc -shared} must select the correct support
4358 libraries to link against.  Failing to supply the correct flags may lead
4359 to subtle defects.  Supplying them in cases where they are not necessary
4360 is innocuous.}
4362 @item -shared-libgcc
4363 @itemx -static-libgcc
4364 @opindex shared-libgcc
4365 @opindex static-libgcc
4366 On systems that provide @file{libgcc} as a shared library, these options
4367 force the use of either the shared or static version respectively.
4368 If no shared version of @file{libgcc} was built when the compiler was
4369 configured, these options have no effect.
4371 There are several situations in which an application should use the
4372 shared @file{libgcc} instead of the static version.  The most common
4373 of these is when the application wishes to throw and catch exceptions
4374 across different shared libraries.  In that case, each of the libraries
4375 as well as the application itself should use the shared @file{libgcc}.
4377 Therefore, whenever you specify the @option{-shared} option, the GCC
4378 driver automatically adds @option{-shared-libgcc}, unless you explicitly
4379 specify @option{-static-libgcc}.  The G++ driver automatically adds
4380 @option{-shared-libgcc} when you build a main executable as well because
4381 for C++ programs that is typically the right thing to do.
4382 (Exception-handling will not work reliably otherwise.)
4384 However, when linking a main executable written in C, you must
4385 explicitly say @option{-shared-libgcc} if you want to use the shared
4386 @file{libgcc}.
4388 @item -symbolic
4389 @opindex symbolic
4390 Bind references to global symbols when building a shared object.  Warn
4391 about any unresolved references (unless overridden by the link editor
4392 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4393 this option.
4395 @item -Xlinker @var{option}
4396 @opindex Xlinker
4397 Pass @var{option} as an option to the linker.  You can use this to
4398 supply system-specific linker options which GCC does not know how to
4399 recognize.
4401 If you want to pass an option that takes an argument, you must use
4402 @option{-Xlinker} twice, once for the option and once for the argument.
4403 For example, to pass @option{-assert definitions}, you must write
4404 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4405 @option{-Xlinker "-assert definitions"}, because this passes the entire
4406 string as a single argument, which is not what the linker expects.
4408 @item -Wl,@var{option}
4409 @opindex Wl
4410 Pass @var{option} as an option to the linker.  If @var{option} contains
4411 commas, it is split into multiple options at the commas.
4413 @item -u @var{symbol}
4414 @opindex u
4415 Pretend the symbol @var{symbol} is undefined, to force linking of
4416 library modules to define it.  You can use @option{-u} multiple times with
4417 different symbols to force loading of additional library modules.
4418 @end table
4420 @node Directory Options
4421 @section Options for Directory Search
4422 @cindex directory options
4423 @cindex options, directory search
4424 @cindex search path
4426 These options specify directories to search for header files, for
4427 libraries and for parts of the compiler:
4429 @table @gcctabopt
4430 @item -I@var{dir}
4431 @opindex I
4432 Add the directory @var{dir} to the head of the list of directories to be
4433 searched for header files.  This can be used to override a system header
4434 file, substituting your own version, since these directories are
4435 searched before the system header file directories.  However, you should
4436 not use this option to add directories that contain vendor-supplied
4437 system header files (use @option{-isystem} for that).  If you use more than
4438 one @option{-I} option, the directories are scanned in left-to-right
4439 order; the standard system directories come after.
4441 If a standard system include directory, or a directory specified with
4442 @option{-isystem}, is also specified with @option{-I}, it will be
4443 searched only in the position requested by @option{-I}.  Also, it will
4444 not be considered a system include directory.  If that directory really
4445 does contain system headers, there is a good chance that they will
4446 break.  For instance, if GCC's installation procedure edited the headers
4447 in @file{/usr/include} to fix bugs, @samp{-I/usr/include} will cause the
4448 original, buggy headers to be found instead of the corrected ones.  GCC
4449 will issue a warning when a system include directory is hidden in this
4450 way.
4452 @item -I-
4453 @opindex I-
4454 Any directories you specify with @option{-I} options before the @option{-I-}
4455 option are searched only for the case of @samp{#include "@var{file}"};
4456 they are not searched for @samp{#include <@var{file}>}.
4458 If additional directories are specified with @option{-I} options after
4459 the @option{-I-}, these directories are searched for all @samp{#include}
4460 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4461 this way.)
4463 In addition, the @option{-I-} option inhibits the use of the current
4464 directory (where the current input file came from) as the first search
4465 directory for @samp{#include "@var{file}"}.  There is no way to
4466 override this effect of @option{-I-}.  With @option{-I.} you can specify
4467 searching the directory which was current when the compiler was
4468 invoked.  That is not exactly the same as what the preprocessor does
4469 by default, but it is often satisfactory.
4471 @option{-I-} does not inhibit the use of the standard system directories
4472 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4473 independent.
4475 @item -L@var{dir}
4476 @opindex L
4477 Add directory @var{dir} to the list of directories to be searched
4478 for @option{-l}.
4480 @item -B@var{prefix}
4481 @opindex B
4482 This option specifies where to find the executables, libraries,
4483 include files, and data files of the compiler itself.
4485 The compiler driver program runs one or more of the subprograms
4486 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4487 @var{prefix} as a prefix for each program it tries to run, both with and
4488 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4490 For each subprogram to be run, the compiler driver first tries the
4491 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4492 was not specified, the driver tries two standard prefixes, which are
4493 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4494 those results in a file name that is found, the unmodified program
4495 name is searched for using the directories specified in your
4496 @env{PATH} environment variable.
4498 The compiler will check to see if the path provided by the @option{-B}
4499 refers to a directory, and if necessary it will add a directory
4500 separator character at the end of the path.
4502 @option{-B} prefixes that effectively specify directory names also apply
4503 to libraries in the linker, because the compiler translates these
4504 options into @option{-L} options for the linker.  They also apply to
4505 includes files in the preprocessor, because the compiler translates these
4506 options into @option{-isystem} options for the preprocessor.  In this case,
4507 the compiler appends @samp{include} to the prefix.
4509 The run-time support file @file{libgcc.a} can also be searched for using
4510 the @option{-B} prefix, if needed.  If it is not found there, the two
4511 standard prefixes above are tried, and that is all.  The file is left
4512 out of the link if it is not found by those means.
4514 Another way to specify a prefix much like the @option{-B} prefix is to use
4515 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4516 Variables}.
4518 As a special kludge, if the path provided by @option{-B} is
4519 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4520 9, then it will be replaced by @file{[dir/]include}.  This is to help
4521 with boot-strapping the compiler.
4523 @item -specs=@var{file}
4524 @opindex specs
4525 Process @var{file} after the compiler reads in the standard @file{specs}
4526 file, in order to override the defaults that the @file{gcc} driver
4527 program uses when determining what switches to pass to @file{cc1},
4528 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4529 @option{-specs=@var{file}} can be specified on the command line, and they
4530 are processed in order, from left to right.
4531 @end table
4533 @c man end
4535 @node Spec Files
4536 @section Specifying subprocesses and the switches to pass to them
4537 @cindex Spec Files
4538 @command{gcc} is a driver program.  It performs its job by invoking a
4539 sequence of other programs to do the work of compiling, assembling and
4540 linking.  GCC interprets its command-line parameters and uses these to
4541 deduce which programs it should invoke, and which command-line options
4542 it ought to place on their command lines.  This behaviour is controlled
4543 by @dfn{spec strings}.  In most cases there is one spec string for each
4544 program that GCC can invoke, but a few programs have multiple spec
4545 strings to control their behaviour.  The spec strings built into GCC can
4546 be overridden by using the @option{-specs=} command-line switch to specify
4547 a spec file.
4549 @dfn{Spec files} are plaintext files that are used to construct spec
4550 strings.  They consist of a sequence of directives separated by blank
4551 lines.  The type of directive is determined by the first non-whitespace
4552 character on the line and it can be one of the following:
4554 @table @code
4555 @item %@var{command}
4556 Issues a @var{command} to the spec file processor.  The commands that can
4557 appear here are:
4559 @table @code
4560 @item %include <@var{file}>
4561 @cindex %include
4562 Search for @var{file} and insert its text at the current point in the
4563 specs file.
4565 @item %include_noerr <@var{file}>
4566 @cindex %include_noerr
4567 Just like @samp{%include}, but do not generate an error message if the include
4568 file cannot be found.
4570 @item %rename @var{old_name} @var{new_name}
4571 @cindex %rename
4572 Rename the spec string @var{old_name} to @var{new_name}.
4574 @end table
4576 @item *[@var{spec_name}]:
4577 This tells the compiler to create, override or delete the named spec
4578 string.  All lines after this directive up to the next directive or
4579 blank line are considered to be the text for the spec string.  If this
4580 results in an empty string then the spec will be deleted.  (Or, if the
4581 spec did not exist, then nothing will happened.)  Otherwise, if the spec
4582 does not currently exist a new spec will be created.  If the spec does
4583 exist then its contents will be overridden by the text of this
4584 directive, unless the first character of that text is the @samp{+}
4585 character, in which case the text will be appended to the spec.
4587 @item [@var{suffix}]:
4588 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
4589 and up to the next directive or blank line are considered to make up the
4590 spec string for the indicated suffix.  When the compiler encounters an
4591 input file with the named suffix, it will processes the spec string in
4592 order to work out how to compile that file.  For example:
4594 @smallexample
4595 .ZZ:
4596 z-compile -input %i
4597 @end smallexample
4599 This says that any input file whose name ends in @samp{.ZZ} should be
4600 passed to the program @samp{z-compile}, which should be invoked with the
4601 command-line switch @option{-input} and with the result of performing the
4602 @samp{%i} substitution.  (See below.)
4604 As an alternative to providing a spec string, the text that follows a
4605 suffix directive can be one of the following:
4607 @table @code
4608 @item @@@var{language}
4609 This says that the suffix is an alias for a known @var{language}.  This is
4610 similar to using the @option{-x} command-line switch to GCC to specify a
4611 language explicitly.  For example:
4613 @smallexample
4614 .ZZ:
4615 @@c++
4616 @end smallexample
4618 Says that .ZZ files are, in fact, C++ source files.
4620 @item #@var{name}
4621 This causes an error messages saying:
4623 @smallexample
4624 @var{name} compiler not installed on this system.
4625 @end smallexample
4626 @end table
4628 GCC already has an extensive list of suffixes built into it.
4629 This directive will add an entry to the end of the list of suffixes, but
4630 since the list is searched from the end backwards, it is effectively
4631 possible to override earlier entries using this technique.
4633 @end table
4635 GCC has the following spec strings built into it.  Spec files can
4636 override these strings or create their own.  Note that individual
4637 targets can also add their own spec strings to this list.
4639 @smallexample
4640 asm          Options to pass to the assembler
4641 asm_final    Options to pass to the assembler post-processor
4642 cpp          Options to pass to the C preprocessor
4643 cc1          Options to pass to the C compiler
4644 cc1plus      Options to pass to the C++ compiler
4645 endfile      Object files to include at the end of the link
4646 link         Options to pass to the linker
4647 lib          Libraries to include on the command line to the linker
4648 libgcc       Decides which GCC support library to pass to the linker
4649 linker       Sets the name of the linker
4650 predefines   Defines to be passed to the C preprocessor
4651 signed_char  Defines to pass to CPP to say whether @code{char} is signed
4652              by default
4653 startfile    Object files to include at the start of the link
4654 @end smallexample
4656 Here is a small example of a spec file:
4658 @smallexample
4659 %rename lib                 old_lib
4661 *lib:
4662 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
4663 @end smallexample
4665 This example renames the spec called @samp{lib} to @samp{old_lib} and
4666 then overrides the previous definition of @samp{lib} with a new one.
4667 The new definition adds in some extra command-line options before
4668 including the text of the old definition.
4670 @dfn{Spec strings} are a list of command-line options to be passed to their
4671 corresponding program.  In addition, the spec strings can contain
4672 @samp{%}-prefixed sequences to substitute variable text or to
4673 conditionally insert text into the command line.  Using these constructs
4674 it is possible to generate quite complex command lines.
4676 Here is a table of all defined @samp{%}-sequences for spec
4677 strings.  Note that spaces are not generated automatically around the
4678 results of expanding these sequences.  Therefore you can concatenate them
4679 together or combine them with constant text in a single argument.
4681 @table @code
4682 @item %%
4683 Substitute one @samp{%} into the program name or argument.
4685 @item %i
4686 Substitute the name of the input file being processed.
4688 @item %b
4689 Substitute the basename of the input file being processed.
4690 This is the substring up to (and not including) the last period
4691 and not including the directory.
4693 @item %B
4694 This is the same as @samp{%b}, but include the file suffix (text after
4695 the last period).
4697 @item %d
4698 Marks the argument containing or following the @samp{%d} as a
4699 temporary file name, so that that file will be deleted if GCC exits
4700 successfully.  Unlike @samp{%g}, this contributes no text to the
4701 argument.
4703 @item %g@var{suffix}
4704 Substitute a file name that has suffix @var{suffix} and is chosen
4705 once per compilation, and mark the argument in the same way as
4706 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
4707 name is now chosen in a way that is hard to predict even when previously
4708 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
4709 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
4710 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4711 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
4712 was simply substituted with a file name chosen once per compilation,
4713 without regard to any appended suffix (which was therefore treated
4714 just like ordinary text), making such attacks more likely to succeed.
4716 @item %u@var{suffix}
4717 Like @samp{%g}, but generates a new temporary file name even if
4718 @samp{%u@var{suffix}} was already seen.
4720 @item %U@var{suffix}
4721 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4722 new one if there is no such last file name.  In the absence of any
4723 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4724 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
4725 would involve the generation of two distinct file names, one
4726 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
4727 simply substituted with a file name chosen for the previous @samp{%u},
4728 without regard to any appended suffix.
4730 @item %j@var{SUFFIX}
4731 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
4732 writable, and if save-temps is off; otherwise, substitute the name
4733 of a temporary file, just like @samp{%u}.  This temporary file is not
4734 meant for communication between processes, but rather as a junk
4735 disposal mechanism.
4737 @item %.@var{SUFFIX}
4738 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4739 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
4740 terminated by the next space or %.
4742 @item %w
4743 Marks the argument containing or following the @samp{%w} as the
4744 designated output file of this compilation.  This puts the argument
4745 into the sequence of arguments that @samp{%o} will substitute later.
4747 @item %o
4748 Substitutes the names of all the output files, with spaces
4749 automatically placed around them.  You should write spaces
4750 around the @samp{%o} as well or the results are undefined.
4751 @samp{%o} is for use in the specs for running the linker.
4752 Input files whose names have no recognized suffix are not compiled
4753 at all, but they are included among the output files, so they will
4754 be linked.
4756 @item %O
4757 Substitutes the suffix for object files.  Note that this is
4758 handled specially when it immediately follows @samp{%g, %u, or %U},
4759 because of the need for those to form complete file names.  The
4760 handling is such that @samp{%O} is treated exactly as if it had already
4761 been substituted, except that @samp{%g, %u, and %U} do not currently
4762 support additional @var{suffix} characters following @samp{%O} as they would
4763 following, for example, @samp{.o}.
4765 @item %p
4766 Substitutes the standard macro predefinitions for the
4767 current target machine.  Use this when running @code{cpp}.
4769 @item %P
4770 Like @samp{%p}, but puts @samp{__} before and after the name of each
4771 predefined macro, except for macros that start with @samp{__} or with
4772 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
4775 @item %I
4776 Substitute a @option{-iprefix} option made from @env{GCC_EXEC_PREFIX}.
4778 @item %s
4779 Current argument is the name of a library or startup file of some sort.
4780 Search for that file in a standard list of directories and substitute
4781 the full name found.
4783 @item %e@var{str}
4784 Print @var{str} as an error message.  @var{str} is terminated by a newline.
4785 Use this when inconsistent options are detected.
4787 @item %|
4788 Output @samp{-} if the input for the current command is coming from a pipe.
4790 @item %(@var{name})
4791 Substitute the contents of spec string @var{name} at this point.
4793 @item %[@var{name}]
4794 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
4796 @item %x@{@var{option}@}
4797 Accumulate an option for @samp{%X}.
4799 @item %X
4800 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
4801 spec string.
4803 @item %Y
4804 Output the accumulated assembler options specified by @option{-Wa}.
4806 @item %Z
4807 Output the accumulated preprocessor options specified by @option{-Wp}.
4809 @item %v1
4810 Substitute the major version number of GCC@.
4811 (For version 2.9.5, this is 2.)
4813 @item %v2
4814 Substitute the minor version number of GCC@.
4815 (For version 2.9.5, this is 9.)
4817 @item %v3
4818 Substitute the patch level number of GCC@.
4819 (For version 2.9.5, this is 5.)
4821 @item %a
4822 Process the @code{asm} spec.  This is used to compute the
4823 switches to be passed to the assembler.
4825 @item %A
4826 Process the @code{asm_final} spec.  This is a spec string for
4827 passing switches to an assembler post-processor, if such a program is
4828 needed.
4830 @item %l
4831 Process the @code{link} spec.  This is the spec for computing the
4832 command line passed to the linker.  Typically it will make use of the
4833 @samp{%L %G %S %D and %E} sequences.
4835 @item %D
4836 Dump out a @option{-L} option for each directory that GCC believes might
4837 contain startup files.  If the target supports multilibs then the
4838 current multilib directory will be prepended to each of these paths.
4840 @item %M
4841 Output the multilib directory with directory separators replaced with
4842 @samp{_}.  If multilib directories are not set, or the multilib directory is
4843 @file{.} then this option emits nothing.
4845 @item %L
4846 Process the @code{lib} spec.  This is a spec string for deciding which
4847 libraries should be included on the command line to the linker.
4849 @item %G
4850 Process the @code{libgcc} spec.  This is a spec string for deciding
4851 which GCC support library should be included on the command line to the linker.
4853 @item %S
4854 Process the @code{startfile} spec.  This is a spec for deciding which
4855 object files should be the first ones passed to the linker.  Typically
4856 this might be a file named @file{crt0.o}.
4858 @item %E
4859 Process the @code{endfile} spec.  This is a spec string that specifies
4860 the last object files that will be passed to the linker.
4862 @item %C
4863 Process the @code{cpp} spec.  This is used to construct the arguments
4864 to be passed to the C preprocessor.
4866 @item %c
4867 Process the @code{signed_char} spec.  This is intended to be used
4868 to tell cpp whether a char is signed.  It typically has the definition:
4869 @smallexample
4870 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
4871 @end smallexample
4873 @item %1
4874 Process the @code{cc1} spec.  This is used to construct the options to be
4875 passed to the actual C compiler (@samp{cc1}).
4877 @item %2
4878 Process the @code{cc1plus} spec.  This is used to construct the options to be
4879 passed to the actual C++ compiler (@samp{cc1plus}).
4881 @item %*
4882 Substitute the variable part of a matched option.  See below.
4883 Note that each comma in the substituted string is replaced by
4884 a single space.
4886 @item %@{@code{S}@}
4887 Substitutes the @code{-S} switch, if that switch was given to GCC@.
4888 If that switch was not specified, this substitutes nothing.  Note that
4889 the leading dash is omitted when specifying this option, and it is
4890 automatically inserted if the substitution is performed.  Thus the spec
4891 string @samp{%@{foo@}} would match the command-line option @option{-foo}
4892 and would output the command line option @option{-foo}.
4894 @item %W@{@code{S}@}
4895 Like %@{@code{S}@} but mark last argument supplied within as a file to be
4896 deleted on failure.
4898 @item %@{@code{S}*@}
4899 Substitutes all the switches specified to GCC whose names start
4900 with @code{-S}, but which also take an argument.  This is used for
4901 switches like @option{-o}, @option{-D}, @option{-I}, etc.
4902 GCC considers @option{-o foo} as being
4903 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
4904 text, including the space.  Thus two arguments would be generated.
4906 @item %@{^@code{S}*@}
4907 Like %@{@code{S}*@}, but don't put a blank between a switch and its
4908 argument.  Thus %@{^o*@} would only generate one argument, not two.
4910 @item %@{@code{S}*&@code{T}*@}
4911 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4912 (the order of @code{S} and @code{T} in the spec is not significant).
4913 There can be any number of ampersand-separated variables; for each the
4914 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
4916 @item %@{<@code{S}@}
4917 Remove all occurrences of @code{-S} from the command line.  Note---this
4918 command is position dependent.  @samp{%} commands in the spec string
4919 before this option will see @code{-S}, @samp{%} commands in the spec
4920 string after this option will not.
4922 @item %@{@code{S}*:@code{X}@}
4923 Substitutes @code{X} if one or more switches whose names start with
4924 @code{-S} are specified to GCC@.  Note that the tail part of the
4925 @code{-S} option (i.e.@: the part matched by the @samp{*}) will be substituted
4926 for each occurrence of @samp{%*} within @code{X}.
4928 @item %@{@code{S}:@code{X}@}
4929 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC@.
4931 @item %@{!@code{S}:@code{X}@}
4932 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC@.
4934 @item %@{|@code{S}:@code{X}@}
4935 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4937 @item %@{|!@code{S}:@code{X}@}
4938 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4940 @item %@{.@code{S}:@code{X}@}
4941 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4943 @item %@{!.@code{S}:@code{X}@}
4944 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4946 @item %@{@code{S}|@code{P}:@code{X}@}
4947 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.  This may be
4948 combined with @samp{!} and @samp{.} sequences as well, although they
4949 have a stronger binding than the @samp{|}.  For example a spec string
4950 like this:
4952 @smallexample
4953 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4954 @end smallexample
4956 will output the following command-line options from the following input
4957 command-line options:
4959 @smallexample
4960 fred.c        -foo -baz
4961 jim.d         -bar -boggle
4962 -d fred.c     -foo -baz -boggle
4963 -d jim.d      -bar -baz -boggle
4964 @end smallexample
4966 @end table
4968 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4969 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4970 or spaces, or even newlines.  They are processed as usual, as described
4971 above.
4973 The @option{-O}, @option{-f}, @option{-m}, and @option{-W}
4974 switches are handled specifically in these
4975 constructs.  If another value of @option{-O} or the negated form of a @option{-f}, @option{-m}, or
4976 @option{-W} switch is found later in the command line, the earlier switch
4977 value is ignored, except with @{@code{S}*@} where @code{S} is just one
4978 letter, which passes all matching options.
4980 The character @samp{|} at the beginning of the predicate text is used to indicate
4981 that a command should be piped to the following command, but only if @option{-pipe}
4982 is specified.
4984 It is built into GCC which switches take arguments and which do not.
4985 (You might think it would be useful to generalize this to allow each
4986 compiler's spec to say which switches take arguments.  But this cannot
4987 be done in a consistent fashion.  GCC cannot even decide which input
4988 files have been specified without knowing which switches take arguments,
4989 and it must know which input files to compile in order to tell which
4990 compilers to run).
4992 GCC also knows implicitly that arguments starting in @option{-l} are to be
4993 treated as compiler output files, and passed to the linker in their
4994 proper position among the other output files.
4996 @c man begin OPTIONS
4998 @node Target Options
4999 @section Specifying Target Machine and Compiler Version
5000 @cindex target options
5001 @cindex cross compiling
5002 @cindex specifying machine version
5003 @cindex specifying compiler version and target machine
5004 @cindex compiler version, specifying
5005 @cindex target machine, specifying
5007 By default, GCC compiles code for the same type of machine that you
5008 are using.  However, it can also be installed as a cross-compiler, to
5009 compile for some other type of machine.  In fact, several different
5010 configurations of GCC, for different target machines, can be
5011 installed side by side.  Then you specify which one to use with the
5012 @option{-b} option.
5014 In addition, older and newer versions of GCC can be installed side
5015 by side.  One of them (probably the newest) will be the default, but
5016 you may sometimes wish to use another.
5018 @table @gcctabopt
5019 @item -b @var{machine}
5020 @opindex b
5021 The argument @var{machine} specifies the target machine for compilation.
5022 This is useful when you have installed GCC as a cross-compiler.
5024 The value to use for @var{machine} is the same as was specified as the
5025 machine type when configuring GCC as a cross-compiler.  For
5026 example, if a cross-compiler was configured with @samp{configure
5027 i386v}, meaning to compile for an 80386 running System V, then you
5028 would specify @option{-b i386v} to run that cross compiler.
5030 When you do not specify @option{-b}, it normally means to compile for
5031 the same type of machine that you are using.
5033 @item -V @var{version}
5034 @opindex V
5035 The argument @var{version} specifies which version of GCC to run.
5036 This is useful when multiple versions are installed.  For example,
5037 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5039 The default version, when you do not specify @option{-V}, is the last
5040 version of GCC that you installed.
5041 @end table
5043 The @option{-b} and @option{-V} options actually work by controlling part of
5044 the file name used for the executable files and libraries used for
5045 compilation.  A given version of GCC, for a given target machine, is
5046 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.
5048 Thus, sites can customize the effect of @option{-b} or @option{-V} either by
5049 changing the names of these directories or adding alternate names (or
5050 symbolic links).  If in directory @file{/usr/local/lib/gcc-lib/} the
5051 file @file{80386} is a link to the file @file{i386v}, then @option{-b
5052 80386} becomes an alias for @option{-b i386v}.
5054 In one respect, the @option{-b} or @option{-V} do not completely change
5055 to a different compiler: the top-level driver program @command{gcc}
5056 that you originally invoked continues to run and invoke the other
5057 executables (preprocessor, compiler per se, assembler and linker)
5058 that do the real work.  However, since no real work is done in the
5059 driver program, it usually does not matter that the driver program
5060 in use is not the one for the specified target.  It is common for the
5061 interface to the other executables to change incompatibly between
5062 compiler versions, so unless the version specified is very close to that
5063 of the driver (for example, @option{-V 3.0} with a driver program from GCC
5064 version 3.0.1), use of @option{-V} may not work; for example, using
5065 @option{-V 2.95.2} will not work with a driver program from GCC 3.0.
5067 The only way that the driver program depends on the target machine is
5068 in the parsing and handling of special machine-specific options.
5069 However, this is controlled by a file which is found, along with the
5070 other executables, in the directory for the specified version and
5071 target machine.  As a result, a single installed driver program adapts
5072 to any specified target machine, and sufficiently similar compiler
5073 versions.
5075 The driver program executable does control one significant thing,
5076 however: the default version and target machine.  Therefore, you can
5077 install different instances of the driver program, compiled for
5078 different targets or versions, under different names.
5080 For example, if the driver for version 2.0 is installed as @command{ogcc}
5081 and that for version 2.1 is installed as @command{gcc}, then the command
5082 @command{gcc} will use version 2.1 by default, while @command{ogcc} will use
5083 2.0 by default.  However, you can choose either version with either
5084 command with the @option{-V} option.
5086 @node Submodel Options
5087 @section Hardware Models and Configurations
5088 @cindex submodel options
5089 @cindex specifying hardware config
5090 @cindex hardware models and configurations, specifying
5091 @cindex machine dependent options
5093 Earlier we discussed the standard option @option{-b} which chooses among
5094 different installed compilers for completely different target
5095 machines, such as VAX vs.@: 68000 vs.@: 80386.
5097 In addition, each of these target machine types can have its own
5098 special options, starting with @samp{-m}, to choose among various
5099 hardware models or configurations---for example, 68010 vs 68020,
5100 floating coprocessor or none.  A single installed version of the
5101 compiler can compile for any model or configuration, according to the
5102 options specified.
5104 Some configurations of the compiler also support additional special
5105 options, usually for compatibility with other compilers on the same
5106 platform.
5108 @ifset INTERNALS
5109 These options are defined by the macro @code{TARGET_SWITCHES} in the
5110 machine description.  The default for the options is also defined by
5111 that macro, which enables you to change the defaults.
5112 @end ifset
5114 @menu
5115 * M680x0 Options::
5116 * M68hc1x Options::
5117 * VAX Options::
5118 * SPARC Options::
5119 * Convex Options::
5120 * AMD29K Options::
5121 * ARM Options::
5122 * MN10200 Options::
5123 * MN10300 Options::
5124 * M32R/D Options::
5125 * M88K Options::
5126 * RS/6000 and PowerPC Options::
5127 * RT Options::
5128 * MIPS Options::
5129 * i386 and x86-64 Options::
5130 * HPPA Options::
5131 * Intel 960 Options::
5132 * DEC Alpha Options::
5133 * Clipper Options::
5134 * H8/300 Options::
5135 * SH Options::
5136 * System V Options::
5137 * TMS320C3x/C4x Options::
5138 * V850 Options::
5139 * ARC Options::
5140 * NS32K Options::
5141 * AVR Options::
5142 * MCore Options::
5143 * IA-64 Options::
5144 * D30V Options::
5145 * S/390 and zSeries Options::
5146 * CRIS Options::
5147 * MMIX Options::
5148 @end menu
5150 @node M680x0 Options
5151 @subsection M680x0 Options
5152 @cindex M680x0 options
5154 These are the @samp{-m} options defined for the 68000 series.  The default
5155 values for these options depends on which style of 68000 was selected when
5156 the compiler was configured; the defaults for the most common choices are
5157 given below.
5159 @table @gcctabopt
5160 @item -m68000
5161 @itemx -mc68000
5162 @opindex m68000
5163 @opindex mc68000
5164 Generate output for a 68000.  This is the default
5165 when the compiler is configured for 68000-based systems.
5167 Use this option for microcontrollers with a 68000 or EC000 core,
5168 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5170 @item -m68020
5171 @itemx -mc68020
5172 @opindex m68020
5173 @opindex mc68020
5174 Generate output for a 68020.  This is the default
5175 when the compiler is configured for 68020-based systems.
5177 @item -m68881
5178 @opindex m68881
5179 Generate output containing 68881 instructions for floating point.
5180 This is the default for most 68020 systems unless @option{--nfp} was
5181 specified when the compiler was configured.
5183 @item -m68030
5184 @opindex m68030
5185 Generate output for a 68030.  This is the default when the compiler is
5186 configured for 68030-based systems.
5188 @item -m68040
5189 @opindex m68040
5190 Generate output for a 68040.  This is the default when the compiler is
5191 configured for 68040-based systems.
5193 This option inhibits the use of 68881/68882 instructions that have to be
5194 emulated by software on the 68040.  Use this option if your 68040 does not
5195 have code to emulate those instructions.
5197 @item -m68060
5198 @opindex m68060
5199 Generate output for a 68060.  This is the default when the compiler is
5200 configured for 68060-based systems.
5202 This option inhibits the use of 68020 and 68881/68882 instructions that
5203 have to be emulated by software on the 68060.  Use this option if your 68060
5204 does not have code to emulate those instructions.
5206 @item -mcpu32
5207 @opindex mcpu32
5208 Generate output for a CPU32.  This is the default
5209 when the compiler is configured for CPU32-based systems.
5211 Use this option for microcontrollers with a
5212 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5213 68336, 68340, 68341, 68349 and 68360.
5215 @item -m5200
5216 @opindex m5200
5217 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5218 when the compiler is configured for 520X-based systems.
5220 Use this option for microcontroller with a 5200 core, including
5221 the MCF5202, MCF5203, MCF5204 and MCF5202.
5224 @item -m68020-40
5225 @opindex m68020-40
5226 Generate output for a 68040, without using any of the new instructions.
5227 This results in code which can run relatively efficiently on either a
5228 68020/68881 or a 68030 or a 68040.  The generated code does use the
5229 68881 instructions that are emulated on the 68040.
5231 @item -m68020-60
5232 @opindex m68020-60
5233 Generate output for a 68060, without using any of the new instructions.
5234 This results in code which can run relatively efficiently on either a
5235 68020/68881 or a 68030 or a 68040.  The generated code does use the
5236 68881 instructions that are emulated on the 68060.
5238 @item -mfpa
5239 @opindex mfpa
5240 Generate output containing Sun FPA instructions for floating point.
5242 @item -msoft-float
5243 @opindex msoft-float
5244 Generate output containing library calls for floating point.
5245 @strong{Warning:} the requisite libraries are not available for all m68k
5246 targets.  Normally the facilities of the machine's usual C compiler are
5247 used, but this can't be done directly in cross-compilation.  You must
5248 make your own arrangements to provide suitable library functions for
5249 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5250 @samp{m68k-*-coff} do provide software floating point support.
5252 @item -mshort
5253 @opindex mshort
5254 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5256 @item -mnobitfield
5257 @opindex mnobitfield
5258 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5259 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5261 @item -mbitfield
5262 @opindex mbitfield
5263 Do use the bit-field instructions.  The @option{-m68020} option implies
5264 @option{-mbitfield}.  This is the default if you use a configuration
5265 designed for a 68020.
5267 @item -mrtd
5268 @opindex mrtd
5269 Use a different function-calling convention, in which functions
5270 that take a fixed number of arguments return with the @code{rtd}
5271 instruction, which pops their arguments while returning.  This
5272 saves one instruction in the caller since there is no need to pop
5273 the arguments there.
5275 This calling convention is incompatible with the one normally
5276 used on Unix, so you cannot use it if you need to call libraries
5277 compiled with the Unix compiler.
5279 Also, you must provide function prototypes for all functions that
5280 take variable numbers of arguments (including @code{printf});
5281 otherwise incorrect code will be generated for calls to those
5282 functions.
5284 In addition, seriously incorrect code will result if you call a
5285 function with too many arguments.  (Normally, extra arguments are
5286 harmlessly ignored.)
5288 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5289 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5291 @item -malign-int
5292 @itemx -mno-align-int
5293 @opindex malign-int
5294 @opindex mno-align-int
5295 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5296 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5297 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5298 Aligning variables on 32-bit boundaries produces code that runs somewhat
5299 faster on processors with 32-bit busses at the expense of more memory.
5301 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5302 align structures containing the above types  differently than
5303 most published application binary interface specifications for the m68k.
5305 @item -mpcrel
5306 @opindex mpcrel
5307 Use the pc-relative addressing mode of the 68000 directly, instead of
5308 using a global offset table.  At present, this option implies @option{-fpic},
5309 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5310 not presently supported with @option{-mpcrel}, though this could be supported for
5311 68020 and higher processors.
5313 @item -mno-strict-align
5314 @itemx -mstrict-align
5315 @opindex mno-strict-align
5316 @opindex mstrict-align
5317 Do not (do) assume that unaligned memory references will be handled by
5318 the system.
5320 @end table
5322 @node M68hc1x Options
5323 @subsection M68hc1x Options
5324 @cindex M68hc1x options
5326 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5327 microcontrollers.  The default values for these options depends on
5328 which style of microcontroller was selected when the compiler was configured;
5329 the defaults for the most common choices are given below.
5331 @table @gcctabopt
5332 @item -m6811
5333 @itemx -m68hc11
5334 @opindex m6811
5335 @opindex m68hc11
5336 Generate output for a 68HC11.  This is the default
5337 when the compiler is configured for 68HC11-based systems.
5339 @item -m6812
5340 @itemx -m68hc12
5341 @opindex m6812
5342 @opindex m68hc12
5343 Generate output for a 68HC12.  This is the default
5344 when the compiler is configured for 68HC12-based systems.
5346 @item -mauto-incdec
5347 @opindex mauto-incdec
5348 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5349 addressing modes.
5351 @item -mshort
5352 @opindex mshort
5353 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5355 @item -msoft-reg-count=@var{count}
5356 @opindex msoft-reg-count
5357 Specify the number of pseudo-soft registers which are used for the
5358 code generation.  The maximum number is 32.  Using more pseudo-soft
5359 register may or may not result in better code depending on the program.
5360 The default is 4 for 68HC11 and 2 for 68HC12.
5362 @end table
5364 @node VAX Options
5365 @subsection VAX Options
5366 @cindex VAX options
5368 These @samp{-m} options are defined for the VAX:
5370 @table @gcctabopt
5371 @item -munix
5372 @opindex munix
5373 Do not output certain jump instructions (@code{aobleq} and so on)
5374 that the Unix assembler for the VAX cannot handle across long
5375 ranges.
5377 @item -mgnu
5378 @opindex mgnu
5379 Do output those jump instructions, on the assumption that you
5380 will assemble with the GNU assembler.
5382 @item -mg
5383 @opindex mg
5384 Output code for g-format floating point numbers instead of d-format.
5385 @end table
5387 @node SPARC Options
5388 @subsection SPARC Options
5389 @cindex SPARC options
5391 These @samp{-m} switches are supported on the SPARC:
5393 @table @gcctabopt
5394 @item -mno-app-regs
5395 @itemx -mapp-regs
5396 @opindex mno-app-regs
5397 @opindex mapp-regs
5398 Specify @option{-mapp-regs} to generate output using the global registers
5399 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5400 is the default.
5402 To be fully SVR4 ABI compliant at the cost of some performance loss,
5403 specify @option{-mno-app-regs}.  You should compile libraries and system
5404 software with this option.
5406 @item -mfpu
5407 @itemx -mhard-float
5408 @opindex mfpu
5409 @opindex mhard-float
5410 Generate output containing floating point instructions.  This is the
5411 default.
5413 @item -mno-fpu
5414 @itemx -msoft-float
5415 @opindex mno-fpu
5416 @opindex msoft-float
5417 Generate output containing library calls for floating point.
5418 @strong{Warning:} the requisite libraries are not available for all SPARC
5419 targets.  Normally the facilities of the machine's usual C compiler are
5420 used, but this cannot be done directly in cross-compilation.  You must make
5421 your own arrangements to provide suitable library functions for
5422 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5423 @samp{sparclite-*-*} do provide software floating point support.
5425 @option{-msoft-float} changes the calling convention in the output file;
5426 therefore, it is only useful if you compile @emph{all} of a program with
5427 this option.  In particular, you need to compile @file{libgcc.a}, the
5428 library that comes with GCC, with @option{-msoft-float} in order for
5429 this to work.
5431 @item -mhard-quad-float
5432 @opindex mhard-quad-float
5433 Generate output containing quad-word (long double) floating point
5434 instructions.
5436 @item -msoft-quad-float
5437 @opindex msoft-quad-float
5438 Generate output containing library calls for quad-word (long double)
5439 floating point instructions.  The functions called are those specified
5440 in the SPARC ABI@.  This is the default.
5442 As of this writing, there are no sparc implementations that have hardware
5443 support for the quad-word floating point instructions.  They all invoke
5444 a trap handler for one of these instructions, and then the trap handler
5445 emulates the effect of the instruction.  Because of the trap handler overhead,
5446 this is much slower than calling the ABI library routines.  Thus the
5447 @option{-msoft-quad-float} option is the default.
5449 @item -mno-epilogue
5450 @itemx -mepilogue
5451 @opindex mno-epilogue
5452 @opindex mepilogue
5453 With @option{-mepilogue} (the default), the compiler always emits code for
5454 function exit at the end of each function.  Any function exit in
5455 the middle of the function (such as a return statement in C) will
5456 generate a jump to the exit code at the end of the function.
5458 With @option{-mno-epilogue}, the compiler tries to emit exit code inline
5459 at every function exit.
5461 @item -mno-flat
5462 @itemx -mflat
5463 @opindex mno-flat
5464 @opindex mflat
5465 With @option{-mflat}, the compiler does not generate save/restore instructions
5466 and will use a ``flat'' or single register window calling convention.
5467 This model uses %i7 as the frame pointer and is compatible with the normal
5468 register window model.  Code from either may be intermixed.
5469 The local registers and the input registers (0--5) are still treated as
5470 ``call saved'' registers and will be saved on the stack as necessary.
5472 With @option{-mno-flat} (the default), the compiler emits save/restore
5473 instructions (except for leaf functions) and is the normal mode of operation.
5475 @item -mno-unaligned-doubles
5476 @itemx -munaligned-doubles
5477 @opindex mno-unaligned-doubles
5478 @opindex munaligned-doubles
5479 Assume that doubles have 8 byte alignment.  This is the default.
5481 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5482 alignment only if they are contained in another type, or if they have an
5483 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5484 Specifying this option avoids some rare compatibility problems with code
5485 generated by other compilers.  It is not the default because it results
5486 in a performance loss, especially for floating point code.
5488 @item -mno-faster-structs
5489 @itemx -mfaster-structs
5490 @opindex mno-faster-structs
5491 @opindex mfaster-structs
5492 With @option{-mfaster-structs}, the compiler assumes that structures
5493 should have 8 byte alignment.  This enables the use of pairs of
5494 @code{ldd} and @code{std} instructions for copies in structure
5495 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5496 However, the use of this changed alignment directly violates the Sparc
5497 ABI@.  Thus, it's intended only for use on targets where the developer
5498 acknowledges that their resulting code will not be directly in line with
5499 the rules of the ABI@.
5501 @item -mv8
5502 @itemx -msparclite
5503 @opindex mv8
5504 @opindex msparclite
5505 These two options select variations on the SPARC architecture.
5507 By default (unless specifically configured for the Fujitsu SPARClite),
5508 GCC generates code for the v7 variant of the SPARC architecture.
5510 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5511 code is that the compiler emits the integer multiply and integer
5512 divide instructions which exist in SPARC v8 but not in SPARC v7.
5514 @option{-msparclite} will give you SPARClite code.  This adds the integer
5515 multiply, integer divide step and scan (@code{ffs}) instructions which
5516 exist in SPARClite but not in SPARC v7.
5518 These options are deprecated and will be deleted in a future GCC release.
5519 They have been replaced with @option{-mcpu=xxx}.
5521 @item -mcypress
5522 @itemx -msupersparc
5523 @opindex mcypress
5524 @opindex msupersparc
5525 These two options select the processor for which the code is optimised.
5527 With @option{-mcypress} (the default), the compiler optimizes code for the
5528 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
5529 This is also appropriate for the older SparcStation 1, 2, IPX etc.
5531 With @option{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
5532 used in the SparcStation 10, 1000 and 2000 series.  This flag also enables use
5533 of the full SPARC v8 instruction set.
5535 These options are deprecated and will be deleted in a future GCC release.
5536 They have been replaced with @option{-mcpu=xxx}.
5538 @item -mcpu=@var{cpu_type}
5539 @opindex mcpu
5540 Set the instruction set, register set, and instruction scheduling parameters
5541 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5542 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5543 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5544 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
5546 Default instruction scheduling parameters are used for values that select
5547 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
5548 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
5550 Here is a list of each supported architecture and their supported
5551 implementations.
5553 @smallexample
5554     v7:             cypress
5555     v8:             supersparc, hypersparc
5556     sparclite:      f930, f934, sparclite86x
5557     sparclet:       tsc701
5558     v9:             ultrasparc
5559 @end smallexample
5561 @item -mtune=@var{cpu_type}
5562 @opindex mtune
5563 Set the instruction scheduling parameters for machine type
5564 @var{cpu_type}, but do not set the instruction set or register set that the
5565 option @option{-mcpu=@var{cpu_type}} would.
5567 The same values for @option{-mcpu=@var{cpu_type}} can be used for
5568 @option{-mtune=@var{cpu_type}}, but the only useful values are those
5569 that select a particular cpu implementation.  Those are @samp{cypress},
5570 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
5571 @samp{sparclite86x}, @samp{tsc701}, and @samp{ultrasparc}.
5573 @end table
5575 These @samp{-m} switches are supported in addition to the above
5576 on the SPARCLET processor.
5578 @table @gcctabopt
5579 @item -mlittle-endian
5580 @opindex mlittle-endian
5581 Generate code for a processor running in little-endian mode.
5583 @item -mlive-g0
5584 @opindex mlive-g0
5585 Treat register @code{%g0} as a normal register.
5586 GCC will continue to clobber it as necessary but will not assume
5587 it always reads as 0.
5589 @item -mbroken-saverestore
5590 @opindex mbroken-saverestore
5591 Generate code that does not use non-trivial forms of the @code{save} and
5592 @code{restore} instructions.  Early versions of the SPARCLET processor do
5593 not correctly handle @code{save} and @code{restore} instructions used with
5594 arguments.  They correctly handle them used without arguments.  A @code{save}
5595 instruction used without arguments increments the current window pointer
5596 but does not allocate a new stack frame.  It is assumed that the window
5597 overflow trap handler will properly handle this case as will interrupt
5598 handlers.
5599 @end table
5601 These @samp{-m} switches are supported in addition to the above
5602 on SPARC V9 processors in 64-bit environments.
5604 @table @gcctabopt
5605 @item -mlittle-endian
5606 @opindex mlittle-endian
5607 Generate code for a processor running in little-endian mode.
5609 @item -m32
5610 @itemx -m64
5611 @opindex m32
5612 @opindex m64
5613 Generate code for a 32-bit or 64-bit environment.
5614 The 32-bit environment sets int, long and pointer to 32 bits.
5615 The 64-bit environment sets int to 32 bits and long and pointer
5616 to 64 bits.
5618 @item -mcmodel=medlow
5619 @opindex mcmodel=medlow
5620 Generate code for the Medium/Low code model: the program must be linked
5621 in the low 32 bits of the address space.  Pointers are 64 bits.
5622 Programs can be statically or dynamically linked.
5624 @item -mcmodel=medmid
5625 @opindex mcmodel=medmid
5626 Generate code for the Medium/Middle code model: the program must be linked
5627 in the low 44 bits of the address space, the text segment must be less than
5628 2G bytes, and data segment must be within 2G of the text segment.
5629 Pointers are 64 bits.
5631 @item -mcmodel=medany
5632 @opindex mcmodel=medany
5633 Generate code for the Medium/Anywhere code model: the program may be linked
5634 anywhere in the address space, the text segment must be less than
5635 2G bytes, and data segment must be within 2G of the text segment.
5636 Pointers are 64 bits.
5638 @item -mcmodel=embmedany
5639 @opindex mcmodel=embmedany
5640 Generate code for the Medium/Anywhere code model for embedded systems:
5641 assume a 32-bit text and a 32-bit data segment, both starting anywhere
5642 (determined at link time).  Register %g4 points to the base of the
5643 data segment.  Pointers are still 64 bits.
5644 Programs are statically linked, PIC is not supported.
5646 @item -mstack-bias
5647 @itemx -mno-stack-bias
5648 @opindex mstack-bias
5649 @opindex mno-stack-bias
5650 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
5651 frame pointer if present, are offset by @minus{}2047 which must be added back
5652 when making stack frame references.
5653 Otherwise, assume no such offset is present.
5654 @end table
5656 @node Convex Options
5657 @subsection Convex Options
5658 @cindex Convex options
5660 These @samp{-m} options are defined for Convex:
5662 @table @gcctabopt
5663 @item -mc1
5664 @opindex mc1
5665 Generate output for C1.  The code will run on any Convex machine.
5666 The preprocessor symbol @code{__convex__c1__} is defined.
5668 @item -mc2
5669 @opindex mc2
5670 Generate output for C2.  Uses instructions not available on C1.
5671 Scheduling and other optimizations are chosen for max performance on C2.
5672 The preprocessor symbol @code{__convex_c2__} is defined.
5674 @item -mc32
5675 @opindex mc32
5676 Generate output for C32xx.  Uses instructions not available on C1.
5677 Scheduling and other optimizations are chosen for max performance on C32.
5678 The preprocessor symbol @code{__convex_c32__} is defined.
5680 @item -mc34
5681 @opindex mc34
5682 Generate output for C34xx.  Uses instructions not available on C1.
5683 Scheduling and other optimizations are chosen for max performance on C34.
5684 The preprocessor symbol @code{__convex_c34__} is defined.
5686 @item -mc38
5687 @opindex mc38
5688 Generate output for C38xx.  Uses instructions not available on C1.
5689 Scheduling and other optimizations are chosen for max performance on C38.
5690 The preprocessor symbol @code{__convex_c38__} is defined.
5692 @item -margcount
5693 @opindex margcount
5694 Generate code which puts an argument count in the word preceding each
5695 argument list.  This is compatible with regular CC, and a few programs
5696 may need the argument count word.  GDB and other source-level debuggers
5697 do not need it; this info is in the symbol table.
5699 @item -mnoargcount
5700 @opindex mnoargcount
5701 Omit the argument count word.  This is the default.
5703 @item -mvolatile-cache
5704 @opindex mvolatile-cache
5705 Allow volatile references to be cached.  This is the default.
5707 @item -mvolatile-nocache
5708 @opindex mvolatile-nocache
5709 Volatile references bypass the data cache, going all the way to memory.
5710 This is only needed for multi-processor code that does not use standard
5711 synchronization instructions.  Making non-volatile references to volatile
5712 locations will not necessarily work.
5714 @item -mlong32
5715 @opindex mlong32
5716 Type long is 32 bits, the same as type int.  This is the default.
5718 @item -mlong64
5719 @opindex mlong64
5720 Type long is 64 bits, the same as type long long.  This option is useless,
5721 because no library support exists for it.
5722 @end table
5724 @node AMD29K Options
5725 @subsection AMD29K Options
5726 @cindex AMD29K options
5728 These @samp{-m} options are defined for the AMD Am29000:
5730 @table @gcctabopt
5731 @item -mdw
5732 @opindex mdw
5733 @cindex DW bit (29k)
5734 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
5735 halfword operations are directly supported by the hardware.  This is the
5736 default.
5738 @item -mndw
5739 @opindex mndw
5740 Generate code that assumes the @code{DW} bit is not set.
5742 @item -mbw
5743 @opindex mbw
5744 @cindex byte writes (29k)
5745 Generate code that assumes the system supports byte and halfword write
5746 operations.  This is the default.
5748 @item -mnbw
5749 @opindex mnbw
5750 Generate code that assumes the systems does not support byte and
5751 halfword write operations.  @option{-mnbw} implies @option{-mndw}.
5753 @item -msmall
5754 @opindex msmall
5755 @cindex memory model (29k)
5756 Use a small memory model that assumes that all function addresses are
5757 either within a single 256 KB segment or at an absolute address of less
5758 than 256k.  This allows the @code{call} instruction to be used instead
5759 of a @code{const}, @code{consth}, @code{calli} sequence.
5761 @item -mnormal
5762 @opindex mnormal
5763 Use the normal memory model: Generate @code{call} instructions only when
5764 calling functions in the same file and @code{calli} instructions
5765 otherwise.  This works if each file occupies less than 256 KB but allows
5766 the entire executable to be larger than 256 KB@.  This is the default.
5768 @item -mlarge
5769 @opindex mlarge
5770 Always use @code{calli} instructions.  Specify this option if you expect
5771 a single file to compile into more than 256 KB of code.
5773 @item -m29050
5774 @opindex m29050
5775 @cindex processor selection (29k)
5776 Generate code for the Am29050.
5778 @item -m29000
5779 @opindex m29000
5780 Generate code for the Am29000.  This is the default.
5782 @item -mkernel-registers
5783 @opindex mkernel-registers
5784 @cindex kernel and user registers (29k)
5785 Generate references to registers @code{gr64-gr95} instead of to
5786 registers @code{gr96-gr127}.  This option can be used when compiling
5787 kernel code that wants a set of global registers disjoint from that used
5788 by user-mode code.
5790 Note that when this option is used, register names in @samp{-f} flags
5791 must use the normal, user-mode, names.
5793 @item -muser-registers
5794 @opindex muser-registers
5795 Use the normal set of global registers, @code{gr96-gr127}.  This is the
5796 default.
5798 @item -mstack-check
5799 @itemx -mno-stack-check
5800 @opindex mstack-check
5801 @opindex mno-stack-check
5802 @cindex stack checks (29k)
5803 Insert (or do not insert) a call to @code{__msp_check} after each stack
5804 adjustment.  This is often used for kernel code.
5806 @item -mstorem-bug
5807 @itemx -mno-storem-bug
5808 @opindex mstorem-bug
5809 @opindex mno-storem-bug
5810 @cindex storem bug (29k)
5811 @option{-mstorem-bug} handles 29k processors which cannot handle the
5812 separation of a mtsrim insn and a storem instruction (most 29000 chips
5813 to date, but not the 29050).
5815 @item -mno-reuse-arg-regs
5816 @itemx -mreuse-arg-regs
5817 @opindex mno-reuse-arg-regs
5818 @opindex mreuse-arg-regs
5819 @option{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5820 registers for copying out arguments.  This helps detect calling a function
5821 with fewer arguments than it was declared with.
5823 @item -mno-impure-text
5824 @itemx -mimpure-text
5825 @opindex mno-impure-text
5826 @opindex mimpure-text
5827 @option{-mimpure-text}, used in addition to @option{-shared}, tells the compiler to
5828 not pass @option{-assert pure-text} to the linker when linking a shared object.
5830 @item -msoft-float
5831 @opindex msoft-float
5832 Generate output containing library calls for floating point.
5833 @strong{Warning:} the requisite libraries are not part of GCC@.
5834 Normally the facilities of the machine's usual C compiler are used, but
5835 this can't be done directly in cross-compilation.  You must make your
5836 own arrangements to provide suitable library functions for
5837 cross-compilation.
5839 @item -mno-multm
5840 @opindex mno-multm
5841 Do not generate multm or multmu instructions.  This is useful for some embedded
5842 systems which do not have trap handlers for these instructions.
5843 @end table
5845 @node ARM Options
5846 @subsection ARM Options
5847 @cindex ARM options
5849 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5850 architectures:
5852 @table @gcctabopt
5853 @item -mapcs-frame
5854 @opindex mapcs-frame
5855 Generate a stack frame that is compliant with the ARM Procedure Call
5856 Standard for all functions, even if this is not strictly necessary for
5857 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
5858 with this option will cause the stack frames not to be generated for
5859 leaf functions.  The default is @option{-mno-apcs-frame}.
5861 @item -mapcs
5862 @opindex mapcs
5863 This is a synonym for @option{-mapcs-frame}.
5865 @item -mapcs-26
5866 @opindex mapcs-26
5867 Generate code for a processor running with a 26-bit program counter,
5868 and conforming to the function calling standards for the APCS 26-bit
5869 option.  This option replaces the @option{-m2} and @option{-m3} options
5870 of previous releases of the compiler.
5872 @item -mapcs-32
5873 @opindex mapcs-32
5874 Generate code for a processor running with a 32-bit program counter,
5875 and conforming to the function calling standards for the APCS 32-bit
5876 option.  This option replaces the @option{-m6} option of previous releases
5877 of the compiler.
5879 @ignore
5880 @c not currently implemented
5881 @item -mapcs-stack-check
5882 @opindex mapcs-stack-check
5883 Generate code to check the amount of stack space available upon entry to
5884 every function (that actually uses some stack space).  If there is
5885 insufficient space available then either the function
5886 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5887 called, depending upon the amount of stack space required.  The run time
5888 system is required to provide these functions.  The default is
5889 @option{-mno-apcs-stack-check}, since this produces smaller code.
5891 @c not currently implemented
5892 @item -mapcs-float
5893 @opindex mapcs-float
5894 Pass floating point arguments using the float point registers.  This is
5895 one of the variants of the APCS@.  This option is recommended if the
5896 target hardware has a floating point unit or if a lot of floating point
5897 arithmetic is going to be performed by the code.  The default is
5898 @option{-mno-apcs-float}, since integer only code is slightly increased in
5899 size if @option{-mapcs-float} is used.
5901 @c not currently implemented
5902 @item -mapcs-reentrant
5903 @opindex mapcs-reentrant
5904 Generate reentrant, position independent code.  The default is
5905 @option{-mno-apcs-reentrant}.
5906 @end ignore
5908 @item -mthumb-interwork
5909 @opindex mthumb-interwork
5910 Generate code which supports calling between the ARM and Thumb
5911 instruction sets.  Without this option the two instruction sets cannot
5912 be reliably used inside one program.  The default is
5913 @option{-mno-thumb-interwork}, since slightly larger code is generated
5914 when @option{-mthumb-interwork} is specified.
5916 @item -mno-sched-prolog
5917 @opindex mno-sched-prolog
5918 Prevent the reordering of instructions in the function prolog, or the
5919 merging of those instruction with the instructions in the function's
5920 body.  This means that all functions will start with a recognizable set
5921 of instructions (or in fact one of a choice from a small set of
5922 different function prologues), and this information can be used to
5923 locate the start if functions inside an executable piece of code.  The
5924 default is @option{-msched-prolog}.
5926 @item -mhard-float
5927 @opindex mhard-float
5928 Generate output containing floating point instructions.  This is the
5929 default.
5931 @item -msoft-float
5932 @opindex msoft-float
5933 Generate output containing library calls for floating point.
5934 @strong{Warning:} the requisite libraries are not available for all ARM
5935 targets.  Normally the facilities of the machine's usual C compiler are
5936 used, but this cannot be done directly in cross-compilation.  You must make
5937 your own arrangements to provide suitable library functions for
5938 cross-compilation.
5940 @option{-msoft-float} changes the calling convention in the output file;
5941 therefore, it is only useful if you compile @emph{all} of a program with
5942 this option.  In particular, you need to compile @file{libgcc.a}, the
5943 library that comes with GCC, with @option{-msoft-float} in order for
5944 this to work.
5946 @item -mlittle-endian
5947 @opindex mlittle-endian
5948 Generate code for a processor running in little-endian mode.  This is
5949 the default for all standard configurations.
5951 @item -mbig-endian
5952 @opindex mbig-endian
5953 Generate code for a processor running in big-endian mode; the default is
5954 to compile code for a little-endian processor.
5956 @item -mwords-little-endian
5957 @opindex mwords-little-endian
5958 This option only applies when generating code for big-endian processors.
5959 Generate code for a little-endian word order but a big-endian byte
5960 order.  That is, a byte order of the form @samp{32107654}.  Note: this
5961 option should only be used if you require compatibility with code for
5962 big-endian ARM processors generated by versions of the compiler prior to
5963 2.8.
5965 @item -malignment-traps
5966 @opindex malignment-traps
5967 Generate code that will not trap if the MMU has alignment traps enabled.
5968 On ARM architectures prior to ARMv4, there were no instructions to
5969 access half-word objects stored in memory.  However, when reading from
5970 memory a feature of the ARM architecture allows a word load to be used,
5971 even if the address is unaligned, and the processor core will rotate the
5972 data as it is being loaded.  This option tells the compiler that such
5973 misaligned accesses will cause a MMU trap and that it should instead
5974 synthesise the access as a series of byte accesses.  The compiler can
5975 still use word accesses to load half-word data if it knows that the
5976 address is aligned to a word boundary.
5978 This option is ignored when compiling for ARM architecture 4 or later,
5979 since these processors have instructions to directly access half-word
5980 objects in memory.
5982 @item -mno-alignment-traps
5983 @opindex mno-alignment-traps
5984 Generate code that assumes that the MMU will not trap unaligned
5985 accesses.  This produces better code when the target instruction set
5986 does not have half-word memory operations (i.e.@: implementations prior to
5987 ARMv4).
5989 Note that you cannot use this option to access unaligned word objects,
5990 since the processor will only fetch one 32-bit aligned object from
5991 memory.
5993 The default setting for most targets is @option{-mno-alignment-traps}, since
5994 this produces better code when there are no half-word memory
5995 instructions available.
5997 @item -mshort-load-bytes
5998 @itemx -mno-short-load-words
5999 @opindex mshort-load-bytes
6000 @opindex mno-short-load-words
6001 These are deprecated aliases for @option{-malignment-traps}.
6003 @item -mno-short-load-bytes
6004 @itemx -mshort-load-words
6005 @opindex mno-short-load-bytes
6006 @opindex mshort-load-words
6007 This are deprecated aliases for @option{-mno-alignment-traps}.
6009 @item -mbsd
6010 @opindex mbsd
6011 This option only applies to RISC iX@.  Emulate the native BSD-mode
6012 compiler.  This is the default if @option{-ansi} is not specified.
6014 @item -mxopen
6015 @opindex mxopen
6016 This option only applies to RISC iX@.  Emulate the native X/Open-mode
6017 compiler.
6019 @item -mno-symrename
6020 @opindex mno-symrename
6021 This option only applies to RISC iX@.  Do not run the assembler
6022 post-processor, @samp{symrename}, after code has been assembled.
6023 Normally it is necessary to modify some of the standard symbols in
6024 preparation for linking with the RISC iX C library; this option
6025 suppresses this pass.  The post-processor is never run when the
6026 compiler is built for cross-compilation.
6028 @item -mcpu=@var{name}
6029 @opindex mcpu
6030 This specifies the name of the target ARM processor.  GCC uses this name
6031 to determine what kind of instructions it can emit when generating
6032 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6033 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6034 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6035 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6036 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6037 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6038 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6039 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6040 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6041 @samp{arm1020t}, @samp{xscale}.
6043 @itemx -mtune=@var{name}
6044 @opindex mtune
6045 This option is very similar to the @option{-mcpu=} option, except that
6046 instead of specifying the actual target processor type, and hence
6047 restricting which instructions can be used, it specifies that GCC should
6048 tune the performance of the code as if the target were of the type
6049 specified in this option, but still choosing the instructions that it
6050 will generate based on the cpu specified by a @option{-mcpu=} option.
6051 For some ARM implementations better performance can be obtained by using
6052 this option.
6054 @item -march=@var{name}
6055 @opindex march
6056 This specifies the name of the target ARM architecture.  GCC uses this
6057 name to determine what kind of instructions it can emit when generating
6058 assembly code.  This option can be used in conjunction with or instead
6059 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6060 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6061 @samp{armv5}, @samp{armv5t}, @samp{armv5te}.
6063 @item -mfpe=@var{number}
6064 @itemx -mfp=@var{number}
6065 @opindex mfpe
6066 @opindex mfp
6067 This specifies the version of the floating point emulation available on
6068 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6069 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6071 @item -mstructure-size-boundary=@var{n}
6072 @opindex mstructure-size-boundary
6073 The size of all structures and unions will be rounded up to a multiple
6074 of the number of bits set by this option.  Permissible values are 8 and
6075 32.  The default value varies for different toolchains.  For the COFF
6076 targeted toolchain the default value is 8.  Specifying the larger number
6077 can produce faster, more efficient code, but can also increase the size
6078 of the program.  The two values are potentially incompatible.  Code
6079 compiled with one value cannot necessarily expect to work with code or
6080 libraries compiled with the other value, if they exchange information
6081 using structures or unions.
6083 @item -mabort-on-noreturn
6084 @opindex mabort-on-noreturn
6085 Generate a call to the function @code{abort} at the end of a
6086 @code{noreturn} function.  It will be executed if the function tries to
6087 return.
6089 @item -mlong-calls
6090 @itemx -mno-long-calls
6091 @opindex mlong-calls
6092 @opindex mno-long-calls
6093 Tells the compiler to perform function calls by first loading the
6094 address of the function into a register and then performing a subroutine
6095 call on this register.  This switch is needed if the target function
6096 will lie outside of the 64 megabyte addressing range of the offset based
6097 version of subroutine call instruction.
6099 Even if this switch is enabled, not all function calls will be turned
6100 into long calls.  The heuristic is that static functions, functions
6101 which have the @samp{short-call} attribute, functions that are inside
6102 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6103 definitions have already been compiled within the current compilation
6104 unit, will not be turned into long calls.  The exception to this rule is
6105 that weak function definitions, functions with the @samp{long-call}
6106 attribute or the @samp{section} attribute, and functions that are within
6107 the scope of a @samp{#pragma long_calls} directive, will always be
6108 turned into long calls.
6110 This feature is not enabled by default.  Specifying
6111 @option{-mno-long-calls} will restore the default behaviour, as will
6112 placing the function calls within the scope of a @samp{#pragma
6113 long_calls_off} directive.  Note these switches have no effect on how
6114 the compiler generates code to handle function calls via function
6115 pointers.
6117 @item -mnop-fun-dllimport
6118 @opindex mnop-fun-dllimport
6119 Disable support for the @code{dllimport} attribute.
6121 @item -msingle-pic-base
6122 @opindex msingle-pic-base
6123 Treat the register used for PIC addressing as read-only, rather than
6124 loading it in the prologue for each function.  The run-time system is
6125 responsible for initialising this register with an appropriate value
6126 before execution begins.
6128 @item -mpic-register=@var{reg}
6129 @opindex mpic-register
6130 Specify the register to be used for PIC addressing.  The default is R10
6131 unless stack-checking is enabled, when R9 is used.
6133 @item -mpoke-function-name
6134 @opindex mpoke-function-name
6135 Write the name of each function into the text section, directly
6136 preceding the function prologue.  The generated code is similar to this:
6138 @smallexample
6139      t0
6140          .ascii "arm_poke_function_name", 0
6141          .align
6142      t1
6143          .word 0xff000000 + (t1 - t0)
6144      arm_poke_function_name
6145          mov     ip, sp
6146          stmfd   sp!, @{fp, ip, lr, pc@}
6147          sub     fp, ip, #4
6148 @end smallexample
6150 When performing a stack backtrace, code can inspect the value of
6151 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6152 location @code{pc - 12} and the top 8 bits are set, then we know that
6153 there is a function name embedded immediately preceding this location
6154 and has length @code{((pc[-3]) & 0xff000000)}.
6156 @item -mthumb
6157 @opindex mthumb
6158 Generate code for the 16-bit Thumb instruction set.  The default is to
6159 use the 32-bit ARM instruction set.
6161 @item -mtpcs-frame
6162 @opindex mtpcs-frame
6163 Generate a stack frame that is compliant with the Thumb Procedure Call
6164 Standard for all non-leaf functions.  (A leaf function is one that does
6165 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6167 @item -mtpcs-leaf-frame
6168 @opindex mtpcs-leaf-frame
6169 Generate a stack frame that is compliant with the Thumb Procedure Call
6170 Standard for all leaf functions.  (A leaf function is one that does
6171 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6173 @item -mcallee-super-interworking
6174 @opindex mcallee-super-interworking
6175 Gives all externally visible functions in the file being compiled an ARM
6176 instruction set header which switches to Thumb mode before executing the
6177 rest of the function.  This allows these functions to be called from
6178 non-interworking code.
6180 @item -mcaller-super-interworking
6181 @opindex mcaller-super-interworking
6182 Allows calls via function pointers (including virtual functions) to
6183 execute correctly regardless of whether the target code has been
6184 compiled for interworking or not.  There is a small overhead in the cost
6185 of executing a function pointer if this option is enabled.
6187 @end table
6189 @node MN10200 Options
6190 @subsection MN10200 Options
6191 @cindex MN10200 options
6192 These @option{-m} options are defined for Matsushita MN10200 architectures:
6193 @table @gcctabopt
6195 @item -mrelax
6196 @opindex mrelax
6197 Indicate to the linker that it should perform a relaxation optimization pass
6198 to shorten branches, calls and absolute memory addresses.  This option only
6199 has an effect when used on the command line for the final link step.
6201 This option makes symbolic debugging impossible.
6202 @end table
6204 @node MN10300 Options
6205 @subsection MN10300 Options
6206 @cindex MN10300 options
6207 These @option{-m} options are defined for Matsushita MN10300 architectures:
6209 @table @gcctabopt
6210 @item -mmult-bug
6211 @opindex mmult-bug
6212 Generate code to avoid bugs in the multiply instructions for the MN10300
6213 processors.  This is the default.
6215 @item -mno-mult-bug
6216 @opindex mno-mult-bug
6217 Do not generate code to avoid bugs in the multiply instructions for the
6218 MN10300 processors.
6220 @item -mam33
6221 @opindex mam33
6222 Generate code which uses features specific to the AM33 processor.
6224 @item -mno-am33
6225 @opindex mno-am33
6226 Do not generate code which uses features specific to the AM33 processor.  This
6227 is the default.
6229 @item -mno-crt0
6230 @opindex mno-crt0
6231 Do not link in the C run-time initialization object file.
6233 @item -mrelax
6234 @opindex mrelax
6235 Indicate to the linker that it should perform a relaxation optimization pass
6236 to shorten branches, calls and absolute memory addresses.  This option only
6237 has an effect when used on the command line for the final link step.
6239 This option makes symbolic debugging impossible.
6240 @end table
6243 @node M32R/D Options
6244 @subsection M32R/D Options
6245 @cindex M32R/D options
6247 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6249 @table @gcctabopt
6250 @item -m32rx
6251 @opindex m32rx
6252 Generate code for the M32R/X@.
6254 @item -m32r
6255 @opindex m32r
6256 Generate code for the M32R@.  This is the default.
6258 @item -mcode-model=small
6259 @opindex mcode-model=small
6260 Assume all objects live in the lower 16MB of memory (so that their addresses
6261 can be loaded with the @code{ld24} instruction), and assume all subroutines
6262 are reachable with the @code{bl} instruction.
6263 This is the default.
6265 The addressability of a particular object can be set with the
6266 @code{model} attribute.
6268 @item -mcode-model=medium
6269 @opindex mcode-model=medium
6270 Assume objects may be anywhere in the 32-bit address space (the compiler
6271 will generate @code{seth/add3} instructions to load their addresses), and
6272 assume all subroutines are reachable with the @code{bl} instruction.
6274 @item -mcode-model=large
6275 @opindex mcode-model=large
6276 Assume objects may be anywhere in the 32-bit address space (the compiler
6277 will generate @code{seth/add3} instructions to load their addresses), and
6278 assume subroutines may not be reachable with the @code{bl} instruction
6279 (the compiler will generate the much slower @code{seth/add3/jl}
6280 instruction sequence).
6282 @item -msdata=none
6283 @opindex msdata=none
6284 Disable use of the small data area.  Variables will be put into
6285 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6286 @code{section} attribute has been specified).
6287 This is the default.
6289 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6290 Objects may be explicitly put in the small data area with the
6291 @code{section} attribute using one of these sections.
6293 @item -msdata=sdata
6294 @opindex msdata=sdata
6295 Put small global and static data in the small data area, but do not
6296 generate special code to reference them.
6298 @item -msdata=use
6299 @opindex msdata=use
6300 Put small global and static data in the small data area, and generate
6301 special instructions to reference them.
6303 @item -G @var{num}
6304 @opindex G
6305 @cindex smaller data references
6306 Put global and static objects less than or equal to @var{num} bytes
6307 into the small data or bss sections instead of the normal data or bss
6308 sections.  The default value of @var{num} is 8.
6309 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6310 for this option to have any effect.
6312 All modules should be compiled with the same @option{-G @var{num}} value.
6313 Compiling with different values of @var{num} may or may not work; if it
6314 doesn't the linker will give an error message---incorrect code will not be
6315 generated.
6317 @end table
6319 @node M88K Options
6320 @subsection M88K Options
6321 @cindex M88k options
6323 These @samp{-m} options are defined for Motorola 88k architectures:
6325 @table @gcctabopt
6326 @item -m88000
6327 @opindex m88000
6328 Generate code that works well on both the m88100 and the
6329 m88110.
6331 @item -m88100
6332 @opindex m88100
6333 Generate code that works best for the m88100, but that also
6334 runs on the m88110.
6336 @item -m88110
6337 @opindex m88110
6338 Generate code that works best for the m88110, and may not run
6339 on the m88100.
6341 @item -mbig-pic
6342 @opindex mbig-pic
6343 Obsolete option to be removed from the next revision.
6344 Use @option{-fPIC}.
6346 @item -midentify-revision
6347 @opindex midentify-revision
6348 @cindex identifying source, compiler (88k)
6349 Include an @code{ident} directive in the assembler output recording the
6350 source file name, compiler name and version, timestamp, and compilation
6351 flags used.
6353 @item -mno-underscores
6354 @opindex mno-underscores
6355 @cindex underscores, avoiding (88k)
6356 In assembler output, emit symbol names without adding an underscore
6357 character at the beginning of each name.  The default is to use an
6358 underscore as prefix on each name.
6360 @item -mocs-debug-info
6361 @itemx -mno-ocs-debug-info
6362 @opindex mocs-debug-info
6363 @opindex mno-ocs-debug-info
6364 @cindex OCS (88k)
6365 @cindex debugging, 88k OCS
6366 Include (or omit) additional debugging information (about registers used
6367 in each stack frame) as specified in the 88open Object Compatibility
6368 Standard, ``OCS''@.  This extra information allows debugging of code that
6369 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
6370 Delta 88 SVr3.2 is to include this information; other 88k configurations
6371 omit this information by default.
6373 @item -mocs-frame-position
6374 @opindex mocs-frame-position
6375 @cindex register positions in frame (88k)
6376 When emitting COFF debugging information for automatic variables and
6377 parameters stored on the stack, use the offset from the canonical frame
6378 address, which is the stack pointer (register 31) on entry to the
6379 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
6380 @option{-mocs-frame-position}; other 88k configurations have the default
6381 @option{-mno-ocs-frame-position}.
6383 @item -mno-ocs-frame-position
6384 @opindex mno-ocs-frame-position
6385 @cindex register positions in frame (88k)
6386 When emitting COFF debugging information for automatic variables and
6387 parameters stored on the stack, use the offset from the frame pointer
6388 register (register 30).  When this option is in effect, the frame
6389 pointer is not eliminated when debugging information is selected by the
6390 -g switch.
6392 @item -moptimize-arg-area
6393 @opindex moptimize-arg-area
6394 @cindex arguments in frame (88k)
6395 Save space by reorganizing the stack frame.  This option generates code
6396 that does not agree with the 88open specifications, but uses less
6397 memory.
6399 @itemx -mno-optimize-arg-area
6400 @opindex mno-optimize-arg-area
6401 Do not reorganize the stack frame to save space.  This is the default.
6402 The generated conforms to the specification, but uses more memory.
6404 @item -mshort-data-@var{num}
6405 @opindex mshort-data
6406 @cindex smaller data references (88k)
6407 @cindex r0-relative references (88k)
6408 Generate smaller data references by making them relative to @code{r0},
6409 which allows loading a value using a single instruction (rather than the
6410 usual two).  You control which data references are affected by
6411 specifying @var{num} with this option.  For example, if you specify
6412 @option{-mshort-data-512}, then the data references affected are those
6413 involving displacements of less than 512 bytes.
6414 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6415 than 64k.
6417 @item -mserialize-volatile
6418 @opindex mserialize-volatile
6419 @itemx -mno-serialize-volatile
6420 @opindex mno-serialize-volatile
6421 @cindex sequential consistency on 88k
6422 Do, or don't, generate code to guarantee sequential consistency
6423 of volatile memory references.  By default, consistency is
6424 guaranteed.
6426 The order of memory references made by the MC88110 processor does
6427 not always match the order of the instructions requesting those
6428 references.  In particular, a load instruction may execute before
6429 a preceding store instruction.  Such reordering violates
6430 sequential consistency of volatile memory references, when there
6431 are multiple processors.   When consistency must be guaranteed,
6432 GCC generates special instructions, as needed, to force
6433 execution in the proper order.
6435 The MC88100 processor does not reorder memory references and so
6436 always provides sequential consistency.  However, by default, GCC
6437 generates the special instructions to guarantee consistency
6438 even when you use @option{-m88100}, so that the code may be run on an
6439 MC88110 processor.  If you intend to run your code only on the
6440 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6442 The extra code generated to guarantee consistency may affect the
6443 performance of your application.  If you know that you can safely
6444 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6446 @item -msvr4
6447 @itemx -msvr3
6448 @opindex msvr4
6449 @opindex msvr3
6450 @cindex assembler syntax, 88k
6451 @cindex SVr4
6452 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6453 related to System V release 4 (SVr4).  This controls the following:
6455 @enumerate
6456 @item
6457 Which variant of the assembler syntax to emit.
6458 @item
6459 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6460 that is used on System V release 4.
6461 @item
6462 @option{-msvr4} makes GCC issue additional declaration directives used in
6463 SVr4.
6464 @end enumerate
6466 @option{-msvr4} is the default for the m88k-motorola-sysv4 and
6467 m88k-dg-dgux m88k configurations.  @option{-msvr3} is the default for all
6468 other m88k configurations.
6470 @item -mversion-03.00
6471 @opindex mversion-03.00
6472 This option is obsolete, and is ignored.
6473 @c ??? which asm syntax better for GAS?  option there too?
6475 @item -mno-check-zero-division
6476 @itemx -mcheck-zero-division
6477 @opindex mno-check-zero-division
6478 @opindex mcheck-zero-division
6479 @cindex zero division on 88k
6480 Do, or don't, generate code to guarantee that integer division by
6481 zero will be detected.  By default, detection is guaranteed.
6483 Some models of the MC88100 processor fail to trap upon integer
6484 division by zero under certain conditions.  By default, when
6485 compiling code that might be run on such a processor, GCC
6486 generates code that explicitly checks for zero-valued divisors
6487 and traps with exception number 503 when one is detected.  Use of
6488 @option{-mno-check-zero-division} suppresses such checking for code
6489 generated to run on an MC88100 processor.
6491 GCC assumes that the MC88110 processor correctly detects all instances
6492 of integer division by zero.  When @option{-m88110} is specified, no
6493 explicit checks for zero-valued divisors are generated, and both
6494 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6495 ignored.
6497 @item -muse-div-instruction
6498 @opindex muse-div-instruction
6499 @cindex divide instruction, 88k
6500 Use the div instruction for signed integer division on the
6501 MC88100 processor.  By default, the div instruction is not used.
6503 On the MC88100 processor the signed integer division instruction
6504 div) traps to the operating system on a negative operand.  The
6505 operating system transparently completes the operation, but at a
6506 large cost in execution time.  By default, when compiling code
6507 that might be run on an MC88100 processor, GCC emulates signed
6508 integer division using the unsigned integer division instruction
6509 divu), thereby avoiding the large penalty of a trap to the
6510 operating system.  Such emulation has its own, smaller, execution
6511 cost in both time and space.  To the extent that your code's
6512 important signed integer division operations are performed on two
6513 nonnegative operands, it may be desirable to use the div
6514 instruction directly.
6516 On the MC88110 processor the div instruction (also known as the
6517 divs instruction) processes negative operands without trapping to
6518 the operating system.  When @option{-m88110} is specified,
6519 @option{-muse-div-instruction} is ignored, and the div instruction is used
6520 for signed integer division.
6522 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6523 particular, the behavior of such a division with and without
6524 @option{-muse-div-instruction} may differ.
6526 @item -mtrap-large-shift
6527 @itemx -mhandle-large-shift
6528 @opindex mtrap-large-shift
6529 @opindex mhandle-large-shift
6530 @cindex bit shift overflow (88k)
6531 @cindex large bit shifts (88k)
6532 Include code to detect bit-shifts of more than 31 bits; respectively,
6533 trap such shifts or emit code to handle them properly.  By default GCC
6534 makes no special provision for large bit shifts.
6536 @item -mwarn-passed-structs
6537 @opindex mwarn-passed-structs
6538 @cindex structure passing (88k)
6539 Warn when a function passes a struct as an argument or result.
6540 Structure-passing conventions have changed during the evolution of the C
6541 language, and are often the source of portability problems.  By default,
6542 GCC issues no such warning.
6543 @end table
6545 @c break page here to avoid unsightly interparagraph stretch.
6546 @c -zw, 2001-8-17
6547 @page
6549 @node RS/6000 and PowerPC Options
6550 @subsection IBM RS/6000 and PowerPC Options
6551 @cindex RS/6000 and PowerPC Options
6552 @cindex IBM RS/6000 and PowerPC Options
6554 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6555 @table @gcctabopt
6556 @item -mpower
6557 @itemx -mno-power
6558 @itemx -mpower2
6559 @itemx -mno-power2
6560 @itemx -mpowerpc
6561 @itemx -mno-powerpc
6562 @itemx -mpowerpc-gpopt
6563 @itemx -mno-powerpc-gpopt
6564 @itemx -mpowerpc-gfxopt
6565 @itemx -mno-powerpc-gfxopt
6566 @itemx -mpowerpc64
6567 @itemx -mno-powerpc64
6568 @opindex mpower
6569 @opindex mno-power
6570 @opindex mpower2
6571 @opindex mno-power2
6572 @opindex mpowerpc
6573 @opindex mno-powerpc
6574 @opindex mpowerpc-gpopt
6575 @opindex mno-powerpc-gpopt
6576 @opindex mpowerpc-gfxopt
6577 @opindex mno-powerpc-gfxopt
6578 @opindex mpowerpc64
6579 @opindex mno-powerpc64
6580 GCC supports two related instruction set architectures for the
6581 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6582 instructions supported by the @samp{rios} chip set used in the original
6583 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6584 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6585 the IBM 4xx microprocessors.
6587 Neither architecture is a subset of the other.  However there is a
6588 large common subset of instructions supported by both.  An MQ
6589 register is included in processors supporting the POWER architecture.
6591 You use these options to specify which instructions are available on the
6592 processor you are using.  The default value of these options is
6593 determined when configuring GCC@.  Specifying the
6594 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6595 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6596 rather than the options listed above.
6598 The @option{-mpower} option allows GCC to generate instructions that
6599 are found only in the POWER architecture and to use the MQ register.
6600 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6601 to generate instructions that are present in the POWER2 architecture but
6602 not the original POWER architecture.
6604 The @option{-mpowerpc} option allows GCC to generate instructions that
6605 are found only in the 32-bit subset of the PowerPC architecture.
6606 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6607 GCC to use the optional PowerPC architecture instructions in the
6608 General Purpose group, including floating-point square root.  Specifying
6609 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6610 use the optional PowerPC architecture instructions in the Graphics
6611 group, including floating-point select.
6613 The @option{-mpowerpc64} option allows GCC to generate the additional
6614 64-bit instructions that are found in the full PowerPC64 architecture
6615 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6616 @option{-mno-powerpc64}.
6618 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6619 will use only the instructions in the common subset of both
6620 architectures plus some special AIX common-mode calls, and will not use
6621 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6622 permits GCC to use any instruction from either architecture and to
6623 allow use of the MQ register; specify this for the Motorola MPC601.
6625 @item -mnew-mnemonics
6626 @itemx -mold-mnemonics
6627 @opindex mnew-mnemonics
6628 @opindex mold-mnemonics
6629 Select which mnemonics to use in the generated assembler code.  With
6630 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6631 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6632 assembler mnemonics defined for the POWER architecture.  Instructions
6633 defined in only one architecture have only one mnemonic; GCC uses that
6634 mnemonic irrespective of which of these options is specified.
6636 GCC defaults to the mnemonics appropriate for the architecture in
6637 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6638 value of these option.  Unless you are building a cross-compiler, you
6639 should normally not specify either @option{-mnew-mnemonics} or
6640 @option{-mold-mnemonics}, but should instead accept the default.
6642 @item -mcpu=@var{cpu_type}
6643 @opindex mcpu
6644 Set architecture type, register usage, choice of mnemonics, and
6645 instruction scheduling parameters for machine type @var{cpu_type}.
6646 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6647 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6648 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6649 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6650 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6651 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6653 @option{-mcpu=common} selects a completely generic processor.  Code
6654 generated under this option will run on any POWER or PowerPC processor.
6655 GCC will use only the instructions in the common subset of both
6656 architectures, and will not use the MQ register.  GCC assumes a generic
6657 processor model for scheduling purposes.
6659 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6660 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6661 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6662 types, with an appropriate, generic processor model assumed for
6663 scheduling purposes.
6665 The other options specify a specific processor.  Code generated under
6666 those options will run best on that processor, and may not run at all on
6667 others.
6669 The @option{-mcpu} options automatically enable or disable other
6670 @option{-m} options as follows:
6672 @table @samp
6673 @item common
6674 @option{-mno-power}, @option{-mno-powerc}
6676 @item power
6677 @itemx power2
6678 @itemx rios1
6679 @itemx rios2
6680 @itemx rsc
6681 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6683 @item powerpc
6684 @itemx rs64a
6685 @itemx 602
6686 @itemx 603
6687 @itemx 603e
6688 @itemx 604
6689 @itemx 620
6690 @itemx 630
6691 @itemx 740
6692 @itemx 7400
6693 @itemx 7450
6694 @itemx 750
6695 @itemx 505
6696 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6698 @item 601
6699 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6701 @item 403
6702 @itemx 821
6703 @itemx 860
6704 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6705 @end table
6707 @item -mtune=@var{cpu_type}
6708 @opindex mtune
6709 Set the instruction scheduling parameters for machine type
6710 @var{cpu_type}, but do not set the architecture type, register usage, or
6711 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6712 values for @var{cpu_type} are used for @option{-mtune} as for
6713 @option{-mcpu}.  If both are specified, the code generated will use the
6714 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6715 scheduling parameters set by @option{-mtune}.
6717 @item -maltivec
6718 @itemx -mno-altivec
6719 @opindex maltivec
6720 @opindex mno-altivec
6721 These switches enable or disable the use of built-in functions that
6722 allow access to the AltiVec instruction set.  You may also need to set
6723 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6724 enhancements.
6726 @item -mfull-toc
6727 @itemx -mno-fp-in-toc
6728 @itemx -mno-sum-in-toc
6729 @itemx -mminimal-toc
6730 @opindex mfull-toc
6731 @opindex mno-fp-in-toc
6732 @opindex mno-sum-in-toc
6733 @opindex mminimal-toc
6734 Modify generation of the TOC (Table Of Contents), which is created for
6735 every executable file.  The @option{-mfull-toc} option is selected by
6736 default.  In that case, GCC will allocate at least one TOC entry for
6737 each unique non-automatic variable reference in your program.  GCC
6738 will also place floating-point constants in the TOC@.  However, only
6739 16,384 entries are available in the TOC@.
6741 If you receive a linker error message that saying you have overflowed
6742 the available TOC space, you can reduce the amount of TOC space used
6743 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
6744 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
6745 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
6746 generate code to calculate the sum of an address and a constant at
6747 run-time instead of putting that sum into the TOC@.  You may specify one
6748 or both of these options.  Each causes GCC to produce very slightly
6749 slower and larger code at the expense of conserving TOC space.
6751 If you still run out of space in the TOC even when you specify both of
6752 these options, specify @option{-mminimal-toc} instead.  This option causes
6753 GCC to make only one TOC entry for every file.  When you specify this
6754 option, GCC will produce code that is slower and larger but which
6755 uses extremely little TOC space.  You may wish to use this option
6756 only on files that contain less frequently executed code.
6758 @item -maix64
6759 @itemx -maix32
6760 @opindex maix64
6761 @opindex maix32
6762 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6763 @code{long} type, and the infrastructure needed to support them.
6764 Specifying @option{-maix64} implies @option{-mpowerpc64} and
6765 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
6766 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
6768 @item -mxl-call
6769 @itemx -mno-xl-call
6770 @opindex mxl-call
6771 @opindex mno-xl-call
6772 On AIX, pass floating-point arguments to prototyped functions beyond the
6773 register save area (RSA) on the stack in addition to argument FPRs.  The
6774 AIX calling convention was extended but not initially documented to
6775 handle an obscure K&R C case of calling a function that takes the
6776 address of its arguments with fewer arguments than declared.  AIX XL
6777 compilers access floating point arguments which do not fit in the
6778 RSA from the stack when a subroutine is compiled without
6779 optimization.  Because always storing floating-point arguments on the
6780 stack is inefficient and rarely needed, this option is not enabled by
6781 default and only is necessary when calling subroutines compiled by AIX
6782 XL compilers without optimization.
6784 @item -mthreads
6785 @opindex mthreads
6786 Support @dfn{AIX Threads}.  Link an application written to use
6787 @dfn{pthreads} with special libraries and startup code to enable the
6788 application to run.
6790 @item -mpe
6791 @opindex mpe
6792 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
6793 application written to use message passing with special startup code to
6794 enable the application to run.  The system must have PE installed in the
6795 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6796 must be overridden with the @option{-specs=} option to specify the
6797 appropriate directory location.  The Parallel Environment does not
6798 support threads, so the @option{-mpe} option and the @option{-mthreads}
6799 option are incompatible.
6801 @item -msoft-float
6802 @itemx -mhard-float
6803 @opindex msoft-float
6804 @opindex mhard-float
6805 Generate code that does not use (uses) the floating-point register set.
6806 Software floating point emulation is provided if you use the
6807 @option{-msoft-float} option, and pass the option to GCC when linking.
6809 @item -mmultiple
6810 @itemx -mno-multiple
6811 @opindex mmultiple
6812 @opindex mno-multiple
6813 Generate code that uses (does not use) the load multiple word
6814 instructions and the store multiple word instructions.  These
6815 instructions are generated by default on POWER systems, and not
6816 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
6817 endian PowerPC systems, since those instructions do not work when the
6818 processor is in little endian mode.  The exceptions are PPC740 and
6819 PPC750 which permit the instructions usage in little endian mode.
6821 @item -mstring
6822 @itemx -mno-string
6823 @opindex mstring
6824 @opindex mno-string
6825 Generate code that uses (does not use) the load string instructions
6826 and the store string word instructions to save multiple registers and
6827 do small block moves.  These instructions are generated by default on
6828 POWER systems, and not generated on PowerPC systems.  Do not use
6829 @option{-mstring} on little endian PowerPC systems, since those
6830 instructions do not work when the processor is in little endian mode.
6831 The exceptions are PPC740 and PPC750 which permit the instructions
6832 usage in little endian mode.
6834 @item -mupdate
6835 @itemx -mno-update
6836 @opindex mupdate
6837 @opindex mno-update
6838 Generate code that uses (does not use) the load or store instructions
6839 that update the base register to the address of the calculated memory
6840 location.  These instructions are generated by default.  If you use
6841 @option{-mno-update}, there is a small window between the time that the
6842 stack pointer is updated and the address of the previous frame is
6843 stored, which means code that walks the stack frame across interrupts or
6844 signals may get corrupted data.
6846 @item -mfused-madd
6847 @itemx -mno-fused-madd
6848 @opindex mfused-madd
6849 @opindex mno-fused-madd
6850 Generate code that uses (does not use) the floating point multiply and
6851 accumulate instructions.  These instructions are generated by default if
6852 hardware floating is used.
6854 @item -mno-bit-align
6855 @itemx -mbit-align
6856 @opindex mno-bit-align
6857 @opindex mbit-align
6858 On System V.4 and embedded PowerPC systems do not (do) force structures
6859 and unions that contain bit-fields to be aligned to the base type of the
6860 bit-field.
6862 For example, by default a structure containing nothing but 8
6863 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
6864 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
6865 the structure would be aligned to a 1 byte boundary and be one byte in
6866 size.
6868 @item -mno-strict-align
6869 @itemx -mstrict-align
6870 @opindex mno-strict-align
6871 @opindex mstrict-align
6872 On System V.4 and embedded PowerPC systems do not (do) assume that
6873 unaligned memory references will be handled by the system.
6875 @item -mrelocatable
6876 @itemx -mno-relocatable
6877 @opindex mrelocatable
6878 @opindex mno-relocatable
6879 On embedded PowerPC systems generate code that allows (does not allow)
6880 the program to be relocated to a different address at runtime.  If you
6881 use @option{-mrelocatable} on any module, all objects linked together must
6882 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
6884 @item -mrelocatable-lib
6885 @itemx -mno-relocatable-lib
6886 @opindex mrelocatable-lib
6887 @opindex mno-relocatable-lib
6888 On embedded PowerPC systems generate code that allows (does not allow)
6889 the program to be relocated to a different address at runtime.  Modules
6890 compiled with @option{-mrelocatable-lib} can be linked with either modules
6891 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
6892 with modules compiled with the @option{-mrelocatable} options.
6894 @item -mno-toc
6895 @itemx -mtoc
6896 @opindex mno-toc
6897 @opindex mtoc
6898 On System V.4 and embedded PowerPC systems do not (do) assume that
6899 register 2 contains a pointer to a global area pointing to the addresses
6900 used in the program.
6902 @item -mlittle
6903 @itemx -mlittle-endian
6904 @opindex mlittle
6905 @opindex mlittle-endian
6906 On System V.4 and embedded PowerPC systems compile code for the
6907 processor in little endian mode.  The @option{-mlittle-endian} option is
6908 the same as @option{-mlittle}.
6910 @item -mbig
6911 @itemx -mbig-endian
6912 @opindex mbig
6913 @opindex mbig-endian
6914 On System V.4 and embedded PowerPC systems compile code for the
6915 processor in big endian mode.  The @option{-mbig-endian} option is
6916 the same as @option{-mbig}.
6918 @item -mcall-sysv
6919 @opindex mcall-sysv
6920 On System V.4 and embedded PowerPC systems compile code using calling
6921 conventions that adheres to the March 1995 draft of the System V
6922 Application Binary Interface, PowerPC processor supplement.  This is the
6923 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6925 @item -mcall-sysv-eabi
6926 @opindex mcall-sysv-eabi
6927 Specify both @option{-mcall-sysv} and @option{-meabi} options.
6929 @item -mcall-sysv-noeabi
6930 @opindex mcall-sysv-noeabi
6931 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
6933 @item -mcall-aix
6934 @opindex mcall-aix
6935 On System V.4 and embedded PowerPC systems compile code using calling
6936 conventions that are similar to those used on AIX@.  This is the
6937 default if you configured GCC using @samp{powerpc-*-eabiaix}.
6939 @item -mcall-solaris
6940 @opindex mcall-solaris
6941 On System V.4 and embedded PowerPC systems compile code for the Solaris
6942 operating system.
6944 @item -mcall-linux
6945 @opindex mcall-linux
6946 On System V.4 and embedded PowerPC systems compile code for the
6947 Linux-based GNU system.
6949 @item -mcall-netbsd
6950 @opindex mcall-netbsd
6951 On System V.4 and embedded PowerPC systems compile code for the
6952 NetBSD operating system.
6954 @item -mabi=altivec
6955 @opindex mabi=altivec
6956 Extend the current ABI with AltiVec ABI extensions.  This does not
6957 change the default ABI, instead it adds the AltiVec ABI extensions to
6958 the current ABI@.
6960 @item -mprototype
6961 @itemx -mno-prototype
6962 @opindex mprototype
6963 @opindex mno-prototype
6964 On System V.4 and embedded PowerPC systems assume that all calls to
6965 variable argument functions are properly prototyped.  Otherwise, the
6966 compiler must insert an instruction before every non prototyped call to
6967 set or clear bit 6 of the condition code register (@var{CR}) to
6968 indicate whether floating point values were passed in the floating point
6969 registers in case the function takes a variable arguments.  With
6970 @option{-mprototype}, only calls to prototyped variable argument functions
6971 will set or clear the bit.
6973 @item -msim
6974 @opindex msim
6975 On embedded PowerPC systems, assume that the startup module is called
6976 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6977 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
6978 configurations.
6980 @item -mmvme
6981 @opindex mmvme
6982 On embedded PowerPC systems, assume that the startup module is called
6983 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6984 @file{libc.a}.
6986 @item -mads
6987 @opindex mads
6988 On embedded PowerPC systems, assume that the startup module is called
6989 @file{crt0.o} and the standard C libraries are @file{libads.a} and
6990 @file{libc.a}.
6992 @item -myellowknife
6993 @opindex myellowknife
6994 On embedded PowerPC systems, assume that the startup module is called
6995 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
6996 @file{libc.a}.
6998 @item -mvxworks
6999 @opindex mvxworks
7000 On System V.4 and embedded PowerPC systems, specify that you are
7001 compiling for a VxWorks system.
7003 @item -memb
7004 @opindex memb
7005 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7006 header to indicate that @samp{eabi} extended relocations are used.
7008 @item -meabi
7009 @itemx -mno-eabi
7010 @opindex meabi
7011 @opindex mno-eabi
7012 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7013 Embedded Applications Binary Interface (eabi) which is a set of
7014 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7015 means that the stack is aligned to an 8 byte boundary, a function
7016 @code{__eabi} is called to from @code{main} to set up the eabi
7017 environment, and the @option{-msdata} option can use both @code{r2} and
7018 @code{r13} to point to two separate small data areas.  Selecting
7019 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7020 do not call an initialization function from @code{main}, and the
7021 @option{-msdata} option will only use @code{r13} to point to a single
7022 small data area.  The @option{-meabi} option is on by default if you
7023 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7025 @item -msdata=eabi
7026 @opindex msdata=eabi
7027 On System V.4 and embedded PowerPC systems, put small initialized
7028 @code{const} global and static data in the @samp{.sdata2} section, which
7029 is pointed to by register @code{r2}.  Put small initialized
7030 non-@code{const} global and static data in the @samp{.sdata} section,
7031 which is pointed to by register @code{r13}.  Put small uninitialized
7032 global and static data in the @samp{.sbss} section, which is adjacent to
7033 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7034 incompatible with the @option{-mrelocatable} option.  The
7035 @option{-msdata=eabi} option also sets the @option{-memb} option.
7037 @item -msdata=sysv
7038 @opindex msdata=sysv
7039 On System V.4 and embedded PowerPC systems, put small global and static
7040 data in the @samp{.sdata} section, which is pointed to by register
7041 @code{r13}.  Put small uninitialized global and static data in the
7042 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7043 The @option{-msdata=sysv} option is incompatible with the
7044 @option{-mrelocatable} option.
7046 @item -msdata=default
7047 @itemx -msdata
7048 @opindex msdata=default
7049 @opindex msdata
7050 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7051 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7052 same as @option{-msdata=sysv}.
7054 @item -msdata-data
7055 @opindex msdata-data
7056 On System V.4 and embedded PowerPC systems, put small global and static
7057 data in the @samp{.sdata} section.  Put small uninitialized global and
7058 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7059 to address small data however.  This is the default behavior unless
7060 other @option{-msdata} options are used.
7062 @item -msdata=none
7063 @itemx -mno-sdata
7064 @opindex msdata=none
7065 @opindex mno-sdata
7066 On embedded PowerPC systems, put all initialized global and static data
7067 in the @samp{.data} section, and all uninitialized data in the
7068 @samp{.bss} section.
7070 @item -G @var{num}
7071 @opindex G
7072 @cindex smaller data references (PowerPC)
7073 @cindex .sdata/.sdata2 references (PowerPC)
7074 On embedded PowerPC systems, put global and static items less than or
7075 equal to @var{num} bytes into the small data or bss sections instead of
7076 the normal data or bss section.  By default, @var{num} is 8.  The
7077 @option{-G @var{num}} switch is also passed to the linker.
7078 All modules should be compiled with the same @option{-G @var{num}} value.
7080 @item -mregnames
7081 @itemx -mno-regnames
7082 @opindex mregnames
7083 @opindex mno-regnames
7084 On System V.4 and embedded PowerPC systems do (do not) emit register
7085 names in the assembly language output using symbolic forms.
7087 @end table
7089 @node RT Options
7090 @subsection IBM RT Options
7091 @cindex RT options
7092 @cindex IBM RT options
7094 These @samp{-m} options are defined for the IBM RT PC:
7096 @table @gcctabopt
7097 @item -min-line-mul
7098 @opindex min-line-mul
7099 Use an in-line code sequence for integer multiplies.  This is the
7100 default.
7102 @item -mcall-lib-mul
7103 @opindex mcall-lib-mul
7104 Call @code{lmul$$} for integer multiples.
7106 @item -mfull-fp-blocks
7107 @opindex mfull-fp-blocks
7108 Generate full-size floating point data blocks, including the minimum
7109 amount of scratch space recommended by IBM@.  This is the default.
7111 @item -mminimum-fp-blocks
7112 @opindex mminimum-fp-blocks
7113 Do not include extra scratch space in floating point data blocks.  This
7114 results in smaller code, but slower execution, since scratch space must
7115 be allocated dynamically.
7117 @cindex @file{varargs.h} and RT PC
7118 @cindex @file{stdarg.h} and RT PC
7119 @item -mfp-arg-in-fpregs
7120 @opindex mfp-arg-in-fpregs
7121 Use a calling sequence incompatible with the IBM calling convention in
7122 which floating point arguments are passed in floating point registers.
7123 Note that @code{varargs.h} and @code{stdarg.h} will not work with
7124 floating point operands if this option is specified.
7126 @item -mfp-arg-in-gregs
7127 @opindex mfp-arg-in-gregs
7128 Use the normal calling convention for floating point arguments.  This is
7129 the default.
7131 @item -mhc-struct-return
7132 @opindex mhc-struct-return
7133 Return structures of more than one word in memory, rather than in a
7134 register.  This provides compatibility with the MetaWare HighC (hc)
7135 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7136 with the Portable C Compiler (pcc).
7138 @item -mnohc-struct-return
7139 @opindex mnohc-struct-return
7140 Return some structures of more than one word in registers, when
7141 convenient.  This is the default.  For compatibility with the
7142 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7143 option @option{-mhc-struct-return}.
7144 @end table
7146 @node MIPS Options
7147 @subsection MIPS Options
7148 @cindex MIPS options
7150 These @samp{-m} options are defined for the MIPS family of computers:
7152 @table @gcctabopt
7154 @item -march=@var{cpu-type}
7155 @opindex march
7156 Assume the defaults for the machine type @var{cpu-type} when generating
7157 instructions.  The choices for @var{cpu-type} are  @samp{r2000}, @samp{r3000},
7158 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
7159 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
7160 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
7161 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
7162 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.
7164 @item -mtune=@var{cpu-type}
7165 @opindex mtune
7166 Assume the defaults for the machine type @var{cpu-type} when scheduling
7167 instructions.  The choices for @var{cpu-type} are @samp{r2000}, @samp{r3000},
7168 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
7169 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
7170 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
7171 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
7172 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.  While picking a specific
7173 @var{cpu-type} will schedule things appropriately for that particular
7174 chip, the compiler will not generate any code that does not meet level 1
7175 of the MIPS ISA (instruction set architecture) without a @option{-mipsX}
7176 or @option{-mabi} switch being used.
7178 @item -mcpu=@var{cpu-type}
7179 @opindex mcpu
7180 This is identical to specifying both @option{-march} and @option{-mtune}.
7182 @item -mips1
7183 @opindex mips1
7184 Issue instructions from level 1 of the MIPS ISA@.  This is the default.
7185 @samp{r3000} is the default @var{cpu-type} at this ISA level.
7187 @item -mips2
7188 @opindex mips2
7189 Issue instructions from level 2 of the MIPS ISA (branch likely, square
7190 root instructions).  @samp{r6000} is the default @var{cpu-type} at this
7191 ISA level.
7193 @item -mips3
7194 @opindex mips3
7195 Issue instructions from level 3 of the MIPS ISA (64-bit instructions).
7196 @samp{r4000} is the default @var{cpu-type} at this ISA level.
7198 @item -mips4
7199 @opindex mips4
7200 Issue instructions from level 4 of the MIPS ISA (conditional move,
7201 prefetch, enhanced FPU instructions).  @samp{r8000} is the default
7202 @var{cpu-type} at this ISA level.
7204 @item -mfp32
7205 @opindex mfp32
7206 Assume that 32 32-bit floating point registers are available.  This is
7207 the default.
7209 @item -mfp64
7210 @opindex mfp64
7211 Assume that 32 64-bit floating point registers are available.  This is
7212 the default when the @option{-mips3} option is used.
7214 @item -mfused-madd
7215 @itemx -mno-fused-madd
7216 @opindex mfused-madd
7217 @opindex mno-fused-madd
7218 Generate code that uses (does not use) the floating point multiply and
7219 accumulate instructions, when they are available.  These instructions
7220 are generated by default if they are available, but this may be
7221 undesirable if the extra precision causes problems or on certain chips
7222 in the mode where denormals are rounded to zero where denormals
7223 generated by multiply and accumulate instructions cause exceptions
7224 anyway.
7226 @item -mgp32
7227 @opindex mgp32
7228 Assume that 32 32-bit general purpose registers are available.  This is
7229 the default.
7231 @item -mgp64
7232 @opindex mgp64
7233 Assume that 32 64-bit general purpose registers are available.  This is
7234 the default when the @option{-mips3} option is used.
7236 @item -mint64
7237 @opindex mint64
7238 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7239 explanation of the default, and the width of pointers.
7241 @item -mlong64
7242 @opindex mlong64
7243 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7244 explanation of the default, and the width of pointers.
7246 @item -mlong32
7247 @opindex mlong32
7248 Force long, int, and pointer types to be 32 bits wide.
7250 If none of @option{-mlong32}, @option{-mlong64}, or @option{-mint64} are set,
7251 the size of ints, longs, and pointers depends on the ABI and ISA chosen.
7252 For @option{-mabi=32}, and @option{-mabi=n32}, ints and longs are 32 bits
7253 wide.  For @option{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
7254 For @option{-mabi=eabi} and either @option{-mips1} or @option{-mips2}, ints
7255 and longs are 32 bits wide.  For @option{-mabi=eabi} and higher ISAs, ints
7256 are 32 bits, and longs are 64 bits wide.  The width of pointer types is
7257 the smaller of the width of longs or the width of general purpose
7258 registers (which in turn depends on the ISA)@.
7260 @item -mabi=32
7261 @itemx -mabi=o64
7262 @itemx -mabi=n32
7263 @itemx -mabi=64
7264 @itemx -mabi=eabi
7265 @opindex mabi=32
7266 @opindex mabi=o64
7267 @opindex mabi=n32
7268 @opindex mabi=64
7269 @opindex mabi=eabi
7270 Generate code for the indicated ABI@.  The default instruction level is
7271 @option{-mips1} for @samp{32}, @option{-mips3} for @samp{n32}, and
7272 @option{-mips4} otherwise.  Conversely, with @option{-mips1} or
7273 @option{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
7274 is @samp{64}.
7276 @item -mmips-as
7277 @opindex mmips-as
7278 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7279 add normal debug information.  This is the default for all
7280 platforms except for the OSF/1 reference platform, using the OSF/rose
7281 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7282 switches are used, the @file{mips-tfile} program will encapsulate the
7283 stabs within MIPS ECOFF@.
7285 @item -mgas
7286 @opindex mgas
7287 Generate code for the GNU assembler.  This is the default on the OSF/1
7288 reference platform, using the OSF/rose object format.  Also, this is
7289 the default if the configure option @option{--with-gnu-as} is used.
7291 @item -msplit-addresses
7292 @itemx -mno-split-addresses
7293 @opindex msplit-addresses
7294 @opindex mno-split-addresses
7295 Generate code to load the high and low parts of address constants separately.
7296 This allows GCC to optimize away redundant loads of the high order
7297 bits of addresses.  This optimization requires GNU as and GNU ld.
7298 This optimization is enabled by default for some embedded targets where
7299 GNU as and GNU ld are standard.
7301 @item -mrnames
7302 @itemx -mno-rnames
7303 @opindex mrnames
7304 @opindex mno-rnames
7305 The @option{-mrnames} switch says to output code using the MIPS software
7306 names for the registers, instead of the hardware names (ie, @var{a0}
7307 instead of @var{$4}).  The only known assembler that supports this option
7308 is the Algorithmics assembler.
7310 @item -mgpopt
7311 @itemx -mno-gpopt
7312 @opindex mgpopt
7313 @opindex mno-gpopt
7314 The @option{-mgpopt} switch says to write all of the data declarations
7315 before the instructions in the text section, this allows the MIPS
7316 assembler to generate one word memory references instead of using two
7317 words for short global or static data items.  This is on by default if
7318 optimization is selected.
7320 @item -mstats
7321 @itemx -mno-stats
7322 @opindex mstats
7323 @opindex mno-stats
7324 For each non-inline function processed, the @option{-mstats} switch
7325 causes the compiler to emit one line to the standard error file to
7326 print statistics about the program (number of registers saved, stack
7327 size, etc.).
7329 @item -mmemcpy
7330 @itemx -mno-memcpy
7331 @opindex mmemcpy
7332 @opindex mno-memcpy
7333 The @option{-mmemcpy} switch makes all block moves call the appropriate
7334 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7335 generating inline code.
7337 @item -mmips-tfile
7338 @itemx -mno-mips-tfile
7339 @opindex mmips-tfile
7340 @opindex mno-mips-tfile
7341 The @option{-mno-mips-tfile} switch causes the compiler not
7342 postprocess the object file with the @file{mips-tfile} program,
7343 after the MIPS assembler has generated it to add debug support.  If
7344 @file{mips-tfile} is not run, then no local variables will be
7345 available to the debugger.  In addition, @file{stage2} and
7346 @file{stage3} objects will have the temporary file names passed to the
7347 assembler embedded in the object file, which means the objects will
7348 not compare the same.  The @option{-mno-mips-tfile} switch should only
7349 be used when there are bugs in the @file{mips-tfile} program that
7350 prevents compilation.
7352 @item -msoft-float
7353 @opindex msoft-float
7354 Generate output containing library calls for floating point.
7355 @strong{Warning:} the requisite libraries are not part of GCC@.
7356 Normally the facilities of the machine's usual C compiler are used, but
7357 this can't be done directly in cross-compilation.  You must make your
7358 own arrangements to provide suitable library functions for
7359 cross-compilation.
7361 @item -mhard-float
7362 @opindex mhard-float
7363 Generate output containing floating point instructions.  This is the
7364 default if you use the unmodified sources.
7366 @item -mabicalls
7367 @itemx -mno-abicalls
7368 @opindex mabicalls
7369 @opindex mno-abicalls
7370 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7371 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7372 position independent code.
7374 @item -mlong-calls
7375 @itemx -mno-long-calls
7376 @opindex mlong-calls
7377 @opindex mno-long-calls
7378 Do all calls with the @samp{JALR} instruction, which requires
7379 loading up a function's address into a register before the call.
7380 You need to use this switch, if you call outside of the current
7381 512 megabyte segment to functions that are not through pointers.
7383 @item -mhalf-pic
7384 @itemx -mno-half-pic
7385 @opindex mhalf-pic
7386 @opindex mno-half-pic
7387 Put pointers to extern references into the data section and load them
7388 up, rather than put the references in the text section.
7390 @item -membedded-pic
7391 @itemx -mno-embedded-pic
7392 @opindex membedded-pic
7393 @opindex mno-embedded-pic
7394 Generate PIC code suitable for some embedded systems.  All calls are
7395 made using PC relative address, and all data is addressed using the $gp
7396 register.  No more than 65536 bytes of global data may be used.  This
7397 requires GNU as and GNU ld which do most of the work.  This currently
7398 only works on targets which use ECOFF; it does not work with ELF@.
7400 @item -membedded-data
7401 @itemx -mno-embedded-data
7402 @opindex membedded-data
7403 @opindex mno-embedded-data
7404 Allocate variables to the read-only data section first if possible, then
7405 next in the small data section if possible, otherwise in data.  This gives
7406 slightly slower code than the default, but reduces the amount of RAM required
7407 when executing, and thus may be preferred for some embedded systems.
7409 @item -muninit-const-in-rodata
7410 @itemx -mno-uninit-const-in-rodata
7411 @opindex muninit-const-in-rodata
7412 @opindex mno-uninit-const-in-rodata
7413 When used together with @option{-membedded-data}, it will always store uninitialized
7414 const variables in the read-only data section.
7416 @item -msingle-float
7417 @itemx -mdouble-float
7418 @opindex msingle-float
7419 @opindex mdouble-float
7420 The @option{-msingle-float} switch tells gcc to assume that the floating
7421 point coprocessor only supports single precision operations, as on the
7422 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7423 double precision operations.  This is the default.
7425 @item -mmad
7426 @itemx -mno-mad
7427 @opindex mmad
7428 @opindex mno-mad
7429 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7430 as on the @samp{r4650} chip.
7432 @item -m4650
7433 @opindex m4650
7434 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7435 @option{-mcpu=r4650}.
7437 @item -mips16
7438 @itemx -mno-mips16
7439 @opindex mips16
7440 @opindex mno-mips16
7441 Enable 16-bit instructions.
7443 @item -mentry
7444 @opindex mentry
7445 Use the entry and exit pseudo ops.  This option can only be used with
7446 @option{-mips16}.
7448 @item -EL
7449 @opindex EL
7450 Compile code for the processor in little endian mode.
7451 The requisite libraries are assumed to exist.
7453 @item -EB
7454 @opindex EB
7455 Compile code for the processor in big endian mode.
7456 The requisite libraries are assumed to exist.
7458 @item -G @var{num}
7459 @opindex G
7460 @cindex smaller data references (MIPS)
7461 @cindex gp-relative references (MIPS)
7462 Put global and static items less than or equal to @var{num} bytes into
7463 the small data or bss sections instead of the normal data or bss
7464 section.  This allows the assembler to emit one word memory reference
7465 instructions based on the global pointer (@var{gp} or @var{$28}),
7466 instead of the normal two words used.  By default, @var{num} is 8 when
7467 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
7468 @option{-G @var{num}} switch is also passed to the assembler and linker.
7469 All modules should be compiled with the same @option{-G @var{num}}
7470 value.
7472 @item -nocpp
7473 @opindex nocpp
7474 Tell the MIPS assembler to not run its preprocessor over user
7475 assembler files (with a @samp{.s} suffix) when assembling them.
7477 @item -mfix7000
7478 @opindex mfix7000
7479 Pass an option to gas which will cause nops to be inserted if
7480 the read of the destination register of an mfhi or mflo instruction
7481 occurs in the following two instructions.
7483 @item -no-crt0
7484 @opindex no-crt0
7485 Do not include the default crt0.
7487 @item -mflush-func=@var{func}
7488 @itemx -mno-flush-func
7489 @opindex mflush-func
7490 Specifies the function to call to flush the I and D caches, or to not
7491 call any such function.  If called, the function must take the same
7492 arguments as the common @code{_flush_func()}, that is, the address of the
7493 memory range for which the cache is being flushed, the size of the
7494 memory range, and the number 3 (to flush both caches).  The default
7495 depends on the target gcc was configured for, but commonly is either
7496 @samp{_flush_func} or @samp{__cpu_flush}.
7497 @end table
7499 @ifset INTERNALS
7500 These options are defined by the macro
7501 @code{TARGET_SWITCHES} in the machine description.  The default for the
7502 options is also defined by that macro, which enables you to change the
7503 defaults.
7504 @end ifset
7506 @node i386 and x86-64 Options
7507 @subsection Intel 386 and AMD x86-64 Options
7508 @cindex i386 Options
7509 @cindex x86-64 Options
7510 @cindex Intel 386 Options
7511 @cindex AMD x86-64 Options
7513 These @samp{-m} options are defined for the i386 and x86-64 family of
7514 computers:
7516 @table @gcctabopt
7517 @item -mcpu=@var{cpu-type}
7518 @opindex mcpu
7519 Assume the defaults for the machine type @var{cpu-type} when scheduling
7520 instructions.  The choices for @var{cpu-type} are @samp{i386},
7521 @samp{i486}, @samp{i586}, @samp{i686}, @samp{pentium},
7522 @samp{pentiumpro}, @samp{pentium4}, @samp{k6}, and @samp{athlon}
7524 While picking a specific @var{cpu-type} will schedule things appropriately
7525 for that particular chip, the compiler will not generate any code that
7526 does not run on the i386 without the @option{-march=@var{cpu-type}} option
7527 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
7528 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
7529 AMD chips as opposed to the Intel ones.
7531 @item -march=@var{cpu-type}
7532 @opindex march
7533 Generate instructions for the machine type @var{cpu-type}.  The choices
7534 for @var{cpu-type} are the same as for @option{-mcpu}.  Moreover,
7535 specifying @option{-march=@var{cpu-type}} implies @option{-mcpu=@var{cpu-type}}.
7537 @item -m386
7538 @itemx -m486
7539 @itemx -mpentium
7540 @itemx -mpentiumpro
7541 @opindex m386
7542 @opindex m486
7543 @opindex mpentium
7544 @opindex mpentiumpro
7545 These options are synonyms for @option{-mcpu=i386}, @option{-mcpu=i486},
7546 @option{-mcpu=pentium}, and @option{-mcpu=pentiumpro} respectively.
7547 These synonyms are deprecated.
7549 @item -mintel-syntax
7550 @opindex mintel-syntax
7551 Emit assembly using Intel syntax opcodes instead of AT&T syntax.
7553 @item -mieee-fp
7554 @itemx -mno-ieee-fp
7555 @opindex mieee-fp
7556 @opindex mno-ieee-fp
7557 Control whether or not the compiler uses IEEE floating point
7558 comparisons.  These handle correctly the case where the result of a
7559 comparison is unordered.
7561 @item -msoft-float
7562 @opindex msoft-float
7563 Generate output containing library calls for floating point.
7564 @strong{Warning:} the requisite libraries are not part of GCC@.
7565 Normally the facilities of the machine's usual C compiler are used, but
7566 this can't be done directly in cross-compilation.  You must make your
7567 own arrangements to provide suitable library functions for
7568 cross-compilation.
7570 On machines where a function returns floating point results in the 80387
7571 register stack, some floating point opcodes may be emitted even if
7572 @option{-msoft-float} is used.
7574 @item -mno-fp-ret-in-387
7575 @opindex mno-fp-ret-in-387
7576 Do not use the FPU registers for return values of functions.
7578 The usual calling convention has functions return values of types
7579 @code{float} and @code{double} in an FPU register, even if there
7580 is no FPU@.  The idea is that the operating system should emulate
7581 an FPU@.
7583 The option @option{-mno-fp-ret-in-387} causes such values to be returned
7584 in ordinary CPU registers instead.
7586 @item -mno-fancy-math-387
7587 @opindex mno-fancy-math-387
7588 Some 387 emulators do not support the @code{sin}, @code{cos} and
7589 @code{sqrt} instructions for the 387.  Specify this option to avoid
7590 generating those instructions.  This option is the default on FreeBSD@.
7591 As of revision 2.6.1, these instructions are not generated unless you
7592 also use the @option{-funsafe-math-optimizations} switch.
7594 @item -malign-double
7595 @itemx -mno-align-double
7596 @opindex malign-double
7597 @opindex mno-align-double
7598 Control whether GCC aligns @code{double}, @code{long double}, and
7599 @code{long long} variables on a two word boundary or a one word
7600 boundary.  Aligning @code{double} variables on a two word boundary will
7601 produce code that runs somewhat faster on a @samp{Pentium} at the
7602 expense of more memory.
7604 @item -m128bit-long-double
7605 @opindex m128bit-long-double
7606 Control the size of @code{long double} type. i386 application binary interface
7607 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
7608 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
7609 impossible to reach with 12 byte long doubles in the array accesses.
7611 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
7612 structures and arrays containing @code{long double} will change their size as
7613 well as function calling convention for function taking @code{long double}
7614 will be modified.
7616 @item -m96bit-long-double
7617 @opindex m96bit-long-double
7618 Set the size of @code{long double} to 96 bits as required by the i386
7619 application binary interface.  This is the default.
7621 @item -msvr3-shlib
7622 @itemx -mno-svr3-shlib
7623 @opindex msvr3-shlib
7624 @opindex mno-svr3-shlib
7625 Control whether GCC places uninitialized local variables into the
7626 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
7627 into @code{bss}.  These options are meaningful only on System V Release 3.
7629 @item -mrtd
7630 @opindex mrtd
7631 Use a different function-calling convention, in which functions that
7632 take a fixed number of arguments return with the @code{ret} @var{num}
7633 instruction, which pops their arguments while returning.  This saves one
7634 instruction in the caller since there is no need to pop the arguments
7635 there.
7637 You can specify that an individual function is called with this calling
7638 sequence with the function attribute @samp{stdcall}.  You can also
7639 override the @option{-mrtd} option by using the function attribute
7640 @samp{cdecl}.  @xref{Function Attributes}.
7642 @strong{Warning:} this calling convention is incompatible with the one
7643 normally used on Unix, so you cannot use it if you need to call
7644 libraries compiled with the Unix compiler.
7646 Also, you must provide function prototypes for all functions that
7647 take variable numbers of arguments (including @code{printf});
7648 otherwise incorrect code will be generated for calls to those
7649 functions.
7651 In addition, seriously incorrect code will result if you call a
7652 function with too many arguments.  (Normally, extra arguments are
7653 harmlessly ignored.)
7655 @item -mregparm=@var{num}
7656 @opindex mregparm
7657 Control how many registers are used to pass integer arguments.  By
7658 default, no registers are used to pass arguments, and at most 3
7659 registers can be used.  You can control this behavior for a specific
7660 function by using the function attribute @samp{regparm}.
7661 @xref{Function Attributes}.
7663 @strong{Warning:} if you use this switch, and
7664 @var{num} is nonzero, then you must build all modules with the same
7665 value, including any libraries.  This includes the system libraries and
7666 startup modules.
7668 @item -mpreferred-stack-boundary=@var{num}
7669 @opindex mpreferred-stack-boundary
7670 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
7671 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
7672 the default is 4 (16 bytes or 128 bits), except when optimizing for code
7673 size (@option{-Os}), in which case the default is the minimum correct
7674 alignment (4 bytes for x86, and 8 bytes for x86-64).
7676 On Pentium and PentiumPro, @code{double} and @code{long double} values
7677 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
7678 suffer significant run time performance penalties.  On Pentium III, the
7679 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
7680 penalties if it is not 16 byte aligned.
7682 To ensure proper alignment of this values on the stack, the stack boundary
7683 must be as aligned as that required by any value stored on the stack.
7684 Further, every function must be generated such that it keeps the stack
7685 aligned.  Thus calling a function compiled with a higher preferred
7686 stack boundary from a function compiled with a lower preferred stack
7687 boundary will most likely misalign the stack.  It is recommended that
7688 libraries that use callbacks always use the default setting.
7690 This extra alignment does consume extra stack space, and generally
7691 increases code size.  Code that is sensitive to stack space usage, such
7692 as embedded systems and operating system kernels, may want to reduce the
7693 preferred alignment to @option{-mpreferred-stack-boundary=2}.
7695 @item -mmmx
7696 @itemx -mno-mmx
7697 @item -msse
7698 @itemx -mno-sse
7699 @item -m3dnow
7700 @itemx -mno-3dnow
7701 @opindex mmmx
7702 @opindex mno-mmx
7703 @opindex msse
7704 @opindex mno-sse
7705 @opindex m3dnow
7706 @opindex mno-3dnow
7707 These switches enable or disable the use of built-in functions that allow
7708 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
7710 The following machine modes are available for use with MMX built-in functions
7711 (@pxref{Vector Extensions}): @code{V2SI} for a vector of two 32 bit integers,
7712 @code{V4HI} for a vector of four 16 bit integers, and @code{V8QI} for a
7713 vector of eight 8 bit integers.  Some of the built-in functions operate on
7714 MMX registers as a whole 64 bit entity, these use @code{DI} as their mode.
7716 If 3Dnow extensions are enabled, @code{V2SF} is used as a mode for a vector
7717 of two 32 bit floating point values.
7719 If SSE extensions are enabled, @code{V4SF} is used for a vector of four 32 bit
7720 floating point values.  Some instructions use a vector of four 32 bit
7721 integers, these use @code{V4SI}.  Finally, some instructions operate on an
7722 entire vector register, interpreting it as a 128 bit integer, these use mode
7723 @code{TI}.
7725 The following built-in functions are made available by @option{-mmmx}:
7726 @table @code
7727 @item v8qi __builtin_ia32_paddb (v8qi, v8qi)
7728 Generates the @code{paddb} machine instruction.
7729 @item v4hi __builtin_ia32_paddw (v4hi, v4hi)
7730 Generates the @code{paddw} machine instruction.
7731 @item v2si __builtin_ia32_paddd (v2si, v2si)
7732 Generates the @code{paddd} machine instruction.
7733 @item v8qi __builtin_ia32_psubb (v8qi, v8qi)
7734 Generates the @code{psubb} machine instruction.
7735 @item v4hi __builtin_ia32_psubw (v4hi, v4hi)
7736 Generates the @code{psubw} machine instruction.
7737 @item v2si __builtin_ia32_psubd (v2si, v2si)
7738 Generates the @code{psubd} machine instruction.
7740 @item v8qi __builtin_ia32_paddsb (v8qi, v8qi)
7741 Generates the @code{paddsb} machine instruction.
7742 @item v4hi __builtin_ia32_paddsw (v4hi, v4hi)
7743 Generates the @code{paddsw} machine instruction.
7744 @item v8qi __builtin_ia32_psubsb (v8qi, v8qi)
7745 Generates the @code{psubsb} machine instruction.
7746 @item v4hi __builtin_ia32_psubsw (v4hi, v4hi)
7747 Generates the @code{psubsw} machine instruction.
7749 @item v8qi __builtin_ia32_paddusb (v8qi, v8qi)
7750 Generates the @code{paddusb} machine instruction.
7751 @item v4hi __builtin_ia32_paddusw (v4hi, v4hi)
7752 Generates the @code{paddusw} machine instruction.
7753 @item v8qi __builtin_ia32_psubusb (v8qi, v8qi)
7754 Generates the @code{psubusb} machine instruction.
7755 @item v4hi __builtin_ia32_psubusw (v4hi, v4hi)
7756 Generates the @code{psubusw} machine instruction.
7758 @item v4hi __builtin_ia32_pmullw (v4hi, v4hi)
7759 Generates the @code{pmullw} machine instruction.
7760 @item v4hi __builtin_ia32_pmulhw (v4hi, v4hi)
7761 Generates the @code{pmulhw} machine instruction.
7763 @item di __builtin_ia32_pand (di, di)
7764 Generates the @code{pand} machine instruction.
7765 @item di __builtin_ia32_pandn (di,di)
7766 Generates the @code{pandn} machine instruction.
7767 @item di __builtin_ia32_por (di, di)
7768 Generates the @code{por} machine instruction.
7769 @item di __builtin_ia32_pxor (di, di)
7770 Generates the @code{pxor} machine instruction.
7772 @item v8qi __builtin_ia32_pcmpeqb (v8qi, v8qi)
7773 Generates the @code{pcmpeqb} machine instruction.
7774 @item v4hi __builtin_ia32_pcmpeqw (v4hi, v4hi)
7775 Generates the @code{pcmpeqw} machine instruction.
7776 @item v2si __builtin_ia32_pcmpeqd (v2si, v2si)
7777 Generates the @code{pcmpeqd} machine instruction.
7778 @item v8qi __builtin_ia32_pcmpgtb (v8qi, v8qi)
7779 Generates the @code{pcmpgtb} machine instruction.
7780 @item v4hi __builtin_ia32_pcmpgtw (v4hi, v4hi)
7781 Generates the @code{pcmpgtw} machine instruction.
7782 @item v2si __builtin_ia32_pcmpgtd (v2si, v2si)
7783 Generates the @code{pcmpgtd} machine instruction.
7785 @item v8qi __builtin_ia32_punpckhbw (v8qi, v8qi)
7786 Generates the @code{punpckhbw} machine instruction.
7787 @item v4hi __builtin_ia32_punpckhwd (v4hi, v4hi)
7788 Generates the @code{punpckhwd} machine instruction.
7789 @item v2si __builtin_ia32_punpckhdq (v2si, v2si)
7790 Generates the @code{punpckhdq} machine instruction.
7791 @item v8qi __builtin_ia32_punpcklbw (v8qi, v8qi)
7792 Generates the @code{punpcklbw} machine instruction.
7793 @item v4hi __builtin_ia32_punpcklwd (v4hi, v4hi)
7794 Generates the @code{punpcklwd} machine instruction.
7795 @item v2si __builtin_ia32_punpckldq (v2si, v2si)
7796 Generates the @code{punpckldq} machine instruction.
7798 @item v8qi __builtin_ia32_packsswb (v4hi, v4hi)
7799 Generates the @code{packsswb} machine instruction.
7800 @item v4hi __builtin_ia32_packssdw (v2si, v2si)
7801 Generates the @code{packssdw} machine instruction.
7802 @item v8qi __builtin_ia32_packuswb (v4hi, v4hi)
7803 Generates the @code{packuswb} machine instruction.
7805 @end table
7807 The following built-in functions are made available either with @option{-msse}, or
7808 with a combination of @option{-m3dnow} and @option{-march=athlon}.
7809 @table @code
7811 @item v4hi __builtin_ia32_pmulhuw (v4hi, v4hi)
7812 Generates the @code{pmulhuw} machine instruction.
7814 @item v8qi __builtin_ia32_pavgb (v8qi, v8qi)
7815 Generates the @code{pavgb} machine instruction.
7816 @item v4hi __builtin_ia32_pavgw (v4hi, v4hi)
7817 Generates the @code{pavgw} machine instruction.
7818 @item v4hi __builtin_ia32_psadbw (v8qi, v8qi)
7819 Generates the @code{psadbw} machine instruction.
7821 @item v8qi __builtin_ia32_pmaxub (v8qi, v8qi)
7822 Generates the @code{pmaxub} machine instruction.
7823 @item v4hi __builtin_ia32_pmaxsw (v4hi, v4hi)
7824 Generates the @code{pmaxsw} machine instruction.
7825 @item v8qi __builtin_ia32_pminub (v8qi, v8qi)
7826 Generates the @code{pminub} machine instruction.
7827 @item v4hi __builtin_ia32_pminsw (v4hi, v4hi)
7828 Generates the @code{pminsw} machine instruction.
7830 @item int __builtin_ia32_pextrw (v4hi, int)
7831 Generates the @code{pextrw} machine instruction.
7832 @item v4hi __builtin_ia32_pinsrw (v4hi, int, int)
7833 Generates the @code{pinsrw} machine instruction.
7835 @item int __builtin_ia32_pmovmskb (v8qi)
7836 Generates the @code{pmovmskb} machine instruction.
7837 @item void __builtin_ia32_maskmovq (v8qi, v8qi, char *)
7838 Generates the @code{maskmovq} machine instruction.
7839 @item void __builtin_ia32_movntq (di *, di)
7840 Generates the @code{movntq} machine instruction.
7841 @item void __builtin_ia32_sfence (void)
7842 Generates the @code{sfence} machine instruction.
7843 @item void __builtin_ia32_prefetch (char *, int selector)
7844 Generates a prefetch machine instruction, depending on the value of
7845 selector.  If @code{selector} is 0, it generates @code{prefetchnta}; for
7846 a value of 1, it generates @code{prefetcht0}; for a value of 2, it generates
7847 @code{prefetcht1}; and for a value of 3 it generates @code{prefetcht2}.
7849 @end table
7851 The following built-in functions are available when @option{-msse} is used.
7853 @table @code
7854 @item int __builtin_ia32_comieq (v4sf, v4sf)
7855 Generates the @code{comiss} machine instruction and performs an equality
7856 comparison.  The return value is the truth value of that comparison.
7857 @item int __builtin_ia32_comineq (v4sf, v4sf)
7858 Generates the @code{comiss} machine instruction and performs an inequality
7859 comparison.  The return value is the truth value of that comparison.
7860 @item int __builtin_ia32_comilt (v4sf, v4sf)
7861 Generates the @code{comiss} machine instruction and performs a ``less than''
7862 comparison.  The return value is the truth value of that comparison.
7863 @item int __builtin_ia32_comile (v4sf, v4sf)
7864 Generates the @code{comiss} machine instruction and performs a ``less or
7865 equal'' comparison.  The return value is the truth value of that comparison.
7866 @item int __builtin_ia32_comigt (v4sf, v4sf)
7867 Generates the @code{comiss} machine instruction and performs a ``greater than''
7868 comparison.  The return value is the truth value of that comparison.
7869 @item int __builtin_ia32_comige (v4sf, v4sf)
7870 Generates the @code{comiss} machine instruction and performs a ``greater or
7871 equal'' comparison.  The return value is the truth value of that comparison.
7873 @item int __builtin_ia32_ucomieq (v4sf, v4sf)
7874 Generates the @code{ucomiss} machine instruction and performs an equality
7875 comparison.  The return value is the truth value of that comparison.
7876 @item int __builtin_ia32_ucomineq (v4sf, v4sf)
7877 Generates the @code{ucomiss} machine instruction and performs an inequality
7878 comparison.  The return value is the truth value of that comparison.
7879 @item int __builtin_ia32_ucomilt (v4sf, v4sf)
7880 Generates the @code{ucomiss} machine instruction and performs a ``less than''
7881 comparison.  The return value is the truth value of that comparison.
7882 @item int __builtin_ia32_ucomile (v4sf, v4sf)
7883 Generates the @code{ucomiss} machine instruction and performs a ``less or
7884 equal'' comparison.  The return value is the truth value of that comparison.
7885 @item int __builtin_ia32_ucomigt (v4sf, v4sf)
7886 Generates the @code{ucomiss} machine instruction and performs a ``greater than''
7887 comparison.  The return value is the truth value of that comparison.
7888 @item int __builtin_ia32_ucomige (v4sf, v4sf)
7889 Generates the @code{ucomiss} machine instruction and performs a ``greater or
7890 equal'' comparison.  The return value is the truth value of that comparison.
7892 @item v4sf __builtin_ia32_addps (v4sf, v4sf)
7893 Generates the @code{addps} machine instruction.
7894 @item v4sf __builtin_ia32_addss (v4sf, v4sf)
7895 Generates the @code{addss} machine instruction.
7896 @item v4sf __builtin_ia32_subps (v4sf, v4sf)
7897 Generates the @code{subps} machine instruction.
7898 @item v4sf __builtin_ia32_subss (v4sf, v4sf)
7899 Generates the @code{subss} machine instruction.
7900 @item v4sf __builtin_ia32_mulps (v4sf, v4sf)
7901 Generates the @code{mulps} machine instruction.
7902 @item v4sf __builtin_ia32_mulss (v4sf, v4sf)
7903 Generates the @code{mulss} machine instruction.
7904 @item v4sf __builtin_ia32_divps (v4sf, v4sf)
7905 Generates the @code{divps} machine instruction.
7906 @item v4sf __builtin_ia32_divss (v4sf, v4sf)
7907 Generates the @code{divss} machine instruction.
7909 @item v4si __builtin_ia32_cmpeqps (v4sf, v4sf)
7910 Generates the @code{cmpeqps} machine instruction.
7911 @item v4si __builtin_ia32_cmplts (v4sf, v4sf)
7912 Generates the @code{cmpltps} machine instruction.
7913 @item v4si __builtin_ia32_cmpleps (v4sf, v4sf)
7914 Generates the @code{cmpleps} machine instruction.
7915 @item v4si __builtin_ia32_cmpgtps (v4sf, v4sf)
7916 Generates the @code{cmpgtps} machine instruction.
7917 @item v4si __builtin_ia32_cmpgeps (v4sf, v4sf)
7918 Generates the @code{cmpgeps} machine instruction.
7919 @item v4si __builtin_ia32_cmpunordps (v4sf, v4sf)
7920 Generates the @code{cmpunodps} machine instruction.
7921 @item v4si __builtin_ia32_cmpneqps (v4sf, v4sf)
7922 Generates the @code{cmpeqps} machine instruction.
7923 @item v4si __builtin_ia32_cmpnltps (v4sf, v4sf)
7924 Generates the @code{cmpltps} machine instruction.
7925 @item v4si __builtin_ia32_cmpnleps (v4sf, v4sf)
7926 Generates the @code{cmpleps} machine instruction.
7927 @item v4si __builtin_ia32_cmpngtps (v4sf, v4sf)
7928 Generates the @code{cmpgtps} machine instruction.
7929 @item v4si __builtin_ia32_cmpngeps (v4sf, v4sf)
7930 Generates the @code{cmpgeps} machine instruction.
7931 @item v4si __builtin_ia32_cmpordps (v4sf, v4sf)
7932 Generates the @code{cmpunodps} machine instruction.
7934 @item v4si __builtin_ia32_cmpeqss (v4sf, v4sf)
7935 Generates the @code{cmpeqss} machine instruction.
7936 @item v4si __builtin_ia32_cmpltss (v4sf, v4sf)
7937 Generates the @code{cmpltss} machine instruction.
7938 @item v4si __builtin_ia32_cmpless (v4sf, v4sf)
7939 Generates the @code{cmpless} machine instruction.
7940 @item v4si __builtin_ia32_cmpgtss (v4sf, v4sf)
7941 Generates the @code{cmpgtss} machine instruction.
7942 @item v4si __builtin_ia32_cmpgess (v4sf, v4sf)
7943 Generates the @code{cmpgess} machine instruction.
7944 @item v4si __builtin_ia32_cmpunordss (v4sf, v4sf)
7945 Generates the @code{cmpunodss} machine instruction.
7946 @item v4si __builtin_ia32_cmpneqss (v4sf, v4sf)
7947 Generates the @code{cmpeqss} machine instruction.
7948 @item v4si __builtin_ia32_cmpnlts (v4sf, v4sf)
7949 Generates the @code{cmpltss} machine instruction.
7950 @item v4si __builtin_ia32_cmpnless (v4sf, v4sf)
7951 Generates the @code{cmpless} machine instruction.
7952 @item v4si __builtin_ia32_cmpngtss (v4sf, v4sf)
7953 Generates the @code{cmpgtss} machine instruction.
7954 @item v4si __builtin_ia32_cmpngess (v4sf, v4sf)
7955 Generates the @code{cmpgess} machine instruction.
7956 @item v4si __builtin_ia32_cmpordss (v4sf, v4sf)
7957 Generates the @code{cmpunodss} machine instruction.
7959 @item v4sf __builtin_ia32_maxps (v4sf, v4sf)
7960 Generates the @code{maxps} machine instruction.
7961 @item v4sf __builtin_ia32_maxsss (v4sf, v4sf)
7962 Generates the @code{maxss} machine instruction.
7963 @item v4sf __builtin_ia32_minps (v4sf, v4sf)
7964 Generates the @code{minps} machine instruction.
7965 @item v4sf __builtin_ia32_minsss (v4sf, v4sf)
7966 Generates the @code{minss} machine instruction.
7968 @item ti __builtin_ia32_andps (ti, ti)
7969 Generates the @code{andps} machine instruction.
7970 @item ti __builtin_ia32_andnps (ti, ti)
7971 Generates the @code{andnps} machine instruction.
7972 @item ti __builtin_ia32_orps (ti, ti)
7973 Generates the @code{orps} machine instruction.
7974 @item ti __builtin_ia32_xorps (ti, ti)
7975 Generates the @code{xorps} machine instruction.
7977 @item v4sf __builtin_ia32_movps (v4sf, v4sf)
7978 Generates the @code{movps} machine instruction.
7979 @item v4sf __builtin_ia32_movhlps (v4sf, v4sf)
7980 Generates the @code{movhlps} machine instruction.
7981 @item v4sf __builtin_ia32_movlhps (v4sf, v4sf)
7982 Generates the @code{movlhps} machine instruction.
7983 @item v4sf __builtin_ia32_unpckhps (v4sf, v4sf)
7984 Generates the @code{unpckhps} machine instruction.
7985 @item v4sf __builtin_ia32_unpcklps (v4sf, v4sf)
7986 Generates the @code{unpcklps} machine instruction.
7988 @item v4sf __builtin_ia32_cvtpi2ps (v4sf, v2si)
7989 Generates the @code{cvtpi2ps} machine instruction.
7990 @item v2si __builtin_ia32_cvtps2pi (v4sf)
7991 Generates the @code{cvtps2pi} machine instruction.
7992 @item v4sf __builtin_ia32_cvtsi2ss (v4sf, int)
7993 Generates the @code{cvtsi2ss} machine instruction.
7994 @item int __builtin_ia32_cvtss2si (v4sf)
7995 Generates the @code{cvtsi2ss} machine instruction.
7996 @item v2si __builtin_ia32_cvttps2pi (v4sf)
7997 Generates the @code{cvttps2pi} machine instruction.
7998 @item int __builtin_ia32_cvttss2si (v4sf)
7999 Generates the @code{cvttsi2ss} machine instruction.
8001 @item v4sf __builtin_ia32_rcpps (v4sf)
8002 Generates the @code{rcpps} machine instruction.
8003 @item v4sf __builtin_ia32_rsqrtps (v4sf)
8004 Generates the @code{rsqrtps} machine instruction.
8005 @item v4sf __builtin_ia32_sqrtps (v4sf)
8006 Generates the @code{sqrtps} machine instruction.
8007 @item v4sf __builtin_ia32_rcpss (v4sf)
8008 Generates the @code{rcpss} machine instruction.
8009 @item v4sf __builtin_ia32_rsqrtss (v4sf)
8010 Generates the @code{rsqrtss} machine instruction.
8011 @item v4sf __builtin_ia32_sqrtss (v4sf)
8012 Generates the @code{sqrtss} machine instruction.
8014 @item v4sf __builtin_ia32_shufps (v4sf, v4sf, int)
8015 Generates the @code{shufps} machine instruction.
8017 @item v4sf __builtin_ia32_loadaps (float *)
8018 Generates the @code{movaps} machine instruction as a load from memory.
8019 @item void __builtin_ia32_storeaps (float *, v4sf)
8020 Generates the @code{movaps} machine instruction as a store to memory.
8021 @item v4sf __builtin_ia32_loadups (float *)
8022 Generates the @code{movups} machine instruction as a load from memory.
8023 @item void __builtin_ia32_storeups (float *, v4sf)
8024 Generates the @code{movups} machine instruction as a store to memory.
8025 @item v4sf __builtin_ia32_loadsss (float *)
8026 Generates the @code{movss} machine instruction as a load from memory.
8027 @item void __builtin_ia32_storess (float *, v4sf)
8028 Generates the @code{movss} machine instruction as a store to memory.
8030 @item v4sf __builtin_ia32_loadhps (v4sf, v2si *)
8031 Generates the @code{movhps} machine instruction as a load from memory.
8032 @item v4sf __builtin_ia32_loadlps (v4sf, v2si *)
8033 Generates the @code{movlps} machine instruction as a load from memory
8034 @item void __builtin_ia32_storehps (v4sf, v2si *)
8035 Generates the @code{movhps} machine instruction as a store to memory.
8036 @item void __builtin_ia32_storelps (v4sf, v2si *)
8037 Generates the @code{movlps} machine instruction as a store to memory.
8039 @item void __builtin_ia32_movntps (float *, v4sf)
8040 Generates the @code{movntps} machine instruction.
8041 @item int __builtin_ia32_movmskps (v4sf)
8042 Generates the @code{movntps} machine instruction.
8044 @item void __builtin_ia32_storeps1 (float *, v4sf)
8045 Generates the @code{movaps} machine instruction as a store to memory.
8046 Before storing, the value is modified with a @code{shufps} instruction
8047 so that the lowest of the four floating point elements is replicated
8048 across the entire vector that is stored.
8049 @item void __builtin_ia32_storerps (float *, v4sf)
8050 Generates the @code{movaps} machine instruction as a store to memory.
8051 Before storing, the value is modified with a @code{shufps} instruction
8052 so that the order of the four floating point elements in the vector is
8053 reversed.
8054 @item v4sf __builtin_ia32_loadps1 (float *)
8055 Generates a @code{movss} machine instruction to load a floating point
8056 value from memory, and a @code{shufps} instruction to replicate the
8057 loaded value across all four elements of the result vector.
8058 @item v4sf __builtin_ia32_loadrps (float *)
8059 Generates a @code{movaps} machine instruction to load a vector from
8060 memory, and a @code{shufps} instruction to reverse the order of the
8061 four floating point elements in the result vector.
8062 @item v4sf __builtin_ia32_setps (float, float, float, float)
8063 Constructs a vector from four single floating point values.  The return
8064 value is equal to the value that would result from storing the four
8065 arguments into consecutive memory locations and then executing a
8066 @code{movaps} to load the vector from memory.
8067 @item v4sf __builtin_ia32_setps1 (float)
8068 Constructs a vector from a single floating point value by replicating
8069 it across all four elements of the result vector.
8070 @end table
8072 @item -mpush-args
8073 @itemx -mno-push-args
8074 @opindex mpush-args
8075 @opindex mno-push-args
8076 Use PUSH operations to store outgoing parameters.  This method is shorter
8077 and usually equally fast as method using SUB/MOV operations and is enabled
8078 by default.  In some cases disabling it may improve performance because of
8079 improved scheduling and reduced dependencies.
8081 @item -maccumulate-outgoing-args
8082 @opindex maccumulate-outgoing-args
8083 If enabled, the maximum amount of space required for outgoing arguments will be
8084 computed in the function prologue.  This is faster on most modern CPUs
8085 because of reduced dependencies, improved scheduling and reduced stack usage
8086 when preferred stack boundary is not equal to 2.  The drawback is a notable
8087 increase in code size.  This switch implies @option{-mno-push-args}.
8089 @item -mthreads
8090 @opindex mthreads
8091 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8092 on thread-safe exception handling must compile and link all code with the
8093 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8094 @option{-D_MT}; when linking, it links in a special thread helper library
8095 @option{-lmingwthrd} which cleans up per thread exception handling data.
8097 @item -mno-align-stringops
8098 @opindex mno-align-stringops
8099 Do not align destination of inlined string operations.  This switch reduces
8100 code size and improves performance in case the destination is already aligned,
8101 but gcc don't know about it.
8103 @item -minline-all-stringops
8104 @opindex minline-all-stringops
8105 By default GCC inlines string operations only when destination is known to be
8106 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8107 size, but may improve performance of code that depends on fast memcpy, strlen
8108 and memset for short lengths.
8110 @item -momit-leaf-frame-pointer
8111 @opindex momit-leaf-frame-pointer
8112 Don't keep the frame pointer in a register for leaf functions.  This
8113 avoids the instructions to save, set up and restore frame pointers and
8114 makes an extra register available in leaf functions.  The option
8115 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8116 which might make debugging harder.
8117 @end table
8119 These @samp{-m} switches are supported in addition to the above
8120 on AMD x86-64 processors in 64-bit environments.
8122 @table @gcctabopt
8123 @item -m32
8124 @itemx -m64
8125 @opindex m32
8126 @opindex m64
8127 Generate code for a 32-bit or 64-bit environment.
8128 The 32-bit environment sets int, long and pointer to 32 bits and
8129 generates code that runs on any i386 system.
8130 The 64-bit environment sets int to 32 bits and long and pointer
8131 to 64 bits and generates code for AMD's x86-64 architecture.
8133 @item -mno-red-zone
8134 @opindex no-red-zone
8135 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8136 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8137 stack pointer that will not be modified by signal or interrupt handlers
8138 and therefore can be used for temporary data without adjusting the stack
8139 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8140 @end table
8142 @node HPPA Options
8143 @subsection HPPA Options
8144 @cindex HPPA Options
8146 These @samp{-m} options are defined for the HPPA family of computers:
8148 @table @gcctabopt
8149 @item -march=@var{architecture-type}
8150 @opindex march
8151 Generate code for the specified architecture.  The choices for
8152 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8153 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8154 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8155 architecture option for your machine.  Code compiled for lower numbered
8156 architectures will run on higher numbered architectures, but not the
8157 other way around.
8159 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8160 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8161 support.
8163 @item -mpa-risc-1-0
8164 @itemx -mpa-risc-1-1
8165 @itemx -mpa-risc-2-0
8166 @opindex mpa-risc-1-0
8167 @opindex mpa-risc-1-1
8168 @opindex mpa-risc-2-0
8169 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8171 @item -mbig-switch
8172 @opindex mbig-switch
8173 Generate code suitable for big switch tables.  Use this option only if
8174 the assembler/linker complain about out of range branches within a switch
8175 table.
8177 @item -mjump-in-delay
8178 @opindex mjump-in-delay
8179 Fill delay slots of function calls with unconditional jump instructions
8180 by modifying the return pointer for the function call to be the target
8181 of the conditional jump.
8183 @item -mdisable-fpregs
8184 @opindex mdisable-fpregs
8185 Prevent floating point registers from being used in any manner.  This is
8186 necessary for compiling kernels which perform lazy context switching of
8187 floating point registers.  If you use this option and attempt to perform
8188 floating point operations, the compiler will abort.
8190 @item -mdisable-indexing
8191 @opindex mdisable-indexing
8192 Prevent the compiler from using indexing address modes.  This avoids some
8193 rather obscure problems when compiling MIG generated code under MACH@.
8195 @item -mno-space-regs
8196 @opindex mno-space-regs
8197 Generate code that assumes the target has no space registers.  This allows
8198 GCC to generate faster indirect calls and use unscaled index address modes.
8200 Such code is suitable for level 0 PA systems and kernels.
8202 @item -mfast-indirect-calls
8203 @opindex mfast-indirect-calls
8204 Generate code that assumes calls never cross space boundaries.  This
8205 allows GCC to emit code which performs faster indirect calls.
8207 This option will not work in the presence of shared libraries or nested
8208 functions.
8210 @item -mlong-load-store
8211 @opindex mlong-load-store
8212 Generate 3-instruction load and store sequences as sometimes required by
8213 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8214 the HP compilers.
8216 @item -mportable-runtime
8217 @opindex mportable-runtime
8218 Use the portable calling conventions proposed by HP for ELF systems.
8220 @item -mgas
8221 @opindex mgas
8222 Enable the use of assembler directives only GAS understands.
8224 @item -mschedule=@var{cpu-type}
8225 @opindex mschedule
8226 Schedule code according to the constraints for the machine type
8227 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8228 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}.  Refer to
8229 @file{/usr/lib/sched.models} on an HP-UX system to determine the
8230 proper scheduling option for your machine.
8232 @item -mlinker-opt
8233 @opindex mlinker-opt
8234 Enable the optimization pass in the HPUX linker.  Note this makes symbolic
8235 debugging impossible.  It also triggers a bug in the HPUX 8 and HPUX 9 linkers
8236 in which they give bogus error messages when linking some programs.
8238 @item -msoft-float
8239 @opindex msoft-float
8240 Generate output containing library calls for floating point.
8241 @strong{Warning:} the requisite libraries are not available for all HPPA
8242 targets.  Normally the facilities of the machine's usual C compiler are
8243 used, but this cannot be done directly in cross-compilation.  You must make
8244 your own arrangements to provide suitable library functions for
8245 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8246 does provide software floating point support.
8248 @option{-msoft-float} changes the calling convention in the output file;
8249 therefore, it is only useful if you compile @emph{all} of a program with
8250 this option.  In particular, you need to compile @file{libgcc.a}, the
8251 library that comes with GCC, with @option{-msoft-float} in order for
8252 this to work.
8253 @end table
8255 @node Intel 960 Options
8256 @subsection Intel 960 Options
8258 These @samp{-m} options are defined for the Intel 960 implementations:
8260 @table @gcctabopt
8261 @item -m@var{cpu-type}
8262 @opindex mka
8263 @opindex mkb
8264 @opindex mmc
8265 @opindex mca
8266 @opindex mcf
8267 @opindex msa
8268 @opindex msb
8269 Assume the defaults for the machine type @var{cpu-type} for some of
8270 the other options, including instruction scheduling, floating point
8271 support, and addressing modes.  The choices for @var{cpu-type} are
8272 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8273 @samp{sa}, and @samp{sb}.
8274 The default is
8275 @samp{kb}.
8277 @item -mnumerics
8278 @itemx -msoft-float
8279 @opindex mnumerics
8280 @opindex msoft-float
8281 The @option{-mnumerics} option indicates that the processor does support
8282 floating-point instructions.  The @option{-msoft-float} option indicates
8283 that floating-point support should not be assumed.
8285 @item -mleaf-procedures
8286 @itemx -mno-leaf-procedures
8287 @opindex mleaf-procedures
8288 @opindex mno-leaf-procedures
8289 Do (or do not) attempt to alter leaf procedures to be callable with the
8290 @code{bal} instruction as well as @code{call}.  This will result in more
8291 efficient code for explicit calls when the @code{bal} instruction can be
8292 substituted by the assembler or linker, but less efficient code in other
8293 cases, such as calls via function pointers, or using a linker that doesn't
8294 support this optimization.
8296 @item -mtail-call
8297 @itemx -mno-tail-call
8298 @opindex mtail-call
8299 @opindex mno-tail-call
8300 Do (or do not) make additional attempts (beyond those of the
8301 machine-independent portions of the compiler) to optimize tail-recursive
8302 calls into branches.  You may not want to do this because the detection of
8303 cases where this is not valid is not totally complete.  The default is
8304 @option{-mno-tail-call}.
8306 @item -mcomplex-addr
8307 @itemx -mno-complex-addr
8308 @opindex mcomplex-addr
8309 @opindex mno-complex-addr
8310 Assume (or do not assume) that the use of a complex addressing mode is a
8311 win on this implementation of the i960.  Complex addressing modes may not
8312 be worthwhile on the K-series, but they definitely are on the C-series.
8313 The default is currently @option{-mcomplex-addr} for all processors except
8314 the CB and CC@.
8316 @item -mcode-align
8317 @itemx -mno-code-align
8318 @opindex mcode-align
8319 @opindex mno-code-align
8320 Align code to 8-byte boundaries for faster fetching (or don't bother).
8321 Currently turned on by default for C-series implementations only.
8323 @ignore
8324 @item -mclean-linkage
8325 @itemx -mno-clean-linkage
8326 @opindex mclean-linkage
8327 @opindex mno-clean-linkage
8328 These options are not fully implemented.
8329 @end ignore
8331 @item -mic-compat
8332 @itemx -mic2.0-compat
8333 @itemx -mic3.0-compat
8334 @opindex mic-compat
8335 @opindex mic2.0-compat
8336 @opindex mic3.0-compat
8337 Enable compatibility with iC960 v2.0 or v3.0.
8339 @item -masm-compat
8340 @itemx -mintel-asm
8341 @opindex masm-compat
8342 @opindex mintel-asm
8343 Enable compatibility with the iC960 assembler.
8345 @item -mstrict-align
8346 @itemx -mno-strict-align
8347 @opindex mstrict-align
8348 @opindex mno-strict-align
8349 Do not permit (do permit) unaligned accesses.
8351 @item -mold-align
8352 @opindex mold-align
8353 Enable structure-alignment compatibility with Intel's gcc release version
8354 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8356 @item -mlong-double-64
8357 @opindex mlong-double-64
8358 Implement type @samp{long double} as 64-bit floating point numbers.
8359 Without the option @samp{long double} is implemented by 80-bit
8360 floating point numbers.  The only reason we have it because there is
8361 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8362 is only useful for people using soft-float targets.  Otherwise, we
8363 should recommend against use of it.
8365 @end table
8367 @node DEC Alpha Options
8368 @subsection DEC Alpha Options
8370 These @samp{-m} options are defined for the DEC Alpha implementations:
8372 @table @gcctabopt
8373 @item -mno-soft-float
8374 @itemx -msoft-float
8375 @opindex mno-soft-float
8376 @opindex msoft-float
8377 Use (do not use) the hardware floating-point instructions for
8378 floating-point operations.  When @option{-msoft-float} is specified,
8379 functions in @file{libgcc.a} will be used to perform floating-point
8380 operations.  Unless they are replaced by routines that emulate the
8381 floating-point operations, or compiled in such a way as to call such
8382 emulations routines, these routines will issue floating-point
8383 operations.   If you are compiling for an Alpha without floating-point
8384 operations, you must ensure that the library is built so as not to call
8385 them.
8387 Note that Alpha implementations without floating-point operations are
8388 required to have floating-point registers.
8390 @item -mfp-reg
8391 @itemx -mno-fp-regs
8392 @opindex mfp-reg
8393 @opindex mno-fp-regs
8394 Generate code that uses (does not use) the floating-point register set.
8395 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8396 register set is not used, floating point operands are passed in integer
8397 registers as if they were integers and floating-point results are passed
8398 in $0 instead of $f0.  This is a non-standard calling sequence, so any
8399 function with a floating-point argument or return value called by code
8400 compiled with @option{-mno-fp-regs} must also be compiled with that
8401 option.
8403 A typical use of this option is building a kernel that does not use,
8404 and hence need not save and restore, any floating-point registers.
8406 @item -mieee
8407 @opindex mieee
8408 The Alpha architecture implements floating-point hardware optimized for
8409 maximum performance.  It is mostly compliant with the IEEE floating
8410 point standard.  However, for full compliance, software assistance is
8411 required.  This option generates code fully IEEE compliant code
8412 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8413 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8414 defined during compilation.  The resulting code is less efficient but is
8415 able to correctly support denormalized numbers and exceptional IEEE
8416 values such as not-a-number and plus/minus infinity.  Other Alpha
8417 compilers call this option @option{-ieee_with_no_inexact}.
8419 @item -mieee-with-inexact
8420 @opindex mieee-with-inexact
8421 This is like @option{-mieee} except the generated code also maintains
8422 the IEEE @var{inexact-flag}.  Turning on this option causes the
8423 generated code to implement fully-compliant IEEE math.  In addition to
8424 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8425 macro.  On some Alpha implementations the resulting code may execute
8426 significantly slower than the code generated by default.  Since there is
8427 very little code that depends on the @var{inexact-flag}, you should
8428 normally not specify this option.  Other Alpha compilers call this
8429 option @option{-ieee_with_inexact}.
8431 @item -mfp-trap-mode=@var{trap-mode}
8432 @opindex mfp-trap-mode
8433 This option controls what floating-point related traps are enabled.
8434 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8435 The trap mode can be set to one of four values:
8437 @table @samp
8438 @item n
8439 This is the default (normal) setting.  The only traps that are enabled
8440 are the ones that cannot be disabled in software (e.g., division by zero
8441 trap).
8443 @item u
8444 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8445 as well.
8447 @item su
8448 Like @samp{su}, but the instructions are marked to be safe for software
8449 completion (see Alpha architecture manual for details).
8451 @item sui
8452 Like @samp{su}, but inexact traps are enabled as well.
8453 @end table
8455 @item -mfp-rounding-mode=@var{rounding-mode}
8456 @opindex mfp-rounding-mode
8457 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8458 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8461 @table @samp
8462 @item n
8463 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8464 the nearest machine number or towards the even machine number in case
8465 of a tie.
8467 @item m
8468 Round towards minus infinity.
8470 @item c
8471 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8473 @item d
8474 Dynamic rounding mode.  A field in the floating point control register
8475 (@var{fpcr}, see Alpha architecture reference manual) controls the
8476 rounding mode in effect.  The C library initializes this register for
8477 rounding towards plus infinity.  Thus, unless your program modifies the
8478 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8479 @end table
8481 @item -mtrap-precision=@var{trap-precision}
8482 @opindex mtrap-precision
8483 In the Alpha architecture, floating point traps are imprecise.  This
8484 means without software assistance it is impossible to recover from a
8485 floating trap and program execution normally needs to be terminated.
8486 GCC can generate code that can assist operating system trap handlers
8487 in determining the exact location that caused a floating point trap.
8488 Depending on the requirements of an application, different levels of
8489 precisions can be selected:
8491 @table @samp
8492 @item p
8493 Program precision.  This option is the default and means a trap handler
8494 can only identify which program caused a floating point exception.
8496 @item f
8497 Function precision.  The trap handler can determine the function that
8498 caused a floating point exception.
8500 @item i
8501 Instruction precision.  The trap handler can determine the exact
8502 instruction that caused a floating point exception.
8503 @end table
8505 Other Alpha compilers provide the equivalent options called
8506 @option{-scope_safe} and @option{-resumption_safe}.
8508 @item -mieee-conformant
8509 @opindex mieee-conformant
8510 This option marks the generated code as IEEE conformant.  You must not
8511 use this option unless you also specify @option{-mtrap-precision=i} and either
8512 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8513 is to emit the line @samp{.eflag 48} in the function prologue of the
8514 generated assembly file.  Under DEC Unix, this has the effect that
8515 IEEE-conformant math library routines will be linked in.
8517 @item -mbuild-constants
8518 @opindex mbuild-constants
8519 Normally GCC examines a 32- or 64-bit integer constant to
8520 see if it can construct it from smaller constants in two or three
8521 instructions.  If it cannot, it will output the constant as a literal and
8522 generate code to load it from the data segment at runtime.
8524 Use this option to require GCC to construct @emph{all} integer constants
8525 using code, even if it takes more instructions (the maximum is six).
8527 You would typically use this option to build a shared library dynamic
8528 loader.  Itself a shared library, it must relocate itself in memory
8529 before it can find the variables and constants in its own data segment.
8531 @item -malpha-as
8532 @itemx -mgas
8533 @opindex malpha-as
8534 @opindex mgas
8535 Select whether to generate code to be assembled by the vendor-supplied
8536 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8538 @item -mbwx
8539 @itemx -mno-bwx
8540 @itemx -mcix
8541 @itemx -mno-cix
8542 @itemx -mmax
8543 @itemx -mno-max
8544 @opindex mbwx
8545 @opindex mno-bwx
8546 @opindex mcix
8547 @opindex mno-cix
8548 @opindex mmax
8549 @opindex mno-max
8550 Indicate whether GCC should generate code to use the optional BWX,
8551 CIX, and MAX instruction sets.  The default is to use the instruction sets
8552 supported by the CPU type specified via @option{-mcpu=} option or that
8553 of the CPU on which GCC was built if none was specified.
8555 @item -mcpu=@var{cpu_type}
8556 @opindex mcpu
8557 Set the instruction set, register set, and instruction scheduling
8558 parameters for machine type @var{cpu_type}.  You can specify either the
8559 @samp{EV} style name or the corresponding chip number.  GCC
8560 supports scheduling parameters for the EV4 and EV5 family of processors
8561 and will choose the default values for the instruction set from
8562 the processor you specify.  If you do not specify a processor type,
8563 GCC will default to the processor on which the compiler was built.
8565 Supported values for @var{cpu_type} are
8567 @table @samp
8568 @item ev4
8569 @itemx 21064
8570 Schedules as an EV4 and has no instruction set extensions.
8572 @item ev5
8573 @itemx 21164
8574 Schedules as an EV5 and has no instruction set extensions.
8576 @item ev56
8577 @itemx 21164a
8578 Schedules as an EV5 and supports the BWX extension.
8580 @item pca56
8581 @itemx 21164pc
8582 @itemx 21164PC
8583 Schedules as an EV5 and supports the BWX and MAX extensions.
8585 @item ev6
8586 @itemx 21264
8587 Schedules as an EV5 (until Digital releases the scheduling parameters
8588 for the EV6) and supports the BWX, CIX, and MAX extensions.
8589 @end table
8591 @item -mmemory-latency=@var{time}
8592 @opindex mmemory-latency
8593 Sets the latency the scheduler should assume for typical memory
8594 references as seen by the application.  This number is highly
8595 dependent on the memory access patterns used by the application
8596 and the size of the external cache on the machine.
8598 Valid options for @var{time} are
8600 @table @samp
8601 @item @var{number}
8602 A decimal number representing clock cycles.
8604 @item L1
8605 @itemx L2
8606 @itemx L3
8607 @itemx main
8608 The compiler contains estimates of the number of clock cycles for
8609 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8610 (also called Dcache, Scache, and Bcache), as well as to main memory.
8611 Note that L3 is only valid for EV5.
8613 @end table
8614 @end table
8616 @node Clipper Options
8617 @subsection Clipper Options
8619 These @samp{-m} options are defined for the Clipper implementations:
8621 @table @gcctabopt
8622 @item -mc300
8623 @opindex mc300
8624 Produce code for a C300 Clipper processor.  This is the default.
8626 @item -mc400
8627 @opindex mc400
8628 Produce code for a C400 Clipper processor, i.e.@: use floating point
8629 registers f8--f15.
8630 @end table
8632 @node H8/300 Options
8633 @subsection H8/300 Options
8635 These @samp{-m} options are defined for the H8/300 implementations:
8637 @table @gcctabopt
8638 @item -mrelax
8639 @opindex mrelax
8640 Shorten some address references at link time, when possible; uses the
8641 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8642 ld.info, Using ld}, for a fuller description.
8644 @item -mh
8645 @opindex mh
8646 Generate code for the H8/300H@.
8648 @item -ms
8649 @opindex ms
8650 Generate code for the H8/S@.
8652 @item -ms2600
8653 @opindex ms2600
8654 Generate code for the H8/S2600.  This switch must be used with @option{-ms}.
8656 @item -mint32
8657 @opindex mint32
8658 Make @code{int} data 32 bits by default.
8660 @item -malign-300
8661 @opindex malign-300
8662 On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
8663 The default for the H8/300H and H8/S is to align longs and floats on 4
8664 byte boundaries.
8665 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8666 This option has no effect on the H8/300.
8667 @end table
8669 @node SH Options
8670 @subsection SH Options
8672 These @samp{-m} options are defined for the SH implementations:
8674 @table @gcctabopt
8675 @item -m1
8676 @opindex m1
8677 Generate code for the SH1.
8679 @item -m2
8680 @opindex m2
8681 Generate code for the SH2.
8683 @item -m3
8684 @opindex m3
8685 Generate code for the SH3.
8687 @item -m3e
8688 @opindex m3e
8689 Generate code for the SH3e.
8691 @item -m4-nofpu
8692 @opindex m4-nofpu
8693 Generate code for the SH4 without a floating-point unit.
8695 @item -m4-single-only
8696 @opindex m4-single-only
8697 Generate code for the SH4 with a floating-point unit that only
8698 supports single-precision arithmetic.
8700 @item -m4-single
8701 @opindex m4-single
8702 Generate code for the SH4 assuming the floating-point unit is in
8703 single-precision mode by default.
8705 @item -m4
8706 @opindex m4
8707 Generate code for the SH4.
8709 @item -mb
8710 @opindex mb
8711 Compile code for the processor in big endian mode.
8713 @item -ml
8714 @opindex ml
8715 Compile code for the processor in little endian mode.
8717 @item -mdalign
8718 @opindex mdalign
8719 Align doubles at 64-bit boundaries.  Note that this changes the calling
8720 conventions, and thus some functions from the standard C library will
8721 not work unless you recompile it first with @option{-mdalign}.
8723 @item -mrelax
8724 @opindex mrelax
8725 Shorten some address references at link time, when possible; uses the
8726 linker option @option{-relax}.
8728 @item -mbigtable
8729 @opindex mbigtable
8730 Use 32-bit offsets in @code{switch} tables.  The default is to use
8731 16-bit offsets.
8733 @item -mfmovd
8734 @opindex mfmovd
8735 Enable the use of the instruction @code{fmovd}.
8737 @item -mhitachi
8738 @opindex mhitachi
8739 Comply with the calling conventions defined by Hitachi.
8741 @item -mnomacsave
8742 @opindex mnomacsave
8743 Mark the @code{MAC} register as call-clobbered, even if
8744 @option{-mhitachi} is given.
8746 @item -mieee
8747 @opindex mieee
8748 Increase IEEE-compliance of floating-point code.
8750 @item -misize
8751 @opindex misize
8752 Dump instruction size and location in the assembly code.
8754 @item -mpadstruct
8755 @opindex mpadstruct
8756 This option is deprecated.  It pads structures to multiple of 4 bytes,
8757 which is incompatible with the SH ABI@.
8759 @item -mspace
8760 @opindex mspace
8761 Optimize for space instead of speed.  Implied by @option{-Os}.
8763 @item -mprefergot
8764 @opindex mprefergot
8765 When generating position-independent code, emit function calls using
8766 the Global Offset Table instead of the Procedure Linkage Table.
8768 @item -musermode
8769 @opindex musermode
8770 Generate a library function call to invalidate instruction cache
8771 entries, after fixing up a trampoline.  This library function call
8772 doesn't assume it can write to the whole memory address space.  This
8773 is the default when the target is @code{sh-*-linux*}.
8774 @end table
8776 @node System V Options
8777 @subsection Options for System V
8779 These additional options are available on System V Release 4 for
8780 compatibility with other compilers on those systems:
8782 @table @gcctabopt
8783 @item -G
8784 @opindex G
8785 Create a shared object.
8786 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
8788 @item -Qy
8789 @opindex Qy
8790 Identify the versions of each tool used by the compiler, in a
8791 @code{.ident} assembler directive in the output.
8793 @item -Qn
8794 @opindex Qn
8795 Refrain from adding @code{.ident} directives to the output file (this is
8796 the default).
8798 @item -YP,@var{dirs}
8799 @opindex YP
8800 Search the directories @var{dirs}, and no others, for libraries
8801 specified with @option{-l}.
8803 @item -Ym,@var{dir}
8804 @opindex Ym
8805 Look in the directory @var{dir} to find the M4 preprocessor.
8806 The assembler uses this option.
8807 @c This is supposed to go with a -Yd for predefined M4 macro files, but
8808 @c the generic assembler that comes with Solaris takes just -Ym.
8809 @end table
8811 @node TMS320C3x/C4x Options
8812 @subsection TMS320C3x/C4x Options
8813 @cindex TMS320C3x/C4x Options
8815 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
8817 @table @gcctabopt
8819 @item -mcpu=@var{cpu_type}
8820 @opindex mcpu
8821 Set the instruction set, register set, and instruction scheduling
8822 parameters for machine type @var{cpu_type}.  Supported values for
8823 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
8824 @samp{c44}.  The default is @samp{c40} to generate code for the
8825 TMS320C40.
8827 @item -mbig-memory
8828 @item -mbig
8829 @itemx -msmall-memory
8830 @itemx -msmall
8831 @opindex mbig-memory
8832 @opindex mbig
8833 @opindex msmall-memory
8834 @opindex msmall
8835 Generates code for the big or small memory model.  The small memory
8836 model assumed that all data fits into one 64K word page.  At run-time
8837 the data page (DP) register must be set to point to the 64K page
8838 containing the .bss and .data program sections.  The big memory model is
8839 the default and requires reloading of the DP register for every direct
8840 memory access.
8842 @item -mbk
8843 @itemx -mno-bk
8844 @opindex mbk
8845 @opindex mno-bk
8846 Allow (disallow) allocation of general integer operands into the block
8847 count register BK@.
8849 @item -mdb
8850 @itemx -mno-db
8851 @opindex mdb
8852 @opindex mno-db
8853 Enable (disable) generation of code using decrement and branch,
8854 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
8855 on the safe side, this is disabled for the C3x, since the maximum
8856 iteration count on the C3x is @math{2^23 + 1} (but who iterates loops more than
8857 @math{2^23} times on the C3x?).  Note that GCC will try to reverse a loop so
8858 that it can utilise the decrement and branch instruction, but will give
8859 up if there is more than one memory reference in the loop.  Thus a loop
8860 where the loop counter is decremented can generate slightly more
8861 efficient code, in cases where the RPTB instruction cannot be utilised.
8863 @item -mdp-isr-reload
8864 @itemx -mparanoid
8865 @opindex mdp-isr-reload
8866 @opindex mparanoid
8867 Force the DP register to be saved on entry to an interrupt service
8868 routine (ISR), reloaded to point to the data section, and restored on
8869 exit from the ISR@.  This should not be required unless someone has
8870 violated the small memory model by modifying the DP register, say within
8871 an object library.
8873 @item -mmpyi
8874 @itemx -mno-mpyi
8875 @opindex mmpyi
8876 @opindex mno-mpyi
8877 For the C3x use the 24-bit MPYI instruction for integer multiplies
8878 instead of a library call to guarantee 32-bit results.  Note that if one
8879 of the operands is a constant, then the multiplication will be performed
8880 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
8881 then squaring operations are performed inline instead of a library call.
8883 @item -mfast-fix
8884 @itemx -mno-fast-fix
8885 @opindex mfast-fix
8886 @opindex mno-fast-fix
8887 The C3x/C4x FIX instruction to convert a floating point value to an
8888 integer value chooses the nearest integer less than or equal to the
8889 floating point value rather than to the nearest integer.  Thus if the
8890 floating point number is negative, the result will be incorrectly
8891 truncated an additional code is necessary to detect and correct this
8892 case.  This option can be used to disable generation of the additional
8893 code required to correct the result.
8895 @item -mrptb
8896 @itemx -mno-rptb
8897 @opindex mrptb
8898 @opindex mno-rptb
8899 Enable (disable) generation of repeat block sequences using the RPTB
8900 instruction for zero overhead looping.  The RPTB construct is only used
8901 for innermost loops that do not call functions or jump across the loop
8902 boundaries.  There is no advantage having nested RPTB loops due to the
8903 overhead required to save and restore the RC, RS, and RE registers.
8904 This is enabled by default with @option{-O2}.
8906 @item -mrpts=@var{count}
8907 @itemx -mno-rpts
8908 @opindex mrpts
8909 @opindex mno-rpts
8910 Enable (disable) the use of the single instruction repeat instruction
8911 RPTS@.  If a repeat block contains a single instruction, and the loop
8912 count can be guaranteed to be less than the value @var{count}, GCC will
8913 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
8914 then a RPTS will be emitted even if the loop count cannot be determined
8915 at compile time.  Note that the repeated instruction following RPTS does
8916 not have to be reloaded from memory each iteration, thus freeing up the
8917 CPU buses for operands.  However, since interrupts are blocked by this
8918 instruction, it is disabled by default.
8920 @item -mloop-unsigned
8921 @itemx -mno-loop-unsigned
8922 @opindex mloop-unsigned
8923 @opindex mno-loop-unsigned
8924 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
8925 is @math{2^31 + 1} since these instructions test if the iteration count is
8926 negative to terminate the loop.  If the iteration count is unsigned
8927 there is a possibility than the @math{2^31 + 1} maximum iteration count may be
8928 exceeded.  This switch allows an unsigned iteration count.
8930 @item -mti
8931 @opindex mti
8932 Try to emit an assembler syntax that the TI assembler (asm30) is happy
8933 with.  This also enforces compatibility with the API employed by the TI
8934 C3x C compiler.  For example, long doubles are passed as structures
8935 rather than in floating point registers.
8937 @item -mregparm
8938 @itemx -mmemparm
8939 @opindex mregparm
8940 @opindex mmemparm
8941 Generate code that uses registers (stack) for passing arguments to functions.
8942 By default, arguments are passed in registers where possible rather
8943 than by pushing arguments on to the stack.
8945 @item -mparallel-insns
8946 @itemx -mno-parallel-insns
8947 @opindex mparallel-insns
8948 @opindex mno-parallel-insns
8949 Allow the generation of parallel instructions.  This is enabled by
8950 default with @option{-O2}.
8952 @item -mparallel-mpy
8953 @itemx -mno-parallel-mpy
8954 @opindex mparallel-mpy
8955 @opindex mno-parallel-mpy
8956 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
8957 provided @option{-mparallel-insns} is also specified.  These instructions have
8958 tight register constraints which can pessimize the code generation
8959 of large functions.
8961 @end table
8963 @node V850 Options
8964 @subsection V850 Options
8965 @cindex V850 Options
8967 These @samp{-m} options are defined for V850 implementations:
8969 @table @gcctabopt
8970 @item -mlong-calls
8971 @itemx -mno-long-calls
8972 @opindex mlong-calls
8973 @opindex mno-long-calls
8974 Treat all calls as being far away (near).  If calls are assumed to be
8975 far away, the compiler will always load the functions address up into a
8976 register, and call indirect through the pointer.
8978 @item -mno-ep
8979 @itemx -mep
8980 @opindex mno-ep
8981 @opindex mep
8982 Do not optimize (do optimize) basic blocks that use the same index
8983 pointer 4 or more times to copy pointer into the @code{ep} register, and
8984 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
8985 option is on by default if you optimize.
8987 @item -mno-prolog-function
8988 @itemx -mprolog-function
8989 @opindex mno-prolog-function
8990 @opindex mprolog-function
8991 Do not use (do use) external functions to save and restore registers at
8992 the prolog and epilog of a function.  The external functions are slower,
8993 but use less code space if more than one function saves the same number
8994 of registers.  The @option{-mprolog-function} option is on by default if
8995 you optimize.
8997 @item -mspace
8998 @opindex mspace
8999 Try to make the code as small as possible.  At present, this just turns
9000 on the @option{-mep} and @option{-mprolog-function} options.
9002 @item -mtda=@var{n}
9003 @opindex mtda
9004 Put static or global variables whose size is @var{n} bytes or less into
9005 the tiny data area that register @code{ep} points to.  The tiny data
9006 area can hold up to 256 bytes in total (128 bytes for byte references).
9008 @item -msda=@var{n}
9009 @opindex msda
9010 Put static or global variables whose size is @var{n} bytes or less into
9011 the small data area that register @code{gp} points to.  The small data
9012 area can hold up to 64 kilobytes.
9014 @item -mzda=@var{n}
9015 @opindex mzda
9016 Put static or global variables whose size is @var{n} bytes or less into
9017 the first 32 kilobytes of memory.
9019 @item -mv850
9020 @opindex mv850
9021 Specify that the target processor is the V850.
9023 @item -mbig-switch
9024 @opindex mbig-switch
9025 Generate code suitable for big switch tables.  Use this option only if
9026 the assembler/linker complain about out of range branches within a switch
9027 table.
9028 @end table
9030 @node ARC Options
9031 @subsection ARC Options
9032 @cindex ARC Options
9034 These options are defined for ARC implementations:
9036 @table @gcctabopt
9037 @item -EL
9038 @opindex EL
9039 Compile code for little endian mode.  This is the default.
9041 @item -EB
9042 @opindex EB
9043 Compile code for big endian mode.
9045 @item -mmangle-cpu
9046 @opindex mmangle-cpu
9047 Prepend the name of the cpu to all public symbol names.
9048 In multiple-processor systems, there are many ARC variants with different
9049 instruction and register set characteristics.  This flag prevents code
9050 compiled for one cpu to be linked with code compiled for another.
9051 No facility exists for handling variants that are ``almost identical''.
9052 This is an all or nothing option.
9054 @item -mcpu=@var{cpu}
9055 @opindex mcpu
9056 Compile code for ARC variant @var{cpu}.
9057 Which variants are supported depend on the configuration.
9058 All variants support @option{-mcpu=base}, this is the default.
9060 @item -mtext=@var{text-section}
9061 @itemx -mdata=@var{data-section}
9062 @itemx -mrodata=@var{readonly-data-section}
9063 @opindex mtext
9064 @opindex mdata
9065 @opindex mrodata
9066 Put functions, data, and readonly data in @var{text-section},
9067 @var{data-section}, and @var{readonly-data-section} respectively
9068 by default.  This can be overridden with the @code{section} attribute.
9069 @xref{Variable Attributes}.
9071 @end table
9073 @node NS32K Options
9074 @subsection NS32K Options
9075 @cindex NS32K options
9077 These are the @samp{-m} options defined for the 32000 series.  The default
9078 values for these options depends on which style of 32000 was selected when
9079 the compiler was configured; the defaults for the most common choices are
9080 given below.
9082 @table @gcctabopt
9083 @item -m32032
9084 @itemx -m32032
9085 @opindex m32032
9086 @opindex m32032
9087 Generate output for a 32032.  This is the default
9088 when the compiler is configured for 32032 and 32016 based systems.
9090 @item -m32332
9091 @itemx -m32332
9092 @opindex m32332
9093 @opindex m32332
9094 Generate output for a 32332.  This is the default
9095 when the compiler is configured for 32332-based systems.
9097 @item -m32532
9098 @itemx -m32532
9099 @opindex m32532
9100 @opindex m32532
9101 Generate output for a 32532.  This is the default
9102 when the compiler is configured for 32532-based systems.
9104 @item -m32081
9105 @opindex m32081
9106 Generate output containing 32081 instructions for floating point.
9107 This is the default for all systems.
9109 @item -m32381
9110 @opindex m32381
9111 Generate output containing 32381 instructions for floating point.  This
9112 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9113 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9115 @item -mmulti-add
9116 @opindex mmulti-add
9117 Try and generate multiply-add floating point instructions @code{polyF}
9118 and @code{dotF}.  This option is only available if the @option{-m32381}
9119 option is in effect.  Using these instructions requires changes to
9120 register allocation which generally has a negative impact on
9121 performance.  This option should only be enabled when compiling code
9122 particularly likely to make heavy use of multiply-add instructions.
9124 @item -mnomulti-add
9125 @opindex mnomulti-add
9126 Do not try and generate multiply-add floating point instructions
9127 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9129 @item -msoft-float
9130 @opindex msoft-float
9131 Generate output containing library calls for floating point.
9132 @strong{Warning:} the requisite libraries may not be available.
9134 @item -mnobitfield
9135 @opindex mnobitfield
9136 Do not use the bit-field instructions.  On some machines it is faster to
9137 use shifting and masking operations.  This is the default for the pc532.
9139 @item -mbitfield
9140 @opindex mbitfield
9141 Do use the bit-field instructions.  This is the default for all platforms
9142 except the pc532.
9144 @item -mrtd
9145 @opindex mrtd
9146 Use a different function-calling convention, in which functions
9147 that take a fixed number of arguments return pop their
9148 arguments on return with the @code{ret} instruction.
9150 This calling convention is incompatible with the one normally
9151 used on Unix, so you cannot use it if you need to call libraries
9152 compiled with the Unix compiler.
9154 Also, you must provide function prototypes for all functions that
9155 take variable numbers of arguments (including @code{printf});
9156 otherwise incorrect code will be generated for calls to those
9157 functions.
9159 In addition, seriously incorrect code will result if you call a
9160 function with too many arguments.  (Normally, extra arguments are
9161 harmlessly ignored.)
9163 This option takes its name from the 680x0 @code{rtd} instruction.
9166 @item -mregparam
9167 @opindex mregparam
9168 Use a different function-calling convention where the first two arguments
9169 are passed in registers.
9171 This calling convention is incompatible with the one normally
9172 used on Unix, so you cannot use it if you need to call libraries
9173 compiled with the Unix compiler.
9175 @item -mnoregparam
9176 @opindex mnoregparam
9177 Do not pass any arguments in registers.  This is the default for all
9178 targets.
9180 @item -msb
9181 @opindex msb
9182 It is OK to use the sb as an index register which is always loaded with
9183 zero.  This is the default for the pc532-netbsd target.
9185 @item -mnosb
9186 @opindex mnosb
9187 The sb register is not available for use or has not been initialized to
9188 zero by the run time system.  This is the default for all targets except
9189 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9190 @option{-fpic} is set.
9192 @item -mhimem
9193 @opindex mhimem
9194 Many ns32000 series addressing modes use displacements of up to 512MB@.
9195 If an address is above 512MB then displacements from zero can not be used.
9196 This option causes code to be generated which can be loaded above 512MB@.
9197 This may be useful for operating systems or ROM code.
9199 @item -mnohimem
9200 @opindex mnohimem
9201 Assume code will be loaded in the first 512MB of virtual address space.
9202 This is the default for all platforms.
9205 @end table
9207 @node AVR Options
9208 @subsection AVR Options
9209 @cindex AVR Options
9211 These options are defined for AVR implementations:
9213 @table @gcctabopt
9214 @item -mmcu=@var{mcu}
9215 @opindex mmcu
9216 Specify ATMEL AVR instruction set or MCU type.
9218 Instruction set avr1 is for the minimal AVR core, not supported by the C
9219 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9220 attiny11, attiny12, attiny15, attiny28).
9222 Instruction set avr2 (default) is for the classic AVR core with up to
9223 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9224 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9225 at90c8534, at90s8535).
9227 Instruction set avr3 is for the classic AVR core with up to 128K program
9228 memory space (MCU types: atmega103, atmega603).
9230 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9231 memory space (MCU types: atmega83, atmega85).
9233 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9234 memory space (MCU types: atmega161, atmega163, atmega32, at94k).
9236 @item -msize
9237 @opindex msize
9238 Output instruction sizes to the asm file.
9240 @item -minit-stack=@var{N}
9241 @opindex minit-stack
9242 Specify the initial stack address, which may be a symbol or numeric value,
9243 @samp{__stack} is the default.
9245 @item -mno-interrupts
9246 @opindex mno-interrupts
9247 Generated code is not compatible with hardware interrupts.
9248 Code size will be smaller.
9250 @item -mcall-prologues
9251 @opindex mcall-prologues
9252 Functions prologues/epilogues expanded as call to appropriate
9253 subroutines.  Code size will be smaller.
9255 @item -mno-tablejump
9256 @opindex mno-tablejump
9257 Do not generate tablejump insns which sometimes increase code size.
9259 @item -mtiny-stack
9260 @opindex mtiny-stack
9261 Change only the low 8 bits of the stack pointer.
9262 @end table
9264 @node MCore Options
9265 @subsection MCore Options
9266 @cindex MCore options
9268 These are the @samp{-m} options defined for the Motorola M*Core
9269 processors.
9271 @table @gcctabopt
9273 @item -mhardlit
9274 @itemx -mhardlit
9275 @itemx -mno-hardlit
9276 @opindex mhardlit
9277 @opindex mhardlit
9278 @opindex mno-hardlit
9279 Inline constants into the code stream if it can be done in two
9280 instructions or less.
9282 @item -mdiv
9283 @itemx -mdiv
9284 @itemx -mno-div
9285 @opindex mdiv
9286 @opindex mdiv
9287 @opindex mno-div
9288 Use the divide instruction.  (Enabled by default).
9290 @item -mrelax-immediate
9291 @itemx -mrelax-immediate
9292 @itemx -mno-relax-immediate
9293 @opindex mrelax-immediate
9294 @opindex mrelax-immediate
9295 @opindex mno-relax-immediate
9296 Allow arbitrary sized immediates in bit operations.
9298 @item -mwide-bitfields
9299 @itemx -mwide-bitfields
9300 @itemx -mno-wide-bitfields
9301 @opindex mwide-bitfields
9302 @opindex mwide-bitfields
9303 @opindex mno-wide-bitfields
9304 Always treat bit-fields as int-sized.
9306 @item -m4byte-functions
9307 @itemx -m4byte-functions
9308 @itemx -mno-4byte-functions
9309 @opindex m4byte-functions
9310 @opindex m4byte-functions
9311 @opindex mno-4byte-functions
9312 Force all functions to be aligned to a four byte boundary.
9314 @item -mcallgraph-data
9315 @itemx -mcallgraph-data
9316 @itemx -mno-callgraph-data
9317 @opindex mcallgraph-data
9318 @opindex mcallgraph-data
9319 @opindex mno-callgraph-data
9320 Emit callgraph information.
9322 @item -mslow-bytes
9323 @itemx -mslow-bytes
9324 @itemx -mno-slow-bytes
9325 @opindex mslow-bytes
9326 @opindex mslow-bytes
9327 @opindex mno-slow-bytes
9328 Prefer word access when reading byte quantities.
9330 @item -mlittle-endian
9331 @itemx -mlittle-endian
9332 @itemx -mbig-endian
9333 @opindex mlittle-endian
9334 @opindex mlittle-endian
9335 @opindex mbig-endian
9336 Generate code for a little endian target.
9338 @item -m210
9339 @itemx -m210
9340 @itemx -m340
9341 @opindex m210
9342 @opindex m210
9343 @opindex m340
9344 Generate code for the 210 processor.
9345 @end table
9347 @node IA-64 Options
9348 @subsection IA-64 Options
9349 @cindex IA-64 Options
9351 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9353 @table @gcctabopt
9354 @item -mbig-endian
9355 @opindex mbig-endian
9356 Generate code for a big endian target.  This is the default for HPUX@.
9358 @item -mlittle-endian
9359 @opindex mlittle-endian
9360 Generate code for a little endian target.  This is the default for AIX5
9361 and Linux.
9363 @item -mgnu-as
9364 @itemx -mno-gnu-as
9365 @opindex mgnu-as
9366 @opindex mno-gnu-as
9367 Generate (or don't) code for the GNU assembler.  This is the default.
9368 @c Also, this is the default if the configure option @option{--with-gnu-as}
9369 @c is used.
9371 @item -mgnu-ld
9372 @itemx -mno-gnu-ld
9373 @opindex mgnu-ld
9374 @opindex mno-gnu-ld
9375 Generate (or don't) code for the GNU linker.  This is the default.
9376 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9377 @c is used.
9379 @item -mno-pic
9380 @opindex mno-pic
9381 Generate code that does not use a global pointer register.  The result
9382 is not position independent code, and violates the IA-64 ABI@.
9384 @item -mvolatile-asm-stop
9385 @itemx -mno-volatile-asm-stop
9386 @opindex mvolatile-asm-stop
9387 @opindex mno-volatile-asm-stop
9388 Generate (or don't) a stop bit immediately before and after volatile asm
9389 statements.
9391 @item -mb-step
9392 @opindex mb-step
9393 Generate code that works around Itanium B step errata.
9395 @item -mregister-names
9396 @itemx -mno-register-names
9397 @opindex mregister-names
9398 @opindex mno-register-names
9399 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9400 the stacked registers.  This may make assembler output more readable.
9402 @item -mno-sdata
9403 @itemx -msdata
9404 @opindex mno-sdata
9405 @opindex msdata
9406 Disable (or enable) optimizations that use the small data section.  This may
9407 be useful for working around optimizer bugs.
9409 @item -mconstant-gp
9410 @opindex mconstant-gp
9411 Generate code that uses a single constant global pointer value.  This is
9412 useful when compiling kernel code.
9414 @item -mauto-pic
9415 @opindex mauto-pic
9416 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9417 This is useful when compiling firmware code.
9419 @item -minline-divide-min-latency
9420 @opindex minline-divide-min-latency
9421 Generate code for inline divides using the minimum latency algorithm.
9423 @item -minline-divide-max-throughput
9424 @opindex minline-divide-max-throughput
9425 Generate code for inline divides using the maximum throughput algorithm.
9427 @item -mno-dwarf2-asm
9428 @itemx -mdwarf2-asm
9429 @opindex mno-dwarf2-asm
9430 @opindex mdwarf2-asm
9431 Don't (or do) generate assembler code for the DWARF2 line number debugging
9432 info.  This may be useful when not using the GNU assembler.
9434 @item -mfixed-range=@var{register-range}
9435 @opindex mfixed-range
9436 Generate code treating the given register range as fixed registers.
9437 A fixed register is one that the register allocator can not use.  This is
9438 useful when compiling kernel code.  A register range is specified as
9439 two registers separated by a dash.  Multiple register ranges can be
9440 specified separated by a comma.
9441 @end table
9443 @node D30V Options
9444 @subsection D30V Options
9445 @cindex D30V Options
9447 These @samp{-m} options are defined for D30V implementations:
9449 @table @gcctabopt
9450 @item -mextmem
9451 @opindex mextmem
9452 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9453 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9454 memory, which starts at location @code{0x80000000}.
9456 @item -mextmemory
9457 @opindex mextmemory
9458 Same as the @option{-mextmem} switch.
9460 @item -monchip
9461 @opindex monchip
9462 Link the @samp{.text} section into onchip text memory, which starts at
9463 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9464 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9465 into onchip data memory, which starts at location @code{0x20000000}.
9467 @item -mno-asm-optimize
9468 @itemx -masm-optimize
9469 @opindex mno-asm-optimize
9470 @opindex masm-optimize
9471 Disable (enable) passing @option{-O} to the assembler when optimizing.
9472 The assembler uses the @option{-O} option to automatically parallelize
9473 adjacent short instructions where possible.
9475 @item -mbranch-cost=@var{n}
9476 @opindex mbranch-cost
9477 Increase the internal costs of branches to @var{n}.  Higher costs means
9478 that the compiler will issue more instructions to avoid doing a branch.
9479 The default is 2.
9481 @item -mcond-exec=@var{n}
9482 @opindex mcond-exec
9483 Specify the maximum number of conditionally executed instructions that
9484 replace a branch.  The default is 4.
9485 @end table
9487 @node S/390 and zSeries Options
9488 @subsection S/390 and zSeries Options
9489 @cindex S/390 and zSeries Options
9491 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9493 @table @gcctabopt
9494 @item -mhard-float
9495 @itemx -msoft-float
9496 @opindex mhard-float
9497 @opindex msoft-float
9498 Use (do not use) the hardware floating-point instructions and registers
9499 for floating-point operations.  When @option{-msoft-float} is specified,
9500 functions in @file{libgcc.a} will be used to perform floating-point
9501 operations.  When @option{-mhard-float} is specified, the compiler
9502 generates IEEE floating-point instructions.  This is the default.
9504 @item -mbackchain
9505 @itemx -mno-backchain
9506 @opindex mbackchain
9507 @opindex mno-backchain
9508 Generate (or do not generate) code which maintains an explicit 
9509 backchain within the stack frame that points to the caller's frame.
9510 This is currently needed to allow debugging.  The default is to
9511 generate the backchain.
9513 @item -msmall-exec
9514 @itemx -mno-small-exec
9515 @opindex msmall-exec
9516 @opindex mno-small-exec
9517 Generate (or do not generate) code using the @code{bras} instruction 
9518 to do subroutine calls. 
9519 This only works reliably if the total executable size does not
9520 exceed 64k.  The default is to use the @code{basr} instruction instead,
9521 which does not have this limitation.
9523 @item -m64
9524 @itemx -m31
9525 @opindex m64
9526 @opindex m31
9527 When @option{-m31} is specified, generate code compliant to the
9528 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9529 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9530 particular to generate 64-bit instructions.  For the @samp{s390}
9531 targets, the default is @option{-m31}, while the @samp{s390x} 
9532 targets default to @option{-m64}.
9534 @item -mmvcle
9535 @itemx -mno-mvcle
9536 @opindex mmvcle
9537 @opindex mno-mvcle
9538 Generate (or do not generate) code using the @code{mvcle} instruction 
9539 to perform block moves.  When @option{-mno-mvcle} is specifed,
9540 use a @code{mvc} loop instead.  This is the default.
9542 @item -mdebug
9543 @itemx -mno-debug
9544 @opindex mdebug
9545 @opindex mno-debug
9546 Print (or do not print) additional debug information when compiling.
9547 The default is to not print debug information.
9549 @end table
9551 @node CRIS Options
9552 @subsection CRIS Options
9553 @cindex CRIS Options
9555 These options are defined specifically for the CRIS ports.
9557 @table @gcctabopt
9558 @item -march=@var{architecture-type}
9559 @itemx -mcpu=@var{architecture-type}
9560 @opindex march
9561 @opindex mcpu
9562 Generate code for the specified architecture.  The choices for
9563 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9564 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
9565 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9566 @samp{v10}.
9568 @item -mtune=@var{architecture-type}
9569 @opindex mtune
9570 Tune to @var{architecture-type} everything applicable about the generated
9571 code, except for the ABI and the set of available instructions.  The
9572 choices for @var{architecture-type} are the same as for
9573 @option{-march=@var{architecture-type}}.
9575 @item -mmax-stack-frame=@var{n}
9576 @opindex mmax-stack-frame
9577 Warn when the stack frame of a function exceeds @var{n} bytes.
9579 @item -melinux-stacksize=@var{n}
9580 @opindex melinux-stacksize
9581 Only available with the @samp{cris-axis-aout} target.  Arranges for
9582 indications in the program to the kernel loader that the stack of the
9583 program should be set to @var{n} bytes.
9585 @item -metrax4
9586 @itemx -metrax100
9587 @opindex metrax4
9588 @opindex metrax100
9589 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9590 @option{-march=v3} and @option{-march=v8} respectively.
9592 @item -mpdebug
9593 @opindex mpdebug
9594 Enable CRIS-specific verbose debug-related information in the assembly
9595 code.  This option also has the effect to turn off the @samp{#NO_APP}
9596 formatted-code indicator to the assembler at the beginning of the
9597 assembly file.
9599 @item -mcc-init
9600 @opindex mcc-init
9601 Do not use condition-code results from previous instruction; always emit
9602 compare and test instructions before use of condition codes.
9604 @item -mno-side-effects
9605 @opindex mno-side-effects
9606 Do not emit instructions with side-effects in addressing modes other than
9607 post-increment.
9609 @item -mstack-align
9610 @itemx -mno-stack-align
9611 @itemx -mdata-align
9612 @itemx -mno-data-align
9613 @itemx -mconst-align
9614 @itemx -mno-const-align
9615 @opindex mstack-align
9616 @opindex mno-stack-align
9617 @opindex mdata-align
9618 @opindex mno-data-align
9619 @opindex mconst-align
9620 @opindex mno-const-align
9621 These options (no-options) arranges (eliminate arrangements) for the
9622 stack-frame, individual data and constants to be aligned for the maximum
9623 single data access size for the chosen CPU model.  The default is to
9624 arrange for 32-bit alignment.  ABI details such as structure layout are
9625 not affected by these options.
9627 @item -m32-bit
9628 @itemx -m16-bit
9629 @itemx -m8-bit
9630 @opindex m32-bit
9631 @opindex m16-bit
9632 @opindex m8-bit
9633 Similar to the stack- data- and const-align options above, these options
9634 arrange for stack-frame, writable data and constants to all be 32-bit,
9635 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9637 @item -mno-prologue-epilogue
9638 @itemx -mprologue-epilogue
9639 @opindex mno-prologue-epilogue
9640 @opindex mprologue-epilogue
9641 With @option{-mno-prologue-epilogue}, the normal function prologue and
9642 epilogue that sets up the stack-frame are omitted and no return
9643 instructions or return sequences are generated in the code.  Use this
9644 option only together with visual inspection of the compiled code: no
9645 warnings or errors are generated when call-saved registers must be saved,
9646 or storage for local variable needs to be allocated.
9648 @item -mno-gotplt
9649 @itemx -mgotplt
9650 @opindex mno-gotplt
9651 @opindex mgotplt
9652 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9653 instruction sequences that load addresses for functions from the PLT part
9654 of the GOT rather than (traditional on other architectures) calls to the
9655 PLT.  The default is @option{-mgotplt}.
9657 @item -maout
9658 @opindex maout
9659 Legacy no-op option only recognized with the cris-axis-aout target.
9661 @item -melf
9662 @opindex melf
9663 Legacy no-op option only recognized with the cris-axis-elf and
9664 cris-axis-linux-gnu targets.
9666 @item -melinux
9667 @opindex melinux
9668 Only recognized with the cris-axis-aout target, where it selects a
9669 GNU/linux-like multilib, include files and instruction set for
9670 @option{-march=v8}.
9672 @item -mlinux
9673 @opindex mlinux
9674 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9676 @item -sim
9677 @opindex sim
9678 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9679 to link with input-output functions from a simulator library.  Code,
9680 initialized data and zero-initialized data are allocated consecutively.
9682 @item -sim2
9683 @opindex sim2
9684 Like @option{-sim}, but pass linker options to locate initialized data at
9685 0x40000000 and zero-initialized data at 0x80000000.
9686 @end table
9688 @node MMIX Options
9689 @subsection MMIX Options
9690 @cindex MMIX Options
9692 These options are defined for the MMIX:
9694 @table @code
9695 @item -mlibfuncs
9696 @itemx -mno-libfuncs
9697 Specify that intrinsic library functions are being compiled, passing all
9698 values in registers, no matter the size.
9700 @item -mepsilon
9701 @itemx -mno-epsilon
9702 Generate floating-point comparison instructions that compare with respect
9703 to the @code{rE} epsilon register.
9705 @item -mabi=mmixware
9706 @itemx -mabi=gnu
9707 Generate code that passes function parameters and return values that (in
9708 the called function) are seen as registers @code{$0} and up, as opposed to
9709 the GNU ABI which uses global registers @code{$231} and up.
9711 @item -mzero-extend
9712 @item -mno-zero-extend
9713 When reading data from memory in sizes shorter than 64 bits, use (do not
9714 use) zero-extending load instructions by default, rather than
9715 sign-extending ones.
9717 @item -mknuthdiv
9718 @itemx -mno-knuthdiv
9719 Make the result of a division yielding a remainder have the same sign as
9720 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9721 remainder follows the sign of the dividend.  Both methods are
9722 arithmetically valid, the latter being almost exclusively used.
9724 @item -mtoplevel-symbols
9725 @itemx -mno-toplevel-symbols
9726 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9727 code can be used with the @code{PREFIX} assembly directive.
9729 @item -melf
9730 Generate an executable in the ELF format, rather than the default
9731 @samp{mmo} format used by the @command{mmix} simulator.
9732 @end table
9734 @node Code Gen Options
9735 @section Options for Code Generation Conventions
9736 @cindex code generation conventions
9737 @cindex options, code generation
9738 @cindex run-time options
9740 These machine-independent options control the interface conventions
9741 used in code generation.
9743 Most of them have both positive and negative forms; the negative form
9744 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
9745 one of the forms is listed---the one which is not the default.  You
9746 can figure out the other form by either removing @samp{no-} or adding
9749 @table @gcctabopt
9750 @item -fexceptions
9751 @opindex fexceptions
9752 Enable exception handling.  Generates extra code needed to propagate
9753 exceptions.  For some targets, this implies GCC will generate frame
9754 unwind information for all functions, which can produce significant data
9755 size overhead, although it does not affect execution.  If you do not
9756 specify this option, GCC will enable it by default for languages like
9757 C++ which normally require exception handling, and disable it for
9758 languages like C that do not normally require it.  However, you may need
9759 to enable this option when compiling C code that needs to interoperate
9760 properly with exception handlers written in C++.  You may also wish to
9761 disable this option if you are compiling older C++ programs that don't
9762 use exception handling.
9764 @item -fnon-call-exceptions
9765 @opindex fnon-call-exceptions
9766 Generate code that allows trapping instructions to throw exceptions.
9767 Note that this requires platform-specific runtime support that does
9768 not exist everywhere.  Moreover, it only allows @emph{trapping}
9769 instructions to throw exceptions, i.e.@: memory references or floating
9770 point instructions.  It does not allow exceptions to be thrown from
9771 arbitrary signal handlers such as @code{SIGALRM}.
9773 @item -funwind-tables
9774 @opindex funwind-tables
9775 Similar to @option{-fexceptions}, except that it will just generate any needed
9776 static data, but will not affect the generated code in any other way.
9777 You will normally not enable this option; instead, a language processor
9778 that needs this handling would enable it on your behalf.
9780 @item -fasynchronous-unwind-tables
9781 @opindex funwind-tables
9782 Generate unwind table in dwarf2 format, if supported by target machine.  The
9783 table is exact at each instruction boundary, so it can be used for stack
9784 unwinding from asynchronous events (such as debugger or garbage collector).
9786 @item -fpcc-struct-return
9787 @opindex fpcc-struct-return
9788 Return ``short'' @code{struct} and @code{union} values in memory like
9789 longer ones, rather than in registers.  This convention is less
9790 efficient, but it has the advantage of allowing intercallability between
9791 GCC-compiled files and files compiled with other compilers.
9793 The precise convention for returning structures in memory depends
9794 on the target configuration macros.
9796 Short structures and unions are those whose size and alignment match
9797 that of some integer type.
9799 @item -freg-struct-return
9800 @opindex freg-struct-return
9801 Return @code{struct} and @code{union} values in registers when possible.
9802 This is more efficient for small structures than
9803 @option{-fpcc-struct-return}.
9805 If you specify neither @option{-fpcc-struct-return} nor
9806 @option{-freg-struct-return}, GCC defaults to whichever convention is
9807 standard for the target.  If there is no standard convention, GCC
9808 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
9809 the principal compiler.  In those cases, we can choose the standard, and
9810 we chose the more efficient register return alternative.
9812 @item -fshort-enums
9813 @opindex fshort-enums
9814 Allocate to an @code{enum} type only as many bytes as it needs for the
9815 declared range of possible values.  Specifically, the @code{enum} type
9816 will be equivalent to the smallest integer type which has enough room.
9818 @item -fshort-double
9819 @opindex fshort-double
9820 Use the same size for @code{double} as for @code{float}.
9822 @item -fshared-data
9823 @opindex fshared-data
9824 Requests that the data and non-@code{const} variables of this
9825 compilation be shared data rather than private data.  The distinction
9826 makes sense only on certain operating systems, where shared data is
9827 shared between processes running the same program, while private data
9828 exists in one copy per process.
9830 @item -fno-common
9831 @opindex fno-common
9832 In C, allocate even uninitialized global variables in the data section of the
9833 object file, rather than generating them as common blocks.  This has the
9834 effect that if the same variable is declared (without @code{extern}) in
9835 two different compilations, you will get an error when you link them.
9836 The only reason this might be useful is if you wish to verify that the
9837 program will work on other systems which always work this way.
9839 @item -fno-ident
9840 @opindex fno-ident
9841 Ignore the @samp{#ident} directive.
9843 @item -fno-gnu-linker
9844 @opindex fno-gnu-linker
9845 Do not output global initializations (such as C++ constructors and
9846 destructors) in the form used by the GNU linker (on systems where the GNU
9847 linker is the standard method of handling them).  Use this option when
9848 you want to use a non-GNU linker, which also requires using the
9849 @command{collect2} program to make sure the system linker includes
9850 constructors and destructors.  (@command{collect2} is included in the GCC
9851 distribution.)  For systems which @emph{must} use @command{collect2}, the
9852 compiler driver @command{gcc} is configured to do this automatically.
9854 @item -finhibit-size-directive
9855 @opindex finhibit-size-directive
9856 Don't output a @code{.size} assembler directive, or anything else that
9857 would cause trouble if the function is split in the middle, and the
9858 two halves are placed at locations far apart in memory.  This option is
9859 used when compiling @file{crtstuff.c}; you should not need to use it
9860 for anything else.
9862 @item -fverbose-asm
9863 @opindex fverbose-asm
9864 Put extra commentary information in the generated assembly code to
9865 make it more readable.  This option is generally only of use to those
9866 who actually need to read the generated assembly code (perhaps while
9867 debugging the compiler itself).
9869 @option{-fno-verbose-asm}, the default, causes the
9870 extra information to be omitted and is useful when comparing two assembler
9871 files.
9873 @item -fvolatile
9874 @opindex fvolatile
9875 Consider all memory references through pointers to be volatile.
9877 @item -fvolatile-global
9878 @opindex fvolatile-global
9879 Consider all memory references to extern and global data items to
9880 be volatile.  GCC does not consider static data items to be volatile
9881 because of this switch.
9883 @item -fvolatile-static
9884 @opindex fvolatile-static
9885 Consider all memory references to static data to be volatile.
9887 @item -fpic
9888 @opindex fpic
9889 @cindex global offset table
9890 @cindex PIC
9891 Generate position-independent code (PIC) suitable for use in a shared
9892 library, if supported for the target machine.  Such code accesses all
9893 constant addresses through a global offset table (GOT)@.  The dynamic
9894 loader resolves the GOT entries when the program starts (the dynamic
9895 loader is not part of GCC; it is part of the operating system).  If
9896 the GOT size for the linked executable exceeds a machine-specific
9897 maximum size, you get an error message from the linker indicating that
9898 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
9899 instead.  (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
9900 on the m68k and RS/6000.  The 386 has no such limit.)
9902 Position-independent code requires special support, and therefore works
9903 only on certain machines.  For the 386, GCC supports PIC for System V
9904 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
9905 position-independent.
9907 @item -fPIC
9908 @opindex fPIC
9909 If supported for the target machine, emit position-independent code,
9910 suitable for dynamic linking and avoiding any limit on the size of the
9911 global offset table.  This option makes a difference on the m68k, m88k,
9912 and the Sparc.
9914 Position-independent code requires special support, and therefore works
9915 only on certain machines.
9917 @item -ffixed-@var{reg}
9918 @opindex ffixed
9919 Treat the register named @var{reg} as a fixed register; generated code
9920 should never refer to it (except perhaps as a stack pointer, frame
9921 pointer or in some other fixed role).
9923 @var{reg} must be the name of a register.  The register names accepted
9924 are machine-specific and are defined in the @code{REGISTER_NAMES}
9925 macro in the machine description macro file.
9927 This flag does not have a negative form, because it specifies a
9928 three-way choice.
9930 @item -fcall-used-@var{reg}
9931 @opindex fcall-used
9932 Treat the register named @var{reg} as an allocable register that is
9933 clobbered by function calls.  It may be allocated for temporaries or
9934 variables that do not live across a call.  Functions compiled this way
9935 will not save and restore the register @var{reg}.
9937 It is an error to used this flag with the frame pointer or stack pointer.
9938 Use of this flag for other registers that have fixed pervasive roles in
9939 the machine's execution model will produce disastrous results.
9941 This flag does not have a negative form, because it specifies a
9942 three-way choice.
9944 @item -fcall-saved-@var{reg}
9945 @opindex fcall-saved
9946 Treat the register named @var{reg} as an allocable register saved by
9947 functions.  It may be allocated even for temporaries or variables that
9948 live across a call.  Functions compiled this way will save and restore
9949 the register @var{reg} if they use it.
9951 It is an error to used this flag with the frame pointer or stack pointer.
9952 Use of this flag for other registers that have fixed pervasive roles in
9953 the machine's execution model will produce disastrous results.
9955 A different sort of disaster will result from the use of this flag for
9956 a register in which function values may be returned.
9958 This flag does not have a negative form, because it specifies a
9959 three-way choice.
9961 @item -fpack-struct
9962 @opindex fpack-struct
9963 Pack all structure members together without holes.  Usually you would
9964 not want to use this option, since it makes the code suboptimal, and
9965 the offsets of structure members won't agree with system libraries.
9967 @item -fcheck-memory-usage
9968 @opindex fcheck-memory-usage
9969 Generate extra code to check each memory access.  GCC will generate
9970 code that is suitable for a detector of bad memory accesses such as
9971 @file{Checker}.
9973 Normally, you should compile all, or none, of your code with this option.
9975 If you do mix code compiled with and without this option,
9976 you must ensure that all code that has side effects
9977 and that is called by code compiled with this option
9978 is, itself, compiled with this option.
9979 If you do not, you might get erroneous messages from the detector.
9981 If you use functions from a library that have side-effects (such as
9982 @code{read}), you might not be able to recompile the library and
9983 specify this option.  In that case, you can enable the
9984 @option{-fprefix-function-name} option, which requests GCC to encapsulate
9985 your code and make other functions look as if they were compiled with
9986 @option{-fcheck-memory-usage}.  This is done by calling ``stubs'',
9987 which are provided by the detector.  If you cannot find or build
9988 stubs for every function you call, you might have to specify
9989 @option{-fcheck-memory-usage} without @option{-fprefix-function-name}.
9991 If you specify this option, you can not use the @code{asm} or
9992 @code{__asm__} keywords in functions with memory checking enabled.  GCC
9993 cannot understand what the @code{asm} statement may do, and therefore
9994 cannot generate the appropriate code, so it will reject it.  However, if
9995 you specify the function attribute @code{no_check_memory_usage}
9996 (@pxref{Function Attributes}), GCC will disable memory checking within a
9997 function; you may use @code{asm} statements inside such functions.  You
9998 may have an inline expansion of a non-checked function within a checked
9999 function; in that case GCC will not generate checks for the inlined
10000 function's memory accesses.
10002 If you move your @code{asm} statements to non-checked inline functions
10003 and they do access memory, you can add calls to the support code in your
10004 inline function, to indicate any reads, writes, or copies being done.
10005 These calls would be similar to those done in the stubs described above.
10007 @item -fprefix-function-name
10008 @opindex fprefix-function-name
10009 Request GCC to add a prefix to the symbols generated for function names.
10010 GCC adds a prefix to the names of functions defined as well as
10011 functions called.  Code compiled with this option and code compiled
10012 without the option can't be linked together, unless stubs are used.
10014 If you compile the following code with @option{-fprefix-function-name}
10015 @example
10016 extern void bar (int);
10017 void
10018 foo (int a)
10020   return bar (a + 5);
10022 @end example
10024 @noindent
10025 GCC will compile the code as if it was written:
10026 @example
10027 extern void prefix_bar (int);
10028 void
10029 prefix_foo (int a)
10031   return prefix_bar (a + 5);
10033 @end example
10034 This option is designed to be used with @option{-fcheck-memory-usage}.
10036 @item -finstrument-functions
10037 @opindex finstrument-functions
10038 Generate instrumentation calls for entry and exit to functions.  Just
10039 after function entry and just before function exit, the following
10040 profiling functions will be called with the address of the current
10041 function and its call site.  (On some platforms,
10042 @code{__builtin_return_address} does not work beyond the current
10043 function, so the call site information may not be available to the
10044 profiling functions otherwise.)
10046 @example
10047 void __cyg_profile_func_enter (void *this_fn,
10048                                void *call_site);
10049 void __cyg_profile_func_exit  (void *this_fn,
10050                                void *call_site);
10051 @end example
10053 The first argument is the address of the start of the current function,
10054 which may be looked up exactly in the symbol table.
10056 This instrumentation is also done for functions expanded inline in other
10057 functions.  The profiling calls will indicate where, conceptually, the
10058 inline function is entered and exited.  This means that addressable
10059 versions of such functions must be available.  If all your uses of a
10060 function are expanded inline, this may mean an additional expansion of
10061 code size.  If you use @samp{extern inline} in your C code, an
10062 addressable version of such functions must be provided.  (This is
10063 normally the case anyways, but if you get lucky and the optimizer always
10064 expands the functions inline, you might have gotten away without
10065 providing static copies.)
10067 A function may be given the attribute @code{no_instrument_function}, in
10068 which case this instrumentation will not be done.  This can be used, for
10069 example, for the profiling functions listed above, high-priority
10070 interrupt routines, and any functions from which the profiling functions
10071 cannot safely be called (perhaps signal handlers, if the profiling
10072 routines generate output or allocate memory).
10074 @item -fstack-check
10075 @opindex fstack-check
10076 Generate code to verify that you do not go beyond the boundary of the
10077 stack.  You should specify this flag if you are running in an
10078 environment with multiple threads, but only rarely need to specify it in
10079 a single-threaded environment since stack overflow is automatically
10080 detected on nearly all systems if there is only one stack.
10082 Note that this switch does not actually cause checking to be done; the
10083 operating system must do that.  The switch causes generation of code
10084 to ensure that the operating system sees the stack being extended.
10086 @item -fstack-limit-register=@var{reg}
10087 @itemx -fstack-limit-symbol=@var{sym}
10088 @itemx -fno-stack-limit
10089 @opindex fstack-limit-register
10090 @opindex fstack-limit-symbol
10091 @opindex fno-stack-limit
10092 Generate code to ensure that the stack does not grow beyond a certain value,
10093 either the value of a register or the address of a symbol.  If the stack
10094 would grow beyond the value, a signal is raised.  For most targets,
10095 the signal is raised before the stack overruns the boundary, so
10096 it is possible to catch the signal without taking special precautions.
10098 For instance, if the stack starts at absolute address @samp{0x80000000}
10099 and grows downwards, you can use the flags
10100 @option{-fstack-limit-symbol=__stack_limit} and
10101 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
10102 of 128KB@.  Note that this may only work with the GNU linker.
10104 @cindex aliasing of parameters
10105 @cindex parameters, aliased
10106 @item -fargument-alias
10107 @itemx -fargument-noalias
10108 @itemx -fargument-noalias-global
10109 @opindex fargument-alias
10110 @opindex fargument-noalias
10111 @opindex fargument-noalias-global
10112 Specify the possible relationships among parameters and between
10113 parameters and global data.
10115 @option{-fargument-alias} specifies that arguments (parameters) may
10116 alias each other and may alias global storage.@*
10117 @option{-fargument-noalias} specifies that arguments do not alias
10118 each other, but may alias global storage.@*
10119 @option{-fargument-noalias-global} specifies that arguments do not
10120 alias each other and do not alias global storage.
10122 Each language will automatically use whatever option is required by
10123 the language standard.  You should not need to use these options yourself.
10125 @item -fleading-underscore
10126 @opindex fleading-underscore
10127 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
10128 change the way C symbols are represented in the object file.  One use
10129 is to help link with legacy assembly code.
10131 Be warned that you should know what you are doing when invoking this
10132 option, and that not all targets provide complete support for it.
10133 @end table
10135 @c man end
10137 @node Environment Variables
10138 @section Environment Variables Affecting GCC
10139 @cindex environment variables
10141 @c man begin ENVIRONMENT
10143 This section describes several environment variables that affect how GCC
10144 operates.  Some of them work by specifying directories or prefixes to use
10145 when searching for various kinds of files.  Some are used to specify other
10146 aspects of the compilation environment.
10148 @ifclear INTERNALS
10149 Note that you can also specify places to search using options such as
10150 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
10151 take precedence over places specified using environment variables, which
10152 in turn take precedence over those specified by the configuration of GCC@.
10154 @end ifclear
10155 @ifset INTERNALS
10156 Note that you can also specify places to search using options such as
10157 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
10158 take precedence over places specified using environment variables, which
10159 in turn take precedence over those specified by the configuration of GCC@.
10160 @xref{Driver}.
10161 @end ifset
10163 @table @env
10164 @item LANG
10165 @itemx LC_CTYPE
10166 @c @itemx LC_COLLATE
10167 @itemx LC_MESSAGES
10168 @c @itemx LC_MONETARY
10169 @c @itemx LC_NUMERIC
10170 @c @itemx LC_TIME
10171 @itemx LC_ALL
10172 @findex LANG
10173 @findex LC_CTYPE
10174 @c @findex LC_COLLATE
10175 @findex LC_MESSAGES
10176 @c @findex LC_MONETARY
10177 @c @findex LC_NUMERIC
10178 @c @findex LC_TIME
10179 @findex LC_ALL
10180 @cindex locale
10181 These environment variables control the way that GCC uses
10182 localization information that allow GCC to work with different
10183 national conventions.  GCC inspects the locale categories
10184 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
10185 so.  These locale categories can be set to any value supported by your
10186 installation.  A typical value is @samp{en_UK} for English in the United
10187 Kingdom.
10189 The @env{LC_CTYPE} environment variable specifies character
10190 classification.  GCC uses it to determine the character boundaries in
10191 a string; this is needed for some multibyte encodings that contain quote
10192 and escape characters that would otherwise be interpreted as a string
10193 end or escape.
10195 The @env{LC_MESSAGES} environment variable specifies the language to
10196 use in diagnostic messages.
10198 If the @env{LC_ALL} environment variable is set, it overrides the value
10199 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
10200 and @env{LC_MESSAGES} default to the value of the @env{LANG}
10201 environment variable.  If none of these variables are set, GCC
10202 defaults to traditional C English behavior.
10204 @item TMPDIR
10205 @findex TMPDIR
10206 If @env{TMPDIR} is set, it specifies the directory to use for temporary
10207 files.  GCC uses temporary files to hold the output of one stage of
10208 compilation which is to be used as input to the next stage: for example,
10209 the output of the preprocessor, which is the input to the compiler
10210 proper.
10212 @item GCC_EXEC_PREFIX
10213 @findex GCC_EXEC_PREFIX
10214 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
10215 names of the subprograms executed by the compiler.  No slash is added
10216 when this prefix is combined with the name of a subprogram, but you can
10217 specify a prefix that ends with a slash if you wish.
10219 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
10220 an appropriate prefix to use based on the pathname it was invoked with.
10222 If GCC cannot find the subprogram using the specified prefix, it
10223 tries looking in the usual places for the subprogram.
10225 The default value of @env{GCC_EXEC_PREFIX} is
10226 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
10227 of @code{prefix} when you ran the @file{configure} script.
10229 Other prefixes specified with @option{-B} take precedence over this prefix.
10231 This prefix is also used for finding files such as @file{crt0.o} that are
10232 used for linking.
10234 In addition, the prefix is used in an unusual way in finding the
10235 directories to search for header files.  For each of the standard
10236 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
10237 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
10238 replacing that beginning with the specified prefix to produce an
10239 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
10240 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
10241 These alternate directories are searched first; the standard directories
10242 come next.
10244 @item COMPILER_PATH
10245 @findex COMPILER_PATH
10246 The value of @env{COMPILER_PATH} is a colon-separated list of
10247 directories, much like @env{PATH}.  GCC tries the directories thus
10248 specified when searching for subprograms, if it can't find the
10249 subprograms using @env{GCC_EXEC_PREFIX}.
10251 @item LIBRARY_PATH
10252 @findex LIBRARY_PATH
10253 The value of @env{LIBRARY_PATH} is a colon-separated list of
10254 directories, much like @env{PATH}.  When configured as a native compiler,
10255 GCC tries the directories thus specified when searching for special
10256 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
10257 using GCC also uses these directories when searching for ordinary
10258 libraries for the @option{-l} option (but directories specified with
10259 @option{-L} come first).
10261 @item C_INCLUDE_PATH
10262 @itemx CPLUS_INCLUDE_PATH
10263 @itemx OBJC_INCLUDE_PATH
10264 @findex C_INCLUDE_PATH
10265 @findex CPLUS_INCLUDE_PATH
10266 @findex OBJC_INCLUDE_PATH
10267 @c @itemx OBJCPLUS_INCLUDE_PATH
10268 These environment variables pertain to particular languages.  Each
10269 variable's value is a colon-separated list of directories, much like
10270 @env{PATH}.  When GCC searches for header files, it tries the
10271 directories listed in the variable for the language you are using, after
10272 the directories specified with @option{-I} but before the standard header
10273 file directories.
10275 @item DEPENDENCIES_OUTPUT
10276 @findex DEPENDENCIES_OUTPUT
10277 @cindex dependencies for make as output
10278 If this variable is set, its value specifies how to output dependencies
10279 for Make based on the header files processed by the compiler.  This
10280 output looks much like the output from the @option{-M} option
10281 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
10282 in addition to the usual results of compilation.
10284 The value of @env{DEPENDENCIES_OUTPUT} can be just a file name, in
10285 which case the Make rules are written to that file, guessing the target
10286 name from the source file name.  Or the value can have the form
10287 @samp{@var{file} @var{target}}, in which case the rules are written to
10288 file @var{file} using @var{target} as the target name.
10290 @item LANG
10291 @findex LANG
10292 @cindex locale definition
10293 This variable is used to pass locale information to the compiler.  One way in
10294 which this information is used is to determine the character set to be used
10295 when character literals, string literals and comments are parsed in C and C++.
10296 When the compiler is configured to allow multibyte characters,
10297 the following values for @env{LANG} are recognized:
10299 @table @samp
10300 @item C-JIS
10301 Recognize JIS characters.
10302 @item C-SJIS
10303 Recognize SJIS characters.
10304 @item C-EUCJP
10305 Recognize EUCJP characters.
10306 @end table
10308 If @env{LANG} is not defined, or if it has some other value, then the
10309 compiler will use mblen and mbtowc as defined by the default locale to
10310 recognize and translate multibyte characters.
10311 @end table
10313 @c man end
10315 @node Running Protoize
10316 @section Running Protoize
10318 The program @code{protoize} is an optional part of GCC@.  You can use
10319 it to add prototypes to a program, thus converting the program to ISO
10320 C in one respect.  The companion program @code{unprotoize} does the
10321 reverse: it removes argument types from any prototypes that are found.
10323 When you run these programs, you must specify a set of source files as
10324 command line arguments.  The conversion programs start out by compiling
10325 these files to see what functions they define.  The information gathered
10326 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
10328 After scanning comes actual conversion.  The specified files are all
10329 eligible to be converted; any files they include (whether sources or
10330 just headers) are eligible as well.
10332 But not all the eligible files are converted.  By default,
10333 @code{protoize} and @code{unprotoize} convert only source and header
10334 files in the current directory.  You can specify additional directories
10335 whose files should be converted with the @option{-d @var{directory}}
10336 option.  You can also specify particular files to exclude with the
10337 @option{-x @var{file}} option.  A file is converted if it is eligible, its
10338 directory name matches one of the specified directory names, and its
10339 name within the directory has not been excluded.
10341 Basic conversion with @code{protoize} consists of rewriting most
10342 function definitions and function declarations to specify the types of
10343 the arguments.  The only ones not rewritten are those for varargs
10344 functions.
10346 @code{protoize} optionally inserts prototype declarations at the
10347 beginning of the source file, to make them available for any calls that
10348 precede the function's definition.  Or it can insert prototype
10349 declarations with block scope in the blocks where undeclared functions
10350 are called.
10352 Basic conversion with @code{unprotoize} consists of rewriting most
10353 function declarations to remove any argument types, and rewriting
10354 function definitions to the old-style pre-ISO form.
10356 Both conversion programs print a warning for any function declaration or
10357 definition that they can't convert.  You can suppress these warnings
10358 with @option{-q}.
10360 The output from @code{protoize} or @code{unprotoize} replaces the
10361 original source file.  The original file is renamed to a name ending
10362 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
10363 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
10364 for DOS) file already exists, then the source file is simply discarded.
10366 @code{protoize} and @code{unprotoize} both depend on GCC itself to
10367 scan the program and collect information about the functions it uses.
10368 So neither of these programs will work until GCC is installed.
10370 Here is a table of the options you can use with @code{protoize} and
10371 @code{unprotoize}.  Each option works with both programs unless
10372 otherwise stated.
10374 @table @code
10375 @item -B @var{directory}
10376 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
10377 usual directory (normally @file{/usr/local/lib}).  This file contains
10378 prototype information about standard system functions.  This option
10379 applies only to @code{protoize}.
10381 @item -c @var{compilation-options}
10382 Use  @var{compilation-options} as the options when running @code{gcc} to
10383 produce the @samp{.X} files.  The special option @option{-aux-info} is
10384 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
10386 Note that the compilation options must be given as a single argument to
10387 @code{protoize} or @code{unprotoize}.  If you want to specify several
10388 @code{gcc} options, you must quote the entire set of compilation options
10389 to make them a single word in the shell.
10391 There are certain @code{gcc} arguments that you cannot use, because they
10392 would produce the wrong kind of output.  These include @option{-g},
10393 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
10394 the @var{compilation-options}, they are ignored.
10396 @item -C
10397 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
10398 systems) instead of @samp{.c}.  This is convenient if you are converting
10399 a C program to C++.  This option applies only to @code{protoize}.
10401 @item -g
10402 Add explicit global declarations.  This means inserting explicit
10403 declarations at the beginning of each source file for each function
10404 that is called in the file and was not declared.  These declarations
10405 precede the first function definition that contains a call to an
10406 undeclared function.  This option applies only to @code{protoize}.
10408 @item -i @var{string}
10409 Indent old-style parameter declarations with the string @var{string}.
10410 This option applies only to @code{protoize}.
10412 @code{unprotoize} converts prototyped function definitions to old-style
10413 function definitions, where the arguments are declared between the
10414 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
10415 uses five spaces as the indentation.  If you want to indent with just
10416 one space instead, use @option{-i " "}.
10418 @item -k
10419 Keep the @samp{.X} files.  Normally, they are deleted after conversion
10420 is finished.
10422 @item -l
10423 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
10424 a prototype declaration for each function in each block which calls the
10425 function without any declaration.  This option applies only to
10426 @code{protoize}.
10428 @item -n
10429 Make no real changes.  This mode just prints information about the conversions
10430 that would have been done without @option{-n}.
10432 @item -N
10433 Make no @samp{.save} files.  The original files are simply deleted.
10434 Use this option with caution.
10436 @item -p @var{program}
10437 Use the program @var{program} as the compiler.  Normally, the name
10438 @file{gcc} is used.
10440 @item -q
10441 Work quietly.  Most warnings are suppressed.
10443 @item -v
10444 Print the version number, just like @option{-v} for @code{gcc}.
10445 @end table
10447 If you need special compiler options to compile one of your program's
10448 source files, then you should generate that file's @samp{.X} file
10449 specially, by running @code{gcc} on that source file with the
10450 appropriate options and the option @option{-aux-info}.  Then run
10451 @code{protoize} on the entire set of files.  @code{protoize} will use
10452 the existing @samp{.X} file because it is newer than the source file.
10453 For example:
10455 @example
10456 gcc -Dfoo=bar file1.c -aux-info file1.X
10457 protoize *.c
10458 @end example
10460 @noindent
10461 You need to include the special files along with the rest in the
10462 @code{protoize} command, even though their @samp{.X} files already
10463 exist, because otherwise they won't get converted.
10465 @xref{Protoize Caveats}, for more information on how to use
10466 @code{protoize} successfully.