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