* flags.h: New variables align_loops, align_loops_log,
[official-gcc.git] / gcc / invoke.texi
blob84184977466ec79429cc6e73b9d2ae427fa82a72
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}  -fthis-is-variable  -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  -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
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   -fexpensive-optimizations
157 -ffast-math  -ffloat-store  -fforce-addr  -fforce-mem
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 @end table
936 @node C++ Dialect Options
937 @section Options Controlling C++ Dialect
939 @cindex compiler options, C++
940 @cindex C++ options, command line
941 @cindex options, C++
942 This section describes the command-line options that are only meaningful
943 for C++ programs; but you can also use most of the GNU compiler options
944 regardless of what language your program is in.  For example, you
945 might compile a file @code{firstClass.C} like this:
947 @example
948 g++ -g -frepo -O -c firstClass.C
949 @end example
951 @noindent
952 In this example, only @samp{-frepo} is an option meant
953 only for C++ programs; you can use the other options with any
954 language supported by GCC.
956 Here is a list of options that are @emph{only} for compiling C++ programs:
958 @table @code
959 @item -fno-access-control
960 Turn off all access checking.  This switch is mainly useful for working
961 around bugs in the access control code.
963 @item -fcheck-new
964 Check that the pointer returned by @code{operator new} is non-null
965 before attempting to modify the storage allocated.  The current Working
966 Paper requires that @code{operator new} never return a null pointer, so
967 this check is normally unnecessary.
969 An alternative to using this option is to specify that your
970 @code{operator new} does not throw any exceptions; if you declare it
971 @samp{throw()}, g++ will check the return value.  See also @samp{new
972 (nothrow)}.
974 @item -fconserve-space
975 Put uninitialized or runtime-initialized global variables into the
976 common segment, as C does.  This saves space in the executable at the
977 cost of not diagnosing duplicate definitions.  If you compile with this
978 flag and your program mysteriously crashes after @code{main()} has
979 completed, you may have an object that is being destroyed twice because
980 two definitions were merged.
982 This option is no longer useful on most targets, now that support has
983 been added for putting variables into BSS without making them common.
985 @item -fdollars-in-identifiers
986 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
987 @samp{$} with the option @samp{-fno-dollars-in-identifiers}.  (GNU C allows
988 @samp{$} by default on most target systems, but there are a few exceptions.)
989 Traditional C allowed the character @samp{$} to form part of
990 identifiers.  However, ANSI C and C++ forbid @samp{$} in identifiers.
992 @item -fno-elide-constructors
993 The C++ standard allows an implementation to omit creating a temporary
994 which is only used to initialize another object of the same type.
995 Specifying this option disables that optimization, and forces g++ to
996 call the copy constructor in all cases.
998 @item -fexternal-templates
999 Cause template instantiations to obey @samp{#pragma interface} and
1000 @samp{implementation}; template instances are emitted or not according
1001 to the location of the template definition.  @xref{Template
1002 Instantiation}, for more information.
1004 This option is deprecated.
1006 @item -falt-external-templates
1007 Similar to -fexternal-templates, but template instances are emitted or
1008 not according to the place where they are first instantiated.
1009 @xref{Template Instantiation}, for more information.
1011 This option is deprecated.
1013 @item -ffor-scope
1014 @itemx -fno-for-scope
1015 If -ffor-scope is specified, the scope of variables declared in
1016 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1017 as specified by the draft C++ standard.
1018 If -fno-for-scope is specified, the scope of variables declared in
1019 a @i{for-init-statement} extends to the end of the enclosing scope,
1020 as was the case in old versions of gcc, and other (traditional)
1021 implementations of C++.
1023 The default if neither flag is given to follow the standard,
1024 but to allow and give a warning for old-style code that would
1025 otherwise be invalid, or have different behavior.
1027 @item -fno-gnu-keywords
1028 Do not recognize @code{classof}, @code{headof}, or @code{typeof} as a
1029 keyword, so that code can use these words as identifiers.  You can use
1030 the keywords @code{__classof__}, @code{__headof__}, and
1031 @code{__typeof__} instead.  @samp{-ansi} implies
1032 @samp{-fno-gnu-keywords}.
1034 @item -fguiding-decls
1035 Treat a function declaration with the same type as a potential function
1036 template instantiation as though it declares that instantiation, not a
1037 normal function.  If a definition is given for the function later in the
1038 translation unit (or another translation unit if the target supports
1039 weak symbols), that definition will be used; otherwise the template will
1040 be instantiated.  This behavior reflects the C++ language prior to
1041 September 1996, when guiding declarations were removed.
1043 This option implies @samp{-fname-mangling-version-0}, and will not work
1044 with other name mangling versions.  Like all options that change the
1045 ABI, all C++ code, @emph{including libgcc.a} must be built with the same
1046 setting of this option.
1048 @item -fhonor-std
1049 Treat the @code{namespace std} as a namespace, instead of ignoring
1050 it. For compatibility with earlier versions of g++, the compiler will,
1051 by default, ignore @code{namespace-declarations},
1052 @code{using-declarations}, @code{using-directives}, and
1053 @code{namespace-names}, if they involve @code{std}.
1055 @item -fhuge-objects
1056 Support virtual function calls for objects that exceed the size
1057 representable by a @samp{short int}.  Users should not use this flag by
1058 default; if you need to use it, the compiler will tell you so.
1060 This flag is not useful when compiling with -fvtable-thunks.
1062 Like all options that change the ABI, all C++ code, @emph{including
1063 libgcc} must be built with the same setting of this option.
1065 @item -fno-implicit-templates
1066 Never emit code for non-inline templates which are instantiated
1067 implicitly (i.e. by use); only emit code for explicit instantiations.
1068 @xref{Template Instantiation}, for more information.
1070 @item -fno-implicit-inline-templates
1071 Don't emit code for implicit instantiations of inline templates, either.
1072 The default is to handle inlines differently so that compiles with and
1073 without optimization will need the same set of explicit instantiations.
1075 @item -finit-priority
1076 Support @samp{__attribute__ ((init_priority (n)))} for controlling the
1077 order of initialization of file-scope objects.  On ELF targets, this
1078 requires GNU ld 2.10 or later.
1080 @item -fno-implement-inlines
1081 To save space, do not emit out-of-line copies of inline functions
1082 controlled by @samp{#pragma implementation}.  This will cause linker
1083 errors if these functions are not inlined everywhere they are called.
1085 @item -fms-extensions
1086 Disable pedwarns about constructs used in MFC, such as implicit int and
1087 getting a pointer to member function via non-standard syntax.
1089 @item -fname-mangling-version-@var{n}
1090 Control the way in which names are mangled.  Version 0 is compatible
1091 with versions of g++ before 2.8.  Version 1 is the default.  Version 1
1092 will allow correct mangling of function templates.  For example, 
1093 version 0 mangling does not mangle foo<int, double> and foo<int, char>
1094 given this declaration:
1096 @example
1097 template <class T, class U> void foo(T t);
1098 @end example
1100 Like all options that change the ABI, all C++ code, @emph{including
1101 libgcc} must be built with the same setting of this option.
1103 @item -foperator-names
1104 Recognize the operator name keywords @code{and}, @code{bitand},
1105 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1106 synonyms for the symbols they refer to.  @samp{-ansi} implies
1107 @samp{-foperator-names}.
1109 @item -fno-optional-diags
1110 Disable diagnostics that the standard says a compiler does not need to
1111 issue.  Currently, the only such diagnostic issued by g++ is the one for
1112 a name having multiple meanings within a class.
1114 @item -fpermissive
1115 Downgrade messages about nonconformant code from errors to warnings.  By
1116 default, g++ effectively sets @samp{-pedantic-errors} without
1117 @samp{-pedantic}; this option reverses that.  This behavior and this
1118 option are superseded by @samp{-pedantic}, which works as it does for GNU C.
1120 @item -frepo
1121 Enable automatic template instantiation.  This option also implies
1122 @samp{-fno-implicit-templates}.  @xref{Template Instantiation}, for more
1123 information.
1125 @item -fno-rtti
1126 Disable generation of the information used by C++ runtime type
1127 identification features (@samp{dynamic_cast} and @samp{typeid}).  If you
1128 don't use those parts of the language (or exception handling, which uses
1129 @samp{dynamic_cast} internally), you can save some space by using this
1130 flag.
1132 @item -fstrict-prototype
1133 Within an @samp{extern "C"} linkage specification, treat a function
1134 declaration with no arguments, such as @samp{int foo ();}, as declaring
1135 the function to take no arguments.  Normally, such a declaration means
1136 that the function @code{foo} can take any combination of arguments, as
1137 in C.  @samp{-pedantic} implies @samp{-fstrict-prototype} unless
1138 overridden with @samp{-fno-strict-prototype}.
1140 Specifying this option will also suppress implicit declarations of
1141 functions.
1143 This flag no longer affects declarations with C++ linkage.
1145 @item -fsquangle
1146 @itemx -fno-squangle
1147 @samp{-fsquangle} will enable a compressed form of name mangling for
1148 identifiers. In particular, it helps to shorten very long names by recognizing
1149 types and class names which occur more than once, replacing them with special
1150 short ID codes.  This option also requires any C++ libraries being used to
1151 be compiled with this option as well.  The compiler has this disabled (the
1152 equivalent of @samp{-fno-squangle}) by default.
1154 Like all options that change the ABI, all C++ code, @emph{including
1155 libgcc.a} must be built with the same setting of this option.
1157 @item -ftemplate-depth-@var{n}
1158 Set the maximum instantiation depth for template classes to @var{n}.
1159 A limit on the template instantiation depth is needed to detect
1160 endless recursions during template class instantiation. ANSI/ISO C++
1161 conforming programs must not rely on a maximum depth greater than 17.
1163 @item -fthis-is-variable
1164 Permit assignment to @code{this}.  The incorporation of user-defined
1165 free store management into C++ has made assignment to @samp{this} an
1166 anachronism.  Therefore, by default it is invalid to assign to
1167 @code{this} within a class member function; that is, GNU C++ treats
1168 @samp{this} in a member function of class @code{X} as a non-lvalue of
1169 type @samp{X *}.  However, for backwards compatibility, you can make it
1170 valid with @samp{-fthis-is-variable}.
1172 @item -fvtable-thunks
1173 Use @samp{thunks} to implement the virtual function dispatch table
1174 (@samp{vtable}).  The traditional (cfront-style) approach to
1175 implementing vtables was to store a pointer to the function and two
1176 offsets for adjusting the @samp{this} pointer at the call site.  Newer
1177 implementations store a single pointer to a @samp{thunk} function which
1178 does any necessary adjustment and then calls the target function.
1180 This option also enables a heuristic for controlling emission of
1181 vtables; if a class has any non-inline virtual functions, the vtable
1182 will be emitted in the translation unit containing the first one of
1183 those.
1185 Like all options that change the ABI, all C++ code, @emph{including
1186 libgcc.a} must be built with the same setting of this option.
1188 @item -nostdinc++
1189 Do not search for header files in the standard directories specific to
1190 C++, but do still search the other standard directories.  (This option
1191 is used when building the C++ library.)
1192 @end table
1194 In addition, these optimization, warning, and code generation options
1195 have meanings only for C++ programs:
1197 @table @code
1198 @item -fno-default-inline
1199 Do not assume @samp{inline} for functions defined inside a class scope.
1200 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1201 functions will have linkage like inline functions; they just won't be
1202 inlined by default.
1204 @item -Wctor-dtor-privacy (C++ only)
1205 Warn when a class seems unusable, because all the constructors or
1206 destructors in a class are private and the class has no friends or
1207 public static member functions.
1209 @item -Wnon-virtual-dtor (C++ only)
1210 Warn when a class declares a non-virtual destructor that should probably
1211 be virtual, because it looks like the class will be used polymorphically.
1213 @item -Wreorder (C++ only)
1214 @cindex reordering, warning
1215 @cindex warning for reordering of member initializers
1216 Warn when the order of member initializers given in the code does not
1217 match the order in which they must be executed.  For instance:
1219 @smallexample
1220 struct A @{
1221   int i;
1222   int j;
1223   A(): j (0), i (1) @{ @}
1225 @end smallexample
1227 Here the compiler will warn that the member initializers for @samp{i}
1228 and @samp{j} will be rearranged to match the declaration order of the
1229 members.
1230 @end table
1232 The following @samp{-W@dots{}} options are not affected by @samp{-Wall}.
1234 @table @code
1235 @item -Weffc++ (C++ only)
1236 Warn about violations of various style guidelines from Scott Meyers'
1237 @cite{Effective C++} books.  If you use this option, you should be aware
1238 that the standard library headers do not obey all of these guidelines;
1239 you can use @samp{grep -v} to filter out those warnings.
1241 @item -Wno-deprecated (C++ only)
1242 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1244 @item -Wno-non-template-friend (C++ only)
1245 Disable warnings when non-templatized friend functions are declared
1246 within a template. With the advent of explicit template specification
1247 support in g++, if the name of the friend is an unqualified-id (ie,
1248 @samp{friend foo(int)}), the C++ language specification demands that the
1249 friend declare or define an ordinary, nontemplate function. (Section
1250 14.5.3). Before g++ implemented explicit specification, unqualified-ids
1251 could be interpreted as a particular specialization of a templatized
1252 function. Because this non-conforming behavior is no longer the default
1253 behavior for g++, @samp{-Wnon-template-friend} allows the compiler to
1254 check existing code for potential trouble spots, and is on by default.
1255 This new compiler behavior can also be turned off with the flag
1256 @samp{-fguiding-decls}, which activates the older, non-specification
1257 compiler code, or with @samp{-Wno-non-template-friend} which keeps the
1258 conformant compiler code but disables the helpful warning.
1260 @item -Wold-style-cast (C++ only)
1261 Warn if an old-style (C-style) cast is used within a C++ program.  The
1262 new-style casts (@samp{static_cast}, @samp{reinterpret_cast}, and
1263 @samp{const_cast}) are less vulnerable to unintended effects.
1265 @item -Woverloaded-virtual (C++ only)
1266 @cindex overloaded virtual fn, warning
1267 @cindex warning for overloaded virtual fn
1268 Warn when a derived class function declaration may be an error in
1269 defining a virtual function.  In a derived class, the
1270 definitions of virtual functions must match the type signature of a
1271 virtual function declared in the base class.  With this option, the
1272 compiler warns when you define a function with the same name as a
1273 virtual function, but with a type signature that does not match any
1274 declarations from the base class.
1276 @item -Wno-pmf-conversions (C++ only)
1277 Disable the diagnostic for converting a bound pointer to member function
1278 to a plain pointer.
1280 @item -Wsign-promo (C++ only)
1281 Warn when overload resolution chooses a promotion from unsigned or
1282 enumeral type to a signed type over a conversion to an unsigned type of
1283 the same size.  Previous versions of g++ would try to preserve
1284 unsignedness, but the standard mandates the current behavior.
1286 @item -Wsynth (C++ only)
1287 @cindex warning for synthesized methods
1288 @cindex synthesized methods, warning
1289 Warn when g++'s synthesis behavior does not match that of cfront.  For
1290 instance:
1292 @smallexample
1293 struct A @{
1294   operator int ();
1295   A& operator = (int);
1298 main ()
1300   A a,b;
1301   a = b;
1303 @end smallexample
1305 In this example, g++ will synthesize a default @samp{A& operator =
1306 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1307 @end table
1309 @node Warning Options
1310 @section Options to Request or Suppress Warnings
1311 @cindex options to control warnings
1312 @cindex warning messages
1313 @cindex messages, warning
1314 @cindex suppressing warnings
1316 Warnings are diagnostic messages that report constructions which
1317 are not inherently erroneous but which are risky or suggest there
1318 may have been an error.
1320 You can request many specific warnings with options beginning @samp{-W},
1321 for example @samp{-Wimplicit} to request warnings on implicit
1322 declarations.  Each of these specific warning options also has a
1323 negative form beginning @samp{-Wno-} to turn off warnings;
1324 for example, @samp{-Wno-implicit}.  This manual lists only one of the
1325 two forms, whichever is not the default.
1327 These options control the amount and kinds of warnings produced by GCC:
1329 @table @code
1330 @cindex syntax checking
1331 @item -fsyntax-only
1332 Check the code for syntax errors, but don't do anything beyond that.
1334 @item -pedantic
1335 Issue all the warnings demanded by strict ANSI C and ISO C++;
1336 reject all programs that use forbidden extensions.
1338 Valid ANSI C and ISO C++ programs should compile properly with or without
1339 this option (though a rare few will require @samp{-ansi}).  However,
1340 without this option, certain GNU extensions and traditional C and C++
1341 features are supported as well.  With this option, they are rejected.
1343 @samp{-pedantic} does not cause warning messages for use of the
1344 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1345 warnings are also disabled in the expression that follows
1346 @code{__extension__}.  However, only system header files should use
1347 these escape routes; application programs should avoid them.
1348 @xref{Alternate Keywords}.
1350 This option is not intended to be @i{useful}; it exists only to satisfy
1351 pedants who would otherwise claim that GCC fails to support the ANSI
1352 standard.
1354 Some users try to use @samp{-pedantic} to check programs for strict ANSI
1355 C conformance.  They soon find that it does not do quite what they want:
1356 it finds some non-ANSI practices, but not all---only those for which
1357 ANSI C @emph{requires} a diagnostic.
1359 A feature to report any failure to conform to ANSI C might be useful in
1360 some instances, but would require considerable additional work and would
1361 be quite different from @samp{-pedantic}.  We don't have plans to
1362 support such a feature in the near future.
1364 @item -pedantic-errors
1365 Like @samp{-pedantic}, except that errors are produced rather than
1366 warnings.
1368 @item -w
1369 Inhibit all warning messages.
1371 @item -Wno-import
1372 Inhibit warning messages about the use of @samp{#import}.
1374 @item -Wchar-subscripts
1375 Warn if an array subscript has type @code{char}.  This is a common cause
1376 of error, as programmers often forget that this type is signed on some
1377 machines.
1379 @item -Wcomment
1380 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1381 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1383 @item -Wformat
1384 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1385 the arguments supplied have types appropriate to the format string
1386 specified.
1388 @item -Wimplicit-int
1389 Warn when a declaration does not specify a type.
1391 @item -Wimplicit-function-declaration
1392 @itemx -Werror-implicit-function-declaration
1393 Give a warning (or error) whenever a function is used before being
1394 declared.
1396 @item -Wimplicit
1397 Same as @samp{-Wimplicit-int} and @samp{-Wimplicit-function-}@*
1398 @samp{declaration}.
1400 @item -Wmain
1401 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
1402 function with external linkage, returning int, taking either zero
1403 arguments, two, or three arguments of appropriate types.
1405 @item -Wmultichar
1406 Warn if a multicharacter constant (@samp{'FOOF'}) is used.  Usually they
1407 indicate a typo in the user's code, as they have implementation-defined
1408 values, and should not be used in portable code.
1409   
1410 @item -Wparentheses
1411 Warn if parentheses are omitted in certain contexts, such
1412 as when there is an assignment in a context where a truth value
1413 is expected, or when operators are nested whose precedence people
1414 often get confused about.
1416 Also warn about constructions where there may be confusion to which
1417 @code{if} statement an @code{else} branch belongs.  Here is an example of
1418 such a case:
1420 @smallexample
1422   if (a)
1423     if (b)
1424       foo ();
1425   else
1426     bar ();
1428 @end smallexample
1430 In C, every @code{else} branch belongs to the innermost possible @code{if}
1431 statement, which in this example is @code{if (b)}.  This is often not
1432 what the programmer expected, as illustrated in the above example by
1433 indentation the programmer chose.  When there is the potential for this
1434 confusion, GNU C will issue a warning when this flag is specified.
1435 To eliminate the warning, add explicit braces around the innermost
1436 @code{if} statement so there is no way the @code{else} could belong to
1437 the enclosing @code{if}.  The resulting code would look like this:
1439 @smallexample
1441   if (a)
1442     @{
1443       if (b)
1444         foo ();
1445       else
1446         bar ();
1447     @}
1449 @end smallexample
1451 @item -Wreturn-type
1452 Warn whenever a function is defined with a return-type that defaults
1453 to @code{int}.  Also warn about any @code{return} statement with no
1454 return-value in a function whose return-type is not @code{void}.
1456 @item -Wswitch
1457 Warn whenever a @code{switch} statement has an index of enumeral type
1458 and lacks a @code{case} for one or more of the named codes of that
1459 enumeration.  (The presence of a @code{default} label prevents this
1460 warning.)  @code{case} labels outside the enumeration range also
1461 provoke warnings when this option is used.
1463 @item -Wtrigraphs
1464 Warn if any trigraphs are encountered (assuming they are enabled).
1466 @item -Wunused
1467 Warn whenever a variable is unused aside from its declaration,
1468 whenever a function is declared static but never defined, whenever a
1469 label is declared but not used, and whenever a statement computes a
1470 result that is explicitly not used.
1472 In order to get a warning about an unused function parameter, you must
1473 specify both @samp{-W} and @samp{-Wunused}.
1475 To suppress this warning for an expression, simply cast it to void.  For
1476 unused variables, parameters and labels, use the @samp{unused} attribute
1477 (@pxref{Variable Attributes}).
1479 @item -Wuninitialized
1480 An automatic variable is used without first being initialized.
1482 These warnings are possible only in optimizing compilation,
1483 because they require data flow information that is computed only
1484 when optimizing.  If you don't specify @samp{-O}, you simply won't
1485 get these warnings.
1487 These warnings occur only for variables that are candidates for
1488 register allocation.  Therefore, they do not occur for a variable that
1489 is declared @code{volatile}, or whose address is taken, or whose size
1490 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
1491 structures, unions or arrays, even when they are in registers.
1493 Note that there may be no warning about a variable that is used only
1494 to compute a value that itself is never used, because such
1495 computations may be deleted by data flow analysis before the warnings
1496 are printed.
1498 These warnings are made optional because GCC is not smart
1499 enough to see all the reasons why the code might be correct
1500 despite appearing to have an error.  Here is one example of how
1501 this can happen:
1503 @smallexample
1505   int x;
1506   switch (y)
1507     @{
1508     case 1: x = 1;
1509       break;
1510     case 2: x = 4;
1511       break;
1512     case 3: x = 5;
1513     @}
1514   foo (x);
1516 @end smallexample
1518 @noindent
1519 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
1520 always initialized, but GCC doesn't know this.  Here is
1521 another common case:
1523 @smallexample
1525   int save_y;
1526   if (change_y) save_y = y, y = new_y;
1527   @dots{}
1528   if (change_y) y = save_y;
1530 @end smallexample
1532 @noindent
1533 This has no bug because @code{save_y} is used only if it is set.
1535 @cindex @code{longjmp} warnings
1536 This option also warns when a nonvolatile automatic variable might be
1537 changed by a call to @code{longjmp}.
1539 The compiler sees only the calls to @code{setjmp}.  It cannot know
1540 where @code{longjmp} will be called; in fact, a signal handler could
1541 call it at any point in the code.  As a result, you may get a warning
1542 even when there is in fact no problem because @code{longjmp} cannot
1543 in fact be called at the place which would cause a problem.
1545 Some spurious warnings can be avoided if you declare all the functions
1546 you use that never return as @code{noreturn}.  @xref{Function
1547 Attributes}.
1549 @item -Wunknown-pragmas
1550 @cindex warning for unknown pragmas
1551 @cindex unknown pragmas, warning
1552 @cindex pragmas, warning of unknown
1553 Warn when a #pragma directive is encountered which is not understood by
1554 GCC.  If this command line option is used, warnings will even be issued
1555 for unknown pragmas in system header files.  This is not the case if
1556 the warnings were only enabled by the @samp{-Wall} command line option.
1558 @item -Wall
1559 All of the above @samp{-W} options combined.  This enables all the
1560 warnings about constructions that some users consider questionable, and
1561 that are easy to avoid (or modify to prevent the warning), even in
1562 conjunction with macros.
1563 @end table
1565 The following @samp{-W@dots{}} options are not implied by @samp{-Wall}.
1566 Some of them warn about constructions that users generally do not
1567 consider questionable, but which occasionally you might wish to check
1568 for; others warn about constructions that are necessary or hard to avoid
1569 in some cases, and there is no simple way to modify the code to suppress
1570 the warning.
1572 @table @code
1573 @item -W
1574 Print extra warning messages for these events:
1576 @itemize @bullet
1577 @item
1578 A function can return either with or without a value.  (Falling
1579 off the end of the function body is considered returning without
1580 a value.)  For example, this function would evoke such a
1581 warning:
1583 @smallexample
1584 @group
1585 foo (a)
1587   if (a > 0)
1588     return a;
1590 @end group
1591 @end smallexample
1593 @item
1594 An expression-statement or the left-hand side of a comma expression
1595 contains no side effects.
1596 To suppress the warning, cast the unused expression to void.
1597 For example, an expression such as @samp{x[i,j]} will cause a warning,
1598 but @samp{x[(void)i,j]} will not.
1600 @item
1601 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
1603 @item
1604 A comparison like @samp{x<=y<=z} appears; this is equivalent to
1605 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
1606 that of ordinary mathematical notation.
1608 @item
1609 Storage-class specifiers like @code{static} are not the first things in
1610 a declaration.  According to the C Standard, this usage is obsolescent.
1612 @item
1613 If @samp{-Wall} or @samp{-Wunused} is also specified, warn about unused
1614 arguments.
1616 @item
1617 A comparison between signed and unsigned values could produce an
1618 incorrect result when the signed value is converted to unsigned.
1619 (But don't warn if @samp{-Wno-sign-compare} is also specified.)
1621 @item
1622 An aggregate has a partly bracketed initializer.
1623 For example, the following code would evoke such a warning,
1624 because braces are missing around the initializer for @code{x.h}:
1626 @smallexample
1627 struct s @{ int f, g; @};
1628 struct t @{ struct s h; int i; @};
1629 struct t x = @{ 1, 2, 3 @};
1630 @end smallexample
1632 @item
1633 An aggregate has an initializer which does not initialize all members.
1634 For example, the following code would cause such a warning, because
1635 @code{x.h} would be implicitly initialized to zero:
1637 @smallexample
1638 struct s @{ int f, g, h; @};
1639 struct s x = @{ 3, 4 @};
1640 @end smallexample
1641 @end itemize
1643 @item -Wtraditional
1644 Warn about certain constructs that behave differently in traditional and
1645 ANSI C.
1647 @itemize @bullet
1648 @item
1649 Macro arguments occurring within string constants in the macro body.
1650 These would substitute the argument in traditional C, but are part of
1651 the constant in ANSI C.
1653 @item
1654 A function declared external in one block and then used after the end of
1655 the block.
1657 @item
1658 A @code{switch} statement has an operand of type @code{long}.
1660 @item
1661 A non-@code{static} function declaration follows a @code{static} one.
1662 This construct is not accepted by some traditional C compilers.
1663 @end itemize
1665 @item -Wundef
1666 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
1668 @item -Wshadow
1669 Warn whenever a local variable shadows another local variable.
1671 @item -Wid-clash-@var{len}
1672 Warn whenever two distinct identifiers match in the first @var{len}
1673 characters.  This may help you prepare a program that will compile
1674 with certain obsolete, brain-damaged compilers.
1676 @item -Wlarger-than-@var{len}
1677 Warn whenever an object of larger than @var{len} bytes is defined.
1679 @item -Wpointer-arith
1680 Warn about anything that depends on the ``size of'' a function type or
1681 of @code{void}.  GNU C assigns these types a size of 1, for
1682 convenience in calculations with @code{void *} pointers and pointers
1683 to functions.
1685 @item -Wbad-function-cast
1686 Warn whenever a function call is cast to a non-matching type.
1687 For example, warn if @code{int malloc()} is cast to @code{anything *}.
1689 @item -Wcast-qual
1690 Warn whenever a pointer is cast so as to remove a type qualifier from
1691 the target type.  For example, warn if a @code{const char *} is cast
1692 to an ordinary @code{char *}.
1694 @item -Wcast-align
1695 Warn whenever a pointer is cast such that the required alignment of the
1696 target is increased.  For example, warn if a @code{char *} is cast to
1697 an @code{int *} on machines where integers can only be accessed at
1698 two- or four-byte boundaries.
1700 @item -Wwrite-strings
1701 Give string constants the type @code{const char[@var{length}]} so that
1702 copying the address of one into a non-@code{const} @code{char *}
1703 pointer will get a warning.  These warnings will help you find at
1704 compile time code that can try to write into a string constant, but
1705 only if you have been very careful about using @code{const} in
1706 declarations and prototypes.  Otherwise, it will just be a nuisance;
1707 this is why we did not make @samp{-Wall} request these warnings.
1709 @item -Wconversion
1710 Warn if a prototype causes a type conversion that is different from what
1711 would happen to the same argument in the absence of a prototype.  This
1712 includes conversions of fixed point to floating and vice versa, and
1713 conversions changing the width or signedness of a fixed point argument
1714 except when the same as the default promotion.
1716 Also, warn if a negative integer constant expression is implicitly
1717 converted to an unsigned type.  For example, warn about the assignment
1718 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
1719 casts like @code{(unsigned) -1}.
1721 @item -Wsign-compare
1722 @cindex warning for comparison of signed and unsigned values
1723 @cindex comparison of signed and unsigned values, warning
1724 @cindex signed and unsigned values, comparison warning
1725 Warn when a comparison between signed and unsigned values could produce
1726 an incorrect result when the signed value is converted to unsigned.
1727 This warning is also enabled by @samp{-W}; to get the other warnings
1728 of @samp{-W} without this warning, use @samp{-W -Wno-sign-compare}.
1730 @item -Waggregate-return
1731 Warn if any functions that return structures or unions are defined or
1732 called.  (In languages where you can return an array, this also elicits
1733 a warning.)
1735 @item -Wstrict-prototypes
1736 Warn if a function is declared or defined without specifying the
1737 argument types.  (An old-style function definition is permitted without
1738 a warning if preceded by a declaration which specifies the argument
1739 types.)
1741 @item -Wmissing-prototypes
1742 Warn if a global function is defined without a previous prototype
1743 declaration.  This warning is issued even if the definition itself
1744 provides a prototype.  The aim is to detect global functions that fail
1745 to be declared in header files.
1747 @item -Wmissing-declarations
1748 Warn if a global function is defined without a previous declaration.
1749 Do so even if the definition itself provides a prototype.
1750 Use this option to detect global functions that are not declared in
1751 header files.
1753 @item -Wmissing-noreturn
1754 Warn about functions which might be candidates for attribute @code{noreturn}.
1755 Note these are only possible candidates, not absolute ones.  Care should
1756 be taken to manually verify functions actually do not ever return before
1757 adding the @code{noreturn} attribute, otherwise subtle code generation
1758 bugs could be introduced.
1760 @item -Wredundant-decls
1761 Warn if anything is declared more than once in the same scope, even in
1762 cases where multiple declaration is valid and changes nothing.
1764 @item -Wnested-externs
1765 Warn if an @code{extern} declaration is encountered within a function.
1767 @item -Wunreachable-code
1768 Warn if the compiler detects that code will never be executed.
1770 This option is intended to warn when the compiler detects that at
1771 least a whole line of source code will never be executed, because
1772 some condition is never satisfied or because it is after a
1773 procedure that never returns.
1775 It is possible for this option to produce a warning even though there
1776 are circumstances under which part of the affected line can be executed,
1777 so care should be taken when removing apparently-unreachable code.
1779 For instance, when a function is inlined, a warning may mean that the
1780 line is unreachable in only one inlined copy of the function.  
1782 This option is not made part of @samp{-Wall} because in a debugging
1783 version of a program there is often substantial code which checks
1784 correct functioning of the program and is, hopefully, unreachable
1785 because the program does work.  Another common use of unreachable
1786 code is to provide behaviour which is selectable at compile-time.
1788 @item -Winline
1789 Warn if a function can not be inlined, and either it was declared as inline,
1790 or else the @samp{-finline-functions} option was given.
1792 @item -Wlong-long
1793 Warn if @samp{long long} type is used.  This is default.  To inhibit
1794 the warning messages, use @samp{-Wno-long-long}.  Flags
1795 @samp{-Wlong-long} and @samp{-Wno-long-long} are taken into account
1796 only when @samp{-pedantic} flag is used.
1798 @item -Werror
1799 Make all warnings into errors.
1800 @end table
1802 @node Debugging Options
1803 @section Options for Debugging Your Program or GCC
1804 @cindex options, debugging
1805 @cindex debugging information options
1807 GCC has various special options that are used for debugging
1808 either your program or GCC:
1810 @table @code
1811 @item -g
1812 Produce debugging information in the operating system's native format
1813 (stabs, COFF, XCOFF, or DWARF).  GDB can work with this debugging
1814 information.
1816 On most systems that use stabs format, @samp{-g} enables use of extra
1817 debugging information that only GDB can use; this extra information
1818 makes debugging work better in GDB but will probably make other debuggers
1819 crash or
1820 refuse to read the program.  If you want to control for certain whether
1821 to generate the extra information, use @samp{-gstabs+}, @samp{-gstabs},
1822 @samp{-gxcoff+}, @samp{-gxcoff}, @samp{-gdwarf-1+}, or @samp{-gdwarf-1}
1823 (see below).
1825 Unlike most other C compilers, GCC allows you to use @samp{-g} with
1826 @samp{-O}.  The shortcuts taken by optimized code may occasionally
1827 produce surprising results: some variables you declared may not exist
1828 at all; flow of control may briefly move where you did not expect it;
1829 some statements may not be executed because they compute constant
1830 results or their values were already at hand; some statements may
1831 execute in different places because they were moved out of loops.
1833 Nevertheless it proves possible to debug optimized output.  This makes
1834 it reasonable to use the optimizer for programs that might have bugs.
1836 The following options are useful when GCC is generated with the
1837 capability for more than one debugging format.
1839 @item -ggdb
1840 Produce debugging information for use by GDB.  This means to use the
1841 most expressive format available (DWARF 2, stabs, or the native format
1842 if neither of those are supported), including GDB extensions if at all
1843 possible.
1845 @item -gstabs
1846 Produce debugging information in stabs format (if that is supported),
1847 without GDB extensions.  This is the format used by DBX on most BSD
1848 systems.  On MIPS, Alpha and System V Release 4 systems this option
1849 produces stabs debugging output which is not understood by DBX or SDB.
1850 On System V Release 4 systems this option requires the GNU assembler.
1852 @item -gstabs+
1853 Produce debugging information in stabs format (if that is supported),
1854 using GNU extensions understood only by the GNU debugger (GDB).  The
1855 use of these extensions is likely to make other debuggers crash or
1856 refuse to read the program.
1858 @item -gcoff
1859 Produce debugging information in COFF format (if that is supported).
1860 This is the format used by SDB on most System V systems prior to
1861 System V Release 4.
1863 @item -gxcoff
1864 Produce debugging information in XCOFF format (if that is supported).
1865 This is the format used by the DBX debugger on IBM RS/6000 systems.
1867 @item -gxcoff+
1868 Produce debugging information in XCOFF format (if that is supported),
1869 using GNU extensions understood only by the GNU debugger (GDB).  The
1870 use of these extensions is likely to make other debuggers crash or
1871 refuse to read the program, and may cause assemblers other than the GNU
1872 assembler (GAS) to fail with an error.
1874 @item -gdwarf
1875 Produce debugging information in DWARF version 1 format (if that is
1876 supported).  This is the format used by SDB on most System V Release 4
1877 systems.
1879 @item -gdwarf+
1880 Produce debugging information in DWARF version 1 format (if that is
1881 supported), using GNU extensions understood only by the GNU debugger
1882 (GDB).  The use of these extensions is likely to make other debuggers
1883 crash or refuse to read the program.
1885 @item -gdwarf-2
1886 Produce debugging information in DWARF version 2 format (if that is
1887 supported).  This is the format used by DBX on IRIX 6.
1889 @item -g@var{level}
1890 @itemx -ggdb@var{level}
1891 @itemx -gstabs@var{level}
1892 @itemx -gcoff@var{level}
1893 @itemx -gxcoff@var{level}
1894 @itemx -gdwarf@var{level}
1895 @itemx -gdwarf-2@var{level}
1896 Request debugging information and also use @var{level} to specify how
1897 much information.  The default level is 2.
1899 Level 1 produces minimal information, enough for making backtraces in
1900 parts of the program that you don't plan to debug.  This includes
1901 descriptions of functions and external variables, but no information
1902 about local variables and no line numbers.
1904 Level 3 includes extra information, such as all the macro definitions
1905 present in the program.  Some debuggers support macro expansion when
1906 you use @samp{-g3}.
1908 @cindex @code{prof}
1909 @item -p
1910 Generate extra code to write profile information suitable for the
1911 analysis program @code{prof}.  You must use this option when compiling
1912 the source files you want data about, and you must also use it when
1913 linking.
1915 @cindex @code{gprof}
1916 @item -pg
1917 Generate extra code to write profile information suitable for the
1918 analysis program @code{gprof}.  You must use this option when compiling
1919 the source files you want data about, and you must also use it when
1920 linking.
1922 @cindex @code{tcov}
1923 @item -a
1924 Generate extra code to write profile information for basic blocks, which will
1925 record the number of times each basic block is executed, the basic block start
1926 address, and the function name containing the basic block.  If @samp{-g} is
1927 used, the line number and filename of the start of the basic block will also be
1928 recorded.  If not overridden by the machine description, the default action is
1929 to append to the text file @file{bb.out}.
1931 This data could be analyzed by a program like @code{tcov}.  Note,
1932 however, that the format of the data is not what @code{tcov} expects.
1933 Eventually GNU @code{gprof} should be extended to process this data.
1935 @item -Q
1936 Makes the compiler print out each function name as it is compiled, and
1937 print some statistics about each pass when it finishes.
1939 @item -ax
1940 Generate extra code to profile basic blocks.  Your executable will
1941 produce output that is a superset of that produced when @samp{-a} is
1942 used.  Additional output is the source and target address of the basic
1943 blocks where a jump takes place, the number of times a jump is executed,
1944 and (optionally) the complete sequence of basic blocks being executed.
1945 The output is appended to file @file{bb.out}.
1947 You can examine different profiling aspects without recompilation.  Your
1948 executable will read a list of function names from file @file{bb.in}.
1949 Profiling starts when a function on the list is entered and stops when
1950 that invocation is exited.  To exclude a function from profiling, prefix
1951 its name with `-'.  If a function name is not unique, you can
1952 disambiguate it by writing it in the form
1953 @samp{/path/filename.d:functionname}.  Your executable will write the
1954 available paths and filenames in file @file{bb.out}.
1956 Several function names have a special meaning:
1957 @table @code
1958 @item __bb_jumps__
1959 Write source, target and frequency of jumps to file @file{bb.out}.
1960 @item __bb_hidecall__
1961 Exclude function calls from frequency count.
1962 @item __bb_showret__
1963 Include function returns in frequency count.
1964 @item __bb_trace__
1965 Write the sequence of basic blocks executed to file @file{bbtrace.gz}.
1966 The file will be compressed using the program @samp{gzip}, which must
1967 exist in your @code{PATH}.  On systems without the @samp{popen}
1968 function, the file will be named @file{bbtrace} and will not be
1969 compressed.  @strong{Profiling for even a few seconds on these systems
1970 will produce a very large file.}  Note: @code{__bb_hidecall__} and
1971 @code{__bb_showret__} will not affect the sequence written to
1972 @file{bbtrace.gz}.
1973 @end table
1975 Here's a short example using different profiling parameters
1976 in file @file{bb.in}.  Assume function @code{foo} consists of basic blocks
1977 1 and 2 and is called twice from block 3 of function @code{main}.  After
1978 the calls, block 3 transfers control to block 4 of @code{main}.
1980 With @code{__bb_trace__} and @code{main} contained in file @file{bb.in},
1981 the following sequence of blocks is written to file @file{bbtrace.gz}:
1982 0 3 1 2 1 2 4.  The return from block 2 to block 3 is not shown, because
1983 the return is to a point inside the block and not to the top.  The
1984 block address 0 always indicates, that control is transferred
1985 to the trace from somewhere outside the observed functions.  With
1986 @samp{-foo} added to @file{bb.in}, the blocks of function
1987 @code{foo} are removed from the trace, so only 0 3 4 remains.
1989 With @code{__bb_jumps__} and @code{main} contained in file @file{bb.in},
1990 jump frequencies will be written to file @file{bb.out}.  The
1991 frequencies are obtained by constructing a trace of blocks
1992 and incrementing a counter for every neighbouring pair of blocks
1993 in the trace.  The trace 0 3 1 2 1 2 4 displays the following
1994 frequencies:
1996 @example
1997 Jump from block 0x0 to block 0x3 executed 1 time(s)
1998 Jump from block 0x3 to block 0x1 executed 1 time(s)
1999 Jump from block 0x1 to block 0x2 executed 2 time(s)
2000 Jump from block 0x2 to block 0x1 executed 1 time(s)
2001 Jump from block 0x2 to block 0x4 executed 1 time(s)
2002 @end example
2004 With @code{__bb_hidecall__}, control transfer due to call instructions
2005 is removed from the trace, that is the trace is cut into three parts: 0
2006 3 4, 0 1 2 and 0 1 2.  With @code{__bb_showret__}, control transfer due
2007 to return instructions is added to the trace.  The trace becomes: 0 3 1
2008 2 3 1 2 3 4.  Note, that this trace is not the same, as the sequence
2009 written to @file{bbtrace.gz}.  It is solely used for counting jump
2010 frequencies.
2012 @item -fprofile-arcs
2013 Instrument @dfn{arcs} during compilation.  For each function of your
2014 program, GCC creates a program flow graph, then finds a spanning tree
2015 for the graph.  Only arcs that are not on the spanning tree have to be
2016 instrumented: the compiler adds code to count the number of times that these
2017 arcs are executed.  When an arc is the only exit or only entrance to a
2018 block, the instrumentation code can be added to the block; otherwise, a
2019 new basic block must be created to hold the instrumentation code.
2021 Since not every arc in the program must be instrumented, programs
2022 compiled with this option run faster than programs compiled with
2023 @samp{-a}, which adds instrumentation code to every basic block in the
2024 program.  The tradeoff: since @code{gcov} does not have
2025 execution counts for all branches, it must start with the execution
2026 counts for the instrumented branches, and then iterate over the program
2027 flow graph until the entire graph has been solved.  Hence, @code{gcov}
2028 runs a little more slowly than a program which uses information from
2029 @samp{-a}.
2031 @samp{-fprofile-arcs} also makes it possible to estimate branch
2032 probabilities, and to calculate basic block execution counts.  In
2033 general, basic block execution counts do not give enough information to
2034 estimate all branch probabilities.  When the compiled program exits, it
2035 saves the arc execution counts to a file called
2036 @file{@var{sourcename}.da}.  Use the compiler option
2037 @samp{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2038 Control Optimization}) when recompiling, to optimize using estimated
2039 branch probabilities.
2041 @need 2000
2042 @item -ftest-coverage
2043 Create data files for the @code{gcov} code-coverage utility
2044 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
2045 The data file names begin with the name of your source file:
2047 @table @code
2048 @item @var{sourcename}.bb
2049 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2050 associate basic block execution counts with line numbers.
2052 @item @var{sourcename}.bbg
2053 A list of all arcs in the program flow graph.  This allows @code{gcov}
2054 to reconstruct the program flow graph, so that it can compute all basic
2055 block and arc execution counts from the information in the
2056 @code{@var{sourcename}.da} file (this last file is the output from
2057 @samp{-fprofile-arcs}).
2058 @end table
2060 @item -Q
2061 Makes the compiler print out each function name as it is compiled, and
2062 print some statistics about each pass when it finishes.
2064 @item -d@var{letters}
2065 Says to make debugging dumps during compilation at times specified by
2066 @var{letters}.  This is used for debugging the compiler.  The file names
2067 for most of the dumps are made by appending a word to the source file
2068 name (e.g.  @file{foo.c.rtl} or @file{foo.c.jump}).  Here are the
2069 possible letters for use in @var{letters}, and their meanings:
2071 @table @samp
2072 @item b
2073 Dump after computing branch probabilities, to @file{@var{file}.bp}.
2074 @item c
2075 Dump after instruction combination, to the file @file{@var{file}.combine}.
2076 @item d
2077 Dump after delayed branch scheduling, to @file{@var{file}.dbr}.
2078 @item D
2079 Dump all macro definitions, at the end of preprocessing, in addition to
2080 normal output.
2081 @item r
2082 Dump after RTL generation, to @file{@var{file}.rtl}.
2083 @item j
2084 Dump after first jump optimization, to @file{@var{file}.jump}.
2085 @item F
2086 Dump after purging ADDRESSOF, to @file{@var{file}.addressof}.
2087 @item f
2088 Dump after flow analysis, to @file{@var{file}.flow}.
2089 @item g
2090 Dump after global register allocation, to @file{@var{file}.greg}.
2091 @item G      
2092 Dump after GCSE, to @file{@var{file}.gcse}.
2093 @item j
2094 Dump after first jump optimization, to @file{@var{file}.jump}.
2095 @item J
2096 Dump after last jump optimization, to @file{@var{file}.jump2}.
2097 @item k
2098 Dump after conversion from registers to stack, to @file{@var{file}.stack}.
2099 @item l
2100 Dump after local register allocation, to @file{@var{file}.lreg}.
2101 @item L
2102 Dump after loop optimization, to @file{@var{file}.loop}.
2103 @item M
2104 Dump after performing the machine dependent reorganisation pass, to
2105 @file{@var{file}.mach}. 
2106 @item N
2107 Dump after the register move pass, to @file{@var{file}.regmove}.
2108 @item r
2109 Dump after RTL generation, to @file{@var{file}.rtl}.
2110 @item R
2111 Dump after the second instruction scheduling pass, to @file{@var{file}.sched2}.
2112 @item s
2113 Dump after CSE (including the jump optimization that sometimes follows
2114 CSE), to @file{@var{file}.cse}. 
2115 @item S
2116 Dump after the first instruction scheduling pass, to @file{@var{file}.sched}.
2117 @item t
2118 Dump after the second CSE pass (including the jump optimization that
2119 sometimes follows CSE), to @file{@var{file}.cse2}. 
2120 @item a
2121 Produce all the dumps listed above.
2122 @item m
2123 Print statistics on memory usage, at the end of the run, to
2124 standard error.
2125 @item p
2126 Annotate the assembler output with a comment indicating which
2127 pattern and alternative was used.  The length of each instruction is
2128 also printed.
2129 @item x
2130 Just generate RTL for a function instead of compiling it.  Usually used
2131 with @samp{r}.
2132 @item y
2133 Dump debugging information during parsing, to standard error.
2134 @item A
2135 Annotate the assembler output with miscellaneous debugging information.
2136 @end table
2138 @item -fdump-unnumbered
2139 When doing debugging dumps (see -d option above), suppress instruction
2140 numbers and line number note output.  This makes it more feasible to
2141 use diff on debugging dumps for compiler invokations with different
2142 options, in particular with and without -g.
2144 @item -fdump-translation-unit-@var{file} (C++ only)
2145 Dump a representation of the tree structure for the entire translation
2146 unit to @var{file}.
2148 @item -fpretend-float
2149 When running a cross-compiler, pretend that the target machine uses the
2150 same floating point format as the host machine.  This causes incorrect
2151 output of the actual floating constants, but the actual instruction
2152 sequence will probably be the same as GCC would make when running on
2153 the target machine.
2155 @item -save-temps
2156 Store the usual ``temporary'' intermediate files permanently; place them
2157 in the current directory and name them based on the source file.  Thus,
2158 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
2159 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.
2161 @item -print-file-name=@var{library}
2162 Print the full absolute name of the library file @var{library} that
2163 would be used when linking---and don't do anything else.  With this
2164 option, GCC does not compile or link anything; it just prints the
2165 file name.
2167 @item -print-prog-name=@var{program}
2168 Like @samp{-print-file-name}, but searches for a program such as @samp{cpp}.
2170 @item -print-libgcc-file-name
2171 Same as @samp{-print-file-name=libgcc.a}.
2173 This is useful when you use @samp{-nostdlib} or @samp{-nodefaultlibs}
2174 but you do want to link with @file{libgcc.a}.  You can do
2176 @example
2177 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
2178 @end example
2180 @item -print-search-dirs
2181 Print the name of the configured installation directory and a list of
2182 program and library directories gcc will search---and don't do anything else.
2184 This is useful when gcc prints the error message
2185 @samp{installation problem, cannot exec cpp: No such file or directory}.
2186 To resolve this you either need to put @file{cpp} and the other compiler
2187 components where gcc expects to find them, or you can set the environment
2188 variable @code{GCC_EXEC_PREFIX} to the directory where you installed them.
2189 Don't forget the trailing '/'.
2190 @xref{Environment Variables}.
2191 @end table
2193 @node Optimize Options
2194 @section Options That Control Optimization
2195 @cindex optimize options
2196 @cindex options, optimization
2198 These options control various sorts of optimizations:
2200 @table @code
2201 @item -O
2202 @itemx -O1
2203 Optimize.  Optimizing compilation takes somewhat more time, and a lot
2204 more memory for a large function.
2206 Without @samp{-O}, the compiler's goal is to reduce the cost of
2207 compilation and to make debugging produce the expected results.
2208 Statements are independent: if you stop the program with a breakpoint
2209 between statements, you can then assign a new value to any variable or
2210 change the program counter to any other statement in the function and
2211 get exactly the results you would expect from the source code.
2213 Without @samp{-O}, the compiler only allocates variables declared
2214 @code{register} in registers.  The resulting compiled code is a little
2215 worse than produced by PCC without @samp{-O}.
2217 With @samp{-O}, the compiler tries to reduce code size and execution
2218 time.
2220 When you specify @samp{-O}, the compiler turns on @samp{-fthread-jumps}
2221 and @samp{-fdefer-pop} on all machines.  The compiler turns on
2222 @samp{-fdelayed-branch} on machines that have delay slots, and
2223 @samp{-fomit-frame-pointer} on machines that can support debugging even
2224 without a frame pointer.  On some machines the compiler also turns
2225 on other flags.@refill
2227 @item -O2
2228 Optimize even more.  GCC performs nearly all supported optimizations
2229 that do not involve a space-speed tradeoff.  The compiler does not
2230 perform loop unrolling or function inlining when you specify @samp{-O2}.
2231 As compared to @samp{-O}, this option increases both compilation time
2232 and the performance of the generated code.
2234 @samp{-O2} turns on all optional optimizations except for loop unrolling
2235 and function inlining.  It also turns on the @samp{-fforce-mem} option
2236 on all machines and frame pointer elimination on machines where doing so
2237 does not interfere with debugging.
2239 @item -O3
2240 Optimize yet more.  @samp{-O3} turns on all optimizations specified by
2241 @samp{-O2} and also turns on the @samp{inline-functions} option.
2243 @item -O0
2244 Do not optimize.
2246 @item -Os
2247 Optimize for size.  @samp{-Os} enables all @samp{-O2} optimizations that
2248 do not typically increase code size.  It also performs further
2249 optimizations designed to reduce code size.
2251 If you use multiple @samp{-O} options, with or without level numbers,
2252 the last such option is the one that is effective.
2253 @end table
2255 Options of the form @samp{-f@var{flag}} specify machine-independent
2256 flags.  Most flags have both positive and negative forms; the negative
2257 form of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below,
2258 only one of the forms is listed---the one which is not the default.
2259 You can figure out the other form by either removing @samp{no-} or
2260 adding it.
2262 @table @code
2263 @item -ffloat-store
2264 Do not store floating point variables in registers, and inhibit other
2265 options that might change whether a floating point value is taken from a
2266 register or memory.
2268 @cindex floating point precision
2269 This option prevents undesirable excess precision on machines such as
2270 the 68000 where the floating registers (of the 68881) keep more
2271 precision than a @code{double} is supposed to have.  Similarly for the
2272 x86 architecture.  For most programs, the excess precision does only
2273 good, but a few programs rely on the precise definition of IEEE floating
2274 point.  Use @samp{-ffloat-store} for such programs, after modifying
2275 them to store all pertinent intermediate computations into variables.
2277 @item -fno-default-inline
2278 Do not make member functions inline by default merely because they are
2279 defined inside the class scope (C++ only).  Otherwise, when you specify
2280 @w{@samp{-O}}, member functions defined inside class scope are compiled
2281 inline by default; i.e., you don't need to add @samp{inline} in front of
2282 the member function name.
2284 @item -fno-defer-pop
2285 Always pop the arguments to each function call as soon as that function
2286 returns.  For machines which must pop arguments after a function call,
2287 the compiler normally lets arguments accumulate on the stack for several
2288 function calls and pops them all at once.
2290 @item -fforce-mem
2291 Force memory operands to be copied into registers before doing
2292 arithmetic on them.  This produces better code by making all memory
2293 references potential common subexpressions.  When they are not common
2294 subexpressions, instruction combination should eliminate the separate
2295 register-load.  The @samp{-O2} option turns on this option.
2297 @item -fforce-addr
2298 Force memory address constants to be copied into registers before
2299 doing arithmetic on them.  This may produce better code just as
2300 @samp{-fforce-mem} may.
2302 @item -fomit-frame-pointer
2303 Don't keep the frame pointer in a register for functions that
2304 don't need one.  This avoids the instructions to save, set up and
2305 restore frame pointers; it also makes an extra register available
2306 in many functions.  @strong{It also makes debugging impossible on
2307 some machines.}
2309 @ifset INTERNALS
2310 On some machines, such as the Vax, this flag has no effect, because
2311 the standard calling sequence automatically handles the frame pointer
2312 and nothing is saved by pretending it doesn't exist.  The
2313 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2314 whether a target machine supports this flag.  @xref{Registers}.@refill
2315 @end ifset
2316 @ifclear INTERNALS
2317 On some machines, such as the Vax, this flag has no effect, because
2318 the standard calling sequence automatically handles the frame pointer
2319 and nothing is saved by pretending it doesn't exist.  The
2320 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2321 whether a target machine supports this flag.  @xref{Registers,,Register
2322 Usage, gcc.info, Using and Porting GCC}.@refill
2323 @end ifclear
2325 @item -fno-inline
2326 Don't pay attention to the @code{inline} keyword.  Normally this option
2327 is used to keep the compiler from expanding any functions inline.
2328 Note that if you are not optimizing, no functions can be expanded inline.
2330 @item -finline-functions
2331 Integrate all simple functions into their callers.  The compiler
2332 heuristically decides which functions are simple enough to be worth
2333 integrating in this way.
2335 If all calls to a given function are integrated, and the function is
2336 declared @code{static}, then the function is normally not output as
2337 assembler code in its own right.
2339 @item -finline-limit=@var{n}
2340 By default, gcc limits the size of functions that can be inlined.  This flag
2341 allows the control of this limit for functions that are explicitly marked as
2342 inline (ie marked with the inline keyword or defined within the class 
2343 definition in c++).  @var{n} is the size of functions that can be inlined in 
2344 number of pseudo instructions (not counting parameter handling).  The default
2345 value of n is 10000.  Increasing this value can result in more inlined code at
2346 the cost of compilation time and memory consumption.  Decreasing usually makes
2347 the compilation faster and less code will be inlined (which presumably 
2348 means slower programs).  This option is particularly useful for programs that 
2349 use inlining heavily such as those based on recursive templates with c++.
2351 @emph{Note:} pseudo instruction represents, in this particular context, an
2352 abstract measurement of function's size.  In no way, it represents a count
2353 of assembly instructions and as such its exact meaning might change from one
2354 release to an another.
2356 @item -fkeep-inline-functions
2357 Even if all calls to a given function are integrated, and the function
2358 is declared @code{static}, nevertheless output a separate run-time
2359 callable version of the function.  This switch does not affect
2360 @code{extern inline} functions.
2362 @item -fkeep-static-consts
2363 Emit variables declared @code{static const} when optimization isn't turned
2364 on, even if the variables aren't referenced.
2366 GCC enables this option by default.  If you want to force the compiler to
2367 check if the variable was referenced, regardless of whether or not
2368 optimization is turned on, use the @samp{-fno-keep-static-consts} option.
2370 @item -fno-function-cse
2371 Do not put function addresses in registers; make each instruction that
2372 calls a constant function contain the function's address explicitly.
2374 This option results in less efficient code, but some strange hacks
2375 that alter the assembler output may be confused by the optimizations
2376 performed when this option is not used.
2378 @item -ffast-math
2379 This option allows GCC to violate some ANSI or IEEE rules and/or
2380 specifications in the interest of optimizing code for speed.  For
2381 example, it allows the compiler to assume arguments to the @code{sqrt}
2382 function are non-negative numbers and that no floating-point values
2383 are NaNs.
2385 This option should never be turned on by any @samp{-O} option since
2386 it can result in incorrect output for programs which depend on
2387 an exact implementation of IEEE or ANSI rules/specifications for
2388 math functions.
2389 @end table
2391 @c following causes underfulls.. they don't look great, but we deal.
2392 @c --mew 26jan93
2393 The following options control specific optimizations.  The @samp{-O2}
2394 option turns on all of these optimizations except @samp{-funroll-loops}
2395 and @samp{-funroll-all-loops}.  On most machines, the @samp{-O} option
2396 turns on the @samp{-fthread-jumps} and @samp{-fdelayed-branch} options,
2397 but specific machines may handle it differently.
2399 You can use the following flags in the rare cases when ``fine-tuning''
2400 of optimizations to be performed is desired.
2402 @table @code
2403 @item -fstrength-reduce
2404 Perform the optimizations of loop strength reduction and
2405 elimination of iteration variables.
2407 @item -fthread-jumps
2408 Perform optimizations where we check to see if a jump branches to a
2409 location where another comparison subsumed by the first is found.  If
2410 so, the first branch is redirected to either the destination of the
2411 second branch or a point immediately following it, depending on whether
2412 the condition is known to be true or false.
2414 @item -fcse-follow-jumps
2415 In common subexpression elimination, scan through jump instructions
2416 when the target of the jump is not reached by any other path.  For
2417 example, when CSE encounters an @code{if} statement with an
2418 @code{else} clause, CSE will follow the jump when the condition
2419 tested is false.
2421 @item -fcse-skip-blocks
2422 This is similar to @samp{-fcse-follow-jumps}, but causes CSE to
2423 follow jumps which conditionally skip over blocks.  When CSE
2424 encounters a simple @code{if} statement with no else clause,
2425 @samp{-fcse-skip-blocks} causes CSE to follow the jump around the
2426 body of the @code{if}.
2428 @item -frerun-cse-after-loop
2429 Re-run common subexpression elimination after loop optimizations has been
2430 performed.
2432 @item -frerun-loop-opt
2433 Run the loop optimizer twice.
2435 @item -fgcse
2436 Perform a global common subexpression elimination pass.
2437 This pass also performs global constant and copy propagation.
2439 @item -fexpensive-optimizations
2440 Perform a number of minor optimizations that are relatively expensive.
2442 @item -foptimize-register-moves
2443 @itemx -fregmove
2444 Attempt to reassign register numbers in move instructions and as
2445 operands of other simple instructions in order to maximize the amount of
2446 register tying.  This is especially helpful on machines with two-operand
2447 instructions.  GCC enables this optimization by default with @samp{-O2}
2448 or higher.
2450 Note @code{-fregmove} and @code{-foptimize-register-moves} are the same
2451 optimization.
2453 @item -fdelayed-branch
2454 If supported for the target machine, attempt to reorder instructions
2455 to exploit instruction slots available after delayed branch
2456 instructions.
2458 @item -fschedule-insns
2459 If supported for the target machine, attempt to reorder instructions to
2460 eliminate execution stalls due to required data being unavailable.  This
2461 helps machines that have slow floating point or memory load instructions
2462 by allowing other instructions to be issued until the result of the load
2463 or floating point instruction is required.
2465 @item -fschedule-insns2
2466 Similar to @samp{-fschedule-insns}, but requests an additional pass of
2467 instruction scheduling after register allocation has been done.  This is
2468 especially useful on machines with a relatively small number of
2469 registers and where memory load instructions take more than one cycle.
2471 @item -ffunction-sections
2472 @itemx -fdata-sections
2473 Place each function or data item into its own section in the output
2474 file if the target supports arbitrary sections.  The name of the
2475 function or the name of the data item determines the section's name
2476 in the output file.
2478 Use these options on systems where the linker can perform optimizations
2479 to improve locality of reference in the instruction space.  HPPA
2480 processors running HP-UX and Sparc processors running Solaris 2 have
2481 linkers with such optimizations.  Other systems using the ELF object format
2482 as well as AIX may have these optimizations in the future.
2484 Only use these options when there are significant benefits from doing
2485 so.  When you specify these options, the assembler and linker will
2486 create larger object and executable files and will also be slower.
2487 You will not be able to use @code{gprof} on all systems if you
2488 specify this option and you may have problems with debugging if
2489 you specify both this option and @samp{-g}.
2491 @item -fcaller-saves
2492 Enable values to be allocated in registers that will be clobbered by
2493 function calls, by emitting extra instructions to save and restore the
2494 registers around such calls.  Such allocation is done only when it
2495 seems to result in better code than would otherwise be produced.
2497 This option is always enabled by default on certain machines, usually
2498 those which have no call-preserved registers to use instead.
2500 For all machines, optimization level 2 and higher enables this flag by
2501 default.
2503 @item -funroll-loops
2504 Perform the optimization of loop unrolling.  This is only done for loops
2505 whose number of iterations can be determined at compile time or run time.
2506 @samp{-funroll-loops} implies both @samp{-fstrength-reduce} and
2507 @samp{-frerun-cse-after-loop}.
2509 @item -funroll-all-loops
2510 Perform the optimization of loop unrolling.  This is done for all loops
2511 and usually makes programs run more slowly.  @samp{-funroll-all-loops}
2512 implies @samp{-fstrength-reduce} as well as @samp{-frerun-cse-after-loop}.
2514 @item -fmove-all-movables
2515 Forces all invariant computations in loops to be moved
2516 outside the loop.
2518 @item -freduce-all-givs
2519 Forces all general-induction variables in loops to be
2520 strength-reduced.
2522 @emph{Note:} When compiling programs written in Fortran,
2523 @samp{-fmove-all-movables} and @samp{-freduce-all-givs} are enabled
2524 by default when you use the optimizer.
2526 These options may generate better or worse code; results are highly
2527 dependent on the structure of loops within the source code.
2529 These two options are intended to be removed someday, once
2530 they have helped determine the efficacy of various
2531 approaches to improving loop optimizations.
2533 Please let us (@code{gcc@@gcc.gnu.org} and @code{fortran@@gnu.org})
2534 know how use of these options affects
2535 the performance of your production code.
2536 We're very interested in code that runs @emph{slower}
2537 when these options are @emph{enabled}.
2539 @item -fno-peephole
2540 Disable any machine-specific peephole optimizations.
2542 @item -fbranch-probabilities
2543 After running a program compiled with @samp{-fprofile-arcs}
2544 (@pxref{Debugging Options,, Options for Debugging Your Program or
2545 @code{gcc}}), you can compile it a second time using
2546 @samp{-fbranch-probabilities}, to improve optimizations based on
2547 guessing the path a branch might take.
2549 @ifset INTERNALS
2550 With @samp{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
2551 note on the first instruction of each basic block, and a
2552 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
2553 These can be used to improve optimization.  Currently, they are only
2554 used in one place: in @file{reorg.c}, instead of guessing which path a
2555 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
2556 exactly determine which path is taken more often.
2557 @end ifset
2559 @item -fstrict-aliasing
2560 Allows the compiler to assume the strictest aliasing rules applicable to
2561 the language being compiled.  For C (and C++), this activates
2562 optimizations based on the type of expressions.  In particular, an
2563 object of one type is assumed never to reside at the same address as an
2564 object of a different type, unless the types are almost the same.  For
2565 example, an @code{unsigned int} can alias an @code{int}, but not a
2566 @code{void*} or a @code{double}.  A character type may alias any other
2567 type.  
2569 Pay special attention to code like this:
2570 @example
2571 union a_union @{ 
2572   int i;
2573   double d;
2576 int f() @{
2577   a_union t;
2578   t.d = 3.0;
2579   return t.i;
2581 @end example
2582 The practice of reading from a different union member than the one most
2583 recently written to (called ``type-punning'') is common.  Even with
2584 @samp{-fstrict-aliasing}, type-punning is allowed, provided the memory
2585 is accessed through the union type.  So, the code above will work as
2586 expected.  However, this code might not:
2587 @example
2588 int f() @{ 
2589   a_union t;
2590   int* ip;
2591   t.d = 3.0;
2592   ip = &t.i;
2593   return *ip;
2595 @end example
2597 @ifset INTERNALS
2598 Every language that wishes to perform language-specific alias analysis
2599 should define a function that computes, given an @code{tree}
2600 node, an alias set for the node.  Nodes in different alias sets are not
2601 allowed to alias.  For an example, see the C front-end function
2602 @code{c_get_alias_set}.
2603 @end ifset
2605 @item -falign-functions
2606 @itemx -falign-functions=@var{n}
2607 Align the start of functions to the next power-of-two greater than
2608 @var{n}, skipping up to @var{n} bytes.  For instance,
2609 @samp{-falign-functions=32} aligns functions to the next 32-byte
2610 boundary, but @samp{-falign-functions=24} would align to the next
2611 32-byte boundary only if this can be done by skipping 23 bytes or less.
2613 @samp{-fno-align-functions} and @samp{-falign-functions=1} are
2614 equivalent and mean that functions will not be aligned.
2616 Some assemblers only support this flag when @var{n} is a power of two;
2617 in that case, it is rounded up.
2619 If @var{n} is not specified, use a machine-dependent default.
2621 @item -falign-labels
2622 @itemx -falign-labels=@var{n}
2623 Align all branch targets to a power-of-two boundary, skipping up to
2624 @var{n} bytes like @samp{-falign-functions}.  This option can easily
2625 make code slower, because it must insert dummy operations for when the
2626 branch target is reached in the usual flow of the code.
2628 If @samp{-falign-loops} or @samp{-falign-jumps} are applicable and
2629 are greater than this value, then their values are used instead.
2631 If @var{n} is not specified, use a machine-dependent default which is
2632 very likely to be @samp{1}, meaning no alignment.
2634 @item -falign-loops
2635 @itemx -falign-loops=@var{n}
2636 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
2637 like @samp{-falign-functions}.  The hope is that the loop will be
2638 executed many times, which will make up for any execution of the dummy
2639 operations.
2641 If @var{n} is not specified, use a machine-dependent default.
2643 @item -falign-jumps
2644 @itemx -falign-jumps=@var{n}
2645 Align branch targets to a power-of-two boundary, for branch targets
2646 where the targets can only be reached by jumping, skipping up to @var{n}
2647 bytes like @samp{-falign-functions}.  In this case, no dummy operations
2648 need be executed.
2650 If @var{n} is not specified, use a machine-dependent default.
2652 @end table
2654 @node Preprocessor Options
2655 @section Options Controlling the Preprocessor
2656 @cindex preprocessor options
2657 @cindex options, preprocessor
2659 These options control the C preprocessor, which is run on each C source
2660 file before actual compilation.
2662 If you use the @samp{-E} option, nothing is done except preprocessing.
2663 Some of these options make sense only together with @samp{-E} because
2664 they cause the preprocessor output to be unsuitable for actual
2665 compilation.
2667 @table @code
2668 @item -include @var{file}
2669 Process @var{file} as input before processing the regular input file.
2670 In effect, the contents of @var{file} are compiled first.  Any @samp{-D}
2671 and @samp{-U} options on the command line are always processed before
2672 @samp{-include @var{file}}, regardless of the order in which they are
2673 written.  All the @samp{-include} and @samp{-imacros} options are
2674 processed in the order in which they are written.
2676 @item -imacros @var{file}
2677 Process @var{file} as input, discarding the resulting output, before
2678 processing the regular input file.  Because the output generated from
2679 @var{file} is discarded, the only effect of @samp{-imacros @var{file}}
2680 is to make the macros defined in @var{file} available for use in the
2681 main input.
2683 Any @samp{-D} and @samp{-U} options on the command line are always
2684 processed before @samp{-imacros @var{file}}, regardless of the order in
2685 which they are written.  All the @samp{-include} and @samp{-imacros}
2686 options are processed in the order in which they are written.
2688 @item -idirafter @var{dir}
2689 @cindex second include path
2690 Add the directory @var{dir} to the second include path.  The directories
2691 on the second include path are searched when a header file is not found
2692 in any of the directories in the main include path (the one that
2693 @samp{-I} adds to).
2695 @item -iprefix @var{prefix}
2696 Specify @var{prefix} as the prefix for subsequent @samp{-iwithprefix}
2697 options.
2699 @item -iwithprefix @var{dir}
2700 Add a directory to the second include path.  The directory's name is
2701 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
2702 specified previously with @samp{-iprefix}.  If you have not specified a
2703 prefix yet, the directory containing the installed passes of the
2704 compiler is used as the default.
2706 @item -iwithprefixbefore @var{dir}
2707 Add a directory to the main include path.  The directory's name is made
2708 by concatenating @var{prefix} and @var{dir}, as in the case of
2709 @samp{-iwithprefix}.
2711 @item -isystem @var{dir}
2712 Add a directory to the beginning of the second include path, marking it
2713 as a system directory, so that it gets the same special treatment as
2714 is applied to the standard system directories.
2716 @item -nostdinc
2717 Do not search the standard system directories for header files.  Only
2718 the directories you have specified with @samp{-I} options (and the
2719 current directory, if appropriate) are searched.  @xref{Directory
2720 Options}, for information on @samp{-I}.
2722 By using both @samp{-nostdinc} and @samp{-I-}, you can limit the include-file
2723 search path to only those directories you specify explicitly.
2725 @item -undef
2726 Do not predefine any nonstandard macros.  (Including architecture flags).
2728 @item -E
2729 Run only the C preprocessor.  Preprocess all the C source files
2730 specified and output the results to standard output or to the
2731 specified output file.
2733 @item -C
2734 Tell the preprocessor not to discard comments.  Used with the
2735 @samp{-E} option.
2737 @item -P
2738 Tell the preprocessor not to generate @samp{#line} directives.
2739 Used with the @samp{-E} option.
2741 @cindex make
2742 @cindex dependencies, make
2743 @item -M
2744 Tell the preprocessor to output a rule suitable for @code{make}
2745 describing the dependencies of each object file.  For each source file,
2746 the preprocessor outputs one @code{make}-rule whose target is the object
2747 file name for that source file and whose dependencies are all the
2748 @code{#include} header files it uses.  This rule may be a single line or
2749 may be continued with @samp{\}-newline if it is long.  The list of rules
2750 is printed on standard output instead of the preprocessed C program.
2752 @samp{-M} implies @samp{-E}.
2754 Another way to specify output of a @code{make} rule is by setting
2755 the environment variable @code{DEPENDENCIES_OUTPUT} (@pxref{Environment
2756 Variables}).
2758 @item -MM
2759 Like @samp{-M} but the output mentions only the user header files
2760 included with @samp{#include "@var{file}"}.  System header files
2761 included with @samp{#include <@var{file}>} are omitted.
2763 @item -MD
2764 Like @samp{-M} but the dependency information is written to a file made by
2765 replacing ".c" with ".d" at the end of the input file names.
2766 This is in addition to compiling the file as specified---@samp{-MD} does
2767 not inhibit ordinary compilation the way @samp{-M} does.
2769 In Mach, you can use the utility @code{md} to merge multiple dependency
2770 files into a single dependency file suitable for using with the @samp{make}
2771 command.
2773 @item -MMD
2774 Like @samp{-MD} except mention only user header files, not system
2775 header files.
2777 @item -MG
2778 Treat missing header files as generated files and assume they live in the
2779 same directory as the source file.  If you specify @samp{-MG}, you
2780 must also specify either @samp{-M} or @samp{-MM}.  @samp{-MG} is not
2781 supported with @samp{-MD} or @samp{-MMD}.
2783 @item -H
2784 Print the name of each header file used, in addition to other normal
2785 activities.
2787 @item -A@var{question}(@var{answer})
2788 Assert the answer @var{answer} for @var{question}, in case it is tested
2789 with a preprocessing conditional such as @samp{#if
2790 #@var{question}(@var{answer})}.  @samp{-A-} disables the standard
2791 assertions that normally describe the target machine.
2793 @item -D@var{macro}
2794 Define macro @var{macro} with the string @samp{1} as its definition.
2796 @item -D@var{macro}=@var{defn}
2797 Define macro @var{macro} as @var{defn}.  All instances of @samp{-D} on
2798 the command line are processed before any @samp{-U} options.
2800 @item -U@var{macro}
2801 Undefine macro @var{macro}.  @samp{-U} options are evaluated after all
2802 @samp{-D} options, but before any @samp{-include} and @samp{-imacros}
2803 options.
2805 @item -dM
2806 Tell the preprocessor to output only a list of the macro definitions
2807 that are in effect at the end of preprocessing.  Used with the @samp{-E}
2808 option.
2810 @item -dD
2811 Tell the preprocessing to pass all macro definitions into the output, in
2812 their proper sequence in the rest of the output.
2814 @item -dN
2815 Like @samp{-dD} except that the macro arguments and contents are omitted.
2816 Only @samp{#define @var{name}} is included in the output.
2818 @item -trigraphs
2819 Support ANSI C trigraphs.  The @samp{-ansi} option also has this effect.
2821 @item -Wp,@var{option}
2822 Pass @var{option} as an option to the preprocessor.  If @var{option}
2823 contains commas, it is split into multiple options at the commas.
2824 @end table
2826 @node Assembler Options
2827 @section Passing Options to the Assembler
2829 @c prevent bad page break with this line
2830 You can pass options to the assembler.
2832 @table @code
2833 @item -Wa,@var{option}
2834 Pass @var{option} as an option to the assembler.  If @var{option}
2835 contains commas, it is split into multiple options at the commas.
2836 @end table
2838 @node Link Options
2839 @section Options for Linking
2840 @cindex link options
2841 @cindex options, linking
2843 These options come into play when the compiler links object files into
2844 an executable output file.  They are meaningless if the compiler is
2845 not doing a link step.
2847 @table @code
2848 @cindex file names
2849 @item @var{object-file-name}
2850 A file name that does not end in a special recognized suffix is
2851 considered to name an object file or library.  (Object files are
2852 distinguished from libraries by the linker according to the file
2853 contents.)  If linking is done, these object files are used as input
2854 to the linker.
2856 @item -c
2857 @itemx -S
2858 @itemx -E
2859 If any of these options is used, then the linker is not run, and
2860 object file names should not be used as arguments.  @xref{Overall
2861 Options}.
2863 @cindex Libraries
2864 @item -l@var{library}
2865 Search the library named @var{library} when linking.
2867 It makes a difference where in the command you write this option; the
2868 linker searches processes libraries and object files in the order they
2869 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
2870 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
2871 to functions in @samp{z}, those functions may not be loaded.
2873 The linker searches a standard list of directories for the library,
2874 which is actually a file named @file{lib@var{library}.a}.  The linker
2875 then uses this file as if it had been specified precisely by name.
2877 The directories searched include several standard system directories
2878 plus any that you specify with @samp{-L}.
2880 Normally the files found this way are library files---archive files
2881 whose members are object files.  The linker handles an archive file by
2882 scanning through it for members which define symbols that have so far
2883 been referenced but not defined.  But if the file that is found is an
2884 ordinary object file, it is linked in the usual fashion.  The only
2885 difference between using an @samp{-l} option and specifying a file name
2886 is that @samp{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
2887 and searches several directories.
2889 @item -lobjc
2890 You need this special case of the @samp{-l} option in order to
2891 link an Objective C program.
2893 @item -nostartfiles
2894 Do not use the standard system startup files when linking.
2895 The standard system libraries are used normally, unless @code{-nostdlib}
2896 or @code{-nodefaultlibs} is used.
2898 @item -nodefaultlibs
2899 Do not use the standard system libraries when linking.
2900 Only the libraries you specify will be passed to the linker.
2901 The standard startup files are used normally, unless @code{-nostartfiles}
2902 is used.  The compiler may generate calls to memcmp, memset, and memcpy
2903 for System V (and ANSI C) environments or to bcopy and bzero for
2904 BSD environments.  These entries are usually resolved by entries in
2905 libc.  These entry points should be supplied through some other
2906 mechanism when this option is specified.
2908 @item -nostdlib
2909 Do not use the standard system startup files or libraries when linking.
2910 No startup files and only the libraries you specify will be passed to
2911 the linker. The compiler may generate calls to memcmp, memset, and memcpy
2912 for System V (and ANSI C) environments or to bcopy and bzero for
2913 BSD environments.  These entries are usually resolved by entries in
2914 libc.  These entry points should be supplied through some other
2915 mechanism when this option is specified.
2917 @cindex @code{-lgcc}, use with @code{-nostdlib}
2918 @cindex @code{-nostdlib} and unresolved references
2919 @cindex unresolved references and @code{-nostdlib}
2920 @cindex @code{-lgcc}, use with @code{-nodefaultlibs}
2921 @cindex @code{-nodefaultlibs} and unresolved references
2922 @cindex unresolved references and @code{-nodefaultlibs}
2923 One of the standard libraries bypassed by @samp{-nostdlib} and
2924 @samp{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
2925 that GCC uses to overcome shortcomings of particular machines, or special
2926 needs for some languages.
2927 @ifset INTERNALS
2928 (@xref{Interface,,Interfacing to GCC Output}, for more discussion of
2929 @file{libgcc.a}.)
2930 @end ifset
2931 @ifclear INTERNALS
2932 (@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
2933 for more discussion of @file{libgcc.a}.)
2934 @end ifclear
2935 In most cases, you need @file{libgcc.a} even when you want to avoid
2936 other standard libraries.  In other words, when you specify @samp{-nostdlib}
2937 or @samp{-nodefaultlibs} you should usually specify @samp{-lgcc} as well.
2938 This ensures that you have no unresolved references to internal GCC
2939 library subroutines.  (For example, @samp{__main}, used to ensure C++
2940 constructors will be called; @pxref{Collect2,,@code{collect2}}.)
2942 @item -s
2943 Remove all symbol table and relocation information from the executable.
2945 @item -static
2946 On systems that support dynamic linking, this prevents linking with the shared
2947 libraries.  On other systems, this option has no effect.
2949 @item -shared
2950 Produce a shared object which can then be linked with other objects to
2951 form an executable.  Not all systems support this option.  You must
2952 also specify @samp{-fpic} or @samp{-fPIC} on some systems when
2953 you specify this option.
2955 @item -symbolic
2956 Bind references to global symbols when building a shared object.  Warn
2957 about any unresolved references (unless overridden by the link editor
2958 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
2959 this option.
2961 @item -Xlinker @var{option}
2962 Pass @var{option} as an option to the linker.  You can use this to
2963 supply system-specific linker options which GCC does not know how to
2964 recognize.
2966 If you want to pass an option that takes an argument, you must use
2967 @samp{-Xlinker} twice, once for the option and once for the argument.
2968 For example, to pass @samp{-assert definitions}, you must write
2969 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
2970 @samp{-Xlinker "-assert definitions"}, because this passes the entire
2971 string as a single argument, which is not what the linker expects.
2973 @item -Wl,@var{option}
2974 Pass @var{option} as an option to the linker.  If @var{option} contains
2975 commas, it is split into multiple options at the commas.
2977 @item -u @var{symbol}
2978 Pretend the symbol @var{symbol} is undefined, to force linking of
2979 library modules to define it.  You can use @samp{-u} multiple times with
2980 different symbols to force loading of additional library modules.
2981 @end table
2983 @node Directory Options
2984 @section Options for Directory Search
2985 @cindex directory options
2986 @cindex options, directory search
2987 @cindex search path
2989 These options specify directories to search for header files, for
2990 libraries and for parts of the compiler:
2992 @table @code
2993 @item -I@var{dir}
2994 Add the directory @var{dir} to the head of the list of directories to be
2995 searched for header files.  This can be used to override a system header
2996 file, substituting your own version, since these directories are
2997 searched before the system header file directories.  If you use more
2998 than one @samp{-I} option, the directories are scanned in left-to-right
2999 order; the standard system directories come after.
3001 @item -I-
3002 Any directories you specify with @samp{-I} options before the @samp{-I-}
3003 option are searched only for the case of @samp{#include "@var{file}"};
3004 they are not searched for @samp{#include <@var{file}>}.
3006 If additional directories are specified with @samp{-I} options after
3007 the @samp{-I-}, these directories are searched for all @samp{#include}
3008 directives.  (Ordinarily @emph{all} @samp{-I} directories are used
3009 this way.)
3011 In addition, the @samp{-I-} option inhibits the use of the current
3012 directory (where the current input file came from) as the first search
3013 directory for @samp{#include "@var{file}"}.  There is no way to
3014 override this effect of @samp{-I-}.  With @samp{-I.} you can specify
3015 searching the directory which was current when the compiler was
3016 invoked.  That is not exactly the same as what the preprocessor does
3017 by default, but it is often satisfactory.
3019 @samp{-I-} does not inhibit the use of the standard system directories
3020 for header files.  Thus, @samp{-I-} and @samp{-nostdinc} are
3021 independent.
3023 @item -L@var{dir}
3024 Add directory @var{dir} to the list of directories to be searched
3025 for @samp{-l}.
3027 @item -B@var{prefix}
3028 This option specifies where to find the executables, libraries,
3029 include files, and data files of the compiler itself.
3031 The compiler driver program runs one or more of the subprograms
3032 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
3033 @var{prefix} as a prefix for each program it tries to run, both with and
3034 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
3036 For each subprogram to be run, the compiler driver first tries the
3037 @samp{-B} prefix, if any.  If that name is not found, or if @samp{-B}
3038 was not specified, the driver tries two standard prefixes, which are
3039 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
3040 those results in a file name that is found, the unmodified program
3041 name is searched for using the directories specified in your
3042 @samp{PATH} environment variable.
3044 @samp{-B} prefixes that effectively specify directory names also apply
3045 to libraries in the linker, because the compiler translates these
3046 options into @samp{-L} options for the linker.  They also apply to
3047 includes files in the preprocessor, because the compiler translates these
3048 options into @samp{-isystem} options for the preprocessor.  In this case,
3049 the compiler appends @samp{include} to the prefix.
3051 The run-time support file @file{libgcc.a} can also be searched for using
3052 the @samp{-B} prefix, if needed.  If it is not found there, the two
3053 standard prefixes above are tried, and that is all.  The file is left
3054 out of the link if it is not found by those means.
3056 Another way to specify a prefix much like the @samp{-B} prefix is to use
3057 the environment variable @code{GCC_EXEC_PREFIX}.  @xref{Environment
3058 Variables}.
3060 @item -specs=@var{file}
3061 Process @var{file} after the compiler reads in the standard @file{specs}
3062 file, in order to override the defaults that the @file{gcc} driver
3063 program uses when determining what switches to pass to @file{cc1},
3064 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
3065 @samp{-specs=}@var{file} can be specified on the command line, and they
3066 are processed in order, from left to right.
3067 @end table
3069 @node Spec Files
3070 @section Specifying subprocesses and the switches to pass to them
3071 @cindex Spec Files
3072 @code{GCC} is a driver program.  It performs its job by invoking a
3073 sequence of other programs to do the work of compiling, assembling and
3074 linking.  GCC interprets its command-line parameters and uses these to
3075 deduce which programs it should invoke, and which command-line options
3076 it ought to place on their command lines.  This behaviour is controlled
3077 by @dfn{spec strings}.  In most cases there is one spec string for each
3078 program that GCC can invoke, but a few programs have multiple spec
3079 strings to control their behaviour.  The spec strings built into GCC can
3080 be overridden by using the @samp{-specs=} command-line switch to specify
3081 a spec file.
3083 @dfn{Spec files} are plaintext files that are used to construct spec
3084 strings.  They consist of a sequence of directives separated by blank
3085 lines.  The type of directive is determined by the first non-whitespace
3086 character on the line and it can be one of the following:
3088 @table @code
3089 @item %@var{command}
3090 Issues a @var{command} to the spec file processor.  The commands that can
3091 appear here are: 
3093 @table @code
3094 @item %include <@var{file}>
3095 @cindex %include
3096 Search for @var{file} and insert its text at the current point in the
3097 specs file.
3099 @item %include_noerr <@var{file}>
3100 @cindex %include_noerr
3101 Just like @samp{%include}, but do not generate an error message if the include
3102 file cannot be found.
3104 @item %rename @var{old_name} @var{new_name}
3105 @cindex %rename
3106 Rename the spec string @var{old_name} to @var{new_name}.
3108 @end table
3110 @item *[@var{spec_name}]:
3111 This tells the compiler to create, override or delete the named spec
3112 string.  All lines after this directive up to the next directive or
3113 blank line are considered to be the text for the spec string.  If this
3114 results in an empty string then the spec will be deleted.  (Or, if the
3115 spec did not exist, then nothing will happened.)  Otherwise, if the spec
3116 does not currently exist a new spec will be created.  If the spec does
3117 exist then its contents will be overridden by the text of this
3118 directive, unless the first character of that text is the @samp{+}
3119 character, in which case the text will be appended to the spec.
3121 @item [@var{suffix}]:
3122 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
3123 and up to the next directive or blank line are considered to make up the
3124 spec string for the indicated suffix.  When the compiler encounters an 
3125 input file with the named suffix, it will processes the spec string in
3126 order to work out how to compile that file.  For example:
3128 @smallexample
3129 .ZZ:
3130 z-compile -input %i
3131 @end smallexample
3133 This says that any input file whose name ends in @samp{.ZZ} should be
3134 passed to the program @samp{z-compile}, which should be invoked with the
3135 command-line switch @samp{-input} and with the result of performing the
3136 @samp{%i} substitution.  (See below.)
3138 As an alternative to providing a spec string, the text that follows a
3139 suffix directive can be one of the following:
3141 @table @code
3142 @item @@@var{language}
3143 This says that the suffix is an alias for a known @var{language}.  This is
3144 similar to using the @code{-x} command-line switch to GCC to specify a
3145 language explicitly.  For example:
3147 @smallexample
3148 .ZZ:
3149 @@c++
3150 @end smallexample
3152 Says that .ZZ files are, in fact, C++ source files.
3154 @item #@var{name}
3155 This causes an error messages saying:
3157 @smallexample
3158 @var{name} compiler not installed on this system.
3159 @end smallexample
3160 @end table
3162 GCC already has an extensive list of suffixes built into it.
3163 This directive will add an entry to the end of the list of suffixes, but
3164 since the list is searched from the end backwards, it is effectively
3165 possible to override earlier entries using this technique.
3167 @end table
3169 GCC has the following spec strings built into it.  Spec files can
3170 override these strings or create their own.  Note that individual
3171 targets can also add their own spec strings to this list. 
3173 @smallexample
3174 asm          Options to pass to the assembler
3175 asm_final    Options to pass to the assembler post-processor
3176 cpp          Options to pass to the C preprocessor
3177 cc1          Options to pass to the C compiler
3178 cc1plus      Options to pass to the C++ compiler
3179 endfile      Object files to include at the end of the link
3180 link         Options to pass to the linker
3181 lib          Libraries to include on the command line to the linker
3182 libgcc       Decides which GCC support library to pass to the linker
3183 linker       Sets the name of the linker
3184 predefines   Defines to be passed to the C preprocessor
3185 signed_char  Defines to pass to CPP to say whether @code{char} is signed by default
3186 startfile    Object files to include at the start of the link
3187 @end smallexample
3189 Here is a small example of a spec file:
3191 @smallexample
3192 %rename lib                 old_lib
3194 *lib:
3195 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
3196 @end smallexample
3198 This example renames the spec called @samp{lib} to @samp{old_lib} and
3199 then overrides the previous definition of @samp{lib} with a new one.
3200 The new definition adds in some extra command-line options before
3201 including the text of the old definition.
3203 @dfn{Spec strings} are a list of command-line options to be passed to their
3204 corresponding program.  In addition, the spec strings can contain
3205 @samp{%}-prefixed sequences to substitute variable text or to
3206 conditionally insert text into the command line.  Using these constructs
3207 it is possible to generate quite complex command lines.
3209 Here is a table of all defined @samp{%}-sequences for spec
3210 strings.  Note that spaces are not generated automatically around the
3211 results of expanding these sequences.  Therefore you can concatenate them
3212 together or combine them with constant text in a single argument. 
3214 @table @code
3215 @item %%
3216 Substitute one @samp{%} into the program name or argument.
3218 @item %i
3219 Substitute the name of the input file being processed.
3221 @item %b
3222 Substitute the basename of the input file being processed.
3223 This is the substring up to (and not including) the last period
3224 and not including the directory.
3226 @item %d
3227 Marks the argument containing or following the @samp{%d} as a
3228 temporary file name, so that that file will be deleted if GCC exits
3229 successfully.  Unlike @samp{%g}, this contributes no text to the
3230 argument. 
3232 @item %g@var{suffix}
3233 Substitute a file name that has suffix @var{suffix} and is chosen
3234 once per compilation, and mark the argument in the same way as
3235 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
3236 name is now chosen in a way that is hard to predict even when previously 
3237 chosen file names are known.  For example, @samp{%g.s ... %g.o ... %g.s}
3238 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
3239 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
3240 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
3241 was simply substituted with a file name chosen once per compilation,
3242 without regard to any appended suffix (which was therefore treated
3243 just like ordinary text), making such attacks more likely to succeed.
3245 @item %u@var{suffix}
3246 Like @samp{%g}, but generates a new temporary file name even if
3247 @samp{%u@var{suffix}} was already seen.
3249 @item %U@var{suffix}
3250 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
3251 new one if there is no such last file name.  In the absence of any
3252 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
3253 the same suffix @emph{space}, so @samp{%g.s ... %U.s ... %g.s ... %U.s}
3254 would involve the generation of two distinct file names, one
3255 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
3256 simply substituted with a file name chosen for the previous @samp{%u},
3257 without regard to any appended suffix.
3259 @item %w
3260 Marks the argument containing or following the @samp{%w} as the
3261 designated output file of this compilation.  This puts the argument
3262 into the sequence of arguments that @samp{%o} will substitute later.
3264 @item %o
3265 Substitutes the names of all the output files, with spaces
3266 automatically placed around them.  You should write spaces
3267 around the @samp{%o} as well or the results are undefined.
3268 @samp{%o} is for use in the specs for running the linker.
3269 Input files whose names have no recognized suffix are not compiled
3270 at all, but they are included among the output files, so they will
3271 be linked.
3273 @item %O
3274 Substitutes the suffix for object files.  Note that this is
3275 handled specially when it immediately follows @samp{%g, %u, or %U},
3276 because of the need for those to form complete file names.  The
3277 handling is such that @samp{%O} is treated exactly as if it had already
3278 been substituted, except that @samp{%g, %u, and %U} do not currently
3279 support additional @var{suffix} characters following @samp{%O} as they would
3280 following, for example, @samp{.o}.
3282 @item %p
3283 Substitutes the standard macro predefinitions for the
3284 current target machine.  Use this when running @code{cpp}.
3286 @item %P
3287 Like @samp{%p}, but puts @samp{__} before and after the name of each
3288 predefined macro, except for macros that start with @samp{__} or with
3289 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ANSI
3290 C.  
3292 @item %I
3293 Substitute a @samp{-iprefix} option made from GCC_EXEC_PREFIX.
3295 @item %s
3296 Current argument is the name of a library or startup file of some sort.
3297 Search for that file in a standard list of directories and substitute
3298 the full name found. 
3300 @item %e@var{str}
3301 Print @var{str} as an error message.  @var{str} is terminated by a newline.
3302 Use this when inconsistent options are detected.
3304 @item %|
3305 Output @samp{-} if the input for the current command is coming from a pipe.
3307 @item %(@var{name})
3308 Substitute the contents of spec string @var{name} at this point.
3310 @item %[@var{name}]
3311 Like @samp{%(...)} but put @samp{__} around @samp{-D} arguments.
3313 @item %x@{@var{option}@}
3314 Accumulate an option for @samp{%X}.
3316 @item %X
3317 Output the accumulated linker options specified by @samp{-Wl} or a @samp{%x}
3318 spec string.
3320 @item %Y
3321 Output the accumulated assembler options specified by @samp{-Wa}.
3323 @item %Z
3324 Output the accumulated preprocessor options specified by @samp{-Wp}.
3326 @item %v1
3327 Substitute the major version number of GCC.
3328 (For version 2.9.5, this is 2.)
3330 @item %v2
3331 Substitute the minor version number of GCC.
3332 (For version 2.9.5, this is 9.)
3334 @item %a
3335 Process the @code{asm} spec.  This is used to compute the
3336 switches to be passed to the assembler.
3338 @item %A
3339 Process the @code{asm_final} spec.  This is a spec string for
3340 passing switches to an assembler post-processor, if such a program is
3341 needed.
3343 @item %l
3344 Process the @code{link} spec.  This is the spec for computing the
3345 command line passed to the linker.  Typically it will make use of the
3346 @samp{%L %G %S %D and %E} sequences.
3348 @item %D
3349 Dump out a @samp{-L} option for each directory that GCC believes might
3350 contain startup files.  If the target supports multilibs then the
3351 current multilib directory will be prepended to each of these paths. 
3353 @item %L
3354 Process the @code{lib} spec.  This is a spec string for deciding which
3355 libraries should be included on the command line to the linker. 
3357 @item %G
3358 Process the @code{libgcc} spec.  This is a spec string for deciding
3359 which GCC support library should be included on the command line to the linker. 
3361 @item %S
3362 Process the @code{startfile} spec.  This is a spec for deciding which
3363 object files should be the first ones passed to the linker.  Typically
3364 this might be a file named @file{crt0.o}. 
3366 @item %E
3367 Process the @code{endfile} spec.  This is a spec string that specifies
3368 the last object files that will be passed to the linker.  
3370 @item %C
3371 Process the @code{cpp} spec.  This is used to construct the arguments
3372 to be passed to the C preprocessor.
3374 @item %c
3375 Process the @code{signed_char} spec.  This is intended to be used
3376 to tell cpp whether a char is signed.  It typically has the definition: 
3377 @smallexample
3378 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
3379 @end smallexample
3381 @item %1
3382 Process the @code{cc1} spec.  This is used to construct the options to be
3383 passed to the actual C compiler (@samp{cc1}).
3385 @item %2
3386 Process the @code{cc1plus} spec.  This is used to construct the options to be
3387 passed to the actual C++ compiler (@samp{cc1plus}).
3389 @item %*
3390 Substitute the variable part of a matched option.  See below.
3391 Note that each comma in the substituted string is replaced by
3392 a single space.
3394 @item %@{@code{S}@}
3395 Substitutes the @code{-S} switch, if that switch was given to GCC.
3396 If that switch was not specified, this substitutes nothing.  Note that
3397 the leading dash is omitted when specifying this option, and it is
3398 automatically inserted if the substitution is performed.  Thus the spec
3399 string @samp{%@{foo@}} would match the command-line option @samp{-foo}
3400 and would output the command line option @samp{-foo}.
3402 @item %W@{@code{S}@}
3403 Like %@{@code{S}@} but mark last argument supplied within as a file to be
3404 deleted on failure. 
3406 @item %@{@code{S}*@}
3407 Substitutes all the switches specified to GCC whose names start
3408 with @code{-S}, but which also take an argument.  This is used for
3409 switches like @samp{-o, -D, -I}, etc.  GCC considers @samp{-o foo} as being
3410 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
3411 text, including the space.  Thus two arguments would be generated. 
3413 @item %@{^@code{S}*@}
3414 Like %@{@code{S}*@}, but don't put a blank between a switch and its
3415 argument.  Thus %@{^o*@} would only generate one argument, not two.
3417 @item %@{@code{S}*:@code{X}@}
3418 Substitutes @code{X} if one or more switches whose names start with
3419 @code{-S} are specified to GCC.  Note that the tail part of the
3420 @code{-S} option (i.e. the part matched by the @samp{*}) will be substituted
3421 for each occurrence of @samp{%*} within @code{X}. 
3423 @item %@{@code{S}:@code{X}@}
3424 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC.
3426 @item %@{!@code{S}:@code{X}@}
3427 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC.
3429 @item %@{|@code{S}:@code{X}@}
3430 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
3432 @item %@{|!@code{S}:@code{X}@}
3433 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
3435 @item %@{.@code{S}:@code{X}@}
3436 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
3438 @item %@{!.@code{S}:@code{X}@}
3439 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
3441 @item %@{@code{S}|@code{P}:@code{X}@}
3442 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC.  This may be
3443 combined with @samp{!} and @samp{.} sequences as well, although they
3444 have a stronger binding than the @samp{|}.  For example a spec string
3445 like this:
3447 @smallexample
3448 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
3449 @end smallexample
3451 will output the following command-line options from the following input
3452 command-line options:
3454 @smallexample
3455 fred.c        -foo -baz
3456 jim.d         -bar -boggle
3457 -d fred.c     -foo -baz -boggle
3458 -d jim.d      -bar -baz -boggle
3459 @end smallexample
3461 @end table
3463 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
3464 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
3465 or spaces, or even newlines.  They are processed as usual, as described
3466 above. 
3468 The @samp{-O, -f, -m, and -W} switches are handled specifically in these
3469 constructs.  If another value of @samp{-O} or the negated form of a @samp{-f, -m, or
3470 -W} switch is found later in the command line, the earlier switch
3471 value is ignored, except with @{@code{S}*@} where @code{S} is just one
3472 letter, which passes all matching options.
3474 The character @samp{|} at the beginning of the predicate text is used to indicate
3475 that a command should be piped to the following command, but only if @samp{-pipe}
3476 is specified.
3478 It is built into GCC which switches take arguments and which do not.
3479 (You might think it would be useful to generalize this to allow each
3480 compiler's spec to say which switches take arguments.  But this cannot
3481 be done in a consistent fashion.  GCC cannot even decide which input
3482 files have been specified without knowing which switches take arguments,
3483 and it must know which input files to compile in order to tell which
3484 compilers to run). 
3486 GCC also knows implicitly that arguments starting in @samp{-l} are to be
3487 treated as compiler output files, and passed to the linker in their
3488 proper position among the other output files.
3490 @node Target Options
3491 @section Specifying Target Machine and Compiler Version
3492 @cindex target options
3493 @cindex cross compiling
3494 @cindex specifying machine version
3495 @cindex specifying compiler version and target machine
3496 @cindex compiler version, specifying
3497 @cindex target machine, specifying
3499 By default, GCC compiles code for the same type of machine that you
3500 are using.  However, it can also be installed as a cross-compiler, to
3501 compile for some other type of machine.  In fact, several different
3502 configurations of GCC, for different target machines, can be
3503 installed side by side.  Then you specify which one to use with the
3504 @samp{-b} option.
3506 In addition, older and newer versions of GCC can be installed side
3507 by side.  One of them (probably the newest) will be the default, but
3508 you may sometimes wish to use another.
3510 @table @code
3511 @item -b @var{machine}
3512 The argument @var{machine} specifies the target machine for compilation.
3513 This is useful when you have installed GCC as a cross-compiler.
3515 The value to use for @var{machine} is the same as was specified as the
3516 machine type when configuring GCC as a cross-compiler.  For
3517 example, if a cross-compiler was configured with @samp{configure
3518 i386v}, meaning to compile for an 80386 running System V, then you
3519 would specify @samp{-b i386v} to run that cross compiler.
3521 When you do not specify @samp{-b}, it normally means to compile for
3522 the same type of machine that you are using.
3524 @item -V @var{version}
3525 The argument @var{version} specifies which version of GCC to run.
3526 This is useful when multiple versions are installed.  For example,
3527 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
3529 The default version, when you do not specify @samp{-V}, is the last
3530 version of GCC that you installed.
3531 @end table
3533 The @samp{-b} and @samp{-V} options actually work by controlling part of
3534 the file name used for the executable files and libraries used for
3535 compilation.  A given version of GCC, for a given target machine, is
3536 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.@refill
3538 Thus, sites can customize the effect of @samp{-b} or @samp{-V} either by
3539 changing the names of these directories or adding alternate names (or
3540 symbolic links).  If in directory @file{/usr/local/lib/gcc-lib/} the
3541 file @file{80386} is a link to the file @file{i386v}, then @samp{-b
3542 80386} becomes an alias for @samp{-b i386v}.
3544 In one respect, the @samp{-b} or @samp{-V} do not completely change
3545 to a different compiler: the top-level driver program @code{gcc}
3546 that you originally invoked continues to run and invoke the other
3547 executables (preprocessor, compiler per se, assembler and linker)
3548 that do the real work.  However, since no real work is done in the
3549 driver program, it usually does not matter that the driver program
3550 in use is not the one for the specified target and version.
3552 The only way that the driver program depends on the target machine is
3553 in the parsing and handling of special machine-specific options.
3554 However, this is controlled by a file which is found, along with the
3555 other executables, in the directory for the specified version and
3556 target machine.  As a result, a single installed driver program adapts
3557 to any specified target machine and compiler version.
3559 The driver program executable does control one significant thing,
3560 however: the default version and target machine.  Therefore, you can
3561 install different instances of the driver program, compiled for
3562 different targets or versions, under different names.
3564 For example, if the driver for version 2.0 is installed as @code{ogcc}
3565 and that for version 2.1 is installed as @code{gcc}, then the command
3566 @code{gcc} will use version 2.1 by default, while @code{ogcc} will use
3567 2.0 by default.  However, you can choose either version with either
3568 command with the @samp{-V} option.
3570 @node Submodel Options
3571 @section Hardware Models and Configurations
3572 @cindex submodel options
3573 @cindex specifying hardware config
3574 @cindex hardware models and configurations, specifying
3575 @cindex machine dependent options
3577 Earlier we discussed the standard option @samp{-b} which chooses among
3578 different installed compilers for completely different target
3579 machines, such as Vax vs. 68000 vs. 80386.
3581 In addition, each of these target machine types can have its own
3582 special options, starting with @samp{-m}, to choose among various
3583 hardware models or configurations---for example, 68010 vs 68020,
3584 floating coprocessor or none.  A single installed version of the
3585 compiler can compile for any model or configuration, according to the
3586 options specified.
3588 Some configurations of the compiler also support additional special
3589 options, usually for compatibility with other compilers on the same
3590 platform.
3592 @ifset INTERNALS
3593 These options are defined by the macro @code{TARGET_SWITCHES} in the
3594 machine description.  The default for the options is also defined by
3595 that macro, which enables you to change the defaults.
3596 @end ifset
3598 @menu
3599 * M680x0 Options::
3600 * VAX Options::
3601 * SPARC Options::
3602 * Convex Options::
3603 * AMD29K Options::
3604 * ARM Options::
3605 * Thumb Options::
3606 * MN10200 Options::
3607 * MN10300 Options::
3608 * M32R/D Options::
3609 * M88K Options::
3610 * RS/6000 and PowerPC Options::
3611 * RT Options::
3612 * MIPS Options::
3613 * i386 Options::
3614 * HPPA Options::
3615 * Intel 960 Options::
3616 * DEC Alpha Options::
3617 * Clipper Options::
3618 * H8/300 Options::
3619 * SH Options::
3620 * System V Options::
3621 * TMS320C3x/C4x Options::
3622 * V850 Options::
3623 * ARC Options::
3624 * NS32K Options::
3625 @end menu
3627 @node M680x0 Options
3628 @subsection M680x0 Options
3629 @cindex M680x0 options
3631 These are the @samp{-m} options defined for the 68000 series.  The default
3632 values for these options depends on which style of 68000 was selected when
3633 the compiler was configured; the defaults for the most common choices are
3634 given below.
3636 @table @code
3637 @item -m68000
3638 @itemx -mc68000
3639 Generate output for a 68000.  This is the default
3640 when the compiler is configured for 68000-based systems.
3642 Use this option for microcontrollers with a 68000 or EC000 core,
3643 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
3645 @item -m68020
3646 @itemx -mc68020
3647 Generate output for a 68020.  This is the default
3648 when the compiler is configured for 68020-based systems.
3650 @item -m68881
3651 Generate output containing 68881 instructions for floating point.
3652 This is the default for most 68020 systems unless @samp{-nfp} was
3653 specified when the compiler was configured.
3655 @item -m68030
3656 Generate output for a 68030.  This is the default when the compiler is
3657 configured for 68030-based systems.
3659 @item -m68040
3660 Generate output for a 68040.  This is the default when the compiler is
3661 configured for 68040-based systems.
3663 This option inhibits the use of 68881/68882 instructions that have to be
3664 emulated by software on the 68040.  Use this option if your 68040 does not
3665 have code to emulate those instructions.
3667 @item -m68060
3668 Generate output for a 68060.  This is the default when the compiler is
3669 configured for 68060-based systems.
3671 This option inhibits the use of 68020 and 68881/68882 instructions that
3672 have to be emulated by software on the 68060.  Use this option if your 68060
3673 does not have code to emulate those instructions.
3675 @item -mcpu32
3676 Generate output for a CPU32. This is the default
3677 when the compiler is configured for CPU32-based systems.
3679 Use this option for microcontrollers with a
3680 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
3681 68336, 68340, 68341, 68349 and 68360.
3683 @item -m5200
3684 Generate output for a 520X "coldfire" family cpu.  This is the default
3685 when the compiler is configured for 520X-based systems.
3687 Use this option for microcontroller with a 5200 core, including 
3688 the MCF5202, MCF5203, MCF5204 and MCF5202.
3691 @item -m68020-40
3692 Generate output for a 68040, without using any of the new instructions.
3693 This results in code which can run relatively efficiently on either a
3694 68020/68881 or a 68030 or a 68040.  The generated code does use the
3695 68881 instructions that are emulated on the 68040.
3697 @item -m68020-60
3698 Generate output for a 68060, without using any of the new instructions.
3699 This results in code which can run relatively efficiently on either a
3700 68020/68881 or a 68030 or a 68040.  The generated code does use the
3701 68881 instructions that are emulated on the 68060.
3703 @item -mfpa
3704 Generate output containing Sun FPA instructions for floating point.
3706 @item -msoft-float
3707 Generate output containing library calls for floating point.
3708 @strong{Warning:} the requisite libraries are not available for all m68k
3709 targets.  Normally the facilities of the machine's usual C compiler are
3710 used, but this can't be done directly in cross-compilation.  You must
3711 make your own arrangements to provide suitable library functions for
3712 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
3713 @samp{m68k-*-coff} do provide software floating point support.
3715 @item -mshort
3716 Consider type @code{int} to be 16 bits wide, like @code{short int}.
3718 @item -mnobitfield
3719 Do not use the bit-field instructions.  The @samp{-m68000}, @samp{-mcpu32}
3720 and @samp{-m5200} options imply @w{@samp{-mnobitfield}}.
3722 @item -mbitfield
3723 Do use the bit-field instructions.  The @samp{-m68020} option implies
3724 @samp{-mbitfield}.  This is the default if you use a configuration
3725 designed for a 68020.
3727 @item -mrtd
3728 Use a different function-calling convention, in which functions
3729 that take a fixed number of arguments return with the @code{rtd}
3730 instruction, which pops their arguments while returning.  This
3731 saves one instruction in the caller since there is no need to pop
3732 the arguments there.
3734 This calling convention is incompatible with the one normally
3735 used on Unix, so you cannot use it if you need to call libraries
3736 compiled with the Unix compiler.
3738 Also, you must provide function prototypes for all functions that
3739 take variable numbers of arguments (including @code{printf});
3740 otherwise incorrect code will be generated for calls to those
3741 functions.
3743 In addition, seriously incorrect code will result if you call a
3744 function with too many arguments.  (Normally, extra arguments are
3745 harmlessly ignored.)
3747 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
3748 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
3750 @item -malign-int
3751 @itemx -mno-align-int
3752 Control whether GCC aligns @code{int}, @code{long}, @code{long long}, 
3753 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
3754 boundary (@samp{-malign-int}) or a 16-bit boundary (@samp{-mno-align-int}).
3755 Aligning variables on 32-bit boundaries produces code that runs somewhat
3756 faster on processors with 32-bit busses at the expense of more memory.
3758 @strong{Warning:} if you use the @samp{-malign-int} switch, GCC will
3759 align structures containing the above types  differently than
3760 most published application binary interface specifications for the m68k.
3762 @item -mpcrel
3763 Use the pc-relative addressing mode of the 68000 directly, instead of
3764 using a global offset table.  At present, this option implies -fpic,
3765 allowing at most a 16-bit offset for pc-relative addressing.  -fPIC is
3766 not presently supported with -mpcrel, though this could be supported for
3767 68020 and higher processors.
3769 @end table
3771 @node VAX Options
3772 @subsection VAX Options
3773 @cindex VAX options
3775 These @samp{-m} options are defined for the Vax:
3777 @table @code
3778 @item -munix
3779 Do not output certain jump instructions (@code{aobleq} and so on)
3780 that the Unix assembler for the Vax cannot handle across long
3781 ranges.
3783 @item -mgnu
3784 Do output those jump instructions, on the assumption that you
3785 will assemble with the GNU assembler.
3787 @item -mg
3788 Output code for g-format floating point numbers instead of d-format.
3789 @end table
3791 @node SPARC Options
3792 @subsection SPARC Options
3793 @cindex SPARC options
3795 These @samp{-m} switches are supported on the SPARC:
3797 @table @code
3798 @item -mno-app-regs
3799 @itemx -mapp-regs
3800 Specify @samp{-mapp-regs} to generate output using the global registers
3801 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
3802 is the default.
3804 To be fully SVR4 ABI compliant at the cost of some performance loss,
3805 specify @samp{-mno-app-regs}.  You should compile libraries and system
3806 software with this option.
3808 @item -mfpu
3809 @itemx -mhard-float
3810 Generate output containing floating point instructions.  This is the
3811 default.
3813 @item -mno-fpu
3814 @itemx -msoft-float
3815 Generate output containing library calls for floating point.
3816 @strong{Warning:} the requisite libraries are not available for all SPARC
3817 targets.  Normally the facilities of the machine's usual C compiler are
3818 used, but this cannot be done directly in cross-compilation.  You must make
3819 your own arrangements to provide suitable library functions for
3820 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
3821 @samp{sparclite-*-*} do provide software floating point support.
3823 @samp{-msoft-float} changes the calling convention in the output file;
3824 therefore, it is only useful if you compile @emph{all} of a program with
3825 this option.  In particular, you need to compile @file{libgcc.a}, the
3826 library that comes with GCC, with @samp{-msoft-float} in order for
3827 this to work.
3829 @item -mhard-quad-float
3830 Generate output containing quad-word (long double) floating point
3831 instructions.
3833 @item -msoft-quad-float
3834 Generate output containing library calls for quad-word (long double)
3835 floating point instructions.  The functions called are those specified
3836 in the SPARC ABI.  This is the default.
3838 As of this writing, there are no sparc implementations that have hardware
3839 support for the quad-word floating point instructions.  They all invoke
3840 a trap handler for one of these instructions, and then the trap handler
3841 emulates the effect of the instruction.  Because of the trap handler overhead,
3842 this is much slower than calling the ABI library routines.  Thus the
3843 @samp{-msoft-quad-float} option is the default.
3845 @item -mno-epilogue
3846 @itemx -mepilogue
3847 With @samp{-mepilogue} (the default), the compiler always emits code for
3848 function exit at the end of each function.  Any function exit in
3849 the middle of the function (such as a return statement in C) will
3850 generate a jump to the exit code at the end of the function.
3852 With @samp{-mno-epilogue}, the compiler tries to emit exit code inline
3853 at every function exit.
3855 @item -mno-flat
3856 @itemx -mflat
3857 With @samp{-mflat}, the compiler does not generate save/restore instructions
3858 and will use a "flat" or single register window calling convention.
3859 This model uses %i7 as the frame pointer and is compatible with the normal
3860 register window model.  Code from either may be intermixed.
3861 The local registers and the input registers (0-5) are still treated as
3862 "call saved" registers and will be saved on the stack as necessary.
3864 With @samp{-mno-flat} (the default), the compiler emits save/restore
3865 instructions (except for leaf functions) and is the normal mode of operation.
3867 @item -mno-unaligned-doubles
3868 @itemx -munaligned-doubles
3869 Assume that doubles have 8 byte alignment.  This is the default.
3871 With @samp{-munaligned-doubles}, GCC assumes that doubles have 8 byte
3872 alignment only if they are contained in another type, or if they have an
3873 absolute address.  Otherwise, it assumes they have 4 byte alignment.
3874 Specifying this option avoids some rare compatibility problems with code
3875 generated by other compilers.  It is not the default because it results
3876 in a performance loss, especially for floating point code.
3878 @item -mv8
3879 @itemx -msparclite
3880 These two options select variations on the SPARC architecture.
3882 By default (unless specifically configured for the Fujitsu SPARClite),
3883 GCC generates code for the v7 variant of the SPARC architecture.
3885 @samp{-mv8} will give you SPARC v8 code.  The only difference from v7
3886 code is that the compiler emits the integer multiply and integer
3887 divide instructions which exist in SPARC v8 but not in SPARC v7.
3889 @samp{-msparclite} will give you SPARClite code.  This adds the integer
3890 multiply, integer divide step and scan (@code{ffs}) instructions which
3891 exist in SPARClite but not in SPARC v7.
3893 These options are deprecated and will be deleted in a future GCC release.
3894 They have been replaced with @samp{-mcpu=xxx}.
3896 @item -mcypress
3897 @itemx -msupersparc
3898 These two options select the processor for which the code is optimised.
3900 With @samp{-mcypress} (the default), the compiler optimizes code for the
3901 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
3902 This is also appropriate for the older SparcStation 1, 2, IPX etc.
3904 With @samp{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
3905 used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
3906 of the full SPARC v8 instruction set.
3908 These options are deprecated and will be deleted in a future GCC release.
3909 They have been replaced with @samp{-mcpu=xxx}.
3911 @item -mcpu=@var{cpu_type}
3912 Set the instruction set, register set, and instruction scheduling parameters
3913 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
3914 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
3915 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
3916 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
3918 Default instruction scheduling parameters are used for values that select
3919 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
3920 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
3922 Here is a list of each supported architecture and their supported
3923 implementations.
3925 @smallexample
3926     v7:             cypress
3927     v8:             supersparc, hypersparc
3928     sparclite:      f930, f934, sparclite86x
3929     sparclet:       tsc701
3930     v9:             ultrasparc
3931 @end smallexample
3933 @item -mtune=@var{cpu_type}
3934 Set the instruction scheduling parameters for machine type
3935 @var{cpu_type}, but do not set the instruction set or register set that the
3936 option @samp{-mcpu=}@var{cpu_type} would.
3938 The same values for @samp{-mcpu=}@var{cpu_type} are used for
3939 @samp{-mtune=}@*@var{cpu_type}, though the only useful values are those that
3940 select a particular cpu implementation: @samp{cypress}, @samp{supersparc},
3941 @samp{hypersparc}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
3942 @samp{tsc701}, @samp{ultrasparc}.
3944 @end table
3946 These @samp{-m} switches are supported in addition to the above
3947 on the SPARCLET processor.
3949 @table @code
3950 @item -mlittle-endian
3951 Generate code for a processor running in little-endian mode.
3953 @item -mlive-g0
3954 Treat register @code{%g0} as a normal register.
3955 GCC will continue to clobber it as necessary but will not assume
3956 it always reads as 0.
3958 @item -mbroken-saverestore
3959 Generate code that does not use non-trivial forms of the @code{save} and
3960 @code{restore} instructions.  Early versions of the SPARCLET processor do
3961 not correctly handle @code{save} and @code{restore} instructions used with
3962 arguments.  They correctly handle them used without arguments.  A @code{save}
3963 instruction used without arguments increments the current window pointer
3964 but does not allocate a new stack frame.  It is assumed that the window
3965 overflow trap handler will properly handle this case as will interrupt
3966 handlers.
3967 @end table
3969 These @samp{-m} switches are supported in addition to the above
3970 on SPARC V9 processors in 64 bit environments.
3972 @table @code
3973 @item -mlittle-endian
3974 Generate code for a processor running in little-endian mode.
3976 @item -m32
3977 @itemx -m64
3978 Generate code for a 32 bit or 64 bit environment.
3979 The 32 bit environment sets int, long and pointer to 32 bits.
3980 The 64 bit environment sets int to 32 bits and long and pointer
3981 to 64 bits.
3983 @item -mcmodel=medlow
3984 Generate code for the Medium/Low code model: the program must be linked
3985 in the low 32 bits of the address space.  Pointers are 64 bits.
3986 Programs can be statically or dynamically linked.
3988 @item -mcmodel=medmid
3989 Generate code for the Medium/Middle code model: the program must be linked
3990 in the low 44 bits of the address space, the text segment must be less than
3991 2G bytes, and data segment must be within 2G of the text segment.
3992 Pointers are 64 bits.
3994 @item -mcmodel=medany
3995 Generate code for the Medium/Anywhere code model: the program may be linked
3996 anywhere in the address space, the text segment must be less than
3997 2G bytes, and data segment must be within 2G of the text segment.
3998 Pointers are 64 bits.
4000 @item -mcmodel=embmedany
4001 Generate code for the Medium/Anywhere code model for embedded systems:
4002 assume a 32 bit text and a 32 bit data segment, both starting anywhere
4003 (determined at link time).  Register %g4 points to the base of the
4004 data segment.  Pointers still 64 bits.
4005 Programs are statically linked, PIC is not supported.
4007 @item -mstack-bias
4008 @itemx -mno-stack-bias
4009 With @samp{-mstack-bias}, GCC assumes that the stack pointer, and
4010 frame pointer if present, are offset by -2047 which must be added back
4011 when making stack frame references.
4012 Otherwise, assume no such offset is present.
4013 @end table
4015 @node Convex Options
4016 @subsection Convex Options
4017 @cindex Convex options
4019 These @samp{-m} options are defined for Convex:
4021 @table @code
4022 @item -mc1
4023 Generate output for C1.  The code will run on any Convex machine.
4024 The preprocessor symbol @code{__convex__c1__} is defined.
4026 @item -mc2
4027 Generate output for C2.  Uses instructions not available on C1.
4028 Scheduling and other optimizations are chosen for max performance on C2.
4029 The preprocessor symbol @code{__convex_c2__} is defined.
4031 @item -mc32
4032 Generate output for C32xx.  Uses instructions not available on C1.
4033 Scheduling and other optimizations are chosen for max performance on C32.
4034 The preprocessor symbol @code{__convex_c32__} is defined.
4036 @item -mc34
4037 Generate output for C34xx.  Uses instructions not available on C1.
4038 Scheduling and other optimizations are chosen for max performance on C34.
4039 The preprocessor symbol @code{__convex_c34__} is defined.
4041 @item -mc38
4042 Generate output for C38xx.  Uses instructions not available on C1.
4043 Scheduling and other optimizations are chosen for max performance on C38.
4044 The preprocessor symbol @code{__convex_c38__} is defined.
4046 @item -margcount
4047 Generate code which puts an argument count in the word preceding each
4048 argument list.  This is compatible with regular CC, and a few programs
4049 may need the argument count word.  GDB and other source-level debuggers
4050 do not need it; this info is in the symbol table.
4052 @item -mnoargcount
4053 Omit the argument count word.  This is the default.
4055 @item -mvolatile-cache
4056 Allow volatile references to be cached.  This is the default.
4058 @item -mvolatile-nocache
4059 Volatile references bypass the data cache, going all the way to memory.
4060 This is only needed for multi-processor code that does not use standard
4061 synchronization instructions.  Making non-volatile references to volatile
4062 locations will not necessarily work.
4064 @item -mlong32
4065 Type long is 32 bits, the same as type int.  This is the default.
4067 @item -mlong64
4068 Type long is 64 bits, the same as type long long.  This option is useless,
4069 because no library support exists for it.
4070 @end table
4072 @node AMD29K Options
4073 @subsection AMD29K Options
4074 @cindex AMD29K options
4076 These @samp{-m} options are defined for the AMD Am29000:
4078 @table @code
4079 @item -mdw
4080 @kindex -mdw
4081 @cindex DW bit (29k)
4082 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
4083 halfword operations are directly supported by the hardware.  This is the
4084 default.
4086 @item -mndw
4087 @kindex -mndw
4088 Generate code that assumes the @code{DW} bit is not set.
4090 @item -mbw
4091 @kindex -mbw
4092 @cindex byte writes (29k)
4093 Generate code that assumes the system supports byte and halfword write
4094 operations.  This is the default.
4096 @item -mnbw
4097 @kindex -mnbw
4098 Generate code that assumes the systems does not support byte and
4099 halfword write operations.  @samp{-mnbw} implies @samp{-mndw}.
4101 @item -msmall
4102 @kindex -msmall
4103 @cindex memory model (29k)
4104 Use a small memory model that assumes that all function addresses are
4105 either within a single 256 KB segment or at an absolute address of less
4106 than 256k.  This allows the @code{call} instruction to be used instead
4107 of a @code{const}, @code{consth}, @code{calli} sequence.
4109 @item -mnormal
4110 @kindex -mnormal
4111 Use the normal memory model: Generate @code{call} instructions only when
4112 calling functions in the same file and @code{calli} instructions
4113 otherwise.  This works if each file occupies less than 256 KB but allows
4114 the entire executable to be larger than 256 KB.  This is the default.
4116 @item -mlarge
4117 Always use @code{calli} instructions.  Specify this option if you expect
4118 a single file to compile into more than 256 KB of code.
4120 @item -m29050
4121 @kindex -m29050
4122 @cindex processor selection (29k)
4123 Generate code for the Am29050.
4125 @item -m29000
4126 @kindex -m29000
4127 Generate code for the Am29000.  This is the default.
4129 @item -mkernel-registers
4130 @kindex -mkernel-registers
4131 @cindex kernel and user registers (29k)
4132 Generate references to registers @code{gr64-gr95} instead of to
4133 registers @code{gr96-gr127}.  This option can be used when compiling
4134 kernel code that wants a set of global registers disjoint from that used
4135 by user-mode code.
4137 Note that when this option is used, register names in @samp{-f} flags
4138 must use the normal, user-mode, names.
4140 @item -muser-registers
4141 @kindex -muser-registers
4142 Use the normal set of global registers, @code{gr96-gr127}.  This is the
4143 default.
4145 @item -mstack-check
4146 @itemx -mno-stack-check
4147 @kindex -mstack-check
4148 @cindex stack checks (29k)
4149 Insert (or do not insert) a call to @code{__msp_check} after each stack
4150 adjustment.  This is often used for kernel code.
4152 @item -mstorem-bug
4153 @itemx -mno-storem-bug
4154 @kindex -mstorem-bug
4155 @cindex storem bug (29k)
4156 @samp{-mstorem-bug} handles 29k processors which cannot handle the
4157 separation of a mtsrim insn and a storem instruction (most 29000 chips
4158 to date, but not the 29050).
4160 @item -mno-reuse-arg-regs
4161 @itemx -mreuse-arg-regs
4162 @kindex -mreuse-arg-regs
4163 @samp{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
4164 registers for copying out arguments.  This helps detect calling a function
4165 with fewer arguments than it was declared with.
4167 @item -mno-impure-text
4168 @itemx -mimpure-text
4169 @kindex -mimpure-text
4170 @samp{-mimpure-text}, used in addition to @samp{-shared}, tells the compiler to
4171 not pass @samp{-assert pure-text} to the linker when linking a shared object.
4173 @item -msoft-float
4174 @kindex -msoft-float
4175 Generate output containing library calls for floating point.
4176 @strong{Warning:} the requisite libraries are not part of GCC.
4177 Normally the facilities of the machine's usual C compiler are used, but
4178 this can't be done directly in cross-compilation.  You must make your
4179 own arrangements to provide suitable library functions for
4180 cross-compilation.
4182 @item -mno-multm
4183 @kindex -mno-multm
4184 Do not generate multm or multmu instructions.  This is useful for some embedded
4185 systems which do not have trap handlers for these instructions.
4186 @end table
4188 @node ARM Options
4189 @subsection ARM Options
4190 @cindex ARM options
4192 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
4193 architectures:
4195 @table @code
4196 @item -mapcs-frame
4197 @kindex -mapcs-frame
4198 Generate a stack frame that is compliant with the ARM Procedure Call
4199 Standard for all functions, even if this is not strictly necessary for
4200 correct execution of the code.  Specifying @samp{-fomit-frame-pointer}
4201 with this option will cause the stack frames not to be generated for
4202 leaf functions.  The default is @samp{-mno-apcs-frame}.
4204 @item -mapcs
4205 @kindex -mapcs
4206 This is a synonym for @samp{-mapcs-frame}.
4208 @item -mapcs-26
4209 @kindex -mapcs-26
4210 Generate code for a processor running with a 26-bit program counter,
4211 and conforming to the function calling standards for the APCS 26-bit
4212 option.  This option replaces the @samp{-m2} and @samp{-m3} options
4213 of previous releases of the compiler.
4215 @item -mapcs-32
4216 @kindex -mapcs-32
4217 Generate code for a processor running with a 32-bit program counter,
4218 and conforming to the function calling standards for the APCS 32-bit
4219 option.  This option replaces the @samp{-m6} option of previous releases
4220 of the compiler.
4222 @item -mapcs-stack-check
4223 @kindex -mapcs-stack-check
4224 @kindex -mno-apcs-stack-check
4225 Generate code to check the amount of stack space available upon entry to
4226 every function (that actually uses some stack space).  If there is
4227 insufficient space available then either the function
4228 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
4229 called, depending upon the amount of stack space required.  The run time
4230 system is required to provide these functions.  The default is
4231 @samp{-mno-apcs-stack-check}, since this produces smaller code.
4233 @item -mapcs-float
4234 @kindex -mapcs-float
4235 @kindex -mno-apcs-float
4236 Pass floating point arguments using the float point registers.  This is
4237 one of the variants of the APCS.  This option is recommended if the
4238 target hardware has a floating point unit or if a lot of floating point
4239 arithmetic is going to be performed by the code.  The default is
4240 @samp{-mno-apcs-float}, since integer only code is slightly increased in
4241 size if @samp{-mapcs-float} is used.
4243 @item -mapcs-reentrant
4244 @kindex -mapcs-reentrant
4245 @kindex -mno-apcs-reentrant
4246 Generate reentrant, position independent code.  This is the equivalent
4247 to specifying the @samp{-fpic} option.  The default is
4248 @samp{-mno-apcs-reentrant}.
4250 @item -mthumb-interwork
4251 @kindex -mthumb-interwork
4252 @kindex -mno-thumb-interwork
4253 Generate code which supports calling between the ARM and THUMB
4254 instruction sets.  Without this option the two instruction sets cannot
4255 be reliably used inside one program.  The default is
4256 @samp{-mno-thumb-interwork}, since slightly larger code is generated
4257 when @samp{-mthumb-interwork} is specified.
4259 @item -mno-sched-prolog
4260 @kindex -mno-sched-prolog
4261 @kindex -msched-prolog
4262 Prevent the reordering of instructions in the function prolog, or the
4263 merging of those instruction with the instructions in the function's
4264 body.  This means that all functions will start with a recognizable set
4265 of instructions (or in fact one of a choice from a small set of
4266 different function prologues), and this information can be used to
4267 locate the start if functions inside an executable piece of code.  The
4268 default is @samp{-msched-prolog}.
4270 @item -mhard-float
4271 Generate output containing floating point instructions.  This is the
4272 default.
4274 @item -msoft-float
4275 Generate output containing library calls for floating point.
4276 @strong{Warning:} the requisite libraries are not available for all ARM
4277 targets.  Normally the facilities of the machine's usual C compiler are
4278 used, but this cannot be done directly in cross-compilation.  You must make
4279 your own arrangements to provide suitable library functions for
4280 cross-compilation.
4282 @samp{-msoft-float} changes the calling convention in the output file;
4283 therefore, it is only useful if you compile @emph{all} of a program with
4284 this option.  In particular, you need to compile @file{libgcc.a}, the
4285 library that comes with GCC, with @samp{-msoft-float} in order for
4286 this to work.
4288 @item -mlittle-endian
4289 Generate code for a processor running in little-endian mode.  This is
4290 the default for all standard configurations.
4292 @item -mbig-endian
4293 Generate code for a processor running in big-endian mode; the default is
4294 to compile code for a little-endian processor.
4296 @item -mwords-little-endian
4297 This option only applies when generating code for big-endian processors.
4298 Generate code for a little-endian word order but a big-endian byte
4299 order.  That is, a byte order of the form @samp{32107654}.  Note: this
4300 option should only be used if you require compatibility with code for
4301 big-endian ARM processors generated by versions of the compiler prior to
4302 2.8.
4304 @item -mshort-load-bytes
4305 @kindex -mshort-load-bytes
4306 Do not try to load half-words (eg @samp{short}s) by loading a word from
4307 an unaligned address.  For some targets the MMU is configured to trap
4308 unaligned loads; use this option to generate code that is safe in these
4309 environments.
4311 @item -mno-short-load-bytes
4312 @kindex -mno-short-load-bytes
4313 Use unaligned word loads to load half-words (eg @samp{short}s).  This
4314 option produces more efficient code, but the MMU is sometimes configured
4315 to trap these instructions.
4317 @item -mshort-load-words
4318 @kindex -mshort-load-words
4319 This is a synonym for @samp{-mno-short-load-bytes}.
4321 @item -mno-short-load-words
4322 @kindex -mno-short-load-words
4323 This is a synonym for @samp{-mshort-load-bytes}.
4325 @item -mbsd
4326 @kindex -mbsd
4327 This option only applies to RISC iX.  Emulate the native BSD-mode
4328 compiler.  This is the default if @samp{-ansi} is not specified.
4330 @item -mxopen
4331 @kindex -mxopen
4332 This option only applies to RISC iX.  Emulate the native X/Open-mode
4333 compiler.
4335 @item -mno-symrename
4336 @kindex -mno-symrename
4337 This option only applies to RISC iX.  Do not run the assembler
4338 post-processor, @samp{symrename}, after code has been assembled.
4339 Normally it is necessary to modify some of the standard symbols in
4340 preparation for linking with the RISC iX C library; this option
4341 suppresses this pass.  The post-processor is never run when the
4342 compiler is built for cross-compilation.
4344 @item -mcpu=<name>
4345 @kindex -mcpu=
4346 This specifies the name of the target ARM processor.  GCC uses this name
4347 to determine what kind of instructions it can use when generating
4348 assembly code.  Permissible names are: arm2, arm250, arm3, arm6, arm60,
4349 arm600, arm610, arm620, arm7, arm7m, arm7d, arm7dm, arm7di, arm7dmi,
4350 arm70, arm700, arm700i, arm710, arm710c, arm7100, arm7500, arm7500fe,
4351 arm7tdmi, arm8, strongarm, strongarm110, strongarm1100, arm8, arm810,
4352 arm9, arm920, arm920t, arm9tdmi.
4354 @itemx -mtune=<name>
4355 @kindex -mtune=
4356 This option is very similar to the @samp{-mcpu=} option, except that
4357 instead of specifying the actual target processor type, and hence
4358 restricting which instructions can be used, it specifies that GCC should
4359 tune the performance of the code as if the target were of the type
4360 specified in this option, but still choosing the instructions that it
4361 will generate based on the cpu specified by a @samp{-mcpu=} option.
4362 For some arm implementations better performance can be obtained by using
4363 this option.
4365 @item -march=<name>
4366 @kindex -march=
4367 This specifies the name of the target ARM architecture.  GCC uses this
4368 name to determine what kind of instructions it can use when generating
4369 assembly code.  This option can be used in conjunction with or instead
4370 of the @samp{-mcpu=} option.  Permissible names are: armv2, armv2a,
4371 armv3, armv3m, armv4, armv4t, armv5.
4373 @item -mfpe=<number>
4374 @itemx -mfp=<number>
4375 @kindex -mfpe=
4376 @kindex -mfp=
4377 This specifes the version of the floating point emulation available on
4378 the target.  Permissible values are 2 and 3.  @samp{-mfp=} is a synonym
4379 for @samp{-mfpe=} to support older versions of GCC.
4381 @item -mstructure-size-boundary=<n>
4382 @kindex -mstructure-size-boundary
4383 The size of all structures and unions will be rounded up to a multiple
4384 of the number of bits set by this option.  Permissible values are 8 and
4385 32.  The default value varies for different toolchains.  For the COFF
4386 targeted toolchain the default value is 8.  Specifying the larger number
4387 can produce faster, more efficient code, but can also increase the size
4388 of the program.  The two values are potentially incompatible.  Code
4389 compiled with one value cannot necessarily expect to work with code or
4390 libraries compiled with the other value, if they exchange information
4391 using structures or unions.  Programmers are encouraged to use the 32
4392 value as future versions of the toolchain may default to this value.
4394 @item -mabort-on-noreturn
4395 @kindex -mabort-on-noreturn
4396 @kindex -mnoabort-on-noreturn
4397 Generate a call to the function abort at the end of a noreturn function.
4398 It will be executed if the function tries to return.
4400 @item -mnop-fun-dllimport
4401 @kindex -mnop-fun-dllimport
4402 Disable the support for the @emph{dllimport} attribute.
4404 @item -msingle-pic-base
4405 @kindex -msingle-pic-base
4406 Treat the register used for PIC addressing as read-only, rather than
4407 loading it in the prologue for each function.  The run-time system is
4408 responsible for initialising this register with an appropriate value
4409 before execution begins.
4411 @item -mpic-register=<reg>
4412 @kindex -mpic-register=
4413 Specify the register to be used for PIC addressing.  The default is R10
4414 unless stack-checking is enabled, when R9 is used.
4416 @end table
4418 @node Thumb Options
4419 @subsection Thumb Options
4420 @cindex Thumb Options
4422 @table @code
4424 @item -mthumb-interwork
4425 @kindex -mthumb-interwork
4426 @kindex -mno-thumb-interwork
4427 Generate code which supports calling between the THUMB and ARM
4428 instruction sets.  Without this option the two instruction sets cannot
4429 be reliably used inside one program.  The default is
4430 @samp{-mno-thumb-interwork}, since slightly smaller code is generated
4431 with this option.
4433 @item -mtpcs-frame
4434 @kindex -mtpcs-frame
4435 @kindex -mno-tpcs-frame
4436 Generate a stack frame that is compliant with the Thumb Procedure Call
4437 Standard for all non-leaf functions.  (A leaf function is one that does
4438 not call any other functions).  The default is @samp{-mno-apcs-frame}. 
4440 @item -mtpcs-leaf-frame
4441 @kindex -mtpcs-leaf-frame
4442 @kindex -mno-tpcs-leaf-frame
4443 Generate a stack frame that is compliant with the Thumb Procedure Call
4444 Standard for all leaf functions.  (A leaf function is one that does
4445 not call any other functions).  The default is @samp{-mno-apcs-leaf-frame}. 
4447 @item -mlittle-endian
4448 @kindex -mlittle-endian
4449 Generate code for a processor running in little-endian mode.  This is
4450 the default for all standard configurations.
4452 @item -mbig-endian
4453 @kindex -mbig-endian
4454 Generate code for a processor running in big-endian mode.
4456 @item -mstructure-size-boundary=<n>
4457 @kindex -mstructure-size-boundary
4458 The size of all structures and unions will be rounded up to a multiple
4459 of the number of bits set by this option.  Permissible values are 8 and
4460 32.  The default value varies for different toolchains.  For the COFF
4461 targeted toolchain the default value is 8.  Specifying the larger number
4462 can produced faster, more efficient code, but can also increase the size
4463 of the program.  The two values are potentially incompatible.  Code
4464 compiled with one value cannot necessarily expect to work with code or
4465 libraries compiled with the other value, if they exchange information
4466 using structures or unions.  Programmers are encouraged to use the 32
4467 value as future versions of the toolchain may default to this value.
4469 @item -mnop-fun-dllimport
4470 @kindex -mnop-fun-dllimport
4471 Disable the support for the @emph{dllimport} attribute.
4473 @item -mcallee-super-interworking
4474 @kindex -mcallee-super-interworking
4475 Gives all externally visible functions in the file being compiled an ARM
4476 instruction set header which switches to Thumb mode before executing the
4477 rest of the function.  This allows these functions to be called from
4478 non-interworking code.
4480 @item -mcaller-super-interworking
4481 @kindex -mcaller-super-interworking
4482 Allows calls via function pointers (including virtual functions) to
4483 execute correctly regardless of whether the target code has been
4484 compiled for interworking or not.  There is a small overhead in the cost
4485 of executing a function pointer if this option is enabled.
4487 @item -msingle-pic-base
4488 @kindex -msingle-pic-base
4489 Treat the register used for PIC addressing as read-only, rather than
4490 loading it in the prologue for each function.  The run-time system is
4491 responsible for initialising this register with an appropriate value
4492 before execution begins.
4494 @item -mpic-register=<reg>
4495 @kindex -mpic-register=
4496 Specify the register to be used for PIC addressing.  The default is R10.
4498 @end table
4500 @node MN10200 Options
4501 @subsection MN10200 Options
4502 @cindex MN10200 options
4503 These @samp{-m} options are defined for Matsushita MN10200 architectures:
4504 @table @code
4506 @item -mrelax
4507 Indicate to the linker that it should perform a relaxation optimization pass
4508 to shorten branches, calls and absolute memory addresses.  This option only
4509 has an effect when used on the command line for the final link step.
4511 This option makes symbolic debugging impossible. 
4512 @end table
4514 @node MN10300 Options
4515 @subsection MN10300 Options
4516 @cindex MN10300 options
4517 These @samp{-m} options are defined for Matsushita MN10300 architectures:
4519 @table @code
4520 @item -mmult-bug
4521 Generate code to avoid bugs in the multiply instructions for the MN10300
4522 processors.  This is the default.
4524 @item -mno-mult-bug
4525 Do not generate code to avoid bugs in the multiply instructions for the
4526 MN10300 processors.
4528 @item -mrelax
4529 Indicate to the linker that it should perform a relaxation optimization pass
4530 to shorten branches, calls and absolute memory addresses.  This option only
4531 has an effect when used on the command line for the final link step.
4533 This option makes symbolic debugging impossible. 
4534 @end table
4537 @node M32R/D Options
4538 @subsection M32R/D Options
4539 @cindex M32R/D options
4541 These @samp{-m} options are defined for Mitsubishi M32R/D architectures:
4543 @table @code
4544 @item -mcode-model=small
4545 Assume all objects live in the lower 16MB of memory (so that their addresses
4546 can be loaded with the @code{ld24} instruction), and assume all subroutines
4547 are reachable with the @code{bl} instruction.
4548 This is the default.
4550 The addressability of a particular object can be set with the
4551 @code{model} attribute.
4553 @item -mcode-model=medium
4554 Assume objects may be anywhere in the 32 bit address space (the compiler
4555 will generate @code{seth/add3} instructions to load their addresses), and
4556 assume all subroutines are reachable with the @code{bl} instruction.
4558 @item -mcode-model=large
4559 Assume objects may be anywhere in the 32 bit address space (the compiler
4560 will generate @code{seth/add3} instructions to load their addresses), and
4561 assume subroutines may not be reachable with the @code{bl} instruction
4562 (the compiler will generate the much slower @code{seth/add3/jl}
4563 instruction sequence).
4565 @item -msdata=none
4566 Disable use of the small data area.  Variables will be put into
4567 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
4568 @code{section} attribute has been specified).
4569 This is the default.
4571 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
4572 Objects may be explicitly put in the small data area with the
4573 @code{section} attribute using one of these sections.
4575 @item -msdata=sdata
4576 Put small global and static data in the small data area, but do not
4577 generate special code to reference them.
4579 @item -msdata=use
4580 Put small global and static data in the small data area, and generate
4581 special instructions to reference them.
4583 @item -G @var{num}
4584 @cindex smaller data references
4585 Put global and static objects less than or equal to @var{num} bytes
4586 into the small data or bss sections instead of the normal data or bss
4587 sections.  The default value of @var{num} is 8.
4588 The @samp{-msdata} option must be set to one of @samp{sdata} or @samp{use}
4589 for this option to have any effect.
4591 All modules should be compiled with the same @samp{-G @var{num}} value.
4592 Compiling with different values of @var{num} may or may not work; if it
4593 doesn't the linker will give an error message - incorrect code will not be
4594 generated.
4596 @end table
4598 @node M88K Options
4599 @subsection M88K Options
4600 @cindex M88k options
4602 These @samp{-m} options are defined for Motorola 88k architectures:
4604 @table @code
4605 @item -m88000
4606 @kindex -m88000
4607 Generate code that works well on both the m88100 and the
4608 m88110.
4610 @item -m88100
4611 @kindex -m88100
4612 Generate code that works best for the m88100, but that also
4613 runs on the m88110.
4615 @item -m88110
4616 @kindex -m88110
4617 Generate code that works best for the m88110, and may not run
4618 on the m88100.
4620 @item -mbig-pic
4621 @kindex -mbig-pic
4622 Obsolete option to be removed from the next revision.
4623 Use @samp{-fPIC}.
4625 @item -midentify-revision
4626 @kindex -midentify-revision
4627 @kindex ident
4628 @cindex identifying source, compiler (88k)
4629 Include an @code{ident} directive in the assembler output recording the
4630 source file name, compiler name and version, timestamp, and compilation
4631 flags used.
4633 @item -mno-underscores
4634 @kindex -mno-underscores
4635 @cindex underscores, avoiding (88k)
4636 In assembler output, emit symbol names without adding an underscore
4637 character at the beginning of each name.  The default is to use an
4638 underscore as prefix on each name.
4640 @item -mocs-debug-info
4641 @itemx -mno-ocs-debug-info
4642 @kindex -mocs-debug-info
4643 @kindex -mno-ocs-debug-info
4644 @cindex OCS (88k)
4645 @cindex debugging, 88k OCS
4646 Include (or omit) additional debugging information (about registers used
4647 in each stack frame) as specified in the 88open Object Compatibility
4648 Standard, ``OCS''.  This extra information allows debugging of code that
4649 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
4650 Delta 88 SVr3.2 is to include this information; other 88k configurations
4651 omit this information by default.
4653 @item -mocs-frame-position
4654 @kindex -mocs-frame-position
4655 @cindex register positions in frame (88k)
4656 When emitting COFF debugging information for automatic variables and
4657 parameters stored on the stack, use the offset from the canonical frame
4658 address, which is the stack pointer (register 31) on entry to the
4659 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
4660 @samp{-mocs-frame-position}; other 88k configurations have the default
4661 @samp{-mno-ocs-frame-position}.
4663 @item -mno-ocs-frame-position
4664 @kindex -mno-ocs-frame-position
4665 @cindex register positions in frame (88k)
4666 When emitting COFF debugging information for automatic variables and
4667 parameters stored on the stack, use the offset from the frame pointer
4668 register (register 30).  When this option is in effect, the frame
4669 pointer is not eliminated when debugging information is selected by the
4670 -g switch.
4672 @item -moptimize-arg-area
4673 @itemx -mno-optimize-arg-area
4674 @kindex -moptimize-arg-area
4675 @kindex -mno-optimize-arg-area
4676 @cindex arguments in frame (88k)
4677 Control how function arguments are stored in stack frames.
4678 @samp{-moptimize-arg-area} saves space by optimizing them, but this
4679 conflicts with the 88open specifications.  The opposite alternative,
4680 @samp{-mno-optimize-arg-area}, agrees with 88open standards.  By default
4681 GCC does not optimize the argument area.
4683 @item -mshort-data-@var{num}
4684 @kindex -mshort-data-@var{num}
4685 @cindex smaller data references (88k)
4686 @cindex r0-relative references (88k)
4687 Generate smaller data references by making them relative to @code{r0},
4688 which allows loading a value using a single instruction (rather than the
4689 usual two).  You control which data references are affected by
4690 specifying @var{num} with this option.  For example, if you specify
4691 @samp{-mshort-data-512}, then the data references affected are those
4692 involving displacements of less than 512 bytes.
4693 @samp{-mshort-data-@var{num}} is not effective for @var{num} greater
4694 than 64k.
4696 @item -mserialize-volatile
4697 @kindex -mserialize-volatile
4698 @itemx -mno-serialize-volatile
4699 @kindex -mno-serialize-volatile
4700 @cindex sequential consistency on 88k
4701 Do, or don't, generate code to guarantee sequential consistency
4702 of volatile memory references.  By default, consistency is
4703 guaranteed.
4705 The order of memory references made by the MC88110 processor does
4706 not always match the order of the instructions requesting those
4707 references.  In particular, a load instruction may execute before
4708 a preceding store instruction.  Such reordering violates
4709 sequential consistency of volatile memory references, when there
4710 are multiple processors.   When consistency must be guaranteed,
4711 GNU C generates special instructions, as needed, to force
4712 execution in the proper order.
4714 The MC88100 processor does not reorder memory references and so
4715 always provides sequential consistency.  However, by default, GNU
4716 C generates the special instructions to guarantee consistency
4717 even when you use @samp{-m88100}, so that the code may be run on an
4718 MC88110 processor.  If you intend to run your code only on the
4719 MC88100 processor, you may use @samp{-mno-serialize-volatile}.
4721 The extra code generated to guarantee consistency may affect the
4722 performance of your application.  If you know that you can safely
4723 forgo this guarantee, you may use @samp{-mno-serialize-volatile}.
4725 @item -msvr4
4726 @itemx -msvr3
4727 @kindex -msvr4
4728 @kindex -msvr3
4729 @cindex assembler syntax, 88k
4730 @cindex SVr4
4731 Turn on (@samp{-msvr4}) or off (@samp{-msvr3}) compiler extensions
4732 related to System V release 4 (SVr4).  This controls the following:
4734 @enumerate
4735 @item
4736 Which variant of the assembler syntax to emit.
4737 @item
4738 @samp{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
4739 that is used on System V release 4.
4740 @item
4741 @samp{-msvr4} makes GCC issue additional declaration directives used in
4742 SVr4.
4743 @end enumerate
4745 @samp{-msvr4} is the default for the m88k-motorola-sysv4 and
4746 m88k-dg-dgux m88k configurations. @samp{-msvr3} is the default for all
4747 other m88k configurations.
4749 @item -mversion-03.00
4750 @kindex -mversion-03.00
4751 This option is obsolete, and is ignored.
4752 @c ??? which asm syntax better for GAS?  option there too?
4754 @item -mno-check-zero-division
4755 @itemx -mcheck-zero-division
4756 @kindex -mno-check-zero-division
4757 @kindex -mcheck-zero-division
4758 @cindex zero division on 88k
4759 Do, or don't, generate code to guarantee that integer division by
4760 zero will be detected.  By default, detection is guaranteed.
4762 Some models of the MC88100 processor fail to trap upon integer
4763 division by zero under certain conditions.  By default, when
4764 compiling code that might be run on such a processor, GNU C
4765 generates code that explicitly checks for zero-valued divisors
4766 and traps with exception number 503 when one is detected.  Use of
4767 mno-check-zero-division suppresses such checking for code
4768 generated to run on an MC88100 processor.
4770 GNU C assumes that the MC88110 processor correctly detects all
4771 instances of integer division by zero.  When @samp{-m88110} is
4772 specified, both @samp{-mcheck-zero-division} and
4773 @samp{-mno-check-zero-division} are ignored, and no explicit checks for
4774 zero-valued divisors are generated.
4776 @item -muse-div-instruction
4777 @kindex -muse-div-instruction
4778 @cindex divide instruction, 88k
4779 Use the div instruction for signed integer division on the
4780 MC88100 processor.  By default, the div instruction is not used.
4782 On the MC88100 processor the signed integer division instruction
4783 div) traps to the operating system on a negative operand.  The
4784 operating system transparently completes the operation, but at a
4785 large cost in execution time.  By default, when compiling code
4786 that might be run on an MC88100 processor, GNU C emulates signed
4787 integer division using the unsigned integer division instruction
4788 divu), thereby avoiding the large penalty of a trap to the
4789 operating system.  Such emulation has its own, smaller, execution
4790 cost in both time and space.  To the extent that your code's
4791 important signed integer division operations are performed on two
4792 nonnegative operands, it may be desirable to use the div
4793 instruction directly.
4795 On the MC88110 processor the div instruction (also known as the
4796 divs instruction) processes negative operands without trapping to
4797 the operating system.  When @samp{-m88110} is specified,
4798 @samp{-muse-div-instruction} is ignored, and the div instruction is used
4799 for signed integer division.
4801 Note that the result of dividing INT_MIN by -1 is undefined.  In
4802 particular, the behavior of such a division with and without
4803 @samp{-muse-div-instruction}  may differ.
4805 @item -mtrap-large-shift
4806 @itemx -mhandle-large-shift
4807 @kindex -mtrap-large-shift
4808 @kindex -mhandle-large-shift
4809 @cindex bit shift overflow (88k)
4810 @cindex large bit shifts (88k)
4811 Include code to detect bit-shifts of more than 31 bits; respectively,
4812 trap such shifts or emit code to handle them properly.  By default GCC
4813 makes no special provision for large bit shifts.
4815 @item -mwarn-passed-structs
4816 @kindex -mwarn-passed-structs
4817 @cindex structure passing (88k)
4818 Warn when a function passes a struct as an argument or result.
4819 Structure-passing conventions have changed during the evolution of the C
4820 language, and are often the source of portability problems.  By default,
4821 GCC issues no such warning.
4822 @end table
4824 @node RS/6000 and PowerPC Options
4825 @subsection IBM RS/6000 and PowerPC Options
4826 @cindex RS/6000 and PowerPC Options
4827 @cindex IBM RS/6000 and PowerPC Options
4829 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
4830 @table @code
4831 @item -mpower
4832 @itemx -mno-power
4833 @itemx -mpower2
4834 @itemx -mno-power2
4835 @itemx -mpowerpc
4836 @itemx -mno-powerpc
4837 @itemx -mpowerpc-gpopt
4838 @itemx -mno-powerpc-gpopt
4839 @itemx -mpowerpc-gfxopt
4840 @itemx -mno-powerpc-gfxopt
4841 @itemx -mpowerpc64
4842 @itemx -mno-powerpc64
4843 @kindex -mpower
4844 @kindex -mpower2
4845 @kindex -mpowerpc
4846 @kindex -mpowerpc-gpopt
4847 @kindex -mpowerpc-gfxopt
4848 @kindex -mpowerpc64
4849 GCC supports two related instruction set architectures for the
4850 RS/6000 and PowerPC.  The @dfn{POWER} instruction set are those
4851 instructions supported by the @samp{rios} chip set used in the original
4852 RS/6000 systems and the @dfn{PowerPC} instruction set is the
4853 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
4854 the IBM 4xx microprocessors.
4856 Neither architecture is a subset of the other.  However there is a
4857 large common subset of instructions supported by both.  An MQ
4858 register is included in processors supporting the POWER architecture.
4860 You use these options to specify which instructions are available on the
4861 processor you are using.  The default value of these options is
4862 determined when configuring GCC.  Specifying the
4863 @samp{-mcpu=@var{cpu_type}} overrides the specification of these
4864 options.  We recommend you use the @samp{-mcpu=@var{cpu_type}} option
4865 rather than the options listed above.
4867 The @samp{-mpower} option allows GCC to generate instructions that
4868 are found only in the POWER architecture and to use the MQ register.
4869 Specifying @samp{-mpower2} implies @samp{-power} and also allows GCC
4870 to generate instructions that are present in the POWER2 architecture but
4871 not the original POWER architecture.
4873 The @samp{-mpowerpc} option allows GCC to generate instructions that
4874 are found only in the 32-bit subset of the PowerPC architecture.
4875 Specifying @samp{-mpowerpc-gpopt} implies @samp{-mpowerpc} and also allows
4876 GCC to use the optional PowerPC architecture instructions in the
4877 General Purpose group, including floating-point square root.  Specifying
4878 @samp{-mpowerpc-gfxopt} implies @samp{-mpowerpc} and also allows GCC to
4879 use the optional PowerPC architecture instructions in the Graphics
4880 group, including floating-point select.
4882 The @samp{-mpowerpc64} option allows GCC to generate the additional
4883 64-bit instructions that are found in the full PowerPC64 architecture
4884 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
4885 @samp{-mno-powerpc64}.
4887 If you specify both @samp{-mno-power} and @samp{-mno-powerpc}, GCC
4888 will use only the instructions in the common subset of both
4889 architectures plus some special AIX common-mode calls, and will not use
4890 the MQ register.  Specifying both @samp{-mpower} and @samp{-mpowerpc}
4891 permits GCC to use any instruction from either architecture and to
4892 allow use of the MQ register; specify this for the Motorola MPC601.
4894 @item -mnew-mnemonics
4895 @itemx -mold-mnemonics
4896 @kindex -mnew-mnemonics
4897 @kindex -mold-mnemonics
4898 Select which mnemonics to use in the generated assembler code.
4899 @samp{-mnew-mnemonics} requests output that uses the assembler mnemonics
4900 defined for the PowerPC architecture, while @samp{-mold-mnemonics}
4901 requests the assembler mnemonics defined for the POWER architecture.
4902 Instructions defined in only one architecture have only one mnemonic;
4903 GCC uses that mnemonic irrespective of which of these options is
4904 specified.
4906 GCC defaults to the mnemonics appropriate for the architecture in
4907 use.  Specifying @samp{-mcpu=@var{cpu_type}} sometimes overrides the
4908 value of these option.  Unless you are building a cross-compiler, you
4909 should normally not specify either @samp{-mnew-mnemonics} or
4910 @samp{-mold-mnemonics}, but should instead accept the default.
4912 @item -mcpu=@var{cpu_type}
4913 @kindex -mcpu
4914 Set architecture type, register usage, choice of mnemonics, and
4915 instruction scheduling parameters for machine type @var{cpu_type}.
4916 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
4917 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
4918 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
4919 @samp{630}, @samp{740}, @samp{750}, @samp{power}, @samp{power2},
4920 @samp{powerpc}, @samp{403}, @samp{505}, @samp{801}, @samp{821},
4921 @samp{823}, and @samp{860} and @samp{common}.  @samp{-mcpu=power},
4922 @samp{-mcpu=power2}, @samp{-mcpu=powerpc}, and @samp{-mcpu=powerpc64}
4923 specify generic POWER, POWER2, pure 32-bit PowerPC (i.e., not MPC601),
4924 and 64-bit PowerPC architecture machine types, with an appropriate,
4925 generic processor model assumed for scheduling purposes.@refill
4927 Specifying any of the following options: 
4928 @samp{-mcpu=rios1}, @samp{-mcpu=rios2}, @samp{-mcpu=rsc},
4929 @samp{-mcpu=power}, or @samp{-mcpu=power2}  
4930 enables the @samp{-mpower} option and disables the @samp{-mpowerpc} option; 
4931 @samp{-mcpu=601} enables both the @samp{-mpower} and @samp{-mpowerpc} options.
4932 All of @samp{-mcpu=rs64a}, @samp{-mcpu=602}, @samp{-mcpu=603},
4933 @samp{-mcpu=603e}, @samp{-mcpu=604}, @samp{-mcpu=620}, @samp{-mcpu=630},
4934 @samp{-mcpu=740}, and @samp{-mcpu=750}
4935 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.  
4936 Exactly similarly, all of @samp{-mcpu=403},
4937 @samp{-mcpu=505}, @samp{-mcpu=821}, @samp{-mcpu=860} and @samp{-mcpu=powerpc} 
4938 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
4939 @samp{-mcpu=common} disables both the 
4940 @samp{-mpower} and @samp{-mpowerpc} options.@refill
4942 AIX versions 4 or greater selects @samp{-mcpu=common} by default, so
4943 that code will operate on all members of the RS/6000 POWER and PowerPC
4944 families.  In that case, GCC will use only the instructions in the
4945 common subset of both architectures plus some special AIX common-mode
4946 calls, and will not use the MQ register.  GCC assumes a generic
4947 processor model for scheduling purposes.
4949 Specifying any of the options @samp{-mcpu=rios1}, @samp{-mcpu=rios2},
4950 @samp{-mcpu=rsc}, @samp{-mcpu=power}, or @samp{-mcpu=power2} also
4951 disables the @samp{new-mnemonics} option.  Specifying @samp{-mcpu=601},
4952 @samp{-mcpu=602}, @samp{-mcpu=603}, @samp{-mcpu=603e}, @samp{-mcpu=604},
4953 @samp{-mcpu=620}, @samp{-mcpu=630}, @samp{-mcpu=403}, @samp{-mcpu=505},
4954 @samp{-mcpu=821}, @samp{-mcpu=860} or @samp{-mcpu=powerpc} also enables
4955 the @samp{new-mnemonics} option.@refill
4957 Specifying @samp{-mcpu=403}, @samp{-mcpu=821}, or @samp{-mcpu=860} also
4958 enables the @samp{-msoft-float} option.
4960 @item -mtune=@var{cpu_type}
4961 Set the instruction scheduling parameters for machine type
4962 @var{cpu_type}, but do not set the architecture type, register usage,
4963 choice of mnemonics like @samp{-mcpu=}@var{cpu_type} would.  The same
4964 values for @var{cpu_type} are used for @samp{-mtune=}@var{cpu_type} as
4965 for @samp{-mcpu=}@var{cpu_type}.  The @samp{-mtune=}@var{cpu_type}
4966 option overrides the @samp{-mcpu=}@var{cpu_type} option in terms of
4967 instruction scheduling parameters.
4969 @item -mfull-toc
4970 @itemx -mno-fp-in-toc
4971 @itemx -mno-sum-in-toc
4972 @itemx -mminimal-toc
4973 @kindex -mminimal-toc
4974 Modify generation of the TOC (Table Of Contents), which is created for
4975 every executable file.  The @samp{-mfull-toc} option is selected by
4976 default.  In that case, GCC will allocate at least one TOC entry for
4977 each unique non-automatic variable reference in your program.  GCC
4978 will also place floating-point constants in the TOC.  However, only
4979 16,384 entries are available in the TOC.
4981 If you receive a linker error message that saying you have overflowed
4982 the available TOC space, you can reduce the amount of TOC space used
4983 with the @samp{-mno-fp-in-toc} and @samp{-mno-sum-in-toc} options.
4984 @samp{-mno-fp-in-toc} prevents GCC from putting floating-point
4985 constants in the TOC and @samp{-mno-sum-in-toc} forces GCC to
4986 generate code to calculate the sum of an address and a constant at
4987 run-time instead of putting that sum into the TOC.  You may specify one
4988 or both of these options.  Each causes GCC to produce very slightly
4989 slower and larger code at the expense of conserving TOC space.
4991 If you still run out of space in the TOC even when you specify both of
4992 these options, specify @samp{-mminimal-toc} instead.  This option causes
4993 GCC to make only one TOC entry for every file.  When you specify this
4994 option, GCC will produce code that is slower and larger but which
4995 uses extremely little TOC space.  You may wish to use this option
4996 only on files that contain less frequently executed code. @refill
4998 @item -m64
4999 @itemx -m32
5000 @kindex -m64
5001 @kindex -m32
5002 Enable 64-bit PowerPC ABI and calling convention: 64-bit pointers, 64-bit
5003 @code{long} type, and the infrastructure needed to support them.
5004 Specifying @samp{-m64} implies @samp{-mpowerpc64} and
5005 @samp{-mpowerpc}, while @samp{-m32} disables the 64-bit ABI and
5006 implies @samp{-mno-powerpc64}.  GCC defaults to @samp{-m32}.
5008 @item -mxl-call
5009 @itemx -mno-xl-call
5010 @kindex -mxl-call
5011 On AIX, pass floating-point arguments to prototyped functions beyond the
5012 register save area (RSA) on the stack in addition to argument FPRs.  The
5013 AIX calling convention was extended but not initially documented to
5014 handle an obscure K&R C case of calling a function that takes the
5015 address of its arguments with fewer arguments than declared.  AIX XL
5016 compilers access floating point arguments which do not fit in the
5017 RSA from the stack when a subroutine is compiled without
5018 optimization.  Because always storing floating-point arguments on the
5019 stack is inefficient and rarely needed, this option is not enabled by
5020 default and only is necessary when calling subroutines compiled by AIX
5021 XL compilers without optimization.
5023 @item -mthreads
5024 @kindex -mthreads
5025 Support @dfn{AIX Threads}.  Link an application written to use
5026 @dfn{pthreads} with special libraries and startup code to enable the
5027 application to run.
5029 @item -mpe
5030 @kindex -mpe
5031 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE).  Link an
5032 application written to use message passing with special startup code to
5033 enable the application to run.  The system must have PE installed in the
5034 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
5035 must be overridden with the @samp{-specs=} option to specify the
5036 appropriate directory location.  The Parallel Environment does not
5037 support threads, so the @samp{-mpe} option and the @samp{-mthreads}
5038 option are incompatible.
5040 @item -msoft-float
5041 @itemx -mhard-float
5042 @kindex -msoft-float
5043 Generate code that does not use (uses) the floating-point register set.
5044 Software floating point emulation is provided if you use the
5045 @samp{-msoft-float} option, and pass the option to GCC when linking.
5047 @item -mmultiple
5048 @itemx -mno-multiple
5049 Generate code that uses (does not use) the load multiple word
5050 instructions and the store multiple word instructions.  These
5051 instructions are generated by default on POWER systems, and not
5052 generated on PowerPC systems.  Do not use @samp{-mmultiple} on little
5053 endian PowerPC systems, since those instructions do not work when the
5054 processor is in little endian mode.  The exceptions are PPC740 and
5055 PPC750 which permit the instructions usage in little endian mode.
5057 @item -mstring
5058 @itemx -mno-string
5059 @kindex -mstring
5060 Generate code that uses (does not use) the load string instructions
5061 and the store string word instructions to save multiple registers and
5062 do small block moves.  These instructions are generated by default on
5063 POWER systems, and not generated on PowerPC systems.  Do not use
5064 @samp{-mstring} on little endian PowerPC systems, since those
5065 instructions do not work when the processor is in little endian mode.
5066 The exceptions are PPC740 and PPC750 which permit the instructions
5067 usage in little endian mode.
5069 @item -mupdate
5070 @itemx -mno-update
5071 @kindex -mupdate
5072 Generate code that uses (does not use) the load or store instructions
5073 that update the base register to the address of the calculated memory
5074 location.  These instructions are generated by default.  If you use
5075 @samp{-mno-update}, there is a small window between the time that the
5076 stack pointer is updated and the address of the previous frame is
5077 stored, which means code that walks the stack frame across interrupts or
5078 signals may get corrupted data.
5080 @item -mfused-madd
5081 @itemx -mno-fused-madd
5082 @kindex -mfused-madd
5083 Generate code that uses (does not use) the floating point multiply and
5084 accumulate instructions.  These instructions are generated by default if
5085 hardware floating is used.
5087 @item -mno-bit-align
5088 @itemx -mbit-align
5089 @kindex -mbit-align
5090 On System V.4 and embedded PowerPC systems do not (do) force structures
5091 and unions that contain bit fields to be aligned to the base type of the
5092 bit field.
5094 For example, by default a structure containing nothing but 8
5095 @code{unsigned} bitfields of length 1 would be aligned to a 4 byte
5096 boundary and have a size of 4 bytes.  By using @samp{-mno-bit-align},
5097 the structure would be aligned to a 1 byte boundary and be one byte in
5098 size.
5100 @item -mno-strict-align
5101 @itemx -mstrict-align
5102 @kindex -mstrict-align
5103 On System V.4 and embedded PowerPC systems do not (do) assume that
5104 unaligned memory references will be handled by the system.
5106 @item -mrelocatable
5107 @itemx -mno-relocatable
5108 @kindex -mrelocatable
5109 On embedded PowerPC systems generate code that allows (does not allow)
5110 the program to be relocated to a different address at runtime.  If you
5111 use @samp{-mrelocatable} on any module, all objects linked together must
5112 be compiled with @samp{-mrelocatable} or @samp{-mrelocatable-lib}.
5114 @item -mrelocatable-lib
5115 @itemx -mno-relocatable-lib
5116 On embedded PowerPC systems generate code that allows (does not allow)
5117 the program to be relocated to a different address at runtime.  Modules
5118 compiled with @samp{-mrelocatable-lib} can be linked with either modules
5119 compiled without @samp{-mrelocatable} and @samp{-mrelocatable-lib} or
5120 with modules compiled with the @samp{-mrelocatable} options.
5122 @item -mno-toc
5123 @itemx -mtoc
5124 On System V.4 and embedded PowerPC systems do not (do) assume that
5125 register 2 contains a pointer to a global area pointing to the addresses
5126 used in the program.
5128 @item -mlittle
5129 @itemx -mlittle-endian
5130 On System V.4 and embedded PowerPC systems compile code for the
5131 processor in little endian mode.  The @samp{-mlittle-endian} option is
5132 the same as @samp{-mlittle}.
5134 @item -mbig
5135 @itemx -mbig-endian
5136 On System V.4 and embedded PowerPC systems compile code for the
5137 processor in big endian mode.  The @samp{-mbig-endian} option is
5138 the same as @samp{-mbig}.
5140 @item -mcall-sysv
5141 On System V.4 and embedded PowerPC systems compile code using calling
5142 conventions that adheres to the March 1995 draft of the System V
5143 Application Binary Interface, PowerPC processor supplement.  This is the
5144 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
5146 @item -mcall-sysv-eabi
5147 Specify both @samp{-mcall-sysv} and @samp{-meabi} options.
5149 @item -mcall-sysv-noeabi
5150 Specify both @samp{-mcall-sysv} and @samp{-mno-eabi} options.
5152 @item -mcall-aix
5153 On System V.4 and embedded PowerPC systems compile code using calling
5154 conventions that are similar to those used on AIX.  This is the
5155 default if you configured GCC using @samp{powerpc-*-eabiaix}.
5157 @item -mcall-solaris
5158 On System V.4 and embedded PowerPC systems compile code for the Solaris
5159 operating system.
5161 @item -mcall-linux
5162 On System V.4 and embedded PowerPC systems compile code for the
5163 Linux-based GNU system.
5165 @item -mprototype
5166 @itemx -mno-prototype
5167 On System V.4 and embedded PowerPC systems assume that all calls to
5168 variable argument functions are properly prototyped.  Otherwise, the
5169 compiler must insert an instruction before every non prototyped call to
5170 set or clear bit 6 of the condition code register (@var{CR}) to
5171 indicate whether floating point values were passed in the floating point
5172 registers in case the function takes a variable arguments.  With
5173 @samp{-mprototype}, only calls to prototyped variable argument functions
5174 will set or clear the bit.
5176 @item -msim
5177 On embedded PowerPC systems, assume that the startup module is called
5178 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
5179 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
5180 configurations.
5182 @item -mmvme
5183 On embedded PowerPC systems, assume that the startup module is called
5184 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
5185 @file{libc.a}.
5187 @item -mads
5188 On embedded PowerPC systems, assume that the startup module is called
5189 @file{crt0.o} and the standard C libraries are @file{libads.a} and
5190 @file{libc.a}.
5192 @item -myellowknife
5193 On embedded PowerPC systems, assume that the startup module is called
5194 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
5195 @file{libc.a}.
5197 @item -memb
5198 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
5199 header to indicate that @samp{eabi} extended relocations are used.
5201 @item -meabi
5202 @itemx -mno-eabi
5203 On System V.4 and embedded PowerPC systems do (do not) adhere to the
5204 Embedded Applications Binary Interface (eabi) which is a set of
5205 modifications to the System V.4 specifications.  Selecting @code{-meabi}
5206 means that the stack is aligned to an 8 byte boundary, a function
5207 @code{__eabi} is called to from @code{main} to set up the eabi
5208 environment, and the @samp{-msdata} option can use both @code{r2} and
5209 @code{r13} to point to two separate small data areas.  Selecting
5210 @code{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
5211 do not call an initialization function from @code{main}, and the
5212 @samp{-msdata} option will only use @code{r13} to point to a single
5213 small data area.  The @samp{-meabi} option is on by default if you
5214 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
5216 @item -msdata=eabi
5217 On System V.4 and embedded PowerPC systems, put small initialized
5218 @code{const} global and static data in the @samp{.sdata2} section, which
5219 is pointed to by register @code{r2}.  Put small initialized
5220 non-@code{const} global and static data in the @samp{.sdata} section,
5221 which is pointed to by register @code{r13}.  Put small uninitialized
5222 global and static data in the @samp{.sbss} section, which is adjacent to
5223 the @samp{.sdata} section.  The @samp{-msdata=eabi} option is
5224 incompatible with the @samp{-mrelocatable} option.  The
5225 @samp{-msdata=eabi} option also sets the @samp{-memb} option.
5227 @item -msdata=sysv
5228 On System V.4 and embedded PowerPC systems, put small global and static
5229 data in the @samp{.sdata} section, which is pointed to by register
5230 @code{r13}.  Put small uninitialized global and static data in the
5231 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
5232 The @samp{-msdata=sysv} option is incompatible with the
5233 @samp{-mrelocatable} option.
5235 @item -msdata=default
5236 @itemx -msdata
5237 On System V.4 and embedded PowerPC systems, if @samp{-meabi} is used,
5238 compile code the same as @samp{-msdata=eabi}, otherwise compile code the
5239 same as @samp{-msdata=sysv}.
5241 @item -msdata-data
5242 On System V.4 and embedded PowerPC systems, put small global and static
5243 data in the @samp{.sdata} section.  Put small uninitialized global and
5244 static data in the @samp{.sbss} section.  Do not use register @code{r13}
5245 to address small data however.  This is the default behavior unless
5246 other @samp{-msdata} options are used.
5248 @item -msdata=none
5249 @itemx -mno-sdata
5250 On embedded PowerPC systems, put all initialized global and static data
5251 in the @samp{.data} section, and all uninitialized data in the
5252 @samp{.bss} section.
5254 @item -G @var{num}
5255 @cindex smaller data references (PowerPC)
5256 @cindex .sdata/.sdata2 references (PowerPC)
5257 On embedded PowerPC systems, put global and static items less than or
5258 equal to @var{num} bytes into the small data or bss sections instead of
5259 the normal data or bss section.  By default, @var{num} is 8.  The
5260 @samp{-G @var{num}} switch is also passed to the linker.
5261 All modules should be compiled with the same @samp{-G @var{num}} value.
5263 @item -mregnames
5264 @itemx -mno-regnames
5265 On System V.4 and embedded PowerPC systems do (do not) emit register
5266 names in the assembly language output using symbolic forms.
5268 @end table
5270 @node RT Options
5271 @subsection IBM RT Options
5272 @cindex RT options
5273 @cindex IBM RT options
5275 These @samp{-m} options are defined for the IBM RT PC:
5277 @table @code
5278 @item -min-line-mul
5279 Use an in-line code sequence for integer multiplies.  This is the
5280 default.
5282 @item -mcall-lib-mul
5283 Call @code{lmul$$} for integer multiples.
5285 @item -mfull-fp-blocks
5286 Generate full-size floating point data blocks, including the minimum
5287 amount of scratch space recommended by IBM.  This is the default.
5289 @item -mminimum-fp-blocks
5290 Do not include extra scratch space in floating point data blocks.  This
5291 results in smaller code, but slower execution, since scratch space must
5292 be allocated dynamically.
5294 @cindex @file{varargs.h} and RT PC
5295 @cindex @file{stdarg.h} and RT PC
5296 @item -mfp-arg-in-fpregs
5297 Use a calling sequence incompatible with the IBM calling convention in
5298 which floating point arguments are passed in floating point registers.
5299 Note that @code{varargs.h} and @code{stdargs.h} will not work with
5300 floating point operands if this option is specified.
5302 @item -mfp-arg-in-gregs
5303 Use the normal calling convention for floating point arguments.  This is
5304 the default.
5306 @item -mhc-struct-return
5307 Return structures of more than one word in memory, rather than in a
5308 register.  This provides compatibility with the MetaWare HighC (hc)
5309 compiler.  Use the option @samp{-fpcc-struct-return} for compatibility
5310 with the Portable C Compiler (pcc).
5312 @item -mnohc-struct-return
5313 Return some structures of more than one word in registers, when
5314 convenient.  This is the default.  For compatibility with the
5315 IBM-supplied compilers, use the option @samp{-fpcc-struct-return} or the
5316 option @samp{-mhc-struct-return}.
5317 @end table
5319 @node MIPS Options
5320 @subsection MIPS Options
5321 @cindex MIPS options
5323 These @samp{-m} options are defined for the MIPS family of computers:
5325 @table @code
5326 @item -mcpu=@var{cpu type}
5327 Assume the defaults for the machine type @var{cpu type} when scheduling
5328 instructions.  The choices for @var{cpu type} are @samp{r2000}, @samp{r3000},
5329 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
5330 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
5331 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
5332 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
5333 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.  While picking a specific
5334 @var{cpu type} will schedule things appropriately for that particular
5335 chip, the compiler will not generate any code that does not meet level 1
5336 of the MIPS ISA (instruction set architecture) without a @samp{-mipsX}
5337 or @samp{-mabi} switch being used.
5339 @item -mips1
5340 Issue instructions from level 1 of the MIPS ISA.  This is the default.
5341 @samp{r3000} is the default @var{cpu type} at this ISA level.
5343 @item -mips2
5344 Issue instructions from level 2 of the MIPS ISA (branch likely, square
5345 root instructions).  @samp{r6000} is the default @var{cpu type} at this
5346 ISA level.
5348 @item -mips3
5349 Issue instructions from level 3 of the MIPS ISA (64 bit instructions).
5350 @samp{r4000} is the default @var{cpu type} at this ISA level.
5352 @item -mips4
5353 Issue instructions from level 4 of the MIPS ISA (conditional move,
5354 prefetch, enhanced FPU instructions).  @samp{r8000} is the default
5355 @var{cpu type} at this ISA level.
5357 @item -mfp32
5358 Assume that 32 32-bit floating point registers are available.  This is
5359 the default.
5361 @item -mfp64
5362 Assume that 32 64-bit floating point registers are available.  This is
5363 the default when the @samp{-mips3} option is used.
5365 @item -mgp32
5366 Assume that 32 32-bit general purpose registers are available.  This is
5367 the default.
5369 @item -mgp64
5370 Assume that 32 64-bit general purpose registers are available.  This is
5371 the default when the @samp{-mips3} option is used.
5373 @item -mint64
5374 Force int and long types to be 64 bits wide.  See @samp{-mlong32} for an
5375 explanation of the default, and the width of pointers.
5377 @item -mlong64
5378 Force long types to be 64 bits wide.  See @samp{-mlong32} for an
5379 explanation of the default, and the width of pointers.
5381 @item -mlong32
5382 Force long, int, and pointer types to be 32 bits wide.
5384 If none of @samp{-mlong32}, @samp{-mlong64}, or @samp{-mint64} are set,
5385 the size of ints, longs, and pointers depends on the ABI and ISA choosen.
5386 For @samp{-mabi=32}, and @samp{-mabi=n32}, ints and longs are 32 bits
5387 wide.  For @samp{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
5388 For @samp{-mabi=eabi} and either @samp{-mips1} or @samp{-mips2}, ints
5389 and longs are 32 bits wide.  For @samp{-mabi=eabi} and higher ISAs, ints
5390 are 32 bits, and longs are 64 bits wide.  The width of pointer types is
5391 the smaller of the width of longs or the width of general purpose
5392 registers (which in turn depends on the ISA).
5394 @item -mabi=32
5395 @itemx -mabi=o64
5396 @itemx -mabi=n32
5397 @itemx -mabi=64
5398 @itemx -mabi=eabi
5399 Generate code for the indicated ABI.  The default instruction level is
5400 @samp{-mips1} for @samp{32}, @samp{-mips3} for @samp{n32}, and
5401 @samp{-mips4} otherwise.  Conversely, with @samp{-mips1} or
5402 @samp{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
5403 is @samp{64}.
5405 @item -mmips-as
5406 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
5407 add normal debug information.  This is the default for all
5408 platforms except for the OSF/1 reference platform, using the OSF/rose
5409 object format.  If the either of the @samp{-gstabs} or @samp{-gstabs+}
5410 switches are used, the @file{mips-tfile} program will encapsulate the
5411 stabs within MIPS ECOFF.
5413 @item -mgas
5414 Generate code for the GNU assembler.  This is the default on the OSF/1
5415 reference platform, using the OSF/rose object format.  Also, this is
5416 the default if the configure option @samp{--with-gnu-as} is used.
5418 @item -msplit-addresses
5419 @itemx -mno-split-addresses
5420 Generate code to load the high and low parts of address constants separately.
5421 This allows @code{gcc} to optimize away redundant loads of the high order
5422 bits of addresses.  This optimization requires GNU as and GNU ld.
5423 This optimization is enabled by default for some embedded targets where
5424 GNU as and GNU ld are standard.
5426 @item -mrnames
5427 @itemx -mno-rnames
5428 The @samp{-mrnames} switch says to output code using the MIPS software
5429 names for the registers, instead of the hardware names (ie, @var{a0}
5430 instead of @var{$4}).  The only known assembler that supports this option
5431 is the Algorithmics assembler.
5433 @item -mgpopt
5434 @itemx -mno-gpopt
5435 The @samp{-mgpopt} switch says to write all of the data declarations
5436 before the instructions in the text section, this allows the MIPS
5437 assembler to generate one word memory references instead of using two
5438 words for short global or static data items.  This is on by default if
5439 optimization is selected.
5441 @item -mstats
5442 @itemx -mno-stats
5443 For each non-inline function processed, the @samp{-mstats} switch
5444 causes the compiler to emit one line to the standard error file to
5445 print statistics about the program (number of registers saved, stack
5446 size, etc.).
5448 @item -mmemcpy
5449 @itemx -mno-memcpy
5450 The @samp{-mmemcpy} switch makes all block moves call the appropriate
5451 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
5452 generating inline code.
5454 @item -mmips-tfile
5455 @itemx -mno-mips-tfile
5456 The @samp{-mno-mips-tfile} switch causes the compiler not
5457 postprocess the object file with the @file{mips-tfile} program,
5458 after the MIPS assembler has generated it to add debug support.  If
5459 @file{mips-tfile} is not run, then no local variables will be
5460 available to the debugger.  In addition, @file{stage2} and
5461 @file{stage3} objects will have the temporary file names passed to the
5462 assembler embedded in the object file, which means the objects will
5463 not compare the same.  The @samp{-mno-mips-tfile} switch should only
5464 be used when there are bugs in the @file{mips-tfile} program that
5465 prevents compilation.
5467 @item -msoft-float
5468 Generate output containing library calls for floating point.
5469 @strong{Warning:} the requisite libraries are not part of GCC.
5470 Normally the facilities of the machine's usual C compiler are used, but
5471 this can't be done directly in cross-compilation.  You must make your
5472 own arrangements to provide suitable library functions for
5473 cross-compilation.
5475 @item -mhard-float
5476 Generate output containing floating point instructions.  This is the
5477 default if you use the unmodified sources.
5479 @item -mabicalls
5480 @itemx -mno-abicalls
5481 Emit (or do not emit) the pseudo operations @samp{.abicalls},
5482 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
5483 position independent code.
5485 @item -mlong-calls
5486 @itemx -mno-long-calls
5487 Do all calls with the @samp{JALR} instruction, which requires
5488 loading up a function's address into a register before the call.
5489 You need to use this switch, if you call outside of the current
5490 512 megabyte segment to functions that are not through pointers.
5492 @item -mhalf-pic
5493 @itemx -mno-half-pic
5494 Put pointers to extern references into the data section and load them
5495 up, rather than put the references in the text section.
5497 @item -membedded-pic
5498 @itemx -mno-embedded-pic
5499 Generate PIC code suitable for some embedded systems.  All calls are
5500 made using PC relative address, and all data is addressed using the $gp
5501 register.  No more than 65536 bytes of global data may be used.  This
5502 requires GNU as and GNU ld which do most of the work.  This currently
5503 only works on targets which use ECOFF; it does not work with ELF.
5505 @item -membedded-data
5506 @itemx -mno-embedded-data
5507 Allocate variables to the read-only data section first if possible, then
5508 next in the small data section if possible, otherwise in data.  This gives
5509 slightly slower code than the default, but reduces the amount of RAM required
5510 when executing, and thus may be preferred for some embedded systems.
5512 @item -msingle-float
5513 @itemx -mdouble-float
5514 The @samp{-msingle-float} switch tells gcc to assume that the floating
5515 point coprocessor only supports single precision operations, as on the
5516 @samp{r4650} chip.  The @samp{-mdouble-float} switch permits gcc to use
5517 double precision operations.  This is the default.
5519 @item -mmad
5520 @itemx -mno-mad
5521 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
5522 as on the @samp{r4650} chip.
5524 @item -m4650
5525 Turns on @samp{-msingle-float}, @samp{-mmad}, and, at least for now,
5526 @samp{-mcpu=r4650}.
5528 @item -mips16
5529 @itemx -mno-mips16
5530 Enable 16-bit instructions.
5532 @item -mentry
5533 Use the entry and exit pseudo ops.  This option can only be used with
5534 @samp{-mips16}.
5536 @item -EL
5537 Compile code for the processor in little endian mode.
5538 The requisite libraries are assumed to exist.
5540 @item -EB
5541 Compile code for the processor in big endian mode.
5542 The requisite libraries are assumed to exist.
5544 @item -G @var{num}
5545 @cindex smaller data references (MIPS)
5546 @cindex gp-relative references (MIPS)
5547 Put global and static items less than or equal to @var{num} bytes into
5548 the small data or bss sections instead of the normal data or bss
5549 section.  This allows the assembler to emit one word memory reference
5550 instructions based on the global pointer (@var{gp} or @var{$28}),
5551 instead of the normal two words used.  By default, @var{num} is 8 when
5552 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
5553 @samp{-G @var{num}} switch is also passed to the assembler and linker.
5554 All modules should be compiled with the same @samp{-G @var{num}}
5555 value.
5557 @item -nocpp
5558 Tell the MIPS assembler to not run its preprocessor over user
5559 assembler files (with a @samp{.s} suffix) when assembling them.
5560 @end table
5562 @ifset INTERNALS
5563 These options are defined by the macro
5564 @code{TARGET_SWITCHES} in the machine description.  The default for the
5565 options is also defined by that macro, which enables you to change the
5566 defaults.
5567 @end ifset
5569 @node i386 Options
5570 @subsection Intel 386 Options
5571 @cindex i386 Options
5572 @cindex Intel 386 Options
5574 These @samp{-m} options are defined for the i386 family of computers:
5576 @table @code
5577 @item -mcpu=@var{cpu type}
5578 Assume the defaults for the machine type @var{cpu type} when scheduling
5579 instructions.  The choices for @var{cpu type} are:
5581 @multitable @columnfractions .20 .20 .20 .20
5582 @item @samp{i386} @tab @samp{i486} @tab @samp{i586} @tab @samp{i686}
5583 @item @samp{pentium} @tab @samp{pentiumpro} @tab @samp{k6}
5584 @end multitable
5586 While picking a specific @var{cpu type} will schedule things appropriately
5587 for that particular chip, the compiler will not generate any code that
5588 does not run on the i386 without the @samp{-march=@var{cpu type}} option
5589 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
5590 is equivalent to @samp{pentiumpro}.  @samp{k6} is the AMD chip as
5591 opposed to the Intel ones.
5593 @item -march=@var{cpu type}
5594 Generate instructions for the machine type @var{cpu type}.  The choices
5595 for @var{cpu type} are the same as for @samp{-mcpu}.  Moreover, 
5596 specifying @samp{-march=@var{cpu type}} implies @samp{-mcpu=@var{cpu type}}.
5598 @item -m386
5599 @itemx -m486
5600 @itemx -mpentium
5601 @itemx -mpentiumpro
5602 Synonyms for -mcpu=i386, -mcpu=i486, -mcpu=pentium, and -mcpu=pentiumpro
5603 respectively.  These synonyms are deprecated.
5605 @item -mieee-fp
5606 @itemx -mno-ieee-fp
5607 Control whether or not the compiler uses IEEE floating point
5608 comparisons.  These handle correctly the case where the result of a
5609 comparison is unordered.
5611 @item -msoft-float
5612 Generate output containing library calls for floating point.
5613 @strong{Warning:} the requisite libraries are not part of GCC.
5614 Normally the facilities of the machine's usual C compiler are used, but
5615 this can't be done directly in cross-compilation.  You must make your
5616 own arrangements to provide suitable library functions for
5617 cross-compilation.
5619 On machines where a function returns floating point results in the 80387
5620 register stack, some floating point opcodes may be emitted even if
5621 @samp{-msoft-float} is used.
5623 @item -mno-fp-ret-in-387
5624 Do not use the FPU registers for return values of functions.
5626 The usual calling convention has functions return values of types
5627 @code{float} and @code{double} in an FPU register, even if there
5628 is no FPU.  The idea is that the operating system should emulate
5629 an FPU.
5631 The option @samp{-mno-fp-ret-in-387} causes such values to be returned
5632 in ordinary CPU registers instead.
5634 @item -mno-fancy-math-387
5635 Some 387 emulators do not support the @code{sin}, @code{cos} and
5636 @code{sqrt} instructions for the 387.  Specify this option to avoid
5637 generating those instructions. This option is the default on FreeBSD.
5638 As of revision 2.6.1, these instructions are not generated unless you
5639 also use the @samp{-ffast-math} switch.
5641 @item -malign-double
5642 @itemx -mno-align-double
5643 Control whether GCC aligns @code{double}, @code{long double}, and
5644 @code{long long} variables on a two word boundary or a one word
5645 boundary.  Aligning @code{double} variables on a two word boundary will
5646 produce code that runs somewhat faster on a @samp{Pentium} at the
5647 expense of more memory.
5649 @strong{Warning:} if you use the @samp{-malign-double} switch,
5650 structures containing the above types will be aligned differently than
5651 the published application binary interface specifications for the 386.
5653 @item -msvr3-shlib
5654 @itemx -mno-svr3-shlib
5655 Control whether GCC places uninitialized locals into @code{bss} or
5656 @code{data}.  @samp{-msvr3-shlib} places these locals into @code{bss}.
5657 These options are meaningful only on System V Release 3.
5659 @item -mno-wide-multiply
5660 @itemx -mwide-multiply
5661 Control whether GCC uses the @code{mul} and @code{imul} that produce
5662 64 bit results in @code{eax:edx} from 32 bit operands to do @code{long
5663 long} multiplies and 32-bit division by constants.
5665 @item -mrtd
5666 Use a different function-calling convention, in which functions that
5667 take a fixed number of arguments return with the @code{ret} @var{num}
5668 instruction, which pops their arguments while returning.  This saves one
5669 instruction in the caller since there is no need to pop the arguments
5670 there.
5672 You can specify that an individual function is called with this calling
5673 sequence with the function attribute @samp{stdcall}.  You can also
5674 override the @samp{-mrtd} option by using the function attribute
5675 @samp{cdecl}.  @xref{Function Attributes}.
5677 @strong{Warning:} this calling convention is incompatible with the one
5678 normally used on Unix, so you cannot use it if you need to call
5679 libraries compiled with the Unix compiler.
5681 Also, you must provide function prototypes for all functions that
5682 take variable numbers of arguments (including @code{printf});
5683 otherwise incorrect code will be generated for calls to those
5684 functions.
5686 In addition, seriously incorrect code will result if you call a
5687 function with too many arguments.  (Normally, extra arguments are
5688 harmlessly ignored.)
5690 @item -mreg-alloc=@var{regs}
5691 Control the default allocation order of integer registers.  The
5692 string @var{regs} is a series of letters specifying a register.  The
5693 supported letters are: @code{a} allocate EAX; @code{b} allocate EBX;
5694 @code{c} allocate ECX; @code{d} allocate EDX; @code{S} allocate ESI;
5695 @code{D} allocate EDI; @code{B} allocate EBP.
5697 @item -mregparm=@var{num}
5698 Control how many registers are used to pass integer arguments.  By
5699 default, no registers are used to pass arguments, and at most 3
5700 registers can be used.  You can control this behavior for a specific
5701 function by using the function attribute @samp{regparm}.
5702 @xref{Function Attributes}.
5704 @strong{Warning:} if you use this switch, and
5705 @var{num} is nonzero, then you must build all modules with the same
5706 value, including any libraries.  This includes the system libraries and
5707 startup modules.
5709 @item -malign-loops=@var{num}
5710 Align loops to a 2 raised to a @var{num} byte boundary.  If
5711 @samp{-malign-loops} is not specified, the default is 2 unless
5712 gas 2.8 (or later) is being used in which case the default is
5713 to align the loop on a 16 byte boundary if it is less than 8
5714 bytes away.
5716 @item -malign-jumps=@var{num}
5717 Align instructions that are only jumped to to a 2 raised to a @var{num}
5718 byte boundary.  If @samp{-malign-jumps} is not specified, the default is
5719 2 if optimizing for a 386, and 4 if optimizing for a 486 unless
5720 gas 2.8 (or later) is being used in which case the default is
5721 to align the instruction on a 16 byte boundary if it is less
5722 than 8 bytes away.
5724 @item -malign-functions=@var{num}
5725 Align the start of functions to a 2 raised to @var{num} byte boundary.
5726 If @samp{-malign-functions} is not specified, the default is 2 if optimizing
5727 for a 386, and 4 if optimizing for a 486.
5729 @item -mpreferred-stack-boundary=@var{num}
5730 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
5731 byte boundary.  If @samp{-mpreferred-stack-boundary} is not specified,
5732 the default is 4 (16 bytes or 128 bits).
5734 The stack is required to be aligned on a 4 byte boundary.  On Pentium
5735 and PentiumPro, @code{double} and @code{long double} values should be
5736 aligned to an 8 byte boundary (see @samp{-malign-double}) or suffer
5737 significant run time performance penalties.  On Pentium III, the
5738 Streaming SIMD Extention (SSE) data type @code{__m128} suffers similar
5739 penalties if it is not 16 byte aligned.
5741 To ensure proper alignment of this values on the stack, the stack boundary
5742 must be as aligned as that required by any value stored on the stack. 
5743 Further, every function must be generated such that it keeps the stack
5744 aligned.  Thus calling a function compiled with a higher preferred
5745 stack boundary from a function compiled with a lower preferred stack
5746 boundary will most likely misalign the stack.  It is recommended that
5747 libraries that use callbacks always use the default setting.
5749 This extra alignment does consume extra stack space.  Code that is sensitive
5750 to stack space usage, such as embedded systems and operating system kernels,
5751 may want to reduce the preferred alignment to
5752 @samp{-mpreferred-stack-boundary=2}.
5753 @end table
5755 @node HPPA Options
5756 @subsection HPPA Options
5757 @cindex HPPA Options
5759 These @samp{-m} options are defined for the HPPA family of computers:
5761 @table @code
5762 @item -march=@var{architecture type}
5763 Generate code for the specified architecture.  The choices for
5764 @var{architecture type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
5765 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
5766 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
5767 architecture option for your machine.  Code compiled for lower numbered
5768 architectures will run on higher numbered architectures, but not the
5769 other way around.
5771 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
5772 next release of binutils (current is 2.9.1) will probably contain PA 2.0
5773 support.  
5775 @item -mpa-risc-1-0
5776 @itemx -mpa-risc-1-1
5777 @itemx -mpa-risc-2-0
5778 Synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively.
5780 @item -mbig-switch
5781 Generate code suitable for big switch tables.  Use this option only if
5782 the assembler/linker complain about out of range branches within a switch
5783 table.
5785 @item -mjump-in-delay
5786 Fill delay slots of function calls with unconditional jump instructions
5787 by modifying the return pointer for the function call to be the target
5788 of the conditional jump.
5790 @item -mdisable-fpregs
5791 Prevent floating point registers from being used in any manner.  This is
5792 necessary for compiling kernels which perform lazy context switching of
5793 floating point registers.  If you use this option and attempt to perform
5794 floating point operations, the compiler will abort.
5796 @item -mdisable-indexing
5797 Prevent the compiler from using indexing address modes.  This avoids some
5798 rather obscure problems when compiling MIG generated code under MACH.
5800 @item -mno-space-regs
5801 Generate code that assumes the target has no space registers.  This allows
5802 GCC to generate faster indirect calls and use unscaled index address modes.
5804 Such code is suitable for level 0 PA systems and kernels.
5806 @item -mfast-indirect-calls
5807 Generate code that assumes calls never cross space boundaries.  This
5808 allows GCC to emit code which performs faster indirect calls.
5810 This option will not work in the presense of shared libraries or nested
5811 functions.
5813 @item -mlong-load-store
5814 Generate 3-instruction load and store sequences as sometimes required by
5815 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
5816 the HP compilers.
5818 @item -mportable-runtime
5819 Use the portable calling conventions proposed by HP for ELF systems.
5821 @item -mgas
5822 Enable the use of assembler directives only GAS understands.
5824 @item -mschedule=@var{cpu type}
5825 Schedule code according to the constraints for the machine type
5826 @var{cpu type}.  The choices for @var{cpu type} are @samp{700} 
5827 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}.  Refer to 
5828 @file{/usr/lib/sched.models} on an HP-UX system to determine the
5829 proper scheduling option for your machine.
5831 @item -mlinker-opt
5832 Enable the optimization pass in the HPUX linker.  Note this makes symbolic
5833 debugging impossible.  It also triggers a bug in the HPUX 8 and HPUX 9 linkers
5834 in which they give bogus error messages when linking some programs.
5836 @item -msoft-float
5837 Generate output containing library calls for floating point.
5838 @strong{Warning:} the requisite libraries are not available for all HPPA
5839 targets.  Normally the facilities of the machine's usual C compiler are
5840 used, but this cannot be done directly in cross-compilation.  You must make
5841 your own arrangements to provide suitable library functions for
5842 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
5843 does provide software floating point support.
5845 @samp{-msoft-float} changes the calling convention in the output file;
5846 therefore, it is only useful if you compile @emph{all} of a program with
5847 this option.  In particular, you need to compile @file{libgcc.a}, the
5848 library that comes with GCC, with @samp{-msoft-float} in order for
5849 this to work.
5850 @end table
5852 @node Intel 960 Options
5853 @subsection Intel 960 Options
5855 These @samp{-m} options are defined for the Intel 960 implementations:
5857 @table @code
5858 @item -m@var{cpu type}
5859 Assume the defaults for the machine type @var{cpu type} for some of
5860 the other options, including instruction scheduling, floating point
5861 support, and addressing modes.  The choices for @var{cpu type} are
5862 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
5863 @samp{sa}, and @samp{sb}.
5864 The default is
5865 @samp{kb}.
5867 @item -mnumerics
5868 @itemx -msoft-float
5869 The @samp{-mnumerics} option indicates that the processor does support
5870 floating-point instructions.  The @samp{-msoft-float} option indicates
5871 that floating-point support should not be assumed.
5873 @item -mleaf-procedures
5874 @itemx -mno-leaf-procedures
5875 Do (or do not) attempt to alter leaf procedures to be callable with the
5876 @code{bal} instruction as well as @code{call}.  This will result in more
5877 efficient code for explicit calls when the @code{bal} instruction can be
5878 substituted by the assembler or linker, but less efficient code in other
5879 cases, such as calls via function pointers, or using a linker that doesn't
5880 support this optimization.
5882 @item -mtail-call
5883 @itemx -mno-tail-call
5884 Do (or do not) make additional attempts (beyond those of the
5885 machine-independent portions of the compiler) to optimize tail-recursive
5886 calls into branches.  You may not want to do this because the detection of
5887 cases where this is not valid is not totally complete.  The default is
5888 @samp{-mno-tail-call}.
5890 @item -mcomplex-addr
5891 @itemx -mno-complex-addr
5892 Assume (or do not assume) that the use of a complex addressing mode is a
5893 win on this implementation of the i960.  Complex addressing modes may not
5894 be worthwhile on the K-series, but they definitely are on the C-series.
5895 The default is currently @samp{-mcomplex-addr} for all processors except
5896 the CB and CC.
5898 @item -mcode-align
5899 @itemx -mno-code-align
5900 Align code to 8-byte boundaries for faster fetching (or don't bother).
5901 Currently turned on by default for C-series implementations only.
5903 @ignore
5904 @item -mclean-linkage
5905 @itemx -mno-clean-linkage
5906 These options are not fully implemented.
5907 @end ignore
5909 @item -mic-compat
5910 @itemx -mic2.0-compat
5911 @itemx -mic3.0-compat
5912 Enable compatibility with iC960 v2.0 or v3.0.
5914 @item -masm-compat
5915 @itemx -mintel-asm
5916 Enable compatibility with the iC960 assembler.
5918 @item -mstrict-align
5919 @itemx -mno-strict-align
5920 Do not permit (do permit) unaligned accesses.
5922 @item -mold-align
5923 Enable structure-alignment compatibility with Intel's gcc release version
5924 1.3 (based on gcc 1.37).  This option implies @samp{-mstrict-align}.
5926 @item -mlong-double-64
5927 Implement type @samp{long double} as 64-bit floating point numbers.
5928 Without the option @samp{long double} is implemented by 80-bit
5929 floating point numbers.  The only reason we have it because there is
5930 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
5931 is only useful for people using soft-float targets.  Otherwise, we
5932 should recommend against use of it.
5934 @end table
5936 @node DEC Alpha Options
5937 @subsection DEC Alpha Options
5939 These @samp{-m} options are defined for the DEC Alpha implementations:
5941 @table @code
5942 @item -mno-soft-float
5943 @itemx -msoft-float
5944 Use (do not use) the hardware floating-point instructions for
5945 floating-point operations.  When @code{-msoft-float} is specified,
5946 functions in @file{libgcc1.c} will be used to perform floating-point
5947 operations.  Unless they are replaced by routines that emulate the
5948 floating-point operations, or compiled in such a way as to call such
5949 emulations routines, these routines will issue floating-point
5950 operations.   If you are compiling for an Alpha without floating-point
5951 operations, you must ensure that the library is built so as not to call
5952 them.
5954 Note that Alpha implementations without floating-point operations are
5955 required to have floating-point registers.
5957 @item -mfp-reg
5958 @itemx -mno-fp-regs
5959 Generate code that uses (does not use) the floating-point register set.
5960 @code{-mno-fp-regs} implies @code{-msoft-float}.  If the floating-point
5961 register set is not used, floating point operands are passed in integer
5962 registers as if they were integers and floating-point results are passed
5963 in $0 instead of $f0.  This is a non-standard calling sequence, so any
5964 function with a floating-point argument or return value called by code
5965 compiled with @code{-mno-fp-regs} must also be compiled with that
5966 option.
5968 A typical use of this option is building a kernel that does not use,
5969 and hence need not save and restore, any floating-point registers.
5971 @item -mieee
5972 The Alpha architecture implements floating-point hardware optimized for
5973 maximum performance.  It is mostly compliant with the IEEE floating
5974 point standard.  However, for full compliance, software assistance is
5975 required.  This option generates code fully IEEE compliant code
5976 @emph{except} that the @var{inexact flag} is not maintained (see below).
5977 If this option is turned on, the CPP macro @code{_IEEE_FP} is defined
5978 during compilation.  The option is a shorthand for: @samp{-D_IEEE_FP
5979 -mfp-trap-mode=su -mtrap-precision=i -mieee-conformant}.  The resulting
5980 code is less efficient but is able to correctly support denormalized
5981 numbers and exceptional IEEE values such as not-a-number and plus/minus
5982 infinity.  Other Alpha compilers call this option
5983 @code{-ieee_with_no_inexact}.
5985 @item -mieee-with-inexact
5986 @c overfull hbox here --bob 22 jul96
5987 @c original text between ignore ... end ignore
5988 @ignore
5989 This is like @samp{-mieee} except the generated code also maintains the
5990 IEEE @var{inexact flag}.  Turning on this option causes the generated
5991 code to implement fully-compliant IEEE math.  The option is a shorthand
5992 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus @samp{-mieee-conformant},
5993 @samp{-mfp-trap-mode=sui}, and @samp{-mtrap-precision=i}.  On some Alpha
5994 implementations the resulting code may execute significantly slower than
5995 the code generated by default.  Since there is very little code that
5996 depends on the @var{inexact flag}, you should normally not specify this
5997 option.  Other Alpha compilers call this option
5998 @samp{-ieee_with_inexact}.
5999 @end ignore
6000 @c            changed paragraph
6001 This is like @samp{-mieee} except the generated code also maintains the
6002 IEEE @var{inexact flag}.  Turning on this option causes the generated
6003 code to implement fully-compliant IEEE math.  The option is a shorthand
6004 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus the three following:
6005 @samp{-mieee-conformant},
6006 @samp{-mfp-trap-mode=sui}, 
6007 and @samp{-mtrap-precision=i}.  
6008 On some Alpha implementations the resulting code may execute
6009 significantly slower than the code generated by default.  Since there
6010 is very little code that depends on the @var{inexact flag}, you should
6011 normally not specify this option.  Other Alpha compilers call this
6012 option @samp{-ieee_with_inexact}.
6013 @c             end changes to prevent overfull hboxes
6015 @item -mfp-trap-mode=@var{trap mode}
6016 This option controls what floating-point related traps are enabled.
6017 Other Alpha compilers call this option @samp{-fptm }@var{trap mode}.
6018 The trap mode can be set to one of four values:
6020 @table @samp
6021 @item n
6022 This is the default (normal) setting.  The only traps that are enabled
6023 are the ones that cannot be disabled in software (e.g., division by zero
6024 trap).
6026 @item u
6027 In addition to the traps enabled by @samp{n}, underflow traps are enabled
6028 as well.
6030 @item su
6031 Like @samp{su}, but the instructions are marked to be safe for software
6032 completion (see Alpha architecture manual for details).
6034 @item sui
6035 Like @samp{su}, but inexact traps are enabled as well.
6036 @end table
6038 @item -mfp-rounding-mode=@var{rounding mode}
6039 Selects the IEEE rounding mode.  Other Alpha compilers call this option
6040 @samp{-fprm }@var{rounding mode}.  The @var{rounding mode} can be one
6043 @table @samp
6044 @item n
6045 Normal IEEE rounding mode.  Floating point numbers are rounded towards
6046 the nearest machine number or towards the even machine number in case
6047 of a tie.
6049 @item m
6050 Round towards minus infinity.
6052 @item c
6053 Chopped rounding mode.  Floating point numbers are rounded towards zero.
6055 @item d
6056 Dynamic rounding mode.  A field in the floating point control register
6057 (@var{fpcr}, see Alpha architecture reference manual) controls the
6058 rounding mode in effect.  The C library initializes this register for
6059 rounding towards plus infinity.  Thus, unless your program modifies the
6060 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
6061 @end table
6063 @item -mtrap-precision=@var{trap precision}
6064 In the Alpha architecture, floating point traps are imprecise.  This
6065 means without software assistance it is impossible to recover from a
6066 floating trap and program execution normally needs to be terminated.
6067 GCC can generate code that can assist operating system trap handlers
6068 in determining the exact location that caused a floating point trap.
6069 Depending on the requirements of an application, different levels of
6070 precisions can be selected:
6072 @table @samp
6073 @item p
6074 Program precision.  This option is the default and means a trap handler
6075 can only identify which program caused a floating point exception.
6077 @item f
6078 Function precision.  The trap handler can determine the function that
6079 caused a floating point exception.
6081 @item i
6082 Instruction precision.  The trap handler can determine the exact
6083 instruction that caused a floating point exception.
6084 @end table
6086 Other Alpha compilers provide the equivalent options called
6087 @samp{-scope_safe} and @samp{-resumption_safe}.
6089 @item -mieee-conformant
6090 This option marks the generated code as IEEE conformant.  You must not
6091 use this option unless you also specify @samp{-mtrap-precision=i} and either
6092 @samp{-mfp-trap-mode=su} or @samp{-mfp-trap-mode=sui}.  Its only effect
6093 is to emit the line @samp{.eflag 48} in the function prologue of the
6094 generated assembly file.  Under DEC Unix, this has the effect that
6095 IEEE-conformant math library routines will be linked in.
6097 @item -mbuild-constants
6098 Normally GCC examines a 32- or 64-bit integer constant to
6099 see if it can construct it from smaller constants in two or three
6100 instructions.  If it cannot, it will output the constant as a literal and
6101 generate code to load it from the data segment at runtime.
6103 Use this option to require GCC to construct @emph{all} integer constants
6104 using code, even if it takes more instructions (the maximum is six).
6106 You would typically use this option to build a shared library dynamic
6107 loader.  Itself a shared library, it must relocate itself in memory
6108 before it can find the variables and constants in its own data segment.
6110 @item -malpha-as
6111 @itemx -mgas
6112 Select whether to generate code to be assembled by the vendor-supplied
6113 assembler (@samp{-malpha-as}) or by the GNU assembler @samp{-mgas}.
6115 @item -mbwx
6116 @itemx -mno-bwx
6117 @itemx -mcix
6118 @itemx -mno-cix
6119 @itemx -mmax
6120 @itemx -mno-max
6121 Indicate whether GCC should generate code to use the optional BWX,
6122 CIX, and MAX instruction sets.  The default is to use the instruction sets
6123 supported by the CPU type specified via @samp{-mcpu=} option or that
6124 of the CPU on which GCC was built if none was specified.
6126 @item -mcpu=@var{cpu_type}
6127 Set the instruction set, register set, and instruction scheduling
6128 parameters for machine type @var{cpu_type}.  You can specify either the
6129 @samp{EV} style name or the corresponding chip number.  GCC
6130 supports scheduling parameters for the EV4 and EV5 family of processors
6131 and will choose the default values for the instruction set from
6132 the processor you specify.  If you do not specify a processor type,
6133 GCC will default to the processor on which the compiler was built.
6135 Supported values for @var{cpu_type} are
6137 @table @samp
6138 @item ev4
6139 @itemx 21064
6140 Schedules as an EV4 and has no instruction set extensions.
6142 @item ev5
6143 @itemx 21164
6144 Schedules as an EV5 and has no instruction set extensions.
6146 @item ev56
6147 @itemx 21164a
6148 Schedules as an EV5 and supports the BWX extension.
6150 @item pca56
6151 @itemx 21164pc
6152 @itemx 21164PC
6153 Schedules as an EV5 and supports the BWX and MAX extensions.
6155 @item ev6
6156 @itemx 21264
6157 Schedules as an EV5 (until Digital releases the scheduling parameters
6158 for the EV6) and supports the BWX, CIX, and MAX extensions.
6159 @end table
6161 @item -mmemory-latency=@var{time}
6162 Sets the latency the scheduler should assume for typical memory
6163 references as seen by the application.  This number is highly
6164 dependant on the memory access patterns used by the application
6165 and the size of the external cache on the machine.
6167 Valid options for @var{time} are
6169 @table @samp
6170 @item @var{number}
6171 A decimal number representing clock cycles.
6173 @item L1
6174 @itemx L2
6175 @itemx L3
6176 @itemx main
6177 The compiler contains estimates of the number of clock cycles for
6178 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
6179 (also called Dcache, Scache, and Bcache), as well as to main memory.
6180 Note that L3 is only valid for EV5.
6182 @end table
6183 @end table
6185 @node Clipper Options
6186 @subsection Clipper Options
6188 These @samp{-m} options are defined for the Clipper implementations:
6190 @table @code
6191 @item -mc300
6192 Produce code for a C300 Clipper processor. This is the default.
6194 @item -mc400
6195 Produce code for a C400 Clipper processor i.e. use floating point
6196 registers f8..f15.
6197 @end table
6199 @node H8/300 Options
6200 @subsection H8/300 Options
6202 These @samp{-m} options are defined for the H8/300 implementations:
6204 @table @code
6205 @item -mrelax
6206 Shorten some address references at link time, when possible; uses the
6207 linker option @samp{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
6208 ld.info, Using ld}, for a fuller description.
6210 @item -mh
6211 Generate code for the H8/300H.
6213 @item -ms
6214 Generate code for the H8/S.
6216 @item -mint32
6217 Make @code{int} data 32 bits by default.
6219 @item -malign-300
6220 On the h8/300h, use the same alignment rules as for the h8/300.
6221 The default for the h8/300h is to align longs and floats on 4 byte boundaries.
6222 @samp{-malign-300} causes them to be aligned on 2 byte boundaries.
6223 This option has no effect on the h8/300.
6224 @end table
6226 @node SH Options
6227 @subsection SH Options
6229 These @samp{-m} options are defined for the SH implementations:
6231 @table @code
6232 @item -m1
6233 Generate code for the SH1.
6235 @item -m2
6236 Generate code for the SH2.
6238 @item -m3
6239 Generate code for the SH3.
6241 @item -m3e
6242 Generate code for the SH3e.
6244 @item -mb
6245 Compile code for the processor in big endian mode.
6247 @item -ml
6248 Compile code for the processor in little endian mode.
6250 @item -mdalign
6251 Align doubles at 64 bit boundaries.  Note that this changes the calling
6252 conventions, and thus some functions from the standard C library will
6253 not work unless you recompile it first with -mdalign.
6255 @item -mrelax
6256 Shorten some address references at link time, when possible; uses the
6257 linker option @samp{-relax}.
6258 @end table
6260 @node System V Options
6261 @subsection Options for System V
6263 These additional options are available on System V Release 4 for
6264 compatibility with other compilers on those systems:
6266 @table @code
6267 @item -G
6268 Create a shared object.
6269 It is recommended that @samp{-symbolic} or @samp{-shared} be used instead.
6271 @item -Qy
6272 Identify the versions of each tool used by the compiler, in a
6273 @code{.ident} assembler directive in the output.
6275 @item -Qn
6276 Refrain from adding @code{.ident} directives to the output file (this is
6277 the default).
6279 @item -YP,@var{dirs}
6280 Search the directories @var{dirs}, and no others, for libraries
6281 specified with @samp{-l}.
6283 @item -Ym,@var{dir}
6284 Look in the directory @var{dir} to find the M4 preprocessor.
6285 The assembler uses this option.
6286 @c This is supposed to go with a -Yd for predefined M4 macro files, but
6287 @c the generic assembler that comes with Solaris takes just -Ym.
6288 @end table
6290 @node TMS320C3x/C4x Options
6291 @subsection TMS320C3x/C4x Options
6292 @cindex TMS320C3x/C4x Options
6294 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
6296 @table @code
6298 @item -mcpu=@var{cpu_type}
6299 Set the instruction set, register set, and instruction scheduling
6300 parameters for machine type @var{cpu_type}.  Supported values for
6301 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
6302 @samp{c44}.  The default is @samp{c40} to generate code for the
6303 TMS320C40.
6305 @item -mbig-memory
6306 @item -mbig
6307 @itemx -msmall-memory
6308 @itemx -msmall
6309 Generates code for the big or small memory model.  The small memory
6310 model assumed that all data fits into one 64K word page.  At run-time
6311 the data page (DP) register must be set to point to the 64K page
6312 containing the .bss and .data program sections.  The big memory model is
6313 the default and requires reloading of the DP register for every direct
6314 memory access.
6316 @item -mbk
6317 @itemx -mno-bk
6318 Allow (disallow) allocation of general integer operands into the block
6319 count register BK. 
6321 @item -mdb
6322 @itemx -mno-db
6323 Enable (disable) generation of code using decrement and branch,
6324 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
6325 on the safe side, this is disabled for the C3x, since the maximum
6326 iteration count on the C3x is 2^23 + 1 (but who iterates loops more than
6327 2^23 times on the C3x?).  Note that GCC will try to reverse a loop so
6328 that it can utilise the decrement and branch instruction, but will give
6329 up if there is more than one memory reference in the loop.  Thus a loop
6330 where the loop counter is decremented can generate slightly more
6331 efficient code, in cases where the RPTB instruction cannot be utilised.
6333 @item -mdp-isr-reload
6334 @itemx -mparanoid
6335 Force the DP register to be saved on entry to an interrupt service
6336 routine (ISR), reloaded to point to the data section, and restored on
6337 exit from the ISR.  This should not be required unless someone has
6338 violated the small memory model by modifying the DP register, say within
6339 an object library.
6341 @item -mmpyi
6342 @itemx -mno-mpyi
6343 For the C3x use the 24-bit MPYI instruction for integer multiplies
6344 instead of a library call to guarantee 32-bit results.  Note that if one
6345 of the operands is a constant, then the multiplication will be performed
6346 using shifts and adds.  If the -mmpyi option is not specified for the C3x,
6347 then squaring operations are performed inline instead of a library call.
6349 @item -mfast-fix
6350 @itemx -mno-fast-fix
6351 The C3x/C4x FIX instruction to convert a floating point value to an
6352 integer value chooses the nearest integer less than or equal to the
6353 floating point value rather than to the nearest integer.  Thus if the
6354 floating point number is negative, the result will be incorrectly
6355 truncated an additional code is necessary to detect and correct this
6356 case.  This option can be used to disable generation of the additional
6357 code required to correct the result.
6359 @item -mrptb
6360 @itemx -mno-rptb
6361 Enable (disable) generation of repeat block sequences using the RPTB
6362 instruction for zero overhead looping.  The RPTB construct is only used
6363 for innermost loops that do not call functions or jump across the loop
6364 boundaries.  There is no advantage having nested RPTB loops due to the
6365 overhead required to save and restore the RC, RS, and RE registers.
6366 This is enabled by default with -O2.
6368 @item -mrpts=@var{count}
6369 @itemx -mno-rpts
6370 Enable (disable) the use of the single instruction repeat instruction
6371 RPTS.  If a repeat block contains a single instruction, and the loop
6372 count can be guaranteed to be less than the value @var{count}, GCC will
6373 emit a RPTS instruction instead of a RPTB.  If no value is specified,
6374 then a RPTS will be emitted even if the loop count cannot be determined
6375 at compile time.  Note that the repeated instruction following RPTS does
6376 not have to be reloaded from memory each iteration, thus freeing up the
6377 CPU buses for oeprands.  However, since interrupts are blocked by this
6378 instruction, it is disabled by default.
6380 @item -mloop-unsigned
6381 @itemx -mno-loop-unsigned
6382 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
6383 is 2^31 + 1 since these instructions test if the iteration count is
6384 negative to terminate the loop.  If the iteration count is unsigned
6385 there is a possibility than the 2^31 + 1 maximum iteration count may be
6386 exceeded.  This switch allows an unsigned iteration count.
6388 @item -mti
6389 Try to emit an assembler syntax that the TI assembler (asm30) is happy
6390 with.  This also enforces compatibility with the API employed by the TI
6391 C3x C compiler.  For example, long doubles are passed as structures
6392 rather than in floating point registers.
6394 @item -mregparm
6395 @itemx -mmemparm
6396 Generate code that uses registers (stack) for passing arguments to functions.
6397 By default, arguments are passed in registers where possible rather
6398 than by pushing arguments on to the stack.
6400 @item -mparallel-insns
6401 @itemx -mno-parallel-insns
6402 Allow the generation of parallel instructions.  This is enabled by
6403 default with -O2.
6405 @item -mparallel-mpy
6406 @itemx -mno-parallel-mpy
6407 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
6408 provided -mparallel-insns is also specified.  These instructions have
6409 tight register constraints which can pessimize the code generation
6410 of large functions.
6412 @end table
6414 @node V850 Options
6415 @subsection V850 Options
6416 @cindex V850 Options
6418 These @samp{-m} options are defined for V850 implementations:
6420 @table @code
6421 @item -mlong-calls
6422 @itemx -mno-long-calls
6423 Treat all calls as being far away (near).  If calls are assumed to be
6424 far away, the compiler will always load the functions address up into a
6425 register, and call indirect through the pointer.
6427 @item -mno-ep
6428 @itemx -mep
6429 Do not optimize (do optimize) basic blocks that use the same index
6430 pointer 4 or more times to copy pointer into the @code{ep} register, and
6431 use the shorter @code{sld} and @code{sst} instructions.  The @samp{-mep}
6432 option is on by default if you optimize.
6434 @item -mno-prolog-function
6435 @itemx -mprolog-function
6436 Do not use (do use) external functions to save and restore registers at
6437 the prolog and epilog of a function.  The external functions are slower,
6438 but use less code space if more than one function saves the same number
6439 of registers.  The @samp{-mprolog-function} option is on by default if
6440 you optimize.
6442 @item -mspace
6443 Try to make the code as small as possible.  At present, this just turns
6444 on the @samp{-mep} and @samp{-mprolog-function} options.
6446 @item -mtda=@var{n}
6447 Put static or global variables whose size is @var{n} bytes or less into
6448 the tiny data area that register @code{ep} points to.  The tiny data
6449 area can hold up to 256 bytes in total (128 bytes for byte references).
6451 @item -msda=@var{n}
6452 Put static or global variables whose size is @var{n} bytes or less into
6453 the small data area that register @code{gp} points to.  The small data
6454 area can hold up to 64 kilobytes.
6456 @item -mzda=@var{n}
6457 Put static or global variables whose size is @var{n} bytes or less into
6458 the first 32 kilobytes of memory.
6460 @item -mv850
6461 Specify that the target processor is the V850.
6463 @item -mbig-switch
6464 Generate code suitable for big switch tables.  Use this option only if
6465 the assembler/linker complain about out of range branches within a switch
6466 table.
6467 @end table
6469 @node ARC Options
6470 @subsection ARC Options
6471 @cindex ARC Options
6473 These options are defined for ARC implementations:
6475 @table @code
6476 @item -EL
6477 Compile code for little endian mode.  This is the default.
6479 @item -EB
6480 Compile code for big endian mode.
6482 @item -mmangle-cpu
6483 Prepend the name of the cpu to all public symbol names.
6484 In multiple-processor systems, there are many ARC variants with different
6485 instruction and register set characteristics.  This flag prevents code
6486 compiled for one cpu to be linked with code compiled for another.
6487 No facility exists for handling variants that are "almost identical".
6488 This is an all or nothing option.
6490 @item -mcpu=@var{cpu}
6491 Compile code for ARC variant @var{cpu}.
6492 Which variants are supported depend on the configuration.
6493 All variants support @samp{-mcpu=base}, this is the default.
6495 @item -mtext=@var{text section}
6496 @itemx -mdata=@var{data section}
6497 @itemx -mrodata=@var{readonly data section}
6498 Put functions, data, and readonly data in @var{text section},
6499 @var{data section}, and @var{readonly data section} respectively
6500 by default.  This can be overridden with the @code{section} attribute.
6501 @xref{Variable Attributes}.
6503 @end table
6505 @node NS32K Options
6506 @subsection NS32K Options
6507 @cindex NS32K options
6509 These are the @samp{-m} options defined for the 32000 series.  The default
6510 values for these options depends on which style of 32000 was selected when
6511 the compiler was configured; the defaults for the most common choices are
6512 given below.
6514 @table @code
6515 @item -m32032
6516 @itemx -m32032
6517 Generate output for a 32032.  This is the default
6518 when the compiler is configured for 32032 and 32016 based systems.
6520 @item -m32332
6521 @itemx -m32332
6522 Generate output for a 32332.  This is the default
6523 when the compiler is configured for 32332-based systems.
6525 @item -m32532
6526 @itemx -m32532
6527 Generate output for a 32532.  This is the default
6528 when the compiler is configured for 32532-based systems.
6530 @item -m32081
6531 Generate output containing 32081 instructions for floating point.
6532 This is the default for all systems.
6534 @item -m32381
6535 Generate output containing 32381 instructions for floating point.  This
6536 also implies @samp{-m32081}. The 32381 is only compatible with the 32332
6537 and 32532 cpus. This is the default for the pc532-netbsd configuration.
6539 @item -mmulti-add
6540 Try and generate multiply-add floating point instructions @code{polyF}
6541 and @code{dotF}. This option is only available if the @samp{-m32381}
6542 option is in effect. Using these instructions requires changes to to
6543 register allocation which generally has a negative impact on
6544 performance.  This option should only be enabled when compiling code
6545 particularly likely to make heavy use of multiply-add instructions.
6547 @item -mnomulti-add
6548 Do not try and generate multiply-add floating point instructions
6549 @code{polyF} and @code{dotF}. This is the default on all platforms.
6551 @item -msoft-float
6552 Generate output containing library calls for floating point.
6553 @strong{Warning:} the requisite libraries may not be available.
6555 @item -mnobitfield
6556 Do not use the bit-field instructions. On some machines it is faster to
6557 use shifting and masking operations. This is the default for the pc532.
6559 @item -mbitfield
6560 Do use the bit-field instructions. This is the default for all platforms
6561 except the pc532.
6563 @item -mrtd
6564 Use a different function-calling convention, in which functions
6565 that take a fixed number of arguments return pop their
6566 arguments on return with the @code{ret} instruction.
6568 This calling convention is incompatible with the one normally
6569 used on Unix, so you cannot use it if you need to call libraries
6570 compiled with the Unix compiler.
6572 Also, you must provide function prototypes for all functions that
6573 take variable numbers of arguments (including @code{printf});
6574 otherwise incorrect code will be generated for calls to those
6575 functions.
6577 In addition, seriously incorrect code will result if you call a
6578 function with too many arguments.  (Normally, extra arguments are
6579 harmlessly ignored.)
6581 This option takes its name from the 680x0 @code{rtd} instruction.
6584 @item -mregparam
6585 Use a different function-calling convention where the first two arguments
6586 are passed in registers.
6588 This calling convention is incompatible with the one normally
6589 used on Unix, so you cannot use it if you need to call libraries
6590 compiled with the Unix compiler.
6592 @item -mnoregparam
6593 Do not pass any arguments in registers. This is the default for all
6594 targets.
6596 @item -msb
6597 It is OK to use the sb as an index register which is always loaded with
6598 zero. This is the default for the pc532-netbsd target.
6600 @item -mnosb
6601 The sb register is not available for use or has not been initialized to
6602 zero by the run time system. This is the default for all targets except
6603 the pc532-netbsd. It is also implied whenever @samp{-mhimem} or
6604 @samp{-fpic} is set.
6606 @item -mhimem
6607 Many ns32000 series addressing modes use displacements of up to 512MB.
6608 If an address is above 512MB then displacements from zero can not be used.
6609 This option causes code to be generated which can be loaded above 512MB.
6610 This may be useful for operating systems or ROM code.
6612 @item -mnohimem
6613 Assume code will be loaded in the first 512MB of virtual address space.
6614 This is the default for all platforms.
6617 @end table
6621 @node Code Gen Options
6622 @section Options for Code Generation Conventions
6623 @cindex code generation conventions
6624 @cindex options, code generation
6625 @cindex run-time options
6627 These machine-independent options control the interface conventions
6628 used in code generation.
6630 Most of them have both positive and negative forms; the negative form
6631 of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below, only
6632 one of the forms is listed---the one which is not the default.  You
6633 can figure out the other form by either removing @samp{no-} or adding
6636 @table @code
6637 @item -fexceptions
6638 Enable exception handling. Generates extra code needed to propagate
6639 exceptions.  For some targets, this implies generation of frame unwind 
6640 information for all functions. This can produce significant data size 
6641 overhead, although it does not affect execution.
6642 If you do not specify this option, it is enabled by
6643 default for languages like C++ which normally require exception handling,
6644 and disabled for languages like C that do not normally require it.
6645 However, when compiling C code that needs to interoperate properly with
6646 exception handlers written in C++, you may need to enable this option.
6647 You may also wish to disable this option is you are compiling older C++
6648 programs that don't use exception handling.
6650 @item -fpcc-struct-return
6651 Return ``short'' @code{struct} and @code{union} values in memory like
6652 longer ones, rather than in registers.  This convention is less
6653 efficient, but it has the advantage of allowing intercallability between
6654 GCC-compiled files and files compiled with other compilers.
6656 The precise convention for returning structures in memory depends
6657 on the target configuration macros.
6659 Short structures and unions are those whose size and alignment match
6660 that of some integer type.
6662 @item -freg-struct-return
6663 Use the convention that @code{struct} and @code{union} values are
6664 returned in registers when possible.  This is more efficient for small
6665 structures than @samp{-fpcc-struct-return}.
6667 If you specify neither @samp{-fpcc-struct-return} nor its contrary
6668 @samp{-freg-struct-return}, GCC defaults to whichever convention is
6669 standard for the target.  If there is no standard convention, GCC
6670 defaults to @samp{-fpcc-struct-return}, except on targets where GCC
6671 is the principal compiler.  In those cases, we can choose the standard,
6672 and we chose the more efficient register return alternative.
6674 @item -fshort-enums
6675 Allocate to an @code{enum} type only as many bytes as it needs for the
6676 declared range of possible values.  Specifically, the @code{enum} type
6677 will be equivalent to the smallest integer type which has enough room.
6679 @item -fshort-double
6680 Use the same size for @code{double} as for @code{float}.
6682 @item -fshared-data
6683 Requests that the data and non-@code{const} variables of this
6684 compilation be shared data rather than private data.  The distinction
6685 makes sense only on certain operating systems, where shared data is
6686 shared between processes running the same program, while private data
6687 exists in one copy per process.
6689 @item -fno-common
6690 Allocate even uninitialized global variables in the bss section of the
6691 object file, rather than generating them as common blocks.  This has the
6692 effect that if the same variable is declared (without @code{extern}) in
6693 two different compilations, you will get an error when you link them.
6694 The only reason this might be useful is if you wish to verify that the
6695 program will work on other systems which always work this way.
6697 @item -fno-ident
6698 Ignore the @samp{#ident} directive.
6700 @item -fno-gnu-linker
6701 Do not output global initializations (such as C++ constructors and
6702 destructors) in the form used by the GNU linker (on systems where the GNU
6703 linker is the standard method of handling them).  Use this option when
6704 you want to use a non-GNU linker, which also requires using the
6705 @code{collect2} program to make sure the system linker includes
6706 constructors and destructors.  (@code{collect2} is included in the GCC
6707 distribution.)  For systems which @emph{must} use @code{collect2}, the
6708 compiler driver @code{gcc} is configured to do this automatically.
6710 @item -finhibit-size-directive
6711 Don't output a @code{.size} assembler directive, or anything else that
6712 would cause trouble if the function is split in the middle, and the
6713 two halves are placed at locations far apart in memory.  This option is
6714 used when compiling @file{crtstuff.c}; you should not need to use it
6715 for anything else.
6717 @item -fverbose-asm
6718 Put extra commentary information in the generated assembly code to
6719 make it more readable.  This option is generally only of use to those
6720 who actually need to read the generated assembly code (perhaps while
6721 debugging the compiler itself).
6723 @samp{-fno-verbose-asm}, the default, causes the
6724 extra information to be omitted and is useful when comparing two assembler
6725 files.
6727 @item -fvolatile
6728 Consider all memory references through pointers to be volatile.
6730 @item -fvolatile-global
6731 Consider all memory references to extern and global data items to
6732 be volatile.  GCC does not consider static data items to be volatile
6733 because of this switch.
6735 @item -fvolatile-static
6736 Consider all memory references to static data to be volatile.
6738 @item -fpic
6739 @cindex global offset table
6740 @cindex PIC
6741 Generate position-independent code (PIC) suitable for use in a shared
6742 library, if supported for the target machine.  Such code accesses all
6743 constant addresses through a global offset table (GOT).  The dynamic
6744 loader resolves the GOT entries when the program starts (the dynamic
6745 loader is not part of GCC; it is part of the operating system).  If
6746 the GOT size for the linked executable exceeds a machine-specific
6747 maximum size, you get an error message from the linker indicating that
6748 @samp{-fpic} does not work; in that case, recompile with @samp{-fPIC}
6749 instead.  (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
6750 on the m68k and RS/6000.  The 386 has no such limit.)
6752 Position-independent code requires special support, and therefore works
6753 only on certain machines.  For the 386, GCC supports PIC for System V
6754 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
6755 position-independent.
6757 @item -fPIC
6758 If supported for the target machine, emit position-independent code,
6759 suitable for dynamic linking and avoiding any limit on the size of the
6760 global offset table.  This option makes a difference on the m68k, m88k,
6761 and the Sparc.
6763 Position-independent code requires special support, and therefore works
6764 only on certain machines.
6766 @item -ffixed-@var{reg}
6767 Treat the register named @var{reg} as a fixed register; generated code
6768 should never refer to it (except perhaps as a stack pointer, frame
6769 pointer or in some other fixed role).
6771 @var{reg} must be the name of a register.  The register names accepted
6772 are machine-specific and are defined in the @code{REGISTER_NAMES}
6773 macro in the machine description macro file.
6775 This flag does not have a negative form, because it specifies a
6776 three-way choice.
6778 @item -fcall-used-@var{reg}
6779 Treat the register named @var{reg} as an allocable register that is
6780 clobbered by function calls.  It may be allocated for temporaries or
6781 variables that do not live across a call.  Functions compiled this way
6782 will not save and restore the register @var{reg}.
6784 It is an error to used this flag with the frame pointer or stack pointer.
6785 Use of this flag for other registers that have fixed pervasive roles in
6786 the machine's execution model will produce disastrous results.
6788 This flag does not have a negative form, because it specifies a
6789 three-way choice.
6791 @item -fcall-saved-@var{reg}
6792 Treat the register named @var{reg} as an allocable register saved by
6793 functions.  It may be allocated even for temporaries or variables that
6794 live across a call.  Functions compiled this way will save and restore
6795 the register @var{reg} if they use it.
6797 It is an error to used this flag with the frame pointer or stack pointer.
6798 Use of this flag for other registers that have fixed pervasive roles in
6799 the machine's execution model will produce disastrous results.
6801 A different sort of disaster will result from the use of this flag for
6802 a register in which function values may be returned.
6804 This flag does not have a negative form, because it specifies a
6805 three-way choice.
6807 @item -fpack-struct
6808 Pack all structure members together without holes.  Usually you would
6809 not want to use this option, since it makes the code suboptimal, and
6810 the offsets of structure members won't agree with system libraries.
6812 @item -fcheck-memory-usage
6813 Generate extra code to check each memory access.  GCC will generate
6814 code that is suitable for a detector of bad memory accesses such as
6815 @file{Checker}.
6817 Normally, you should compile all, or none, of your code with this option.
6819 If you do mix code compiled with and without this option,
6820 you must ensure that all code that has side effects
6821 and that is called by code compiled with this option
6822 is, itself, compiled with this option.
6823 If you do not, you might get erroneous messages from the detector.
6825 If you use functions from a library that have side-effects (such as
6826 @code{read}), you might not be able to recompile the library and
6827 specify this option.  In that case, you can enable the
6828 @samp{-fprefix-function-name} option, which requests GCC to encapsulate
6829 your code and make other functions look as if they were compiled with
6830 @samp{-fcheck-memory-usage}.  This is done by calling ``stubs'',
6831 which are provided by the detector.  If you cannot find or build
6832 stubs for every function you call, you might have to specify
6833 @samp{-fcheck-memory-usage} without @samp{-fprefix-function-name}.
6835 If you specify this option, you can not use the @code{asm} or
6836 @code{__asm__} keywords in functions with memory checking enabled.  The
6837 compiler cannot understand what the @code{asm} statement will do, and
6838 therefore cannot generate the appropriate code, so it is rejected.
6839 However, the function attribute @code{no_check_memory_usage} will
6840 disable memory checking within a function, and @code{asm} statements can
6841 be put inside such functions.  Inline expansion of a non-checked
6842 function within a checked function is permitted; the inline function's
6843 memory accesses won't be checked, but the rest will.
6845 If you move your @code{asm} statements to non-checked inline functions,
6846 but they do access memory, you can add calls to the support code in your
6847 inline function, to indicate any reads, writes, or copies being done.
6848 These calls would be similar to those done in the stubs described above.
6850 @c FIXME: The support-routine interface is defined by the compiler and
6851 @c        should be documented!
6853 @item -fprefix-function-name
6854 Request GCC to add a prefix to the symbols generated for function names.
6855 GCC adds a prefix to the names of functions defined as well as
6856 functions called.  Code compiled with this option and code compiled
6857 without the option can't be linked together, unless stubs are used.
6859 If you compile the following code with @samp{-fprefix-function-name}
6860 @example
6861 extern void bar (int);
6862 void
6863 foo (int a)
6865   return bar (a + 5);
6867 @end example
6869 @noindent
6870 GCC will compile the code as if it was written:
6871 @example
6872 extern void prefix_bar (int);
6873 void
6874 prefix_foo (int a)
6876   return prefix_bar (a + 5);
6878 @end example
6879 This option is designed to be used with @samp{-fcheck-memory-usage}.
6881 @item -finstrument-functions
6882 Generate instrumentation calls for entry and exit to functions.  Just
6883 after function entry and just before function exit, the following
6884 profiling functions will be called with the address of the current
6885 function and its call site.  (On some platforms,
6886 @code{__builtin_return_address} does not work beyond the current
6887 function, so the call site information may not be available to the
6888 profiling functions otherwise.)
6890 @example
6891 void __cyg_profile_func_enter (void *this_fn, void *call_site);
6892 void __cyg_profile_func_exit  (void *this_fn, void *call_site);
6893 @end example
6895 The first argument is the address of the start of the current function,
6896 which may be looked up exactly in the symbol table.
6898 This instrumentation is also done for functions expanded inline in other
6899 functions.  The profiling calls will indicate where, conceptually, the
6900 inline function is entered and exited.  This means that addressable
6901 versions of such functions must be available.  If all your uses of a
6902 function are expanded inline, this may mean an additional expansion of
6903 code size.  If you use @samp{extern inline} in your C code, an
6904 addressable version of such functions must be provided.  (This is
6905 normally the case anyways, but if you get lucky and the optimizer always
6906 expands the functions inline, you might have gotten away without
6907 providing static copies.)
6909 A function may be given the attribute @code{no_instrument_function}, in
6910 which case this instrumentation will not be done.  This can be used, for
6911 example, for the profiling functions listed above, high-priority
6912 interrupt routines, and any functions from which the profiling functions
6913 cannot safely be called (perhaps signal handlers, if the profiling
6914 routines generate output or allocate memory).
6916 @item -fstack-check
6917 Generate code to verify that you do not go beyond the boundary of the
6918 stack.  You should specify this flag if you are running in an
6919 environment with multiple threads, but only rarely need to specify it in
6920 a single-threaded environment since stack overflow is automatically
6921 detected on nearly all systems if there is only one stack.
6923 @cindex aliasing of parameters
6924 @cindex parameters, aliased
6925 @item -fargument-alias
6926 @itemx -fargument-noalias
6927 @itemx -fargument-noalias-global
6928 Specify the possible relationships among parameters and between
6929 parameters and global data.
6931 @samp{-fargument-alias} specifies that arguments (parameters) may
6932 alias each other and may alias global storage.
6933 @samp{-fargument-noalias} specifies that arguments do not alias
6934 each other, but may alias global storage.
6935 @samp{-fargument-noalias-global} specifies that arguments do not
6936 alias each other and do not alias global storage.
6938 Each language will automatically use whatever option is required by
6939 the language standard.  You should not need to use these options yourself.
6941 @item -fleading-underscore
6942 This option and its counterpart, -fno-leading-underscore, forcibly
6943 change the way C symbols are represented in the object file.  One use
6944 is to help link with legacy assembly code.
6946 Be warned that you should know what you are doing when invoking this
6947 option, and that not all targets provide complete support for it.
6948 @end table
6950 @node Environment Variables
6951 @section Environment Variables Affecting GCC
6952 @cindex environment variables
6954 This section describes several environment variables that affect how GCC
6955 operates.  Some of them work by specifying directories or prefixes to use
6956 when searching for various kinds of files. Some are used to specify other
6957 aspects of the compilation environment.
6959 @ifclear INTERNALS
6960 Note that you can also specify places to search using options such as
6961 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
6962 take precedence over places specified using environment variables, which
6963 in turn take precedence over those specified by the configuration of GCC.
6965 @end ifclear
6966 @ifset INTERNALS
6967 Note that you can also specify places to search using options such as
6968 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
6969 take precedence over places specified using environment variables, which
6970 in turn take precedence over those specified by the configuration of GCC.
6971 @xref{Driver}.
6972 @end ifset
6974 @table @code
6975 @item LANG
6976 @itemx LC_CTYPE
6977 @c @itemx LC_COLLATE
6978 @itemx LC_MESSAGES
6979 @c @itemx LC_MONETARY
6980 @c @itemx LC_NUMERIC
6981 @c @itemx LC_TIME
6982 @itemx LC_ALL
6983 @findex LANG
6984 @findex LC_CTYPE
6985 @c @findex LC_COLLATE
6986 @findex LC_MESSAGES
6987 @c @findex LC_MONETARY
6988 @c @findex LC_NUMERIC
6989 @c @findex LC_TIME
6990 @findex LC_ALL
6991 @cindex locale
6992 These environment variables control the way that GCC uses
6993 localization information that allow GCC to work with different
6994 national conventions.  GCC inspects the locale categories
6995 @code{LC_CTYPE} and @code{LC_MESSAGES} if it has been configured to do
6996 so.  These locale categories can be set to any value supported by your
6997 installation.  A typical value is @samp{en_UK} for English in the United
6998 Kingdom.
7000 The @code{LC_CTYPE} environment variable specifies character
7001 classification.  GCC uses it to determine the character boundaries in
7002 a string; this is needed for some multibyte encodings that contain quote
7003 and escape characters that would otherwise be interpreted as a string
7004 end or escape.
7006 The @code{LC_MESSAGES} environment variable specifies the language to
7007 use in diagnostic messages.
7009 If the @code{LC_ALL} environment variable is set, it overrides the value
7010 of @code{LC_CTYPE} and @code{LC_MESSAGES}; otherwise, @code{LC_CTYPE}
7011 and @code{LC_MESSAGES} default to the value of the @code{LANG}
7012 environment variable.  If none of these variables are set, GCC
7013 defaults to traditional C English behavior.
7015 @item TMPDIR
7016 @findex TMPDIR
7017 If @code{TMPDIR} is set, it specifies the directory to use for temporary
7018 files.  GCC uses temporary files to hold the output of one stage of
7019 compilation which is to be used as input to the next stage: for example,
7020 the output of the preprocessor, which is the input to the compiler
7021 proper.
7023 @item GCC_EXEC_PREFIX
7024 @findex GCC_EXEC_PREFIX
7025 If @code{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
7026 names of the subprograms executed by the compiler.  No slash is added
7027 when this prefix is combined with the name of a subprogram, but you can
7028 specify a prefix that ends with a slash if you wish.
7030 If GCC cannot find the subprogram using the specified prefix, it
7031 tries looking in the usual places for the subprogram.
7033 The default value of @code{GCC_EXEC_PREFIX} is
7034 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
7035 of @code{prefix} when you ran the @file{configure} script.
7037 Other prefixes specified with @samp{-B} take precedence over this prefix.
7039 This prefix is also used for finding files such as @file{crt0.o} that are
7040 used for linking.
7042 In addition, the prefix is used in an unusual way in finding the
7043 directories to search for header files.  For each of the standard
7044 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
7045 (more precisely, with the value of @code{GCC_INCLUDE_DIR}), GCC tries
7046 replacing that beginning with the specified prefix to produce an
7047 alternate directory name.  Thus, with @samp{-Bfoo/}, GCC will search
7048 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
7049 These alternate directories are searched first; the standard directories
7050 come next.
7052 @item COMPILER_PATH
7053 @findex COMPILER_PATH
7054 The value of @code{COMPILER_PATH} is a colon-separated list of
7055 directories, much like @code{PATH}.  GCC tries the directories thus
7056 specified when searching for subprograms, if it can't find the
7057 subprograms using @code{GCC_EXEC_PREFIX}.
7059 @item LIBRARY_PATH
7060 @findex LIBRARY_PATH
7061 The value of @code{LIBRARY_PATH} is a colon-separated list of
7062 directories, much like @code{PATH}.  When configured as a native compiler,
7063 GCC tries the directories thus specified when searching for special
7064 linker files, if it can't find them using @code{GCC_EXEC_PREFIX}.  Linking
7065 using GCC also uses these directories when searching for ordinary
7066 libraries for the @samp{-l} option (but directories specified with
7067 @samp{-L} come first).
7069 @item C_INCLUDE_PATH
7070 @itemx CPLUS_INCLUDE_PATH
7071 @itemx OBJC_INCLUDE_PATH
7072 @findex C_INCLUDE_PATH
7073 @findex CPLUS_INCLUDE_PATH
7074 @findex OBJC_INCLUDE_PATH
7075 @c @itemx OBJCPLUS_INCLUDE_PATH
7076 These environment variables pertain to particular languages.  Each
7077 variable's value is a colon-separated list of directories, much like
7078 @code{PATH}.  When GCC searches for header files, it tries the
7079 directories listed in the variable for the language you are using, after
7080 the directories specified with @samp{-I} but before the standard header
7081 file directories.
7083 @item DEPENDENCIES_OUTPUT
7084 @findex DEPENDENCIES_OUTPUT
7085 @cindex dependencies for make as output
7086 If this variable is set, its value specifies how to output dependencies
7087 for Make based on the header files processed by the compiler.  This
7088 output looks much like the output from the @samp{-M} option
7089 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
7090 in addition to the usual results of compilation.
7092 The value of @code{DEPENDENCIES_OUTPUT} can be just a file name, in
7093 which case the Make rules are written to that file, guessing the target
7094 name from the source file name.  Or the value can have the form
7095 @samp{@var{file} @var{target}}, in which case the rules are written to
7096 file @var{file} using @var{target} as the target name.
7098 @item LANG
7099 @findex LANG
7100 @cindex locale definition
7101 This variable is used to pass locale information to the compiler. One way in
7102 which this information is used is to determine the character set to be used
7103 when character literals, string literals and comments are parsed in C and C++.
7104 When the compiler is configured to allow multibyte characters,
7105 the following values for @code{LANG} are recognized:
7107 @table @code
7108 @item C-JIS
7109 Recognize JIS characters.
7110 @item C-SJIS
7111 Recognize SJIS characters.
7112 @item C-EUCJP
7113 Recognize EUCJP characters.
7114 @end table
7116 If @code{LANG} is not defined, or if it has some other value, then the
7117 compiler will use mblen and mbtowc as defined by the default locale to
7118 recognize and translate multibyte characters.
7119 @end table
7121 @node Running Protoize
7122 @section Running Protoize
7124 The program @code{protoize} is an optional part of GNU C.  You can use
7125 it to add prototypes to a program, thus converting the program to ANSI
7126 C in one respect.  The companion program @code{unprotoize} does the
7127 reverse: it removes argument types from any prototypes that are found.
7129 When you run these programs, you must specify a set of source files as
7130 command line arguments.  The conversion programs start out by compiling
7131 these files to see what functions they define.  The information gathered
7132 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
7134 After scanning comes actual conversion.  The specified files are all
7135 eligible to be converted; any files they include (whether sources or
7136 just headers) are eligible as well.
7138 But not all the eligible files are converted.  By default,
7139 @code{protoize} and @code{unprotoize} convert only source and header
7140 files in the current directory.  You can specify additional directories
7141 whose files should be converted with the @samp{-d @var{directory}}
7142 option.  You can also specify particular files to exclude with the
7143 @samp{-x @var{file}} option.  A file is converted if it is eligible, its
7144 directory name matches one of the specified directory names, and its
7145 name within the directory has not been excluded.
7147 Basic conversion with @code{protoize} consists of rewriting most
7148 function definitions and function declarations to specify the types of
7149 the arguments.  The only ones not rewritten are those for varargs
7150 functions.
7152 @code{protoize} optionally inserts prototype declarations at the
7153 beginning of the source file, to make them available for any calls that
7154 precede the function's definition.  Or it can insert prototype
7155 declarations with block scope in the blocks where undeclared functions
7156 are called.
7158 Basic conversion with @code{unprotoize} consists of rewriting most
7159 function declarations to remove any argument types, and rewriting
7160 function definitions to the old-style pre-ANSI form.
7162 Both conversion programs print a warning for any function declaration or
7163 definition that they can't convert.  You can suppress these warnings
7164 with @samp{-q}.
7166 The output from @code{protoize} or @code{unprotoize} replaces the
7167 original source file.  The original file is renamed to a name ending
7168 with @samp{.save}.  If the @samp{.save} file already exists, then
7169 the source file is simply discarded.
7171 @code{protoize} and @code{unprotoize} both depend on GCC itself to
7172 scan the program and collect information about the functions it uses.
7173 So neither of these programs will work until GCC is installed.
7175 Here is a table of the options you can use with @code{protoize} and
7176 @code{unprotoize}.  Each option works with both programs unless
7177 otherwise stated.
7179 @table @code
7180 @item -B @var{directory}
7181 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
7182 usual directory (normally @file{/usr/local/lib}).  This file contains
7183 prototype information about standard system functions.  This option
7184 applies only to @code{protoize}.
7186 @item -c @var{compilation-options}
7187 Use  @var{compilation-options} as the options when running @code{gcc} to
7188 produce the @samp{.X} files.  The special option @samp{-aux-info} is
7189 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
7191 Note that the compilation options must be given as a single argument to
7192 @code{protoize} or @code{unprotoize}.  If you want to specify several
7193 @code{gcc} options, you must quote the entire set of compilation options
7194 to make them a single word in the shell.
7196 There are certain @code{gcc} arguments that you cannot use, because they
7197 would produce the wrong kind of output.  These include @samp{-g},
7198 @samp{-O}, @samp{-c}, @samp{-S}, and @samp{-o} If you include these in
7199 the @var{compilation-options}, they are ignored.
7201 @item -C
7202 Rename files to end in @samp{.C} instead of @samp{.c}.
7203 This is convenient if you are converting a C program to C++.
7204 This option applies only to @code{protoize}.
7206 @item -g
7207 Add explicit global declarations.  This means inserting explicit
7208 declarations at the beginning of each source file for each function
7209 that is called in the file and was not declared.  These declarations
7210 precede the first function definition that contains a call to an
7211 undeclared function.  This option applies only to @code{protoize}.
7213 @item -i @var{string}
7214 Indent old-style parameter declarations with the string @var{string}.
7215 This option applies only to @code{protoize}.
7217 @code{unprotoize} converts prototyped function definitions to old-style
7218 function definitions, where the arguments are declared between the
7219 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
7220 uses five spaces as the indentation.  If you want to indent with just
7221 one space instead, use @samp{-i " "}.
7223 @item -k
7224 Keep the @samp{.X} files.  Normally, they are deleted after conversion
7225 is finished.
7227 @item -l
7228 Add explicit local declarations.  @code{protoize} with @samp{-l} inserts
7229 a prototype declaration for each function in each block which calls the
7230 function without any declaration.  This option applies only to
7231 @code{protoize}.
7233 @item -n
7234 Make no real changes.  This mode just prints information about the conversions
7235 that would have been done without @samp{-n}.
7237 @item -N
7238 Make no @samp{.save} files.  The original files are simply deleted.
7239 Use this option with caution.
7241 @item -p @var{program}
7242 Use the program @var{program} as the compiler.  Normally, the name
7243 @file{gcc} is used.
7245 @item -q
7246 Work quietly.  Most warnings are suppressed.
7248 @item -v
7249 Print the version number, just like @samp{-v} for @code{gcc}.
7250 @end table
7252 If you need special compiler options to compile one of your program's
7253 source files, then you should generate that file's @samp{.X} file
7254 specially, by running @code{gcc} on that source file with the
7255 appropriate options and the option @samp{-aux-info}.  Then run
7256 @code{protoize} on the entire set of files.  @code{protoize} will use
7257 the existing @samp{.X} file because it is newer than the source file.
7258 For example:
7260 @example
7261 gcc -Dfoo=bar file1.c -aux-info
7262 protoize *.c
7263 @end example
7265 @noindent
7266 You need to include the special files along with the rest in the
7267 @code{protoize} command, even though their @samp{.X} files already
7268 exist, because otherwise they won't get converted.
7270 @xref{Protoize Caveats}, for more information on how to use
7271 @code{protoize} successfully.