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