OSDN Git Service

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