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