OSDN Git Service

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