* extend.texi, invoke.texi: Move documentation of builtin versions
[official-gcc.git] / gcc / invoke.texi
blob209cdea8a0a047d533877459588b135c3e76b43f
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @node Invoking GCC
6 @chapter GCC Command Options
7 @cindex GCC command options
8 @cindex command options
9 @cindex options, GCC command
11 When you invoke GCC, it normally does preprocessing, compilation,
12 assembly and linking.  The ``overall options'' allow you to stop this
13 process at an intermediate stage.  For example, the @samp{-c} option
14 says not to run the linker.  Then the output consists of object files
15 output by the assembler.
17 Other options are passed on to one stage of processing.  Some options
18 control the preprocessor and others the compiler itself.  Yet other
19 options control the assembler and linker; most of these are not
20 documented here, since you rarely need to use any of them.
22 @cindex C compilation options
23 Most of the command line options that you can use with GCC are useful
24 for C programs; when an option is only useful with another language
25 (usually C++), the explanation says so explicitly.  If the description
26 for a particular option does not mention a source language, you can use
27 that option with all supported languages.
29 @cindex C++ compilation options
30 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
31 options for compiling C++ programs.
33 @cindex grouping options
34 @cindex options, grouping
35 The @code{gcc} program accepts options and file names as operands.  Many
36 options have multi-letter names; therefore multiple single-letter options
37 may @emph{not} be grouped: @samp{-dr} is very different from @w{@samp{-d
38 -r}}.
40 @cindex order of options
41 @cindex options, order
42 You can mix options and other arguments.  For the most part, the order
43 you use doesn't matter.  Order does matter when you use several options
44 of the same kind; for example, if you specify @samp{-L} more than once,
45 the directories are searched in the order specified.
47 Many options have long names starting with @samp{-f} or with
48 @samp{-W}---for example, @samp{-fforce-mem},
49 @samp{-fstrength-reduce}, @samp{-Wformat} and so on.  Most of
50 these have both positive and negative forms; the negative form of
51 @samp{-ffoo} would be @samp{-fno-foo}.  This manual documents
52 only one of these two forms, whichever one is not the default.
54 @menu
55 * Option Summary::      Brief list of all options, without explanations.
56 * Overall Options::     Controlling the kind of output:
57                         an executable, object files, assembler files,
58                         or preprocessed source.
59 * Invoking G++::        Compiling C++ programs.
60 * C Dialect Options::   Controlling the variant of C language compiled.
61 * C++ Dialect Options:: Variations on C++.
62 * Language Independent Options:: Controlling how diagnostics should be
63                         formatted. 
64 * Warning Options::     How picky should the compiler be?
65 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
66 * Optimize Options::    How much optimization?
67 * Preprocessor Options:: Controlling header files and macro definitions.
68                          Also, getting dependency information for Make.
69 * Assembler Options::   Passing options to the assembler.
70 * Link Options::        Specifying libraries and so on.
71 * Directory Options::   Where to find header files and libraries.
72                         Where to find the compiler executable files.
73 * Spec Files::          How to pass switches to sub-processes.
74 * Target Options::      Running a cross-compiler, or an old version of GCC.
75 * Submodel Options::    Specifying minor hardware or convention variations,
76                         such as 68010 vs 68020.
77 * Code Gen Options::    Specifying conventions for function calls, data layout
78                         and register usage.
79 * Environment Variables:: Env vars that affect GCC.
80 * Running Protoize::    Automatically adding or removing function prototypes.
81 @end menu
83 @node Option Summary
84 @section Option Summary
86 Here is a summary of all the options, grouped by type.  Explanations are
87 in the following sections.
89 @table @emph
90 @item Overall Options
91 @xref{Overall Options,,Options Controlling the Kind of Output}.
92 @smallexample
93 -c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  -v  --target-help  --help  -x @var{language}
94 @end smallexample
96 @item C Language Options
97 @xref{C Dialect Options,,Options Controlling C Dialect}.
98 @smallexample
99 -ansi -std  -fallow-single-precision  -fcond-mismatch  -fno-asm
100 -fno-builtin  -ffreestanding  -fhosted  -fsigned-bitfields  -fsigned-char
101 -funsigned-bitfields  -funsigned-char  -fwritable-strings
102 -traditional  -traditional-cpp  -trigraphs -fsingle-precision-constant
103 @end smallexample
105 @item C++ Language Options
106 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
107 @smallexample
108 -fno-access-control -fcheck-new -fconserve-space
109 -fdollars-in-identifiers -fno-elide-constructors -fexternal-templates
110 -ffor-scope -fno-for-scope -fno-gnu-keywords -fhonor-std
111 -fhuge-objects -fno-implicit-templates -finit-priority
112 -fno-implement-inlines -fname-mangling-version-@var{n}
113 -fno-default-inline -fno-operator-names -fno-optional-diags -fpermissive
114 -frepo -fsquangle -ftemplate-depth-@var{n}
115 -fuse-cxa-atexit -fvtable-thunks -nostdinc++ -Wctor-dtor-privacy
116 -Wno-deprecated -Weffc++ -Wno-non-template-friend -Wnon-virtual-dtor
117 -Wold-style-cast -Woverloaded-virtual -Wno-pmf-conversions -Wreorder
118 -Wsign-promo -Wsynth
119 @end smallexample
121 @item Language Independent Options
122 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
123 @smallexample
124 -fmessage-length=@var{n} 
125 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}
126 @end smallexample
128 @item Warning Options
129 @xref{Warning Options,,Options to Request or Suppress Warnings}.
130 @smallexample
131 -fsyntax-only  -pedantic  -pedantic-errors
132 -w  -W  -Wall  -Waggregate-return 
133 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment
134 -Wconversion  -Wdisabled-optimization -Werror  -Wformat
135 -Wid-clash-@var{len}  -Wimplicit -Wimplicit-int 
136 -Wimplicit-function-declaration  -Wimport
137 -Werror-implicit-function-declaration  -Wfloat-equal -Winline
138 -Wlarger-than-@var{len}  -Wlong-long
139 -Wmain  -Wmissing-declarations  -Wmissing-noreturn
140 -Wmultichar  -Wno-import  -Wpacked  -Wpadded
141 -Wparentheses -Wpointer-arith  -Wredundant-decls
142 -Wreturn-type -Wshadow  -Wsign-compare -Wswitch -Wsystem-headers
143 -Wtrigraphs -Wundef  -Wuninitialized  -Wunknown-pragmas -Wunreachable-code 
144 -Wunused -Wunused-function -Wunused-label -Wunused-parameter
145 -Wunused-variable -Wunused-value -Wwrite-strings
146 @end smallexample
148 @item C-only Warning Options
149 @smallexample
150 -Wbad-function-cast -Wmissing-prototypes -Wnested-externs
151 -Wstrict-prototypes -Wtraditional
152 @end smallexample
154 @item Debugging Options
155 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
156 @smallexample
157 -a  -ax  -d@var{letters}  -fdump-unnumbered -fdump-translation-unit-@var{file}
158 -fpretend-float -fprofile-arcs  -ftest-coverage
159 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2
160 -ggdb  -gstabs  -gstabs+  -gxcoff  -gxcoff+
161 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name
162 -print-prog-name=@var{program}  -print-search-dirs  -save-temps  -time
163 @end smallexample
165 @item Optimization Options
166 @xref{Optimize Options,,Options that Control Optimization}.
167 @smallexample
168 -falign-functions=@var{n}  -falign-labels=@var{n}  -falign-loops=@var{n} 
169 -falign-jumps=@var{n}  -fbranch-probabilities  
170 -fcaller-saves  -fcse-follow-jumps  -fcse-skip-blocks
171 -fdce -fdelayed-branch  -fdelete-null-pointer-checks -fexpensive-optimizations
172 -ffast-math  -ffloat-store  -fforce-addr  -fforce-mem -fno-math-errno
173 -fdata-sections  -ffunction-sections  -fgcse 
174 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions
175 -fmove-all-movables  -fno-default-inline  -fno-defer-pop
176 -fno-function-cse  -fno-inline  -fno-peephole -ftrapv
177 -fomit-frame-pointer  -foptimize-register-moves -foptimize-sibling-calls
178 -fregmove  -frename-registers  -frerun-cse-after-loop  -frerun-loop-opt
179 -freduce-all-givs  -fschedule-insns  -fschedule-insns2  -fssa
180 -fstrength-reduce  -fstrict-aliasing  -fthread-jumps  -funroll-all-loops
181 -funroll-loops 
182 -O  -O0  -O1  -O2  -O3 -Os
183 @end smallexample
185 @item Preprocessor Options
186 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
187 @smallexample
188 -A@var{question}(@var{answer})  -C  -dD  -dM  -dN
189 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H
190 -idirafter @var{dir}
191 -include @var{file}  -imacros @var{file}
192 -iprefix @var{file}  -iwithprefix @var{dir}
193 -iwithprefixbefore @var{dir}  -isystem @var{dir} -isystem-c++ @var{dir}
194 -M  -MD  -MM  -MMD  -MG  -nostdinc  -P  -trigraphs
195 -undef  -U@var{macro}  -Wp,@var{option}
196 @end smallexample
198 @item Assembler Option
199 @xref{Assembler Options,,Passing Options to the Assembler}.
200 @smallexample
201 -Wa,@var{option}
202 @end smallexample
204 @item Linker Options
205 @xref{Link Options,,Options for Linking}.
206 @smallexample
207 @var{object-file-name}  -l@var{library}
208 -nostartfiles  -nodefaultlibs  -nostdlib
209 -s  -static  -shared  -symbolic
210 -Wl,@var{option}  -Xlinker @var{option}
211 -u @var{symbol}
212 @end smallexample
214 @item Directory Options
215 @xref{Directory Options,,Options for Directory Search}.
216 @smallexample
217 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}
218 @end smallexample
220 @item Target Options
221 @c I wrote this xref this way to avoid overfull hbox. -- rms
222 @xref{Target Options}.
223 @smallexample
224 -b @var{machine}  -V @var{version}
225 @end smallexample
227 @item Machine Dependent Options
228 @xref{Submodel Options,,Hardware Models and Configurations}.
229 @smallexample
230 @emph{M680x0 Options}
231 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040
232 -m68060  -mcpu32 -m5200  -m68881  -mbitfield  -mc68000  -mc68020  
233 -mfpa -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel
234 -malign-int -mstrict-align
236 @emph{M68hc1x Options}
237 -m6811  -m6812  -m68hc11  -m68hc12
238 -mauto-incdec  -mshort  -msoft-reg-count=@var{count}
240 @emph{VAX Options}
241 -mg  -mgnu  -munix
243 @emph{SPARC Options}
244 -mcpu=@var{cpu type}
245 -mtune=@var{cpu type}
246 -mcmodel=@var{code model}
247 -m32  -m64
248 -mapp-regs  -mbroken-saverestore  -mcypress
249 -mepilogue -mfaster-structs -mflat
250 -mfpu  -mhard-float  -mhard-quad-float
251 -mimpure-text  -mlive-g0  -mno-app-regs
252 -mno-epilogue -mno-faster-structs -mno-flat  -mno-fpu
253 -mno-impure-text -mno-stack-bias  -mno-unaligned-doubles
254 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias
255 -msupersparc  -munaligned-doubles  -mv8
257 @emph{Convex Options}
258 -mc1  -mc2  -mc32  -mc34  -mc38
259 -margcount  -mnoargcount
260 -mlong32  -mlong64
261 -mvolatile-cache  -mvolatile-nocache
263 @emph{AMD29K Options}
264 -m29000  -m29050  -mbw  -mnbw  -mdw  -mndw
265 -mlarge  -mnormal  -msmall
266 -mkernel-registers  -mno-reuse-arg-regs
267 -mno-stack-check  -mno-storem-bug
268 -mreuse-arg-regs  -msoft-float  -mstack-check
269 -mstorem-bug  -muser-registers
271 @emph{ARM Options}
272 -mapcs-frame -mno-apcs-frame
273 -mapcs-26 -mapcs-32
274 -mapcs-stack-check -mno-apcs-stack-check
275 -mapcs-float -mno-apcs-float
276 -mapcs-reentrant -mno-apcs-reentrant
277 -msched-prolog -mno-sched-prolog
278 -mlittle-endian -mbig-endian -mwords-little-endian
279 -malignment-traps -mno-alignment-traps
280 -msoft-float -mhard-float -mfpe
281 -mthumb-interwork -mno-thumb-interwork
282 -mcpu= -march= -mfpe= 
283 -mstructure-size-boundary=
284 -mbsd -mxopen -mno-symrename
285 -mabort-on-noreturn
286 -mlong-calls -mno-long-calls
287 -mnop-fun-dllimport -mno-nop-fun-dllimport
288 -msingle-pic-base -mno-single-pic-base
289 -mpic-register=
291 @emph{Thumb Options}
292 -mtpcs-frame -mno-tpcs-frame
293 -mtpcs-leaf-frame -mno-tpcs-leaf-frame
294 -mlittle-endian  -mbig-endian
295 -mthumb-interwork -mno-thumb-interwork
296 -mstructure-size-boundary=
297 -mnop-fun-dllimport -mno-nop-fun-dllimport
298 -mcallee-super-interworking -mno-callee-super-interworking
299 -mcaller-super-interworking -mno-caller-super-interworking
300 -msingle-pic-base -mno-single-pic-base
301 -mpic-register=
303 @emph{MN10200 Options}
304 -mrelax
306 @emph{MN10300 Options}
307 -mmult-bug
308 -mno-mult-bug
309 -mam33
310 -mno-am33
311 -mrelax
313 @emph{M32R/D Options}
314 -mcode-model=@var{model type}  -msdata=@var{sdata type}
315 -G @var{num}
317 @emph{M88K Options}
318 -m88000  -m88100  -m88110  -mbig-pic
319 -mcheck-zero-division  -mhandle-large-shift
320 -midentify-revision  -mno-check-zero-division
321 -mno-ocs-debug-info  -mno-ocs-frame-position
322 -mno-optimize-arg-area  -mno-serialize-volatile
323 -mno-underscores  -mocs-debug-info
324 -mocs-frame-position  -moptimize-arg-area
325 -mserialize-volatile  -mshort-data-@var{num}  -msvr3
326 -msvr4  -mtrap-large-shift  -muse-div-instruction
327 -mversion-03.00  -mwarn-passed-structs
329 @emph{RS/6000 and PowerPC Options}
330 -mcpu=@var{cpu type}
331 -mtune=@var{cpu type}
332 -mpower  -mno-power  -mpower2  -mno-power2
333 -mpowerpc  -mpowerpc64  -mno-powerpc
334 -mpowerpc-gpopt  -mno-powerpc-gpopt
335 -mpowerpc-gfxopt  -mno-powerpc-gfxopt
336 -mnew-mnemonics  -mold-mnemonics
337 -mfull-toc   -mminimal-toc  -mno-fop-in-toc  -mno-sum-in-toc
338 -m64  -m32  -mxl-call  -mno-xl-call  -mthreads  -mpe
339 -msoft-float  -mhard-float  -mmultiple  -mno-multiple
340 -mstring  -mno-string  -mupdate  -mno-update
341 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align
342 -mstrict-align  -mno-strict-align  -mrelocatable
343 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib
344 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian
345 -mcall-aix  -mcall-sysv  -mprototype  -mno-prototype
346 -msim  -mmvme  -mads  -myellowknife  -memb -msdata
347 -msdata=@var{opt}  -mvxworks -G @var{num}
349 @emph{RT Options}
350 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs
351 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul
352 -mminimum-fp-blocks  -mnohc-struct-return
354 @emph{MIPS Options}
355 -mabicalls  -mcpu=@var{cpu type}  -membedded-data -muninit-const-in-rodata
356 -membedded-pic  -mfp32  -mfp64  -mgas  -mgp32  -mgp64
357 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1
358 -mips2  -mips3 -mips4 -mlong64  -mlong32 -mlong-calls  -mmemcpy
359 -mmips-as  -mmips-tfile  -mno-abicalls
360 -mno-embedded-data  -mno-uninit-const-in-rodata  -mno-embedded-pic
361 -mno-gpopt  -mno-long-calls
362 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats
363 -mrnames  -msoft-float
364 -m4650  -msingle-float  -mmad
365 -mstats  -EL  -EB  -G @var{num}  -nocpp
366 -mabi=32 -mabi=n32 -mabi=64 -mabi=eabi
367 -mfix7000 -mno-crt0
369 @emph{i386 Options}
370 -mcpu=@var{cpu type} -march=@var{cpu type}
371 -mintel-syntax -mieee-fp  -mno-fancy-math-387
372 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib
373 -mno-wide-multiply  -mrtd  -malign-double
374 -mreg-alloc=@var{list}  -mregparm=@var{num}
375 -malign-jumps=@var{num}  -malign-loops=@var{num}
376 -malign-functions=@var{num} -mpreferred-stack-boundary=@var{num}
377 -mthreads -mno-align-stringops -minline-all-stringops
378 -mpush-args -maccumulate-outgoing-args
380 @emph{HPPA Options}
381 -march=@var{architecture type}
382 -mbig-switch  -mdisable-fpregs  -mdisable-indexing  
383 -mfast-indirect-calls -mgas  -mjump-in-delay  
384 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs
385 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas
386 -mno-jump-in-delay  -mno-long-load-store  
387 -mno-portable-runtime  -mno-soft-float
388 -mno-space-regs  -msoft-float  -mpa-risc-1-0  
389 -mpa-risc-1-1  -mpa-risc-2-0 -mportable-runtime
390 -mschedule=@var{cpu type}  -mspace-regs
392 @emph{Intel 960 Options}
393 -m@var{cpu type}  -masm-compat  -mclean-linkage
394 -mcode-align  -mcomplex-addr  -mleaf-procedures
395 -mic-compat  -mic2.0-compat  -mic3.0-compat
396 -mintel-asm  -mno-clean-linkage  -mno-code-align
397 -mno-complex-addr  -mno-leaf-procedures
398 -mno-old-align  -mno-strict-align  -mno-tail-call
399 -mnumerics  -mold-align  -msoft-float  -mstrict-align
400 -mtail-call
402 @emph{DEC Alpha Options}
403 -mfp-regs  -mno-fp-regs -mno-soft-float  -msoft-float
404 -malpha-as -mgas
405 -mieee  -mieee-with-inexact  -mieee-conformant
406 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode}
407 -mtrap-precision=@var{mode}  -mbuild-constants
408 -mcpu=@var{cpu type}
409 -mbwx -mno-bwx -mcix -mno-cix -mmax -mno-max
410 -mmemory-latency=@var{time}
412 @emph{Clipper Options}
413 -mc300  -mc400
415 @emph{H8/300 Options}
416 -mrelax  -mh -ms -mint32  -malign-300
418 @emph{SH Options}
419 -m1  -m2  -m3  -m3e
420 -m4-nofpu  -m4-single-only  -m4-single  -m4
421 -mb  -ml  -mdalign  -mrelax
422 -mbigtable  -mfmovd  -mhitachi  -mnomacsave
423 -misize  -mpadstruct  -mspace
424 -mprefergot
425 -musermode
427 @emph{System V Options}
428 -Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}
430 @emph{ARC Options}
431 -EB  -EL
432 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text section}
433 -mdata=@var{data section}  -mrodata=@var{readonly data section}
435 @emph{TMS320C3x/C4x Options}
436 -mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm
437 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload
438 -mrpts=@var{count}  -mrptb -mdb -mloop-unsigned
439 -mparallel-insns -mparallel-mpy -mpreserve-float
441 @emph{V850 Options}
442 -mlong-calls -mno-long-calls -mep -mno-ep
443 -mprolog-function -mno-prolog-function -mspace
444 -mtda=@var{n} -msda=@var{n} -mzda=@var{n}
445 -mv850 -mbig-switch
447 @emph{NS32K Options}
448 -m32032 -m32332 -m32532 -m32081 -m32381 -mmult-add -mnomult-add
449 -msoft-float -mrtd -mnortd -mregparam -mnoregparam -msb -mnosb
450 -mbitfield -mnobitfield -mhimem -mnohimem
452 @emph{AVR Options}
453 -mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts
454 -mcall-prologues
456 @emph{MCore Options}
457 -mhardlit, -mno-hardlit -mdiv -mno-div -mrelax-immediates 
458 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields
459 -m4byte-functions -mno-4byte-functions -mcallgraph-data
460 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim
461 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment
462 @end smallexample
464 @item Code Generation Options
465 @xref{Code Gen Options,,Options for Code Generation Conventions}.
466 @smallexample
467 -fcall-saved-@var{reg}  -fcall-used-@var{reg}
468 -fexceptions  -funwind-tables  -ffixed-@var{reg}  -finhibit-size-directive
469 -fcheck-memory-usage  -fprefix-function-name
470 -fno-common  -fno-ident  -fno-gnu-linker
471 -fpcc-struct-return  -fpic  -fPIC
472 -freg-struct-return  -fshared-data  -fshort-enums
473 -fshort-double  -fvolatile  -fvolatile-global -fvolatile-static
474 -fverbose-asm -fpack-struct  -fstack-check
475 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym}
476 -fargument-alias  -fargument-noalias
477 -fargument-noalias-global
478 -fleading-underscore
479 @end smallexample
480 @end table
482 @menu
483 * Overall Options::     Controlling the kind of output:
484                         an executable, object files, assembler files,
485                         or preprocessed source.
486 * C Dialect Options::   Controlling the variant of C language compiled.
487 * C++ Dialect Options:: Variations on C++.
488 * Language Independent Options:: Controlling how diagnostics should be
489                         formatted. 
490 * Warning Options::     How picky should the compiler be?
491 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
492 * Optimize Options::    How much optimization?
493 * Preprocessor Options:: Controlling header files and macro definitions.
494                          Also, getting dependency information for Make.
495 * Assembler Options::   Passing options to the assembler.
496 * Link Options::        Specifying libraries and so on.
497 * Directory Options::   Where to find header files and libraries.
498                         Where to find the compiler executable files.
499 * Spec Files::          How to pass switches to sub-processes.
500 * Target Options::      Running a cross-compiler, or an old version of GCC.
501 @end menu
503 @node Overall Options
504 @section Options Controlling the Kind of Output
506 Compilation can involve up to four stages: preprocessing, compilation
507 proper, assembly and linking, always in that order.  The first three
508 stages apply to an individual source file, and end by producing an
509 object file; linking combines all the object files (those newly
510 compiled, and those specified as input) into an executable file.
512 @cindex file name suffix
513 For any given input file, the file name suffix determines what kind of
514 compilation is done:
516 @table @code
517 @item @var{file}.c
518 C source code which must be preprocessed.
520 @item @var{file}.i
521 C source code which should not be preprocessed.
523 @item @var{file}.ii
524 C++ source code which should not be preprocessed.
526 @item @var{file}.m
527 Objective-C source code.  Note that you must link with the library
528 @file{libobjc.a} to make an Objective-C program work.
530 @item @var{file}.h
531 C header file (not to be compiled or linked).
533 @item @var{file}.cc
534 @itemx @var{file}.cxx
535 @itemx @var{file}.cpp
536 @itemx @var{file}.C
537 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
538 the last two letters must both be literally @samp{x}.  Likewise,
539 @samp{.C} refers to a literal capital C.
541 @item @var{file}.s
542 Assembler code.
544 @item @var{file}.S
545 Assembler code which must be preprocessed.
547 @item @var{other}
548 An object file to be fed straight into linking.
549 Any file name with no recognized suffix is treated this way.
550 @end table
552 You can specify the input language explicitly with the @samp{-x} option:
554 @table @code
555 @item -x @var{language}
556 Specify explicitly the @var{language} for the following input files
557 (rather than letting the compiler choose a default based on the file
558 name suffix).  This option applies to all following input files until
559 the next @samp{-x} option.  Possible values for @var{language} are:
560 @example
561 c  objective-c  c++
562 c-header  cpp-output  c++-cpp-output
563 assembler  assembler-with-cpp
564 @end example
566 @item -x none
567 Turn off any specification of a language, so that subsequent files are
568 handled according to their file name suffixes (as they are if @samp{-x}
569 has not been used at all).
571 @item -pass-exit-codes
572 Normally the @code{gcc} program will exit with the code of 1 if any
573 phase of the compiler returns a non-success return code.  If you specify
574 @samp{-pass-exit-codes}, the @code{gcc} program will instead return with
575 numerically highest error produced by any phase that returned an error
576 indication.
577 @end table
579 If you only want some of the stages of compilation, you can use
580 @samp{-x} (or filename suffixes) to tell @code{gcc} where to start, and
581 one of the options @samp{-c}, @samp{-S}, or @samp{-E} to say where
582 @code{gcc} is to stop.  Note that some combinations (for example,
583 @samp{-x cpp-output -E} instruct @code{gcc} to do nothing at all.
585 @table @code
586 @item -c
587 Compile or assemble the source files, but do not link.  The linking
588 stage simply is not done.  The ultimate output is in the form of an
589 object file for each source file.
591 By default, the object file name for a source file is made by replacing
592 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
594 Unrecognized input files, not requiring compilation or assembly, are
595 ignored.
597 @item -S
598 Stop after the stage of compilation proper; do not assemble.  The output
599 is in the form of an assembler code file for each non-assembler input
600 file specified.
602 By default, the assembler file name for a source file is made by
603 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
605 Input files that don't require compilation are ignored.
607 @item -E
608 Stop after the preprocessing stage; do not run the compiler proper.  The
609 output is in the form of preprocessed source code, which is sent to the
610 standard output.
612 Input files which don't require preprocessing are ignored.
614 @cindex output file option
615 @item -o @var{file}
616 Place output in file @var{file}.  This applies regardless to whatever
617 sort of output is being produced, whether it be an executable file,
618 an object file, an assembler file or preprocessed C code.
620 Since only one output file can be specified, it does not make sense to
621 use @samp{-o} when compiling more than one input file, unless you are
622 producing an executable file as output.
624 If @samp{-o} is not specified, the default is to put an executable file
625 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
626 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
627 all preprocessed C source on standard output.@refill
629 @item -v
630 Print (on standard error output) the commands executed to run the stages
631 of compilation.  Also print the version number of the compiler driver
632 program and of the preprocessor and the compiler proper.
634 @item -pipe
635 Use pipes rather than temporary files for communication between the
636 various stages of compilation.  This fails to work on some systems where
637 the assembler is unable to read from a pipe; but the GNU assembler has
638 no trouble.
640 @item --help
641 Print (on the standard output) a description of the command line options
642 understood by @code{gcc}.  If the @code{-v} option is also specified
643 then @code{--help} will also be passed on to the various processes
644 invoked by @code{gcc}, so that they can display the command line options
645 they accept.  If the @code{-W} option is also specified then command
646 line options which have no documentation associated with them will also
647 be displayed.
649 @item --target-help
650 Print (on the standard output) a description of target specific command
651 line options for each tool.
652 @end table
654 @node Invoking G++
655 @section Compiling C++ Programs
657 @cindex suffixes for C++ source
658 @cindex C++ source file suffixes
659 C++ source files conventionally use one of the suffixes @samp{.C},
660 @samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
661 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
662 files with these names and compiles them as C++ programs even if you
663 call the compiler the same way as for compiling C programs (usually with
664 the name @code{gcc}).
666 @findex g++
667 @findex c++
668 However, C++ programs often require class libraries as well as a
669 compiler that understands the C++ language---and under some
670 circumstances, you might want to compile programs from standard input,
671 or otherwise without a suffix that flags them as C++ programs.
672 @code{g++} is a program that calls GCC with the default language
673 set to C++, and automatically specifies linking against the C++
674 library.  On many systems, @code{g++} is also
675 installed with the name @code{c++}.
677 @cindex invoking @code{g++}
678 When you compile C++ programs, you may specify many of the same
679 command-line options that you use for compiling programs in any
680 language; or command-line options meaningful for C and related
681 languages; or options that are meaningful only for C++ programs.
682 @xref{C Dialect Options,,Options Controlling C Dialect}, for
683 explanations of options for languages related to C.
684 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
685 explanations of options that are meaningful only for C++ programs.
687 @node C Dialect Options
688 @section Options Controlling C Dialect
689 @cindex dialect options
690 @cindex language dialect options
691 @cindex options, dialect
693 The following options control the dialect of C (or languages derived
694 from C, such as C++ and Objective C) that the compiler accepts:
696 @table @code
697 @cindex ANSI support
698 @item -ansi
699 In C mode, support all ANSI standard C programs.  In C++ mode,
700 remove GNU extensions that conflict with ISO C++.
701 @c shouldn't we be saying "ISO"?
703 This turns off certain features of GCC that are incompatible with ANSI
704 C (when compiling C code), or of standard C++ (when compiling C++ code),
705 such as the @code{asm} and @code{typeof} keywords, and
706 predefined macros such as @code{unix} and @code{vax} that identify the
707 type of system you are using.  It also enables the undesirable and
708 rarely used ANSI trigraph feature.  For the C compiler, 
709 it disables recognition of C++ style @samp{//} comments as well as
710 the @code{inline} keyword.
712 The alternate keywords @code{__asm__}, @code{__extension__},
713 @code{__inline__} and @code{__typeof__} continue to work despite
714 @samp{-ansi}.  You would not want to use them in an ANSI C program, of
715 course, but it is useful to put them in header files that might be included
716 in compilations done with @samp{-ansi}.  Alternate predefined macros
717 such as @code{__unix__} and @code{__vax__} are also available, with or
718 without @samp{-ansi}.
720 The @samp{-ansi} option does not cause non-ANSI programs to be
721 rejected gratuitously.  For that, @samp{-pedantic} is required in
722 addition to @samp{-ansi}.  @xref{Warning Options}.
724 The macro @code{__STRICT_ANSI__} is predefined when the @samp{-ansi}
725 option is used.  Some header files may notice this macro and refrain
726 from declaring certain functions or defining certain macros that the
727 ANSI standard doesn't call for; this is to avoid interfering with any
728 programs that might use these names for other things.
730 Functions which would normally be builtin but do not have semantics
731 defined by ISO C (such as @code{alloca} and @code{ffs}) are not builtin
732 functions with @samp{-ansi} is used.  @xref{Other Builtins,,Other
733 built-in functions provided by GNU CC}, for details of the functions
734 affected.
736 @item -std=
737 Determine the language standard.  A value for this option must be provided;
738 possible values are 
740 @itemize @minus
741 @item iso9899:1990
742 Same as -ansi
744 @item iso9899:199409
745 ISO C as modified in amend. 1
747 @item iso9899:1999
748 ISO C99.  Note that this standard is not yet fully supported; see
749 @uref{http://gcc.gnu.org/c99status.html} for more information.
751 @item c89
752 same as -std=iso9899:1990
754 @item c99
755 same as -std=iso9899:1999
757 @item gnu89
758 default, iso9899:1990 + gnu extensions
760 @item gnu99
761 iso9899:1999 + gnu extensions
763 @item iso9899:199x
764 same as -std=iso9899:1999, deprecated
766 @item c9x
767 same as -std=iso9899:1999, deprecated
769 @item gnu9x
770 same as -std=gnu99, deprecated
772 @end itemize
774 Even when this option is not specified, you can still use some of the
775 features of newer standards in so far as they do not conflict with
776 previous C standards.  For example, you may use @code{__restrict__} even
777 when -std=c99 is not specified.
779 @item -fno-asm
780 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
781 keyword, so that code can use these words as identifiers.  You can use
782 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
783 instead.  @samp{-ansi} implies @samp{-fno-asm}.
785 In C++, this switch only affects the @code{typeof} keyword, since
786 @code{asm} and @code{inline} are standard keywords.  You may want to
787 use the @samp{-fno-gnu-keywords} flag instead, which has the same effect.
789 @item -fno-builtin
790 @cindex builtin functions
791 Don't recognize builtin functions that do not begin with
792 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
793 functions provided by GNU CC}, for details of the functions affected,
794 including those which are not builtin functions when @samp{-ansi} is
795 used because they do not have an ISO standard meaning.
797 GCC normally generates special code to handle certain builtin functions
798 more efficiently; for instance, calls to @code{alloca} may become single
799 instructions that adjust the stack directly, and calls to @code{memcpy}
800 may become inline copy loops.  The resulting code is often both smaller
801 and faster, but since the function calls no longer appear as such, you
802 cannot set a breakpoint on those calls, nor can you change the behavior
803 of the functions by linking with a different library.
805 @item -fhosted
806 @cindex hosted environment
808 Assert that compilation takes place in a hosted environment.  This implies
809 @samp{-fbuiltin}.  A hosted environment is one in which the
810 entire standard library is available, and in which @code{main} has a return
811 type of @code{int}.  Examples are nearly everything except a kernel.
812 This is equivalent to @samp{-fno-freestanding}.
814 @item -ffreestanding
815 @cindex hosted environment
817 Assert that compilation takes place in a freestanding environment.  This
818 implies @samp{-fno-builtin}.  A freestanding environment
819 is one in which the standard library may not exist, and program startup may
820 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
821 This is equivalent to @samp{-fno-hosted}.
823 @item -trigraphs
824 Support ANSI C trigraphs.  You don't want to know about this
825 brain-damage.  The @samp{-ansi} option implies @samp{-trigraphs}.
827 @cindex traditional C language
828 @cindex C language, traditional
829 @item -traditional
830 Attempt to support some aspects of traditional C compilers.
831 Specifically:
833 @itemize @bullet
834 @item
835 All @code{extern} declarations take effect globally even if they
836 are written inside of a function definition.  This includes implicit
837 declarations of functions.
839 @item
840 The newer keywords @code{typeof}, @code{inline}, @code{signed}, @code{const}
841 and @code{volatile} are not recognized.  (You can still use the
842 alternative keywords such as @code{__typeof__}, @code{__inline__}, and
843 so on.)
845 @item
846 Comparisons between pointers and integers are always allowed.
848 @item
849 Integer types @code{unsigned short} and @code{unsigned char} promote
850 to @code{unsigned int}.
852 @item
853 Out-of-range floating point literals are not an error.
855 @item
856 Certain constructs which ANSI regards as a single invalid preprocessing
857 number, such as @samp{0xe-0xd}, are treated as expressions instead.
859 @item
860 String ``constants'' are not necessarily constant; they are stored in
861 writable space, and identical looking constants are allocated
862 separately.  (This is the same as the effect of
863 @samp{-fwritable-strings}.)
865 @cindex @code{longjmp} and automatic variables
866 @item
867 All automatic variables not declared @code{register} are preserved by
868 @code{longjmp}.  Ordinarily, GNU C follows ANSI C: automatic variables
869 not declared @code{volatile} may be clobbered.
871 @item
872 @kindex \x
873 @kindex \a
874 @cindex escape sequences, traditional
875 The character escape sequences @samp{\x} and @samp{\a} evaluate as the
876 literal characters @samp{x} and @samp{a} respectively.  Without
877 @w{@samp{-traditional}}, @samp{\x} is a prefix for the hexadecimal
878 representation of a character, and @samp{\a} produces a bell.
879 @end itemize
881 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
882 if your program uses names that are normally GNU C builtin functions for
883 other purposes of its own.
885 You cannot use @samp{-traditional} if you include any header files that
886 rely on ANSI C features.  Some vendors are starting to ship systems with
887 ANSI C header files and you cannot use @samp{-traditional} on such
888 systems to compile files that include any system headers.
890 The @samp{-traditional} option also enables @samp{-traditional-cpp},
891 which is described next.
893 @item -traditional-cpp
894 Attempt to support some aspects of traditional C preprocessors.
895 Specifically:
897 @itemize @bullet
898 @item
899 Comments convert to nothing at all, rather than to a space.  This allows
900 traditional token concatenation.
902 @item
903 In a preprocessing directive, the @samp{#} symbol must appear as the first
904 character of a line.
906 @item
907 Macro arguments are recognized within string constants in a macro
908 definition (and their values are stringified, though without additional
909 quote marks, when they appear in such a context).  The preprocessor
910 always considers a string constant to end at a newline.
912 @item
913 @cindex detecting @w{@samp{-traditional}}
914 The predefined macro @code{__STDC__} is not defined when you use
915 @samp{-traditional}, but @code{__GNUC__} is (since the GNU extensions
916 which @code{__GNUC__} indicates are not affected by
917 @samp{-traditional}).  If you need to write header files that work
918 differently depending on whether @samp{-traditional} is in use, by
919 testing both of these predefined macros you can distinguish four
920 situations: GNU C, traditional GNU C, other ANSI C compilers, and other
921 old C compilers.  The predefined macro @code{__STDC_VERSION__} is also
922 not defined when you use @samp{-traditional}.  @xref{Standard
923 Predefined,,Standard Predefined Macros,cpp.info,The C Preprocessor},
924 for more discussion of these and other predefined macros.
926 @item
927 @cindex string constants vs newline
928 @cindex newline vs string constants
929 The preprocessor considers a string constant to end at a newline (unless
930 the newline is escaped with @samp{\}).  (Without @w{@samp{-traditional}},
931 string constants can contain the newline character as typed.)
932 @end itemize
934 @item -fcond-mismatch
935 Allow conditional expressions with mismatched types in the second and
936 third arguments.  The value of such an expression is void.
938 @item -funsigned-char
939 Let the type @code{char} be unsigned, like @code{unsigned char}.
941 Each kind of machine has a default for what @code{char} should
942 be.  It is either like @code{unsigned char} by default or like
943 @code{signed char} by default.
945 Ideally, a portable program should always use @code{signed char} or
946 @code{unsigned char} when it depends on the signedness of an object.
947 But many programs have been written to use plain @code{char} and
948 expect it to be signed, or expect it to be unsigned, depending on the
949 machines they were written for.  This option, and its inverse, let you
950 make such a program work with the opposite default.
952 The type @code{char} is always a distinct type from each of
953 @code{signed char} or @code{unsigned char}, even though its behavior
954 is always just like one of those two.
956 @item -fsigned-char
957 Let the type @code{char} be signed, like @code{signed char}.
959 Note that this is equivalent to @samp{-fno-unsigned-char}, which is
960 the negative form of @samp{-funsigned-char}.  Likewise, the option
961 @samp{-fno-signed-char} is equivalent to @samp{-funsigned-char}.
963 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
964 if your program uses names that are normally GNU C builtin functions for
965 other purposes of its own.
967 You cannot use @samp{-traditional} if you include any header files that
968 rely on ANSI C features.  Some vendors are starting to ship systems with
969 ANSI C header files and you cannot use @samp{-traditional} on such
970 systems to compile files that include any system headers.
972 @item -fsigned-bitfields
973 @itemx -funsigned-bitfields
974 @itemx -fno-signed-bitfields
975 @itemx -fno-unsigned-bitfields
976 These options control whether a bitfield is signed or unsigned, when the
977 declaration does not use either @code{signed} or @code{unsigned}.  By
978 default, such a bitfield is signed, because this is consistent: the
979 basic integer types such as @code{int} are signed types.
981 However, when @samp{-traditional} is used, bitfields are all unsigned
982 no matter what.
984 @item -fwritable-strings
985 Store string constants in the writable data segment and don't uniquize
986 them.  This is for compatibility with old programs which assume they can
987 write into string constants.  The option @samp{-traditional} also has
988 this effect.
990 Writing into string constants is a very bad idea; ``constants'' should
991 be constant.
993 @item -fallow-single-precision
994 Do not promote single precision math operations to double precision,
995 even when compiling with @samp{-traditional}.
997 Traditional K&R C promotes all floating point operations to double
998 precision, regardless of the sizes of the operands.   On the
999 architecture for which you are compiling, single precision may be faster
1000 than double precision.   If you must use @samp{-traditional}, but want
1001 to use single precision operations when the operands are single
1002 precision, use this option.   This option has no effect when compiling
1003 with ANSI or GNU C conventions (the default).
1005 @item -fshort-wchar
1006 Override the underlying type for @samp{wchar_t} to be @samp{short
1007 unsigned int} instead of the default for the target.  This option is
1008 useful for building programs to run under WINE.
1009 @end table
1011 @node C++ Dialect Options
1012 @section Options Controlling C++ Dialect
1014 @cindex compiler options, C++
1015 @cindex C++ options, command line
1016 @cindex options, C++
1017 This section describes the command-line options that are only meaningful
1018 for C++ programs; but you can also use most of the GNU compiler options
1019 regardless of what language your program is in.  For example, you
1020 might compile a file @code{firstClass.C} like this:
1022 @example
1023 g++ -g -frepo -O -c firstClass.C
1024 @end example
1026 @noindent
1027 In this example, only @samp{-frepo} is an option meant
1028 only for C++ programs; you can use the other options with any
1029 language supported by GCC.
1031 Here is a list of options that are @emph{only} for compiling C++ programs:
1033 @table @code
1034 @item -fno-access-control
1035 Turn off all access checking.  This switch is mainly useful for working
1036 around bugs in the access control code.
1038 @item -fcheck-new
1039 Check that the pointer returned by @code{operator new} is non-null
1040 before attempting to modify the storage allocated.  The current Working
1041 Paper requires that @code{operator new} never return a null pointer, so
1042 this check is normally unnecessary.
1044 An alternative to using this option is to specify that your
1045 @code{operator new} does not throw any exceptions; if you declare it
1046 @samp{throw()}, g++ will check the return value.  See also @samp{new
1047 (nothrow)}.
1049 @item -fconserve-space
1050 Put uninitialized or runtime-initialized global variables into the
1051 common segment, as C does.  This saves space in the executable at the
1052 cost of not diagnosing duplicate definitions.  If you compile with this
1053 flag and your program mysteriously crashes after @code{main()} has
1054 completed, you may have an object that is being destroyed twice because
1055 two definitions were merged.
1057 This option is no longer useful on most targets, now that support has
1058 been added for putting variables into BSS without making them common.
1060 @item -fdollars-in-identifiers
1061 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1062 @samp{$} with the option @samp{-fno-dollars-in-identifiers}.  (GNU C allows
1063 @samp{$} by default on most target systems, but there are a few exceptions.)
1064 Traditional C allowed the character @samp{$} to form part of
1065 identifiers.  However, ANSI C and C++ forbid @samp{$} in identifiers.
1067 @item -fno-elide-constructors
1068 The C++ standard allows an implementation to omit creating a temporary
1069 which is only used to initialize another object of the same type.
1070 Specifying this option disables that optimization, and forces g++ to
1071 call the copy constructor in all cases.
1073 @item -fno-enforce-eh-specs
1074 Don't check for violation of exception specifications at runtime.  This
1075 option violates the C++ standard, but may be useful for reducing code
1076 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1077 will still optimize based on the exception specifications.
1079 @item -fexternal-templates
1080 Cause template instantiations to obey @samp{#pragma interface} and
1081 @samp{implementation}; template instances are emitted or not according
1082 to the location of the template definition.  @xref{Template
1083 Instantiation}, for more information.
1085 This option is deprecated.
1087 @item -falt-external-templates
1088 Similar to -fexternal-templates, but template instances are emitted or
1089 not according to the place where they are first instantiated.
1090 @xref{Template Instantiation}, for more information.
1092 This option is deprecated.
1094 @item -ffor-scope
1095 @itemx -fno-for-scope
1096 If -ffor-scope is specified, the scope of variables declared in
1097 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1098 as specified by the C++ standard.
1099 If -fno-for-scope is specified, the scope of variables declared in
1100 a @i{for-init-statement} extends to the end of the enclosing scope,
1101 as was the case in old versions of gcc, and other (traditional)
1102 implementations of C++.
1104 The default if neither flag is given to follow the standard,
1105 but to allow and give a warning for old-style code that would
1106 otherwise be invalid, or have different behavior.
1108 @item -fno-gnu-keywords
1109 Do not recognize @code{typeof} as a keyword, so that code can use this
1110 word as an identifier. You can use the keyword @code{__typeof__} instead.  
1111 @samp{-ansi} implies @samp{-fno-gnu-keywords}.
1113 @item -fhonor-std
1114 Treat the @code{namespace std} as a namespace, instead of ignoring
1115 it. For compatibility with earlier versions of g++, the compiler will,
1116 by default, ignore @code{namespace-declarations},
1117 @code{using-declarations}, @code{using-directives}, and
1118 @code{namespace-names}, if they involve @code{std}.
1120 @item -fhuge-objects
1121 Support virtual function calls for objects that exceed the size
1122 representable by a @samp{short int}.  Users should not use this flag by
1123 default; if you need to use it, the compiler will tell you so.
1125 This flag is not useful when compiling with -fvtable-thunks.
1127 Like all options that change the ABI, all C++ code, @emph{including
1128 libgcc} must be built with the same setting of this option.
1130 @item -fno-implicit-templates
1131 Never emit code for non-inline templates which are instantiated
1132 implicitly (i.e. by use); only emit code for explicit instantiations.
1133 @xref{Template Instantiation}, for more information.
1135 @item -fno-implicit-inline-templates
1136 Don't emit code for implicit instantiations of inline templates, either.
1137 The default is to handle inlines differently so that compiles with and
1138 without optimization will need the same set of explicit instantiations.
1140 @item -finit-priority
1141 Support @samp{__attribute__ ((init_priority (n)))} for controlling the
1142 order of initialization of file-scope objects.  On ELF targets, this
1143 requires GNU ld 2.10 or later.
1145 @item -fno-implement-inlines
1146 To save space, do not emit out-of-line copies of inline functions
1147 controlled by @samp{#pragma implementation}.  This will cause linker
1148 errors if these functions are not inlined everywhere they are called.
1150 @item -fms-extensions
1151 Disable pedwarns about constructs used in MFC, such as implicit int and
1152 getting a pointer to member function via non-standard syntax.
1154 @item -fname-mangling-version-@var{n}
1155 Control the way in which names are mangled.  Version 0 is compatible
1156 with versions of g++ before 2.8.  Version 1 is the default.  Version 1
1157 will allow correct mangling of function templates.  For example, 
1158 version 0 mangling does not mangle foo<int, double> and foo<int, char>
1159 given this declaration:
1161 @example
1162 template <class T, class U> void foo(T t);
1163 @end example
1165 Like all options that change the ABI, all C++ code, @emph{including
1166 libgcc} must be built with the same setting of this option.
1168 @item -fno-operator-names
1169 Do not treat the operator name keywords @code{and}, @code{bitand},
1170 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1171 synonyms as keywords.
1173 @item -fno-optional-diags
1174 Disable diagnostics that the standard says a compiler does not need to
1175 issue.  Currently, the only such diagnostic issued by g++ is the one for
1176 a name having multiple meanings within a class.
1178 @item -fpermissive
1179 Downgrade messages about nonconformant code from errors to warnings.  By
1180 default, g++ effectively sets @samp{-pedantic-errors} without
1181 @samp{-pedantic}; this option reverses that.  This behavior and this
1182 option are superseded by @samp{-pedantic}, which works as it does for GNU C.
1184 @item -frepo
1185 Enable automatic template instantiation.  This option also implies
1186 @samp{-fno-implicit-templates}.  @xref{Template Instantiation}, for more
1187 information.
1189 @item -fno-rtti
1190 Disable generation of information about every class with virtual
1191 functions for use by the C++ runtime type identification features
1192 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1193 of the language, you can save some space by using this flag.  Note that
1194 exception handling uses the same information, but it will generate it as
1195 needed.
1197 @item -fsquangle
1198 @itemx -fno-squangle
1199 @samp{-fsquangle} will enable a compressed form of name mangling for
1200 identifiers. In particular, it helps to shorten very long names by recognizing
1201 types and class names which occur more than once, replacing them with special
1202 short ID codes.  This option also requires any C++ libraries being used to
1203 be compiled with this option as well.  The compiler has this disabled (the
1204 equivalent of @samp{-fno-squangle}) by default.
1206 Like all options that change the ABI, all C++ code, @emph{including
1207 libgcc.a} must be built with the same setting of this option.
1209 @item -ftemplate-depth-@var{n}
1210 Set the maximum instantiation depth for template classes to @var{n}.
1211 A limit on the template instantiation depth is needed to detect
1212 endless recursions during template class instantiation. ANSI/ISO C++
1213 conforming programs must not rely on a maximum depth greater than 17.
1215 @item -fuse-cxa-atexit
1216 Register destructors for objects with static storage duration with the
1217 @code{__cxa_atexit} function rather than the @code{atexit} function.
1218 This option is required for fully standards-compliant handling of static
1219 destructors, but will only work if your C library supports
1220 @code{__cxa_atexit}.
1222 @item -fvtable-thunks
1223 Use @samp{thunks} to implement the virtual function dispatch table
1224 (@samp{vtable}).  The traditional (cfront-style) approach to
1225 implementing vtables was to store a pointer to the function and two
1226 offsets for adjusting the @samp{this} pointer at the call site.  Newer
1227 implementations store a single pointer to a @samp{thunk} function which
1228 does any necessary adjustment and then calls the target function.
1230 This option also enables a heuristic for controlling emission of
1231 vtables; if a class has any non-inline virtual functions, the vtable
1232 will be emitted in the translation unit containing the first one of
1233 those.
1235 Like all options that change the ABI, all C++ code, @emph{including
1236 libgcc.a} must be built with the same setting of this option.
1238 @item -nostdinc++
1239 Do not search for header files in the standard directories specific to
1240 C++, but do still search the other standard directories.  (This option
1241 is used when building the C++ library.)
1242 @end table
1244 In addition, these optimization, warning, and code generation options
1245 have meanings only for C++ programs:
1247 @table @code
1248 @item -fno-default-inline
1249 Do not assume @samp{inline} for functions defined inside a class scope.
1250 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1251 functions will have linkage like inline functions; they just won't be
1252 inlined by default.
1254 @item -Wctor-dtor-privacy (C++ only)
1255 Warn when a class seems unusable, because all the constructors or
1256 destructors in a class are private and the class has no friends or
1257 public static member functions.
1259 @item -Wnon-virtual-dtor (C++ only)
1260 Warn when a class declares a non-virtual destructor that should probably
1261 be virtual, because it looks like the class will be used polymorphically.
1263 @item -Wreorder (C++ only)
1264 @cindex reordering, warning
1265 @cindex warning for reordering of member initializers
1266 Warn when the order of member initializers given in the code does not
1267 match the order in which they must be executed.  For instance:
1269 @smallexample
1270 struct A @{
1271   int i;
1272   int j;
1273   A(): j (0), i (1) @{ @}
1275 @end smallexample
1277 Here the compiler will warn that the member initializers for @samp{i}
1278 and @samp{j} will be rearranged to match the declaration order of the
1279 members.
1280 @end table
1282 The following @samp{-W@dots{}} options are not affected by @samp{-Wall}.
1284 @table @code
1285 @item -Weffc++ (C++ only)
1286 Warn about violations of various style guidelines from Scott Meyers'
1287 @cite{Effective C++} books.  If you use this option, you should be aware
1288 that the standard library headers do not obey all of these guidelines;
1289 you can use @samp{grep -v} to filter out those warnings.
1291 @item -Wno-deprecated (C++ only)
1292 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1294 @item -Wno-non-template-friend (C++ only)
1295 Disable warnings when non-templatized friend functions are declared
1296 within a template. With the advent of explicit template specification
1297 support in g++, if the name of the friend is an unqualified-id (ie,
1298 @samp{friend foo(int)}), the C++ language specification demands that the
1299 friend declare or define an ordinary, nontemplate function. (Section
1300 14.5.3). Before g++ implemented explicit specification, unqualified-ids
1301 could be interpreted as a particular specialization of a templatized
1302 function. Because this non-conforming behavior is no longer the default
1303 behavior for g++, @samp{-Wnon-template-friend} allows the compiler to
1304 check existing code for potential trouble spots, and is on by default.
1305 This new compiler behavior can be turned off with
1306 @samp{-Wno-non-template-friend} which keeps the conformant compiler code
1307 but disables the helpful warning.
1309 @item -Wold-style-cast (C++ only)
1310 Warn if an old-style (C-style) cast is used within a C++ program.  The
1311 new-style casts (@samp{static_cast}, @samp{reinterpret_cast}, and
1312 @samp{const_cast}) are less vulnerable to unintended effects.
1314 @item -Woverloaded-virtual (C++ only)
1315 @cindex overloaded virtual fn, warning
1316 @cindex warning for overloaded virtual fn
1317 Warn when a derived class function declaration may be an error in
1318 defining a virtual function.  In a derived class, the
1319 definitions of virtual functions must match the type signature of a
1320 virtual function declared in the base class.  With this option, the
1321 compiler warns when you define a function with the same name as a
1322 virtual function, but with a type signature that does not match any
1323 declarations from the base class.
1325 @item -Wno-pmf-conversions (C++ only)
1326 Disable the diagnostic for converting a bound pointer to member function
1327 to a plain pointer.
1329 @item -Wsign-promo (C++ only)
1330 Warn when overload resolution chooses a promotion from unsigned or
1331 enumeral type to a signed type over a conversion to an unsigned type of
1332 the same size.  Previous versions of g++ would try to preserve
1333 unsignedness, but the standard mandates the current behavior.
1335 @item -Wsynth (C++ only)
1336 @cindex warning for synthesized methods
1337 @cindex synthesized methods, warning
1338 Warn when g++'s synthesis behavior does not match that of cfront.  For
1339 instance:
1341 @smallexample
1342 struct A @{
1343   operator int ();
1344   A& operator = (int);
1347 main ()
1349   A a,b;
1350   a = b;
1352 @end smallexample
1354 In this example, g++ will synthesize a default @samp{A& operator =
1355 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1356 @end table
1358 @node Language Independent Options
1359 @section Options to Control Diagnostic Messages Formatting
1360 @cindex options to control diagnostics formatting
1361 @cindex diagnostic messages
1362 @cindex message formatting
1364 Traditionally, diagnostic messages have been formatted irrespective of
1365 the output device's aspect (e.g. its width, ...).  The options described
1366 below can be used to control the diagnostic messages formatting
1367 algorithm, e.g. how many characters per line, how often source location
1368 information should be reported.  Right now, only the C++ front-end can
1369 honor these options.  However it is expected, in the near future, that
1370 the remaining front-ends would be able to digest them correctly. 
1372 @table @code
1373 @item -fmessage-length=@var{n}
1374 Try to format error messages so that they fit on lines of about @var{n}
1375 characters.  The default is 72 characters for g++ and 0 for the rest of
1376 the front-ends supported by GCC.  If @var{n} is zero, then no
1377 line-wrapping will be done; each error message will appear on a single 
1378 line.
1380 @item -fdiagnostics-show-location=once
1381 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1382 reporter to emit @emph{once} source location information; that is, in
1383 case the message is too long to fit on a single physical line and has to
1384 be wrapped, the source location won't be emitted (as prefix) again,
1385 over and over, in subsequent continuation lines.  This is the default
1386 behaviour. 
1388 @item -fdiagnostics-show-location=every-line
1389 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1390 messages reporter to emit the same source location information (as
1391 prefix) for physical lines that result from the process of breaking a
1392 a message which is too long to fit on a single line.
1394 @end table
1396 @node Warning Options
1397 @section Options to Request or Suppress Warnings
1398 @cindex options to control warnings
1399 @cindex warning messages
1400 @cindex messages, warning
1401 @cindex suppressing warnings
1403 Warnings are diagnostic messages that report constructions which
1404 are not inherently erroneous but which are risky or suggest there
1405 may have been an error.
1407 You can request many specific warnings with options beginning @samp{-W},
1408 for example @samp{-Wimplicit} to request warnings on implicit
1409 declarations.  Each of these specific warning options also has a
1410 negative form beginning @samp{-Wno-} to turn off warnings;
1411 for example, @samp{-Wno-implicit}.  This manual lists only one of the
1412 two forms, whichever is not the default.
1414 These options control the amount and kinds of warnings produced by GCC:
1416 @table @code
1417 @cindex syntax checking
1418 @item -fsyntax-only
1419 Check the code for syntax errors, but don't do anything beyond that.
1421 @item -pedantic
1422 Issue all the warnings demanded by strict ISO C and ISO C++;
1423 reject all programs that use forbidden extensions, and some other
1424 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1425 version of the ISO C standard specified by any @samp{-std} option used.
1427 Valid ISO C and ISO C++ programs should compile properly with or without
1428 this option (though a rare few will require @samp{-ansi}).  However,
1429 without this option, certain GNU extensions and traditional C and C++
1430 features are supported as well.  With this option, they are rejected.
1432 @samp{-pedantic} does not cause warning messages for use of the
1433 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1434 warnings are also disabled in the expression that follows
1435 @code{__extension__}.  However, only system header files should use
1436 these escape routes; application programs should avoid them.
1437 @xref{Alternate Keywords}.
1439 Some users try to use @samp{-pedantic} to check programs for strict ISO
1440 C conformance.  They soon find that it does not do quite what they want:
1441 it finds some non-ANSI practices, but not all---only those for which
1442 ISO C @emph{requires} a diagnostic, and some others for which
1443 diagnostics have been added.
1445 A feature to report any failure to conform to ISO C might be useful in
1446 some instances, but would require considerable additional work and would
1447 be quite different from @samp{-pedantic}.  We don't have plans to
1448 support such a feature in the near future.
1450 @item -pedantic-errors
1451 Like @samp{-pedantic}, except that errors are produced rather than
1452 warnings.
1454 @item -w
1455 Inhibit all warning messages.
1457 @item -Wno-import
1458 Inhibit warning messages about the use of @samp{#import}.
1460 @item -Wchar-subscripts
1461 Warn if an array subscript has type @code{char}.  This is a common cause
1462 of error, as programmers often forget that this type is signed on some
1463 machines.
1465 @item -Wcomment
1466 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1467 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1469 @item -Wformat
1470 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1471 the arguments supplied have types appropriate to the format string
1472 specified.
1474 @item -Wimplicit-int
1475 Warn when a declaration does not specify a type.
1477 @item -Wimplicit-function-declaration
1478 @itemx -Werror-implicit-function-declaration
1479 Give a warning (or error) whenever a function is used before being
1480 declared.
1482 @item -Wimplicit
1483 Same as @samp{-Wimplicit-int} and @samp{-Wimplicit-function-}@*
1484 @samp{declaration}.
1486 @item -Wmain
1487 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
1488 function with external linkage, returning int, taking either zero
1489 arguments, two, or three arguments of appropriate types.
1491 @item -Wmultichar
1492 Warn if a multicharacter constant (@samp{'FOOF'}) is used.  Usually they
1493 indicate a typo in the user's code, as they have implementation-defined
1494 values, and should not be used in portable code.
1496 @item -Wparentheses
1497 Warn if parentheses are omitted in certain contexts, such
1498 as when there is an assignment in a context where a truth value
1499 is expected, or when operators are nested whose precedence people
1500 often get confused about.
1502 Also warn about constructions where there may be confusion to which
1503 @code{if} statement an @code{else} branch belongs.  Here is an example of
1504 such a case:
1506 @smallexample
1508   if (a)
1509     if (b)
1510       foo ();
1511   else
1512     bar ();
1514 @end smallexample
1516 In C, every @code{else} branch belongs to the innermost possible @code{if}
1517 statement, which in this example is @code{if (b)}.  This is often not
1518 what the programmer expected, as illustrated in the above example by
1519 indentation the programmer chose.  When there is the potential for this
1520 confusion, GNU C will issue a warning when this flag is specified.
1521 To eliminate the warning, add explicit braces around the innermost
1522 @code{if} statement so there is no way the @code{else} could belong to
1523 the enclosing @code{if}.  The resulting code would look like this:
1525 @smallexample
1527   if (a)
1528     @{
1529       if (b)
1530         foo ();
1531       else
1532         bar ();
1533     @}
1535 @end smallexample
1537 @item -Wsequence-point
1538 Warn about code that may have undefined semantics because of violations
1539 of sequence point rules in the C standard.
1541 The C standard defines the order in which expressions in a C program are
1542 evaluated in terms of @dfn{sequence points}, which represent a partial
1543 ordering between the execution of parts of the program: those executed
1544 before the sequence point, and those executed after it.  These occur
1545 after the evaluation of a full expression (one which is not part of a
1546 larger expression), after the evaluation of the first operand of a
1547 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
1548 function is called (but after the evaluation of its arguments and the
1549 expression denoting the called function), and in certain other places.
1550 Other than as expressed by the sequence point rules, the order of
1551 evaluation of subexpressions of an expression is not specified.  All
1552 these rules describe only a partial order rather than a total order,
1553 since, for example, if two functions are called within one expression
1554 with no sequence point between them, the order in which the functions
1555 are called is not specified.  However, the standards committee have
1556 ruled that function calls do not overlap.
1558 It is not specified when between sequence points modifications to the
1559 values of objects take effect.  Programs whose behavior depends on this
1560 have undefined behavior; the C standard specifies that ``Between the
1561 previous and next sequence point an object shall have its stored value
1562 modified at most once by the evaluation of an expression.  Furthermore,
1563 the prior value shall be read only to determine the value to be
1564 stored.''.  If a program breaks these rules, the results on any
1565 particular implementation are entirely unpredictable.
1567 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
1568 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
1569 diagnosed by this option, and it may give an occasional false positive
1570 result, but in general it has been found fairly effective at detecting
1571 this sort of problem in programs.
1573 The present implementation of this option only works for C programs.  A
1574 future implementation may also work for C++ programs.
1576 There is some controversy over the precise meaning of the sequence point
1577 rules in subtle cases.  Alternative formal definitions may be found in
1578 Clive Feather's ``Annex S''
1579 @uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n908.htm} and in
1580 Michael Norrish's thesis
1581 @uref{http://www.cl.cam.ac.uk/users/mn200/PhD/thesis-report.ps.gz}.
1583 @item -Wreturn-type
1584 Warn whenever a function is defined with a return-type that defaults to
1585 @code{int}.  Also warn about any @code{return} statement with no
1586 return-value in a function whose return-type is not @code{void}. 
1588 For C++, a function without return type always produces a diagnostic
1589 message, even when @samp{-Wno-return-type} is specified. The only
1590 exceptions are @samp{main} and functions defined in system headers.
1592 @item -Wswitch
1593 Warn whenever a @code{switch} statement has an index of enumeral type
1594 and lacks a @code{case} for one or more of the named codes of that
1595 enumeration.  (The presence of a @code{default} label prevents this
1596 warning.)  @code{case} labels outside the enumeration range also
1597 provoke warnings when this option is used.
1599 @item -Wtrigraphs
1600 Warn if any trigraphs are encountered (assuming they are enabled).
1602 @item -Wunused-function
1603 Warn whenever a static function is declared but not defined or a
1604 non\-inline static function is unused.
1606 @item -Wunused-label
1607 Warn whenever a label is declared but not used.
1609 To suppress this warning use the @samp{unused} attribute
1610 (@pxref{Variable Attributes}).
1612 @item -Wunused-parameter
1613 Warn whenever a function parameter is unused aside from its declaration.
1615 To suppress this warning use the @samp{unused} attribute
1616 (@pxref{Variable Attributes}).
1618 @item -Wunused-variable
1619 Warn whenever a local variable or non-constant static variable is unused
1620 aside from its declaration
1622 To suppress this warning use the @samp{unused} attribute
1623 (@pxref{Variable Attributes}).
1625 @item -Wunused-value
1626 Warn whenever a statement computes a result that is explicitly not used.
1628 To suppress this warning cast the expression to @samp{void}.
1630 @item -Wunused
1631 All all the above @samp{-Wunused} options combined.
1633 In order to get a warning about an unused function parameter, you must
1634 either specify @samp{-W -Wunused} or separately specify
1635 @samp{-Wunused-parameter}.
1637 @item -Wuninitialized
1638 Warn if an automatic variable is used without first being initialized or
1639 if a variable may be clobbered by a @code{setjmp} call.
1641 These warnings are possible only in optimizing compilation,
1642 because they require data flow information that is computed only
1643 when optimizing.  If you don't specify @samp{-O}, you simply won't
1644 get these warnings.
1646 These warnings occur only for variables that are candidates for
1647 register allocation.  Therefore, they do not occur for a variable that
1648 is declared @code{volatile}, or whose address is taken, or whose size
1649 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
1650 structures, unions or arrays, even when they are in registers.
1652 Note that there may be no warning about a variable that is used only
1653 to compute a value that itself is never used, because such
1654 computations may be deleted by data flow analysis before the warnings
1655 are printed.
1657 These warnings are made optional because GCC is not smart
1658 enough to see all the reasons why the code might be correct
1659 despite appearing to have an error.  Here is one example of how
1660 this can happen:
1662 @smallexample
1664   int x;
1665   switch (y)
1666     @{
1667     case 1: x = 1;
1668       break;
1669     case 2: x = 4;
1670       break;
1671     case 3: x = 5;
1672     @}
1673   foo (x);
1675 @end smallexample
1677 @noindent
1678 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
1679 always initialized, but GCC doesn't know this.  Here is
1680 another common case:
1682 @smallexample
1684   int save_y;
1685   if (change_y) save_y = y, y = new_y;
1686   @dots{}
1687   if (change_y) y = save_y;
1689 @end smallexample
1691 @noindent
1692 This has no bug because @code{save_y} is used only if it is set.
1694 @cindex @code{longjmp} warnings
1695 This option also warns when a non-volatile automatic variable might be
1696 changed by a call to @code{longjmp}.  These warnings as well are possible
1697 only in optimizing compilation.
1699 The compiler sees only the calls to @code{setjmp}.  It cannot know
1700 where @code{longjmp} will be called; in fact, a signal handler could
1701 call it at any point in the code.  As a result, you may get a warning
1702 even when there is in fact no problem because @code{longjmp} cannot
1703 in fact be called at the place which would cause a problem.
1705 Some spurious warnings can be avoided if you declare all the functions
1706 you use that never return as @code{noreturn}.  @xref{Function
1707 Attributes}.
1709 @item -Wreorder (C++ only)
1710 @cindex reordering, warning
1711 @cindex warning for reordering of member initializers
1712 Warn when the order of member initializers given in the code does not
1713 match the order in which they must be executed.  For instance:
1715 @item -Wunknown-pragmas
1716 @cindex warning for unknown pragmas
1717 @cindex unknown pragmas, warning
1718 @cindex pragmas, warning of unknown
1719 Warn when a #pragma directive is encountered which is not understood by
1720 GCC.  If this command line option is used, warnings will even be issued
1721 for unknown pragmas in system header files.  This is not the case if
1722 the warnings were only enabled by the @samp{-Wall} command line option.
1724 @item -Wall
1725 All of the above @samp{-W} options combined.  This enables all the
1726 warnings about constructions that some users consider questionable, and
1727 that are easy to avoid (or modify to prevent the warning), even in
1728 conjunction with macros.
1730 @item -Wsystem-headers
1731 @cindex warnings from system headers
1732 @cindex system headers, warnings from
1733 Print warning messages for constructs found in system header files.
1734 Warnings from system headers are normally suppressed, on the assumption
1735 that they usually do not indicate real problems and would only make the
1736 compiler output harder to read.  Using this command line option tells
1737 GCC to emit warnings from system headers as if they occurred in user
1738 code.  However, note that using @samp{-Wall} in conjunction with this
1739 option will @emph{not} warn about unknown pragmas in system
1740 headers---for that, @samp{-Wunknown-pragmas} must also be used.
1741 @end table
1743 The following @samp{-W@dots{}} options are not implied by @samp{-Wall}.
1744 Some of them warn about constructions that users generally do not
1745 consider questionable, but which occasionally you might wish to check
1746 for; others warn about constructions that are necessary or hard to avoid
1747 in some cases, and there is no simple way to modify the code to suppress
1748 the warning.
1750 @table @code
1751 @item -W
1752 Print extra warning messages for these events:
1754 @itemize @bullet
1755 @item
1756 A function can return either with or without a value.  (Falling
1757 off the end of the function body is considered returning without
1758 a value.)  For example, this function would evoke such a
1759 warning:
1761 @smallexample
1762 @group
1763 foo (a)
1765   if (a > 0)
1766     return a;
1768 @end group
1769 @end smallexample
1771 @item
1772 An expression-statement or the left-hand side of a comma expression
1773 contains no side effects.
1774 To suppress the warning, cast the unused expression to void.
1775 For example, an expression such as @samp{x[i,j]} will cause a warning,
1776 but @samp{x[(void)i,j]} will not.
1778 @item
1779 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
1781 @item
1782 A comparison like @samp{x<=y<=z} appears; this is equivalent to
1783 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
1784 that of ordinary mathematical notation.
1786 @item
1787 Storage-class specifiers like @code{static} are not the first things in
1788 a declaration.  According to the C Standard, this usage is obsolescent.
1790 @item
1791 The return type of a function has a type qualifier such as @code{const}.
1792 Such a type qualifier has no effect, since the value returned by a
1793 function is not an lvalue.  (But don't warn about the GNU extension of
1794 @code{volatile void} return types.  That extension will be warned about
1795 if @samp{-pedantic} is specified.)
1797 @item
1798 If @samp{-Wall} or @samp{-Wunused} is also specified, warn about unused
1799 arguments.
1801 @item
1802 A comparison between signed and unsigned values could produce an
1803 incorrect result when the signed value is converted to unsigned.
1804 (But don't warn if @samp{-Wno-sign-compare} is also specified.)
1806 @item
1807 An aggregate has a partly bracketed initializer.
1808 For example, the following code would evoke such a warning,
1809 because braces are missing around the initializer for @code{x.h}:
1811 @smallexample
1812 struct s @{ int f, g; @};
1813 struct t @{ struct s h; int i; @};
1814 struct t x = @{ 1, 2, 3 @};
1815 @end smallexample
1817 @item
1818 An aggregate has an initializer which does not initialize all members.
1819 For example, the following code would cause such a warning, because
1820 @code{x.h} would be implicitly initialized to zero:
1822 @smallexample
1823 struct s @{ int f, g, h; @};
1824 struct s x = @{ 3, 4 @};
1825 @end smallexample
1826 @end itemize
1828 @item -Wfloat-equal
1829 Warn if floating point values are used in equality comparisons.
1831 The idea behind this is that sometimes it is convenient (for the
1832 programmer) to consider floating-point values as approximations to
1833 infinitely precise real numbers.  If you are doing this, then you need
1834 to compute (by analysing the code, or in some other way) the maximum or
1835 likely maximum error that the computation introduces, and allow for it
1836 when performing comparisons (and when producing output, but that's a
1837 different problem).  In particular, instead of testing for equality, you
1838 would check to see whether the two values have ranges that overlap; and
1839 this is done with the relational operators, so equality comparisons are
1840 probably mistaken.
1842 @item -Wtraditional (C only)
1843 Warn about certain constructs that behave differently in traditional and
1844 ANSI C.
1846 @itemize @bullet
1847 @item
1848 Macro arguments occurring within string constants in the macro body.
1849 These would substitute the argument in traditional C, but are part of
1850 the constant in ANSI C.
1852 @item
1853 A function declared external in one block and then used after the end of
1854 the block.
1856 @item
1857 A @code{switch} statement has an operand of type @code{long}.
1859 @item
1860 A non-@code{static} function declaration follows a @code{static} one.
1861 This construct is not accepted by some traditional C compilers.
1863 @item
1864 The ANSI type of an integer constant has a different width or
1865 signedness from its traditional type.  This warning is only issued if
1866 the base of the constant is ten.  I.e. hexadecimal or octal values, which
1867 typically represent bit patterns, are not warned about.
1869 @item
1870 Usage of ANSI string concatenation is detected.
1872 @item
1873 A function macro appears without arguments.
1875 @item
1876 The unary plus operator.
1878 @item
1879 Initialization of automatic aggregates.
1881 @item
1882 Identifier conflicts with labels.  Traditional C lacks a separate
1883 namespace for labels.
1885 @item
1886 Initialization of unions.  If the initializer is zero, the warning is
1887 omitted.  This is done under the assumption that the zero initializer in
1888 user code appears conditioned on e.g. @code{__STDC__} to avoid missing
1889 initializer warnings and relies on default initialization to zero in the
1890 traditional C case.
1892 @item
1893 The `U' integer constant suffix, or the `F' or `L' floating point
1894 constant suffixes.  (Traditonal C does support the `L' suffix on integer
1895 constants.)  Note, these suffixes appear in macros defined in the system
1896 headers of most modern systems, e.g. the _MIN/_MAX macros in limits.h.
1897 Use of these macros can lead to spurious warnings as they do not
1898 necessarily reflect whether the code in question is any less portable to
1899 traditional C given that suitable backup definitions are provided.
1900 @end itemize
1902 @item -Wundef
1903 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
1905 @item -Wshadow
1906 Warn whenever a local variable shadows another local variable.
1908 @item -Wid-clash-@var{len}
1909 Warn whenever two distinct identifiers match in the first @var{len}
1910 characters.  This may help you prepare a program that will compile
1911 with certain obsolete, brain-damaged compilers.
1913 @item -Wlarger-than-@var{len}
1914 Warn whenever an object of larger than @var{len} bytes is defined.
1916 @item -Wpointer-arith
1917 Warn about anything that depends on the ``size of'' a function type or
1918 of @code{void}.  GNU C assigns these types a size of 1, for
1919 convenience in calculations with @code{void *} pointers and pointers
1920 to functions.
1922 @item -Wbad-function-cast (C only)
1923 Warn whenever a function call is cast to a non-matching type.
1924 For example, warn if @code{int malloc()} is cast to @code{anything *}.
1926 @item -Wcast-qual
1927 Warn whenever a pointer is cast so as to remove a type qualifier from
1928 the target type.  For example, warn if a @code{const char *} is cast
1929 to an ordinary @code{char *}.
1931 @item -Wcast-align
1932 Warn whenever a pointer is cast such that the required alignment of the
1933 target is increased.  For example, warn if a @code{char *} is cast to
1934 an @code{int *} on machines where integers can only be accessed at
1935 two- or four-byte boundaries.
1937 @item -Wwrite-strings
1938 Give string constants the type @code{const char[@var{length}]} so that
1939 copying the address of one into a non-@code{const} @code{char *}
1940 pointer will get a warning.  These warnings will help you find at
1941 compile time code that can try to write into a string constant, but
1942 only if you have been very careful about using @code{const} in
1943 declarations and prototypes.  Otherwise, it will just be a nuisance;
1944 this is why we did not make @samp{-Wall} request these warnings.
1946 @item -Wconversion
1947 Warn if a prototype causes a type conversion that is different from what
1948 would happen to the same argument in the absence of a prototype.  This
1949 includes conversions of fixed point to floating and vice versa, and
1950 conversions changing the width or signedness of a fixed point argument
1951 except when the same as the default promotion.
1953 Also, warn if a negative integer constant expression is implicitly
1954 converted to an unsigned type.  For example, warn about the assignment
1955 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
1956 casts like @code{(unsigned) -1}.
1958 @item -Wsign-compare
1959 @cindex warning for comparison of signed and unsigned values
1960 @cindex comparison of signed and unsigned values, warning
1961 @cindex signed and unsigned values, comparison warning
1962 Warn when a comparison between signed and unsigned values could produce
1963 an incorrect result when the signed value is converted to unsigned.
1964 This warning is also enabled by @samp{-W}; to get the other warnings
1965 of @samp{-W} without this warning, use @samp{-W -Wno-sign-compare}.
1967 @item -Waggregate-return
1968 Warn if any functions that return structures or unions are defined or
1969 called.  (In languages where you can return an array, this also elicits
1970 a warning.)
1972 @item -Wstrict-prototypes (C only)
1973 Warn if a function is declared or defined without specifying the
1974 argument types.  (An old-style function definition is permitted without
1975 a warning if preceded by a declaration which specifies the argument
1976 types.)
1978 @item -Wmissing-prototypes (C only)
1979 Warn if a global function is defined without a previous prototype
1980 declaration.  This warning is issued even if the definition itself
1981 provides a prototype.  The aim is to detect global functions that fail
1982 to be declared in header files.
1984 @item -Wmissing-declarations
1985 Warn if a global function is defined without a previous declaration.
1986 Do so even if the definition itself provides a prototype.
1987 Use this option to detect global functions that are not declared in
1988 header files.
1990 @item -Wmissing-noreturn
1991 Warn about functions which might be candidates for attribute @code{noreturn}.
1992 Note these are only possible candidates, not absolute ones.  Care should
1993 be taken to manually verify functions actually do not ever return before
1994 adding the @code{noreturn} attribute, otherwise subtle code generation
1995 bugs could be introduced.
1997 @item -Wmissing-format-attribute
1998 If @samp{-Wformat} is enabled, also warn about functions which might be
1999 candidates for @code{format} attributes.  Note these are only possible
2000 candidates, not absolute ones.  GCC will guess that @code{format}
2001 attributes might be appropriate for any function that calls a function
2002 like @code{vprintf} or @code{vscanf}, but this might not always be the
2003 case, and some functions for which @code{format} attributes are
2004 appropriate may not be detected.  This option has no effect unless
2005 @samp{-Wformat} is enabled (possibly by @samp{-Wall}).
2007 @item -Wpacked
2008 Warn if a structure is given the packed attribute, but the packed
2009 attribute has no effect on the layout or size of the structure.  
2010 Such structures may be mis-aligned for little benefit.  For
2011 instance, in this code, the variable @code{f.x} in @code{struct bar}
2012 will be misaligned even though @code{struct bar} does not itself
2013 have the packed attribute:
2015 @smallexample
2016 @group
2017 struct foo @{
2018   int x;
2019   char a, b, c, d;
2020 @} __attribute__((packed));
2021 struct bar @{
2022   char z;
2023   struct foo f;
2025 @end group
2026 @end smallexample
2028 @item -Wpadded
2029 Warn if padding is included in a structure, either to align an element
2030 of the structure or to align the whole structure.  Sometimes when this
2031 happens it is possible to rearrange the fields of the structure to
2032 reduce the padding and so make the structure smaller.
2034 @item -Wredundant-decls
2035 Warn if anything is declared more than once in the same scope, even in
2036 cases where multiple declaration is valid and changes nothing.
2038 @item -Wnested-externs (C only)
2039 Warn if an @code{extern} declaration is encountered within a function.
2041 @item -Wunreachable-code
2042 Warn if the compiler detects that code will never be executed.
2044 This option is intended to warn when the compiler detects that at
2045 least a whole line of source code will never be executed, because
2046 some condition is never satisfied or because it is after a
2047 procedure that never returns.
2049 It is possible for this option to produce a warning even though there
2050 are circumstances under which part of the affected line can be executed,
2051 so care should be taken when removing apparently-unreachable code.
2053 For instance, when a function is inlined, a warning may mean that the
2054 line is unreachable in only one inlined copy of the function.  
2056 This option is not made part of @samp{-Wall} because in a debugging
2057 version of a program there is often substantial code which checks
2058 correct functioning of the program and is, hopefully, unreachable
2059 because the program does work.  Another common use of unreachable
2060 code is to provide behaviour which is selectable at compile-time.
2062 @item -Winline
2063 Warn if a function can not be inlined and it was declared as inline.
2065 @item -Wlong-long
2066 Warn if @samp{long long} type is used.  This is default.  To inhibit
2067 the warning messages, use @samp{-Wno-long-long}.  Flags
2068 @samp{-Wlong-long} and @samp{-Wno-long-long} are taken into account
2069 only when @samp{-pedantic} flag is used.
2071 @item -Wdisabled-optimization
2072 Warn if a requested optimization pass is disabled.  This warning does
2073 not generally indicate that there is anything wrong with your code; it
2074 merely indicates that GCC's optimizers were unable to handle the code
2075 effectively.  Often, the problem is that your code is too big or too
2076 complex; GCC will refuse to optimize programs when the optimization
2077 itself is likely to take inordinate amounts of time.
2079 @item -Werror
2080 Make all warnings into errors.
2081 @end table
2083 @node Debugging Options
2084 @section Options for Debugging Your Program or GCC
2085 @cindex options, debugging
2086 @cindex debugging information options
2088 GCC has various special options that are used for debugging
2089 either your program or GCC:
2091 @table @code
2092 @item -g
2093 Produce debugging information in the operating system's native format
2094 (stabs, COFF, XCOFF, or DWARF).  GDB can work with this debugging
2095 information.
2097 On most systems that use stabs format, @samp{-g} enables use of extra
2098 debugging information that only GDB can use; this extra information
2099 makes debugging work better in GDB but will probably make other debuggers
2100 crash or
2101 refuse to read the program.  If you want to control for certain whether
2102 to generate the extra information, use @samp{-gstabs+}, @samp{-gstabs},
2103 @samp{-gxcoff+}, @samp{-gxcoff}, @samp{-gdwarf-1+}, or @samp{-gdwarf-1}
2104 (see below).
2106 Unlike most other C compilers, GCC allows you to use @samp{-g} with
2107 @samp{-O}.  The shortcuts taken by optimized code may occasionally
2108 produce surprising results: some variables you declared may not exist
2109 at all; flow of control may briefly move where you did not expect it;
2110 some statements may not be executed because they compute constant
2111 results or their values were already at hand; some statements may
2112 execute in different places because they were moved out of loops.
2114 Nevertheless it proves possible to debug optimized output.  This makes
2115 it reasonable to use the optimizer for programs that might have bugs.
2117 The following options are useful when GCC is generated with the
2118 capability for more than one debugging format.
2120 @item -ggdb
2121 Produce debugging information for use by GDB.  This means to use the
2122 most expressive format available (DWARF 2, stabs, or the native format
2123 if neither of those are supported), including GDB extensions if at all
2124 possible.
2126 @item -gstabs
2127 Produce debugging information in stabs format (if that is supported),
2128 without GDB extensions.  This is the format used by DBX on most BSD
2129 systems.  On MIPS, Alpha and System V Release 4 systems this option
2130 produces stabs debugging output which is not understood by DBX or SDB.
2131 On System V Release 4 systems this option requires the GNU assembler.
2133 @item -gstabs+
2134 Produce debugging information in stabs format (if that is supported),
2135 using GNU extensions understood only by the GNU debugger (GDB).  The
2136 use of these extensions is likely to make other debuggers crash or
2137 refuse to read the program.
2139 @item -gcoff
2140 Produce debugging information in COFF format (if that is supported).
2141 This is the format used by SDB on most System V systems prior to
2142 System V Release 4.
2144 @item -gxcoff
2145 Produce debugging information in XCOFF format (if that is supported).
2146 This is the format used by the DBX debugger on IBM RS/6000 systems.
2148 @item -gxcoff+
2149 Produce debugging information in XCOFF format (if that is supported),
2150 using GNU extensions understood only by the GNU debugger (GDB).  The
2151 use of these extensions is likely to make other debuggers crash or
2152 refuse to read the program, and may cause assemblers other than the GNU
2153 assembler (GAS) to fail with an error.
2155 @item -gdwarf
2156 Produce debugging information in DWARF version 1 format (if that is
2157 supported).  This is the format used by SDB on most System V Release 4
2158 systems.
2160 @item -gdwarf+
2161 Produce debugging information in DWARF version 1 format (if that is
2162 supported), using GNU extensions understood only by the GNU debugger
2163 (GDB).  The use of these extensions is likely to make other debuggers
2164 crash or refuse to read the program.
2166 @item -gdwarf-2
2167 Produce debugging information in DWARF version 2 format (if that is
2168 supported).  This is the format used by DBX on IRIX 6.
2170 @item -g@var{level}
2171 @itemx -ggdb@var{level}
2172 @itemx -gstabs@var{level}
2173 @itemx -gcoff@var{level}
2174 @itemx -gxcoff@var{level}
2175 @itemx -gdwarf@var{level}
2176 @itemx -gdwarf-2@var{level}
2177 Request debugging information and also use @var{level} to specify how
2178 much information.  The default level is 2.
2180 Level 1 produces minimal information, enough for making backtraces in
2181 parts of the program that you don't plan to debug.  This includes
2182 descriptions of functions and external variables, but no information
2183 about local variables and no line numbers.
2185 Level 3 includes extra information, such as all the macro definitions
2186 present in the program.  Some debuggers support macro expansion when
2187 you use @samp{-g3}.
2189 @cindex @code{prof}
2190 @item -p
2191 Generate extra code to write profile information suitable for the
2192 analysis program @code{prof}.  You must use this option when compiling
2193 the source files you want data about, and you must also use it when
2194 linking.
2196 @cindex @code{gprof}
2197 @item -pg
2198 Generate extra code to write profile information suitable for the
2199 analysis program @code{gprof}.  You must use this option when compiling
2200 the source files you want data about, and you must also use it when
2201 linking.
2203 @cindex @code{tcov}
2204 @item -a
2205 Generate extra code to write profile information for basic blocks, which will
2206 record the number of times each basic block is executed, the basic block start
2207 address, and the function name containing the basic block.  If @samp{-g} is
2208 used, the line number and filename of the start of the basic block will also be
2209 recorded.  If not overridden by the machine description, the default action is
2210 to append to the text file @file{bb.out}.
2212 This data could be analyzed by a program like @code{tcov}.  Note,
2213 however, that the format of the data is not what @code{tcov} expects.
2214 Eventually GNU @code{gprof} should be extended to process this data.
2216 @item -Q
2217 Makes the compiler print out each function name as it is compiled, and
2218 print some statistics about each pass when it finishes.
2220 @item -ax
2221 Generate extra code to profile basic blocks.  Your executable will
2222 produce output that is a superset of that produced when @samp{-a} is
2223 used.  Additional output is the source and target address of the basic
2224 blocks where a jump takes place, the number of times a jump is executed,
2225 and (optionally) the complete sequence of basic blocks being executed.
2226 The output is appended to file @file{bb.out}.
2228 You can examine different profiling aspects without recompilation.  Your
2229 executable will read a list of function names from file @file{bb.in}.
2230 Profiling starts when a function on the list is entered and stops when
2231 that invocation is exited.  To exclude a function from profiling, prefix
2232 its name with `-'.  If a function name is not unique, you can
2233 disambiguate it by writing it in the form
2234 @samp{/path/filename.d:functionname}.  Your executable will write the
2235 available paths and filenames in file @file{bb.out}.
2237 Several function names have a special meaning:
2238 @table @code
2239 @item __bb_jumps__
2240 Write source, target and frequency of jumps to file @file{bb.out}.
2241 @item __bb_hidecall__
2242 Exclude function calls from frequency count.
2243 @item __bb_showret__
2244 Include function returns in frequency count.
2245 @item __bb_trace__
2246 Write the sequence of basic blocks executed to file @file{bbtrace.gz}.
2247 The file will be compressed using the program @samp{gzip}, which must
2248 exist in your @code{PATH}.  On systems without the @samp{popen}
2249 function, the file will be named @file{bbtrace} and will not be
2250 compressed.  @strong{Profiling for even a few seconds on these systems
2251 will produce a very large file.}  Note: @code{__bb_hidecall__} and
2252 @code{__bb_showret__} will not affect the sequence written to
2253 @file{bbtrace.gz}.
2254 @end table
2256 Here's a short example using different profiling parameters
2257 in file @file{bb.in}.  Assume function @code{foo} consists of basic blocks
2258 1 and 2 and is called twice from block 3 of function @code{main}.  After
2259 the calls, block 3 transfers control to block 4 of @code{main}.
2261 With @code{__bb_trace__} and @code{main} contained in file @file{bb.in},
2262 the following sequence of blocks is written to file @file{bbtrace.gz}:
2263 0 3 1 2 1 2 4.  The return from block 2 to block 3 is not shown, because
2264 the return is to a point inside the block and not to the top.  The
2265 block address 0 always indicates, that control is transferred
2266 to the trace from somewhere outside the observed functions.  With
2267 @samp{-foo} added to @file{bb.in}, the blocks of function
2268 @code{foo} are removed from the trace, so only 0 3 4 remains.
2270 With @code{__bb_jumps__} and @code{main} contained in file @file{bb.in},
2271 jump frequencies will be written to file @file{bb.out}.  The
2272 frequencies are obtained by constructing a trace of blocks
2273 and incrementing a counter for every neighbouring pair of blocks
2274 in the trace.  The trace 0 3 1 2 1 2 4 displays the following
2275 frequencies:
2277 @example
2278 Jump from block 0x0 to block 0x3 executed 1 time(s)
2279 Jump from block 0x3 to block 0x1 executed 1 time(s)
2280 Jump from block 0x1 to block 0x2 executed 2 time(s)
2281 Jump from block 0x2 to block 0x1 executed 1 time(s)
2282 Jump from block 0x2 to block 0x4 executed 1 time(s)
2283 @end example
2285 With @code{__bb_hidecall__}, control transfer due to call instructions
2286 is removed from the trace, that is the trace is cut into three parts: 0
2287 3 4, 0 1 2 and 0 1 2.  With @code{__bb_showret__}, control transfer due
2288 to return instructions is added to the trace.  The trace becomes: 0 3 1
2289 2 3 1 2 3 4.  Note, that this trace is not the same, as the sequence
2290 written to @file{bbtrace.gz}.  It is solely used for counting jump
2291 frequencies.
2293 @item -fprofile-arcs
2294 Instrument @dfn{arcs} during compilation.  For each function of your
2295 program, GCC creates a program flow graph, then finds a spanning tree
2296 for the graph.  Only arcs that are not on the spanning tree have to be
2297 instrumented: the compiler adds code to count the number of times that these
2298 arcs are executed.  When an arc is the only exit or only entrance to a
2299 block, the instrumentation code can be added to the block; otherwise, a
2300 new basic block must be created to hold the instrumentation code.
2302 Since not every arc in the program must be instrumented, programs
2303 compiled with this option run faster than programs compiled with
2304 @samp{-a}, which adds instrumentation code to every basic block in the
2305 program.  The tradeoff: since @code{gcov} does not have
2306 execution counts for all branches, it must start with the execution
2307 counts for the instrumented branches, and then iterate over the program
2308 flow graph until the entire graph has been solved.  Hence, @code{gcov}
2309 runs a little more slowly than a program which uses information from
2310 @samp{-a}.
2312 @samp{-fprofile-arcs} also makes it possible to estimate branch
2313 probabilities, and to calculate basic block execution counts.  In
2314 general, basic block execution counts do not give enough information to
2315 estimate all branch probabilities.  When the compiled program exits, it
2316 saves the arc execution counts to a file called
2317 @file{@var{sourcename}.da}.  Use the compiler option
2318 @samp{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2319 Control Optimization}) when recompiling, to optimize using estimated
2320 branch probabilities.
2322 @need 2000
2323 @item -ftest-coverage
2324 Create data files for the @code{gcov} code-coverage utility
2325 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
2326 The data file names begin with the name of your source file:
2328 @table @code
2329 @item @var{sourcename}.bb
2330 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2331 associate basic block execution counts with line numbers.
2333 @item @var{sourcename}.bbg
2334 A list of all arcs in the program flow graph.  This allows @code{gcov}
2335 to reconstruct the program flow graph, so that it can compute all basic
2336 block and arc execution counts from the information in the
2337 @code{@var{sourcename}.da} file (this last file is the output from
2338 @samp{-fprofile-arcs}).
2339 @end table
2341 @item -d@var{letters}
2342 Says to make debugging dumps during compilation at times specified by
2343 @var{letters}.  This is used for debugging the compiler.  The file names
2344 for most of the dumps are made by appending a pass number and a word to
2345 the source file name (e.g.  @file{foo.c.00.rtl} or @file{foo.c.01.sibling}). 
2346 Here are the possible letters for use in @var{letters}, and their meanings:
2348 @table @samp
2349 @item A
2350 Annotate the assembler output with miscellaneous debugging information.
2351 @item b
2352 Dump after computing branch probabilities, to @file{@var{file}.11.bp}.
2353 @item B
2354 Dump after block reordering, to @file{@var{file}.26.bbro}.
2355 @item c
2356 Dump after instruction combination, to the file @file{@var{file}.14.combine}.
2357 @item C
2358 Dump after the first if conversion, to the file @file{@var{file}.15.ce}.
2359 @item d
2360 Dump after delayed branch scheduling, to @file{@var{file}.29.dbr}.
2361 @item D
2362 Dump all macro definitions, at the end of preprocessing, in addition to
2363 normal output.
2364 @item e
2365 Dump after SSA optimizations, to @file{@var{file}.05.ssa} and
2366 @file{@var{file}.06.ussa}.
2367 @item E
2368 Dump after the second if conversion, to @file{@var{file}.24.ce2}.
2369 @item f
2370 Dump after life analysis, to @file{@var{file}.13.life}.
2371 @item F
2372 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.04.addressof}.
2373 @item g
2374 Dump after global register allocation, to @file{@var{file}.19.greg}.
2375 @item o
2376 Dump after post-reload CSE and other optimizations, to @file{@var{file}.20.postreload}.
2377 @item G      
2378 Dump after GCSE, to @file{@var{file}.08.gcse}.
2379 @item i
2380 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
2381 @item j
2382 Dump after the first jump optimization, to @file{@var{file}.02.jump}.
2383 @item J
2384 Dump after the last jump optimization, to @file{@var{file}.27.jump2}.
2385 @item k
2386 Dump after conversion from registers to stack, to @file{@var{file}.29.stack}.
2387 @item l
2388 Dump after local register allocation, to @file{@var{file}.18.lreg}.
2389 @item L
2390 Dump after loop optimization, to @file{@var{file}.09.loop}.
2391 @item M
2392 Dump after performing the machine dependent reorganisation pass, to
2393 @file{@var{file}.28.mach}. 
2394 @item n
2395 Dump after register renumbering, to @file{@var{file}.23.rnreg}.
2396 @item N
2397 Dump after the register move pass, to @file{@var{file}.16.regmove}.
2398 @item r
2399 Dump after RTL generation, to @file{@var{file}.00.rtl}.
2400 @item R
2401 Dump after the second instruction scheduling pass, to
2402 @file{@var{file}.25.sched2}.
2403 @item s
2404 Dump after CSE (including the jump optimization that sometimes follows
2405 CSE), to @file{@var{file}.03.cse}. 
2406 @item S
2407 Dump after the first instruction scheduling pass, to
2408 @file{@var{file}.17.sched}.
2409 @item t
2410 Dump after the second CSE pass (including the jump optimization that
2411 sometimes follows CSE), to @file{@var{file}.10.cse2}.
2412 @item w
2413 Dump after the second flow pass, to @file{@var{file}.21.flow2}.
2414 @item X
2415 Dump after dead code elimination, to @file{@var{file}.06.dce}.
2416 @item z
2417 Dump after the peephole pass, to @file{@var{file}.22.peephole2}.
2418 @item a
2419 Produce all the dumps listed above.
2420 @item m
2421 Print statistics on memory usage, at the end of the run, to
2422 standard error.
2423 @item p
2424 Annotate the assembler output with a comment indicating which
2425 pattern and alternative was used.  The length of each instruction is
2426 also printed.
2427 @item P
2428 Dump the RTL in the assembler output as a comment before each instruction.
2429 Also turns on @samp{-dp} annotation.
2430 @item v
2431 For each of the other indicated dump files (except for
2432 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
2433 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
2434 @item x
2435 Just generate RTL for a function instead of compiling it.  Usually used
2436 with @samp{r}.
2437 @item y
2438 Dump debugging information during parsing, to standard error.
2439 @end table
2441 @item -fdump-unnumbered
2442 When doing debugging dumps (see -d option above), suppress instruction
2443 numbers and line number note output.  This makes it more feasible to
2444 use diff on debugging dumps for compiler invocations with different
2445 options, in particular with and without -g.
2447 @item -fdump-translation-unit-@var{file} (C++ only)
2448 Dump a representation of the tree structure for the entire translation
2449 unit to @var{file}.
2451 @item -fpretend-float
2452 When running a cross-compiler, pretend that the target machine uses the
2453 same floating point format as the host machine.  This causes incorrect
2454 output of the actual floating constants, but the actual instruction
2455 sequence will probably be the same as GCC would make when running on
2456 the target machine.
2458 @item -save-temps
2459 Store the usual ``temporary'' intermediate files permanently; place them
2460 in the current directory and name them based on the source file.  Thus,
2461 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
2462 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.
2464 @item -time
2465 Report the CPU time taken by each subprocess in the compilation
2466 sequence.  For C source files, this is the preprocessor, compiler
2467 proper, and assembler.  The output looks like this:
2469 @smallexample
2470 # cpp 0.04 0.04
2471 # cc1 0.12 0.01
2472 # as 0.00 0.01
2473 @end smallexample
2475 The first number on each line is the ``user time,'' that is time spent
2476 executing the program itself.  The second number is ``system time,''
2477 time spent executing operating system routines on behalf of the program.
2478 Both numbers are in seconds.
2480 @item -print-file-name=@var{library}
2481 Print the full absolute name of the library file @var{library} that
2482 would be used when linking---and don't do anything else.  With this
2483 option, GCC does not compile or link anything; it just prints the
2484 file name.
2486 @item -print-prog-name=@var{program}
2487 Like @samp{-print-file-name}, but searches for a program such as @samp{cpp}.
2489 @item -print-libgcc-file-name
2490 Same as @samp{-print-file-name=libgcc.a}.
2492 This is useful when you use @samp{-nostdlib} or @samp{-nodefaultlibs}
2493 but you do want to link with @file{libgcc.a}.  You can do
2495 @example
2496 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
2497 @end example
2499 @item -print-search-dirs
2500 Print the name of the configured installation directory and a list of
2501 program and library directories gcc will search---and don't do anything else.
2503 This is useful when gcc prints the error message
2504 @samp{installation problem, cannot exec cpp: No such file or directory}.
2505 To resolve this you either need to put @file{cpp} and the other compiler
2506 components where gcc expects to find them, or you can set the environment
2507 variable @code{GCC_EXEC_PREFIX} to the directory where you installed them.
2508 Don't forget the trailing '/'.
2509 @xref{Environment Variables}.
2510 @end table
2512 @node Optimize Options
2513 @section Options That Control Optimization
2514 @cindex optimize options
2515 @cindex options, optimization
2517 These options control various sorts of optimizations:
2519 @table @code
2520 @item -O
2521 @itemx -O1
2522 Optimize.  Optimizing compilation takes somewhat more time, and a lot
2523 more memory for a large function.
2525 Without @samp{-O}, the compiler's goal is to reduce the cost of
2526 compilation and to make debugging produce the expected results.
2527 Statements are independent: if you stop the program with a breakpoint
2528 between statements, you can then assign a new value to any variable or
2529 change the program counter to any other statement in the function and
2530 get exactly the results you would expect from the source code.
2532 Without @samp{-O}, the compiler only allocates variables declared
2533 @code{register} in registers.  The resulting compiled code is a little
2534 worse than produced by PCC without @samp{-O}.
2536 With @samp{-O}, the compiler tries to reduce code size and execution
2537 time.
2539 When you specify @samp{-O}, the compiler turns on @samp{-fthread-jumps}
2540 and @samp{-fdefer-pop} on all machines.  The compiler turns on
2541 @samp{-fdelayed-branch} on machines that have delay slots, and
2542 @samp{-fomit-frame-pointer} on machines that can support debugging even
2543 without a frame pointer.  On some machines the compiler also turns
2544 on other flags.@refill
2546 @item -O2
2547 Optimize even more.  GCC performs nearly all supported optimizations
2548 that do not involve a space-speed tradeoff.  The compiler does not
2549 perform loop unrolling or function inlining when you specify @samp{-O2}.
2550 As compared to @samp{-O}, this option increases both compilation time
2551 and the performance of the generated code.
2553 @samp{-O2} turns on all optional optimizations except for loop unrolling,
2554 function inlining, and register renaming.  It also turns on the
2555 @samp{-fforce-mem} option on all machines and frame pointer elimination
2556 on machines where doing so does not interfere with debugging.
2558 @item -O3
2559 Optimize yet more.  @samp{-O3} turns on all optimizations specified by
2560 @samp{-O2} and also turns on the @samp{-finline-functions} and
2561 @samp{-frename-registers} options.
2563 @item -O0
2564 Do not optimize.
2566 @item -Os
2567 Optimize for size.  @samp{-Os} enables all @samp{-O2} optimizations that
2568 do not typically increase code size.  It also performs further
2569 optimizations designed to reduce code size.
2571 If you use multiple @samp{-O} options, with or without level numbers,
2572 the last such option is the one that is effective.
2573 @end table
2575 Options of the form @samp{-f@var{flag}} specify machine-independent
2576 flags.  Most flags have both positive and negative forms; the negative
2577 form of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below,
2578 only one of the forms is listed---the one which is not the default.
2579 You can figure out the other form by either removing @samp{no-} or
2580 adding it.
2582 @table @code
2583 @item -ffloat-store
2584 Do not store floating point variables in registers, and inhibit other
2585 options that might change whether a floating point value is taken from a
2586 register or memory.
2588 @cindex floating point precision
2589 This option prevents undesirable excess precision on machines such as
2590 the 68000 where the floating registers (of the 68881) keep more
2591 precision than a @code{double} is supposed to have.  Similarly for the
2592 x86 architecture.  For most programs, the excess precision does only
2593 good, but a few programs rely on the precise definition of IEEE floating
2594 point.  Use @samp{-ffloat-store} for such programs, after modifying
2595 them to store all pertinent intermediate computations into variables.
2597 @item -fno-default-inline
2598 Do not make member functions inline by default merely because they are
2599 defined inside the class scope (C++ only).  Otherwise, when you specify
2600 @w{@samp{-O}}, member functions defined inside class scope are compiled
2601 inline by default; i.e., you don't need to add @samp{inline} in front of
2602 the member function name.
2604 @item -fno-defer-pop
2605 Always pop the arguments to each function call as soon as that function
2606 returns.  For machines which must pop arguments after a function call,
2607 the compiler normally lets arguments accumulate on the stack for several
2608 function calls and pops them all at once.
2610 @item -fforce-mem
2611 Force memory operands to be copied into registers before doing
2612 arithmetic on them.  This produces better code by making all memory
2613 references potential common subexpressions.  When they are not common
2614 subexpressions, instruction combination should eliminate the separate
2615 register-load.  The @samp{-O2} option turns on this option.
2617 @item -fforce-addr
2618 Force memory address constants to be copied into registers before
2619 doing arithmetic on them.  This may produce better code just as
2620 @samp{-fforce-mem} may.
2622 @item -fomit-frame-pointer
2623 Don't keep the frame pointer in a register for functions that
2624 don't need one.  This avoids the instructions to save, set up and
2625 restore frame pointers; it also makes an extra register available
2626 in many functions.  @strong{It also makes debugging impossible on
2627 some machines.}
2629 @ifset INTERNALS
2630 On some machines, such as the Vax, this flag has no effect, because
2631 the standard calling sequence automatically handles the frame pointer
2632 and nothing is saved by pretending it doesn't exist.  The
2633 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2634 whether a target machine supports this flag.  @xref{Registers}.@refill
2635 @end ifset
2636 @ifclear INTERNALS
2637 On some machines, such as the Vax, this flag has no effect, because
2638 the standard calling sequence automatically handles the frame pointer
2639 and nothing is saved by pretending it doesn't exist.  The
2640 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2641 whether a target machine supports this flag.  @xref{Registers,,Register
2642 Usage, gcc.info, Using and Porting GCC}.@refill
2643 @end ifclear
2645 @item -foptimize-sibling-calls
2646 Optimize sibling and tail recursive calls.
2648 @item -ftrapv
2649 This option generates traps for signed overflow on addition, subtraction,
2650 multiplication operations.
2652 @item -fno-inline
2653 Don't pay attention to the @code{inline} keyword.  Normally this option
2654 is used to keep the compiler from expanding any functions inline.
2655 Note that if you are not optimizing, no functions can be expanded inline.
2657 @item -finline-functions
2658 Integrate all simple functions into their callers.  The compiler
2659 heuristically decides which functions are simple enough to be worth
2660 integrating in this way.
2662 If all calls to a given function are integrated, and the function is
2663 declared @code{static}, then the function is normally not output as
2664 assembler code in its own right.
2666 @item -finline-limit=@var{n}
2667 By default, gcc limits the size of functions that can be inlined.  This flag
2668 allows the control of this limit for functions that are explicitly marked as
2669 inline (ie marked with the inline keyword or defined within the class 
2670 definition in c++).  @var{n} is the size of functions that can be inlined in 
2671 number of pseudo instructions (not counting parameter handling).  The default
2672 value of n is 10000.  Increasing this value can result in more inlined code at
2673 the cost of compilation time and memory consumption.  Decreasing usually makes
2674 the compilation faster and less code will be inlined (which presumably 
2675 means slower programs).  This option is particularly useful for programs that 
2676 use inlining heavily such as those based on recursive templates with c++.
2678 @emph{Note:} pseudo instruction represents, in this particular context, an
2679 abstract measurement of function's size.  In no way, it represents a count
2680 of assembly instructions and as such its exact meaning might change from one
2681 release to an another.
2683 @item -fkeep-inline-functions
2684 Even if all calls to a given function are integrated, and the function
2685 is declared @code{static}, nevertheless output a separate run-time
2686 callable version of the function.  This switch does not affect
2687 @code{extern inline} functions.
2689 @item -fkeep-static-consts
2690 Emit variables declared @code{static const} when optimization isn't turned
2691 on, even if the variables aren't referenced.
2693 GCC enables this option by default.  If you want to force the compiler to
2694 check if the variable was referenced, regardless of whether or not
2695 optimization is turned on, use the @samp{-fno-keep-static-consts} option.
2697 @item -fno-function-cse
2698 Do not put function addresses in registers; make each instruction that
2699 calls a constant function contain the function's address explicitly.
2701 This option results in less efficient code, but some strange hacks
2702 that alter the assembler output may be confused by the optimizations
2703 performed when this option is not used.
2705 @item -ffast-math
2706 This option allows GCC to violate some ANSI or IEEE rules and/or
2707 specifications in the interest of optimizing code for speed.  For
2708 example, it allows the compiler to assume arguments to the @code{sqrt}
2709 function are non-negative numbers and that no floating-point values
2710 are NaNs.
2712 This option should never be turned on by any @samp{-O} option since
2713 it can result in incorrect output for programs which depend on
2714 an exact implementation of IEEE or ANSI rules/specifications for
2715 math functions.
2717 @item -fno-math-errno
2718 Do not set ERRNO after calling math functions that are executed
2719 with a single instruction, e.g., sqrt.  A program that relies on
2720 IEEE exceptions for math error handling may want to use this flag
2721 for speed while maintaining IEEE arithmetic compatibility.
2723 The default is @samp{-fmath-errno}.  The @samp{-ffast-math} option
2724 sets @samp{-fno-math-errno}.
2725 @end table
2727 @c following causes underfulls.. they don't look great, but we deal.
2728 @c --mew 26jan93
2729 The following options control specific optimizations.  The @samp{-O2}
2730 option turns on all of these optimizations except @samp{-funroll-loops}
2731 and @samp{-funroll-all-loops}.  On most machines, the @samp{-O} option
2732 turns on the @samp{-fthread-jumps} and @samp{-fdelayed-branch} options,
2733 but specific machines may handle it differently.
2735 You can use the following flags in the rare cases when ``fine-tuning''
2736 of optimizations to be performed is desired.
2738 @table @code
2739 @item -fstrength-reduce
2740 Perform the optimizations of loop strength reduction and
2741 elimination of iteration variables.
2743 @item -fthread-jumps
2744 Perform optimizations where we check to see if a jump branches to a
2745 location where another comparison subsumed by the first is found.  If
2746 so, the first branch is redirected to either the destination of the
2747 second branch or a point immediately following it, depending on whether
2748 the condition is known to be true or false.
2750 @item -fcse-follow-jumps
2751 In common subexpression elimination, scan through jump instructions
2752 when the target of the jump is not reached by any other path.  For
2753 example, when CSE encounters an @code{if} statement with an
2754 @code{else} clause, CSE will follow the jump when the condition
2755 tested is false.
2757 @item -fcse-skip-blocks
2758 This is similar to @samp{-fcse-follow-jumps}, but causes CSE to
2759 follow jumps which conditionally skip over blocks.  When CSE
2760 encounters a simple @code{if} statement with no else clause,
2761 @samp{-fcse-skip-blocks} causes CSE to follow the jump around the
2762 body of the @code{if}.
2764 @item -frerun-cse-after-loop
2765 Re-run common subexpression elimination after loop optimizations has been
2766 performed.
2768 @item -frerun-loop-opt
2769 Run the loop optimizer twice.
2771 @item -fgcse
2772 Perform a global common subexpression elimination pass.
2773 This pass also performs global constant and copy propagation.
2775 @item -fdelete-null-pointer-checks
2776 Use global dataflow analysis to identify and eliminate useless null
2777 pointer checks.  Programs which rely on NULL pointer dereferences @emph{not}
2778 halting the program may not work properly with this option.  Use
2779 -fno-delete-null-pointer-checks to disable this optimizing for programs
2780 which depend on that behavior.
2782 @item -fexpensive-optimizations
2783 Perform a number of minor optimizations that are relatively expensive.
2785 @item -foptimize-register-moves
2786 @itemx -fregmove
2787 Attempt to reassign register numbers in move instructions and as
2788 operands of other simple instructions in order to maximize the amount of
2789 register tying.  This is especially helpful on machines with two-operand
2790 instructions.  GCC enables this optimization by default with @samp{-O2}
2791 or higher.
2793 Note @code{-fregmove} and @code{-foptimize-register-moves} are the same
2794 optimization.
2796 @item -fdelayed-branch
2797 If supported for the target machine, attempt to reorder instructions
2798 to exploit instruction slots available after delayed branch
2799 instructions.
2801 @item -fschedule-insns
2802 If supported for the target machine, attempt to reorder instructions to
2803 eliminate execution stalls due to required data being unavailable.  This
2804 helps machines that have slow floating point or memory load instructions
2805 by allowing other instructions to be issued until the result of the load
2806 or floating point instruction is required.
2808 @item -fschedule-insns2
2809 Similar to @samp{-fschedule-insns}, but requests an additional pass of
2810 instruction scheduling after register allocation has been done.  This is
2811 especially useful on machines with a relatively small number of
2812 registers and where memory load instructions take more than one cycle.
2814 @item -ffunction-sections
2815 @itemx -fdata-sections
2816 Place each function or data item into its own section in the output
2817 file if the target supports arbitrary sections.  The name of the
2818 function or the name of the data item determines the section's name
2819 in the output file.
2821 Use these options on systems where the linker can perform optimizations
2822 to improve locality of reference in the instruction space.  HPPA
2823 processors running HP-UX and Sparc processors running Solaris 2 have
2824 linkers with such optimizations.  Other systems using the ELF object format
2825 as well as AIX may have these optimizations in the future.
2827 Only use these options when there are significant benefits from doing
2828 so.  When you specify these options, the assembler and linker will
2829 create larger object and executable files and will also be slower.
2830 You will not be able to use @code{gprof} on all systems if you
2831 specify this option and you may have problems with debugging if
2832 you specify both this option and @samp{-g}.
2834 @item -fcaller-saves
2835 Enable values to be allocated in registers that will be clobbered by
2836 function calls, by emitting extra instructions to save and restore the
2837 registers around such calls.  Such allocation is done only when it
2838 seems to result in better code than would otherwise be produced.
2840 This option is always enabled by default on certain machines, usually
2841 those which have no call-preserved registers to use instead.
2843 For all machines, optimization level 2 and higher enables this flag by
2844 default.
2846 @item -funroll-loops
2847 Perform the optimization of loop unrolling.  This is only done for loops
2848 whose number of iterations can be determined at compile time or run time.
2849 @samp{-funroll-loops} implies both @samp{-fstrength-reduce} and
2850 @samp{-frerun-cse-after-loop}.
2852 @item -funroll-all-loops
2853 Perform the optimization of loop unrolling.  This is done for all loops
2854 and usually makes programs run more slowly.  @samp{-funroll-all-loops}
2855 implies @samp{-fstrength-reduce} as well as @samp{-frerun-cse-after-loop}.
2857 @item -fmove-all-movables
2858 Forces all invariant computations in loops to be moved
2859 outside the loop.
2861 @item -freduce-all-givs
2862 Forces all general-induction variables in loops to be
2863 strength-reduced.
2865 @emph{Note:} When compiling programs written in Fortran,
2866 @samp{-fmove-all-movables} and @samp{-freduce-all-givs} are enabled
2867 by default when you use the optimizer.
2869 These options may generate better or worse code; results are highly
2870 dependent on the structure of loops within the source code.
2872 These two options are intended to be removed someday, once
2873 they have helped determine the efficacy of various
2874 approaches to improving loop optimizations.
2876 Please let us (@email{gcc@@gcc.gnu.org} and @email{fortran@@gnu.org})
2877 know how use of these options affects
2878 the performance of your production code.
2879 We're very interested in code that runs @emph{slower}
2880 when these options are @emph{enabled}.
2882 @item -fno-peephole
2883 Disable any machine-specific peephole optimizations.
2885 @item -fbranch-probabilities
2886 After running a program compiled with @samp{-fprofile-arcs}
2887 (@pxref{Debugging Options,, Options for Debugging Your Program or
2888 @code{gcc}}), you can compile it a second time using
2889 @samp{-fbranch-probabilities}, to improve optimizations based on
2890 guessing the path a branch might take.
2892 @ifset INTERNALS
2893 With @samp{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
2894 note on the first instruction of each basic block, and a
2895 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
2896 These can be used to improve optimization.  Currently, they are only
2897 used in one place: in @file{reorg.c}, instead of guessing which path a
2898 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
2899 exactly determine which path is taken more often.
2900 @end ifset
2902 @item -fstrict-aliasing
2903 Allows the compiler to assume the strictest aliasing rules applicable to
2904 the language being compiled.  For C (and C++), this activates
2905 optimizations based on the type of expressions.  In particular, an
2906 object of one type is assumed never to reside at the same address as an
2907 object of a different type, unless the types are almost the same.  For
2908 example, an @code{unsigned int} can alias an @code{int}, but not a
2909 @code{void*} or a @code{double}.  A character type may alias any other
2910 type.  
2912 Pay special attention to code like this:
2913 @example
2914 union a_union @{ 
2915   int i;
2916   double d;
2919 int f() @{
2920   a_union t;
2921   t.d = 3.0;
2922   return t.i;
2924 @end example
2925 The practice of reading from a different union member than the one most
2926 recently written to (called ``type-punning'') is common.  Even with
2927 @samp{-fstrict-aliasing}, type-punning is allowed, provided the memory
2928 is accessed through the union type.  So, the code above will work as
2929 expected.  However, this code might not:
2930 @example
2931 int f() @{ 
2932   a_union t;
2933   int* ip;
2934   t.d = 3.0;
2935   ip = &t.i;
2936   return *ip;
2938 @end example
2940 @ifset INTERNALS
2941 Every language that wishes to perform language-specific alias analysis
2942 should define a function that computes, given an @code{tree}
2943 node, an alias set for the node.  Nodes in different alias sets are not
2944 allowed to alias.  For an example, see the C front-end function
2945 @code{c_get_alias_set}.
2946 @end ifset
2948 @item -falign-functions
2949 @itemx -falign-functions=@var{n}
2950 Align the start of functions to the next power-of-two greater than
2951 @var{n}, skipping up to @var{n} bytes.  For instance,
2952 @samp{-falign-functions=32} aligns functions to the next 32-byte
2953 boundary, but @samp{-falign-functions=24} would align to the next
2954 32-byte boundary only if this can be done by skipping 23 bytes or less.
2956 @samp{-fno-align-functions} and @samp{-falign-functions=1} are
2957 equivalent and mean that functions will not be aligned.
2959 Some assemblers only support this flag when @var{n} is a power of two;
2960 in that case, it is rounded up.
2962 If @var{n} is not specified, use a machine-dependent default.
2964 @item -falign-labels
2965 @itemx -falign-labels=@var{n}
2966 Align all branch targets to a power-of-two boundary, skipping up to
2967 @var{n} bytes like @samp{-falign-functions}.  This option can easily
2968 make code slower, because it must insert dummy operations for when the
2969 branch target is reached in the usual flow of the code.
2971 If @samp{-falign-loops} or @samp{-falign-jumps} are applicable and
2972 are greater than this value, then their values are used instead.
2974 If @var{n} is not specified, use a machine-dependent default which is
2975 very likely to be @samp{1}, meaning no alignment.
2977 @item -falign-loops
2978 @itemx -falign-loops=@var{n}
2979 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
2980 like @samp{-falign-functions}.  The hope is that the loop will be
2981 executed many times, which will make up for any execution of the dummy
2982 operations.
2984 If @var{n} is not specified, use a machine-dependent default.
2986 @item -falign-jumps
2987 @itemx -falign-jumps=@var{n}
2988 Align branch targets to a power-of-two boundary, for branch targets
2989 where the targets can only be reached by jumping, skipping up to @var{n}
2990 bytes like @samp{-falign-functions}.  In this case, no dummy operations
2991 need be executed.
2993 If @var{n} is not specified, use a machine-dependent default.
2995 @item -fssa
2996 Perform optimizations in static single assignment form.  Each function's
2997 flow graph is translated into SSA form, optimizations are performed, and
2998 the flow graph is translated back from SSA form.  User's should not
2999 specify this option, since it is not yet ready for production use.
3001 @item -fdce
3002 Perform dead-code elimination in SSA form.  Requires @samp{-fssa}.  Like
3003 @samp{-fssa}, this is an experimental feature.
3005 @item -fsingle-precision-constant
3006 Treat floating point constant as single precision constant instead of
3007 implicitly converting it to double precision constant.
3009 @item -frename-registers
3010 Attempt to avoid false dependancies in scheduled code by making use
3011 of registers left over after register allocation.  This optimization
3012 will most benefit processors with lots of registers.  It can, however,
3013 make debugging impossible, since variables will no longer stay in
3014 a ``home register''.
3015 @end table
3017 @node Preprocessor Options
3018 @section Options Controlling the Preprocessor
3019 @cindex preprocessor options
3020 @cindex options, preprocessor
3022 These options control the C preprocessor, which is run on each C source
3023 file before actual compilation.
3025 If you use the @samp{-E} option, nothing is done except preprocessing.
3026 Some of these options make sense only together with @samp{-E} because
3027 they cause the preprocessor output to be unsuitable for actual
3028 compilation.
3030 @table @code
3031 @item -include @var{file}
3032 Process @var{file} as input before processing the regular input file.
3033 In effect, the contents of @var{file} are compiled first.  Any @samp{-D}
3034 and @samp{-U} options on the command line are always processed before
3035 @samp{-include @var{file}}, regardless of the order in which they are
3036 written.  All the @samp{-include} and @samp{-imacros} options are
3037 processed in the order in which they are written.
3039 @item -imacros @var{file}
3040 Process @var{file} as input, discarding the resulting output, before
3041 processing the regular input file.  Because the output generated from
3042 @var{file} is discarded, the only effect of @samp{-imacros @var{file}}
3043 is to make the macros defined in @var{file} available for use in the
3044 main input.
3046 Any @samp{-D} and @samp{-U} options on the command line are always
3047 processed before @samp{-imacros @var{file}}, regardless of the order in
3048 which they are written.  All the @samp{-include} and @samp{-imacros}
3049 options are processed in the order in which they are written.
3051 @item -idirafter @var{dir}
3052 @cindex second include path
3053 Add the directory @var{dir} to the second include path.  The directories
3054 on the second include path are searched when a header file is not found
3055 in any of the directories in the main include path (the one that
3056 @samp{-I} adds to).
3058 @item -iprefix @var{prefix}
3059 Specify @var{prefix} as the prefix for subsequent @samp{-iwithprefix}
3060 options.
3062 @item -iwithprefix @var{dir}
3063 Add a directory to the second include path.  The directory's name is
3064 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
3065 specified previously with @samp{-iprefix}.  If you have not specified a
3066 prefix yet, the directory containing the installed passes of the
3067 compiler is used as the default.
3069 @item -iwithprefixbefore @var{dir}
3070 Add a directory to the main include path.  The directory's name is made
3071 by concatenating @var{prefix} and @var{dir}, as in the case of
3072 @samp{-iwithprefix}.
3074 @item -isystem @var{dir}
3075 Add a directory to the beginning of the second include path, marking it
3076 as a system directory, so that it gets the same special treatment as
3077 is applied to the standard system directories.
3079 @item -nostdinc
3080 Do not search the standard system directories for header files.  Only
3081 the directories you have specified with @samp{-I} options (and the
3082 current directory, if appropriate) are searched.  @xref{Directory
3083 Options}, for information on @samp{-I}.
3085 By using both @samp{-nostdinc} and @samp{-I-}, you can limit the include-file
3086 search path to only those directories you specify explicitly.
3088 @item -undef
3089 Do not predefine any nonstandard macros.  (Including architecture flags).
3091 @item -E
3092 Run only the C preprocessor.  Preprocess all the C source files
3093 specified and output the results to standard output or to the
3094 specified output file.
3096 @item -C
3097 Tell the preprocessor not to discard comments.  Used with the
3098 @samp{-E} option.
3100 @item -P
3101 Tell the preprocessor not to generate @samp{#line} directives.
3102 Used with the @samp{-E} option.
3104 @cindex make
3105 @cindex dependencies, make
3106 @item -M
3107 Tell the preprocessor to output a rule suitable for @code{make}
3108 describing the dependencies of each object file.  For each source file,
3109 the preprocessor outputs one @code{make}-rule whose target is the object
3110 file name for that source file and whose dependencies are all the
3111 @code{#include} header files it uses.  This rule may be a single line or
3112 may be continued with @samp{\}-newline if it is long.  The list of rules
3113 is printed on standard output instead of the preprocessed C program.
3115 @samp{-M} implies @samp{-E}.
3117 Another way to specify output of a @code{make} rule is by setting
3118 the environment variable @code{DEPENDENCIES_OUTPUT} (@pxref{Environment
3119 Variables}).
3121 @item -MM
3122 Like @samp{-M} but the output mentions only the user header files
3123 included with @samp{#include "@var{file}"}.  System header files
3124 included with @samp{#include <@var{file}>} are omitted.
3126 @item -MD
3127 Like @samp{-M} but the dependency information is written to a file made by
3128 replacing ".c" with ".d" at the end of the input file names.
3129 This is in addition to compiling the file as specified---@samp{-MD} does
3130 not inhibit ordinary compilation the way @samp{-M} does.
3132 In Mach, you can use the utility @code{md} to merge multiple dependency
3133 files into a single dependency file suitable for using with the @samp{make}
3134 command.
3136 @item -MMD
3137 Like @samp{-MD} except mention only user header files, not system
3138 header files.
3140 @item -MG
3141 Treat missing header files as generated files and assume they live in the
3142 same directory as the source file.  If you specify @samp{-MG}, you
3143 must also specify either @samp{-M} or @samp{-MM}.  @samp{-MG} is not
3144 supported with @samp{-MD} or @samp{-MMD}.
3146 @item -H
3147 Print the name of each header file used, in addition to other normal
3148 activities.
3150 @item -A@var{question}(@var{answer})
3151 Assert the answer @var{answer} for @var{question}, in case it is tested
3152 with a preprocessing conditional such as @samp{#if
3153 #@var{question}(@var{answer})}.  @samp{-A-} disables the standard
3154 assertions that normally describe the target machine.
3156 @item -D@var{macro}
3157 Define macro @var{macro} with the string @samp{1} as its definition.
3159 @item -D@var{macro}=@var{defn}
3160 Define macro @var{macro} as @var{defn}.  All instances of @samp{-D} on
3161 the command line are processed before any @samp{-U} options.
3163 @item -U@var{macro}
3164 Undefine macro @var{macro}.  @samp{-U} options are evaluated after all
3165 @samp{-D} options, but before any @samp{-include} and @samp{-imacros}
3166 options.
3168 @item -dM
3169 Tell the preprocessor to output only a list of the macro definitions
3170 that are in effect at the end of preprocessing.  Used with the @samp{-E}
3171 option.
3173 @item -dD
3174 Tell the preprocessing to pass all macro definitions into the output, in
3175 their proper sequence in the rest of the output.
3177 @item -dN
3178 Like @samp{-dD} except that the macro arguments and contents are omitted.
3179 Only @samp{#define @var{name}} is included in the output.
3181 @item -trigraphs
3182 Support ANSI C trigraphs.  The @samp{-ansi} option also has this effect.
3184 @item -Wp,@var{option}
3185 Pass @var{option} as an option to the preprocessor.  If @var{option}
3186 contains commas, it is split into multiple options at the commas.
3187 @end table
3189 @node Assembler Options
3190 @section Passing Options to the Assembler
3192 @c prevent bad page break with this line
3193 You can pass options to the assembler.
3195 @table @code
3196 @item -Wa,@var{option}
3197 Pass @var{option} as an option to the assembler.  If @var{option}
3198 contains commas, it is split into multiple options at the commas.
3199 @end table
3201 @node Link Options
3202 @section Options for Linking
3203 @cindex link options
3204 @cindex options, linking
3206 These options come into play when the compiler links object files into
3207 an executable output file.  They are meaningless if the compiler is
3208 not doing a link step.
3210 @table @code
3211 @cindex file names
3212 @item @var{object-file-name}
3213 A file name that does not end in a special recognized suffix is
3214 considered to name an object file or library.  (Object files are
3215 distinguished from libraries by the linker according to the file
3216 contents.)  If linking is done, these object files are used as input
3217 to the linker.
3219 @item -c
3220 @itemx -S
3221 @itemx -E
3222 If any of these options is used, then the linker is not run, and
3223 object file names should not be used as arguments.  @xref{Overall
3224 Options}.
3226 @cindex Libraries
3227 @item -l@var{library}
3228 Search the library named @var{library} when linking.
3230 It makes a difference where in the command you write this option; the
3231 linker searches processes libraries and object files in the order they
3232 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
3233 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
3234 to functions in @samp{z}, those functions may not be loaded.
3236 The linker searches a standard list of directories for the library,
3237 which is actually a file named @file{lib@var{library}.a}.  The linker
3238 then uses this file as if it had been specified precisely by name.
3240 The directories searched include several standard system directories
3241 plus any that you specify with @samp{-L}.
3243 Normally the files found this way are library files---archive files
3244 whose members are object files.  The linker handles an archive file by
3245 scanning through it for members which define symbols that have so far
3246 been referenced but not defined.  But if the file that is found is an
3247 ordinary object file, it is linked in the usual fashion.  The only
3248 difference between using an @samp{-l} option and specifying a file name
3249 is that @samp{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
3250 and searches several directories.
3252 @item -lobjc
3253 You need this special case of the @samp{-l} option in order to
3254 link an Objective C program.
3256 @item -nostartfiles
3257 Do not use the standard system startup files when linking.
3258 The standard system libraries are used normally, unless @code{-nostdlib}
3259 or @code{-nodefaultlibs} is used.
3261 @item -nodefaultlibs
3262 Do not use the standard system libraries when linking.
3263 Only the libraries you specify will be passed to the linker.
3264 The standard startup files are used normally, unless @code{-nostartfiles}
3265 is used.  The compiler may generate calls to memcmp, memset, and memcpy
3266 for System V (and ANSI C) environments or to bcopy and bzero for
3267 BSD environments.  These entries are usually resolved by entries in
3268 libc.  These entry points should be supplied through some other
3269 mechanism when this option is specified.
3271 @item -nostdlib
3272 Do not use the standard system startup files or libraries when linking.
3273 No startup files and only the libraries you specify will be passed to
3274 the linker. The compiler may generate calls to memcmp, memset, and memcpy
3275 for System V (and ANSI C) environments or to bcopy and bzero for
3276 BSD environments.  These entries are usually resolved by entries in
3277 libc.  These entry points should be supplied through some other
3278 mechanism when this option is specified.
3280 @cindex @code{-lgcc}, use with @code{-nostdlib}
3281 @cindex @code{-nostdlib} and unresolved references
3282 @cindex unresolved references and @code{-nostdlib}
3283 @cindex @code{-lgcc}, use with @code{-nodefaultlibs}
3284 @cindex @code{-nodefaultlibs} and unresolved references
3285 @cindex unresolved references and @code{-nodefaultlibs}
3286 One of the standard libraries bypassed by @samp{-nostdlib} and
3287 @samp{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
3288 that GCC uses to overcome shortcomings of particular machines, or special
3289 needs for some languages.
3290 @ifset INTERNALS
3291 (@xref{Interface,,Interfacing to GCC Output}, for more discussion of
3292 @file{libgcc.a}.)
3293 @end ifset
3294 @ifclear INTERNALS
3295 (@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
3296 for more discussion of @file{libgcc.a}.)
3297 @end ifclear
3298 In most cases, you need @file{libgcc.a} even when you want to avoid
3299 other standard libraries.  In other words, when you specify @samp{-nostdlib}
3300 or @samp{-nodefaultlibs} you should usually specify @samp{-lgcc} as well.
3301 This ensures that you have no unresolved references to internal GCC
3302 library subroutines.  (For example, @samp{__main}, used to ensure C++
3303 constructors will be called; @pxref{Collect2,,@code{collect2}}.)
3305 @item -s
3306 Remove all symbol table and relocation information from the executable.
3308 @item -static
3309 On systems that support dynamic linking, this prevents linking with the shared
3310 libraries.  On other systems, this option has no effect.
3312 @item -shared
3313 Produce a shared object which can then be linked with other objects to
3314 form an executable.  Not all systems support this option.  For predictable
3315 results, you must also specify the same set of options that were used to 
3316 generate code (@samp{-fpic}, @samp{-fPIC}, or model suboptions)
3317 when you specify this option.@footnote{On some systems, @code{gcc -shared}
3318 needs to build supplementary stub code for constructors to work. On
3319 multi-libbed systems, @code{gcc -shared} must select the correct support
3320 libraries to link against.  Failing to supply the correct flags may lead
3321 to subtle defects. Supplying them in cases where they are not necessary
3322 is innocuous.}
3324 @item -symbolic
3325 Bind references to global symbols when building a shared object.  Warn
3326 about any unresolved references (unless overridden by the link editor
3327 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
3328 this option.
3330 @item -Xlinker @var{option}
3331 Pass @var{option} as an option to the linker.  You can use this to
3332 supply system-specific linker options which GCC does not know how to
3333 recognize.
3335 If you want to pass an option that takes an argument, you must use
3336 @samp{-Xlinker} twice, once for the option and once for the argument.
3337 For example, to pass @samp{-assert definitions}, you must write
3338 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
3339 @samp{-Xlinker "-assert definitions"}, because this passes the entire
3340 string as a single argument, which is not what the linker expects.
3342 @item -Wl,@var{option}
3343 Pass @var{option} as an option to the linker.  If @var{option} contains
3344 commas, it is split into multiple options at the commas.
3346 @item -u @var{symbol}
3347 Pretend the symbol @var{symbol} is undefined, to force linking of
3348 library modules to define it.  You can use @samp{-u} multiple times with
3349 different symbols to force loading of additional library modules.
3350 @end table
3352 @node Directory Options
3353 @section Options for Directory Search
3354 @cindex directory options
3355 @cindex options, directory search
3356 @cindex search path
3358 These options specify directories to search for header files, for
3359 libraries and for parts of the compiler:
3361 @table @code
3362 @item -I@var{dir}
3363 Add the directory @var{dir} to the head of the list of directories to be
3364 searched for header files.  This can be used to override a system header
3365 file, substituting your own version, since these directories are
3366 searched before the system header file directories.  If you use more
3367 than one @samp{-I} option, the directories are scanned in left-to-right
3368 order; the standard system directories come after.
3370 @item -I-
3371 Any directories you specify with @samp{-I} options before the @samp{-I-}
3372 option are searched only for the case of @samp{#include "@var{file}"};
3373 they are not searched for @samp{#include <@var{file}>}.
3375 If additional directories are specified with @samp{-I} options after
3376 the @samp{-I-}, these directories are searched for all @samp{#include}
3377 directives.  (Ordinarily @emph{all} @samp{-I} directories are used
3378 this way.)
3380 In addition, the @samp{-I-} option inhibits the use of the current
3381 directory (where the current input file came from) as the first search
3382 directory for @samp{#include "@var{file}"}.  There is no way to
3383 override this effect of @samp{-I-}.  With @samp{-I.} you can specify
3384 searching the directory which was current when the compiler was
3385 invoked.  That is not exactly the same as what the preprocessor does
3386 by default, but it is often satisfactory.
3388 @samp{-I-} does not inhibit the use of the standard system directories
3389 for header files.  Thus, @samp{-I-} and @samp{-nostdinc} are
3390 independent.
3392 @item -L@var{dir}
3393 Add directory @var{dir} to the list of directories to be searched
3394 for @samp{-l}.
3396 @item -B@var{prefix}
3397 This option specifies where to find the executables, libraries,
3398 include files, and data files of the compiler itself.
3400 The compiler driver program runs one or more of the subprograms
3401 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
3402 @var{prefix} as a prefix for each program it tries to run, both with and
3403 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
3405 For each subprogram to be run, the compiler driver first tries the
3406 @samp{-B} prefix, if any.  If that name is not found, or if @samp{-B}
3407 was not specified, the driver tries two standard prefixes, which are
3408 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
3409 those results in a file name that is found, the unmodified program
3410 name is searched for using the directories specified in your
3411 @samp{PATH} environment variable.
3413 @samp{-B} prefixes that effectively specify directory names also apply
3414 to libraries in the linker, because the compiler translates these
3415 options into @samp{-L} options for the linker.  They also apply to
3416 includes files in the preprocessor, because the compiler translates these
3417 options into @samp{-isystem} options for the preprocessor.  In this case,
3418 the compiler appends @samp{include} to the prefix.
3420 The run-time support file @file{libgcc.a} can also be searched for using
3421 the @samp{-B} prefix, if needed.  If it is not found there, the two
3422 standard prefixes above are tried, and that is all.  The file is left
3423 out of the link if it is not found by those means.
3425 Another way to specify a prefix much like the @samp{-B} prefix is to use
3426 the environment variable @code{GCC_EXEC_PREFIX}.  @xref{Environment
3427 Variables}.
3429 @item -specs=@var{file}
3430 Process @var{file} after the compiler reads in the standard @file{specs}
3431 file, in order to override the defaults that the @file{gcc} driver
3432 program uses when determining what switches to pass to @file{cc1},
3433 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
3434 @samp{-specs=}@var{file} can be specified on the command line, and they
3435 are processed in order, from left to right.
3436 @end table
3438 @node Spec Files
3439 @section Specifying subprocesses and the switches to pass to them
3440 @cindex Spec Files
3441 @code{GCC} is a driver program.  It performs its job by invoking a
3442 sequence of other programs to do the work of compiling, assembling and
3443 linking.  GCC interprets its command-line parameters and uses these to
3444 deduce which programs it should invoke, and which command-line options
3445 it ought to place on their command lines.  This behaviour is controlled
3446 by @dfn{spec strings}.  In most cases there is one spec string for each
3447 program that GCC can invoke, but a few programs have multiple spec
3448 strings to control their behaviour.  The spec strings built into GCC can
3449 be overridden by using the @samp{-specs=} command-line switch to specify
3450 a spec file.
3452 @dfn{Spec files} are plaintext files that are used to construct spec
3453 strings.  They consist of a sequence of directives separated by blank
3454 lines.  The type of directive is determined by the first non-whitespace
3455 character on the line and it can be one of the following:
3457 @table @code
3458 @item %@var{command}
3459 Issues a @var{command} to the spec file processor.  The commands that can
3460 appear here are: 
3462 @table @code
3463 @item %include <@var{file}>
3464 @cindex %include
3465 Search for @var{file} and insert its text at the current point in the
3466 specs file.
3468 @item %include_noerr <@var{file}>
3469 @cindex %include_noerr
3470 Just like @samp{%include}, but do not generate an error message if the include
3471 file cannot be found.
3473 @item %rename @var{old_name} @var{new_name}
3474 @cindex %rename
3475 Rename the spec string @var{old_name} to @var{new_name}.
3477 @end table
3479 @item *[@var{spec_name}]:
3480 This tells the compiler to create, override or delete the named spec
3481 string.  All lines after this directive up to the next directive or
3482 blank line are considered to be the text for the spec string.  If this
3483 results in an empty string then the spec will be deleted.  (Or, if the
3484 spec did not exist, then nothing will happened.)  Otherwise, if the spec
3485 does not currently exist a new spec will be created.  If the spec does
3486 exist then its contents will be overridden by the text of this
3487 directive, unless the first character of that text is the @samp{+}
3488 character, in which case the text will be appended to the spec.
3490 @item [@var{suffix}]:
3491 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
3492 and up to the next directive or blank line are considered to make up the
3493 spec string for the indicated suffix.  When the compiler encounters an 
3494 input file with the named suffix, it will processes the spec string in
3495 order to work out how to compile that file.  For example:
3497 @smallexample
3498 .ZZ:
3499 z-compile -input %i
3500 @end smallexample
3502 This says that any input file whose name ends in @samp{.ZZ} should be
3503 passed to the program @samp{z-compile}, which should be invoked with the
3504 command-line switch @samp{-input} and with the result of performing the
3505 @samp{%i} substitution.  (See below.)
3507 As an alternative to providing a spec string, the text that follows a
3508 suffix directive can be one of the following:
3510 @table @code
3511 @item @@@var{language}
3512 This says that the suffix is an alias for a known @var{language}.  This is
3513 similar to using the @code{-x} command-line switch to GCC to specify a
3514 language explicitly.  For example:
3516 @smallexample
3517 .ZZ:
3518 @@c++
3519 @end smallexample
3521 Says that .ZZ files are, in fact, C++ source files.
3523 @item #@var{name}
3524 This causes an error messages saying:
3526 @smallexample
3527 @var{name} compiler not installed on this system.
3528 @end smallexample
3529 @end table
3531 GCC already has an extensive list of suffixes built into it.
3532 This directive will add an entry to the end of the list of suffixes, but
3533 since the list is searched from the end backwards, it is effectively
3534 possible to override earlier entries using this technique.
3536 @end table
3538 GCC has the following spec strings built into it.  Spec files can
3539 override these strings or create their own.  Note that individual
3540 targets can also add their own spec strings to this list. 
3542 @smallexample
3543 asm          Options to pass to the assembler
3544 asm_final    Options to pass to the assembler post-processor
3545 cpp          Options to pass to the C preprocessor
3546 cc1          Options to pass to the C compiler
3547 cc1plus      Options to pass to the C++ compiler
3548 endfile      Object files to include at the end of the link
3549 link         Options to pass to the linker
3550 lib          Libraries to include on the command line to the linker
3551 libgcc       Decides which GCC support library to pass to the linker
3552 linker       Sets the name of the linker
3553 predefines   Defines to be passed to the C preprocessor
3554 signed_char  Defines to pass to CPP to say whether @code{char} is signed by default
3555 startfile    Object files to include at the start of the link
3556 @end smallexample
3558 Here is a small example of a spec file:
3560 @smallexample
3561 %rename lib                 old_lib
3563 *lib:
3564 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
3565 @end smallexample
3567 This example renames the spec called @samp{lib} to @samp{old_lib} and
3568 then overrides the previous definition of @samp{lib} with a new one.
3569 The new definition adds in some extra command-line options before
3570 including the text of the old definition.
3572 @dfn{Spec strings} are a list of command-line options to be passed to their
3573 corresponding program.  In addition, the spec strings can contain
3574 @samp{%}-prefixed sequences to substitute variable text or to
3575 conditionally insert text into the command line.  Using these constructs
3576 it is possible to generate quite complex command lines.
3578 Here is a table of all defined @samp{%}-sequences for spec
3579 strings.  Note that spaces are not generated automatically around the
3580 results of expanding these sequences.  Therefore you can concatenate them
3581 together or combine them with constant text in a single argument. 
3583 @table @code
3584 @item %%
3585 Substitute one @samp{%} into the program name or argument.
3587 @item %i
3588 Substitute the name of the input file being processed.
3590 @item %b
3591 Substitute the basename of the input file being processed.
3592 This is the substring up to (and not including) the last period
3593 and not including the directory.
3595 @item %d
3596 Marks the argument containing or following the @samp{%d} as a
3597 temporary file name, so that that file will be deleted if GCC exits
3598 successfully.  Unlike @samp{%g}, this contributes no text to the
3599 argument. 
3601 @item %g@var{suffix}
3602 Substitute a file name that has suffix @var{suffix} and is chosen
3603 once per compilation, and mark the argument in the same way as
3604 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
3605 name is now chosen in a way that is hard to predict even when previously 
3606 chosen file names are known.  For example, @samp{%g.s ... %g.o ... %g.s}
3607 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
3608 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
3609 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
3610 was simply substituted with a file name chosen once per compilation,
3611 without regard to any appended suffix (which was therefore treated
3612 just like ordinary text), making such attacks more likely to succeed.
3614 @item %u@var{suffix}
3615 Like @samp{%g}, but generates a new temporary file name even if
3616 @samp{%u@var{suffix}} was already seen.
3618 @item %U@var{suffix}
3619 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
3620 new one if there is no such last file name.  In the absence of any
3621 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
3622 the same suffix @emph{space}, so @samp{%g.s ... %U.s ... %g.s ... %U.s}
3623 would involve the generation of two distinct file names, one
3624 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
3625 simply substituted with a file name chosen for the previous @samp{%u},
3626 without regard to any appended suffix.
3628 @item %w
3629 Marks the argument containing or following the @samp{%w} as the
3630 designated output file of this compilation.  This puts the argument
3631 into the sequence of arguments that @samp{%o} will substitute later.
3633 @item %o
3634 Substitutes the names of all the output files, with spaces
3635 automatically placed around them.  You should write spaces
3636 around the @samp{%o} as well or the results are undefined.
3637 @samp{%o} is for use in the specs for running the linker.
3638 Input files whose names have no recognized suffix are not compiled
3639 at all, but they are included among the output files, so they will
3640 be linked.
3642 @item %O
3643 Substitutes the suffix for object files.  Note that this is
3644 handled specially when it immediately follows @samp{%g, %u, or %U},
3645 because of the need for those to form complete file names.  The
3646 handling is such that @samp{%O} is treated exactly as if it had already
3647 been substituted, except that @samp{%g, %u, and %U} do not currently
3648 support additional @var{suffix} characters following @samp{%O} as they would
3649 following, for example, @samp{.o}.
3651 @item %p
3652 Substitutes the standard macro predefinitions for the
3653 current target machine.  Use this when running @code{cpp}.
3655 @item %P
3656 Like @samp{%p}, but puts @samp{__} before and after the name of each
3657 predefined macro, except for macros that start with @samp{__} or with
3658 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ANSI
3659 C.  
3661 @item %I
3662 Substitute a @samp{-iprefix} option made from GCC_EXEC_PREFIX.
3664 @item %s
3665 Current argument is the name of a library or startup file of some sort.
3666 Search for that file in a standard list of directories and substitute
3667 the full name found. 
3669 @item %e@var{str}
3670 Print @var{str} as an error message.  @var{str} is terminated by a newline.
3671 Use this when inconsistent options are detected.
3673 @item %|
3674 Output @samp{-} if the input for the current command is coming from a pipe.
3676 @item %(@var{name})
3677 Substitute the contents of spec string @var{name} at this point.
3679 @item %[@var{name}]
3680 Like @samp{%(...)} but put @samp{__} around @samp{-D} arguments.
3682 @item %x@{@var{option}@}
3683 Accumulate an option for @samp{%X}.
3685 @item %X
3686 Output the accumulated linker options specified by @samp{-Wl} or a @samp{%x}
3687 spec string.
3689 @item %Y
3690 Output the accumulated assembler options specified by @samp{-Wa}.
3692 @item %Z
3693 Output the accumulated preprocessor options specified by @samp{-Wp}.
3695 @item %v1
3696 Substitute the major version number of GCC.
3697 (For version 2.9.5, this is 2.)
3699 @item %v2
3700 Substitute the minor version number of GCC.
3701 (For version 2.9.5, this is 9.)
3703 @item %a
3704 Process the @code{asm} spec.  This is used to compute the
3705 switches to be passed to the assembler.
3707 @item %A
3708 Process the @code{asm_final} spec.  This is a spec string for
3709 passing switches to an assembler post-processor, if such a program is
3710 needed.
3712 @item %l
3713 Process the @code{link} spec.  This is the spec for computing the
3714 command line passed to the linker.  Typically it will make use of the
3715 @samp{%L %G %S %D and %E} sequences.
3717 @item %D
3718 Dump out a @samp{-L} option for each directory that GCC believes might
3719 contain startup files.  If the target supports multilibs then the
3720 current multilib directory will be prepended to each of these paths. 
3722 @item %L
3723 Process the @code{lib} spec.  This is a spec string for deciding which
3724 libraries should be included on the command line to the linker. 
3726 @item %G
3727 Process the @code{libgcc} spec.  This is a spec string for deciding
3728 which GCC support library should be included on the command line to the linker. 
3730 @item %S
3731 Process the @code{startfile} spec.  This is a spec for deciding which
3732 object files should be the first ones passed to the linker.  Typically
3733 this might be a file named @file{crt0.o}. 
3735 @item %E
3736 Process the @code{endfile} spec.  This is a spec string that specifies
3737 the last object files that will be passed to the linker.  
3739 @item %C
3740 Process the @code{cpp} spec.  This is used to construct the arguments
3741 to be passed to the C preprocessor.
3743 @item %c
3744 Process the @code{signed_char} spec.  This is intended to be used
3745 to tell cpp whether a char is signed.  It typically has the definition: 
3746 @smallexample
3747 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
3748 @end smallexample
3750 @item %1
3751 Process the @code{cc1} spec.  This is used to construct the options to be
3752 passed to the actual C compiler (@samp{cc1}).
3754 @item %2
3755 Process the @code{cc1plus} spec.  This is used to construct the options to be
3756 passed to the actual C++ compiler (@samp{cc1plus}).
3758 @item %*
3759 Substitute the variable part of a matched option.  See below.
3760 Note that each comma in the substituted string is replaced by
3761 a single space.
3763 @item %@{@code{S}@}
3764 Substitutes the @code{-S} switch, if that switch was given to GCC.
3765 If that switch was not specified, this substitutes nothing.  Note that
3766 the leading dash is omitted when specifying this option, and it is
3767 automatically inserted if the substitution is performed.  Thus the spec
3768 string @samp{%@{foo@}} would match the command-line option @samp{-foo}
3769 and would output the command line option @samp{-foo}.
3771 @item %W@{@code{S}@}
3772 Like %@{@code{S}@} but mark last argument supplied within as a file to be
3773 deleted on failure. 
3775 @item %@{@code{S}*@}
3776 Substitutes all the switches specified to GCC whose names start
3777 with @code{-S}, but which also take an argument.  This is used for
3778 switches like @samp{-o, -D, -I}, etc.  GCC considers @samp{-o foo} as being
3779 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
3780 text, including the space.  Thus two arguments would be generated. 
3782 @item %@{^@code{S}*@}
3783 Like %@{@code{S}*@}, but don't put a blank between a switch and its
3784 argument.  Thus %@{^o*@} would only generate one argument, not two.
3786 @item %@{<@code{S}@}
3787 Remove all occurrences of @code{-S} from the command line.  Note - this
3788 command is position dependent.  @samp{%} commands in the spec string
3789 before this option will see @code{-S}, @samp{%} commands in the spec
3790 string after this option will not.
3792 @item %@{@code{S}*:@code{X}@}
3793 Substitutes @code{X} if one or more switches whose names start with
3794 @code{-S} are specified to GCC.  Note that the tail part of the
3795 @code{-S} option (i.e. the part matched by the @samp{*}) will be substituted
3796 for each occurrence of @samp{%*} within @code{X}. 
3798 @item %@{@code{S}:@code{X}@}
3799 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC.
3801 @item %@{!@code{S}:@code{X}@}
3802 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC.
3804 @item %@{|@code{S}:@code{X}@}
3805 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
3807 @item %@{|!@code{S}:@code{X}@}
3808 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
3810 @item %@{.@code{S}:@code{X}@}
3811 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
3813 @item %@{!.@code{S}:@code{X}@}
3814 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
3816 @item %@{@code{S}|@code{P}:@code{X}@}
3817 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC.  This may be
3818 combined with @samp{!} and @samp{.} sequences as well, although they
3819 have a stronger binding than the @samp{|}.  For example a spec string
3820 like this:
3822 @smallexample
3823 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
3824 @end smallexample
3826 will output the following command-line options from the following input
3827 command-line options:
3829 @smallexample
3830 fred.c        -foo -baz
3831 jim.d         -bar -boggle
3832 -d fred.c     -foo -baz -boggle
3833 -d jim.d      -bar -baz -boggle
3834 @end smallexample
3836 @end table
3838 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
3839 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
3840 or spaces, or even newlines.  They are processed as usual, as described
3841 above. 
3843 The @samp{-O, -f, -m, and -W} switches are handled specifically in these
3844 constructs.  If another value of @samp{-O} or the negated form of a @samp{-f, -m, or
3845 -W} switch is found later in the command line, the earlier switch
3846 value is ignored, except with @{@code{S}*@} where @code{S} is just one
3847 letter, which passes all matching options.
3849 The character @samp{|} at the beginning of the predicate text is used to indicate
3850 that a command should be piped to the following command, but only if @samp{-pipe}
3851 is specified.
3853 It is built into GCC which switches take arguments and which do not.
3854 (You might think it would be useful to generalize this to allow each
3855 compiler's spec to say which switches take arguments.  But this cannot
3856 be done in a consistent fashion.  GCC cannot even decide which input
3857 files have been specified without knowing which switches take arguments,
3858 and it must know which input files to compile in order to tell which
3859 compilers to run). 
3861 GCC also knows implicitly that arguments starting in @samp{-l} are to be
3862 treated as compiler output files, and passed to the linker in their
3863 proper position among the other output files.
3865 @node Target Options
3866 @section Specifying Target Machine and Compiler Version
3867 @cindex target options
3868 @cindex cross compiling
3869 @cindex specifying machine version
3870 @cindex specifying compiler version and target machine
3871 @cindex compiler version, specifying
3872 @cindex target machine, specifying
3874 By default, GCC compiles code for the same type of machine that you
3875 are using.  However, it can also be installed as a cross-compiler, to
3876 compile for some other type of machine.  In fact, several different
3877 configurations of GCC, for different target machines, can be
3878 installed side by side.  Then you specify which one to use with the
3879 @samp{-b} option.
3881 In addition, older and newer versions of GCC can be installed side
3882 by side.  One of them (probably the newest) will be the default, but
3883 you may sometimes wish to use another.
3885 @table @code
3886 @item -b @var{machine}
3887 The argument @var{machine} specifies the target machine for compilation.
3888 This is useful when you have installed GCC as a cross-compiler.
3890 The value to use for @var{machine} is the same as was specified as the
3891 machine type when configuring GCC as a cross-compiler.  For
3892 example, if a cross-compiler was configured with @samp{configure
3893 i386v}, meaning to compile for an 80386 running System V, then you
3894 would specify @samp{-b i386v} to run that cross compiler.
3896 When you do not specify @samp{-b}, it normally means to compile for
3897 the same type of machine that you are using.
3899 @item -V @var{version}
3900 The argument @var{version} specifies which version of GCC to run.
3901 This is useful when multiple versions are installed.  For example,
3902 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
3904 The default version, when you do not specify @samp{-V}, is the last
3905 version of GCC that you installed.
3906 @end table
3908 The @samp{-b} and @samp{-V} options actually work by controlling part of
3909 the file name used for the executable files and libraries used for
3910 compilation.  A given version of GCC, for a given target machine, is
3911 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.@refill
3913 Thus, sites can customize the effect of @samp{-b} or @samp{-V} either by
3914 changing the names of these directories or adding alternate names (or
3915 symbolic links).  If in directory @file{/usr/local/lib/gcc-lib/} the
3916 file @file{80386} is a link to the file @file{i386v}, then @samp{-b
3917 80386} becomes an alias for @samp{-b i386v}.
3919 In one respect, the @samp{-b} or @samp{-V} do not completely change
3920 to a different compiler: the top-level driver program @code{gcc}
3921 that you originally invoked continues to run and invoke the other
3922 executables (preprocessor, compiler per se, assembler and linker)
3923 that do the real work.  However, since no real work is done in the
3924 driver program, it usually does not matter that the driver program
3925 in use is not the one for the specified target.  It is common for the
3926 interface to the other executables to change incompatibly between
3927 compiler versions, so unless the version specified is very close to that
3928 of the driver (for example, @samp{-V 3.0} with a driver program from GCC
3929 version 3.0.1), use of @samp{-V} may not work; for example, using
3930 @samp{-V 2.95.2} will not work with a driver program from GCC 3.0.
3932 The only way that the driver program depends on the target machine is
3933 in the parsing and handling of special machine-specific options.
3934 However, this is controlled by a file which is found, along with the
3935 other executables, in the directory for the specified version and
3936 target machine.  As a result, a single installed driver program adapts
3937 to any specified target machine, and sufficiently similar compiler
3938 versions.
3940 The driver program executable does control one significant thing,
3941 however: the default version and target machine.  Therefore, you can
3942 install different instances of the driver program, compiled for
3943 different targets or versions, under different names.
3945 For example, if the driver for version 2.0 is installed as @code{ogcc}
3946 and that for version 2.1 is installed as @code{gcc}, then the command
3947 @code{gcc} will use version 2.1 by default, while @code{ogcc} will use
3948 2.0 by default.  However, you can choose either version with either
3949 command with the @samp{-V} option.
3951 @node Submodel Options
3952 @section Hardware Models and Configurations
3953 @cindex submodel options
3954 @cindex specifying hardware config
3955 @cindex hardware models and configurations, specifying
3956 @cindex machine dependent options
3958 Earlier we discussed the standard option @samp{-b} which chooses among
3959 different installed compilers for completely different target
3960 machines, such as Vax vs. 68000 vs. 80386.
3962 In addition, each of these target machine types can have its own
3963 special options, starting with @samp{-m}, to choose among various
3964 hardware models or configurations---for example, 68010 vs 68020,
3965 floating coprocessor or none.  A single installed version of the
3966 compiler can compile for any model or configuration, according to the
3967 options specified.
3969 Some configurations of the compiler also support additional special
3970 options, usually for compatibility with other compilers on the same
3971 platform.
3973 @ifset INTERNALS
3974 These options are defined by the macro @code{TARGET_SWITCHES} in the
3975 machine description.  The default for the options is also defined by
3976 that macro, which enables you to change the defaults.
3977 @end ifset
3979 @menu
3980 * M680x0 Options::
3981 * M68hc1x Options::
3982 * VAX Options::
3983 * SPARC Options::
3984 * Convex Options::
3985 * AMD29K Options::
3986 * ARM Options::
3987 * Thumb Options::
3988 * MN10200 Options::
3989 * MN10300 Options::
3990 * M32R/D Options::
3991 * M88K Options::
3992 * RS/6000 and PowerPC Options::
3993 * RT Options::
3994 * MIPS Options::
3995 * i386 Options::
3996 * HPPA Options::
3997 * Intel 960 Options::
3998 * DEC Alpha Options::
3999 * Clipper Options::
4000 * H8/300 Options::
4001 * SH Options::
4002 * System V Options::
4003 * TMS320C3x/C4x Options::
4004 * V850 Options::
4005 * ARC Options::
4006 * NS32K Options::
4007 * AVR Options::
4008 * MCore Options::
4009 * D30V Options::
4010 @end menu
4012 @node M680x0 Options
4013 @subsection M680x0 Options
4014 @cindex M680x0 options
4016 These are the @samp{-m} options defined for the 68000 series.  The default
4017 values for these options depends on which style of 68000 was selected when
4018 the compiler was configured; the defaults for the most common choices are
4019 given below.
4021 @table @code
4022 @item -m68000
4023 @itemx -mc68000
4024 Generate output for a 68000.  This is the default
4025 when the compiler is configured for 68000-based systems.
4027 Use this option for microcontrollers with a 68000 or EC000 core,
4028 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
4030 @item -m68020
4031 @itemx -mc68020
4032 Generate output for a 68020.  This is the default
4033 when the compiler is configured for 68020-based systems.
4035 @item -m68881
4036 Generate output containing 68881 instructions for floating point.
4037 This is the default for most 68020 systems unless @samp{-nfp} was
4038 specified when the compiler was configured.
4040 @item -m68030
4041 Generate output for a 68030.  This is the default when the compiler is
4042 configured for 68030-based systems.
4044 @item -m68040
4045 Generate output for a 68040.  This is the default when the compiler is
4046 configured for 68040-based systems.
4048 This option inhibits the use of 68881/68882 instructions that have to be
4049 emulated by software on the 68040.  Use this option if your 68040 does not
4050 have code to emulate those instructions.
4052 @item -m68060
4053 Generate output for a 68060.  This is the default when the compiler is
4054 configured for 68060-based systems.
4056 This option inhibits the use of 68020 and 68881/68882 instructions that
4057 have to be emulated by software on the 68060.  Use this option if your 68060
4058 does not have code to emulate those instructions.
4060 @item -mcpu32
4061 Generate output for a CPU32. This is the default
4062 when the compiler is configured for CPU32-based systems.
4064 Use this option for microcontrollers with a
4065 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
4066 68336, 68340, 68341, 68349 and 68360.
4068 @item -m5200
4069 Generate output for a 520X "coldfire" family cpu.  This is the default
4070 when the compiler is configured for 520X-based systems.
4072 Use this option for microcontroller with a 5200 core, including 
4073 the MCF5202, MCF5203, MCF5204 and MCF5202.
4076 @item -m68020-40
4077 Generate output for a 68040, without using any of the new instructions.
4078 This results in code which can run relatively efficiently on either a
4079 68020/68881 or a 68030 or a 68040.  The generated code does use the
4080 68881 instructions that are emulated on the 68040.
4082 @item -m68020-60
4083 Generate output for a 68060, without using any of the new instructions.
4084 This results in code which can run relatively efficiently on either a
4085 68020/68881 or a 68030 or a 68040.  The generated code does use the
4086 68881 instructions that are emulated on the 68060.
4088 @item -mfpa
4089 Generate output containing Sun FPA instructions for floating point.
4091 @item -msoft-float
4092 Generate output containing library calls for floating point.
4093 @strong{Warning:} the requisite libraries are not available for all m68k
4094 targets.  Normally the facilities of the machine's usual C compiler are
4095 used, but this can't be done directly in cross-compilation.  You must
4096 make your own arrangements to provide suitable library functions for
4097 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
4098 @samp{m68k-*-coff} do provide software floating point support.
4100 @item -mshort
4101 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4103 @item -mnobitfield
4104 Do not use the bit-field instructions.  The @samp{-m68000}, @samp{-mcpu32}
4105 and @samp{-m5200} options imply @w{@samp{-mnobitfield}}.
4107 @item -mbitfield
4108 Do use the bit-field instructions.  The @samp{-m68020} option implies
4109 @samp{-mbitfield}.  This is the default if you use a configuration
4110 designed for a 68020.
4112 @item -mrtd
4113 Use a different function-calling convention, in which functions
4114 that take a fixed number of arguments return with the @code{rtd}
4115 instruction, which pops their arguments while returning.  This
4116 saves one instruction in the caller since there is no need to pop
4117 the arguments there.
4119 This calling convention is incompatible with the one normally
4120 used on Unix, so you cannot use it if you need to call libraries
4121 compiled with the Unix compiler.
4123 Also, you must provide function prototypes for all functions that
4124 take variable numbers of arguments (including @code{printf});
4125 otherwise incorrect code will be generated for calls to those
4126 functions.
4128 In addition, seriously incorrect code will result if you call a
4129 function with too many arguments.  (Normally, extra arguments are
4130 harmlessly ignored.)
4132 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
4133 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
4135 @item -malign-int
4136 @itemx -mno-align-int
4137 Control whether GCC aligns @code{int}, @code{long}, @code{long long}, 
4138 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
4139 boundary (@samp{-malign-int}) or a 16-bit boundary (@samp{-mno-align-int}).
4140 Aligning variables on 32-bit boundaries produces code that runs somewhat
4141 faster on processors with 32-bit busses at the expense of more memory.
4143 @strong{Warning:} if you use the @samp{-malign-int} switch, GCC will
4144 align structures containing the above types  differently than
4145 most published application binary interface specifications for the m68k.
4147 @item -mpcrel
4148 Use the pc-relative addressing mode of the 68000 directly, instead of
4149 using a global offset table.  At present, this option implies -fpic,
4150 allowing at most a 16-bit offset for pc-relative addressing.  -fPIC is
4151 not presently supported with -mpcrel, though this could be supported for
4152 68020 and higher processors.
4154 @item -mno-strict-align
4155 @itemx -mstrict-align
4156 @kindex -mstrict-align
4157 Do not (do) assume that unaligned memory references will be handled by
4158 the system.
4160 @end table
4162 @node M68hc1x Options
4163 @subsection M68hc1x Options
4164 @cindex M68hc1x options
4166 These are the @samp{-m} options defined for the 68hc11 and 68hc12
4167 microcontrollers.  The default values for these options depends on 
4168 which style of microcontroller was selected when the compiler was configured;
4169 the defaults for the most common choices are given below.
4171 @table @code
4172 @item -m6811
4173 @itemx -m68hc11
4174 Generate output for a 68HC11.  This is the default
4175 when the compiler is configured for 68HC11-based systems.
4177 @item -m6812
4178 @itemx -m68hc12
4179 Generate output for a 68HC12.  This is the default
4180 when the compiler is configured for 68HC12-based systems.
4182 @item -mauto-incdec
4183 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
4184 addressing modes.
4186 @item -mshort
4187 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4189 @item -msoft-reg-count=@var{count}
4190 Specify the number of pseudo-soft registers which are used for the
4191 code generation.  The maximum number is 32.  Using more pseudo-soft
4192 register may or may not result in better code depending on the program.
4193 The default is 4 for 68HC11 and 2 for 68HC12.
4195 @end table
4197 @node VAX Options
4198 @subsection VAX Options
4199 @cindex VAX options
4201 These @samp{-m} options are defined for the Vax:
4203 @table @code
4204 @item -munix
4205 Do not output certain jump instructions (@code{aobleq} and so on)
4206 that the Unix assembler for the Vax cannot handle across long
4207 ranges.
4209 @item -mgnu
4210 Do output those jump instructions, on the assumption that you
4211 will assemble with the GNU assembler.
4213 @item -mg
4214 Output code for g-format floating point numbers instead of d-format.
4215 @end table
4217 @node SPARC Options
4218 @subsection SPARC Options
4219 @cindex SPARC options
4221 These @samp{-m} switches are supported on the SPARC:
4223 @table @code
4224 @item -mno-app-regs
4225 @itemx -mapp-regs
4226 Specify @samp{-mapp-regs} to generate output using the global registers
4227 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
4228 is the default.
4230 To be fully SVR4 ABI compliant at the cost of some performance loss,
4231 specify @samp{-mno-app-regs}.  You should compile libraries and system
4232 software with this option.
4234 @item -mfpu
4235 @itemx -mhard-float
4236 Generate output containing floating point instructions.  This is the
4237 default.
4239 @item -mno-fpu
4240 @itemx -msoft-float
4241 Generate output containing library calls for floating point.
4242 @strong{Warning:} the requisite libraries are not available for all SPARC
4243 targets.  Normally the facilities of the machine's usual C compiler are
4244 used, but this cannot be done directly in cross-compilation.  You must make
4245 your own arrangements to provide suitable library functions for
4246 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
4247 @samp{sparclite-*-*} do provide software floating point support.
4249 @samp{-msoft-float} changes the calling convention in the output file;
4250 therefore, it is only useful if you compile @emph{all} of a program with
4251 this option.  In particular, you need to compile @file{libgcc.a}, the
4252 library that comes with GCC, with @samp{-msoft-float} in order for
4253 this to work.
4255 @item -mhard-quad-float
4256 Generate output containing quad-word (long double) floating point
4257 instructions.
4259 @item -msoft-quad-float
4260 Generate output containing library calls for quad-word (long double)
4261 floating point instructions.  The functions called are those specified
4262 in the SPARC ABI.  This is the default.
4264 As of this writing, there are no sparc implementations that have hardware
4265 support for the quad-word floating point instructions.  They all invoke
4266 a trap handler for one of these instructions, and then the trap handler
4267 emulates the effect of the instruction.  Because of the trap handler overhead,
4268 this is much slower than calling the ABI library routines.  Thus the
4269 @samp{-msoft-quad-float} option is the default.
4271 @item -mno-epilogue
4272 @itemx -mepilogue
4273 With @samp{-mepilogue} (the default), the compiler always emits code for
4274 function exit at the end of each function.  Any function exit in
4275 the middle of the function (such as a return statement in C) will
4276 generate a jump to the exit code at the end of the function.
4278 With @samp{-mno-epilogue}, the compiler tries to emit exit code inline
4279 at every function exit.
4281 @item -mno-flat
4282 @itemx -mflat
4283 With @samp{-mflat}, the compiler does not generate save/restore instructions
4284 and will use a "flat" or single register window calling convention.
4285 This model uses %i7 as the frame pointer and is compatible with the normal
4286 register window model.  Code from either may be intermixed.
4287 The local registers and the input registers (0-5) are still treated as
4288 "call saved" registers and will be saved on the stack as necessary.
4290 With @samp{-mno-flat} (the default), the compiler emits save/restore
4291 instructions (except for leaf functions) and is the normal mode of operation.
4293 @item -mno-unaligned-doubles
4294 @itemx -munaligned-doubles
4295 Assume that doubles have 8 byte alignment.  This is the default.
4297 With @samp{-munaligned-doubles}, GCC assumes that doubles have 8 byte
4298 alignment only if they are contained in another type, or if they have an
4299 absolute address.  Otherwise, it assumes they have 4 byte alignment.
4300 Specifying this option avoids some rare compatibility problems with code
4301 generated by other compilers.  It is not the default because it results
4302 in a performance loss, especially for floating point code.
4304 @item -mno-faster-structs
4305 @itemx -mfaster-structs
4306 With @samp{-mfaster-structs}, the compiler assumes that structures
4307 should have 8 byte alignment.  This enables the use of pairs of
4308 @code{ldd} and @code{std} instructions for copies in structure
4309 assignment, in place of twice as many @code{ld} and @code{st} pairs.
4310 However, the use of this changed alignment directly violates the Sparc
4311 ABI.  Thus, it's intended only for use on targets where the developer
4312 acknowledges that their resulting code will not be directly in line with
4313 the rules of the ABI.
4315 @item -mv8
4316 @itemx -msparclite
4317 These two options select variations on the SPARC architecture.
4319 By default (unless specifically configured for the Fujitsu SPARClite),
4320 GCC generates code for the v7 variant of the SPARC architecture.
4322 @samp{-mv8} will give you SPARC v8 code.  The only difference from v7
4323 code is that the compiler emits the integer multiply and integer
4324 divide instructions which exist in SPARC v8 but not in SPARC v7.
4326 @samp{-msparclite} will give you SPARClite code.  This adds the integer
4327 multiply, integer divide step and scan (@code{ffs}) instructions which
4328 exist in SPARClite but not in SPARC v7.
4330 These options are deprecated and will be deleted in a future GCC release.
4331 They have been replaced with @samp{-mcpu=xxx}.
4333 @item -mcypress
4334 @itemx -msupersparc
4335 These two options select the processor for which the code is optimised.
4337 With @samp{-mcypress} (the default), the compiler optimizes code for the
4338 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
4339 This is also appropriate for the older SparcStation 1, 2, IPX etc.
4341 With @samp{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
4342 used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
4343 of the full SPARC v8 instruction set.
4345 These options are deprecated and will be deleted in a future GCC release.
4346 They have been replaced with @samp{-mcpu=xxx}.
4348 @item -mcpu=@var{cpu_type}
4349 Set the instruction set, register set, and instruction scheduling parameters
4350 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
4351 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
4352 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
4353 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
4355 Default instruction scheduling parameters are used for values that select
4356 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
4357 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
4359 Here is a list of each supported architecture and their supported
4360 implementations.
4362 @smallexample
4363     v7:             cypress
4364     v8:             supersparc, hypersparc
4365     sparclite:      f930, f934, sparclite86x
4366     sparclet:       tsc701
4367     v9:             ultrasparc
4368 @end smallexample
4370 @item -mtune=@var{cpu_type}
4371 Set the instruction scheduling parameters for machine type
4372 @var{cpu_type}, but do not set the instruction set or register set that the
4373 option @samp{-mcpu=}@var{cpu_type} would.
4375 The same values for @samp{-mcpu=}@var{cpu_type} are used for
4376 @samp{-mtune=}@*@var{cpu_type}, though the only useful values are those that
4377 select a particular cpu implementation: @samp{cypress}, @samp{supersparc},
4378 @samp{hypersparc}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
4379 @samp{tsc701}, @samp{ultrasparc}.
4381 @end table
4383 These @samp{-m} switches are supported in addition to the above
4384 on the SPARCLET processor.
4386 @table @code
4387 @item -mlittle-endian
4388 Generate code for a processor running in little-endian mode.
4390 @item -mlive-g0
4391 Treat register @code{%g0} as a normal register.
4392 GCC will continue to clobber it as necessary but will not assume
4393 it always reads as 0.
4395 @item -mbroken-saverestore
4396 Generate code that does not use non-trivial forms of the @code{save} and
4397 @code{restore} instructions.  Early versions of the SPARCLET processor do
4398 not correctly handle @code{save} and @code{restore} instructions used with
4399 arguments.  They correctly handle them used without arguments.  A @code{save}
4400 instruction used without arguments increments the current window pointer
4401 but does not allocate a new stack frame.  It is assumed that the window
4402 overflow trap handler will properly handle this case as will interrupt
4403 handlers.
4404 @end table
4406 These @samp{-m} switches are supported in addition to the above
4407 on SPARC V9 processors in 64 bit environments.
4409 @table @code
4410 @item -mlittle-endian
4411 Generate code for a processor running in little-endian mode.
4413 @item -m32
4414 @itemx -m64
4415 Generate code for a 32 bit or 64 bit environment.
4416 The 32 bit environment sets int, long and pointer to 32 bits.
4417 The 64 bit environment sets int to 32 bits and long and pointer
4418 to 64 bits.
4420 @item -mcmodel=medlow
4421 Generate code for the Medium/Low code model: the program must be linked
4422 in the low 32 bits of the address space.  Pointers are 64 bits.
4423 Programs can be statically or dynamically linked.
4425 @item -mcmodel=medmid
4426 Generate code for the Medium/Middle code model: the program must be linked
4427 in the low 44 bits of the address space, the text segment must be less than
4428 2G bytes, and data segment must be within 2G of the text segment.
4429 Pointers are 64 bits.
4431 @item -mcmodel=medany
4432 Generate code for the Medium/Anywhere code model: the program may be linked
4433 anywhere in the address space, the text segment must be less than
4434 2G bytes, and data segment must be within 2G of the text segment.
4435 Pointers are 64 bits.
4437 @item -mcmodel=embmedany
4438 Generate code for the Medium/Anywhere code model for embedded systems:
4439 assume a 32 bit text and a 32 bit data segment, both starting anywhere
4440 (determined at link time).  Register %g4 points to the base of the
4441 data segment.  Pointers still 64 bits.
4442 Programs are statically linked, PIC is not supported.
4444 @item -mstack-bias
4445 @itemx -mno-stack-bias
4446 With @samp{-mstack-bias}, GCC assumes that the stack pointer, and
4447 frame pointer if present, are offset by -2047 which must be added back
4448 when making stack frame references.
4449 Otherwise, assume no such offset is present.
4450 @end table
4452 @node Convex Options
4453 @subsection Convex Options
4454 @cindex Convex options
4456 These @samp{-m} options are defined for Convex:
4458 @table @code
4459 @item -mc1
4460 Generate output for C1.  The code will run on any Convex machine.
4461 The preprocessor symbol @code{__convex__c1__} is defined.
4463 @item -mc2
4464 Generate output for C2.  Uses instructions not available on C1.
4465 Scheduling and other optimizations are chosen for max performance on C2.
4466 The preprocessor symbol @code{__convex_c2__} is defined.
4468 @item -mc32
4469 Generate output for C32xx.  Uses instructions not available on C1.
4470 Scheduling and other optimizations are chosen for max performance on C32.
4471 The preprocessor symbol @code{__convex_c32__} is defined.
4473 @item -mc34
4474 Generate output for C34xx.  Uses instructions not available on C1.
4475 Scheduling and other optimizations are chosen for max performance on C34.
4476 The preprocessor symbol @code{__convex_c34__} is defined.
4478 @item -mc38
4479 Generate output for C38xx.  Uses instructions not available on C1.
4480 Scheduling and other optimizations are chosen for max performance on C38.
4481 The preprocessor symbol @code{__convex_c38__} is defined.
4483 @item -margcount
4484 Generate code which puts an argument count in the word preceding each
4485 argument list.  This is compatible with regular CC, and a few programs
4486 may need the argument count word.  GDB and other source-level debuggers
4487 do not need it; this info is in the symbol table.
4489 @item -mnoargcount
4490 Omit the argument count word.  This is the default.
4492 @item -mvolatile-cache
4493 Allow volatile references to be cached.  This is the default.
4495 @item -mvolatile-nocache
4496 Volatile references bypass the data cache, going all the way to memory.
4497 This is only needed for multi-processor code that does not use standard
4498 synchronization instructions.  Making non-volatile references to volatile
4499 locations will not necessarily work.
4501 @item -mlong32
4502 Type long is 32 bits, the same as type int.  This is the default.
4504 @item -mlong64
4505 Type long is 64 bits, the same as type long long.  This option is useless,
4506 because no library support exists for it.
4507 @end table
4509 @node AMD29K Options
4510 @subsection AMD29K Options
4511 @cindex AMD29K options
4513 These @samp{-m} options are defined for the AMD Am29000:
4515 @table @code
4516 @item -mdw
4517 @kindex -mdw
4518 @cindex DW bit (29k)
4519 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
4520 halfword operations are directly supported by the hardware.  This is the
4521 default.
4523 @item -mndw
4524 @kindex -mndw
4525 Generate code that assumes the @code{DW} bit is not set.
4527 @item -mbw
4528 @kindex -mbw
4529 @cindex byte writes (29k)
4530 Generate code that assumes the system supports byte and halfword write
4531 operations.  This is the default.
4533 @item -mnbw
4534 @kindex -mnbw
4535 Generate code that assumes the systems does not support byte and
4536 halfword write operations.  @samp{-mnbw} implies @samp{-mndw}.
4538 @item -msmall
4539 @kindex -msmall
4540 @cindex memory model (29k)
4541 Use a small memory model that assumes that all function addresses are
4542 either within a single 256 KB segment or at an absolute address of less
4543 than 256k.  This allows the @code{call} instruction to be used instead
4544 of a @code{const}, @code{consth}, @code{calli} sequence.
4546 @item -mnormal
4547 @kindex -mnormal
4548 Use the normal memory model: Generate @code{call} instructions only when
4549 calling functions in the same file and @code{calli} instructions
4550 otherwise.  This works if each file occupies less than 256 KB but allows
4551 the entire executable to be larger than 256 KB.  This is the default.
4553 @item -mlarge
4554 Always use @code{calli} instructions.  Specify this option if you expect
4555 a single file to compile into more than 256 KB of code.
4557 @item -m29050
4558 @kindex -m29050
4559 @cindex processor selection (29k)
4560 Generate code for the Am29050.
4562 @item -m29000
4563 @kindex -m29000
4564 Generate code for the Am29000.  This is the default.
4566 @item -mkernel-registers
4567 @kindex -mkernel-registers
4568 @cindex kernel and user registers (29k)
4569 Generate references to registers @code{gr64-gr95} instead of to
4570 registers @code{gr96-gr127}.  This option can be used when compiling
4571 kernel code that wants a set of global registers disjoint from that used
4572 by user-mode code.
4574 Note that when this option is used, register names in @samp{-f} flags
4575 must use the normal, user-mode, names.
4577 @item -muser-registers
4578 @kindex -muser-registers
4579 Use the normal set of global registers, @code{gr96-gr127}.  This is the
4580 default.
4582 @item -mstack-check
4583 @itemx -mno-stack-check
4584 @kindex -mstack-check
4585 @cindex stack checks (29k)
4586 Insert (or do not insert) a call to @code{__msp_check} after each stack
4587 adjustment.  This is often used for kernel code.
4589 @item -mstorem-bug
4590 @itemx -mno-storem-bug
4591 @kindex -mstorem-bug
4592 @cindex storem bug (29k)
4593 @samp{-mstorem-bug} handles 29k processors which cannot handle the
4594 separation of a mtsrim insn and a storem instruction (most 29000 chips
4595 to date, but not the 29050).
4597 @item -mno-reuse-arg-regs
4598 @itemx -mreuse-arg-regs
4599 @kindex -mreuse-arg-regs
4600 @samp{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
4601 registers for copying out arguments.  This helps detect calling a function
4602 with fewer arguments than it was declared with.
4604 @item -mno-impure-text
4605 @itemx -mimpure-text
4606 @kindex -mimpure-text
4607 @samp{-mimpure-text}, used in addition to @samp{-shared}, tells the compiler to
4608 not pass @samp{-assert pure-text} to the linker when linking a shared object.
4610 @item -msoft-float
4611 @kindex -msoft-float
4612 Generate output containing library calls for floating point.
4613 @strong{Warning:} the requisite libraries are not part of GCC.
4614 Normally the facilities of the machine's usual C compiler are used, but
4615 this can't be done directly in cross-compilation.  You must make your
4616 own arrangements to provide suitable library functions for
4617 cross-compilation.
4619 @item -mno-multm
4620 @kindex -mno-multm
4621 Do not generate multm or multmu instructions.  This is useful for some embedded
4622 systems which do not have trap handlers for these instructions.
4623 @end table
4625 @node ARM Options
4626 @subsection ARM Options
4627 @cindex ARM options
4629 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
4630 architectures:
4632 @table @code
4633 @item -mapcs-frame
4634 @kindex -mapcs-frame
4635 Generate a stack frame that is compliant with the ARM Procedure Call
4636 Standard for all functions, even if this is not strictly necessary for
4637 correct execution of the code.  Specifying @samp{-fomit-frame-pointer}
4638 with this option will cause the stack frames not to be generated for
4639 leaf functions.  The default is @samp{-mno-apcs-frame}.
4641 @item -mapcs
4642 @kindex -mapcs
4643 This is a synonym for @samp{-mapcs-frame}.
4645 @item -mapcs-26
4646 @kindex -mapcs-26
4647 Generate code for a processor running with a 26-bit program counter,
4648 and conforming to the function calling standards for the APCS 26-bit
4649 option.  This option replaces the @samp{-m2} and @samp{-m3} options
4650 of previous releases of the compiler.
4652 @item -mapcs-32
4653 @kindex -mapcs-32
4654 Generate code for a processor running with a 32-bit program counter,
4655 and conforming to the function calling standards for the APCS 32-bit
4656 option.  This option replaces the @samp{-m6} option of previous releases
4657 of the compiler.
4659 @item -mapcs-stack-check
4660 @kindex -mapcs-stack-check
4661 @kindex -mno-apcs-stack-check
4662 Generate code to check the amount of stack space available upon entry to
4663 every function (that actually uses some stack space).  If there is
4664 insufficient space available then either the function
4665 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
4666 called, depending upon the amount of stack space required.  The run time
4667 system is required to provide these functions.  The default is
4668 @samp{-mno-apcs-stack-check}, since this produces smaller code.
4670 @item -mapcs-float
4671 @kindex -mapcs-float
4672 @kindex -mno-apcs-float
4673 Pass floating point arguments using the float point registers.  This is
4674 one of the variants of the APCS.  This option is recommended if the
4675 target hardware has a floating point unit or if a lot of floating point
4676 arithmetic is going to be performed by the code.  The default is
4677 @samp{-mno-apcs-float}, since integer only code is slightly increased in
4678 size if @samp{-mapcs-float} is used.
4680 @item -mapcs-reentrant
4681 @kindex -mapcs-reentrant
4682 @kindex -mno-apcs-reentrant
4683 Generate reentrant, position independent code.  This is the equivalent
4684 to specifying the @samp{-fpic} option.  The default is
4685 @samp{-mno-apcs-reentrant}.
4687 @item -mthumb-interwork
4688 @kindex -mthumb-interwork
4689 @kindex -mno-thumb-interwork
4690 Generate code which supports calling between the ARM and THUMB
4691 instruction sets.  Without this option the two instruction sets cannot
4692 be reliably used inside one program.  The default is
4693 @samp{-mno-thumb-interwork}, since slightly larger code is generated
4694 when @samp{-mthumb-interwork} is specified.
4696 @item -mno-sched-prolog
4697 @kindex -mno-sched-prolog
4698 @kindex -msched-prolog
4699 Prevent the reordering of instructions in the function prolog, or the
4700 merging of those instruction with the instructions in the function's
4701 body.  This means that all functions will start with a recognizable set
4702 of instructions (or in fact one of a choice from a small set of
4703 different function prologues), and this information can be used to
4704 locate the start if functions inside an executable piece of code.  The
4705 default is @samp{-msched-prolog}.
4707 @item -mhard-float
4708 Generate output containing floating point instructions.  This is the
4709 default.
4711 @item -msoft-float
4712 Generate output containing library calls for floating point.
4713 @strong{Warning:} the requisite libraries are not available for all ARM
4714 targets.  Normally the facilities of the machine's usual C compiler are
4715 used, but this cannot be done directly in cross-compilation.  You must make
4716 your own arrangements to provide suitable library functions for
4717 cross-compilation.
4719 @samp{-msoft-float} changes the calling convention in the output file;
4720 therefore, it is only useful if you compile @emph{all} of a program with
4721 this option.  In particular, you need to compile @file{libgcc.a}, the
4722 library that comes with GCC, with @samp{-msoft-float} in order for
4723 this to work.
4725 @item -mlittle-endian
4726 Generate code for a processor running in little-endian mode.  This is
4727 the default for all standard configurations.
4729 @item -mbig-endian
4730 Generate code for a processor running in big-endian mode; the default is
4731 to compile code for a little-endian processor.
4733 @item -mwords-little-endian
4734 This option only applies when generating code for big-endian processors.
4735 Generate code for a little-endian word order but a big-endian byte
4736 order.  That is, a byte order of the form @samp{32107654}.  Note: this
4737 option should only be used if you require compatibility with code for
4738 big-endian ARM processors generated by versions of the compiler prior to
4739 2.8.
4741 @item -malignment-traps
4742 @kindex -malignment-traps
4743 Generate code that will not trap if the MMU has alignment traps enabled.
4744 On ARM architectures prior to ARMv4, there were no instructions to
4745 access half-word objects stored in memory.  However, when reading from
4746 memory a feature of the ARM architecture allows a word load to be used,
4747 even if the address is unaligned, and the processor core will rotate the
4748 data as it is being loaded.  This option tells the compiler that such
4749 misaligned accesses will cause a MMU trap and that it should instead
4750 synthesise the access as a series of byte accesses.  The compiler can
4751 still use word accesses to load half-word data if it knows that the
4752 address is aligned to a word boundary.
4754 This option is ignored when compiling for ARM architecture 4 or later,
4755 since these processors have instructions to directly access half-word
4756 objects in memory. 
4757         
4758 @item -mno-alignment-traps
4759 @kindex -mno-alignment-traps
4760 Generate code that assumes that the MMU will not trap unaligned
4761 accesses.  This produces better code when the target instruction set
4762 does not have half-word memory operations (implementations prior to
4763 ARMv4). 
4765 Note that you cannot use this option to access unaligned word objects,
4766 since the processor will only fetch one 32-bit aligned object from
4767 memory. 
4769 The default setting for most targets is -mno-alignment-traps, since
4770 this produces better code when there are no half-word memory
4771 instructions available. 
4773 @item -mshort-load-bytes
4774 @kindex -mshort-load-bytes
4775 This is a depreciated alias for @samp{-malignment-traps}.
4777 @item -mno-short-load-bytes
4778 @kindex -mno-short-load-bytes
4779 This is a depreciated alias for @samp{-mno-alignment-traps}.
4781 @item -mshort-load-words
4782 @kindex -mshort-load-words
4783 This is a depreciated alias for @samp{-mno-alignment-traps}.
4785 @item -mno-short-load-words
4786 @kindex -mno-short-load-words
4787 This is a depreciated alias for @samp{-malignment-traps}.
4789 @item -mbsd
4790 @kindex -mbsd
4791 This option only applies to RISC iX.  Emulate the native BSD-mode
4792 compiler.  This is the default if @samp{-ansi} is not specified.
4794 @item -mxopen
4795 @kindex -mxopen
4796 This option only applies to RISC iX.  Emulate the native X/Open-mode
4797 compiler.
4799 @item -mno-symrename
4800 @kindex -mno-symrename
4801 This option only applies to RISC iX.  Do not run the assembler
4802 post-processor, @samp{symrename}, after code has been assembled.
4803 Normally it is necessary to modify some of the standard symbols in
4804 preparation for linking with the RISC iX C library; this option
4805 suppresses this pass.  The post-processor is never run when the
4806 compiler is built for cross-compilation.
4808 @item -mcpu=<name>
4809 @kindex -mcpu=
4810 This specifies the name of the target ARM processor.  GCC uses this name
4811 to determine what kind of instructions it can use when generating
4812 assembly code.  Permissible names are: arm2, arm250, arm3, arm6, arm60,
4813 arm600, arm610, arm620, arm7, arm7m, arm7d, arm7dm, arm7di, arm7dmi,
4814 arm70, arm700, arm700i, arm710, arm710c, arm7100, arm7500, arm7500fe,
4815 arm7tdmi, arm8, strongarm, strongarm110, strongarm1100, arm8, arm810,
4816 arm9, arm920, arm920t, arm9tdmi.
4818 @itemx -mtune=<name>
4819 @kindex -mtune=
4820 This option is very similar to the @samp{-mcpu=} option, except that
4821 instead of specifying the actual target processor type, and hence
4822 restricting which instructions can be used, it specifies that GCC should
4823 tune the performance of the code as if the target were of the type
4824 specified in this option, but still choosing the instructions that it
4825 will generate based on the cpu specified by a @samp{-mcpu=} option.
4826 For some arm implementations better performance can be obtained by using
4827 this option.
4829 @item -march=<name>
4830 @kindex -march=
4831 This specifies the name of the target ARM architecture.  GCC uses this
4832 name to determine what kind of instructions it can use when generating
4833 assembly code.  This option can be used in conjunction with or instead
4834 of the @samp{-mcpu=} option.  Permissible names are: armv2, armv2a,
4835 armv3, armv3m, armv4, armv4t, armv5.
4837 @item -mfpe=<number>
4838 @itemx -mfp=<number>
4839 @kindex -mfpe=
4840 @kindex -mfp=
4841 This specifies the version of the floating point emulation available on
4842 the target.  Permissible values are 2 and 3.  @samp{-mfp=} is a synonym
4843 for @samp{-mfpe=} to support older versions of GCC.
4845 @item -mstructure-size-boundary=<n>
4846 @kindex -mstructure-size-boundary
4847 The size of all structures and unions will be rounded up to a multiple
4848 of the number of bits set by this option.  Permissible values are 8 and
4849 32.  The default value varies for different toolchains.  For the COFF
4850 targeted toolchain the default value is 8.  Specifying the larger number
4851 can produce faster, more efficient code, but can also increase the size
4852 of the program.  The two values are potentially incompatible.  Code
4853 compiled with one value cannot necessarily expect to work with code or
4854 libraries compiled with the other value, if they exchange information
4855 using structures or unions.  Programmers are encouraged to use the 32
4856 value as future versions of the toolchain may default to this value.
4858 @item -mabort-on-noreturn
4859 @kindex -mabort-on-noreturn
4860 @kindex -mnoabort-on-noreturn
4861 Generate a call to the function abort at the end of a noreturn function.
4862 It will be executed if the function tries to return.
4864 @item -mlong-calls
4865 @itemx -mno-long-calls
4866 Tells the compiler to perform function calls by first loading the
4867 address of the function into a register and then performing a subroutine
4868 call on this register.  This switch is needed if the target function
4869 will lie outside of the 64 megabyte addressing range of the offset based
4870 version of subroutine call instruction. 
4872 Even if this switch is enabled, not all function calls will be turned
4873 into long calls.  The heuristic is that static functions, functions
4874 which have the @samp{short-call} attribute, functions that are inside
4875 the scope of a @samp{#pragma no_long_calls} directive and functions whose
4876 definitions have already been compiled within the current compilation
4877 unit, will not be turned into long calls.  The exception to this rule is
4878 that weak function definitions, functions with the @samp{long-call}
4879 attribute or the @samp{section} attribute, and functions that are within
4880 the scope of a @samp{#pragma long_calls} directive, will always be
4881 turned into long calls.
4883 This feature is not enabled by default.  Specifying
4884 @samp{--no-long-calls} will restore the default behaviour, as will
4885 placing the function calls within the scope of a @samp{#pragma
4886 long_calls_off} directive.  Note these switches have no effect on how
4887 the compiler generates code to handle function calls via function
4888 pointers.  
4890 @item -mnop-fun-dllimport
4891 @kindex -mnop-fun-dllimport
4892 Disable the support for the @emph{dllimport} attribute.
4894 @item -msingle-pic-base
4895 @kindex -msingle-pic-base
4896 Treat the register used for PIC addressing as read-only, rather than
4897 loading it in the prologue for each function.  The run-time system is
4898 responsible for initialising this register with an appropriate value
4899 before execution begins.
4901 @item -mpic-register=<reg>
4902 @kindex -mpic-register=
4903 Specify the register to be used for PIC addressing.  The default is R10
4904 unless stack-checking is enabled, when R9 is used.
4906 @end table
4908 @node Thumb Options
4909 @subsection Thumb Options
4910 @cindex Thumb Options
4912 @table @code
4914 @item -mthumb-interwork
4915 @kindex -mthumb-interwork
4916 @kindex -mno-thumb-interwork
4917 Generate code which supports calling between the THUMB and ARM
4918 instruction sets.  Without this option the two instruction sets cannot
4919 be reliably used inside one program.  The default is
4920 @samp{-mno-thumb-interwork}, since slightly smaller code is generated
4921 with this option.
4923 @item -mtpcs-frame
4924 @kindex -mtpcs-frame
4925 @kindex -mno-tpcs-frame
4926 Generate a stack frame that is compliant with the Thumb Procedure Call
4927 Standard for all non-leaf functions.  (A leaf function is one that does
4928 not call any other functions).  The default is @samp{-mno-apcs-frame}. 
4930 @item -mtpcs-leaf-frame
4931 @kindex -mtpcs-leaf-frame
4932 @kindex -mno-tpcs-leaf-frame
4933 Generate a stack frame that is compliant with the Thumb Procedure Call
4934 Standard for all leaf functions.  (A leaf function is one that does
4935 not call any other functions).  The default is @samp{-mno-apcs-leaf-frame}. 
4937 @item -mlittle-endian
4938 @kindex -mlittle-endian
4939 Generate code for a processor running in little-endian mode.  This is
4940 the default for all standard configurations.
4942 @item -mbig-endian
4943 @kindex -mbig-endian
4944 Generate code for a processor running in big-endian mode.
4946 @item -mstructure-size-boundary=<n>
4947 @kindex -mstructure-size-boundary
4948 The size of all structures and unions will be rounded up to a multiple
4949 of the number of bits set by this option.  Permissible values are 8 and
4950 32.  The default value varies for different toolchains.  For the COFF
4951 targeted toolchain the default value is 8.  Specifying the larger number
4952 can produced faster, more efficient code, but can also increase the size
4953 of the program.  The two values are potentially incompatible.  Code
4954 compiled with one value cannot necessarily expect to work with code or
4955 libraries compiled with the other value, if they exchange information
4956 using structures or unions.  Programmers are encouraged to use the 32
4957 value as future versions of the toolchain may default to this value.
4959 @item -mnop-fun-dllimport
4960 @kindex -mnop-fun-dllimport
4961 Disable the support for the @emph{dllimport} attribute.
4963 @item -mcallee-super-interworking
4964 @kindex -mcallee-super-interworking
4965 Gives all externally visible functions in the file being compiled an ARM
4966 instruction set header which switches to Thumb mode before executing the
4967 rest of the function.  This allows these functions to be called from
4968 non-interworking code.
4970 @item -mcaller-super-interworking
4971 @kindex -mcaller-super-interworking
4972 Allows calls via function pointers (including virtual functions) to
4973 execute correctly regardless of whether the target code has been
4974 compiled for interworking or not.  There is a small overhead in the cost
4975 of executing a function pointer if this option is enabled.
4977 @item -msingle-pic-base
4978 @kindex -msingle-pic-base
4979 Treat the register used for PIC addressing as read-only, rather than
4980 loading it in the prologue for each function.  The run-time system is
4981 responsible for initialising this register with an appropriate value
4982 before execution begins.
4984 @item -mpic-register=<reg>
4985 @kindex -mpic-register=
4986 Specify the register to be used for PIC addressing.  The default is R10.
4988 @end table
4990 @node MN10200 Options
4991 @subsection MN10200 Options
4992 @cindex MN10200 options
4993 These @samp{-m} options are defined for Matsushita MN10200 architectures:
4994 @table @code
4996 @item -mrelax
4997 Indicate to the linker that it should perform a relaxation optimization pass
4998 to shorten branches, calls and absolute memory addresses.  This option only
4999 has an effect when used on the command line for the final link step.
5001 This option makes symbolic debugging impossible. 
5002 @end table
5004 @node MN10300 Options
5005 @subsection MN10300 Options
5006 @cindex MN10300 options
5007 These @samp{-m} options are defined for Matsushita MN10300 architectures:
5009 @table @code
5010 @item -mmult-bug
5011 Generate code to avoid bugs in the multiply instructions for the MN10300
5012 processors.  This is the default.
5014 @item -mno-mult-bug
5015 Do not generate code to avoid bugs in the multiply instructions for the
5016 MN10300 processors.
5018 @item -mam33
5019 Generate code which uses features specific to the AM33 processor.
5021 @item -mno-am33
5022 Do not generate code which uses features specific to the AM33 processor.  This
5023 is the default.
5025 @item -mrelax
5026 Indicate to the linker that it should perform a relaxation optimization pass
5027 to shorten branches, calls and absolute memory addresses.  This option only
5028 has an effect when used on the command line for the final link step.
5030 This option makes symbolic debugging impossible. 
5031 @end table
5034 @node M32R/D Options
5035 @subsection M32R/D Options
5036 @cindex M32R/D options
5038 These @samp{-m} options are defined for Mitsubishi M32R/D architectures:
5040 @table @code
5041 @item -mcode-model=small
5042 Assume all objects live in the lower 16MB of memory (so that their addresses
5043 can be loaded with the @code{ld24} instruction), and assume all subroutines
5044 are reachable with the @code{bl} instruction.
5045 This is the default.
5047 The addressability of a particular object can be set with the
5048 @code{model} attribute.
5050 @item -mcode-model=medium
5051 Assume objects may be anywhere in the 32 bit address space (the compiler
5052 will generate @code{seth/add3} instructions to load their addresses), and
5053 assume all subroutines are reachable with the @code{bl} instruction.
5055 @item -mcode-model=large
5056 Assume objects may be anywhere in the 32 bit address space (the compiler
5057 will generate @code{seth/add3} instructions to load their addresses), and
5058 assume subroutines may not be reachable with the @code{bl} instruction
5059 (the compiler will generate the much slower @code{seth/add3/jl}
5060 instruction sequence).
5062 @item -msdata=none
5063 Disable use of the small data area.  Variables will be put into
5064 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
5065 @code{section} attribute has been specified).
5066 This is the default.
5068 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
5069 Objects may be explicitly put in the small data area with the
5070 @code{section} attribute using one of these sections.
5072 @item -msdata=sdata
5073 Put small global and static data in the small data area, but do not
5074 generate special code to reference them.
5076 @item -msdata=use
5077 Put small global and static data in the small data area, and generate
5078 special instructions to reference them.
5080 @item -G @var{num}
5081 @cindex smaller data references
5082 Put global and static objects less than or equal to @var{num} bytes
5083 into the small data or bss sections instead of the normal data or bss
5084 sections.  The default value of @var{num} is 8.
5085 The @samp{-msdata} option must be set to one of @samp{sdata} or @samp{use}
5086 for this option to have any effect.
5088 All modules should be compiled with the same @samp{-G @var{num}} value.
5089 Compiling with different values of @var{num} may or may not work; if it
5090 doesn't the linker will give an error message - incorrect code will not be
5091 generated.
5093 @end table
5095 @node M88K Options
5096 @subsection M88K Options
5097 @cindex M88k options
5099 These @samp{-m} options are defined for Motorola 88k architectures:
5101 @table @code
5102 @item -m88000
5103 @kindex -m88000
5104 Generate code that works well on both the m88100 and the
5105 m88110.
5107 @item -m88100
5108 @kindex -m88100
5109 Generate code that works best for the m88100, but that also
5110 runs on the m88110.
5112 @item -m88110
5113 @kindex -m88110
5114 Generate code that works best for the m88110, and may not run
5115 on the m88100.
5117 @item -mbig-pic
5118 @kindex -mbig-pic
5119 Obsolete option to be removed from the next revision.
5120 Use @samp{-fPIC}.
5122 @item -midentify-revision
5123 @kindex -midentify-revision
5124 @kindex ident
5125 @cindex identifying source, compiler (88k)
5126 Include an @code{ident} directive in the assembler output recording the
5127 source file name, compiler name and version, timestamp, and compilation
5128 flags used.
5130 @item -mno-underscores
5131 @kindex -mno-underscores
5132 @cindex underscores, avoiding (88k)
5133 In assembler output, emit symbol names without adding an underscore
5134 character at the beginning of each name.  The default is to use an
5135 underscore as prefix on each name.
5137 @item -mocs-debug-info
5138 @itemx -mno-ocs-debug-info
5139 @kindex -mocs-debug-info
5140 @kindex -mno-ocs-debug-info
5141 @cindex OCS (88k)
5142 @cindex debugging, 88k OCS
5143 Include (or omit) additional debugging information (about registers used
5144 in each stack frame) as specified in the 88open Object Compatibility
5145 Standard, ``OCS''.  This extra information allows debugging of code that
5146 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
5147 Delta 88 SVr3.2 is to include this information; other 88k configurations
5148 omit this information by default.
5150 @item -mocs-frame-position
5151 @kindex -mocs-frame-position
5152 @cindex register positions in frame (88k)
5153 When emitting COFF debugging information for automatic variables and
5154 parameters stored on the stack, use the offset from the canonical frame
5155 address, which is the stack pointer (register 31) on entry to the
5156 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
5157 @samp{-mocs-frame-position}; other 88k configurations have the default
5158 @samp{-mno-ocs-frame-position}.
5160 @item -mno-ocs-frame-position
5161 @kindex -mno-ocs-frame-position
5162 @cindex register positions in frame (88k)
5163 When emitting COFF debugging information for automatic variables and
5164 parameters stored on the stack, use the offset from the frame pointer
5165 register (register 30).  When this option is in effect, the frame
5166 pointer is not eliminated when debugging information is selected by the
5167 -g switch.
5169 @item -moptimize-arg-area
5170 @itemx -mno-optimize-arg-area
5171 @kindex -moptimize-arg-area
5172 @kindex -mno-optimize-arg-area
5173 @cindex arguments in frame (88k)
5174 Control how function arguments are stored in stack frames.
5175 @samp{-moptimize-arg-area} saves space by optimizing them, but this
5176 conflicts with the 88open specifications.  The opposite alternative,
5177 @samp{-mno-optimize-arg-area}, agrees with 88open standards.  By default
5178 GCC does not optimize the argument area.
5180 @item -mshort-data-@var{num}
5181 @kindex -mshort-data-@var{num}
5182 @cindex smaller data references (88k)
5183 @cindex r0-relative references (88k)
5184 Generate smaller data references by making them relative to @code{r0},
5185 which allows loading a value using a single instruction (rather than the
5186 usual two).  You control which data references are affected by
5187 specifying @var{num} with this option.  For example, if you specify
5188 @samp{-mshort-data-512}, then the data references affected are those
5189 involving displacements of less than 512 bytes.
5190 @samp{-mshort-data-@var{num}} is not effective for @var{num} greater
5191 than 64k.
5193 @item -mserialize-volatile
5194 @kindex -mserialize-volatile
5195 @itemx -mno-serialize-volatile
5196 @kindex -mno-serialize-volatile
5197 @cindex sequential consistency on 88k
5198 Do, or don't, generate code to guarantee sequential consistency
5199 of volatile memory references.  By default, consistency is
5200 guaranteed.
5202 The order of memory references made by the MC88110 processor does
5203 not always match the order of the instructions requesting those
5204 references.  In particular, a load instruction may execute before
5205 a preceding store instruction.  Such reordering violates
5206 sequential consistency of volatile memory references, when there
5207 are multiple processors.   When consistency must be guaranteed,
5208 GNU C generates special instructions, as needed, to force
5209 execution in the proper order.
5211 The MC88100 processor does not reorder memory references and so
5212 always provides sequential consistency.  However, by default, GNU
5213 C generates the special instructions to guarantee consistency
5214 even when you use @samp{-m88100}, so that the code may be run on an
5215 MC88110 processor.  If you intend to run your code only on the
5216 MC88100 processor, you may use @samp{-mno-serialize-volatile}.
5218 The extra code generated to guarantee consistency may affect the
5219 performance of your application.  If you know that you can safely
5220 forgo this guarantee, you may use @samp{-mno-serialize-volatile}.
5222 @item -msvr4
5223 @itemx -msvr3
5224 @kindex -msvr4
5225 @kindex -msvr3
5226 @cindex assembler syntax, 88k
5227 @cindex SVr4
5228 Turn on (@samp{-msvr4}) or off (@samp{-msvr3}) compiler extensions
5229 related to System V release 4 (SVr4).  This controls the following:
5231 @enumerate
5232 @item
5233 Which variant of the assembler syntax to emit.
5234 @item
5235 @samp{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
5236 that is used on System V release 4.
5237 @item
5238 @samp{-msvr4} makes GCC issue additional declaration directives used in
5239 SVr4.
5240 @end enumerate
5242 @samp{-msvr4} is the default for the m88k-motorola-sysv4 and
5243 m88k-dg-dgux m88k configurations. @samp{-msvr3} is the default for all
5244 other m88k configurations.
5246 @item -mversion-03.00
5247 @kindex -mversion-03.00
5248 This option is obsolete, and is ignored.
5249 @c ??? which asm syntax better for GAS?  option there too?
5251 @item -mno-check-zero-division
5252 @itemx -mcheck-zero-division
5253 @kindex -mno-check-zero-division
5254 @kindex -mcheck-zero-division
5255 @cindex zero division on 88k
5256 Do, or don't, generate code to guarantee that integer division by
5257 zero will be detected.  By default, detection is guaranteed.
5259 Some models of the MC88100 processor fail to trap upon integer
5260 division by zero under certain conditions.  By default, when
5261 compiling code that might be run on such a processor, GNU C
5262 generates code that explicitly checks for zero-valued divisors
5263 and traps with exception number 503 when one is detected.  Use of
5264 mno-check-zero-division suppresses such checking for code
5265 generated to run on an MC88100 processor.
5267 GNU C assumes that the MC88110 processor correctly detects all
5268 instances of integer division by zero.  When @samp{-m88110} is
5269 specified, both @samp{-mcheck-zero-division} and
5270 @samp{-mno-check-zero-division} are ignored, and no explicit checks for
5271 zero-valued divisors are generated.
5273 @item -muse-div-instruction
5274 @kindex -muse-div-instruction
5275 @cindex divide instruction, 88k
5276 Use the div instruction for signed integer division on the
5277 MC88100 processor.  By default, the div instruction is not used.
5279 On the MC88100 processor the signed integer division instruction
5280 div) traps to the operating system on a negative operand.  The
5281 operating system transparently completes the operation, but at a
5282 large cost in execution time.  By default, when compiling code
5283 that might be run on an MC88100 processor, GNU C emulates signed
5284 integer division using the unsigned integer division instruction
5285 divu), thereby avoiding the large penalty of a trap to the
5286 operating system.  Such emulation has its own, smaller, execution
5287 cost in both time and space.  To the extent that your code's
5288 important signed integer division operations are performed on two
5289 nonnegative operands, it may be desirable to use the div
5290 instruction directly.
5292 On the MC88110 processor the div instruction (also known as the
5293 divs instruction) processes negative operands without trapping to
5294 the operating system.  When @samp{-m88110} is specified,
5295 @samp{-muse-div-instruction} is ignored, and the div instruction is used
5296 for signed integer division.
5298 Note that the result of dividing INT_MIN by -1 is undefined.  In
5299 particular, the behavior of such a division with and without
5300 @samp{-muse-div-instruction}  may differ.
5302 @item -mtrap-large-shift
5303 @itemx -mhandle-large-shift
5304 @kindex -mtrap-large-shift
5305 @kindex -mhandle-large-shift
5306 @cindex bit shift overflow (88k)
5307 @cindex large bit shifts (88k)
5308 Include code to detect bit-shifts of more than 31 bits; respectively,
5309 trap such shifts or emit code to handle them properly.  By default GCC
5310 makes no special provision for large bit shifts.
5312 @item -mwarn-passed-structs
5313 @kindex -mwarn-passed-structs
5314 @cindex structure passing (88k)
5315 Warn when a function passes a struct as an argument or result.
5316 Structure-passing conventions have changed during the evolution of the C
5317 language, and are often the source of portability problems.  By default,
5318 GCC issues no such warning.
5319 @end table
5321 @node RS/6000 and PowerPC Options
5322 @subsection IBM RS/6000 and PowerPC Options
5323 @cindex RS/6000 and PowerPC Options
5324 @cindex IBM RS/6000 and PowerPC Options
5326 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
5327 @table @code
5328 @item -mpower
5329 @itemx -mno-power
5330 @itemx -mpower2
5331 @itemx -mno-power2
5332 @itemx -mpowerpc
5333 @itemx -mno-powerpc
5334 @itemx -mpowerpc-gpopt
5335 @itemx -mno-powerpc-gpopt
5336 @itemx -mpowerpc-gfxopt
5337 @itemx -mno-powerpc-gfxopt
5338 @itemx -mpowerpc64
5339 @itemx -mno-powerpc64
5340 @kindex -mpower
5341 @kindex -mpower2
5342 @kindex -mpowerpc
5343 @kindex -mpowerpc-gpopt
5344 @kindex -mpowerpc-gfxopt
5345 @kindex -mpowerpc64
5346 GCC supports two related instruction set architectures for the
5347 RS/6000 and PowerPC.  The @dfn{POWER} instruction set are those
5348 instructions supported by the @samp{rios} chip set used in the original
5349 RS/6000 systems and the @dfn{PowerPC} instruction set is the
5350 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
5351 the IBM 4xx microprocessors.
5353 Neither architecture is a subset of the other.  However there is a
5354 large common subset of instructions supported by both.  An MQ
5355 register is included in processors supporting the POWER architecture.
5357 You use these options to specify which instructions are available on the
5358 processor you are using.  The default value of these options is
5359 determined when configuring GCC.  Specifying the
5360 @samp{-mcpu=@var{cpu_type}} overrides the specification of these
5361 options.  We recommend you use the @samp{-mcpu=@var{cpu_type}} option
5362 rather than the options listed above.
5364 The @samp{-mpower} option allows GCC to generate instructions that
5365 are found only in the POWER architecture and to use the MQ register.
5366 Specifying @samp{-mpower2} implies @samp{-power} and also allows GCC
5367 to generate instructions that are present in the POWER2 architecture but
5368 not the original POWER architecture.
5370 The @samp{-mpowerpc} option allows GCC to generate instructions that
5371 are found only in the 32-bit subset of the PowerPC architecture.
5372 Specifying @samp{-mpowerpc-gpopt} implies @samp{-mpowerpc} and also allows
5373 GCC to use the optional PowerPC architecture instructions in the
5374 General Purpose group, including floating-point square root.  Specifying
5375 @samp{-mpowerpc-gfxopt} implies @samp{-mpowerpc} and also allows GCC to
5376 use the optional PowerPC architecture instructions in the Graphics
5377 group, including floating-point select.
5379 The @samp{-mpowerpc64} option allows GCC to generate the additional
5380 64-bit instructions that are found in the full PowerPC64 architecture
5381 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
5382 @samp{-mno-powerpc64}.
5384 If you specify both @samp{-mno-power} and @samp{-mno-powerpc}, GCC
5385 will use only the instructions in the common subset of both
5386 architectures plus some special AIX common-mode calls, and will not use
5387 the MQ register.  Specifying both @samp{-mpower} and @samp{-mpowerpc}
5388 permits GCC to use any instruction from either architecture and to
5389 allow use of the MQ register; specify this for the Motorola MPC601.
5391 @item -mnew-mnemonics
5392 @itemx -mold-mnemonics
5393 @kindex -mnew-mnemonics
5394 @kindex -mold-mnemonics
5395 Select which mnemonics to use in the generated assembler code.
5396 @samp{-mnew-mnemonics} requests output that uses the assembler mnemonics
5397 defined for the PowerPC architecture, while @samp{-mold-mnemonics}
5398 requests the assembler mnemonics defined for the POWER architecture.
5399 Instructions defined in only one architecture have only one mnemonic;
5400 GCC uses that mnemonic irrespective of which of these options is
5401 specified.
5403 GCC defaults to the mnemonics appropriate for the architecture in
5404 use.  Specifying @samp{-mcpu=@var{cpu_type}} sometimes overrides the
5405 value of these option.  Unless you are building a cross-compiler, you
5406 should normally not specify either @samp{-mnew-mnemonics} or
5407 @samp{-mold-mnemonics}, but should instead accept the default.
5409 @item -mcpu=@var{cpu_type}
5410 @kindex -mcpu
5411 Set architecture type, register usage, choice of mnemonics, and
5412 instruction scheduling parameters for machine type @var{cpu_type}.
5413 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
5414 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
5415 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
5416 @samp{630}, @samp{740}, @samp{750}, @samp{power}, @samp{power2},
5417 @samp{powerpc}, @samp{403}, @samp{505}, @samp{801}, @samp{821},
5418 @samp{823}, and @samp{860} and @samp{common}.  @samp{-mcpu=power},
5419 @samp{-mcpu=power2}, @samp{-mcpu=powerpc}, and @samp{-mcpu=powerpc64}
5420 specify generic POWER, POWER2, pure 32-bit PowerPC (i.e., not MPC601),
5421 and 64-bit PowerPC architecture machine types, with an appropriate,
5422 generic processor model assumed for scheduling purposes.@refill
5424 Specifying any of the following options: 
5425 @samp{-mcpu=rios1}, @samp{-mcpu=rios2}, @samp{-mcpu=rsc},
5426 @samp{-mcpu=power}, or @samp{-mcpu=power2}  
5427 enables the @samp{-mpower} option and disables the @samp{-mpowerpc} option; 
5428 @samp{-mcpu=601} enables both the @samp{-mpower} and @samp{-mpowerpc} options.
5429 All of @samp{-mcpu=rs64a}, @samp{-mcpu=602}, @samp{-mcpu=603},
5430 @samp{-mcpu=603e}, @samp{-mcpu=604}, @samp{-mcpu=620}, @samp{-mcpu=630},
5431 @samp{-mcpu=740}, and @samp{-mcpu=750}
5432 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.  
5433 Exactly similarly, all of @samp{-mcpu=403},
5434 @samp{-mcpu=505}, @samp{-mcpu=821}, @samp{-mcpu=860} and @samp{-mcpu=powerpc} 
5435 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
5436 @samp{-mcpu=common} disables both the 
5437 @samp{-mpower} and @samp{-mpowerpc} options.@refill
5439 AIX versions 4 or greater selects @samp{-mcpu=common} by default, so
5440 that code will operate on all members of the RS/6000 POWER and PowerPC
5441 families.  In that case, GCC will use only the instructions in the
5442 common subset of both architectures plus some special AIX common-mode
5443 calls, and will not use the MQ register.  GCC assumes a generic
5444 processor model for scheduling purposes.
5446 Specifying any of the options @samp{-mcpu=rios1}, @samp{-mcpu=rios2},
5447 @samp{-mcpu=rsc}, @samp{-mcpu=power}, or @samp{-mcpu=power2} also
5448 disables the @samp{new-mnemonics} option.  Specifying @samp{-mcpu=601},
5449 @samp{-mcpu=602}, @samp{-mcpu=603}, @samp{-mcpu=603e}, @samp{-mcpu=604},
5450 @samp{-mcpu=620}, @samp{-mcpu=630}, @samp{-mcpu=403}, @samp{-mcpu=505},
5451 @samp{-mcpu=821}, @samp{-mcpu=860} or @samp{-mcpu=powerpc} also enables
5452 the @samp{new-mnemonics} option.@refill
5454 Specifying @samp{-mcpu=403}, @samp{-mcpu=821}, or @samp{-mcpu=860} also
5455 enables the @samp{-msoft-float} option.
5457 @item -mtune=@var{cpu_type}
5458 Set the instruction scheduling parameters for machine type
5459 @var{cpu_type}, but do not set the architecture type, register usage,
5460 choice of mnemonics like @samp{-mcpu=}@var{cpu_type} would.  The same
5461 values for @var{cpu_type} are used for @samp{-mtune=}@var{cpu_type} as
5462 for @samp{-mcpu=}@var{cpu_type}.  The @samp{-mtune=}@var{cpu_type}
5463 option overrides the @samp{-mcpu=}@var{cpu_type} option in terms of
5464 instruction scheduling parameters.
5466 @item -mfull-toc
5467 @itemx -mno-fp-in-toc
5468 @itemx -mno-sum-in-toc
5469 @itemx -mminimal-toc
5470 @kindex -mminimal-toc
5471 Modify generation of the TOC (Table Of Contents), which is created for
5472 every executable file.  The @samp{-mfull-toc} option is selected by
5473 default.  In that case, GCC will allocate at least one TOC entry for
5474 each unique non-automatic variable reference in your program.  GCC
5475 will also place floating-point constants in the TOC.  However, only
5476 16,384 entries are available in the TOC.
5478 If you receive a linker error message that saying you have overflowed
5479 the available TOC space, you can reduce the amount of TOC space used
5480 with the @samp{-mno-fp-in-toc} and @samp{-mno-sum-in-toc} options.
5481 @samp{-mno-fp-in-toc} prevents GCC from putting floating-point
5482 constants in the TOC and @samp{-mno-sum-in-toc} forces GCC to
5483 generate code to calculate the sum of an address and a constant at
5484 run-time instead of putting that sum into the TOC.  You may specify one
5485 or both of these options.  Each causes GCC to produce very slightly
5486 slower and larger code at the expense of conserving TOC space.
5488 If you still run out of space in the TOC even when you specify both of
5489 these options, specify @samp{-mminimal-toc} instead.  This option causes
5490 GCC to make only one TOC entry for every file.  When you specify this
5491 option, GCC will produce code that is slower and larger but which
5492 uses extremely little TOC space.  You may wish to use this option
5493 only on files that contain less frequently executed code. @refill
5495 @item -maix64
5496 @itemx -maix32
5497 @kindex -maix64
5498 @kindex -maix32
5499 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
5500 @code{long} type, and the infrastructure needed to support them.
5501 Specifying @samp{-maix64} implies @samp{-mpowerpc64} and
5502 @samp{-mpowerpc}, while @samp{-maix32} disables the 64-bit ABI and
5503 implies @samp{-mno-powerpc64}.  GCC defaults to @samp{-maix32}.
5505 @item -mxl-call
5506 @itemx -mno-xl-call
5507 @kindex -mxl-call
5508 On AIX, pass floating-point arguments to prototyped functions beyond the
5509 register save area (RSA) on the stack in addition to argument FPRs.  The
5510 AIX calling convention was extended but not initially documented to
5511 handle an obscure K&R C case of calling a function that takes the
5512 address of its arguments with fewer arguments than declared.  AIX XL
5513 compilers access floating point arguments which do not fit in the
5514 RSA from the stack when a subroutine is compiled without
5515 optimization.  Because always storing floating-point arguments on the
5516 stack is inefficient and rarely needed, this option is not enabled by
5517 default and only is necessary when calling subroutines compiled by AIX
5518 XL compilers without optimization.
5520 @item -mthreads
5521 @kindex -mthreads
5522 Support @dfn{AIX Threads}.  Link an application written to use
5523 @dfn{pthreads} with special libraries and startup code to enable the
5524 application to run.
5526 @item -mpe
5527 @kindex -mpe
5528 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE).  Link an
5529 application written to use message passing with special startup code to
5530 enable the application to run.  The system must have PE installed in the
5531 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
5532 must be overridden with the @samp{-specs=} option to specify the
5533 appropriate directory location.  The Parallel Environment does not
5534 support threads, so the @samp{-mpe} option and the @samp{-mthreads}
5535 option are incompatible.
5537 @item -msoft-float
5538 @itemx -mhard-float
5539 @kindex -msoft-float
5540 Generate code that does not use (uses) the floating-point register set.
5541 Software floating point emulation is provided if you use the
5542 @samp{-msoft-float} option, and pass the option to GCC when linking.
5544 @item -mmultiple
5545 @itemx -mno-multiple
5546 Generate code that uses (does not use) the load multiple word
5547 instructions and the store multiple word instructions.  These
5548 instructions are generated by default on POWER systems, and not
5549 generated on PowerPC systems.  Do not use @samp{-mmultiple} on little
5550 endian PowerPC systems, since those instructions do not work when the
5551 processor is in little endian mode.  The exceptions are PPC740 and
5552 PPC750 which permit the instructions usage in little endian mode.
5554 @item -mstring
5555 @itemx -mno-string
5556 @kindex -mstring
5557 Generate code that uses (does not use) the load string instructions
5558 and the store string word instructions to save multiple registers and
5559 do small block moves.  These instructions are generated by default on
5560 POWER systems, and not generated on PowerPC systems.  Do not use
5561 @samp{-mstring} on little endian PowerPC systems, since those
5562 instructions do not work when the processor is in little endian mode.
5563 The exceptions are PPC740 and PPC750 which permit the instructions
5564 usage in little endian mode.
5566 @item -mupdate
5567 @itemx -mno-update
5568 @kindex -mupdate
5569 Generate code that uses (does not use) the load or store instructions
5570 that update the base register to the address of the calculated memory
5571 location.  These instructions are generated by default.  If you use
5572 @samp{-mno-update}, there is a small window between the time that the
5573 stack pointer is updated and the address of the previous frame is
5574 stored, which means code that walks the stack frame across interrupts or
5575 signals may get corrupted data.
5577 @item -mfused-madd
5578 @itemx -mno-fused-madd
5579 @kindex -mfused-madd
5580 Generate code that uses (does not use) the floating point multiply and
5581 accumulate instructions.  These instructions are generated by default if
5582 hardware floating is used.
5584 @item -mno-bit-align
5585 @itemx -mbit-align
5586 @kindex -mbit-align
5587 On System V.4 and embedded PowerPC systems do not (do) force structures
5588 and unions that contain bit fields to be aligned to the base type of the
5589 bit field.
5591 For example, by default a structure containing nothing but 8
5592 @code{unsigned} bitfields of length 1 would be aligned to a 4 byte
5593 boundary and have a size of 4 bytes.  By using @samp{-mno-bit-align},
5594 the structure would be aligned to a 1 byte boundary and be one byte in
5595 size.
5597 @item -mno-strict-align
5598 @itemx -mstrict-align
5599 @kindex -mstrict-align
5600 On System V.4 and embedded PowerPC systems do not (do) assume that
5601 unaligned memory references will be handled by the system.
5603 @item -mrelocatable
5604 @itemx -mno-relocatable
5605 @kindex -mrelocatable
5606 On embedded PowerPC systems generate code that allows (does not allow)
5607 the program to be relocated to a different address at runtime.  If you
5608 use @samp{-mrelocatable} on any module, all objects linked together must
5609 be compiled with @samp{-mrelocatable} or @samp{-mrelocatable-lib}.
5611 @item -mrelocatable-lib
5612 @itemx -mno-relocatable-lib
5613 On embedded PowerPC systems generate code that allows (does not allow)
5614 the program to be relocated to a different address at runtime.  Modules
5615 compiled with @samp{-mrelocatable-lib} can be linked with either modules
5616 compiled without @samp{-mrelocatable} and @samp{-mrelocatable-lib} or
5617 with modules compiled with the @samp{-mrelocatable} options.
5619 @item -mno-toc
5620 @itemx -mtoc
5621 On System V.4 and embedded PowerPC systems do not (do) assume that
5622 register 2 contains a pointer to a global area pointing to the addresses
5623 used in the program.
5625 @item -mlittle
5626 @itemx -mlittle-endian
5627 On System V.4 and embedded PowerPC systems compile code for the
5628 processor in little endian mode.  The @samp{-mlittle-endian} option is
5629 the same as @samp{-mlittle}.
5631 @item -mbig
5632 @itemx -mbig-endian
5633 On System V.4 and embedded PowerPC systems compile code for the
5634 processor in big endian mode.  The @samp{-mbig-endian} option is
5635 the same as @samp{-mbig}.
5637 @item -mcall-sysv
5638 On System V.4 and embedded PowerPC systems compile code using calling
5639 conventions that adheres to the March 1995 draft of the System V
5640 Application Binary Interface, PowerPC processor supplement.  This is the
5641 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
5643 @item -mcall-sysv-eabi
5644 Specify both @samp{-mcall-sysv} and @samp{-meabi} options.
5646 @item -mcall-sysv-noeabi
5647 Specify both @samp{-mcall-sysv} and @samp{-mno-eabi} options.
5649 @item -mcall-aix
5650 On System V.4 and embedded PowerPC systems compile code using calling
5651 conventions that are similar to those used on AIX.  This is the
5652 default if you configured GCC using @samp{powerpc-*-eabiaix}.
5654 @item -mcall-solaris
5655 On System V.4 and embedded PowerPC systems compile code for the Solaris
5656 operating system.
5658 @item -mcall-linux
5659 On System V.4 and embedded PowerPC systems compile code for the
5660 Linux-based GNU system.
5662 @item -mprototype
5663 @itemx -mno-prototype
5664 On System V.4 and embedded PowerPC systems assume that all calls to
5665 variable argument functions are properly prototyped.  Otherwise, the
5666 compiler must insert an instruction before every non prototyped call to
5667 set or clear bit 6 of the condition code register (@var{CR}) to
5668 indicate whether floating point values were passed in the floating point
5669 registers in case the function takes a variable arguments.  With
5670 @samp{-mprototype}, only calls to prototyped variable argument functions
5671 will set or clear the bit.
5673 @item -msim
5674 On embedded PowerPC systems, assume that the startup module is called
5675 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
5676 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
5677 configurations.
5679 @item -mmvme
5680 On embedded PowerPC systems, assume that the startup module is called
5681 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
5682 @file{libc.a}.
5684 @item -mads
5685 On embedded PowerPC systems, assume that the startup module is called
5686 @file{crt0.o} and the standard C libraries are @file{libads.a} and
5687 @file{libc.a}.
5689 @item -myellowknife
5690 On embedded PowerPC systems, assume that the startup module is called
5691 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
5692 @file{libc.a}.
5694 @item -mvxworks
5695 On System V.4 and embedded PowerPC systems, specify that you are
5696 compiling for a VxWorks system.
5698 @item -memb
5699 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
5700 header to indicate that @samp{eabi} extended relocations are used.
5702 @item -meabi
5703 @itemx -mno-eabi
5704 On System V.4 and embedded PowerPC systems do (do not) adhere to the
5705 Embedded Applications Binary Interface (eabi) which is a set of
5706 modifications to the System V.4 specifications.  Selecting @code{-meabi}
5707 means that the stack is aligned to an 8 byte boundary, a function
5708 @code{__eabi} is called to from @code{main} to set up the eabi
5709 environment, and the @samp{-msdata} option can use both @code{r2} and
5710 @code{r13} to point to two separate small data areas.  Selecting
5711 @code{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
5712 do not call an initialization function from @code{main}, and the
5713 @samp{-msdata} option will only use @code{r13} to point to a single
5714 small data area.  The @samp{-meabi} option is on by default if you
5715 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
5717 @item -msdata=eabi
5718 On System V.4 and embedded PowerPC systems, put small initialized
5719 @code{const} global and static data in the @samp{.sdata2} section, which
5720 is pointed to by register @code{r2}.  Put small initialized
5721 non-@code{const} global and static data in the @samp{.sdata} section,
5722 which is pointed to by register @code{r13}.  Put small uninitialized
5723 global and static data in the @samp{.sbss} section, which is adjacent to
5724 the @samp{.sdata} section.  The @samp{-msdata=eabi} option is
5725 incompatible with the @samp{-mrelocatable} option.  The
5726 @samp{-msdata=eabi} option also sets the @samp{-memb} option.
5728 @item -msdata=sysv
5729 On System V.4 and embedded PowerPC systems, put small global and static
5730 data in the @samp{.sdata} section, which is pointed to by register
5731 @code{r13}.  Put small uninitialized global and static data in the
5732 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
5733 The @samp{-msdata=sysv} option is incompatible with the
5734 @samp{-mrelocatable} option.
5736 @item -msdata=default
5737 @itemx -msdata
5738 On System V.4 and embedded PowerPC systems, if @samp{-meabi} is used,
5739 compile code the same as @samp{-msdata=eabi}, otherwise compile code the
5740 same as @samp{-msdata=sysv}.
5742 @item -msdata-data
5743 On System V.4 and embedded PowerPC systems, put small global and static
5744 data in the @samp{.sdata} section.  Put small uninitialized global and
5745 static data in the @samp{.sbss} section.  Do not use register @code{r13}
5746 to address small data however.  This is the default behavior unless
5747 other @samp{-msdata} options are used.
5749 @item -msdata=none
5750 @itemx -mno-sdata
5751 On embedded PowerPC systems, put all initialized global and static data
5752 in the @samp{.data} section, and all uninitialized data in the
5753 @samp{.bss} section.
5755 @item -G @var{num}
5756 @cindex smaller data references (PowerPC)
5757 @cindex .sdata/.sdata2 references (PowerPC)
5758 On embedded PowerPC systems, put global and static items less than or
5759 equal to @var{num} bytes into the small data or bss sections instead of
5760 the normal data or bss section.  By default, @var{num} is 8.  The
5761 @samp{-G @var{num}} switch is also passed to the linker.
5762 All modules should be compiled with the same @samp{-G @var{num}} value.
5764 @item -mregnames
5765 @itemx -mno-regnames
5766 On System V.4 and embedded PowerPC systems do (do not) emit register
5767 names in the assembly language output using symbolic forms.
5769 @end table
5771 @node RT Options
5772 @subsection IBM RT Options
5773 @cindex RT options
5774 @cindex IBM RT options
5776 These @samp{-m} options are defined for the IBM RT PC:
5778 @table @code
5779 @item -min-line-mul
5780 Use an in-line code sequence for integer multiplies.  This is the
5781 default.
5783 @item -mcall-lib-mul
5784 Call @code{lmul$$} for integer multiples.
5786 @item -mfull-fp-blocks
5787 Generate full-size floating point data blocks, including the minimum
5788 amount of scratch space recommended by IBM.  This is the default.
5790 @item -mminimum-fp-blocks
5791 Do not include extra scratch space in floating point data blocks.  This
5792 results in smaller code, but slower execution, since scratch space must
5793 be allocated dynamically.
5795 @cindex @file{varargs.h} and RT PC
5796 @cindex @file{stdarg.h} and RT PC
5797 @item -mfp-arg-in-fpregs
5798 Use a calling sequence incompatible with the IBM calling convention in
5799 which floating point arguments are passed in floating point registers.
5800 Note that @code{varargs.h} and @code{stdargs.h} will not work with
5801 floating point operands if this option is specified.
5803 @item -mfp-arg-in-gregs
5804 Use the normal calling convention for floating point arguments.  This is
5805 the default.
5807 @item -mhc-struct-return
5808 Return structures of more than one word in memory, rather than in a
5809 register.  This provides compatibility with the MetaWare HighC (hc)
5810 compiler.  Use the option @samp{-fpcc-struct-return} for compatibility
5811 with the Portable C Compiler (pcc).
5813 @item -mnohc-struct-return
5814 Return some structures of more than one word in registers, when
5815 convenient.  This is the default.  For compatibility with the
5816 IBM-supplied compilers, use the option @samp{-fpcc-struct-return} or the
5817 option @samp{-mhc-struct-return}.
5818 @end table
5820 @node MIPS Options
5821 @subsection MIPS Options
5822 @cindex MIPS options
5824 These @samp{-m} options are defined for the MIPS family of computers:
5826 @table @code
5827 @item -mcpu=@var{cpu type}
5828 Assume the defaults for the machine type @var{cpu type} when scheduling
5829 instructions.  The choices for @var{cpu type} are @samp{r2000}, @samp{r3000},
5830 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
5831 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
5832 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
5833 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
5834 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.  While picking a specific
5835 @var{cpu type} will schedule things appropriately for that particular
5836 chip, the compiler will not generate any code that does not meet level 1
5837 of the MIPS ISA (instruction set architecture) without a @samp{-mipsX}
5838 or @samp{-mabi} switch being used.
5840 @item -mips1
5841 Issue instructions from level 1 of the MIPS ISA.  This is the default.
5842 @samp{r3000} is the default @var{cpu type} at this ISA level.
5844 @item -mips2
5845 Issue instructions from level 2 of the MIPS ISA (branch likely, square
5846 root instructions).  @samp{r6000} is the default @var{cpu type} at this
5847 ISA level.
5849 @item -mips3
5850 Issue instructions from level 3 of the MIPS ISA (64 bit instructions).
5851 @samp{r4000} is the default @var{cpu type} at this ISA level.
5853 @item -mips4
5854 Issue instructions from level 4 of the MIPS ISA (conditional move,
5855 prefetch, enhanced FPU instructions).  @samp{r8000} is the default
5856 @var{cpu type} at this ISA level.
5858 @item -mfp32
5859 Assume that 32 32-bit floating point registers are available.  This is
5860 the default.
5862 @item -mfp64
5863 Assume that 32 64-bit floating point registers are available.  This is
5864 the default when the @samp{-mips3} option is used.
5866 @item -mgp32
5867 Assume that 32 32-bit general purpose registers are available.  This is
5868 the default.
5870 @item -mgp64
5871 Assume that 32 64-bit general purpose registers are available.  This is
5872 the default when the @samp{-mips3} option is used.
5874 @item -mint64
5875 Force int and long types to be 64 bits wide.  See @samp{-mlong32} for an
5876 explanation of the default, and the width of pointers.
5878 @item -mlong64
5879 Force long types to be 64 bits wide.  See @samp{-mlong32} for an
5880 explanation of the default, and the width of pointers.
5882 @item -mlong32
5883 Force long, int, and pointer types to be 32 bits wide.
5885 If none of @samp{-mlong32}, @samp{-mlong64}, or @samp{-mint64} are set,
5886 the size of ints, longs, and pointers depends on the ABI and ISA chosen.
5887 For @samp{-mabi=32}, and @samp{-mabi=n32}, ints and longs are 32 bits
5888 wide.  For @samp{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
5889 For @samp{-mabi=eabi} and either @samp{-mips1} or @samp{-mips2}, ints
5890 and longs are 32 bits wide.  For @samp{-mabi=eabi} and higher ISAs, ints
5891 are 32 bits, and longs are 64 bits wide.  The width of pointer types is
5892 the smaller of the width of longs or the width of general purpose
5893 registers (which in turn depends on the ISA).
5895 @item -mabi=32
5896 @itemx -mabi=o64
5897 @itemx -mabi=n32
5898 @itemx -mabi=64
5899 @itemx -mabi=eabi
5900 Generate code for the indicated ABI.  The default instruction level is
5901 @samp{-mips1} for @samp{32}, @samp{-mips3} for @samp{n32}, and
5902 @samp{-mips4} otherwise.  Conversely, with @samp{-mips1} or
5903 @samp{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
5904 is @samp{64}.
5906 @item -mmips-as
5907 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
5908 add normal debug information.  This is the default for all
5909 platforms except for the OSF/1 reference platform, using the OSF/rose
5910 object format.  If the either of the @samp{-gstabs} or @samp{-gstabs+}
5911 switches are used, the @file{mips-tfile} program will encapsulate the
5912 stabs within MIPS ECOFF.
5914 @item -mgas
5915 Generate code for the GNU assembler.  This is the default on the OSF/1
5916 reference platform, using the OSF/rose object format.  Also, this is
5917 the default if the configure option @samp{--with-gnu-as} is used.
5919 @item -msplit-addresses
5920 @itemx -mno-split-addresses
5921 Generate code to load the high and low parts of address constants separately.
5922 This allows @code{gcc} to optimize away redundant loads of the high order
5923 bits of addresses.  This optimization requires GNU as and GNU ld.
5924 This optimization is enabled by default for some embedded targets where
5925 GNU as and GNU ld are standard.
5927 @item -mrnames
5928 @itemx -mno-rnames
5929 The @samp{-mrnames} switch says to output code using the MIPS software
5930 names for the registers, instead of the hardware names (ie, @var{a0}
5931 instead of @var{$4}).  The only known assembler that supports this option
5932 is the Algorithmics assembler.
5934 @item -mgpopt
5935 @itemx -mno-gpopt
5936 The @samp{-mgpopt} switch says to write all of the data declarations
5937 before the instructions in the text section, this allows the MIPS
5938 assembler to generate one word memory references instead of using two
5939 words for short global or static data items.  This is on by default if
5940 optimization is selected.
5942 @item -mstats
5943 @itemx -mno-stats
5944 For each non-inline function processed, the @samp{-mstats} switch
5945 causes the compiler to emit one line to the standard error file to
5946 print statistics about the program (number of registers saved, stack
5947 size, etc.).
5949 @item -mmemcpy
5950 @itemx -mno-memcpy
5951 The @samp{-mmemcpy} switch makes all block moves call the appropriate
5952 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
5953 generating inline code.
5955 @item -mmips-tfile
5956 @itemx -mno-mips-tfile
5957 The @samp{-mno-mips-tfile} switch causes the compiler not
5958 postprocess the object file with the @file{mips-tfile} program,
5959 after the MIPS assembler has generated it to add debug support.  If
5960 @file{mips-tfile} is not run, then no local variables will be
5961 available to the debugger.  In addition, @file{stage2} and
5962 @file{stage3} objects will have the temporary file names passed to the
5963 assembler embedded in the object file, which means the objects will
5964 not compare the same.  The @samp{-mno-mips-tfile} switch should only
5965 be used when there are bugs in the @file{mips-tfile} program that
5966 prevents compilation.
5968 @item -msoft-float
5969 Generate output containing library calls for floating point.
5970 @strong{Warning:} the requisite libraries are not part of GCC.
5971 Normally the facilities of the machine's usual C compiler are used, but
5972 this can't be done directly in cross-compilation.  You must make your
5973 own arrangements to provide suitable library functions for
5974 cross-compilation.
5976 @item -mhard-float
5977 Generate output containing floating point instructions.  This is the
5978 default if you use the unmodified sources.
5980 @item -mabicalls
5981 @itemx -mno-abicalls
5982 Emit (or do not emit) the pseudo operations @samp{.abicalls},
5983 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
5984 position independent code.
5986 @item -mlong-calls
5987 @itemx -mno-long-calls
5988 Do all calls with the @samp{JALR} instruction, which requires
5989 loading up a function's address into a register before the call.
5990 You need to use this switch, if you call outside of the current
5991 512 megabyte segment to functions that are not through pointers.
5993 @item -mhalf-pic
5994 @itemx -mno-half-pic
5995 Put pointers to extern references into the data section and load them
5996 up, rather than put the references in the text section.
5998 @item -membedded-pic
5999 @itemx -mno-embedded-pic
6000 Generate PIC code suitable for some embedded systems.  All calls are
6001 made using PC relative address, and all data is addressed using the $gp
6002 register.  No more than 65536 bytes of global data may be used.  This
6003 requires GNU as and GNU ld which do most of the work.  This currently
6004 only works on targets which use ECOFF; it does not work with ELF.
6006 @item -membedded-data
6007 @itemx -mno-embedded-data
6008 Allocate variables to the read-only data section first if possible, then
6009 next in the small data section if possible, otherwise in data.  This gives
6010 slightly slower code than the default, but reduces the amount of RAM required
6011 when executing, and thus may be preferred for some embedded systems.
6013 @item -muninit-const-in-rodata
6014 @itemx -mno-uninit-const-in-rodata
6015 When used together with -membedded-data, it will always store uninitialized
6016 const variables in the read-only data section.
6017   
6018 @item -msingle-float
6019 @itemx -mdouble-float
6020 The @samp{-msingle-float} switch tells gcc to assume that the floating
6021 point coprocessor only supports single precision operations, as on the
6022 @samp{r4650} chip.  The @samp{-mdouble-float} switch permits gcc to use
6023 double precision operations.  This is the default.
6025 @item -mmad
6026 @itemx -mno-mad
6027 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
6028 as on the @samp{r4650} chip.
6030 @item -m4650
6031 Turns on @samp{-msingle-float}, @samp{-mmad}, and, at least for now,
6032 @samp{-mcpu=r4650}.
6034 @item -mips16
6035 @itemx -mno-mips16
6036 Enable 16-bit instructions.
6038 @item -mentry
6039 Use the entry and exit pseudo ops.  This option can only be used with
6040 @samp{-mips16}.
6042 @item -EL
6043 Compile code for the processor in little endian mode.
6044 The requisite libraries are assumed to exist.
6046 @item -EB
6047 Compile code for the processor in big endian mode.
6048 The requisite libraries are assumed to exist.
6050 @item -G @var{num}
6051 @cindex smaller data references (MIPS)
6052 @cindex gp-relative references (MIPS)
6053 Put global and static items less than or equal to @var{num} bytes into
6054 the small data or bss sections instead of the normal data or bss
6055 section.  This allows the assembler to emit one word memory reference
6056 instructions based on the global pointer (@var{gp} or @var{$28}),
6057 instead of the normal two words used.  By default, @var{num} is 8 when
6058 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
6059 @samp{-G @var{num}} switch is also passed to the assembler and linker.
6060 All modules should be compiled with the same @samp{-G @var{num}}
6061 value.
6063 @item -nocpp
6064 Tell the MIPS assembler to not run its preprocessor over user
6065 assembler files (with a @samp{.s} suffix) when assembling them.
6067 @item -mfix7000
6068 Pass an option to gas which will cause nops to be inserted if
6069 the read of the destination register of an mfhi or mflo instruction
6070 occurs in the following two instructions.
6072 @item -no-crt0
6073 Do not include the default crt0.
6074 @end table
6076 @ifset INTERNALS
6077 These options are defined by the macro
6078 @code{TARGET_SWITCHES} in the machine description.  The default for the
6079 options is also defined by that macro, which enables you to change the
6080 defaults.
6081 @end ifset
6083 @node i386 Options
6084 @subsection Intel 386 Options
6085 @cindex i386 Options
6086 @cindex Intel 386 Options
6088 These @samp{-m} options are defined for the i386 family of computers:
6090 @table @code
6091 @item -mcpu=@var{cpu type}
6092 Assume the defaults for the machine type @var{cpu type} when scheduling
6093 instructions.  The choices for @var{cpu type} are:
6095 @multitable @columnfractions .20 .20 .20 .20
6096 @item @samp{i386} @tab @samp{i486} @tab @samp{i586} @tab @samp{i686}
6097 @item @samp{pentium} @tab @samp{pentiumpro} @tab @samp{k6} @tab @samp{athlon}
6098 @end multitable
6100 While picking a specific @var{cpu type} will schedule things appropriately
6101 for that particular chip, the compiler will not generate any code that
6102 does not run on the i386 without the @samp{-march=@var{cpu type}} option
6103 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
6104 is equivalent to @samp{pentiumpro}.  @samp{k6} is the AMD chip as
6105 opposed to the Intel ones.
6107 @item -march=@var{cpu type}
6108 Generate instructions for the machine type @var{cpu type}.  The choices
6109 for @var{cpu type} are the same as for @samp{-mcpu}.  Moreover, 
6110 specifying @samp{-march=@var{cpu type}} implies @samp{-mcpu=@var{cpu type}}.
6112 @item -m386
6113 @itemx -m486
6114 @itemx -mpentium
6115 @itemx -mpentiumpro
6116 Synonyms for -mcpu=i386, -mcpu=i486, -mcpu=pentium, and -mcpu=pentiumpro
6117 respectively.  These synonyms are deprecated.
6119 @item -mintel-syntax
6120 Emit assembly using Intel syntax opcodes instead of AT&T syntax.
6122 @item -mieee-fp
6123 @itemx -mno-ieee-fp
6124 Control whether or not the compiler uses IEEE floating point
6125 comparisons.  These handle correctly the case where the result of a
6126 comparison is unordered.
6128 @item -msoft-float
6129 Generate output containing library calls for floating point.
6130 @strong{Warning:} the requisite libraries are not part of GCC.
6131 Normally the facilities of the machine's usual C compiler are used, but
6132 this can't be done directly in cross-compilation.  You must make your
6133 own arrangements to provide suitable library functions for
6134 cross-compilation.
6136 On machines where a function returns floating point results in the 80387
6137 register stack, some floating point opcodes may be emitted even if
6138 @samp{-msoft-float} is used.
6140 @item -mno-fp-ret-in-387
6141 Do not use the FPU registers for return values of functions.
6143 The usual calling convention has functions return values of types
6144 @code{float} and @code{double} in an FPU register, even if there
6145 is no FPU.  The idea is that the operating system should emulate
6146 an FPU.
6148 The option @samp{-mno-fp-ret-in-387} causes such values to be returned
6149 in ordinary CPU registers instead.
6151 @item -mno-fancy-math-387
6152 Some 387 emulators do not support the @code{sin}, @code{cos} and
6153 @code{sqrt} instructions for the 387.  Specify this option to avoid
6154 generating those instructions. This option is the default on FreeBSD.
6155 As of revision 2.6.1, these instructions are not generated unless you
6156 also use the @samp{-ffast-math} switch.
6158 @item -malign-double
6159 @itemx -mno-align-double
6160 Control whether GCC aligns @code{double}, @code{long double}, and
6161 @code{long long} variables on a two word boundary or a one word
6162 boundary.  Aligning @code{double} variables on a two word boundary will
6163 produce code that runs somewhat faster on a @samp{Pentium} at the
6164 expense of more memory.
6166 @strong{Warning:} if you use the @samp{-malign-double} switch,
6167 structures containing the above types will be aligned differently than
6168 the published application binary interface specifications for the 386.
6170 @item -msvr3-shlib
6171 @itemx -mno-svr3-shlib
6172 Control whether GCC places uninitialized locals into @code{bss} or
6173 @code{data}.  @samp{-msvr3-shlib} places these locals into @code{bss}.
6174 These options are meaningful only on System V Release 3.
6176 @item -mno-wide-multiply
6177 @itemx -mwide-multiply
6178 Control whether GCC uses the @code{mul} and @code{imul} that produce
6179 64 bit results in @code{eax:edx} from 32 bit operands to do @code{long
6180 long} multiplies and 32-bit division by constants.
6182 @item -mrtd
6183 Use a different function-calling convention, in which functions that
6184 take a fixed number of arguments return with the @code{ret} @var{num}
6185 instruction, which pops their arguments while returning.  This saves one
6186 instruction in the caller since there is no need to pop the arguments
6187 there.
6189 You can specify that an individual function is called with this calling
6190 sequence with the function attribute @samp{stdcall}.  You can also
6191 override the @samp{-mrtd} option by using the function attribute
6192 @samp{cdecl}.  @xref{Function Attributes}.
6194 @strong{Warning:} this calling convention is incompatible with the one
6195 normally used on Unix, so you cannot use it if you need to call
6196 libraries compiled with the Unix compiler.
6198 Also, you must provide function prototypes for all functions that
6199 take variable numbers of arguments (including @code{printf});
6200 otherwise incorrect code will be generated for calls to those
6201 functions.
6203 In addition, seriously incorrect code will result if you call a
6204 function with too many arguments.  (Normally, extra arguments are
6205 harmlessly ignored.)
6207 @item -mreg-alloc=@var{regs}
6208 Control the default allocation order of integer registers.  The
6209 string @var{regs} is a series of letters specifying a register.  The
6210 supported letters are: @code{a} allocate EAX; @code{b} allocate EBX;
6211 @code{c} allocate ECX; @code{d} allocate EDX; @code{S} allocate ESI;
6212 @code{D} allocate EDI; @code{B} allocate EBP.
6214 @item -mregparm=@var{num}
6215 Control how many registers are used to pass integer arguments.  By
6216 default, no registers are used to pass arguments, and at most 3
6217 registers can be used.  You can control this behavior for a specific
6218 function by using the function attribute @samp{regparm}.
6219 @xref{Function Attributes}.
6221 @strong{Warning:} if you use this switch, and
6222 @var{num} is nonzero, then you must build all modules with the same
6223 value, including any libraries.  This includes the system libraries and
6224 startup modules.
6226 @item -malign-loops=@var{num}
6227 Align loops to a 2 raised to a @var{num} byte boundary.  If
6228 @samp{-malign-loops} is not specified, the default is 2 unless
6229 gas 2.8 (or later) is being used in which case the default is
6230 to align the loop on a 16 byte boundary if it is less than 8
6231 bytes away.
6233 @item -malign-jumps=@var{num}
6234 Align instructions that are only jumped to to a 2 raised to a @var{num}
6235 byte boundary.  If @samp{-malign-jumps} is not specified, the default is
6236 2 if optimizing for a 386, and 4 if optimizing for a 486 unless
6237 gas 2.8 (or later) is being used in which case the default is
6238 to align the instruction on a 16 byte boundary if it is less
6239 than 8 bytes away.
6241 @item -malign-functions=@var{num}
6242 Align the start of functions to a 2 raised to @var{num} byte boundary.
6243 If @samp{-malign-functions} is not specified, the default is 2 if optimizing
6244 for a 386, and 4 if optimizing for a 486.
6246 @item -mpreferred-stack-boundary=@var{num}
6247 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
6248 byte boundary.  If @samp{-mpreferred-stack-boundary} is not specified,
6249 the default is 4 (16 bytes or 128 bits).
6251 The stack is required to be aligned on a 4 byte boundary.  On Pentium
6252 and PentiumPro, @code{double} and @code{long double} values should be
6253 aligned to an 8 byte boundary (see @samp{-malign-double}) or suffer
6254 significant run time performance penalties.  On Pentium III, the
6255 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
6256 penalties if it is not 16 byte aligned.
6258 To ensure proper alignment of this values on the stack, the stack boundary
6259 must be as aligned as that required by any value stored on the stack. 
6260 Further, every function must be generated such that it keeps the stack
6261 aligned.  Thus calling a function compiled with a higher preferred
6262 stack boundary from a function compiled with a lower preferred stack
6263 boundary will most likely misalign the stack.  It is recommended that
6264 libraries that use callbacks always use the default setting.
6266 This extra alignment does consume extra stack space.  Code that is sensitive
6267 to stack space usage, such as embedded systems and operating system kernels,
6268 may want to reduce the preferred alignment to
6269 @samp{-mpreferred-stack-boundary=2}.
6271 @item -mpush-args
6272 @kindex -mpush-args
6273 Use PUSH operations to store outgoing parameters. This method is shorter
6274 and usually equally fast as method using SUB/MOV operations and is enabled
6275 by default. In some cases disabling it may improve performance because of
6276 improved scheduling and reduced dependencies.
6278 @item -maccumulate-outgoing-args
6279 @kindex -maccumulate-outgoing-args
6280 If enabled, the maximum amount of space required for outgoing arguments will be
6281 computed in the function prologue. This in faster on most modern CPUs
6282 because of reduced dependencies, improved scheduling and reduced stack usage
6283 when preferred stack boundary is not equal to 2.  The drawback is a notable
6284 increase in code size. This switch implies -mno-push-args.
6286 @item -mthreads
6287 @kindex -mthreads
6288 Support thread-safe exception handling on @samp{Mingw32}. Code that relies 
6289 on thread-safe exception handling must compile and link all code with the 
6290 @samp{-mthreads} option. When compiling, @samp{-mthreads} defines 
6291 @samp{-D_MT}; when linking, it links in a special thread helper library 
6292 @samp{-lmingwthrd} which cleans up per thread exception handling data.
6294 @item -mno-align-stringops
6295 @kindex -mno-align-stringops
6296 Do not align destination of inlined string operations. This switch reduces
6297 code size and improves performance in case the destination is already aligned,
6298 but gcc don't know about it.
6300 @item -minline-all-stringops
6301 @kindex -minline-all-stringops
6302 By default GCC inlines string operations only when destination is known to be
6303 aligned at least to 4 byte boundary. This enables more inlining, increase code
6304 size, but may improve performance of code that depends on fast memcpy, strlen
6305 and memset for short lengths.
6306 @end table
6308 @node HPPA Options
6309 @subsection HPPA Options
6310 @cindex HPPA Options
6312 These @samp{-m} options are defined for the HPPA family of computers:
6314 @table @code
6315 @item -march=@var{architecture type}
6316 Generate code for the specified architecture.  The choices for
6317 @var{architecture type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
6318 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
6319 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
6320 architecture option for your machine.  Code compiled for lower numbered
6321 architectures will run on higher numbered architectures, but not the
6322 other way around.
6324 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
6325 next release of binutils (current is 2.9.1) will probably contain PA 2.0
6326 support.  
6328 @item -mpa-risc-1-0
6329 @itemx -mpa-risc-1-1
6330 @itemx -mpa-risc-2-0
6331 Synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively.
6333 @item -mbig-switch
6334 Generate code suitable for big switch tables.  Use this option only if
6335 the assembler/linker complain about out of range branches within a switch
6336 table.
6338 @item -mjump-in-delay
6339 Fill delay slots of function calls with unconditional jump instructions
6340 by modifying the return pointer for the function call to be the target
6341 of the conditional jump.
6343 @item -mdisable-fpregs
6344 Prevent floating point registers from being used in any manner.  This is
6345 necessary for compiling kernels which perform lazy context switching of
6346 floating point registers.  If you use this option and attempt to perform
6347 floating point operations, the compiler will abort.
6349 @item -mdisable-indexing
6350 Prevent the compiler from using indexing address modes.  This avoids some
6351 rather obscure problems when compiling MIG generated code under MACH.
6353 @item -mno-space-regs
6354 Generate code that assumes the target has no space registers.  This allows
6355 GCC to generate faster indirect calls and use unscaled index address modes.
6357 Such code is suitable for level 0 PA systems and kernels.
6359 @item -mfast-indirect-calls
6360 Generate code that assumes calls never cross space boundaries.  This
6361 allows GCC to emit code which performs faster indirect calls.
6363 This option will not work in the presence of shared libraries or nested
6364 functions.
6366 @item -mlong-load-store
6367 Generate 3-instruction load and store sequences as sometimes required by
6368 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
6369 the HP compilers.
6371 @item -mportable-runtime
6372 Use the portable calling conventions proposed by HP for ELF systems.
6374 @item -mgas
6375 Enable the use of assembler directives only GAS understands.
6377 @item -mschedule=@var{cpu type}
6378 Schedule code according to the constraints for the machine type
6379 @var{cpu type}.  The choices for @var{cpu type} are @samp{700} 
6380 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}.  Refer to 
6381 @file{/usr/lib/sched.models} on an HP-UX system to determine the
6382 proper scheduling option for your machine.
6384 @item -mlinker-opt
6385 Enable the optimization pass in the HPUX linker.  Note this makes symbolic
6386 debugging impossible.  It also triggers a bug in the HPUX 8 and HPUX 9 linkers
6387 in which they give bogus error messages when linking some programs.
6389 @item -msoft-float
6390 Generate output containing library calls for floating point.
6391 @strong{Warning:} the requisite libraries are not available for all HPPA
6392 targets.  Normally the facilities of the machine's usual C compiler are
6393 used, but this cannot be done directly in cross-compilation.  You must make
6394 your own arrangements to provide suitable library functions for
6395 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
6396 does provide software floating point support.
6398 @samp{-msoft-float} changes the calling convention in the output file;
6399 therefore, it is only useful if you compile @emph{all} of a program with
6400 this option.  In particular, you need to compile @file{libgcc.a}, the
6401 library that comes with GCC, with @samp{-msoft-float} in order for
6402 this to work.
6403 @end table
6405 @node Intel 960 Options
6406 @subsection Intel 960 Options
6408 These @samp{-m} options are defined for the Intel 960 implementations:
6410 @table @code
6411 @item -m@var{cpu type}
6412 Assume the defaults for the machine type @var{cpu type} for some of
6413 the other options, including instruction scheduling, floating point
6414 support, and addressing modes.  The choices for @var{cpu type} are
6415 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
6416 @samp{sa}, and @samp{sb}.
6417 The default is
6418 @samp{kb}.
6420 @item -mnumerics
6421 @itemx -msoft-float
6422 The @samp{-mnumerics} option indicates that the processor does support
6423 floating-point instructions.  The @samp{-msoft-float} option indicates
6424 that floating-point support should not be assumed.
6426 @item -mleaf-procedures
6427 @itemx -mno-leaf-procedures
6428 Do (or do not) attempt to alter leaf procedures to be callable with the
6429 @code{bal} instruction as well as @code{call}.  This will result in more
6430 efficient code for explicit calls when the @code{bal} instruction can be
6431 substituted by the assembler or linker, but less efficient code in other
6432 cases, such as calls via function pointers, or using a linker that doesn't
6433 support this optimization.
6435 @item -mtail-call
6436 @itemx -mno-tail-call
6437 Do (or do not) make additional attempts (beyond those of the
6438 machine-independent portions of the compiler) to optimize tail-recursive
6439 calls into branches.  You may not want to do this because the detection of
6440 cases where this is not valid is not totally complete.  The default is
6441 @samp{-mno-tail-call}.
6443 @item -mcomplex-addr
6444 @itemx -mno-complex-addr
6445 Assume (or do not assume) that the use of a complex addressing mode is a
6446 win on this implementation of the i960.  Complex addressing modes may not
6447 be worthwhile on the K-series, but they definitely are on the C-series.
6448 The default is currently @samp{-mcomplex-addr} for all processors except
6449 the CB and CC.
6451 @item -mcode-align
6452 @itemx -mno-code-align
6453 Align code to 8-byte boundaries for faster fetching (or don't bother).
6454 Currently turned on by default for C-series implementations only.
6456 @ignore
6457 @item -mclean-linkage
6458 @itemx -mno-clean-linkage
6459 These options are not fully implemented.
6460 @end ignore
6462 @item -mic-compat
6463 @itemx -mic2.0-compat
6464 @itemx -mic3.0-compat
6465 Enable compatibility with iC960 v2.0 or v3.0.
6467 @item -masm-compat
6468 @itemx -mintel-asm
6469 Enable compatibility with the iC960 assembler.
6471 @item -mstrict-align
6472 @itemx -mno-strict-align
6473 Do not permit (do permit) unaligned accesses.
6475 @item -mold-align
6476 Enable structure-alignment compatibility with Intel's gcc release version
6477 1.3 (based on gcc 1.37).  This option implies @samp{-mstrict-align}.
6479 @item -mlong-double-64
6480 Implement type @samp{long double} as 64-bit floating point numbers.
6481 Without the option @samp{long double} is implemented by 80-bit
6482 floating point numbers.  The only reason we have it because there is
6483 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
6484 is only useful for people using soft-float targets.  Otherwise, we
6485 should recommend against use of it.
6487 @end table
6489 @node DEC Alpha Options
6490 @subsection DEC Alpha Options
6492 These @samp{-m} options are defined for the DEC Alpha implementations:
6494 @table @code
6495 @item -mno-soft-float
6496 @itemx -msoft-float
6497 Use (do not use) the hardware floating-point instructions for
6498 floating-point operations.  When @code{-msoft-float} is specified,
6499 functions in @file{libgcc1.c} will be used to perform floating-point
6500 operations.  Unless they are replaced by routines that emulate the
6501 floating-point operations, or compiled in such a way as to call such
6502 emulations routines, these routines will issue floating-point
6503 operations.   If you are compiling for an Alpha without floating-point
6504 operations, you must ensure that the library is built so as not to call
6505 them.
6507 Note that Alpha implementations without floating-point operations are
6508 required to have floating-point registers.
6510 @item -mfp-reg
6511 @itemx -mno-fp-regs
6512 Generate code that uses (does not use) the floating-point register set.
6513 @code{-mno-fp-regs} implies @code{-msoft-float}.  If the floating-point
6514 register set is not used, floating point operands are passed in integer
6515 registers as if they were integers and floating-point results are passed
6516 in $0 instead of $f0.  This is a non-standard calling sequence, so any
6517 function with a floating-point argument or return value called by code
6518 compiled with @code{-mno-fp-regs} must also be compiled with that
6519 option.
6521 A typical use of this option is building a kernel that does not use,
6522 and hence need not save and restore, any floating-point registers.
6524 @item -mieee
6525 The Alpha architecture implements floating-point hardware optimized for
6526 maximum performance.  It is mostly compliant with the IEEE floating
6527 point standard.  However, for full compliance, software assistance is
6528 required.  This option generates code fully IEEE compliant code
6529 @emph{except} that the @var{inexact flag} is not maintained (see below).
6530 If this option is turned on, the CPP macro @code{_IEEE_FP} is defined
6531 during compilation.  The option is a shorthand for: @samp{-D_IEEE_FP
6532 -mfp-trap-mode=su -mtrap-precision=i -mieee-conformant}.  The resulting
6533 code is less efficient but is able to correctly support denormalized
6534 numbers and exceptional IEEE values such as not-a-number and plus/minus
6535 infinity.  Other Alpha compilers call this option
6536 @code{-ieee_with_no_inexact}.
6538 @item -mieee-with-inexact
6539 @c overfull hbox here --bob 22 jul96
6540 @c original text between ignore ... end ignore
6541 @ignore
6542 This is like @samp{-mieee} except the generated code also maintains the
6543 IEEE @var{inexact flag}.  Turning on this option causes the generated
6544 code to implement fully-compliant IEEE math.  The option is a shorthand
6545 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus @samp{-mieee-conformant},
6546 @samp{-mfp-trap-mode=sui}, and @samp{-mtrap-precision=i}.  On some Alpha
6547 implementations the resulting code may execute significantly slower than
6548 the code generated by default.  Since there is very little code that
6549 depends on the @var{inexact flag}, you should normally not specify this
6550 option.  Other Alpha compilers call this option
6551 @samp{-ieee_with_inexact}.
6552 @end ignore
6553 @c            changed paragraph
6554 This is like @samp{-mieee} except the generated code also maintains the
6555 IEEE @var{inexact flag}.  Turning on this option causes the generated
6556 code to implement fully-compliant IEEE math.  The option is a shorthand
6557 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus the three following:
6558 @samp{-mieee-conformant},
6559 @samp{-mfp-trap-mode=sui}, 
6560 and @samp{-mtrap-precision=i}.  
6561 On some Alpha implementations the resulting code may execute
6562 significantly slower than the code generated by default.  Since there
6563 is very little code that depends on the @var{inexact flag}, you should
6564 normally not specify this option.  Other Alpha compilers call this
6565 option @samp{-ieee_with_inexact}.
6566 @c             end changes to prevent overfull hboxes
6568 @item -mfp-trap-mode=@var{trap mode}
6569 This option controls what floating-point related traps are enabled.
6570 Other Alpha compilers call this option @samp{-fptm }@var{trap mode}.
6571 The trap mode can be set to one of four values:
6573 @table @samp
6574 @item n
6575 This is the default (normal) setting.  The only traps that are enabled
6576 are the ones that cannot be disabled in software (e.g., division by zero
6577 trap).
6579 @item u
6580 In addition to the traps enabled by @samp{n}, underflow traps are enabled
6581 as well.
6583 @item su
6584 Like @samp{su}, but the instructions are marked to be safe for software
6585 completion (see Alpha architecture manual for details).
6587 @item sui
6588 Like @samp{su}, but inexact traps are enabled as well.
6589 @end table
6591 @item -mfp-rounding-mode=@var{rounding mode}
6592 Selects the IEEE rounding mode.  Other Alpha compilers call this option
6593 @samp{-fprm }@var{rounding mode}.  The @var{rounding mode} can be one
6596 @table @samp
6597 @item n
6598 Normal IEEE rounding mode.  Floating point numbers are rounded towards
6599 the nearest machine number or towards the even machine number in case
6600 of a tie.
6602 @item m
6603 Round towards minus infinity.
6605 @item c
6606 Chopped rounding mode.  Floating point numbers are rounded towards zero.
6608 @item d
6609 Dynamic rounding mode.  A field in the floating point control register
6610 (@var{fpcr}, see Alpha architecture reference manual) controls the
6611 rounding mode in effect.  The C library initializes this register for
6612 rounding towards plus infinity.  Thus, unless your program modifies the
6613 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
6614 @end table
6616 @item -mtrap-precision=@var{trap precision}
6617 In the Alpha architecture, floating point traps are imprecise.  This
6618 means without software assistance it is impossible to recover from a
6619 floating trap and program execution normally needs to be terminated.
6620 GCC can generate code that can assist operating system trap handlers
6621 in determining the exact location that caused a floating point trap.
6622 Depending on the requirements of an application, different levels of
6623 precisions can be selected:
6625 @table @samp
6626 @item p
6627 Program precision.  This option is the default and means a trap handler
6628 can only identify which program caused a floating point exception.
6630 @item f
6631 Function precision.  The trap handler can determine the function that
6632 caused a floating point exception.
6634 @item i
6635 Instruction precision.  The trap handler can determine the exact
6636 instruction that caused a floating point exception.
6637 @end table
6639 Other Alpha compilers provide the equivalent options called
6640 @samp{-scope_safe} and @samp{-resumption_safe}.
6642 @item -mieee-conformant
6643 This option marks the generated code as IEEE conformant.  You must not
6644 use this option unless you also specify @samp{-mtrap-precision=i} and either
6645 @samp{-mfp-trap-mode=su} or @samp{-mfp-trap-mode=sui}.  Its only effect
6646 is to emit the line @samp{.eflag 48} in the function prologue of the
6647 generated assembly file.  Under DEC Unix, this has the effect that
6648 IEEE-conformant math library routines will be linked in.
6650 @item -mbuild-constants
6651 Normally GCC examines a 32- or 64-bit integer constant to
6652 see if it can construct it from smaller constants in two or three
6653 instructions.  If it cannot, it will output the constant as a literal and
6654 generate code to load it from the data segment at runtime.
6656 Use this option to require GCC to construct @emph{all} integer constants
6657 using code, even if it takes more instructions (the maximum is six).
6659 You would typically use this option to build a shared library dynamic
6660 loader.  Itself a shared library, it must relocate itself in memory
6661 before it can find the variables and constants in its own data segment.
6663 @item -malpha-as
6664 @itemx -mgas
6665 Select whether to generate code to be assembled by the vendor-supplied
6666 assembler (@samp{-malpha-as}) or by the GNU assembler @samp{-mgas}.
6668 @item -mbwx
6669 @itemx -mno-bwx
6670 @itemx -mcix
6671 @itemx -mno-cix
6672 @itemx -mmax
6673 @itemx -mno-max
6674 Indicate whether GCC should generate code to use the optional BWX,
6675 CIX, and MAX instruction sets.  The default is to use the instruction sets
6676 supported by the CPU type specified via @samp{-mcpu=} option or that
6677 of the CPU on which GCC was built if none was specified.
6679 @item -mcpu=@var{cpu_type}
6680 Set the instruction set, register set, and instruction scheduling
6681 parameters for machine type @var{cpu_type}.  You can specify either the
6682 @samp{EV} style name or the corresponding chip number.  GCC
6683 supports scheduling parameters for the EV4 and EV5 family of processors
6684 and will choose the default values for the instruction set from
6685 the processor you specify.  If you do not specify a processor type,
6686 GCC will default to the processor on which the compiler was built.
6688 Supported values for @var{cpu_type} are
6690 @table @samp
6691 @item ev4
6692 @itemx 21064
6693 Schedules as an EV4 and has no instruction set extensions.
6695 @item ev5
6696 @itemx 21164
6697 Schedules as an EV5 and has no instruction set extensions.
6699 @item ev56
6700 @itemx 21164a
6701 Schedules as an EV5 and supports the BWX extension.
6703 @item pca56
6704 @itemx 21164pc
6705 @itemx 21164PC
6706 Schedules as an EV5 and supports the BWX and MAX extensions.
6708 @item ev6
6709 @itemx 21264
6710 Schedules as an EV5 (until Digital releases the scheduling parameters
6711 for the EV6) and supports the BWX, CIX, and MAX extensions.
6712 @end table
6714 @item -mmemory-latency=@var{time}
6715 Sets the latency the scheduler should assume for typical memory
6716 references as seen by the application.  This number is highly
6717 dependent on the memory access patterns used by the application
6718 and the size of the external cache on the machine.
6720 Valid options for @var{time} are
6722 @table @samp
6723 @item @var{number}
6724 A decimal number representing clock cycles.
6726 @item L1
6727 @itemx L2
6728 @itemx L3
6729 @itemx main
6730 The compiler contains estimates of the number of clock cycles for
6731 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
6732 (also called Dcache, Scache, and Bcache), as well as to main memory.
6733 Note that L3 is only valid for EV5.
6735 @end table
6736 @end table
6738 @node Clipper Options
6739 @subsection Clipper Options
6741 These @samp{-m} options are defined for the Clipper implementations:
6743 @table @code
6744 @item -mc300
6745 Produce code for a C300 Clipper processor. This is the default.
6747 @item -mc400
6748 Produce code for a C400 Clipper processor i.e. use floating point
6749 registers f8..f15.
6750 @end table
6752 @node H8/300 Options
6753 @subsection H8/300 Options
6755 These @samp{-m} options are defined for the H8/300 implementations:
6757 @table @code
6758 @item -mrelax
6759 Shorten some address references at link time, when possible; uses the
6760 linker option @samp{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
6761 ld.info, Using ld}, for a fuller description.
6763 @item -mh
6764 Generate code for the H8/300H.
6766 @item -ms
6767 Generate code for the H8/S.
6769 @item -ms2600
6770 Generate code for the H8/S2600.  This switch must be used with -ms.
6772 @item -mint32
6773 Make @code{int} data 32 bits by default.
6775 @item -malign-300
6776 On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
6777 The default for the H8/300H and H8/S is to align longs and floats on 4
6778 byte boundaries.
6779 @samp{-malign-300} causes them to be aligned on 2 byte boundaries.
6780 This option has no effect on the H8/300.
6781 @end table
6783 @node SH Options
6784 @subsection SH Options
6786 These @samp{-m} options are defined for the SH implementations:
6788 @table @code
6789 @item -m1
6790 Generate code for the SH1.
6792 @item -m2
6793 Generate code for the SH2.
6795 @item -m3
6796 Generate code for the SH3.
6798 @item -m3e
6799 Generate code for the SH3e.
6801 @item -m4-nofpu
6802 Generate code for the SH4 without a floating-point unit.
6804 @item -m4-single-only
6805 Generate code for the SH4 with a floating-point unit that only
6806 supports single-precision arithmentic.
6808 @item -m4-single
6809 Generate code for the SH4 assuming the floating-point unit is in
6810 single-precision mode by default.
6812 @item -m4
6813 Generate code for the SH4.
6815 @item -mb
6816 Compile code for the processor in big endian mode.
6818 @item -ml
6819 Compile code for the processor in little endian mode.
6821 @item -mdalign
6822 Align doubles at 64 bit boundaries.  Note that this changes the calling
6823 conventions, and thus some functions from the standard C library will
6824 not work unless you recompile it first with -mdalign.
6826 @item -mrelax
6827 Shorten some address references at link time, when possible; uses the
6828 linker option @samp{-relax}.
6830 @item -mbigtable
6831 Use 32-bit offsets in @code{switch} tables.  The default is to use
6832 16-bit offsets.
6834 @item -mfmovd
6835 Enable the use of the instruction @code{fmovd}.
6837 @item -mhitachi
6838 Comply with the calling conventions defined by Hitachi.
6840 @item -mnomacsave
6841 Mark the @code{MAC} register as call-clobbered, even if
6842 @code{-mhitachi} is given.
6844 @item -misize
6845 Dump instruction size and location in the assembly code.
6847 @item -mpadstruct
6848 This option is deprecated.  It pads structures to multiple of 4 bytes,
6849 which is incompatible with the SH ABI.
6851 @item -mspace
6852 Optimize for space instead of speed.  Implied by @code{-Os}.
6854 @item -mprefergot
6855 When generating position-independent code, emit function calls using
6856 the Global Offset Table instead of the Procedure Linkage Table.
6858 @item -musermode
6859 Generate a library function call to invalidate instruction cache
6860 entries, after fixing up a trampoline.  This library function call
6861 doesn't assume it can write to the whole memory address space.  This
6862 is the default when the target is @code{sh-*-linux*}.
6863 @end table
6865 @node System V Options
6866 @subsection Options for System V
6868 These additional options are available on System V Release 4 for
6869 compatibility with other compilers on those systems:
6871 @table @code
6872 @item -G
6873 Create a shared object.
6874 It is recommended that @samp{-symbolic} or @samp{-shared} be used instead.
6876 @item -Qy
6877 Identify the versions of each tool used by the compiler, in a
6878 @code{.ident} assembler directive in the output.
6880 @item -Qn
6881 Refrain from adding @code{.ident} directives to the output file (this is
6882 the default).
6884 @item -YP,@var{dirs}
6885 Search the directories @var{dirs}, and no others, for libraries
6886 specified with @samp{-l}.
6888 @item -Ym,@var{dir}
6889 Look in the directory @var{dir} to find the M4 preprocessor.
6890 The assembler uses this option.
6891 @c This is supposed to go with a -Yd for predefined M4 macro files, but
6892 @c the generic assembler that comes with Solaris takes just -Ym.
6893 @end table
6895 @node TMS320C3x/C4x Options
6896 @subsection TMS320C3x/C4x Options
6897 @cindex TMS320C3x/C4x Options
6899 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
6901 @table @code
6903 @item -mcpu=@var{cpu_type}
6904 Set the instruction set, register set, and instruction scheduling
6905 parameters for machine type @var{cpu_type}.  Supported values for
6906 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
6907 @samp{c44}.  The default is @samp{c40} to generate code for the
6908 TMS320C40.
6910 @item -mbig-memory
6911 @item -mbig
6912 @itemx -msmall-memory
6913 @itemx -msmall
6914 Generates code for the big or small memory model.  The small memory
6915 model assumed that all data fits into one 64K word page.  At run-time
6916 the data page (DP) register must be set to point to the 64K page
6917 containing the .bss and .data program sections.  The big memory model is
6918 the default and requires reloading of the DP register for every direct
6919 memory access.
6921 @item -mbk
6922 @itemx -mno-bk
6923 Allow (disallow) allocation of general integer operands into the block
6924 count register BK. 
6926 @item -mdb
6927 @itemx -mno-db
6928 Enable (disable) generation of code using decrement and branch,
6929 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
6930 on the safe side, this is disabled for the C3x, since the maximum
6931 iteration count on the C3x is 2^23 + 1 (but who iterates loops more than
6932 2^23 times on the C3x?).  Note that GCC will try to reverse a loop so
6933 that it can utilise the decrement and branch instruction, but will give
6934 up if there is more than one memory reference in the loop.  Thus a loop
6935 where the loop counter is decremented can generate slightly more
6936 efficient code, in cases where the RPTB instruction cannot be utilised.
6938 @item -mdp-isr-reload
6939 @itemx -mparanoid
6940 Force the DP register to be saved on entry to an interrupt service
6941 routine (ISR), reloaded to point to the data section, and restored on
6942 exit from the ISR.  This should not be required unless someone has
6943 violated the small memory model by modifying the DP register, say within
6944 an object library.
6946 @item -mmpyi
6947 @itemx -mno-mpyi
6948 For the C3x use the 24-bit MPYI instruction for integer multiplies
6949 instead of a library call to guarantee 32-bit results.  Note that if one
6950 of the operands is a constant, then the multiplication will be performed
6951 using shifts and adds.  If the -mmpyi option is not specified for the C3x,
6952 then squaring operations are performed inline instead of a library call.
6954 @item -mfast-fix
6955 @itemx -mno-fast-fix
6956 The C3x/C4x FIX instruction to convert a floating point value to an
6957 integer value chooses the nearest integer less than or equal to the
6958 floating point value rather than to the nearest integer.  Thus if the
6959 floating point number is negative, the result will be incorrectly
6960 truncated an additional code is necessary to detect and correct this
6961 case.  This option can be used to disable generation of the additional
6962 code required to correct the result.
6964 @item -mrptb
6965 @itemx -mno-rptb
6966 Enable (disable) generation of repeat block sequences using the RPTB
6967 instruction for zero overhead looping.  The RPTB construct is only used
6968 for innermost loops that do not call functions or jump across the loop
6969 boundaries.  There is no advantage having nested RPTB loops due to the
6970 overhead required to save and restore the RC, RS, and RE registers.
6971 This is enabled by default with -O2.
6973 @item -mrpts=@var{count}
6974 @itemx -mno-rpts
6975 Enable (disable) the use of the single instruction repeat instruction
6976 RPTS.  If a repeat block contains a single instruction, and the loop
6977 count can be guaranteed to be less than the value @var{count}, GCC will
6978 emit a RPTS instruction instead of a RPTB.  If no value is specified,
6979 then a RPTS will be emitted even if the loop count cannot be determined
6980 at compile time.  Note that the repeated instruction following RPTS does
6981 not have to be reloaded from memory each iteration, thus freeing up the
6982 CPU buses for operands.  However, since interrupts are blocked by this
6983 instruction, it is disabled by default.
6985 @item -mloop-unsigned
6986 @itemx -mno-loop-unsigned
6987 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
6988 is 2^31 + 1 since these instructions test if the iteration count is
6989 negative to terminate the loop.  If the iteration count is unsigned
6990 there is a possibility than the 2^31 + 1 maximum iteration count may be
6991 exceeded.  This switch allows an unsigned iteration count.
6993 @item -mti
6994 Try to emit an assembler syntax that the TI assembler (asm30) is happy
6995 with.  This also enforces compatibility with the API employed by the TI
6996 C3x C compiler.  For example, long doubles are passed as structures
6997 rather than in floating point registers.
6999 @item -mregparm
7000 @itemx -mmemparm
7001 Generate code that uses registers (stack) for passing arguments to functions.
7002 By default, arguments are passed in registers where possible rather
7003 than by pushing arguments on to the stack.
7005 @item -mparallel-insns
7006 @itemx -mno-parallel-insns
7007 Allow the generation of parallel instructions.  This is enabled by
7008 default with -O2.
7010 @item -mparallel-mpy
7011 @itemx -mno-parallel-mpy
7012 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
7013 provided -mparallel-insns is also specified.  These instructions have
7014 tight register constraints which can pessimize the code generation
7015 of large functions.
7017 @end table
7019 @node V850 Options
7020 @subsection V850 Options
7021 @cindex V850 Options
7023 These @samp{-m} options are defined for V850 implementations:
7025 @table @code
7026 @item -mlong-calls
7027 @itemx -mno-long-calls
7028 Treat all calls as being far away (near).  If calls are assumed to be
7029 far away, the compiler will always load the functions address up into a
7030 register, and call indirect through the pointer.
7032 @item -mno-ep
7033 @itemx -mep
7034 Do not optimize (do optimize) basic blocks that use the same index
7035 pointer 4 or more times to copy pointer into the @code{ep} register, and
7036 use the shorter @code{sld} and @code{sst} instructions.  The @samp{-mep}
7037 option is on by default if you optimize.
7039 @item -mno-prolog-function
7040 @itemx -mprolog-function
7041 Do not use (do use) external functions to save and restore registers at
7042 the prolog and epilog of a function.  The external functions are slower,
7043 but use less code space if more than one function saves the same number
7044 of registers.  The @samp{-mprolog-function} option is on by default if
7045 you optimize.
7047 @item -mspace
7048 Try to make the code as small as possible.  At present, this just turns
7049 on the @samp{-mep} and @samp{-mprolog-function} options.
7051 @item -mtda=@var{n}
7052 Put static or global variables whose size is @var{n} bytes or less into
7053 the tiny data area that register @code{ep} points to.  The tiny data
7054 area can hold up to 256 bytes in total (128 bytes for byte references).
7056 @item -msda=@var{n}
7057 Put static or global variables whose size is @var{n} bytes or less into
7058 the small data area that register @code{gp} points to.  The small data
7059 area can hold up to 64 kilobytes.
7061 @item -mzda=@var{n}
7062 Put static or global variables whose size is @var{n} bytes or less into
7063 the first 32 kilobytes of memory.
7065 @item -mv850
7066 Specify that the target processor is the V850.
7068 @item -mbig-switch
7069 Generate code suitable for big switch tables.  Use this option only if
7070 the assembler/linker complain about out of range branches within a switch
7071 table.
7072 @end table
7074 @node ARC Options
7075 @subsection ARC Options
7076 @cindex ARC Options
7078 These options are defined for ARC implementations:
7080 @table @code
7081 @item -EL
7082 Compile code for little endian mode.  This is the default.
7084 @item -EB
7085 Compile code for big endian mode.
7087 @item -mmangle-cpu
7088 Prepend the name of the cpu to all public symbol names.
7089 In multiple-processor systems, there are many ARC variants with different
7090 instruction and register set characteristics.  This flag prevents code
7091 compiled for one cpu to be linked with code compiled for another.
7092 No facility exists for handling variants that are "almost identical".
7093 This is an all or nothing option.
7095 @item -mcpu=@var{cpu}
7096 Compile code for ARC variant @var{cpu}.
7097 Which variants are supported depend on the configuration.
7098 All variants support @samp{-mcpu=base}, this is the default.
7100 @item -mtext=@var{text section}
7101 @itemx -mdata=@var{data section}
7102 @itemx -mrodata=@var{readonly data section}
7103 Put functions, data, and readonly data in @var{text section},
7104 @var{data section}, and @var{readonly data section} respectively
7105 by default.  This can be overridden with the @code{section} attribute.
7106 @xref{Variable Attributes}.
7108 @end table
7110 @node NS32K Options
7111 @subsection NS32K Options
7112 @cindex NS32K options
7114 These are the @samp{-m} options defined for the 32000 series.  The default
7115 values for these options depends on which style of 32000 was selected when
7116 the compiler was configured; the defaults for the most common choices are
7117 given below.
7119 @table @code
7120 @item -m32032
7121 @itemx -m32032
7122 Generate output for a 32032.  This is the default
7123 when the compiler is configured for 32032 and 32016 based systems.
7125 @item -m32332
7126 @itemx -m32332
7127 Generate output for a 32332.  This is the default
7128 when the compiler is configured for 32332-based systems.
7130 @item -m32532
7131 @itemx -m32532
7132 Generate output for a 32532.  This is the default
7133 when the compiler is configured for 32532-based systems.
7135 @item -m32081
7136 Generate output containing 32081 instructions for floating point.
7137 This is the default for all systems.
7139 @item -m32381
7140 Generate output containing 32381 instructions for floating point.  This
7141 also implies @samp{-m32081}. The 32381 is only compatible with the 32332
7142 and 32532 cpus. This is the default for the pc532-netbsd configuration.
7144 @item -mmulti-add
7145 Try and generate multiply-add floating point instructions @code{polyF}
7146 and @code{dotF}. This option is only available if the @samp{-m32381}
7147 option is in effect. Using these instructions requires changes to to
7148 register allocation which generally has a negative impact on
7149 performance.  This option should only be enabled when compiling code
7150 particularly likely to make heavy use of multiply-add instructions.
7152 @item -mnomulti-add
7153 Do not try and generate multiply-add floating point instructions
7154 @code{polyF} and @code{dotF}. This is the default on all platforms.
7156 @item -msoft-float
7157 Generate output containing library calls for floating point.
7158 @strong{Warning:} the requisite libraries may not be available.
7160 @item -mnobitfield
7161 Do not use the bit-field instructions. On some machines it is faster to
7162 use shifting and masking operations. This is the default for the pc532.
7164 @item -mbitfield
7165 Do use the bit-field instructions. This is the default for all platforms
7166 except the pc532.
7168 @item -mrtd
7169 Use a different function-calling convention, in which functions
7170 that take a fixed number of arguments return pop their
7171 arguments on return with the @code{ret} instruction.
7173 This calling convention is incompatible with the one normally
7174 used on Unix, so you cannot use it if you need to call libraries
7175 compiled with the Unix compiler.
7177 Also, you must provide function prototypes for all functions that
7178 take variable numbers of arguments (including @code{printf});
7179 otherwise incorrect code will be generated for calls to those
7180 functions.
7182 In addition, seriously incorrect code will result if you call a
7183 function with too many arguments.  (Normally, extra arguments are
7184 harmlessly ignored.)
7186 This option takes its name from the 680x0 @code{rtd} instruction.
7189 @item -mregparam
7190 Use a different function-calling convention where the first two arguments
7191 are passed in registers.
7193 This calling convention is incompatible with the one normally
7194 used on Unix, so you cannot use it if you need to call libraries
7195 compiled with the Unix compiler.
7197 @item -mnoregparam
7198 Do not pass any arguments in registers. This is the default for all
7199 targets.
7201 @item -msb
7202 It is OK to use the sb as an index register which is always loaded with
7203 zero. This is the default for the pc532-netbsd target.
7205 @item -mnosb
7206 The sb register is not available for use or has not been initialized to
7207 zero by the run time system. This is the default for all targets except
7208 the pc532-netbsd. It is also implied whenever @samp{-mhimem} or
7209 @samp{-fpic} is set.
7211 @item -mhimem
7212 Many ns32000 series addressing modes use displacements of up to 512MB.
7213 If an address is above 512MB then displacements from zero can not be used.
7214 This option causes code to be generated which can be loaded above 512MB.
7215 This may be useful for operating systems or ROM code.
7217 @item -mnohimem
7218 Assume code will be loaded in the first 512MB of virtual address space.
7219 This is the default for all platforms.
7222 @end table
7224 @node AVR Options
7225 @subsection AVR Options
7226 @cindex AVR Options
7228 These options are defined for AVR implementations:
7230 @table @code
7231 @item -mmcu=@var{mcu}
7232 Specify ATMEL AVR mcu (at90s23xx,attiny22,at90s44xx,at90s85xx,atmega603,
7233 atmega103).
7235 @item -msize
7236 Output instruction size's to the asm file
7238 @item -minit-stack=@var{N}
7239 Specify the initial stack address
7241 @item -mno-interrupts
7242 Generated code is not compatible with hardware interrupts.
7243 Code size will be smaller.
7245 @item -mcall-prologues
7246 Functions prologues/epilogues expanded as call to appropriate
7247 subroutines. Code size will be smaller.
7248 @end table
7250 @node MCore Options
7251 @subsection MCore Options
7252 @cindex MCore options
7254 These are the @samp{-m} options defined for the Motorola M*Core
7255 processors.  
7257 @table @code
7259 @item -mhardlit
7260 @itemx -mhardlit
7261 @itemx -mno-hardlit
7262 Inline constants into the code stream if it can be done in two
7263 instructions or less.
7265 @item -mdiv
7266 @itemx -mdiv
7267 @itemx -mno-div
7268 Use the divide instruction.  (Enabled by default).
7270 @item -mrelax-immediate
7271 @itemx -mrelax-immediate
7272 @itemx -mno-relax-immediate
7273 Allow arbitrary sized immediates in bit operations.
7275 @item -mwide-bitfields
7276 @itemx -mwide-bitfields
7277 @itemx -mno-wide-bitfields
7278 Always treat bitfields as int-sized.
7280 @item -m4byte-functions
7281 @itemx -m4byte-functions
7282 @itemx -mno-4byte-functions
7283 Force all functions to be aligned to a four byte boundary.
7285 @item -mcallgraph-data
7286 @itemx -mcallgraph-data
7287 @itemx -mno-callgraph-data
7288 Emit callgraph information.
7290 @item -mslow-bytes
7291 @itemx -mslow-bytes
7292 @itemx -mno-slow-bytes
7293 Prefer word access when reading byte quantities.
7295 @item -mlittle-endian
7296 @itemx -mlittle-endian
7297 @itemx -mbig-endian
7298 Generate code for a little endian target.
7300 @item -m210
7301 @itemx -m210
7302 @itemx -m340
7303 Generate code for the 210 processor.
7304 @end table
7306 @node D30V Options
7307 @subsection D30V Options
7308 @cindex D30V Options
7310 These @samp{-m} options are defined for D30V implementations:
7312 @table @code
7313 @item -mextmem
7314 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
7315 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
7316 memory, which starts at location @code{0x80000000}.
7318 @item -mextmemory
7319 Same as the @samp{-mextmem} switch.
7321 @item -monchip
7322 Link the @samp{.text} section into onchip text memory, which starts at
7323 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
7324 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
7325 into onchip data memory, which starts at location @code{0x20000000}.
7327 @item -mno-asm-optimize
7328 @itemx -masm-optimize
7329 Disable (enable) passing @samp{-O} to the assembler when optimizing.
7330 The assembler uses the @samp{-O} option to automatically parallelize
7331 adjacent short instructions where possible.
7333 @item -mbranch-cost=@var{n}
7334 Increase the internal costs of branches to @var{n}.  Higher costs means
7335 that the compiler will issue more instructions to avoid doing a branch.
7336 The default is 2.
7338 @item -mcond-exec=@var{n}
7339 Specify the maximum number of conditionally executed instructions that
7340 replace a branch.  The default is 4.
7341 @end table
7343 @node Code Gen Options
7344 @section Options for Code Generation Conventions
7345 @cindex code generation conventions
7346 @cindex options, code generation
7347 @cindex run-time options
7349 These machine-independent options control the interface conventions
7350 used in code generation.
7352 Most of them have both positive and negative forms; the negative form
7353 of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below, only
7354 one of the forms is listed---the one which is not the default.  You
7355 can figure out the other form by either removing @samp{no-} or adding
7358 @table @code
7359 @item -fexceptions
7360 Enable exception handling. Generates extra code needed to propagate
7361 exceptions.  For some targets, this implies GNU CC will generate frame
7362 unwind information for all functions, which can produce significant data
7363 size overhead, although it does not affect execution.  If you do not
7364 specify this option, GNU CC will enable it by default for languages like
7365 C++ which normally require exception handling, and disable itfor
7366 languages like C that do not normally require it.  However, you may need
7367 to enable this option when compiling C code that needs to interoperate
7368 properly with exception handlers written in C++.  You may also wish to
7369 disable this option if you are compiling older C++ programs that don't
7370 use exception handling.
7372 @item -funwind-tables
7373 Similar to @code{-fexceptions}, except that it will just generate any needed
7374 static data, but will not affect the generated code in any other way.
7375 You will normally not enable this option; instead, a language processor
7376 that needs this handling would enable it on your behalf.
7378 @item -fpcc-struct-return
7379 Return ``short'' @code{struct} and @code{union} values in memory like
7380 longer ones, rather than in registers.  This convention is less
7381 efficient, but it has the advantage of allowing intercallability between
7382 GCC-compiled files and files compiled with other compilers.
7384 The precise convention for returning structures in memory depends
7385 on the target configuration macros.
7387 Short structures and unions are those whose size and alignment match
7388 that of some integer type.
7390 @item -freg-struct-return
7391 Use the convention that @code{struct} and @code{union} values are
7392 returned in registers when possible.  This is more efficient for small
7393 structures than @samp{-fpcc-struct-return}.
7395 If you specify neither @samp{-fpcc-struct-return} nor its contrary
7396 @samp{-freg-struct-return}, GCC defaults to whichever convention is
7397 standard for the target.  If there is no standard convention, GCC
7398 defaults to @samp{-fpcc-struct-return}, except on targets where GCC
7399 is the principal compiler.  In those cases, we can choose the standard,
7400 and we chose the more efficient register return alternative.
7402 @item -fshort-enums
7403 Allocate to an @code{enum} type only as many bytes as it needs for the
7404 declared range of possible values.  Specifically, the @code{enum} type
7405 will be equivalent to the smallest integer type which has enough room.
7407 @item -fshort-double
7408 Use the same size for @code{double} as for @code{float}.
7410 @item -fshared-data
7411 Requests that the data and non-@code{const} variables of this
7412 compilation be shared data rather than private data.  The distinction
7413 makes sense only on certain operating systems, where shared data is
7414 shared between processes running the same program, while private data
7415 exists in one copy per process.
7417 @item -fno-common
7418 Allocate even uninitialized global variables in the data section of the
7419 object file, rather than generating them as common blocks.  This has the
7420 effect that if the same variable is declared (without @code{extern}) in
7421 two different compilations, you will get an error when you link them.
7422 The only reason this might be useful is if you wish to verify that the
7423 program will work on other systems which always work this way.
7425 @item -fno-ident
7426 Ignore the @samp{#ident} directive.
7428 @item -fno-gnu-linker
7429 Do not output global initializations (such as C++ constructors and
7430 destructors) in the form used by the GNU linker (on systems where the GNU
7431 linker is the standard method of handling them).  Use this option when
7432 you want to use a non-GNU linker, which also requires using the
7433 @code{collect2} program to make sure the system linker includes
7434 constructors and destructors.  (@code{collect2} is included in the GCC
7435 distribution.)  For systems which @emph{must} use @code{collect2}, the
7436 compiler driver @code{gcc} is configured to do this automatically.
7438 @item -finhibit-size-directive
7439 Don't output a @code{.size} assembler directive, or anything else that
7440 would cause trouble if the function is split in the middle, and the
7441 two halves are placed at locations far apart in memory.  This option is
7442 used when compiling @file{crtstuff.c}; you should not need to use it
7443 for anything else.
7445 @item -fverbose-asm
7446 Put extra commentary information in the generated assembly code to
7447 make it more readable.  This option is generally only of use to those
7448 who actually need to read the generated assembly code (perhaps while
7449 debugging the compiler itself).
7451 @samp{-fno-verbose-asm}, the default, causes the
7452 extra information to be omitted and is useful when comparing two assembler
7453 files.
7455 @item -fvolatile
7456 Consider all memory references through pointers to be volatile.
7458 @item -fvolatile-global
7459 Consider all memory references to extern and global data items to
7460 be volatile.  GCC does not consider static data items to be volatile
7461 because of this switch.
7463 @item -fvolatile-static
7464 Consider all memory references to static data to be volatile.
7466 @item -fpic
7467 @cindex global offset table
7468 @cindex PIC
7469 Generate position-independent code (PIC) suitable for use in a shared
7470 library, if supported for the target machine.  Such code accesses all
7471 constant addresses through a global offset table (GOT).  The dynamic
7472 loader resolves the GOT entries when the program starts (the dynamic
7473 loader is not part of GCC; it is part of the operating system).  If
7474 the GOT size for the linked executable exceeds a machine-specific
7475 maximum size, you get an error message from the linker indicating that
7476 @samp{-fpic} does not work; in that case, recompile with @samp{-fPIC}
7477 instead.  (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
7478 on the m68k and RS/6000.  The 386 has no such limit.)
7480 Position-independent code requires special support, and therefore works
7481 only on certain machines.  For the 386, GCC supports PIC for System V
7482 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
7483 position-independent.
7485 @item -fPIC
7486 If supported for the target machine, emit position-independent code,
7487 suitable for dynamic linking and avoiding any limit on the size of the
7488 global offset table.  This option makes a difference on the m68k, m88k,
7489 and the Sparc.
7491 Position-independent code requires special support, and therefore works
7492 only on certain machines.
7494 @item -ffixed-@var{reg}
7495 Treat the register named @var{reg} as a fixed register; generated code
7496 should never refer to it (except perhaps as a stack pointer, frame
7497 pointer or in some other fixed role).
7499 @var{reg} must be the name of a register.  The register names accepted
7500 are machine-specific and are defined in the @code{REGISTER_NAMES}
7501 macro in the machine description macro file.
7503 This flag does not have a negative form, because it specifies a
7504 three-way choice.
7506 @item -fcall-used-@var{reg}
7507 Treat the register named @var{reg} as an allocable register that is
7508 clobbered by function calls.  It may be allocated for temporaries or
7509 variables that do not live across a call.  Functions compiled this way
7510 will not save and restore the register @var{reg}.
7512 It is an error to used this flag with the frame pointer or stack pointer.
7513 Use of this flag for other registers that have fixed pervasive roles in
7514 the machine's execution model will produce disastrous results.
7516 This flag does not have a negative form, because it specifies a
7517 three-way choice.
7519 @item -fcall-saved-@var{reg}
7520 Treat the register named @var{reg} as an allocable register saved by
7521 functions.  It may be allocated even for temporaries or variables that
7522 live across a call.  Functions compiled this way will save and restore
7523 the register @var{reg} if they use it.
7525 It is an error to used this flag with the frame pointer or stack pointer.
7526 Use of this flag for other registers that have fixed pervasive roles in
7527 the machine's execution model will produce disastrous results.
7529 A different sort of disaster will result from the use of this flag for
7530 a register in which function values may be returned.
7532 This flag does not have a negative form, because it specifies a
7533 three-way choice.
7535 @item -fpack-struct
7536 Pack all structure members together without holes.  Usually you would
7537 not want to use this option, since it makes the code suboptimal, and
7538 the offsets of structure members won't agree with system libraries.
7540 @item -fcheck-memory-usage
7541 Generate extra code to check each memory access.  GCC will generate
7542 code that is suitable for a detector of bad memory accesses such as
7543 @file{Checker}.
7545 Normally, you should compile all, or none, of your code with this option.
7547 If you do mix code compiled with and without this option,
7548 you must ensure that all code that has side effects
7549 and that is called by code compiled with this option
7550 is, itself, compiled with this option.
7551 If you do not, you might get erroneous messages from the detector.
7553 If you use functions from a library that have side-effects (such as
7554 @code{read}), you might not be able to recompile the library and
7555 specify this option.  In that case, you can enable the
7556 @samp{-fprefix-function-name} option, which requests GCC to encapsulate
7557 your code and make other functions look as if they were compiled with
7558 @samp{-fcheck-memory-usage}.  This is done by calling ``stubs'',
7559 which are provided by the detector.  If you cannot find or build
7560 stubs for every function you call, you might have to specify
7561 @samp{-fcheck-memory-usage} without @samp{-fprefix-function-name}.
7563 If you specify this option, you can not use the @code{asm} or
7564 @code{__asm__} keywords in functions with memory checking enabled.  GNU
7565 CC cannot understand what the @code{asm} statement may do, and therefore
7566 cannot generate the appropriate code, so it will reject it.  However, if
7567 you specify the function attribute @code{no_check_memory_usage} (see
7568 @pxref{Function Attributes}, GNU CC will disable memory checking within a
7569 function; you may use @code{asm} statements inside such functions.  You
7570 may have an inline expansion of a non-checked function within a checked
7571 function; in that case GNU CC will not generate checks for the inlined
7572 function's memory accesses.
7574 If you move your @code{asm} statements to non-checked inline functions
7575 and they do access memory, you can add calls to the support code in your
7576 inline function, to indicate any reads, writes, or copies being done.
7577 These calls would be similar to those done in the stubs described above.
7579 @item -fprefix-function-name
7580 Request GCC to add a prefix to the symbols generated for function names.
7581 GCC adds a prefix to the names of functions defined as well as
7582 functions called.  Code compiled with this option and code compiled
7583 without the option can't be linked together, unless stubs are used.
7585 If you compile the following code with @samp{-fprefix-function-name}
7586 @example
7587 extern void bar (int);
7588 void
7589 foo (int a)
7591   return bar (a + 5);
7593 @end example
7595 @noindent
7596 GCC will compile the code as if it was written:
7597 @example
7598 extern void prefix_bar (int);
7599 void
7600 prefix_foo (int a)
7602   return prefix_bar (a + 5);
7604 @end example
7605 This option is designed to be used with @samp{-fcheck-memory-usage}.
7607 @item -finstrument-functions
7608 Generate instrumentation calls for entry and exit to functions.  Just
7609 after function entry and just before function exit, the following
7610 profiling functions will be called with the address of the current
7611 function and its call site.  (On some platforms,
7612 @code{__builtin_return_address} does not work beyond the current
7613 function, so the call site information may not be available to the
7614 profiling functions otherwise.)
7616 @example
7617 void __cyg_profile_func_enter (void *this_fn, void *call_site);
7618 void __cyg_profile_func_exit  (void *this_fn, void *call_site);
7619 @end example
7621 The first argument is the address of the start of the current function,
7622 which may be looked up exactly in the symbol table.
7624 This instrumentation is also done for functions expanded inline in other
7625 functions.  The profiling calls will indicate where, conceptually, the
7626 inline function is entered and exited.  This means that addressable
7627 versions of such functions must be available.  If all your uses of a
7628 function are expanded inline, this may mean an additional expansion of
7629 code size.  If you use @samp{extern inline} in your C code, an
7630 addressable version of such functions must be provided.  (This is
7631 normally the case anyways, but if you get lucky and the optimizer always
7632 expands the functions inline, you might have gotten away without
7633 providing static copies.)
7635 A function may be given the attribute @code{no_instrument_function}, in
7636 which case this instrumentation will not be done.  This can be used, for
7637 example, for the profiling functions listed above, high-priority
7638 interrupt routines, and any functions from which the profiling functions
7639 cannot safely be called (perhaps signal handlers, if the profiling
7640 routines generate output or allocate memory).
7642 @item -fstack-check
7643 Generate code to verify that you do not go beyond the boundary of the
7644 stack.  You should specify this flag if you are running in an
7645 environment with multiple threads, but only rarely need to specify it in
7646 a single-threaded environment since stack overflow is automatically
7647 detected on nearly all systems if there is only one stack.
7649 Note that this switch does not actually cause checking to be done; the
7650 operating system must do that.  The switch causes generation of code
7651 to ensure that the operating system sees the stack being extended.
7653 @item -fstack-limit-register=@var{reg}
7654 @itemx -fstack-limit-symbol=@var{sym}
7655 @itemx -fno-stack-limit
7656 Generate code to ensure that the stack does not grow beyond a certain value,
7657 either the value of a register or the address of a symbol.  If the stack
7658 would grow beyond the value, a signal is raised.  For most targets,
7659 the signal is raised before the stack overruns the boundary, so
7660 it is possible to catch the signal without taking special precautions.
7662 For instance, if the stack starts at address @samp{0x80000000} and grows
7663 downwards you can use the flags
7664 @samp{-fstack-limit-symbol=__stack_limit}
7665 @samp{-Wl,--defsym,__stack_limit=0x7ffe0000} which will enforce a stack
7666 limit of 128K.
7668 @cindex aliasing of parameters
7669 @cindex parameters, aliased
7670 @item -fargument-alias
7671 @itemx -fargument-noalias
7672 @itemx -fargument-noalias-global
7673 Specify the possible relationships among parameters and between
7674 parameters and global data.
7676 @samp{-fargument-alias} specifies that arguments (parameters) may
7677 alias each other and may alias global storage.
7678 @samp{-fargument-noalias} specifies that arguments do not alias
7679 each other, but may alias global storage.
7680 @samp{-fargument-noalias-global} specifies that arguments do not
7681 alias each other and do not alias global storage.
7683 Each language will automatically use whatever option is required by
7684 the language standard.  You should not need to use these options yourself.
7686 @item -fleading-underscore
7687 This option and its counterpart, -fno-leading-underscore, forcibly
7688 change the way C symbols are represented in the object file.  One use
7689 is to help link with legacy assembly code.
7691 Be warned that you should know what you are doing when invoking this
7692 option, and that not all targets provide complete support for it.
7693 @end table
7695 @node Environment Variables
7696 @section Environment Variables Affecting GCC
7697 @cindex environment variables
7699 This section describes several environment variables that affect how GCC
7700 operates.  Some of them work by specifying directories or prefixes to use
7701 when searching for various kinds of files. Some are used to specify other
7702 aspects of the compilation environment.
7704 @ifclear INTERNALS
7705 Note that you can also specify places to search using options such as
7706 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
7707 take precedence over places specified using environment variables, which
7708 in turn take precedence over those specified by the configuration of GCC.
7710 @end ifclear
7711 @ifset INTERNALS
7712 Note that you can also specify places to search using options such as
7713 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
7714 take precedence over places specified using environment variables, which
7715 in turn take precedence over those specified by the configuration of GCC.
7716 @xref{Driver}.
7717 @end ifset
7719 @table @code
7720 @item LANG
7721 @itemx LC_CTYPE
7722 @c @itemx LC_COLLATE
7723 @itemx LC_MESSAGES
7724 @c @itemx LC_MONETARY
7725 @c @itemx LC_NUMERIC
7726 @c @itemx LC_TIME
7727 @itemx LC_ALL
7728 @findex LANG
7729 @findex LC_CTYPE
7730 @c @findex LC_COLLATE
7731 @findex LC_MESSAGES
7732 @c @findex LC_MONETARY
7733 @c @findex LC_NUMERIC
7734 @c @findex LC_TIME
7735 @findex LC_ALL
7736 @cindex locale
7737 These environment variables control the way that GCC uses
7738 localization information that allow GCC to work with different
7739 national conventions.  GCC inspects the locale categories
7740 @code{LC_CTYPE} and @code{LC_MESSAGES} if it has been configured to do
7741 so.  These locale categories can be set to any value supported by your
7742 installation.  A typical value is @samp{en_UK} for English in the United
7743 Kingdom.
7745 The @code{LC_CTYPE} environment variable specifies character
7746 classification.  GCC uses it to determine the character boundaries in
7747 a string; this is needed for some multibyte encodings that contain quote
7748 and escape characters that would otherwise be interpreted as a string
7749 end or escape.
7751 The @code{LC_MESSAGES} environment variable specifies the language to
7752 use in diagnostic messages.
7754 If the @code{LC_ALL} environment variable is set, it overrides the value
7755 of @code{LC_CTYPE} and @code{LC_MESSAGES}; otherwise, @code{LC_CTYPE}
7756 and @code{LC_MESSAGES} default to the value of the @code{LANG}
7757 environment variable.  If none of these variables are set, GCC
7758 defaults to traditional C English behavior.
7760 @item TMPDIR
7761 @findex TMPDIR
7762 If @code{TMPDIR} is set, it specifies the directory to use for temporary
7763 files.  GCC uses temporary files to hold the output of one stage of
7764 compilation which is to be used as input to the next stage: for example,
7765 the output of the preprocessor, which is the input to the compiler
7766 proper.
7768 @item GCC_EXEC_PREFIX
7769 @findex GCC_EXEC_PREFIX
7770 If @code{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
7771 names of the subprograms executed by the compiler.  No slash is added
7772 when this prefix is combined with the name of a subprogram, but you can
7773 specify a prefix that ends with a slash if you wish.
7775 If @code{GCC_EXEC_PREFIX} is not set, GNU CC will attempt to figure out
7776 an appropriate prefix to use based on the pathname it was invoked with.
7778 If GCC cannot find the subprogram using the specified prefix, it
7779 tries looking in the usual places for the subprogram.
7781 The default value of @code{GCC_EXEC_PREFIX} is
7782 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
7783 of @code{prefix} when you ran the @file{configure} script.
7785 Other prefixes specified with @samp{-B} take precedence over this prefix.
7787 This prefix is also used for finding files such as @file{crt0.o} that are
7788 used for linking.
7790 In addition, the prefix is used in an unusual way in finding the
7791 directories to search for header files.  For each of the standard
7792 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
7793 (more precisely, with the value of @code{GCC_INCLUDE_DIR}), GCC tries
7794 replacing that beginning with the specified prefix to produce an
7795 alternate directory name.  Thus, with @samp{-Bfoo/}, GCC will search
7796 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
7797 These alternate directories are searched first; the standard directories
7798 come next.
7800 @item COMPILER_PATH
7801 @findex COMPILER_PATH
7802 The value of @code{COMPILER_PATH} is a colon-separated list of
7803 directories, much like @code{PATH}.  GCC tries the directories thus
7804 specified when searching for subprograms, if it can't find the
7805 subprograms using @code{GCC_EXEC_PREFIX}.
7807 @item LIBRARY_PATH
7808 @findex LIBRARY_PATH
7809 The value of @code{LIBRARY_PATH} is a colon-separated list of
7810 directories, much like @code{PATH}.  When configured as a native compiler,
7811 GCC tries the directories thus specified when searching for special
7812 linker files, if it can't find them using @code{GCC_EXEC_PREFIX}.  Linking
7813 using GCC also uses these directories when searching for ordinary
7814 libraries for the @samp{-l} option (but directories specified with
7815 @samp{-L} come first).
7817 @item C_INCLUDE_PATH
7818 @itemx CPLUS_INCLUDE_PATH
7819 @itemx OBJC_INCLUDE_PATH
7820 @findex C_INCLUDE_PATH
7821 @findex CPLUS_INCLUDE_PATH
7822 @findex OBJC_INCLUDE_PATH
7823 @c @itemx OBJCPLUS_INCLUDE_PATH
7824 These environment variables pertain to particular languages.  Each
7825 variable's value is a colon-separated list of directories, much like
7826 @code{PATH}.  When GCC searches for header files, it tries the
7827 directories listed in the variable for the language you are using, after
7828 the directories specified with @samp{-I} but before the standard header
7829 file directories.
7831 @item DEPENDENCIES_OUTPUT
7832 @findex DEPENDENCIES_OUTPUT
7833 @cindex dependencies for make as output
7834 If this variable is set, its value specifies how to output dependencies
7835 for Make based on the header files processed by the compiler.  This
7836 output looks much like the output from the @samp{-M} option
7837 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
7838 in addition to the usual results of compilation.
7840 The value of @code{DEPENDENCIES_OUTPUT} can be just a file name, in
7841 which case the Make rules are written to that file, guessing the target
7842 name from the source file name.  Or the value can have the form
7843 @samp{@var{file} @var{target}}, in which case the rules are written to
7844 file @var{file} using @var{target} as the target name.
7846 @item LANG
7847 @findex LANG
7848 @cindex locale definition
7849 This variable is used to pass locale information to the compiler. One way in
7850 which this information is used is to determine the character set to be used
7851 when character literals, string literals and comments are parsed in C and C++.
7852 When the compiler is configured to allow multibyte characters,
7853 the following values for @code{LANG} are recognized:
7855 @table @code
7856 @item C-JIS
7857 Recognize JIS characters.
7858 @item C-SJIS
7859 Recognize SJIS characters.
7860 @item C-EUCJP
7861 Recognize EUCJP characters.
7862 @end table
7864 If @code{LANG} is not defined, or if it has some other value, then the
7865 compiler will use mblen and mbtowc as defined by the default locale to
7866 recognize and translate multibyte characters.
7867 @end table
7869 @node Running Protoize
7870 @section Running Protoize
7872 The program @code{protoize} is an optional part of GNU C.  You can use
7873 it to add prototypes to a program, thus converting the program to ANSI
7874 C in one respect.  The companion program @code{unprotoize} does the
7875 reverse: it removes argument types from any prototypes that are found.
7877 When you run these programs, you must specify a set of source files as
7878 command line arguments.  The conversion programs start out by compiling
7879 these files to see what functions they define.  The information gathered
7880 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
7882 After scanning comes actual conversion.  The specified files are all
7883 eligible to be converted; any files they include (whether sources or
7884 just headers) are eligible as well.
7886 But not all the eligible files are converted.  By default,
7887 @code{protoize} and @code{unprotoize} convert only source and header
7888 files in the current directory.  You can specify additional directories
7889 whose files should be converted with the @samp{-d @var{directory}}
7890 option.  You can also specify particular files to exclude with the
7891 @samp{-x @var{file}} option.  A file is converted if it is eligible, its
7892 directory name matches one of the specified directory names, and its
7893 name within the directory has not been excluded.
7895 Basic conversion with @code{protoize} consists of rewriting most
7896 function definitions and function declarations to specify the types of
7897 the arguments.  The only ones not rewritten are those for varargs
7898 functions.
7900 @code{protoize} optionally inserts prototype declarations at the
7901 beginning of the source file, to make them available for any calls that
7902 precede the function's definition.  Or it can insert prototype
7903 declarations with block scope in the blocks where undeclared functions
7904 are called.
7906 Basic conversion with @code{unprotoize} consists of rewriting most
7907 function declarations to remove any argument types, and rewriting
7908 function definitions to the old-style pre-ANSI form.
7910 Both conversion programs print a warning for any function declaration or
7911 definition that they can't convert.  You can suppress these warnings
7912 with @samp{-q}.
7914 The output from @code{protoize} or @code{unprotoize} replaces the
7915 original source file.  The original file is renamed to a name ending
7916 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav} 
7917 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
7918 for DOS) file already exists, then the source file is simply discarded.
7920 @code{protoize} and @code{unprotoize} both depend on GCC itself to
7921 scan the program and collect information about the functions it uses.
7922 So neither of these programs will work until GCC is installed.
7924 Here is a table of the options you can use with @code{protoize} and
7925 @code{unprotoize}.  Each option works with both programs unless
7926 otherwise stated.
7928 @table @code
7929 @item -B @var{directory}
7930 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
7931 usual directory (normally @file{/usr/local/lib}).  This file contains
7932 prototype information about standard system functions.  This option
7933 applies only to @code{protoize}.
7935 @item -c @var{compilation-options}
7936 Use  @var{compilation-options} as the options when running @code{gcc} to
7937 produce the @samp{.X} files.  The special option @samp{-aux-info} is
7938 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
7940 Note that the compilation options must be given as a single argument to
7941 @code{protoize} or @code{unprotoize}.  If you want to specify several
7942 @code{gcc} options, you must quote the entire set of compilation options
7943 to make them a single word in the shell.
7945 There are certain @code{gcc} arguments that you cannot use, because they
7946 would produce the wrong kind of output.  These include @samp{-g},
7947 @samp{-O}, @samp{-c}, @samp{-S}, and @samp{-o} If you include these in
7948 the @var{compilation-options}, they are ignored.
7950 @item -C
7951 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
7952 systems) instead of @samp{.c}.  This is convenient if you are converting 
7953 a C program to C++.  This option applies only to @code{protoize}.
7955 @item -g
7956 Add explicit global declarations.  This means inserting explicit
7957 declarations at the beginning of each source file for each function
7958 that is called in the file and was not declared.  These declarations
7959 precede the first function definition that contains a call to an
7960 undeclared function.  This option applies only to @code{protoize}.
7962 @item -i @var{string}
7963 Indent old-style parameter declarations with the string @var{string}.
7964 This option applies only to @code{protoize}.
7966 @code{unprotoize} converts prototyped function definitions to old-style
7967 function definitions, where the arguments are declared between the
7968 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
7969 uses five spaces as the indentation.  If you want to indent with just
7970 one space instead, use @samp{-i " "}.
7972 @item -k
7973 Keep the @samp{.X} files.  Normally, they are deleted after conversion
7974 is finished.
7976 @item -l
7977 Add explicit local declarations.  @code{protoize} with @samp{-l} inserts
7978 a prototype declaration for each function in each block which calls the
7979 function without any declaration.  This option applies only to
7980 @code{protoize}.
7982 @item -n
7983 Make no real changes.  This mode just prints information about the conversions
7984 that would have been done without @samp{-n}.
7986 @item -N
7987 Make no @samp{.save} files.  The original files are simply deleted.
7988 Use this option with caution.
7990 @item -p @var{program}
7991 Use the program @var{program} as the compiler.  Normally, the name
7992 @file{gcc} is used.
7994 @item -q
7995 Work quietly.  Most warnings are suppressed.
7997 @item -v
7998 Print the version number, just like @samp{-v} for @code{gcc}.
7999 @end table
8001 If you need special compiler options to compile one of your program's
8002 source files, then you should generate that file's @samp{.X} file
8003 specially, by running @code{gcc} on that source file with the
8004 appropriate options and the option @samp{-aux-info}.  Then run
8005 @code{protoize} on the entire set of files.  @code{protoize} will use
8006 the existing @samp{.X} file because it is newer than the source file.
8007 For example:
8009 @example
8010 gcc -Dfoo=bar file1.c -aux-info
8011 protoize *.c
8012 @end example
8014 @noindent
8015 You need to include the special files along with the rest in the
8016 @code{protoize} command, even though their @samp{.X} files already
8017 exist, because otherwise they won't get converted.
8019 @xref{Protoize Caveats}, for more information on how to use
8020 @code{protoize} successfully.