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