Regenerate after this patch:
[official-gcc.git] / gcc / invoke.texi
blobe1f2503b9cecd906b82a2cff183a22e7eac8ee5b
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 -fstd  -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 -fstd=
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:199x
732 ISO C 9x
734 @item c89
735 same as -std=iso9899:1990
737 @item c9x
738 same as -std=iso9899:199x
740 @item gnu89
741 default, iso9899:1990 + gnu extensions
743 @item gnu9x
744 iso9899:199x + gnu extensions
745 @end itemize
747 Even when this option is not specified, you can still use some of the
748 features of newer standards in so far as they do not conflict with
749 previous C standards.  For example, you may use @code{__restrict__} even
750 when -fstd=c9x is not specified.
752 @item -fno-asm
753 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
754 keyword, so that code can use these words as identifiers.  You can use
755 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
756 instead.  @samp{-ansi} implies @samp{-fno-asm}.
758 In C++, this switch only affects the @code{typeof} keyword, since
759 @code{asm} and @code{inline} are standard keywords.  You may want to
760 use the @samp{-fno-gnu-keywords} flag instead, which has the same effect.
762 @item -fno-builtin
763 @cindex builtin functions
764 @findex abort
765 @findex abs
766 @findex alloca
767 @findex cos
768 @findex cosf
769 @findex cosl
770 @findex exit
771 @findex _exit
772 @findex fabs
773 @findex fabsf
774 @findex fabsl
775 @findex ffs
776 @findex labs
777 @findex memcmp
778 @findex memcpy
779 @findex memset
780 @findex sin
781 @findex sinf
782 @findex sinl
783 @findex sqrt
784 @findex sqrtf
785 @findex sqrtl
786 @findex strcmp
787 @findex strcpy
788 @findex strlen
789 Don't recognize builtin functions that do not begin with @samp{__builtin_}
790 as prefix.  Currently, the functions affected include @code{abort},
791 @code{abs}, @code{alloca}, @code{cos}, @code{cosf}, @code{cosl},
792 @code{exit}, @code{_exit}, @code{fabs}, @code{fabsf}, @code{fabsl},
793 @code{ffs}, @code{labs}, @code{memcmp}, @code{memcpy}, @code{memset},
794 @code{sin}, @code{sinf}, @code{sinl}, @code{sqrt}, @code{sqrtf},
795 @code{sqrtl}, @code{strcmp}, @code{strcpy}, and @code{strlen}.
797 GCC normally generates special code to handle certain builtin functions
798 more efficiently; for instance, calls to @code{alloca} may become single
799 instructions that adjust the stack directly, and calls to @code{memcpy}
800 may become inline copy loops.  The resulting code is often both smaller
801 and faster, but since the function calls no longer appear as such, you
802 cannot set a breakpoint on those calls, nor can you change the behavior
803 of the functions by linking with a different library.
805 The @samp{-ansi} option prevents @code{alloca}, @code{ffs} and @code{_exit}
806 from being builtin functions, since these functions do not have an ANSI
807 standard meaning.
809 @item -fhosted
810 @cindex hosted environment
812 Assert that compilation takes place in a hosted environment.  This implies
813 @samp{-fbuiltin}.  A hosted environment is one in which the
814 entire standard library is available, and in which @code{main} has a return
815 type of @code{int}.  Examples are nearly everything except a kernel.
816 This is equivalent to @samp{-fno-freestanding}.
818 @item -ffreestanding
819 @cindex hosted environment
821 Assert that compilation takes place in a freestanding environment.  This
822 implies @samp{-fno-builtin}.  A freestanding environment
823 is one in which the standard library may not exist, and program startup may
824 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
825 This is equivalent to @samp{-fno-hosted}.
827 @item -trigraphs
828 Support ANSI C trigraphs.  You don't want to know about this
829 brain-damage.  The @samp{-ansi} option implies @samp{-trigraphs}.
831 @cindex traditional C language
832 @cindex C language, traditional
833 @item -traditional
834 Attempt to support some aspects of traditional C compilers.
835 Specifically:
837 @itemize @bullet
838 @item
839 All @code{extern} declarations take effect globally even if they
840 are written inside of a function definition.  This includes implicit
841 declarations of functions.
843 @item
844 The newer keywords @code{typeof}, @code{inline}, @code{signed}, @code{const}
845 and @code{volatile} are not recognized.  (You can still use the
846 alternative keywords such as @code{__typeof__}, @code{__inline__}, and
847 so on.)
849 @item
850 Comparisons between pointers and integers are always allowed.
852 @item
853 Integer types @code{unsigned short} and @code{unsigned char} promote
854 to @code{unsigned int}.
856 @item
857 Out-of-range floating point literals are not an error.
859 @item
860 Certain constructs which ANSI regards as a single invalid preprocessing
861 number, such as @samp{0xe-0xd}, are treated as expressions instead.
863 @item
864 String ``constants'' are not necessarily constant; they are stored in
865 writable space, and identical looking constants are allocated
866 separately.  (This is the same as the effect of
867 @samp{-fwritable-strings}.)
869 @cindex @code{longjmp} and automatic variables
870 @item
871 All automatic variables not declared @code{register} are preserved by
872 @code{longjmp}.  Ordinarily, GNU C follows ANSI C: automatic variables
873 not declared @code{volatile} may be clobbered.
875 @item
876 @kindex \x
877 @kindex \a
878 @cindex escape sequences, traditional
879 The character escape sequences @samp{\x} and @samp{\a} evaluate as the
880 literal characters @samp{x} and @samp{a} respectively.  Without
881 @w{@samp{-traditional}}, @samp{\x} is a prefix for the hexadecimal
882 representation of a character, and @samp{\a} produces a bell.
883 @end itemize
885 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
886 if your program uses names that are normally GNU C builtin functions for
887 other purposes of its own.
889 You cannot use @samp{-traditional} if you include any header files that
890 rely on ANSI C features.  Some vendors are starting to ship systems with
891 ANSI C header files and you cannot use @samp{-traditional} on such
892 systems to compile files that include any system headers.
894 The @samp{-traditional} option also enables @samp{-traditional-cpp},
895 which is described next.
897 @item -traditional-cpp
898 Attempt to support some aspects of traditional C preprocessors.
899 Specifically:
901 @itemize @bullet
902 @item
903 Comments convert to nothing at all, rather than to a space.  This allows
904 traditional token concatenation.
906 @item
907 In a preprocessing directive, the @samp{#} symbol must appear as the first
908 character of a line.
910 @item
911 Macro arguments are recognized within string constants in a macro
912 definition (and their values are stringified, though without additional
913 quote marks, when they appear in such a context).  The preprocessor
914 always considers a string constant to end at a newline.
916 @item
917 @cindex detecting @w{@samp{-traditional}}
918 The predefined macro @code{__STDC__} is not defined when you use
919 @samp{-traditional}, but @code{__GNUC__} is (since the GNU extensions
920 which @code{__GNUC__} indicates are not affected by
921 @samp{-traditional}).  If you need to write header files that work
922 differently depending on whether @samp{-traditional} is in use, by
923 testing both of these predefined macros you can distinguish four
924 situations: GNU C, traditional GNU C, other ANSI C compilers, and other
925 old C compilers.  The predefined macro @code{__STDC_VERSION__} is also
926 not defined when you use @samp{-traditional}.  @xref{Standard
927 Predefined,,Standard Predefined Macros,cpp.info,The C Preprocessor},
928 for more discussion of these and other predefined macros.
930 @item
931 @cindex string constants vs newline
932 @cindex newline vs string constants
933 The preprocessor considers a string constant to end at a newline (unless
934 the newline is escaped with @samp{\}).  (Without @w{@samp{-traditional}},
935 string constants can contain the newline character as typed.)
936 @end itemize
938 @item -fcond-mismatch
939 Allow conditional expressions with mismatched types in the second and
940 third arguments.  The value of such an expression is void.
942 @item -funsigned-char
943 Let the type @code{char} be unsigned, like @code{unsigned char}.
945 Each kind of machine has a default for what @code{char} should
946 be.  It is either like @code{unsigned char} by default or like
947 @code{signed char} by default.
949 Ideally, a portable program should always use @code{signed char} or
950 @code{unsigned char} when it depends on the signedness of an object.
951 But many programs have been written to use plain @code{char} and
952 expect it to be signed, or expect it to be unsigned, depending on the
953 machines they were written for.  This option, and its inverse, let you
954 make such a program work with the opposite default.
956 The type @code{char} is always a distinct type from each of
957 @code{signed char} or @code{unsigned char}, even though its behavior
958 is always just like one of those two.
960 @item -fsigned-char
961 Let the type @code{char} be signed, like @code{signed char}.
963 Note that this is equivalent to @samp{-fno-unsigned-char}, which is
964 the negative form of @samp{-funsigned-char}.  Likewise, the option
965 @samp{-fno-signed-char} is equivalent to @samp{-funsigned-char}.
967 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
968 if your program uses names that are normally GNU C builtin functions for
969 other purposes of its own.
971 You cannot use @samp{-traditional} if you include any header files that
972 rely on ANSI C features.  Some vendors are starting to ship systems with
973 ANSI C header files and you cannot use @samp{-traditional} on such
974 systems to compile files that include any system headers.
976 @item -fsigned-bitfields
977 @itemx -funsigned-bitfields
978 @itemx -fno-signed-bitfields
979 @itemx -fno-unsigned-bitfields
980 These options control whether a bitfield is signed or unsigned, when the
981 declaration does not use either @code{signed} or @code{unsigned}.  By
982 default, such a bitfield is signed, because this is consistent: the
983 basic integer types such as @code{int} are signed types.
985 However, when @samp{-traditional} is used, bitfields are all unsigned
986 no matter what.
988 @item -fwritable-strings
989 Store string constants in the writable data segment and don't uniquize
990 them.  This is for compatibility with old programs which assume they can
991 write into string constants.  The option @samp{-traditional} also has
992 this effect.
994 Writing into string constants is a very bad idea; ``constants'' should
995 be constant.
997 @item -fallow-single-precision
998 Do not promote single precision math operations to double precision,
999 even when compiling with @samp{-traditional}.
1001 Traditional K&R C promotes all floating point operations to double
1002 precision, regardless of the sizes of the operands.   On the
1003 architecture for which you are compiling, single precision may be faster
1004 than double precision.   If you must use @samp{-traditional}, but want
1005 to use single precision operations when the operands are single
1006 precision, use this option.   This option has no effect when compiling
1007 with ANSI or GNU C conventions (the default).
1009 @item -fshort-wchar
1010 Override the underlying type for @samp{wchar_t} to be @samp{short
1011 unsigned int} instead of the default for the target.  This option is
1012 useful for building programs to run under WINE.
1013 @end table
1015 @node C++ Dialect Options
1016 @section Options Controlling C++ Dialect
1018 @cindex compiler options, C++
1019 @cindex C++ options, command line
1020 @cindex options, C++
1021 This section describes the command-line options that are only meaningful
1022 for C++ programs; but you can also use most of the GNU compiler options
1023 regardless of what language your program is in.  For example, you
1024 might compile a file @code{firstClass.C} like this:
1026 @example
1027 g++ -g -frepo -O -c firstClass.C
1028 @end example
1030 @noindent
1031 In this example, only @samp{-frepo} is an option meant
1032 only for C++ programs; you can use the other options with any
1033 language supported by GCC.
1035 Here is a list of options that are @emph{only} for compiling C++ programs:
1037 @table @code
1038 @item -fno-access-control
1039 Turn off all access checking.  This switch is mainly useful for working
1040 around bugs in the access control code.
1042 @item -fcheck-new
1043 Check that the pointer returned by @code{operator new} is non-null
1044 before attempting to modify the storage allocated.  The current Working
1045 Paper requires that @code{operator new} never return a null pointer, so
1046 this check is normally unnecessary.
1048 An alternative to using this option is to specify that your
1049 @code{operator new} does not throw any exceptions; if you declare it
1050 @samp{throw()}, g++ will check the return value.  See also @samp{new
1051 (nothrow)}.
1053 @item -fconserve-space
1054 Put uninitialized or runtime-initialized global variables into the
1055 common segment, as C does.  This saves space in the executable at the
1056 cost of not diagnosing duplicate definitions.  If you compile with this
1057 flag and your program mysteriously crashes after @code{main()} has
1058 completed, you may have an object that is being destroyed twice because
1059 two definitions were merged.
1061 This option is no longer useful on most targets, now that support has
1062 been added for putting variables into BSS without making them common.
1064 @item -fdollars-in-identifiers
1065 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1066 @samp{$} with the option @samp{-fno-dollars-in-identifiers}.  (GNU C allows
1067 @samp{$} by default on most target systems, but there are a few exceptions.)
1068 Traditional C allowed the character @samp{$} to form part of
1069 identifiers.  However, ANSI C and C++ forbid @samp{$} in identifiers.
1071 @item -fno-elide-constructors
1072 The C++ standard allows an implementation to omit creating a temporary
1073 which is only used to initialize another object of the same type.
1074 Specifying this option disables that optimization, and forces g++ to
1075 call the copy constructor in all cases.
1077 @item -fno-enforce-eh-specs
1078 Don't check for violation of exception specifications at runtime.  This
1079 option violates the C++ standard, but may be useful for reducing code
1080 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1081 will still optimize based on the exception specifications.
1083 @item -fexternal-templates
1084 Cause template instantiations to obey @samp{#pragma interface} and
1085 @samp{implementation}; template instances are emitted or not according
1086 to the location of the template definition.  @xref{Template
1087 Instantiation}, for more information.
1089 This option is deprecated.
1091 @item -falt-external-templates
1092 Similar to -fexternal-templates, but template instances are emitted or
1093 not according to the place where they are first instantiated.
1094 @xref{Template Instantiation}, for more information.
1096 This option is deprecated.
1098 @item -ffor-scope
1099 @itemx -fno-for-scope
1100 If -ffor-scope is specified, the scope of variables declared in
1101 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1102 as specified by the C++ standard.
1103 If -fno-for-scope is specified, the scope of variables declared in
1104 a @i{for-init-statement} extends to the end of the enclosing scope,
1105 as was the case in old versions of gcc, and other (traditional)
1106 implementations of C++.
1108 The default if neither flag is given to follow the standard,
1109 but to allow and give a warning for old-style code that would
1110 otherwise be invalid, or have different behavior.
1112 @item -fno-gnu-keywords
1113 Do not recognize @code{typeof} as a keyword, so that code can use this
1114 word as an identifier. You can use the keyword @code{__typeof__} instead.  
1115 @samp{-ansi} implies @samp{-fno-gnu-keywords}.
1117 @item -fhonor-std
1118 Treat the @code{namespace std} as a namespace, instead of ignoring
1119 it. For compatibility with earlier versions of g++, the compiler will,
1120 by default, ignore @code{namespace-declarations},
1121 @code{using-declarations}, @code{using-directives}, and
1122 @code{namespace-names}, if they involve @code{std}.
1124 @item -fhuge-objects
1125 Support virtual function calls for objects that exceed the size
1126 representable by a @samp{short int}.  Users should not use this flag by
1127 default; if you need to use it, the compiler will tell you so.
1129 This flag is not useful when compiling with -fvtable-thunks.
1131 Like all options that change the ABI, all C++ code, @emph{including
1132 libgcc} must be built with the same setting of this option.
1134 @item -fno-implicit-templates
1135 Never emit code for non-inline templates which are instantiated
1136 implicitly (i.e. by use); only emit code for explicit instantiations.
1137 @xref{Template Instantiation}, for more information.
1139 @item -fno-implicit-inline-templates
1140 Don't emit code for implicit instantiations of inline templates, either.
1141 The default is to handle inlines differently so that compiles with and
1142 without optimization will need the same set of explicit instantiations.
1144 @item -finit-priority
1145 Support @samp{__attribute__ ((init_priority (n)))} for controlling the
1146 order of initialization of file-scope objects.  On ELF targets, this
1147 requires GNU ld 2.10 or later.
1149 @item -fno-implement-inlines
1150 To save space, do not emit out-of-line copies of inline functions
1151 controlled by @samp{#pragma implementation}.  This will cause linker
1152 errors if these functions are not inlined everywhere they are called.
1154 @item -fms-extensions
1155 Disable pedwarns about constructs used in MFC, such as implicit int and
1156 getting a pointer to member function via non-standard syntax.
1158 @item -fname-mangling-version-@var{n}
1159 Control the way in which names are mangled.  Version 0 is compatible
1160 with versions of g++ before 2.8.  Version 1 is the default.  Version 1
1161 will allow correct mangling of function templates.  For example, 
1162 version 0 mangling does not mangle foo<int, double> and foo<int, char>
1163 given this declaration:
1165 @example
1166 template <class T, class U> void foo(T t);
1167 @end example
1169 Like all options that change the ABI, all C++ code, @emph{including
1170 libgcc} must be built with the same setting of this option.
1172 @item -fno-operator-names
1173 Do not treat the operator name keywords @code{and}, @code{bitand},
1174 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1175 synonyms as keywords.
1177 @item -fno-optional-diags
1178 Disable diagnostics that the standard says a compiler does not need to
1179 issue.  Currently, the only such diagnostic issued by g++ is the one for
1180 a name having multiple meanings within a class.
1182 @item -fpermissive
1183 Downgrade messages about nonconformant code from errors to warnings.  By
1184 default, g++ effectively sets @samp{-pedantic-errors} without
1185 @samp{-pedantic}; this option reverses that.  This behavior and this
1186 option are superseded by @samp{-pedantic}, which works as it does for GNU C.
1188 @item -frepo
1189 Enable automatic template instantiation.  This option also implies
1190 @samp{-fno-implicit-templates}.  @xref{Template Instantiation}, for more
1191 information.
1193 @item -fno-rtti
1194 Disable generation of information about every class with virtual
1195 functions for use by the C++ runtime type identification features
1196 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1197 of the language, you can save some space by using this flag.  Note that
1198 exception handling uses the same information, but it will generate it as
1199 needed.
1201 @item -fstrict-prototype
1202 Within an @samp{extern "C"} linkage specification, treat a function
1203 declaration with no arguments, such as @samp{int foo ();}, as declaring
1204 the function to take no arguments.  Normally, such a declaration means
1205 that the function @code{foo} can take any combination of arguments, as
1206 in C.  @samp{-pedantic} implies @samp{-fstrict-prototype} unless
1207 overridden with @samp{-fno-strict-prototype}.
1209 Specifying this option will also suppress implicit declarations of
1210 functions.
1212 This flag no longer affects declarations with C++ linkage.
1214 @item -fsquangle
1215 @itemx -fno-squangle
1216 @samp{-fsquangle} will enable a compressed form of name mangling for
1217 identifiers. In particular, it helps to shorten very long names by recognizing
1218 types and class names which occur more than once, replacing them with special
1219 short ID codes.  This option also requires any C++ libraries being used to
1220 be compiled with this option as well.  The compiler has this disabled (the
1221 equivalent of @samp{-fno-squangle}) by default.
1223 Like all options that change the ABI, all C++ code, @emph{including
1224 libgcc.a} must be built with the same setting of this option.
1226 @item -ftemplate-depth-@var{n}
1227 Set the maximum instantiation depth for template classes to @var{n}.
1228 A limit on the template instantiation depth is needed to detect
1229 endless recursions during template class instantiation. ANSI/ISO C++
1230 conforming programs must not rely on a maximum depth greater than 17.
1232 @item -fuse-cxa-atexit
1233 Register destructors for objects with static storage duration with the
1234 @code{__cxa_atexit} function rather than the @code{atexit} function.
1235 This option is required for fully standards-compliant handling of static
1236 destructors, but will only work if your C library supports
1237 @code{__cxa_atexit}.
1239 @item -fvtable-thunks
1240 Use @samp{thunks} to implement the virtual function dispatch table
1241 (@samp{vtable}).  The traditional (cfront-style) approach to
1242 implementing vtables was to store a pointer to the function and two
1243 offsets for adjusting the @samp{this} pointer at the call site.  Newer
1244 implementations store a single pointer to a @samp{thunk} function which
1245 does any necessary adjustment and then calls the target function.
1247 This option also enables a heuristic for controlling emission of
1248 vtables; if a class has any non-inline virtual functions, the vtable
1249 will be emitted in the translation unit containing the first one of
1250 those.
1252 Like all options that change the ABI, all C++ code, @emph{including
1253 libgcc.a} must be built with the same setting of this option.
1255 @item -nostdinc++
1256 Do not search for header files in the standard directories specific to
1257 C++, but do still search the other standard directories.  (This option
1258 is used when building the C++ library.)
1259 @end table
1261 In addition, these optimization, warning, and code generation options
1262 have meanings only for C++ programs:
1264 @table @code
1265 @item -fno-default-inline
1266 Do not assume @samp{inline} for functions defined inside a class scope.
1267 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1268 functions will have linkage like inline functions; they just won't be
1269 inlined by default.
1271 @item -Wctor-dtor-privacy (C++ only)
1272 Warn when a class seems unusable, because all the constructors or
1273 destructors in a class are private and the class has no friends or
1274 public static member functions.
1276 @item -Wnon-virtual-dtor (C++ only)
1277 Warn when a class declares a non-virtual destructor that should probably
1278 be virtual, because it looks like the class will be used polymorphically.
1280 @item -Wreorder (C++ only)
1281 @cindex reordering, warning
1282 @cindex warning for reordering of member initializers
1283 Warn when the order of member initializers given in the code does not
1284 match the order in which they must be executed.  For instance:
1286 @smallexample
1287 struct A @{
1288   int i;
1289   int j;
1290   A(): j (0), i (1) @{ @}
1292 @end smallexample
1294 Here the compiler will warn that the member initializers for @samp{i}
1295 and @samp{j} will be rearranged to match the declaration order of the
1296 members.
1297 @end table
1299 The following @samp{-W@dots{}} options are not affected by @samp{-Wall}.
1301 @table @code
1302 @item -Weffc++ (C++ only)
1303 Warn about violations of various style guidelines from Scott Meyers'
1304 @cite{Effective C++} books.  If you use this option, you should be aware
1305 that the standard library headers do not obey all of these guidelines;
1306 you can use @samp{grep -v} to filter out those warnings.
1308 @item -Wno-deprecated (C++ only)
1309 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1311 @item -Wno-non-template-friend (C++ only)
1312 Disable warnings when non-templatized friend functions are declared
1313 within a template. With the advent of explicit template specification
1314 support in g++, if the name of the friend is an unqualified-id (ie,
1315 @samp{friend foo(int)}), the C++ language specification demands that the
1316 friend declare or define an ordinary, nontemplate function. (Section
1317 14.5.3). Before g++ implemented explicit specification, unqualified-ids
1318 could be interpreted as a particular specialization of a templatized
1319 function. Because this non-conforming behavior is no longer the default
1320 behavior for g++, @samp{-Wnon-template-friend} allows the compiler to
1321 check existing code for potential trouble spots, and is on by default.
1322 This new compiler behavior can be turned off with
1323 @samp{-Wno-non-template-friend} which keeps the conformant compiler code
1324 but disables the helpful warning.
1326 @item -Wold-style-cast (C++ only)
1327 Warn if an old-style (C-style) cast is used within a C++ program.  The
1328 new-style casts (@samp{static_cast}, @samp{reinterpret_cast}, and
1329 @samp{const_cast}) are less vulnerable to unintended effects.
1331 @item -Woverloaded-virtual (C++ only)
1332 @cindex overloaded virtual fn, warning
1333 @cindex warning for overloaded virtual fn
1334 Warn when a derived class function declaration may be an error in
1335 defining a virtual function.  In a derived class, the
1336 definitions of virtual functions must match the type signature of a
1337 virtual function declared in the base class.  With this option, the
1338 compiler warns when you define a function with the same name as a
1339 virtual function, but with a type signature that does not match any
1340 declarations from the base class.
1342 @item -Wno-pmf-conversions (C++ only)
1343 Disable the diagnostic for converting a bound pointer to member function
1344 to a plain pointer.
1346 @item -Wsign-promo (C++ only)
1347 Warn when overload resolution chooses a promotion from unsigned or
1348 enumeral type to a signed type over a conversion to an unsigned type of
1349 the same size.  Previous versions of g++ would try to preserve
1350 unsignedness, but the standard mandates the current behavior.
1352 @item -Wsynth (C++ only)
1353 @cindex warning for synthesized methods
1354 @cindex synthesized methods, warning
1355 Warn when g++'s synthesis behavior does not match that of cfront.  For
1356 instance:
1358 @smallexample
1359 struct A @{
1360   operator int ();
1361   A& operator = (int);
1364 main ()
1366   A a,b;
1367   a = b;
1369 @end smallexample
1371 In this example, g++ will synthesize a default @samp{A& operator =
1372 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1373 @end table
1375 @node Language Independent Options
1376 @section Options to Control Diagnostic Messages Formatting
1377 @cindex options to control diagnostics formatting
1378 @cindex diagnostic messages
1379 @cindex message formatting
1381 Traditionally, diagnostic messages have been formatted irrespective of
1382 the output device's aspect (e.g. its width, ...).  The options described
1383 below can be used to control the diagnostic messages formatting
1384 algorithm, e.g. how many characters per line, how often source location
1385 information should be reported.  Right now, only the C++ front-end can
1386 honor these options.  However it is expected, in the near future, that
1387 the remaining front-ends would be able to digest them correctly. 
1389 @table @code
1390 @item -fmessage-length=@var{n}
1391 Try to format error messages so that they fit on lines of about @var{n}
1392 characters.  The default is 72 characters for g++ and 0 for the rest of
1393 the front-ends supported by GCC.  If @var{n} is zero, then no
1394 line-wrapping will be done; each error message will appear on a single 
1395 line.
1397 @item -fdiagnostics-show-location=once
1398 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1399 reporter to emit @emph{once} source location information; that is, in
1400 case the message is too long to fit on a single physical line and has to
1401 be wrapped, the source location won't be emitted (as prefix) again,
1402 over and over, in subsequent continuation lines.  This is the default
1403 behaviour. 
1405 @item -fdiagnostics-show-location=every-line
1406 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1407 messages reporter to emit the same source location information (as
1408 prefix) for physical lines that result from the process of breaking a
1409 a message which is too long to fit on a single line.
1411 @end table
1413 @node Warning Options
1414 @section Options to Request or Suppress Warnings
1415 @cindex options to control warnings
1416 @cindex warning messages
1417 @cindex messages, warning
1418 @cindex suppressing warnings
1420 Warnings are diagnostic messages that report constructions which
1421 are not inherently erroneous but which are risky or suggest there
1422 may have been an error.
1424 You can request many specific warnings with options beginning @samp{-W},
1425 for example @samp{-Wimplicit} to request warnings on implicit
1426 declarations.  Each of these specific warning options also has a
1427 negative form beginning @samp{-Wno-} to turn off warnings;
1428 for example, @samp{-Wno-implicit}.  This manual lists only one of the
1429 two forms, whichever is not the default.
1431 These options control the amount and kinds of warnings produced by GCC:
1433 @table @code
1434 @cindex syntax checking
1435 @item -fsyntax-only
1436 Check the code for syntax errors, but don't do anything beyond that.
1438 @item -pedantic
1439 Issue all the warnings demanded by strict ANSI C and ISO C++;
1440 reject all programs that use forbidden extensions.
1442 Valid ANSI C and ISO C++ programs should compile properly with or without
1443 this option (though a rare few will require @samp{-ansi}).  However,
1444 without this option, certain GNU extensions and traditional C and C++
1445 features are supported as well.  With this option, they are rejected.
1447 @samp{-pedantic} does not cause warning messages for use of the
1448 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1449 warnings are also disabled in the expression that follows
1450 @code{__extension__}.  However, only system header files should use
1451 these escape routes; application programs should avoid them.
1452 @xref{Alternate Keywords}.
1454 This option is not intended to be @i{useful}; it exists only to satisfy
1455 pedants who would otherwise claim that GCC fails to support the ANSI
1456 standard.
1458 Some users try to use @samp{-pedantic} to check programs for strict ANSI
1459 C conformance.  They soon find that it does not do quite what they want:
1460 it finds some non-ANSI practices, but not all---only those for which
1461 ANSI C @emph{requires} a diagnostic.
1463 A feature to report any failure to conform to ANSI C might be useful in
1464 some instances, but would require considerable additional work and would
1465 be quite different from @samp{-pedantic}.  We don't have plans to
1466 support such a feature in the near future.
1468 @item -pedantic-errors
1469 Like @samp{-pedantic}, except that errors are produced rather than
1470 warnings.
1472 @item -w
1473 Inhibit all warning messages.
1475 @item -Wno-import
1476 Inhibit warning messages about the use of @samp{#import}.
1478 @item -Wchar-subscripts
1479 Warn if an array subscript has type @code{char}.  This is a common cause
1480 of error, as programmers often forget that this type is signed on some
1481 machines.
1483 @item -Wcomment
1484 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1485 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1487 @item -Wformat
1488 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1489 the arguments supplied have types appropriate to the format string
1490 specified.
1492 @item -Wimplicit-int
1493 Warn when a declaration does not specify a type.
1495 @item -Wimplicit-function-declaration
1496 @itemx -Werror-implicit-function-declaration
1497 Give a warning (or error) whenever a function is used before being
1498 declared.
1500 @item -Wimplicit
1501 Same as @samp{-Wimplicit-int} and @samp{-Wimplicit-function-}@*
1502 @samp{declaration}.
1504 @item -Wmain
1505 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
1506 function with external linkage, returning int, taking either zero
1507 arguments, two, or three arguments of appropriate types.
1509 @item -Wmultichar
1510 Warn if a multicharacter constant (@samp{'FOOF'}) is used.  Usually they
1511 indicate a typo in the user's code, as they have implementation-defined
1512 values, and should not be used in portable code.
1514 @item -Wparentheses
1515 Warn if parentheses are omitted in certain contexts, such
1516 as when there is an assignment in a context where a truth value
1517 is expected, or when operators are nested whose precedence people
1518 often get confused about.
1520 Also warn about constructions where there may be confusion to which
1521 @code{if} statement an @code{else} branch belongs.  Here is an example of
1522 such a case:
1524 @smallexample
1526   if (a)
1527     if (b)
1528       foo ();
1529   else
1530     bar ();
1532 @end smallexample
1534 In C, every @code{else} branch belongs to the innermost possible @code{if}
1535 statement, which in this example is @code{if (b)}.  This is often not
1536 what the programmer expected, as illustrated in the above example by
1537 indentation the programmer chose.  When there is the potential for this
1538 confusion, GNU C will issue a warning when this flag is specified.
1539 To eliminate the warning, add explicit braces around the innermost
1540 @code{if} statement so there is no way the @code{else} could belong to
1541 the enclosing @code{if}.  The resulting code would look like this:
1543 @smallexample
1545   if (a)
1546     @{
1547       if (b)
1548         foo ();
1549       else
1550         bar ();
1551     @}
1553 @end smallexample
1555 @item -Wreturn-type
1556 Warn whenever a function is defined with a return-type that defaults to
1557 @code{int}.  Also warn about any @code{return} statement with no
1558 return-value in a function whose return-type is not @code{void}. 
1560 For C++, a function without return type always produces a diagnostic
1561 message, even when @samp{-Wno-return-type} is specified. The only
1562 exceptions are @samp{main} and functions defined in system headers.
1564 @item -Wswitch
1565 Warn whenever a @code{switch} statement has an index of enumeral type
1566 and lacks a @code{case} for one or more of the named codes of that
1567 enumeration.  (The presence of a @code{default} label prevents this
1568 warning.)  @code{case} labels outside the enumeration range also
1569 provoke warnings when this option is used.
1571 @item -Wtrigraphs
1572 Warn if any trigraphs are encountered (assuming they are enabled).
1574 @item -Wunused-function
1575 Warn whenever a static function is declared but not defined or a
1576 non\-inline static function is unused.
1578 @item -Wunused-label
1579 Warn whenever a label is declared but not used.
1581 To suppress this warning use the @samp{unused} attribute
1582 (@pxref{Variable Attributes}).
1584 @item -Wunused-parameter
1585 Warn whenever a function parameter is unused aside from its declaration.
1587 To suppress this warning use the @samp{unused} attribute
1588 (@pxref{Variable Attributes}).
1590 @item -Wunused-variable
1591 Warn whenever a local variable or non-constant static variable is unused
1592 aside from its declaration
1594 To suppress this warning use the @samp{unused} attribute
1595 (@pxref{Variable Attributes}).
1597 @item -Wunused-value
1598 Warn whenever a statement computes a result that is explicitly not used.
1600 To suppress this warning cast the expression to @samp{void}.
1602 @item -Wunused
1603 All all the above @samp{-Wunused} options combined.
1605 In order to get a warning about an unused function parameter, you must
1606 either specify @samp{-W -Wunused} or separately specify
1607 @samp{-Wunused-parameter}.
1609 @item -Wuninitialized
1610 Warn if an automatic variable is used without first being initialized or
1611 if a variable may be clobbered by a @code{setjmp} call.
1613 These warnings are possible only in optimizing compilation,
1614 because they require data flow information that is computed only
1615 when optimizing.  If you don't specify @samp{-O}, you simply won't
1616 get these warnings.
1618 These warnings occur only for variables that are candidates for
1619 register allocation.  Therefore, they do not occur for a variable that
1620 is declared @code{volatile}, or whose address is taken, or whose size
1621 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
1622 structures, unions or arrays, even when they are in registers.
1624 Note that there may be no warning about a variable that is used only
1625 to compute a value that itself is never used, because such
1626 computations may be deleted by data flow analysis before the warnings
1627 are printed.
1629 These warnings are made optional because GCC is not smart
1630 enough to see all the reasons why the code might be correct
1631 despite appearing to have an error.  Here is one example of how
1632 this can happen:
1634 @smallexample
1636   int x;
1637   switch (y)
1638     @{
1639     case 1: x = 1;
1640       break;
1641     case 2: x = 4;
1642       break;
1643     case 3: x = 5;
1644     @}
1645   foo (x);
1647 @end smallexample
1649 @noindent
1650 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
1651 always initialized, but GCC doesn't know this.  Here is
1652 another common case:
1654 @smallexample
1656   int save_y;
1657   if (change_y) save_y = y, y = new_y;
1658   @dots{}
1659   if (change_y) y = save_y;
1661 @end smallexample
1663 @noindent
1664 This has no bug because @code{save_y} is used only if it is set.
1666 @cindex @code{longjmp} warnings
1667 This option also warns when a non-volatile automatic variable might be
1668 changed by a call to @code{longjmp}.  These warnings as well are possible
1669 only in optimizing compilation.
1671 The compiler sees only the calls to @code{setjmp}.  It cannot know
1672 where @code{longjmp} will be called; in fact, a signal handler could
1673 call it at any point in the code.  As a result, you may get a warning
1674 even when there is in fact no problem because @code{longjmp} cannot
1675 in fact be called at the place which would cause a problem.
1677 Some spurious warnings can be avoided if you declare all the functions
1678 you use that never return as @code{noreturn}.  @xref{Function
1679 Attributes}.
1681 @item -Wreorder (C++ only)
1682 @cindex reordering, warning
1683 @cindex warning for reordering of member initializers
1684 Warn when the order of member initializers given in the code does not
1685 match the order in which they must be executed.  For instance:
1687 @item -Wunknown-pragmas
1688 @cindex warning for unknown pragmas
1689 @cindex unknown pragmas, warning
1690 @cindex pragmas, warning of unknown
1691 Warn when a #pragma directive is encountered which is not understood by
1692 GCC.  If this command line option is used, warnings will even be issued
1693 for unknown pragmas in system header files.  This is not the case if
1694 the warnings were only enabled by the @samp{-Wall} command line option.
1696 @item -Wall
1697 All of the above @samp{-W} options combined.  This enables all the
1698 warnings about constructions that some users consider questionable, and
1699 that are easy to avoid (or modify to prevent the warning), even in
1700 conjunction with macros.
1701 @end table
1703 The following @samp{-W@dots{}} options are not implied by @samp{-Wall}.
1704 Some of them warn about constructions that users generally do not
1705 consider questionable, but which occasionally you might wish to check
1706 for; others warn about constructions that are necessary or hard to avoid
1707 in some cases, and there is no simple way to modify the code to suppress
1708 the warning.
1710 @table @code
1711 @item -W
1712 Print extra warning messages for these events:
1714 @itemize @bullet
1715 @item
1716 A function can return either with or without a value.  (Falling
1717 off the end of the function body is considered returning without
1718 a value.)  For example, this function would evoke such a
1719 warning:
1721 @smallexample
1722 @group
1723 foo (a)
1725   if (a > 0)
1726     return a;
1728 @end group
1729 @end smallexample
1731 @item
1732 An expression-statement or the left-hand side of a comma expression
1733 contains no side effects.
1734 To suppress the warning, cast the unused expression to void.
1735 For example, an expression such as @samp{x[i,j]} will cause a warning,
1736 but @samp{x[(void)i,j]} will not.
1738 @item
1739 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
1741 @item
1742 A comparison like @samp{x<=y<=z} appears; this is equivalent to
1743 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
1744 that of ordinary mathematical notation.
1746 @item
1747 Storage-class specifiers like @code{static} are not the first things in
1748 a declaration.  According to the C Standard, this usage is obsolescent.
1750 @item
1751 If @samp{-Wall} or @samp{-Wunused} is also specified, warn about unused
1752 arguments.
1754 @item
1755 A comparison between signed and unsigned values could produce an
1756 incorrect result when the signed value is converted to unsigned.
1757 (But don't warn if @samp{-Wno-sign-compare} is also specified.)
1759 @item
1760 An aggregate has a partly bracketed initializer.
1761 For example, the following code would evoke such a warning,
1762 because braces are missing around the initializer for @code{x.h}:
1764 @smallexample
1765 struct s @{ int f, g; @};
1766 struct t @{ struct s h; int i; @};
1767 struct t x = @{ 1, 2, 3 @};
1768 @end smallexample
1770 @item
1771 An aggregate has an initializer which does not initialize all members.
1772 For example, the following code would cause such a warning, because
1773 @code{x.h} would be implicitly initialized to zero:
1775 @smallexample
1776 struct s @{ int f, g, h; @};
1777 struct s x = @{ 3, 4 @};
1778 @end smallexample
1779 @end itemize
1781 @item -Wfloat-equal
1782 Warn if floating point values are used in equality comparisons.
1784 The idea behind this is that sometimes it is convenient (for the
1785 programmer) to consider floating-point values as approximations to
1786 infinitely precise real numbers.  If you are doing this, then you need
1787 to compute (by analysing the code, or in some other way) the maximum or
1788 likely maximum error that the computation introduces, and allow for it
1789 when performing comparisons (and when producing output, but that's a
1790 different problem).  In particular, instead of testing for equality, you
1791 would check to see whether the two values have ranges that overlap; and
1792 this is done with the relational operators, so equality comparisons are
1793 probably mistaken.
1795 @item -Wtraditional (C only)
1796 Warn about certain constructs that behave differently in traditional and
1797 ANSI C.
1799 @itemize @bullet
1800 @item
1801 Macro arguments occurring within string constants in the macro body.
1802 These would substitute the argument in traditional C, but are part of
1803 the constant in ANSI C.
1805 @item
1806 A function declared external in one block and then used after the end of
1807 the block.
1809 @item
1810 A @code{switch} statement has an operand of type @code{long}.
1812 @item
1813 A non-@code{static} function declaration follows a @code{static} one.
1814 This construct is not accepted by some traditional C compilers.
1816 @item
1817 The ANSI type of an integer constant has a different width or
1818 signedness from its traditional type.  This warning is only issued if
1819 the base of the constant is ten.  I.e. hexadecimal or octal values, which
1820 typically represent bit patterns, are not warned about.
1822 @item
1823 Usage of ANSI string concatenation is detected.
1825 @item
1826 A function macro appears without arguments.
1827 @end itemize
1829 @item -Wundef
1830 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
1832 @item -Wshadow
1833 Warn whenever a local variable shadows another local variable.
1835 @item -Wid-clash-@var{len}
1836 Warn whenever two distinct identifiers match in the first @var{len}
1837 characters.  This may help you prepare a program that will compile
1838 with certain obsolete, brain-damaged compilers.
1840 @item -Wlarger-than-@var{len}
1841 Warn whenever an object of larger than @var{len} bytes is defined.
1843 @item -Wpointer-arith
1844 Warn about anything that depends on the ``size of'' a function type or
1845 of @code{void}.  GNU C assigns these types a size of 1, for
1846 convenience in calculations with @code{void *} pointers and pointers
1847 to functions.
1849 @item -Wbad-function-cast (C only)
1850 Warn whenever a function call is cast to a non-matching type.
1851 For example, warn if @code{int malloc()} is cast to @code{anything *}.
1853 @item -Wcast-qual
1854 Warn whenever a pointer is cast so as to remove a type qualifier from
1855 the target type.  For example, warn if a @code{const char *} is cast
1856 to an ordinary @code{char *}.
1858 @item -Wcast-align
1859 Warn whenever a pointer is cast such that the required alignment of the
1860 target is increased.  For example, warn if a @code{char *} is cast to
1861 an @code{int *} on machines where integers can only be accessed at
1862 two- or four-byte boundaries.
1864 @item -Wwrite-strings
1865 Give string constants the type @code{const char[@var{length}]} so that
1866 copying the address of one into a non-@code{const} @code{char *}
1867 pointer will get a warning.  These warnings will help you find at
1868 compile time code that can try to write into a string constant, but
1869 only if you have been very careful about using @code{const} in
1870 declarations and prototypes.  Otherwise, it will just be a nuisance;
1871 this is why we did not make @samp{-Wall} request these warnings.
1873 @item -Wconversion
1874 Warn if a prototype causes a type conversion that is different from what
1875 would happen to the same argument in the absence of a prototype.  This
1876 includes conversions of fixed point to floating and vice versa, and
1877 conversions changing the width or signedness of a fixed point argument
1878 except when the same as the default promotion.
1880 Also, warn if a negative integer constant expression is implicitly
1881 converted to an unsigned type.  For example, warn about the assignment
1882 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
1883 casts like @code{(unsigned) -1}.
1885 @item -Wsign-compare
1886 @cindex warning for comparison of signed and unsigned values
1887 @cindex comparison of signed and unsigned values, warning
1888 @cindex signed and unsigned values, comparison warning
1889 Warn when a comparison between signed and unsigned values could produce
1890 an incorrect result when the signed value is converted to unsigned.
1891 This warning is also enabled by @samp{-W}; to get the other warnings
1892 of @samp{-W} without this warning, use @samp{-W -Wno-sign-compare}.
1894 @item -Waggregate-return
1895 Warn if any functions that return structures or unions are defined or
1896 called.  (In languages where you can return an array, this also elicits
1897 a warning.)
1899 @item -Wstrict-prototypes (C only)
1900 Warn if a function is declared or defined without specifying the
1901 argument types.  (An old-style function definition is permitted without
1902 a warning if preceded by a declaration which specifies the argument
1903 types.)
1905 @item -Wmissing-prototypes (C only)
1906 Warn if a global function is defined without a previous prototype
1907 declaration.  This warning is issued even if the definition itself
1908 provides a prototype.  The aim is to detect global functions that fail
1909 to be declared in header files.
1911 @item -Wmissing-declarations
1912 Warn if a global function is defined without a previous declaration.
1913 Do so even if the definition itself provides a prototype.
1914 Use this option to detect global functions that are not declared in
1915 header files.
1917 @item -Wmissing-noreturn
1918 Warn about functions which might be candidates for attribute @code{noreturn}.
1919 Note these are only possible candidates, not absolute ones.  Care should
1920 be taken to manually verify functions actually do not ever return before
1921 adding the @code{noreturn} attribute, otherwise subtle code generation
1922 bugs could be introduced.
1924 @item -Wpacked
1925 Warn if a structure is given the packed attribute, but the packed
1926 attribute has no effect on the layout or size of the structure.  
1927 Such structures may be mis-aligned for little benefit.  For
1928 instance, in this code, the variable @code{f.x} in @code{struct bar}
1929 will be misaligned even though @code{struct bar} does not itself
1930 have the packed attribute:
1932 @smallexample
1933 @group
1934 struct foo @{
1935   int x;
1936   char a, b, c, d;
1937 @} __attribute__((packed));
1938 struct bar @{
1939   char z;
1940   struct foo f;
1942 @end group
1943 @end smallexample
1945 @item -Wpadded
1946 Warn if padding is included in a structure, either to align an element
1947 of the structure or to align the whole structure.  Sometimes when this
1948 happens it is possible to rearrange the fields of the structure to
1949 reduce the padding and so make the structure smaller.
1951 @item -Wredundant-decls
1952 Warn if anything is declared more than once in the same scope, even in
1953 cases where multiple declaration is valid and changes nothing.
1955 @item -Wnested-externs (C only)
1956 Warn if an @code{extern} declaration is encountered within a function.
1958 @item -Wunreachable-code
1959 Warn if the compiler detects that code will never be executed.
1961 This option is intended to warn when the compiler detects that at
1962 least a whole line of source code will never be executed, because
1963 some condition is never satisfied or because it is after a
1964 procedure that never returns.
1966 It is possible for this option to produce a warning even though there
1967 are circumstances under which part of the affected line can be executed,
1968 so care should be taken when removing apparently-unreachable code.
1970 For instance, when a function is inlined, a warning may mean that the
1971 line is unreachable in only one inlined copy of the function.  
1973 This option is not made part of @samp{-Wall} because in a debugging
1974 version of a program there is often substantial code which checks
1975 correct functioning of the program and is, hopefully, unreachable
1976 because the program does work.  Another common use of unreachable
1977 code is to provide behaviour which is selectable at compile-time.
1979 @item -Winline
1980 Warn if a function can not be inlined and it was declared as inline.
1982 @item -Wlong-long
1983 Warn if @samp{long long} type is used.  This is default.  To inhibit
1984 the warning messages, use @samp{-Wno-long-long}.  Flags
1985 @samp{-Wlong-long} and @samp{-Wno-long-long} are taken into account
1986 only when @samp{-pedantic} flag is used.
1988 @item -Werror
1989 Make all warnings into errors.
1990 @end table
1992 @node Debugging Options
1993 @section Options for Debugging Your Program or GCC
1994 @cindex options, debugging
1995 @cindex debugging information options
1997 GCC has various special options that are used for debugging
1998 either your program or GCC:
2000 @table @code
2001 @item -g
2002 Produce debugging information in the operating system's native format
2003 (stabs, COFF, XCOFF, or DWARF).  GDB can work with this debugging
2004 information.
2006 On most systems that use stabs format, @samp{-g} enables use of extra
2007 debugging information that only GDB can use; this extra information
2008 makes debugging work better in GDB but will probably make other debuggers
2009 crash or
2010 refuse to read the program.  If you want to control for certain whether
2011 to generate the extra information, use @samp{-gstabs+}, @samp{-gstabs},
2012 @samp{-gxcoff+}, @samp{-gxcoff}, @samp{-gdwarf-1+}, or @samp{-gdwarf-1}
2013 (see below).
2015 Unlike most other C compilers, GCC allows you to use @samp{-g} with
2016 @samp{-O}.  The shortcuts taken by optimized code may occasionally
2017 produce surprising results: some variables you declared may not exist
2018 at all; flow of control may briefly move where you did not expect it;
2019 some statements may not be executed because they compute constant
2020 results or their values were already at hand; some statements may
2021 execute in different places because they were moved out of loops.
2023 Nevertheless it proves possible to debug optimized output.  This makes
2024 it reasonable to use the optimizer for programs that might have bugs.
2026 The following options are useful when GCC is generated with the
2027 capability for more than one debugging format.
2029 @item -ggdb
2030 Produce debugging information for use by GDB.  This means to use the
2031 most expressive format available (DWARF 2, stabs, or the native format
2032 if neither of those are supported), including GDB extensions if at all
2033 possible.
2035 @item -gstabs
2036 Produce debugging information in stabs format (if that is supported),
2037 without GDB extensions.  This is the format used by DBX on most BSD
2038 systems.  On MIPS, Alpha and System V Release 4 systems this option
2039 produces stabs debugging output which is not understood by DBX or SDB.
2040 On System V Release 4 systems this option requires the GNU assembler.
2042 @item -gstabs+
2043 Produce debugging information in stabs format (if that is supported),
2044 using GNU extensions understood only by the GNU debugger (GDB).  The
2045 use of these extensions is likely to make other debuggers crash or
2046 refuse to read the program.
2048 @item -gcoff
2049 Produce debugging information in COFF format (if that is supported).
2050 This is the format used by SDB on most System V systems prior to
2051 System V Release 4.
2053 @item -gxcoff
2054 Produce debugging information in XCOFF format (if that is supported).
2055 This is the format used by the DBX debugger on IBM RS/6000 systems.
2057 @item -gxcoff+
2058 Produce debugging information in XCOFF format (if that is supported),
2059 using GNU extensions understood only by the GNU debugger (GDB).  The
2060 use of these extensions is likely to make other debuggers crash or
2061 refuse to read the program, and may cause assemblers other than the GNU
2062 assembler (GAS) to fail with an error.
2064 @item -gdwarf
2065 Produce debugging information in DWARF version 1 format (if that is
2066 supported).  This is the format used by SDB on most System V Release 4
2067 systems.
2069 @item -gdwarf+
2070 Produce debugging information in DWARF version 1 format (if that is
2071 supported), using GNU extensions understood only by the GNU debugger
2072 (GDB).  The use of these extensions is likely to make other debuggers
2073 crash or refuse to read the program.
2075 @item -gdwarf-2
2076 Produce debugging information in DWARF version 2 format (if that is
2077 supported).  This is the format used by DBX on IRIX 6.
2079 @item -g@var{level}
2080 @itemx -ggdb@var{level}
2081 @itemx -gstabs@var{level}
2082 @itemx -gcoff@var{level}
2083 @itemx -gxcoff@var{level}
2084 @itemx -gdwarf@var{level}
2085 @itemx -gdwarf-2@var{level}
2086 Request debugging information and also use @var{level} to specify how
2087 much information.  The default level is 2.
2089 Level 1 produces minimal information, enough for making backtraces in
2090 parts of the program that you don't plan to debug.  This includes
2091 descriptions of functions and external variables, but no information
2092 about local variables and no line numbers.
2094 Level 3 includes extra information, such as all the macro definitions
2095 present in the program.  Some debuggers support macro expansion when
2096 you use @samp{-g3}.
2098 @cindex @code{prof}
2099 @item -p
2100 Generate extra code to write profile information suitable for the
2101 analysis program @code{prof}.  You must use this option when compiling
2102 the source files you want data about, and you must also use it when
2103 linking.
2105 @cindex @code{gprof}
2106 @item -pg
2107 Generate extra code to write profile information suitable for the
2108 analysis program @code{gprof}.  You must use this option when compiling
2109 the source files you want data about, and you must also use it when
2110 linking.
2112 @cindex @code{tcov}
2113 @item -a
2114 Generate extra code to write profile information for basic blocks, which will
2115 record the number of times each basic block is executed, the basic block start
2116 address, and the function name containing the basic block.  If @samp{-g} is
2117 used, the line number and filename of the start of the basic block will also be
2118 recorded.  If not overridden by the machine description, the default action is
2119 to append to the text file @file{bb.out}.
2121 This data could be analyzed by a program like @code{tcov}.  Note,
2122 however, that the format of the data is not what @code{tcov} expects.
2123 Eventually GNU @code{gprof} should be extended to process this data.
2125 @item -Q
2126 Makes the compiler print out each function name as it is compiled, and
2127 print some statistics about each pass when it finishes.
2129 @item -ax
2130 Generate extra code to profile basic blocks.  Your executable will
2131 produce output that is a superset of that produced when @samp{-a} is
2132 used.  Additional output is the source and target address of the basic
2133 blocks where a jump takes place, the number of times a jump is executed,
2134 and (optionally) the complete sequence of basic blocks being executed.
2135 The output is appended to file @file{bb.out}.
2137 You can examine different profiling aspects without recompilation.  Your
2138 executable will read a list of function names from file @file{bb.in}.
2139 Profiling starts when a function on the list is entered and stops when
2140 that invocation is exited.  To exclude a function from profiling, prefix
2141 its name with `-'.  If a function name is not unique, you can
2142 disambiguate it by writing it in the form
2143 @samp{/path/filename.d:functionname}.  Your executable will write the
2144 available paths and filenames in file @file{bb.out}.
2146 Several function names have a special meaning:
2147 @table @code
2148 @item __bb_jumps__
2149 Write source, target and frequency of jumps to file @file{bb.out}.
2150 @item __bb_hidecall__
2151 Exclude function calls from frequency count.
2152 @item __bb_showret__
2153 Include function returns in frequency count.
2154 @item __bb_trace__
2155 Write the sequence of basic blocks executed to file @file{bbtrace.gz}.
2156 The file will be compressed using the program @samp{gzip}, which must
2157 exist in your @code{PATH}.  On systems without the @samp{popen}
2158 function, the file will be named @file{bbtrace} and will not be
2159 compressed.  @strong{Profiling for even a few seconds on these systems
2160 will produce a very large file.}  Note: @code{__bb_hidecall__} and
2161 @code{__bb_showret__} will not affect the sequence written to
2162 @file{bbtrace.gz}.
2163 @end table
2165 Here's a short example using different profiling parameters
2166 in file @file{bb.in}.  Assume function @code{foo} consists of basic blocks
2167 1 and 2 and is called twice from block 3 of function @code{main}.  After
2168 the calls, block 3 transfers control to block 4 of @code{main}.
2170 With @code{__bb_trace__} and @code{main} contained in file @file{bb.in},
2171 the following sequence of blocks is written to file @file{bbtrace.gz}:
2172 0 3 1 2 1 2 4.  The return from block 2 to block 3 is not shown, because
2173 the return is to a point inside the block and not to the top.  The
2174 block address 0 always indicates, that control is transferred
2175 to the trace from somewhere outside the observed functions.  With
2176 @samp{-foo} added to @file{bb.in}, the blocks of function
2177 @code{foo} are removed from the trace, so only 0 3 4 remains.
2179 With @code{__bb_jumps__} and @code{main} contained in file @file{bb.in},
2180 jump frequencies will be written to file @file{bb.out}.  The
2181 frequencies are obtained by constructing a trace of blocks
2182 and incrementing a counter for every neighbouring pair of blocks
2183 in the trace.  The trace 0 3 1 2 1 2 4 displays the following
2184 frequencies:
2186 @example
2187 Jump from block 0x0 to block 0x3 executed 1 time(s)
2188 Jump from block 0x3 to block 0x1 executed 1 time(s)
2189 Jump from block 0x1 to block 0x2 executed 2 time(s)
2190 Jump from block 0x2 to block 0x1 executed 1 time(s)
2191 Jump from block 0x2 to block 0x4 executed 1 time(s)
2192 @end example
2194 With @code{__bb_hidecall__}, control transfer due to call instructions
2195 is removed from the trace, that is the trace is cut into three parts: 0
2196 3 4, 0 1 2 and 0 1 2.  With @code{__bb_showret__}, control transfer due
2197 to return instructions is added to the trace.  The trace becomes: 0 3 1
2198 2 3 1 2 3 4.  Note, that this trace is not the same, as the sequence
2199 written to @file{bbtrace.gz}.  It is solely used for counting jump
2200 frequencies.
2202 @item -fprofile-arcs
2203 Instrument @dfn{arcs} during compilation.  For each function of your
2204 program, GCC creates a program flow graph, then finds a spanning tree
2205 for the graph.  Only arcs that are not on the spanning tree have to be
2206 instrumented: the compiler adds code to count the number of times that these
2207 arcs are executed.  When an arc is the only exit or only entrance to a
2208 block, the instrumentation code can be added to the block; otherwise, a
2209 new basic block must be created to hold the instrumentation code.
2211 Since not every arc in the program must be instrumented, programs
2212 compiled with this option run faster than programs compiled with
2213 @samp{-a}, which adds instrumentation code to every basic block in the
2214 program.  The tradeoff: since @code{gcov} does not have
2215 execution counts for all branches, it must start with the execution
2216 counts for the instrumented branches, and then iterate over the program
2217 flow graph until the entire graph has been solved.  Hence, @code{gcov}
2218 runs a little more slowly than a program which uses information from
2219 @samp{-a}.
2221 @samp{-fprofile-arcs} also makes it possible to estimate branch
2222 probabilities, and to calculate basic block execution counts.  In
2223 general, basic block execution counts do not give enough information to
2224 estimate all branch probabilities.  When the compiled program exits, it
2225 saves the arc execution counts to a file called
2226 @file{@var{sourcename}.da}.  Use the compiler option
2227 @samp{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2228 Control Optimization}) when recompiling, to optimize using estimated
2229 branch probabilities.
2231 @need 2000
2232 @item -ftest-coverage
2233 Create data files for the @code{gcov} code-coverage utility
2234 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
2235 The data file names begin with the name of your source file:
2237 @table @code
2238 @item @var{sourcename}.bb
2239 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2240 associate basic block execution counts with line numbers.
2242 @item @var{sourcename}.bbg
2243 A list of all arcs in the program flow graph.  This allows @code{gcov}
2244 to reconstruct the program flow graph, so that it can compute all basic
2245 block and arc execution counts from the information in the
2246 @code{@var{sourcename}.da} file (this last file is the output from
2247 @samp{-fprofile-arcs}).
2248 @end table
2250 @item -d@var{letters}
2251 Says to make debugging dumps during compilation at times specified by
2252 @var{letters}.  This is used for debugging the compiler.  The file names
2253 for most of the dumps are made by appending a pass number and a word to
2254 the source file name (e.g.  @file{foo.c.00.rtl} or @file{foo.c.01.sibling}). 
2255 Here are the possible letters for use in @var{letters}, and their meanings:
2257 @table @samp
2258 @item A
2259 Annotate the assembler output with miscellaneous debugging information.
2260 @item b
2261 Dump after computing branch probabilities, to @file{@var{file}.11.bp}.
2262 @item B
2263 Dump after block reordering, to @file{@var{file}.24.bbro}.
2264 @item c
2265 Dump after instruction combination, to the file @file{@var{file}.13.combine}.
2266 @item d
2267 Dump after delayed branch scheduling, to @file{@var{file}.27.dbr}.
2268 @item D
2269 Dump all macro definitions, at the end of preprocessing, in addition to
2270 normal output.
2271 @item e
2272 Dump after SSA optimizations, to @file{@var{file}.05.ssa} and
2273 @file{@var{file}.06.ussa}.
2274 @item f
2275 Dump after life analysis, to @file{@var{file}.12.life}.
2276 @item F
2277 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.04.addressof}.
2278 @item g
2279 Dump after global register allocation, to @file{@var{file}.18.greg}.
2280 @item G      
2281 Dump after GCSE, to @file{@var{file}.07.gcse}.
2282 @item i
2283 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
2284 @item j
2285 Dump after first jump optimization, to @file{@var{file}.02.jump}.
2286 @item J
2287 Dump after last jump optimization, to @file{@var{file}.25.jump2}.
2288 @item k
2289 Dump after conversion from registers to stack, to @file{@var{file}.28.stack}.
2290 @item l
2291 Dump after local register allocation, to @file{@var{file}.17.lreg}.
2292 @item L
2293 Dump after loop optimization, to @file{@var{file}.08.loop}.
2294 @item M
2295 Dump after performing the machine dependent reorganisation pass, to
2296 @file{@var{file}.26.mach}. 
2297 @item n
2298 Dump after register renumbering, to @file{@var{file}.22.rnreg}.
2299 @item N
2300 Dump after the register move pass, to @file{@var{file}.15.regmove}.
2301 @item r
2302 Dump after RTL generation, to @file{@var{file}.00.rtl}.
2303 @item R
2304 Dump after the second instruction scheduling pass, to
2305 @file{@var{file}.239.sched2}.
2306 @item s
2307 Dump after CSE (including the jump optimization that sometimes follows
2308 CSE), to @file{@var{file}.03.cse}. 
2309 @item S
2310 Dump after the first instruction scheduling pass, to
2311 @file{@var{file}.16.sched}.
2312 @item t
2313 Dump after the second CSE pass (including the jump optimization that
2314 sometimes follows CSE), to @file{@var{file}.09.cse2}.
2315 @item w
2316 Dump after the second flow pass, to @file{@var{file}.19.flow2}.
2317 @item z
2318 Dump after the peephole pass, to @file{@var{file}.21.peephole2}.
2319 @item a
2320 Produce all the dumps listed above.
2321 @item m
2322 Print statistics on memory usage, at the end of the run, to
2323 standard error.
2324 @item p
2325 Annotate the assembler output with a comment indicating which
2326 pattern and alternative was used.  The length of each instruction is
2327 also printed.
2328 @item v
2329 For each of the other indicated dump files (except for
2330 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
2331 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
2332 @item w
2333 Dump after the second flow pass to @file{@var{file}.19.flow2}. 
2334 @item x
2335 Just generate RTL for a function instead of compiling it.  Usually used
2336 with @samp{r}.
2337 @item y
2338 Dump debugging information during parsing, to standard error.
2339 @item z
2340 Dump after the peephole2 pass to @file{@var{file}.21.peephole2}.
2341 @end table
2343 @item -fdump-unnumbered
2344 When doing debugging dumps (see -d option above), suppress instruction
2345 numbers and line number note output.  This makes it more feasible to
2346 use diff on debugging dumps for compiler invocations with different
2347 options, in particular with and without -g.
2349 @item -fdump-translation-unit-@var{file} (C++ only)
2350 Dump a representation of the tree structure for the entire translation
2351 unit to @var{file}.
2353 @item -fpretend-float
2354 When running a cross-compiler, pretend that the target machine uses the
2355 same floating point format as the host machine.  This causes incorrect
2356 output of the actual floating constants, but the actual instruction
2357 sequence will probably be the same as GCC would make when running on
2358 the target machine.
2360 @item -save-temps
2361 Store the usual ``temporary'' intermediate files permanently; place them
2362 in the current directory and name them based on the source file.  Thus,
2363 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
2364 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.
2366 @item -time
2367 Report the CPU time taken by each subprocess in the compilation
2368 sequence.  For C source files, this is the preprocessor, compiler
2369 proper, and assembler.  The output looks like this:
2371 @smallexample
2372 # cpp 0.04 0.04
2373 # cc1 0.12 0.01
2374 # as 0.00 0.01
2375 @end smallexample
2377 The first number on each line is the ``user time,'' that is time spent
2378 executing the program itself.  The second number is ``system time,''
2379 time spent executing operating system routines on behalf of the program.
2380 Both numbers are in seconds.
2382 @item -print-file-name=@var{library}
2383 Print the full absolute name of the library file @var{library} that
2384 would be used when linking---and don't do anything else.  With this
2385 option, GCC does not compile or link anything; it just prints the
2386 file name.
2388 @item -print-prog-name=@var{program}
2389 Like @samp{-print-file-name}, but searches for a program such as @samp{cpp}.
2391 @item -print-libgcc-file-name
2392 Same as @samp{-print-file-name=libgcc.a}.
2394 This is useful when you use @samp{-nostdlib} or @samp{-nodefaultlibs}
2395 but you do want to link with @file{libgcc.a}.  You can do
2397 @example
2398 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
2399 @end example
2401 @item -print-search-dirs
2402 Print the name of the configured installation directory and a list of
2403 program and library directories gcc will search---and don't do anything else.
2405 This is useful when gcc prints the error message
2406 @samp{installation problem, cannot exec cpp: No such file or directory}.
2407 To resolve this you either need to put @file{cpp} and the other compiler
2408 components where gcc expects to find them, or you can set the environment
2409 variable @code{GCC_EXEC_PREFIX} to the directory where you installed them.
2410 Don't forget the trailing '/'.
2411 @xref{Environment Variables}.
2412 @end table
2414 @node Optimize Options
2415 @section Options That Control Optimization
2416 @cindex optimize options
2417 @cindex options, optimization
2419 These options control various sorts of optimizations:
2421 @table @code
2422 @item -O
2423 @itemx -O1
2424 Optimize.  Optimizing compilation takes somewhat more time, and a lot
2425 more memory for a large function.
2427 Without @samp{-O}, the compiler's goal is to reduce the cost of
2428 compilation and to make debugging produce the expected results.
2429 Statements are independent: if you stop the program with a breakpoint
2430 between statements, you can then assign a new value to any variable or
2431 change the program counter to any other statement in the function and
2432 get exactly the results you would expect from the source code.
2434 Without @samp{-O}, the compiler only allocates variables declared
2435 @code{register} in registers.  The resulting compiled code is a little
2436 worse than produced by PCC without @samp{-O}.
2438 With @samp{-O}, the compiler tries to reduce code size and execution
2439 time.
2441 When you specify @samp{-O}, the compiler turns on @samp{-fthread-jumps}
2442 and @samp{-fdefer-pop} on all machines.  The compiler turns on
2443 @samp{-fdelayed-branch} on machines that have delay slots, and
2444 @samp{-fomit-frame-pointer} on machines that can support debugging even
2445 without a frame pointer.  On some machines the compiler also turns
2446 on other flags.@refill
2448 @item -O2
2449 Optimize even more.  GCC performs nearly all supported optimizations
2450 that do not involve a space-speed tradeoff.  The compiler does not
2451 perform loop unrolling or function inlining when you specify @samp{-O2}.
2452 As compared to @samp{-O}, this option increases both compilation time
2453 and the performance of the generated code.
2455 @samp{-O2} turns on all optional optimizations except for loop unrolling
2456 and function inlining.  It also turns on the @samp{-fforce-mem} option
2457 on all machines and frame pointer elimination on machines where doing so
2458 does not interfere with debugging.
2460 @item -O3
2461 Optimize yet more.  @samp{-O3} turns on all optimizations specified by
2462 @samp{-O2} and also turns on the @samp{inline-functions} option.
2464 @item -O0
2465 Do not optimize.
2467 @item -Os
2468 Optimize for size.  @samp{-Os} enables all @samp{-O2} optimizations that
2469 do not typically increase code size.  It also performs further
2470 optimizations designed to reduce code size.
2472 If you use multiple @samp{-O} options, with or without level numbers,
2473 the last such option is the one that is effective.
2474 @end table
2476 Options of the form @samp{-f@var{flag}} specify machine-independent
2477 flags.  Most flags have both positive and negative forms; the negative
2478 form of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below,
2479 only one of the forms is listed---the one which is not the default.
2480 You can figure out the other form by either removing @samp{no-} or
2481 adding it.
2483 @table @code
2484 @item -ffloat-store
2485 Do not store floating point variables in registers, and inhibit other
2486 options that might change whether a floating point value is taken from a
2487 register or memory.
2489 @cindex floating point precision
2490 This option prevents undesirable excess precision on machines such as
2491 the 68000 where the floating registers (of the 68881) keep more
2492 precision than a @code{double} is supposed to have.  Similarly for the
2493 x86 architecture.  For most programs, the excess precision does only
2494 good, but a few programs rely on the precise definition of IEEE floating
2495 point.  Use @samp{-ffloat-store} for such programs, after modifying
2496 them to store all pertinent intermediate computations into variables.
2498 @item -fno-default-inline
2499 Do not make member functions inline by default merely because they are
2500 defined inside the class scope (C++ only).  Otherwise, when you specify
2501 @w{@samp{-O}}, member functions defined inside class scope are compiled
2502 inline by default; i.e., you don't need to add @samp{inline} in front of
2503 the member function name.
2505 @item -fno-defer-pop
2506 Always pop the arguments to each function call as soon as that function
2507 returns.  For machines which must pop arguments after a function call,
2508 the compiler normally lets arguments accumulate on the stack for several
2509 function calls and pops them all at once.
2511 @item -fforce-mem
2512 Force memory operands to be copied into registers before doing
2513 arithmetic on them.  This produces better code by making all memory
2514 references potential common subexpressions.  When they are not common
2515 subexpressions, instruction combination should eliminate the separate
2516 register-load.  The @samp{-O2} option turns on this option.
2518 @item -fforce-addr
2519 Force memory address constants to be copied into registers before
2520 doing arithmetic on them.  This may produce better code just as
2521 @samp{-fforce-mem} may.
2523 @item -fomit-frame-pointer
2524 Don't keep the frame pointer in a register for functions that
2525 don't need one.  This avoids the instructions to save, set up and
2526 restore frame pointers; it also makes an extra register available
2527 in many functions.  @strong{It also makes debugging impossible on
2528 some machines.}
2530 @ifset INTERNALS
2531 On some machines, such as the Vax, this flag has no effect, because
2532 the standard calling sequence automatically handles the frame pointer
2533 and nothing is saved by pretending it doesn't exist.  The
2534 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2535 whether a target machine supports this flag.  @xref{Registers}.@refill
2536 @end ifset
2537 @ifclear INTERNALS
2538 On some machines, such as the Vax, this flag has no effect, because
2539 the standard calling sequence automatically handles the frame pointer
2540 and nothing is saved by pretending it doesn't exist.  The
2541 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2542 whether a target machine supports this flag.  @xref{Registers,,Register
2543 Usage, gcc.info, Using and Porting GCC}.@refill
2544 @end ifclear
2546 @item -foptimize-sibling-calls
2547 Optimize sibling and tail recursive calls.
2549 @item -fno-inline
2550 Don't pay attention to the @code{inline} keyword.  Normally this option
2551 is used to keep the compiler from expanding any functions inline.
2552 Note that if you are not optimizing, no functions can be expanded inline.
2554 @item -finline-functions
2555 Integrate all simple functions into their callers.  The compiler
2556 heuristically decides which functions are simple enough to be worth
2557 integrating in this way.
2559 If all calls to a given function are integrated, and the function is
2560 declared @code{static}, then the function is normally not output as
2561 assembler code in its own right.
2563 @item -finline-limit=@var{n}
2564 By default, gcc limits the size of functions that can be inlined.  This flag
2565 allows the control of this limit for functions that are explicitly marked as
2566 inline (ie marked with the inline keyword or defined within the class 
2567 definition in c++).  @var{n} is the size of functions that can be inlined in 
2568 number of pseudo instructions (not counting parameter handling).  The default
2569 value of n is 10000.  Increasing this value can result in more inlined code at
2570 the cost of compilation time and memory consumption.  Decreasing usually makes
2571 the compilation faster and less code will be inlined (which presumably 
2572 means slower programs).  This option is particularly useful for programs that 
2573 use inlining heavily such as those based on recursive templates with c++.
2575 @emph{Note:} pseudo instruction represents, in this particular context, an
2576 abstract measurement of function's size.  In no way, it represents a count
2577 of assembly instructions and as such its exact meaning might change from one
2578 release to an another.
2580 @item -fkeep-inline-functions
2581 Even if all calls to a given function are integrated, and the function
2582 is declared @code{static}, nevertheless output a separate run-time
2583 callable version of the function.  This switch does not affect
2584 @code{extern inline} functions.
2586 @item -fkeep-static-consts
2587 Emit variables declared @code{static const} when optimization isn't turned
2588 on, even if the variables aren't referenced.
2590 GCC enables this option by default.  If you want to force the compiler to
2591 check if the variable was referenced, regardless of whether or not
2592 optimization is turned on, use the @samp{-fno-keep-static-consts} option.
2594 @item -fno-function-cse
2595 Do not put function addresses in registers; make each instruction that
2596 calls a constant function contain the function's address explicitly.
2598 This option results in less efficient code, but some strange hacks
2599 that alter the assembler output may be confused by the optimizations
2600 performed when this option is not used.
2602 @item -ffast-math
2603 This option allows GCC to violate some ANSI or IEEE rules and/or
2604 specifications in the interest of optimizing code for speed.  For
2605 example, it allows the compiler to assume arguments to the @code{sqrt}
2606 function are non-negative numbers and that no floating-point values
2607 are NaNs.
2609 This option should never be turned on by any @samp{-O} option since
2610 it can result in incorrect output for programs which depend on
2611 an exact implementation of IEEE or ANSI rules/specifications for
2612 math functions.
2614 @item -fno-math-errno
2615 Do not set ERRNO after calling math functions that are executed
2616 with a single instruction, e.g., sqrt.  A program that relies on
2617 IEEE exceptions for math error handling may want to use this flag
2618 for speed while maintaining IEEE arithmetic compatibility.
2620 The default is @samp{-fmath-errno}.  The @samp{-ffast-math} option
2621 sets @samp{-fno-math-errno}.
2622 @end table
2624 @c following causes underfulls.. they don't look great, but we deal.
2625 @c --mew 26jan93
2626 The following options control specific optimizations.  The @samp{-O2}
2627 option turns on all of these optimizations except @samp{-funroll-loops}
2628 and @samp{-funroll-all-loops}.  On most machines, the @samp{-O} option
2629 turns on the @samp{-fthread-jumps} and @samp{-fdelayed-branch} options,
2630 but specific machines may handle it differently.
2632 You can use the following flags in the rare cases when ``fine-tuning''
2633 of optimizations to be performed is desired.
2635 @table @code
2636 @item -fstrength-reduce
2637 Perform the optimizations of loop strength reduction and
2638 elimination of iteration variables.
2640 @item -fthread-jumps
2641 Perform optimizations where we check to see if a jump branches to a
2642 location where another comparison subsumed by the first is found.  If
2643 so, the first branch is redirected to either the destination of the
2644 second branch or a point immediately following it, depending on whether
2645 the condition is known to be true or false.
2647 @item -fcse-follow-jumps
2648 In common subexpression elimination, scan through jump instructions
2649 when the target of the jump is not reached by any other path.  For
2650 example, when CSE encounters an @code{if} statement with an
2651 @code{else} clause, CSE will follow the jump when the condition
2652 tested is false.
2654 @item -fcse-skip-blocks
2655 This is similar to @samp{-fcse-follow-jumps}, but causes CSE to
2656 follow jumps which conditionally skip over blocks.  When CSE
2657 encounters a simple @code{if} statement with no else clause,
2658 @samp{-fcse-skip-blocks} causes CSE to follow the jump around the
2659 body of the @code{if}.
2661 @item -frerun-cse-after-loop
2662 Re-run common subexpression elimination after loop optimizations has been
2663 performed.
2665 @item -frerun-loop-opt
2666 Run the loop optimizer twice.
2668 @item -fgcse
2669 Perform a global common subexpression elimination pass.
2670 This pass also performs global constant and copy propagation.
2672 @item -fdelete-null-pointer-checks
2673 Use global dataflow analysis to identify and eliminate useless null
2674 pointer checks.  Programs which rely on NULL pointer dereferences @emph{not}
2675 halting the program may not work properly with this option.  Use
2676 -fno-delete-null-pointer-checks to disable this optimizing for programs
2677 which depend on that behavior.
2680 @item -fexpensive-optimizations
2681 Perform a number of minor optimizations that are relatively expensive.
2683 @item -foptimize-register-moves
2684 @itemx -fregmove
2685 Attempt to reassign register numbers in move instructions and as
2686 operands of other simple instructions in order to maximize the amount of
2687 register tying.  This is especially helpful on machines with two-operand
2688 instructions.  GCC enables this optimization by default with @samp{-O2}
2689 or higher.
2691 Note @code{-fregmove} and @code{-foptimize-register-moves} are the same
2692 optimization.
2694 @item -fdelayed-branch
2695 If supported for the target machine, attempt to reorder instructions
2696 to exploit instruction slots available after delayed branch
2697 instructions.
2699 @item -fschedule-insns
2700 If supported for the target machine, attempt to reorder instructions to
2701 eliminate execution stalls due to required data being unavailable.  This
2702 helps machines that have slow floating point or memory load instructions
2703 by allowing other instructions to be issued until the result of the load
2704 or floating point instruction is required.
2706 @item -fschedule-insns2
2707 Similar to @samp{-fschedule-insns}, but requests an additional pass of
2708 instruction scheduling after register allocation has been done.  This is
2709 especially useful on machines with a relatively small number of
2710 registers and where memory load instructions take more than one cycle.
2712 @item -ffunction-sections
2713 @itemx -fdata-sections
2714 Place each function or data item into its own section in the output
2715 file if the target supports arbitrary sections.  The name of the
2716 function or the name of the data item determines the section's name
2717 in the output file.
2719 Use these options on systems where the linker can perform optimizations
2720 to improve locality of reference in the instruction space.  HPPA
2721 processors running HP-UX and Sparc processors running Solaris 2 have
2722 linkers with such optimizations.  Other systems using the ELF object format
2723 as well as AIX may have these optimizations in the future.
2725 Only use these options when there are significant benefits from doing
2726 so.  When you specify these options, the assembler and linker will
2727 create larger object and executable files and will also be slower.
2728 You will not be able to use @code{gprof} on all systems if you
2729 specify this option and you may have problems with debugging if
2730 you specify both this option and @samp{-g}.
2732 @item -fcaller-saves
2733 Enable values to be allocated in registers that will be clobbered by
2734 function calls, by emitting extra instructions to save and restore the
2735 registers around such calls.  Such allocation is done only when it
2736 seems to result in better code than would otherwise be produced.
2738 This option is always enabled by default on certain machines, usually
2739 those which have no call-preserved registers to use instead.
2741 For all machines, optimization level 2 and higher enables this flag by
2742 default.
2744 @item -funroll-loops
2745 Perform the optimization of loop unrolling.  This is only done for loops
2746 whose number of iterations can be determined at compile time or run time.
2747 @samp{-funroll-loops} implies both @samp{-fstrength-reduce} and
2748 @samp{-frerun-cse-after-loop}.
2750 @item -funroll-all-loops
2751 Perform the optimization of loop unrolling.  This is done for all loops
2752 and usually makes programs run more slowly.  @samp{-funroll-all-loops}
2753 implies @samp{-fstrength-reduce} as well as @samp{-frerun-cse-after-loop}.
2755 @item -fmove-all-movables
2756 Forces all invariant computations in loops to be moved
2757 outside the loop.
2759 @item -freduce-all-givs
2760 Forces all general-induction variables in loops to be
2761 strength-reduced.
2763 @emph{Note:} When compiling programs written in Fortran,
2764 @samp{-fmove-all-movables} and @samp{-freduce-all-givs} are enabled
2765 by default when you use the optimizer.
2767 These options may generate better or worse code; results are highly
2768 dependent on the structure of loops within the source code.
2770 These two options are intended to be removed someday, once
2771 they have helped determine the efficacy of various
2772 approaches to improving loop optimizations.
2774 Please let us (@code{gcc@@gcc.gnu.org} and @code{fortran@@gnu.org})
2775 know how use of these options affects
2776 the performance of your production code.
2777 We're very interested in code that runs @emph{slower}
2778 when these options are @emph{enabled}.
2780 @item -fno-peephole
2781 Disable any machine-specific peephole optimizations.
2783 @item -fbranch-probabilities
2784 After running a program compiled with @samp{-fprofile-arcs}
2785 (@pxref{Debugging Options,, Options for Debugging Your Program or
2786 @code{gcc}}), you can compile it a second time using
2787 @samp{-fbranch-probabilities}, to improve optimizations based on
2788 guessing the path a branch might take.
2790 @ifset INTERNALS
2791 With @samp{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
2792 note on the first instruction of each basic block, and a
2793 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
2794 These can be used to improve optimization.  Currently, they are only
2795 used in one place: in @file{reorg.c}, instead of guessing which path a
2796 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
2797 exactly determine which path is taken more often.
2798 @end ifset
2800 @item -fstrict-aliasing
2801 Allows the compiler to assume the strictest aliasing rules applicable to
2802 the language being compiled.  For C (and C++), this activates
2803 optimizations based on the type of expressions.  In particular, an
2804 object of one type is assumed never to reside at the same address as an
2805 object of a different type, unless the types are almost the same.  For
2806 example, an @code{unsigned int} can alias an @code{int}, but not a
2807 @code{void*} or a @code{double}.  A character type may alias any other
2808 type.  
2810 Pay special attention to code like this:
2811 @example
2812 union a_union @{ 
2813   int i;
2814   double d;
2817 int f() @{
2818   a_union t;
2819   t.d = 3.0;
2820   return t.i;
2822 @end example
2823 The practice of reading from a different union member than the one most
2824 recently written to (called ``type-punning'') is common.  Even with
2825 @samp{-fstrict-aliasing}, type-punning is allowed, provided the memory
2826 is accessed through the union type.  So, the code above will work as
2827 expected.  However, this code might not:
2828 @example
2829 int f() @{ 
2830   a_union t;
2831   int* ip;
2832   t.d = 3.0;
2833   ip = &t.i;
2834   return *ip;
2836 @end example
2838 @ifset INTERNALS
2839 Every language that wishes to perform language-specific alias analysis
2840 should define a function that computes, given an @code{tree}
2841 node, an alias set for the node.  Nodes in different alias sets are not
2842 allowed to alias.  For an example, see the C front-end function
2843 @code{c_get_alias_set}.
2844 @end ifset
2846 @item -falign-functions
2847 @itemx -falign-functions=@var{n}
2848 Align the start of functions to the next power-of-two greater than
2849 @var{n}, skipping up to @var{n} bytes.  For instance,
2850 @samp{-falign-functions=32} aligns functions to the next 32-byte
2851 boundary, but @samp{-falign-functions=24} would align to the next
2852 32-byte boundary only if this can be done by skipping 23 bytes or less.
2854 @samp{-fno-align-functions} and @samp{-falign-functions=1} are
2855 equivalent and mean that functions will not be aligned.
2857 Some assemblers only support this flag when @var{n} is a power of two;
2858 in that case, it is rounded up.
2860 If @var{n} is not specified, use a machine-dependent default.
2862 @item -falign-labels
2863 @itemx -falign-labels=@var{n}
2864 Align all branch targets to a power-of-two boundary, skipping up to
2865 @var{n} bytes like @samp{-falign-functions}.  This option can easily
2866 make code slower, because it must insert dummy operations for when the
2867 branch target is reached in the usual flow of the code.
2869 If @samp{-falign-loops} or @samp{-falign-jumps} are applicable and
2870 are greater than this value, then their values are used instead.
2872 If @var{n} is not specified, use a machine-dependent default which is
2873 very likely to be @samp{1}, meaning no alignment.
2875 @item -falign-loops
2876 @itemx -falign-loops=@var{n}
2877 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
2878 like @samp{-falign-functions}.  The hope is that the loop will be
2879 executed many times, which will make up for any execution of the dummy
2880 operations.
2882 If @var{n} is not specified, use a machine-dependent default.
2884 @item -falign-jumps
2885 @itemx -falign-jumps=@var{n}
2886 Align branch targets to a power-of-two boundary, for branch targets
2887 where the targets can only be reached by jumping, skipping up to @var{n}
2888 bytes like @samp{-falign-functions}.  In this case, no dummy operations
2889 need be executed.
2891 If @var{n} is not specified, use a machine-dependent default.
2893 @item -fssa
2894 Perform optimizations in static single assignment form.  Each function's
2895 flow graph is translated into SSA form, optimizations are performed, and
2896 the flow graph is translated back from SSA form.  (Currently, no
2897 SSA-based optimizations are implemented, but converting into and out of
2898 SSA form is not an invariant operation, and generated code may differ.)
2900 @item -fsingle-precision-constant
2901 Treat floating point constant as single precision constant instead of
2902 implicitly converting it to double precision constant.
2904 @end table
2906 @node Preprocessor Options
2907 @section Options Controlling the Preprocessor
2908 @cindex preprocessor options
2909 @cindex options, preprocessor
2911 These options control the C preprocessor, which is run on each C source
2912 file before actual compilation.
2914 If you use the @samp{-E} option, nothing is done except preprocessing.
2915 Some of these options make sense only together with @samp{-E} because
2916 they cause the preprocessor output to be unsuitable for actual
2917 compilation.
2919 @table @code
2920 @item -include @var{file}
2921 Process @var{file} as input before processing the regular input file.
2922 In effect, the contents of @var{file} are compiled first.  Any @samp{-D}
2923 and @samp{-U} options on the command line are always processed before
2924 @samp{-include @var{file}}, regardless of the order in which they are
2925 written.  All the @samp{-include} and @samp{-imacros} options are
2926 processed in the order in which they are written.
2928 @item -imacros @var{file}
2929 Process @var{file} as input, discarding the resulting output, before
2930 processing the regular input file.  Because the output generated from
2931 @var{file} is discarded, the only effect of @samp{-imacros @var{file}}
2932 is to make the macros defined in @var{file} available for use in the
2933 main input.
2935 Any @samp{-D} and @samp{-U} options on the command line are always
2936 processed before @samp{-imacros @var{file}}, regardless of the order in
2937 which they are written.  All the @samp{-include} and @samp{-imacros}
2938 options are processed in the order in which they are written.
2940 @item -idirafter @var{dir}
2941 @cindex second include path
2942 Add the directory @var{dir} to the second include path.  The directories
2943 on the second include path are searched when a header file is not found
2944 in any of the directories in the main include path (the one that
2945 @samp{-I} adds to).
2947 @item -iprefix @var{prefix}
2948 Specify @var{prefix} as the prefix for subsequent @samp{-iwithprefix}
2949 options.
2951 @item -iwithprefix @var{dir}
2952 Add a directory to the second include path.  The directory's name is
2953 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
2954 specified previously with @samp{-iprefix}.  If you have not specified a
2955 prefix yet, the directory containing the installed passes of the
2956 compiler is used as the default.
2958 @item -iwithprefixbefore @var{dir}
2959 Add a directory to the main include path.  The directory's name is made
2960 by concatenating @var{prefix} and @var{dir}, as in the case of
2961 @samp{-iwithprefix}.
2963 @item -isystem @var{dir}
2964 Add a directory to the beginning of the second include path, marking it
2965 as a system directory, so that it gets the same special treatment as
2966 is applied to the standard system directories.
2968 @item -nostdinc
2969 Do not search the standard system directories for header files.  Only
2970 the directories you have specified with @samp{-I} options (and the
2971 current directory, if appropriate) are searched.  @xref{Directory
2972 Options}, for information on @samp{-I}.
2974 By using both @samp{-nostdinc} and @samp{-I-}, you can limit the include-file
2975 search path to only those directories you specify explicitly.
2977 @item -undef
2978 Do not predefine any nonstandard macros.  (Including architecture flags).
2980 @item -E
2981 Run only the C preprocessor.  Preprocess all the C source files
2982 specified and output the results to standard output or to the
2983 specified output file.
2985 @item -C
2986 Tell the preprocessor not to discard comments.  Used with the
2987 @samp{-E} option.
2989 @item -P
2990 Tell the preprocessor not to generate @samp{#line} directives.
2991 Used with the @samp{-E} option.
2993 @cindex make
2994 @cindex dependencies, make
2995 @item -M
2996 Tell the preprocessor to output a rule suitable for @code{make}
2997 describing the dependencies of each object file.  For each source file,
2998 the preprocessor outputs one @code{make}-rule whose target is the object
2999 file name for that source file and whose dependencies are all the
3000 @code{#include} header files it uses.  This rule may be a single line or
3001 may be continued with @samp{\}-newline if it is long.  The list of rules
3002 is printed on standard output instead of the preprocessed C program.
3004 @samp{-M} implies @samp{-E}.
3006 Another way to specify output of a @code{make} rule is by setting
3007 the environment variable @code{DEPENDENCIES_OUTPUT} (@pxref{Environment
3008 Variables}).
3010 @item -MM
3011 Like @samp{-M} but the output mentions only the user header files
3012 included with @samp{#include "@var{file}"}.  System header files
3013 included with @samp{#include <@var{file}>} are omitted.
3015 @item -MD
3016 Like @samp{-M} but the dependency information is written to a file made by
3017 replacing ".c" with ".d" at the end of the input file names.
3018 This is in addition to compiling the file as specified---@samp{-MD} does
3019 not inhibit ordinary compilation the way @samp{-M} does.
3021 In Mach, you can use the utility @code{md} to merge multiple dependency
3022 files into a single dependency file suitable for using with the @samp{make}
3023 command.
3025 @item -MMD
3026 Like @samp{-MD} except mention only user header files, not system
3027 header files.
3029 @item -MG
3030 Treat missing header files as generated files and assume they live in the
3031 same directory as the source file.  If you specify @samp{-MG}, you
3032 must also specify either @samp{-M} or @samp{-MM}.  @samp{-MG} is not
3033 supported with @samp{-MD} or @samp{-MMD}.
3035 @item -H
3036 Print the name of each header file used, in addition to other normal
3037 activities.
3039 @item -A@var{question}(@var{answer})
3040 Assert the answer @var{answer} for @var{question}, in case it is tested
3041 with a preprocessing conditional such as @samp{#if
3042 #@var{question}(@var{answer})}.  @samp{-A-} disables the standard
3043 assertions that normally describe the target machine.
3045 @item -D@var{macro}
3046 Define macro @var{macro} with the string @samp{1} as its definition.
3048 @item -D@var{macro}=@var{defn}
3049 Define macro @var{macro} as @var{defn}.  All instances of @samp{-D} on
3050 the command line are processed before any @samp{-U} options.
3052 @item -U@var{macro}
3053 Undefine macro @var{macro}.  @samp{-U} options are evaluated after all
3054 @samp{-D} options, but before any @samp{-include} and @samp{-imacros}
3055 options.
3057 @item -dM
3058 Tell the preprocessor to output only a list of the macro definitions
3059 that are in effect at the end of preprocessing.  Used with the @samp{-E}
3060 option.
3062 @item -dD
3063 Tell the preprocessing to pass all macro definitions into the output, in
3064 their proper sequence in the rest of the output.
3066 @item -dN
3067 Like @samp{-dD} except that the macro arguments and contents are omitted.
3068 Only @samp{#define @var{name}} is included in the output.
3070 @item -trigraphs
3071 Support ANSI C trigraphs.  The @samp{-ansi} option also has this effect.
3073 @item -Wp,@var{option}
3074 Pass @var{option} as an option to the preprocessor.  If @var{option}
3075 contains commas, it is split into multiple options at the commas.
3076 @end table
3078 @node Assembler Options
3079 @section Passing Options to the Assembler
3081 @c prevent bad page break with this line
3082 You can pass options to the assembler.
3084 @table @code
3085 @item -Wa,@var{option}
3086 Pass @var{option} as an option to the assembler.  If @var{option}
3087 contains commas, it is split into multiple options at the commas.
3088 @end table
3090 @node Link Options
3091 @section Options for Linking
3092 @cindex link options
3093 @cindex options, linking
3095 These options come into play when the compiler links object files into
3096 an executable output file.  They are meaningless if the compiler is
3097 not doing a link step.
3099 @table @code
3100 @cindex file names
3101 @item @var{object-file-name}
3102 A file name that does not end in a special recognized suffix is
3103 considered to name an object file or library.  (Object files are
3104 distinguished from libraries by the linker according to the file
3105 contents.)  If linking is done, these object files are used as input
3106 to the linker.
3108 @item -c
3109 @itemx -S
3110 @itemx -E
3111 If any of these options is used, then the linker is not run, and
3112 object file names should not be used as arguments.  @xref{Overall
3113 Options}.
3115 @cindex Libraries
3116 @item -l@var{library}
3117 Search the library named @var{library} when linking.
3119 It makes a difference where in the command you write this option; the
3120 linker searches processes libraries and object files in the order they
3121 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
3122 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
3123 to functions in @samp{z}, those functions may not be loaded.
3125 The linker searches a standard list of directories for the library,
3126 which is actually a file named @file{lib@var{library}.a}.  The linker
3127 then uses this file as if it had been specified precisely by name.
3129 The directories searched include several standard system directories
3130 plus any that you specify with @samp{-L}.
3132 Normally the files found this way are library files---archive files
3133 whose members are object files.  The linker handles an archive file by
3134 scanning through it for members which define symbols that have so far
3135 been referenced but not defined.  But if the file that is found is an
3136 ordinary object file, it is linked in the usual fashion.  The only
3137 difference between using an @samp{-l} option and specifying a file name
3138 is that @samp{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
3139 and searches several directories.
3141 @item -lobjc
3142 You need this special case of the @samp{-l} option in order to
3143 link an Objective C program.
3145 @item -nostartfiles
3146 Do not use the standard system startup files when linking.
3147 The standard system libraries are used normally, unless @code{-nostdlib}
3148 or @code{-nodefaultlibs} is used.
3150 @item -nodefaultlibs
3151 Do not use the standard system libraries when linking.
3152 Only the libraries you specify will be passed to the linker.
3153 The standard startup files are used normally, unless @code{-nostartfiles}
3154 is used.  The compiler may generate calls to memcmp, memset, and memcpy
3155 for System V (and ANSI C) environments or to bcopy and bzero for
3156 BSD environments.  These entries are usually resolved by entries in
3157 libc.  These entry points should be supplied through some other
3158 mechanism when this option is specified.
3160 @item -nostdlib
3161 Do not use the standard system startup files or libraries when linking.
3162 No startup files and only the libraries you specify will be passed to
3163 the linker. The compiler may generate calls to memcmp, memset, and memcpy
3164 for System V (and ANSI C) environments or to bcopy and bzero for
3165 BSD environments.  These entries are usually resolved by entries in
3166 libc.  These entry points should be supplied through some other
3167 mechanism when this option is specified.
3169 @cindex @code{-lgcc}, use with @code{-nostdlib}
3170 @cindex @code{-nostdlib} and unresolved references
3171 @cindex unresolved references and @code{-nostdlib}
3172 @cindex @code{-lgcc}, use with @code{-nodefaultlibs}
3173 @cindex @code{-nodefaultlibs} and unresolved references
3174 @cindex unresolved references and @code{-nodefaultlibs}
3175 One of the standard libraries bypassed by @samp{-nostdlib} and
3176 @samp{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
3177 that GCC uses to overcome shortcomings of particular machines, or special
3178 needs for some languages.
3179 @ifset INTERNALS
3180 (@xref{Interface,,Interfacing to GCC Output}, for more discussion of
3181 @file{libgcc.a}.)
3182 @end ifset
3183 @ifclear INTERNALS
3184 (@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
3185 for more discussion of @file{libgcc.a}.)
3186 @end ifclear
3187 In most cases, you need @file{libgcc.a} even when you want to avoid
3188 other standard libraries.  In other words, when you specify @samp{-nostdlib}
3189 or @samp{-nodefaultlibs} you should usually specify @samp{-lgcc} as well.
3190 This ensures that you have no unresolved references to internal GCC
3191 library subroutines.  (For example, @samp{__main}, used to ensure C++
3192 constructors will be called; @pxref{Collect2,,@code{collect2}}.)
3194 @item -s
3195 Remove all symbol table and relocation information from the executable.
3197 @item -static
3198 On systems that support dynamic linking, this prevents linking with the shared
3199 libraries.  On other systems, this option has no effect.
3201 @item -shared
3202 Produce a shared object which can then be linked with other objects to
3203 form an executable.  Not all systems support this option.  You must
3204 also specify @samp{-fpic} or @samp{-fPIC} on some systems when
3205 you specify this option.
3207 @item -symbolic
3208 Bind references to global symbols when building a shared object.  Warn
3209 about any unresolved references (unless overridden by the link editor
3210 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
3211 this option.
3213 @item -Xlinker @var{option}
3214 Pass @var{option} as an option to the linker.  You can use this to
3215 supply system-specific linker options which GCC does not know how to
3216 recognize.
3218 If you want to pass an option that takes an argument, you must use
3219 @samp{-Xlinker} twice, once for the option and once for the argument.
3220 For example, to pass @samp{-assert definitions}, you must write
3221 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
3222 @samp{-Xlinker "-assert definitions"}, because this passes the entire
3223 string as a single argument, which is not what the linker expects.
3225 @item -Wl,@var{option}
3226 Pass @var{option} as an option to the linker.  If @var{option} contains
3227 commas, it is split into multiple options at the commas.
3229 @item -u @var{symbol}
3230 Pretend the symbol @var{symbol} is undefined, to force linking of
3231 library modules to define it.  You can use @samp{-u} multiple times with
3232 different symbols to force loading of additional library modules.
3233 @end table
3235 @node Directory Options
3236 @section Options for Directory Search
3237 @cindex directory options
3238 @cindex options, directory search
3239 @cindex search path
3241 These options specify directories to search for header files, for
3242 libraries and for parts of the compiler:
3244 @table @code
3245 @item -I@var{dir}
3246 Add the directory @var{dir} to the head of the list of directories to be
3247 searched for header files.  This can be used to override a system header
3248 file, substituting your own version, since these directories are
3249 searched before the system header file directories.  If you use more
3250 than one @samp{-I} option, the directories are scanned in left-to-right
3251 order; the standard system directories come after.
3253 @item -I-
3254 Any directories you specify with @samp{-I} options before the @samp{-I-}
3255 option are searched only for the case of @samp{#include "@var{file}"};
3256 they are not searched for @samp{#include <@var{file}>}.
3258 If additional directories are specified with @samp{-I} options after
3259 the @samp{-I-}, these directories are searched for all @samp{#include}
3260 directives.  (Ordinarily @emph{all} @samp{-I} directories are used
3261 this way.)
3263 In addition, the @samp{-I-} option inhibits the use of the current
3264 directory (where the current input file came from) as the first search
3265 directory for @samp{#include "@var{file}"}.  There is no way to
3266 override this effect of @samp{-I-}.  With @samp{-I.} you can specify
3267 searching the directory which was current when the compiler was
3268 invoked.  That is not exactly the same as what the preprocessor does
3269 by default, but it is often satisfactory.
3271 @samp{-I-} does not inhibit the use of the standard system directories
3272 for header files.  Thus, @samp{-I-} and @samp{-nostdinc} are
3273 independent.
3275 @item -L@var{dir}
3276 Add directory @var{dir} to the list of directories to be searched
3277 for @samp{-l}.
3279 @item -B@var{prefix}
3280 This option specifies where to find the executables, libraries,
3281 include files, and data files of the compiler itself.
3283 The compiler driver program runs one or more of the subprograms
3284 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
3285 @var{prefix} as a prefix for each program it tries to run, both with and
3286 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
3288 For each subprogram to be run, the compiler driver first tries the
3289 @samp{-B} prefix, if any.  If that name is not found, or if @samp{-B}
3290 was not specified, the driver tries two standard prefixes, which are
3291 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
3292 those results in a file name that is found, the unmodified program
3293 name is searched for using the directories specified in your
3294 @samp{PATH} environment variable.
3296 @samp{-B} prefixes that effectively specify directory names also apply
3297 to libraries in the linker, because the compiler translates these
3298 options into @samp{-L} options for the linker.  They also apply to
3299 includes files in the preprocessor, because the compiler translates these
3300 options into @samp{-isystem} options for the preprocessor.  In this case,
3301 the compiler appends @samp{include} to the prefix.
3303 The run-time support file @file{libgcc.a} can also be searched for using
3304 the @samp{-B} prefix, if needed.  If it is not found there, the two
3305 standard prefixes above are tried, and that is all.  The file is left
3306 out of the link if it is not found by those means.
3308 Another way to specify a prefix much like the @samp{-B} prefix is to use
3309 the environment variable @code{GCC_EXEC_PREFIX}.  @xref{Environment
3310 Variables}.
3312 @item -specs=@var{file}
3313 Process @var{file} after the compiler reads in the standard @file{specs}
3314 file, in order to override the defaults that the @file{gcc} driver
3315 program uses when determining what switches to pass to @file{cc1},
3316 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
3317 @samp{-specs=}@var{file} can be specified on the command line, and they
3318 are processed in order, from left to right.
3319 @end table
3321 @node Spec Files
3322 @section Specifying subprocesses and the switches to pass to them
3323 @cindex Spec Files
3324 @code{GCC} is a driver program.  It performs its job by invoking a
3325 sequence of other programs to do the work of compiling, assembling and
3326 linking.  GCC interprets its command-line parameters and uses these to
3327 deduce which programs it should invoke, and which command-line options
3328 it ought to place on their command lines.  This behaviour is controlled
3329 by @dfn{spec strings}.  In most cases there is one spec string for each
3330 program that GCC can invoke, but a few programs have multiple spec
3331 strings to control their behaviour.  The spec strings built into GCC can
3332 be overridden by using the @samp{-specs=} command-line switch to specify
3333 a spec file.
3335 @dfn{Spec files} are plaintext files that are used to construct spec
3336 strings.  They consist of a sequence of directives separated by blank
3337 lines.  The type of directive is determined by the first non-whitespace
3338 character on the line and it can be one of the following:
3340 @table @code
3341 @item %@var{command}
3342 Issues a @var{command} to the spec file processor.  The commands that can
3343 appear here are: 
3345 @table @code
3346 @item %include <@var{file}>
3347 @cindex %include
3348 Search for @var{file} and insert its text at the current point in the
3349 specs file.
3351 @item %include_noerr <@var{file}>
3352 @cindex %include_noerr
3353 Just like @samp{%include}, but do not generate an error message if the include
3354 file cannot be found.
3356 @item %rename @var{old_name} @var{new_name}
3357 @cindex %rename
3358 Rename the spec string @var{old_name} to @var{new_name}.
3360 @end table
3362 @item *[@var{spec_name}]:
3363 This tells the compiler to create, override or delete the named spec
3364 string.  All lines after this directive up to the next directive or
3365 blank line are considered to be the text for the spec string.  If this
3366 results in an empty string then the spec will be deleted.  (Or, if the
3367 spec did not exist, then nothing will happened.)  Otherwise, if the spec
3368 does not currently exist a new spec will be created.  If the spec does
3369 exist then its contents will be overridden by the text of this
3370 directive, unless the first character of that text is the @samp{+}
3371 character, in which case the text will be appended to the spec.
3373 @item [@var{suffix}]:
3374 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
3375 and up to the next directive or blank line are considered to make up the
3376 spec string for the indicated suffix.  When the compiler encounters an 
3377 input file with the named suffix, it will processes the spec string in
3378 order to work out how to compile that file.  For example:
3380 @smallexample
3381 .ZZ:
3382 z-compile -input %i
3383 @end smallexample
3385 This says that any input file whose name ends in @samp{.ZZ} should be
3386 passed to the program @samp{z-compile}, which should be invoked with the
3387 command-line switch @samp{-input} and with the result of performing the
3388 @samp{%i} substitution.  (See below.)
3390 As an alternative to providing a spec string, the text that follows a
3391 suffix directive can be one of the following:
3393 @table @code
3394 @item @@@var{language}
3395 This says that the suffix is an alias for a known @var{language}.  This is
3396 similar to using the @code{-x} command-line switch to GCC to specify a
3397 language explicitly.  For example:
3399 @smallexample
3400 .ZZ:
3401 @@c++
3402 @end smallexample
3404 Says that .ZZ files are, in fact, C++ source files.
3406 @item #@var{name}
3407 This causes an error messages saying:
3409 @smallexample
3410 @var{name} compiler not installed on this system.
3411 @end smallexample
3412 @end table
3414 GCC already has an extensive list of suffixes built into it.
3415 This directive will add an entry to the end of the list of suffixes, but
3416 since the list is searched from the end backwards, it is effectively
3417 possible to override earlier entries using this technique.
3419 @end table
3421 GCC has the following spec strings built into it.  Spec files can
3422 override these strings or create their own.  Note that individual
3423 targets can also add their own spec strings to this list. 
3425 @smallexample
3426 asm          Options to pass to the assembler
3427 asm_final    Options to pass to the assembler post-processor
3428 cpp          Options to pass to the C preprocessor
3429 cc1          Options to pass to the C compiler
3430 cc1plus      Options to pass to the C++ compiler
3431 endfile      Object files to include at the end of the link
3432 link         Options to pass to the linker
3433 lib          Libraries to include on the command line to the linker
3434 libgcc       Decides which GCC support library to pass to the linker
3435 linker       Sets the name of the linker
3436 predefines   Defines to be passed to the C preprocessor
3437 signed_char  Defines to pass to CPP to say whether @code{char} is signed by default
3438 startfile    Object files to include at the start of the link
3439 @end smallexample
3441 Here is a small example of a spec file:
3443 @smallexample
3444 %rename lib                 old_lib
3446 *lib:
3447 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
3448 @end smallexample
3450 This example renames the spec called @samp{lib} to @samp{old_lib} and
3451 then overrides the previous definition of @samp{lib} with a new one.
3452 The new definition adds in some extra command-line options before
3453 including the text of the old definition.
3455 @dfn{Spec strings} are a list of command-line options to be passed to their
3456 corresponding program.  In addition, the spec strings can contain
3457 @samp{%}-prefixed sequences to substitute variable text or to
3458 conditionally insert text into the command line.  Using these constructs
3459 it is possible to generate quite complex command lines.
3461 Here is a table of all defined @samp{%}-sequences for spec
3462 strings.  Note that spaces are not generated automatically around the
3463 results of expanding these sequences.  Therefore you can concatenate them
3464 together or combine them with constant text in a single argument. 
3466 @table @code
3467 @item %%
3468 Substitute one @samp{%} into the program name or argument.
3470 @item %i
3471 Substitute the name of the input file being processed.
3473 @item %b
3474 Substitute the basename of the input file being processed.
3475 This is the substring up to (and not including) the last period
3476 and not including the directory.
3478 @item %d
3479 Marks the argument containing or following the @samp{%d} as a
3480 temporary file name, so that that file will be deleted if GCC exits
3481 successfully.  Unlike @samp{%g}, this contributes no text to the
3482 argument. 
3484 @item %g@var{suffix}
3485 Substitute a file name that has suffix @var{suffix} and is chosen
3486 once per compilation, and mark the argument in the same way as
3487 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
3488 name is now chosen in a way that is hard to predict even when previously 
3489 chosen file names are known.  For example, @samp{%g.s ... %g.o ... %g.s}
3490 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
3491 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
3492 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
3493 was simply substituted with a file name chosen once per compilation,
3494 without regard to any appended suffix (which was therefore treated
3495 just like ordinary text), making such attacks more likely to succeed.
3497 @item %u@var{suffix}
3498 Like @samp{%g}, but generates a new temporary file name even if
3499 @samp{%u@var{suffix}} was already seen.
3501 @item %U@var{suffix}
3502 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
3503 new one if there is no such last file name.  In the absence of any
3504 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
3505 the same suffix @emph{space}, so @samp{%g.s ... %U.s ... %g.s ... %U.s}
3506 would involve the generation of two distinct file names, one
3507 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
3508 simply substituted with a file name chosen for the previous @samp{%u},
3509 without regard to any appended suffix.
3511 @item %w
3512 Marks the argument containing or following the @samp{%w} as the
3513 designated output file of this compilation.  This puts the argument
3514 into the sequence of arguments that @samp{%o} will substitute later.
3516 @item %o
3517 Substitutes the names of all the output files, with spaces
3518 automatically placed around them.  You should write spaces
3519 around the @samp{%o} as well or the results are undefined.
3520 @samp{%o} is for use in the specs for running the linker.
3521 Input files whose names have no recognized suffix are not compiled
3522 at all, but they are included among the output files, so they will
3523 be linked.
3525 @item %O
3526 Substitutes the suffix for object files.  Note that this is
3527 handled specially when it immediately follows @samp{%g, %u, or %U},
3528 because of the need for those to form complete file names.  The
3529 handling is such that @samp{%O} is treated exactly as if it had already
3530 been substituted, except that @samp{%g, %u, and %U} do not currently
3531 support additional @var{suffix} characters following @samp{%O} as they would
3532 following, for example, @samp{.o}.
3534 @item %p
3535 Substitutes the standard macro predefinitions for the
3536 current target machine.  Use this when running @code{cpp}.
3538 @item %P
3539 Like @samp{%p}, but puts @samp{__} before and after the name of each
3540 predefined macro, except for macros that start with @samp{__} or with
3541 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ANSI
3542 C.  
3544 @item %I
3545 Substitute a @samp{-iprefix} option made from GCC_EXEC_PREFIX.
3547 @item %s
3548 Current argument is the name of a library or startup file of some sort.
3549 Search for that file in a standard list of directories and substitute
3550 the full name found. 
3552 @item %e@var{str}
3553 Print @var{str} as an error message.  @var{str} is terminated by a newline.
3554 Use this when inconsistent options are detected.
3556 @item %|
3557 Output @samp{-} if the input for the current command is coming from a pipe.
3559 @item %(@var{name})
3560 Substitute the contents of spec string @var{name} at this point.
3562 @item %[@var{name}]
3563 Like @samp{%(...)} but put @samp{__} around @samp{-D} arguments.
3565 @item %x@{@var{option}@}
3566 Accumulate an option for @samp{%X}.
3568 @item %X
3569 Output the accumulated linker options specified by @samp{-Wl} or a @samp{%x}
3570 spec string.
3572 @item %Y
3573 Output the accumulated assembler options specified by @samp{-Wa}.
3575 @item %Z
3576 Output the accumulated preprocessor options specified by @samp{-Wp}.
3578 @item %v1
3579 Substitute the major version number of GCC.
3580 (For version 2.9.5, this is 2.)
3582 @item %v2
3583 Substitute the minor version number of GCC.
3584 (For version 2.9.5, this is 9.)
3586 @item %a
3587 Process the @code{asm} spec.  This is used to compute the
3588 switches to be passed to the assembler.
3590 @item %A
3591 Process the @code{asm_final} spec.  This is a spec string for
3592 passing switches to an assembler post-processor, if such a program is
3593 needed.
3595 @item %l
3596 Process the @code{link} spec.  This is the spec for computing the
3597 command line passed to the linker.  Typically it will make use of the
3598 @samp{%L %G %S %D and %E} sequences.
3600 @item %D
3601 Dump out a @samp{-L} option for each directory that GCC believes might
3602 contain startup files.  If the target supports multilibs then the
3603 current multilib directory will be prepended to each of these paths. 
3605 @item %L
3606 Process the @code{lib} spec.  This is a spec string for deciding which
3607 libraries should be included on the command line to the linker. 
3609 @item %G
3610 Process the @code{libgcc} spec.  This is a spec string for deciding
3611 which GCC support library should be included on the command line to the linker. 
3613 @item %S
3614 Process the @code{startfile} spec.  This is a spec for deciding which
3615 object files should be the first ones passed to the linker.  Typically
3616 this might be a file named @file{crt0.o}. 
3618 @item %E
3619 Process the @code{endfile} spec.  This is a spec string that specifies
3620 the last object files that will be passed to the linker.  
3622 @item %C
3623 Process the @code{cpp} spec.  This is used to construct the arguments
3624 to be passed to the C preprocessor.
3626 @item %c
3627 Process the @code{signed_char} spec.  This is intended to be used
3628 to tell cpp whether a char is signed.  It typically has the definition: 
3629 @smallexample
3630 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
3631 @end smallexample
3633 @item %1
3634 Process the @code{cc1} spec.  This is used to construct the options to be
3635 passed to the actual C compiler (@samp{cc1}).
3637 @item %2
3638 Process the @code{cc1plus} spec.  This is used to construct the options to be
3639 passed to the actual C++ compiler (@samp{cc1plus}).
3641 @item %*
3642 Substitute the variable part of a matched option.  See below.
3643 Note that each comma in the substituted string is replaced by
3644 a single space.
3646 @item %@{@code{S}@}
3647 Substitutes the @code{-S} switch, if that switch was given to GCC.
3648 If that switch was not specified, this substitutes nothing.  Note that
3649 the leading dash is omitted when specifying this option, and it is
3650 automatically inserted if the substitution is performed.  Thus the spec
3651 string @samp{%@{foo@}} would match the command-line option @samp{-foo}
3652 and would output the command line option @samp{-foo}.
3654 @item %W@{@code{S}@}
3655 Like %@{@code{S}@} but mark last argument supplied within as a file to be
3656 deleted on failure. 
3658 @item %@{@code{S}*@}
3659 Substitutes all the switches specified to GCC whose names start
3660 with @code{-S}, but which also take an argument.  This is used for
3661 switches like @samp{-o, -D, -I}, etc.  GCC considers @samp{-o foo} as being
3662 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
3663 text, including the space.  Thus two arguments would be generated. 
3665 @item %@{^@code{S}*@}
3666 Like %@{@code{S}*@}, but don't put a blank between a switch and its
3667 argument.  Thus %@{^o*@} would only generate one argument, not two.
3669 @item %@{<@code{S}@}
3670 Remove all occurrences of @code{S} from the command line.  Note - this
3671 command is position dependent.  @samp{%} commands in the spec string
3672 before this option will see @code{S}, @samp{%} commands in the spec
3673 string after this option will not.
3675 @item %@{@code{S}*:@code{X}@}
3676 Substitutes @code{X} if one or more switches whose names start with
3677 @code{-S} are specified to GCC.  Note that the tail part of the
3678 @code{-S} option (i.e. the part matched by the @samp{*}) will be substituted
3679 for each occurrence of @samp{%*} within @code{X}. 
3681 @item %@{@code{S}:@code{X}@}
3682 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC.
3684 @item %@{!@code{S}:@code{X}@}
3685 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC.
3687 @item %@{|@code{S}:@code{X}@}
3688 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
3690 @item %@{|!@code{S}:@code{X}@}
3691 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
3693 @item %@{.@code{S}:@code{X}@}
3694 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
3696 @item %@{!.@code{S}:@code{X}@}
3697 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
3699 @item %@{@code{S}|@code{P}:@code{X}@}
3700 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC.  This may be
3701 combined with @samp{!} and @samp{.} sequences as well, although they
3702 have a stronger binding than the @samp{|}.  For example a spec string
3703 like this:
3705 @smallexample
3706 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
3707 @end smallexample
3709 will output the following command-line options from the following input
3710 command-line options:
3712 @smallexample
3713 fred.c        -foo -baz
3714 jim.d         -bar -boggle
3715 -d fred.c     -foo -baz -boggle
3716 -d jim.d      -bar -baz -boggle
3717 @end smallexample
3719 @end table
3721 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
3722 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
3723 or spaces, or even newlines.  They are processed as usual, as described
3724 above. 
3726 The @samp{-O, -f, -m, and -W} switches are handled specifically in these
3727 constructs.  If another value of @samp{-O} or the negated form of a @samp{-f, -m, or
3728 -W} switch is found later in the command line, the earlier switch
3729 value is ignored, except with @{@code{S}*@} where @code{S} is just one
3730 letter, which passes all matching options.
3732 The character @samp{|} at the beginning of the predicate text is used to indicate
3733 that a command should be piped to the following command, but only if @samp{-pipe}
3734 is specified.
3736 It is built into GCC which switches take arguments and which do not.
3737 (You might think it would be useful to generalize this to allow each
3738 compiler's spec to say which switches take arguments.  But this cannot
3739 be done in a consistent fashion.  GCC cannot even decide which input
3740 files have been specified without knowing which switches take arguments,
3741 and it must know which input files to compile in order to tell which
3742 compilers to run). 
3744 GCC also knows implicitly that arguments starting in @samp{-l} are to be
3745 treated as compiler output files, and passed to the linker in their
3746 proper position among the other output files.
3748 @node Target Options
3749 @section Specifying Target Machine and Compiler Version
3750 @cindex target options
3751 @cindex cross compiling
3752 @cindex specifying machine version
3753 @cindex specifying compiler version and target machine
3754 @cindex compiler version, specifying
3755 @cindex target machine, specifying
3757 By default, GCC compiles code for the same type of machine that you
3758 are using.  However, it can also be installed as a cross-compiler, to
3759 compile for some other type of machine.  In fact, several different
3760 configurations of GCC, for different target machines, can be
3761 installed side by side.  Then you specify which one to use with the
3762 @samp{-b} option.
3764 In addition, older and newer versions of GCC can be installed side
3765 by side.  One of them (probably the newest) will be the default, but
3766 you may sometimes wish to use another.
3768 @table @code
3769 @item -b @var{machine}
3770 The argument @var{machine} specifies the target machine for compilation.
3771 This is useful when you have installed GCC as a cross-compiler.
3773 The value to use for @var{machine} is the same as was specified as the
3774 machine type when configuring GCC as a cross-compiler.  For
3775 example, if a cross-compiler was configured with @samp{configure
3776 i386v}, meaning to compile for an 80386 running System V, then you
3777 would specify @samp{-b i386v} to run that cross compiler.
3779 When you do not specify @samp{-b}, it normally means to compile for
3780 the same type of machine that you are using.
3782 @item -V @var{version}
3783 The argument @var{version} specifies which version of GCC to run.
3784 This is useful when multiple versions are installed.  For example,
3785 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
3787 The default version, when you do not specify @samp{-V}, is the last
3788 version of GCC that you installed.
3789 @end table
3791 The @samp{-b} and @samp{-V} options actually work by controlling part of
3792 the file name used for the executable files and libraries used for
3793 compilation.  A given version of GCC, for a given target machine, is
3794 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.@refill
3796 Thus, sites can customize the effect of @samp{-b} or @samp{-V} either by
3797 changing the names of these directories or adding alternate names (or
3798 symbolic links).  If in directory @file{/usr/local/lib/gcc-lib/} the
3799 file @file{80386} is a link to the file @file{i386v}, then @samp{-b
3800 80386} becomes an alias for @samp{-b i386v}.
3802 In one respect, the @samp{-b} or @samp{-V} do not completely change
3803 to a different compiler: the top-level driver program @code{gcc}
3804 that you originally invoked continues to run and invoke the other
3805 executables (preprocessor, compiler per se, assembler and linker)
3806 that do the real work.  However, since no real work is done in the
3807 driver program, it usually does not matter that the driver program
3808 in use is not the one for the specified target and version.
3810 The only way that the driver program depends on the target machine is
3811 in the parsing and handling of special machine-specific options.
3812 However, this is controlled by a file which is found, along with the
3813 other executables, in the directory for the specified version and
3814 target machine.  As a result, a single installed driver program adapts
3815 to any specified target machine and compiler version.
3817 The driver program executable does control one significant thing,
3818 however: the default version and target machine.  Therefore, you can
3819 install different instances of the driver program, compiled for
3820 different targets or versions, under different names.
3822 For example, if the driver for version 2.0 is installed as @code{ogcc}
3823 and that for version 2.1 is installed as @code{gcc}, then the command
3824 @code{gcc} will use version 2.1 by default, while @code{ogcc} will use
3825 2.0 by default.  However, you can choose either version with either
3826 command with the @samp{-V} option.
3828 @node Submodel Options
3829 @section Hardware Models and Configurations
3830 @cindex submodel options
3831 @cindex specifying hardware config
3832 @cindex hardware models and configurations, specifying
3833 @cindex machine dependent options
3835 Earlier we discussed the standard option @samp{-b} which chooses among
3836 different installed compilers for completely different target
3837 machines, such as Vax vs. 68000 vs. 80386.
3839 In addition, each of these target machine types can have its own
3840 special options, starting with @samp{-m}, to choose among various
3841 hardware models or configurations---for example, 68010 vs 68020,
3842 floating coprocessor or none.  A single installed version of the
3843 compiler can compile for any model or configuration, according to the
3844 options specified.
3846 Some configurations of the compiler also support additional special
3847 options, usually for compatibility with other compilers on the same
3848 platform.
3850 @ifset INTERNALS
3851 These options are defined by the macro @code{TARGET_SWITCHES} in the
3852 machine description.  The default for the options is also defined by
3853 that macro, which enables you to change the defaults.
3854 @end ifset
3856 @menu
3857 * M680x0 Options::
3858 * VAX Options::
3859 * SPARC Options::
3860 * Convex Options::
3861 * AMD29K Options::
3862 * ARM Options::
3863 * Thumb Options::
3864 * MN10200 Options::
3865 * MN10300 Options::
3866 * M32R/D Options::
3867 * M88K Options::
3868 * RS/6000 and PowerPC Options::
3869 * RT Options::
3870 * MIPS Options::
3871 * i386 Options::
3872 * HPPA Options::
3873 * Intel 960 Options::
3874 * DEC Alpha Options::
3875 * Clipper Options::
3876 * H8/300 Options::
3877 * SH Options::
3878 * System V Options::
3879 * TMS320C3x/C4x Options::
3880 * V850 Options::
3881 * ARC Options::
3882 * NS32K Options::
3883 * AVR Options::
3884 * MCore Options::
3885 @end menu
3887 @node M680x0 Options
3888 @subsection M680x0 Options
3889 @cindex M680x0 options
3891 These are the @samp{-m} options defined for the 68000 series.  The default
3892 values for these options depends on which style of 68000 was selected when
3893 the compiler was configured; the defaults for the most common choices are
3894 given below.
3896 @table @code
3897 @item -m68000
3898 @itemx -mc68000
3899 Generate output for a 68000.  This is the default
3900 when the compiler is configured for 68000-based systems.
3902 Use this option for microcontrollers with a 68000 or EC000 core,
3903 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
3905 @item -m68020
3906 @itemx -mc68020
3907 Generate output for a 68020.  This is the default
3908 when the compiler is configured for 68020-based systems.
3910 @item -m68881
3911 Generate output containing 68881 instructions for floating point.
3912 This is the default for most 68020 systems unless @samp{-nfp} was
3913 specified when the compiler was configured.
3915 @item -m68030
3916 Generate output for a 68030.  This is the default when the compiler is
3917 configured for 68030-based systems.
3919 @item -m68040
3920 Generate output for a 68040.  This is the default when the compiler is
3921 configured for 68040-based systems.
3923 This option inhibits the use of 68881/68882 instructions that have to be
3924 emulated by software on the 68040.  Use this option if your 68040 does not
3925 have code to emulate those instructions.
3927 @item -m68060
3928 Generate output for a 68060.  This is the default when the compiler is
3929 configured for 68060-based systems.
3931 This option inhibits the use of 68020 and 68881/68882 instructions that
3932 have to be emulated by software on the 68060.  Use this option if your 68060
3933 does not have code to emulate those instructions.
3935 @item -mcpu32
3936 Generate output for a CPU32. This is the default
3937 when the compiler is configured for CPU32-based systems.
3939 Use this option for microcontrollers with a
3940 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
3941 68336, 68340, 68341, 68349 and 68360.
3943 @item -m5200
3944 Generate output for a 520X "coldfire" family cpu.  This is the default
3945 when the compiler is configured for 520X-based systems.
3947 Use this option for microcontroller with a 5200 core, including 
3948 the MCF5202, MCF5203, MCF5204 and MCF5202.
3951 @item -m68020-40
3952 Generate output for a 68040, without using any of the new instructions.
3953 This results in code which can run relatively efficiently on either a
3954 68020/68881 or a 68030 or a 68040.  The generated code does use the
3955 68881 instructions that are emulated on the 68040.
3957 @item -m68020-60
3958 Generate output for a 68060, without using any of the new instructions.
3959 This results in code which can run relatively efficiently on either a
3960 68020/68881 or a 68030 or a 68040.  The generated code does use the
3961 68881 instructions that are emulated on the 68060.
3963 @item -mfpa
3964 Generate output containing Sun FPA instructions for floating point.
3966 @item -msoft-float
3967 Generate output containing library calls for floating point.
3968 @strong{Warning:} the requisite libraries are not available for all m68k
3969 targets.  Normally the facilities of the machine's usual C compiler are
3970 used, but this can't be done directly in cross-compilation.  You must
3971 make your own arrangements to provide suitable library functions for
3972 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
3973 @samp{m68k-*-coff} do provide software floating point support.
3975 @item -mshort
3976 Consider type @code{int} to be 16 bits wide, like @code{short int}.
3978 @item -mnobitfield
3979 Do not use the bit-field instructions.  The @samp{-m68000}, @samp{-mcpu32}
3980 and @samp{-m5200} options imply @w{@samp{-mnobitfield}}.
3982 @item -mbitfield
3983 Do use the bit-field instructions.  The @samp{-m68020} option implies
3984 @samp{-mbitfield}.  This is the default if you use a configuration
3985 designed for a 68020.
3987 @item -mrtd
3988 Use a different function-calling convention, in which functions
3989 that take a fixed number of arguments return with the @code{rtd}
3990 instruction, which pops their arguments while returning.  This
3991 saves one instruction in the caller since there is no need to pop
3992 the arguments there.
3994 This calling convention is incompatible with the one normally
3995 used on Unix, so you cannot use it if you need to call libraries
3996 compiled with the Unix compiler.
3998 Also, you must provide function prototypes for all functions that
3999 take variable numbers of arguments (including @code{printf});
4000 otherwise incorrect code will be generated for calls to those
4001 functions.
4003 In addition, seriously incorrect code will result if you call a
4004 function with too many arguments.  (Normally, extra arguments are
4005 harmlessly ignored.)
4007 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
4008 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
4010 @item -malign-int
4011 @itemx -mno-align-int
4012 Control whether GCC aligns @code{int}, @code{long}, @code{long long}, 
4013 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
4014 boundary (@samp{-malign-int}) or a 16-bit boundary (@samp{-mno-align-int}).
4015 Aligning variables on 32-bit boundaries produces code that runs somewhat
4016 faster on processors with 32-bit busses at the expense of more memory.
4018 @strong{Warning:} if you use the @samp{-malign-int} switch, GCC will
4019 align structures containing the above types  differently than
4020 most published application binary interface specifications for the m68k.
4022 @item -mpcrel
4023 Use the pc-relative addressing mode of the 68000 directly, instead of
4024 using a global offset table.  At present, this option implies -fpic,
4025 allowing at most a 16-bit offset for pc-relative addressing.  -fPIC is
4026 not presently supported with -mpcrel, though this could be supported for
4027 68020 and higher processors.
4029 @item -mno-strict-align
4030 @itemx -mstrict-align
4031 @kindex -mstrict-align
4032 Do not (do) assume that unaligned memory references will be handled by
4033 the system.
4035 @end table
4037 @node VAX Options
4038 @subsection VAX Options
4039 @cindex VAX options
4041 These @samp{-m} options are defined for the Vax:
4043 @table @code
4044 @item -munix
4045 Do not output certain jump instructions (@code{aobleq} and so on)
4046 that the Unix assembler for the Vax cannot handle across long
4047 ranges.
4049 @item -mgnu
4050 Do output those jump instructions, on the assumption that you
4051 will assemble with the GNU assembler.
4053 @item -mg
4054 Output code for g-format floating point numbers instead of d-format.
4055 @end table
4057 @node SPARC Options
4058 @subsection SPARC Options
4059 @cindex SPARC options
4061 These @samp{-m} switches are supported on the SPARC:
4063 @table @code
4064 @item -mno-app-regs
4065 @itemx -mapp-regs
4066 Specify @samp{-mapp-regs} to generate output using the global registers
4067 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
4068 is the default.
4070 To be fully SVR4 ABI compliant at the cost of some performance loss,
4071 specify @samp{-mno-app-regs}.  You should compile libraries and system
4072 software with this option.
4074 @item -mfpu
4075 @itemx -mhard-float
4076 Generate output containing floating point instructions.  This is the
4077 default.
4079 @item -mno-fpu
4080 @itemx -msoft-float
4081 Generate output containing library calls for floating point.
4082 @strong{Warning:} the requisite libraries are not available for all SPARC
4083 targets.  Normally the facilities of the machine's usual C compiler are
4084 used, but this cannot be done directly in cross-compilation.  You must make
4085 your own arrangements to provide suitable library functions for
4086 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
4087 @samp{sparclite-*-*} do provide software floating point support.
4089 @samp{-msoft-float} changes the calling convention in the output file;
4090 therefore, it is only useful if you compile @emph{all} of a program with
4091 this option.  In particular, you need to compile @file{libgcc.a}, the
4092 library that comes with GCC, with @samp{-msoft-float} in order for
4093 this to work.
4095 @item -mhard-quad-float
4096 Generate output containing quad-word (long double) floating point
4097 instructions.
4099 @item -msoft-quad-float
4100 Generate output containing library calls for quad-word (long double)
4101 floating point instructions.  The functions called are those specified
4102 in the SPARC ABI.  This is the default.
4104 As of this writing, there are no sparc implementations that have hardware
4105 support for the quad-word floating point instructions.  They all invoke
4106 a trap handler for one of these instructions, and then the trap handler
4107 emulates the effect of the instruction.  Because of the trap handler overhead,
4108 this is much slower than calling the ABI library routines.  Thus the
4109 @samp{-msoft-quad-float} option is the default.
4111 @item -mno-epilogue
4112 @itemx -mepilogue
4113 With @samp{-mepilogue} (the default), the compiler always emits code for
4114 function exit at the end of each function.  Any function exit in
4115 the middle of the function (such as a return statement in C) will
4116 generate a jump to the exit code at the end of the function.
4118 With @samp{-mno-epilogue}, the compiler tries to emit exit code inline
4119 at every function exit.
4121 @item -mno-flat
4122 @itemx -mflat
4123 With @samp{-mflat}, the compiler does not generate save/restore instructions
4124 and will use a "flat" or single register window calling convention.
4125 This model uses %i7 as the frame pointer and is compatible with the normal
4126 register window model.  Code from either may be intermixed.
4127 The local registers and the input registers (0-5) are still treated as
4128 "call saved" registers and will be saved on the stack as necessary.
4130 With @samp{-mno-flat} (the default), the compiler emits save/restore
4131 instructions (except for leaf functions) and is the normal mode of operation.
4133 @item -mno-unaligned-doubles
4134 @itemx -munaligned-doubles
4135 Assume that doubles have 8 byte alignment.  This is the default.
4137 With @samp{-munaligned-doubles}, GCC assumes that doubles have 8 byte
4138 alignment only if they are contained in another type, or if they have an
4139 absolute address.  Otherwise, it assumes they have 4 byte alignment.
4140 Specifying this option avoids some rare compatibility problems with code
4141 generated by other compilers.  It is not the default because it results
4142 in a performance loss, especially for floating point code.
4144 @item -mno-faster-structs
4145 @itemx -mfaster-structs
4146 With @samp{-mfaster-structs}, the compiler assumes that structures
4147 should have 8 byte alignment.  This enables the use of pairs of
4148 @code{ldd} and @code{std} instructions for copies in structure
4149 assignment, in place of twice as many @code{ld} and @code{st} pairs.
4150 However, the use of this changed alignment directly violates the Sparc
4151 ABI.  Thus, it's intended only for use on targets where the developer
4152 acknowledges that their resulting code will not be directly in line with
4153 the rules of the ABI.
4155 @item -mv8
4156 @itemx -msparclite
4157 These two options select variations on the SPARC architecture.
4159 By default (unless specifically configured for the Fujitsu SPARClite),
4160 GCC generates code for the v7 variant of the SPARC architecture.
4162 @samp{-mv8} will give you SPARC v8 code.  The only difference from v7
4163 code is that the compiler emits the integer multiply and integer
4164 divide instructions which exist in SPARC v8 but not in SPARC v7.
4166 @samp{-msparclite} will give you SPARClite code.  This adds the integer
4167 multiply, integer divide step and scan (@code{ffs}) instructions which
4168 exist in SPARClite but not in SPARC v7.
4170 These options are deprecated and will be deleted in a future GCC release.
4171 They have been replaced with @samp{-mcpu=xxx}.
4173 @item -mcypress
4174 @itemx -msupersparc
4175 These two options select the processor for which the code is optimised.
4177 With @samp{-mcypress} (the default), the compiler optimizes code for the
4178 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
4179 This is also appropriate for the older SparcStation 1, 2, IPX etc.
4181 With @samp{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
4182 used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
4183 of the full SPARC v8 instruction set.
4185 These options are deprecated and will be deleted in a future GCC release.
4186 They have been replaced with @samp{-mcpu=xxx}.
4188 @item -mcpu=@var{cpu_type}
4189 Set the instruction set, register set, and instruction scheduling parameters
4190 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
4191 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
4192 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
4193 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
4195 Default instruction scheduling parameters are used for values that select
4196 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
4197 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
4199 Here is a list of each supported architecture and their supported
4200 implementations.
4202 @smallexample
4203     v7:             cypress
4204     v8:             supersparc, hypersparc
4205     sparclite:      f930, f934, sparclite86x
4206     sparclet:       tsc701
4207     v9:             ultrasparc
4208 @end smallexample
4210 @item -mtune=@var{cpu_type}
4211 Set the instruction scheduling parameters for machine type
4212 @var{cpu_type}, but do not set the instruction set or register set that the
4213 option @samp{-mcpu=}@var{cpu_type} would.
4215 The same values for @samp{-mcpu=}@var{cpu_type} are used for
4216 @samp{-mtune=}@*@var{cpu_type}, though the only useful values are those that
4217 select a particular cpu implementation: @samp{cypress}, @samp{supersparc},
4218 @samp{hypersparc}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
4219 @samp{tsc701}, @samp{ultrasparc}.
4221 @end table
4223 These @samp{-m} switches are supported in addition to the above
4224 on the SPARCLET processor.
4226 @table @code
4227 @item -mlittle-endian
4228 Generate code for a processor running in little-endian mode.
4230 @item -mlive-g0
4231 Treat register @code{%g0} as a normal register.
4232 GCC will continue to clobber it as necessary but will not assume
4233 it always reads as 0.
4235 @item -mbroken-saverestore
4236 Generate code that does not use non-trivial forms of the @code{save} and
4237 @code{restore} instructions.  Early versions of the SPARCLET processor do
4238 not correctly handle @code{save} and @code{restore} instructions used with
4239 arguments.  They correctly handle them used without arguments.  A @code{save}
4240 instruction used without arguments increments the current window pointer
4241 but does not allocate a new stack frame.  It is assumed that the window
4242 overflow trap handler will properly handle this case as will interrupt
4243 handlers.
4244 @end table
4246 These @samp{-m} switches are supported in addition to the above
4247 on SPARC V9 processors in 64 bit environments.
4249 @table @code
4250 @item -mlittle-endian
4251 Generate code for a processor running in little-endian mode.
4253 @item -m32
4254 @itemx -m64
4255 Generate code for a 32 bit or 64 bit environment.
4256 The 32 bit environment sets int, long and pointer to 32 bits.
4257 The 64 bit environment sets int to 32 bits and long and pointer
4258 to 64 bits.
4260 @item -mcmodel=medlow
4261 Generate code for the Medium/Low code model: the program must be linked
4262 in the low 32 bits of the address space.  Pointers are 64 bits.
4263 Programs can be statically or dynamically linked.
4265 @item -mcmodel=medmid
4266 Generate code for the Medium/Middle code model: the program must be linked
4267 in the low 44 bits of the address space, the text segment must be less than
4268 2G bytes, and data segment must be within 2G of the text segment.
4269 Pointers are 64 bits.
4271 @item -mcmodel=medany
4272 Generate code for the Medium/Anywhere code model: the program may be linked
4273 anywhere in the address space, the text segment must be less than
4274 2G bytes, and data segment must be within 2G of the text segment.
4275 Pointers are 64 bits.
4277 @item -mcmodel=embmedany
4278 Generate code for the Medium/Anywhere code model for embedded systems:
4279 assume a 32 bit text and a 32 bit data segment, both starting anywhere
4280 (determined at link time).  Register %g4 points to the base of the
4281 data segment.  Pointers still 64 bits.
4282 Programs are statically linked, PIC is not supported.
4284 @item -mstack-bias
4285 @itemx -mno-stack-bias
4286 With @samp{-mstack-bias}, GCC assumes that the stack pointer, and
4287 frame pointer if present, are offset by -2047 which must be added back
4288 when making stack frame references.
4289 Otherwise, assume no such offset is present.
4290 @end table
4292 @node Convex Options
4293 @subsection Convex Options
4294 @cindex Convex options
4296 These @samp{-m} options are defined for Convex:
4298 @table @code
4299 @item -mc1
4300 Generate output for C1.  The code will run on any Convex machine.
4301 The preprocessor symbol @code{__convex__c1__} is defined.
4303 @item -mc2
4304 Generate output for C2.  Uses instructions not available on C1.
4305 Scheduling and other optimizations are chosen for max performance on C2.
4306 The preprocessor symbol @code{__convex_c2__} is defined.
4308 @item -mc32
4309 Generate output for C32xx.  Uses instructions not available on C1.
4310 Scheduling and other optimizations are chosen for max performance on C32.
4311 The preprocessor symbol @code{__convex_c32__} is defined.
4313 @item -mc34
4314 Generate output for C34xx.  Uses instructions not available on C1.
4315 Scheduling and other optimizations are chosen for max performance on C34.
4316 The preprocessor symbol @code{__convex_c34__} is defined.
4318 @item -mc38
4319 Generate output for C38xx.  Uses instructions not available on C1.
4320 Scheduling and other optimizations are chosen for max performance on C38.
4321 The preprocessor symbol @code{__convex_c38__} is defined.
4323 @item -margcount
4324 Generate code which puts an argument count in the word preceding each
4325 argument list.  This is compatible with regular CC, and a few programs
4326 may need the argument count word.  GDB and other source-level debuggers
4327 do not need it; this info is in the symbol table.
4329 @item -mnoargcount
4330 Omit the argument count word.  This is the default.
4332 @item -mvolatile-cache
4333 Allow volatile references to be cached.  This is the default.
4335 @item -mvolatile-nocache
4336 Volatile references bypass the data cache, going all the way to memory.
4337 This is only needed for multi-processor code that does not use standard
4338 synchronization instructions.  Making non-volatile references to volatile
4339 locations will not necessarily work.
4341 @item -mlong32
4342 Type long is 32 bits, the same as type int.  This is the default.
4344 @item -mlong64
4345 Type long is 64 bits, the same as type long long.  This option is useless,
4346 because no library support exists for it.
4347 @end table
4349 @node AMD29K Options
4350 @subsection AMD29K Options
4351 @cindex AMD29K options
4353 These @samp{-m} options are defined for the AMD Am29000:
4355 @table @code
4356 @item -mdw
4357 @kindex -mdw
4358 @cindex DW bit (29k)
4359 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
4360 halfword operations are directly supported by the hardware.  This is the
4361 default.
4363 @item -mndw
4364 @kindex -mndw
4365 Generate code that assumes the @code{DW} bit is not set.
4367 @item -mbw
4368 @kindex -mbw
4369 @cindex byte writes (29k)
4370 Generate code that assumes the system supports byte and halfword write
4371 operations.  This is the default.
4373 @item -mnbw
4374 @kindex -mnbw
4375 Generate code that assumes the systems does not support byte and
4376 halfword write operations.  @samp{-mnbw} implies @samp{-mndw}.
4378 @item -msmall
4379 @kindex -msmall
4380 @cindex memory model (29k)
4381 Use a small memory model that assumes that all function addresses are
4382 either within a single 256 KB segment or at an absolute address of less
4383 than 256k.  This allows the @code{call} instruction to be used instead
4384 of a @code{const}, @code{consth}, @code{calli} sequence.
4386 @item -mnormal
4387 @kindex -mnormal
4388 Use the normal memory model: Generate @code{call} instructions only when
4389 calling functions in the same file and @code{calli} instructions
4390 otherwise.  This works if each file occupies less than 256 KB but allows
4391 the entire executable to be larger than 256 KB.  This is the default.
4393 @item -mlarge
4394 Always use @code{calli} instructions.  Specify this option if you expect
4395 a single file to compile into more than 256 KB of code.
4397 @item -m29050
4398 @kindex -m29050
4399 @cindex processor selection (29k)
4400 Generate code for the Am29050.
4402 @item -m29000
4403 @kindex -m29000
4404 Generate code for the Am29000.  This is the default.
4406 @item -mkernel-registers
4407 @kindex -mkernel-registers
4408 @cindex kernel and user registers (29k)
4409 Generate references to registers @code{gr64-gr95} instead of to
4410 registers @code{gr96-gr127}.  This option can be used when compiling
4411 kernel code that wants a set of global registers disjoint from that used
4412 by user-mode code.
4414 Note that when this option is used, register names in @samp{-f} flags
4415 must use the normal, user-mode, names.
4417 @item -muser-registers
4418 @kindex -muser-registers
4419 Use the normal set of global registers, @code{gr96-gr127}.  This is the
4420 default.
4422 @item -mstack-check
4423 @itemx -mno-stack-check
4424 @kindex -mstack-check
4425 @cindex stack checks (29k)
4426 Insert (or do not insert) a call to @code{__msp_check} after each stack
4427 adjustment.  This is often used for kernel code.
4429 @item -mstorem-bug
4430 @itemx -mno-storem-bug
4431 @kindex -mstorem-bug
4432 @cindex storem bug (29k)
4433 @samp{-mstorem-bug} handles 29k processors which cannot handle the
4434 separation of a mtsrim insn and a storem instruction (most 29000 chips
4435 to date, but not the 29050).
4437 @item -mno-reuse-arg-regs
4438 @itemx -mreuse-arg-regs
4439 @kindex -mreuse-arg-regs
4440 @samp{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
4441 registers for copying out arguments.  This helps detect calling a function
4442 with fewer arguments than it was declared with.
4444 @item -mno-impure-text
4445 @itemx -mimpure-text
4446 @kindex -mimpure-text
4447 @samp{-mimpure-text}, used in addition to @samp{-shared}, tells the compiler to
4448 not pass @samp{-assert pure-text} to the linker when linking a shared object.
4450 @item -msoft-float
4451 @kindex -msoft-float
4452 Generate output containing library calls for floating point.
4453 @strong{Warning:} the requisite libraries are not part of GCC.
4454 Normally the facilities of the machine's usual C compiler are used, but
4455 this can't be done directly in cross-compilation.  You must make your
4456 own arrangements to provide suitable library functions for
4457 cross-compilation.
4459 @item -mno-multm
4460 @kindex -mno-multm
4461 Do not generate multm or multmu instructions.  This is useful for some embedded
4462 systems which do not have trap handlers for these instructions.
4463 @end table
4465 @node ARM Options
4466 @subsection ARM Options
4467 @cindex ARM options
4469 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
4470 architectures:
4472 @table @code
4473 @item -mapcs-frame
4474 @kindex -mapcs-frame
4475 Generate a stack frame that is compliant with the ARM Procedure Call
4476 Standard for all functions, even if this is not strictly necessary for
4477 correct execution of the code.  Specifying @samp{-fomit-frame-pointer}
4478 with this option will cause the stack frames not to be generated for
4479 leaf functions.  The default is @samp{-mno-apcs-frame}.
4481 @item -mapcs
4482 @kindex -mapcs
4483 This is a synonym for @samp{-mapcs-frame}.
4485 @item -mapcs-26
4486 @kindex -mapcs-26
4487 Generate code for a processor running with a 26-bit program counter,
4488 and conforming to the function calling standards for the APCS 26-bit
4489 option.  This option replaces the @samp{-m2} and @samp{-m3} options
4490 of previous releases of the compiler.
4492 @item -mapcs-32
4493 @kindex -mapcs-32
4494 Generate code for a processor running with a 32-bit program counter,
4495 and conforming to the function calling standards for the APCS 32-bit
4496 option.  This option replaces the @samp{-m6} option of previous releases
4497 of the compiler.
4499 @item -mapcs-stack-check
4500 @kindex -mapcs-stack-check
4501 @kindex -mno-apcs-stack-check
4502 Generate code to check the amount of stack space available upon entry to
4503 every function (that actually uses some stack space).  If there is
4504 insufficient space available then either the function
4505 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
4506 called, depending upon the amount of stack space required.  The run time
4507 system is required to provide these functions.  The default is
4508 @samp{-mno-apcs-stack-check}, since this produces smaller code.
4510 @item -mapcs-float
4511 @kindex -mapcs-float
4512 @kindex -mno-apcs-float
4513 Pass floating point arguments using the float point registers.  This is
4514 one of the variants of the APCS.  This option is recommended if the
4515 target hardware has a floating point unit or if a lot of floating point
4516 arithmetic is going to be performed by the code.  The default is
4517 @samp{-mno-apcs-float}, since integer only code is slightly increased in
4518 size if @samp{-mapcs-float} is used.
4520 @item -mapcs-reentrant
4521 @kindex -mapcs-reentrant
4522 @kindex -mno-apcs-reentrant
4523 Generate reentrant, position independent code.  This is the equivalent
4524 to specifying the @samp{-fpic} option.  The default is
4525 @samp{-mno-apcs-reentrant}.
4527 @item -mthumb-interwork
4528 @kindex -mthumb-interwork
4529 @kindex -mno-thumb-interwork
4530 Generate code which supports calling between the ARM and THUMB
4531 instruction sets.  Without this option the two instruction sets cannot
4532 be reliably used inside one program.  The default is
4533 @samp{-mno-thumb-interwork}, since slightly larger code is generated
4534 when @samp{-mthumb-interwork} is specified.
4536 @item -mno-sched-prolog
4537 @kindex -mno-sched-prolog
4538 @kindex -msched-prolog
4539 Prevent the reordering of instructions in the function prolog, or the
4540 merging of those instruction with the instructions in the function's
4541 body.  This means that all functions will start with a recognizable set
4542 of instructions (or in fact one of a choice from a small set of
4543 different function prologues), and this information can be used to
4544 locate the start if functions inside an executable piece of code.  The
4545 default is @samp{-msched-prolog}.
4547 @item -mhard-float
4548 Generate output containing floating point instructions.  This is the
4549 default.
4551 @item -msoft-float
4552 Generate output containing library calls for floating point.
4553 @strong{Warning:} the requisite libraries are not available for all ARM
4554 targets.  Normally the facilities of the machine's usual C compiler are
4555 used, but this cannot be done directly in cross-compilation.  You must make
4556 your own arrangements to provide suitable library functions for
4557 cross-compilation.
4559 @samp{-msoft-float} changes the calling convention in the output file;
4560 therefore, it is only useful if you compile @emph{all} of a program with
4561 this option.  In particular, you need to compile @file{libgcc.a}, the
4562 library that comes with GCC, with @samp{-msoft-float} in order for
4563 this to work.
4565 @item -mlittle-endian
4566 Generate code for a processor running in little-endian mode.  This is
4567 the default for all standard configurations.
4569 @item -mbig-endian
4570 Generate code for a processor running in big-endian mode; the default is
4571 to compile code for a little-endian processor.
4573 @item -mwords-little-endian
4574 This option only applies when generating code for big-endian processors.
4575 Generate code for a little-endian word order but a big-endian byte
4576 order.  That is, a byte order of the form @samp{32107654}.  Note: this
4577 option should only be used if you require compatibility with code for
4578 big-endian ARM processors generated by versions of the compiler prior to
4579 2.8.
4581 @item -malignment-traps
4582 @kindex -malignment-traps
4583 Generate code that will not trap if the MMU has alignment traps enabled.
4584 On ARM architectures prior to ARMv4, there were no instructions to
4585 access half-word objects stored in memory.  However, when reading from
4586 memory a feature of the ARM architecture allows a word load to be used,
4587 even if the address is unaligned, and the processor core will rotate the
4588 data as it is being loaded.  This option tells the compiler that such
4589 misaligned accesses will cause a MMU trap and that it should instead
4590 synthesise the access as a series of byte accesses.  The compiler can
4591 still use word accesses to load half-word data if it knows that the
4592 address is aligned to a word boundary.
4594 This option is ignored when compiling for ARM architecture 4 or later,
4595 since these processors have instructions to directly access half-word
4596 objects in memory. 
4597         
4598 @item -mno-alignment-traps
4599 @kindex -mno-alignment-traps
4600 Generate code that assumes that the MMU will not trap unaligned
4601 accesses.  This produces better code when the target instruction set
4602 does not have half-word memory operations (implementations prior to
4603 ARMv4). 
4605 Note that you cannot use this option to access unaligned word objects,
4606 since the processor will only fetch one 32-bit aligned object from
4607 memory. 
4609 The default setting for most targets is -mno-alignment-traps, since
4610 this produces better code when there are no half-word memory
4611 instructions available. 
4613 @item -mshort-load-bytes
4614 @kindex -mshort-load-bytes
4615 This is a depreciated alias for @samp{-malignment-traps}.
4617 @item -mno-short-load-bytes
4618 @kindex -mno-short-load-bytes
4619 This is a depreciated alias for @samp{-mno-alignment-traps}.
4621 @item -mshort-load-words
4622 @kindex -mshort-load-words
4623 This is a depreciated alias for @samp{-mno-alignment-traps}.
4625 @item -mno-short-load-words
4626 @kindex -mno-short-load-words
4627 This is a depreciated alias for @samp{-malignment-traps}.
4629 @item -mbsd
4630 @kindex -mbsd
4631 This option only applies to RISC iX.  Emulate the native BSD-mode
4632 compiler.  This is the default if @samp{-ansi} is not specified.
4634 @item -mxopen
4635 @kindex -mxopen
4636 This option only applies to RISC iX.  Emulate the native X/Open-mode
4637 compiler.
4639 @item -mno-symrename
4640 @kindex -mno-symrename
4641 This option only applies to RISC iX.  Do not run the assembler
4642 post-processor, @samp{symrename}, after code has been assembled.
4643 Normally it is necessary to modify some of the standard symbols in
4644 preparation for linking with the RISC iX C library; this option
4645 suppresses this pass.  The post-processor is never run when the
4646 compiler is built for cross-compilation.
4648 @item -mcpu=<name>
4649 @kindex -mcpu=
4650 This specifies the name of the target ARM processor.  GCC uses this name
4651 to determine what kind of instructions it can use when generating
4652 assembly code.  Permissible names are: arm2, arm250, arm3, arm6, arm60,
4653 arm600, arm610, arm620, arm7, arm7m, arm7d, arm7dm, arm7di, arm7dmi,
4654 arm70, arm700, arm700i, arm710, arm710c, arm7100, arm7500, arm7500fe,
4655 arm7tdmi, arm8, strongarm, strongarm110, strongarm1100, arm8, arm810,
4656 arm9, arm920, arm920t, arm9tdmi.
4658 @itemx -mtune=<name>
4659 @kindex -mtune=
4660 This option is very similar to the @samp{-mcpu=} option, except that
4661 instead of specifying the actual target processor type, and hence
4662 restricting which instructions can be used, it specifies that GCC should
4663 tune the performance of the code as if the target were of the type
4664 specified in this option, but still choosing the instructions that it
4665 will generate based on the cpu specified by a @samp{-mcpu=} option.
4666 For some arm implementations better performance can be obtained by using
4667 this option.
4669 @item -march=<name>
4670 @kindex -march=
4671 This specifies the name of the target ARM architecture.  GCC uses this
4672 name to determine what kind of instructions it can use when generating
4673 assembly code.  This option can be used in conjunction with or instead
4674 of the @samp{-mcpu=} option.  Permissible names are: armv2, armv2a,
4675 armv3, armv3m, armv4, armv4t, armv5.
4677 @item -mfpe=<number>
4678 @itemx -mfp=<number>
4679 @kindex -mfpe=
4680 @kindex -mfp=
4681 This specifies the version of the floating point emulation available on
4682 the target.  Permissible values are 2 and 3.  @samp{-mfp=} is a synonym
4683 for @samp{-mfpe=} to support older versions of GCC.
4685 @item -mstructure-size-boundary=<n>
4686 @kindex -mstructure-size-boundary
4687 The size of all structures and unions will be rounded up to a multiple
4688 of the number of bits set by this option.  Permissible values are 8 and
4689 32.  The default value varies for different toolchains.  For the COFF
4690 targeted toolchain the default value is 8.  Specifying the larger number
4691 can produce faster, more efficient code, but can also increase the size
4692 of the program.  The two values are potentially incompatible.  Code
4693 compiled with one value cannot necessarily expect to work with code or
4694 libraries compiled with the other value, if they exchange information
4695 using structures or unions.  Programmers are encouraged to use the 32
4696 value as future versions of the toolchain may default to this value.
4698 @item -mabort-on-noreturn
4699 @kindex -mabort-on-noreturn
4700 @kindex -mnoabort-on-noreturn
4701 Generate a call to the function abort at the end of a noreturn function.
4702 It will be executed if the function tries to return.
4704 @item -mlong-calls
4705 @itemx -mno-long-calls
4706 Tells the compiler to perform function calls by first loading the
4707 address of the function into a register and then performing a subroutine
4708 call on this register.  This switch is needed if the target function
4709 will lie outside of the 64 megabyte addressing range of the offset based
4710 version of subroutine call instruction. 
4712 Even if this switch is enabled, not all function calls will be turned
4713 into long calls.  The heuristic is that static functions, functions
4714 which have the @samp{short-call} attribute, functions that are inside
4715 the scope of a @samp{#pragma no_long_calls} directive and functions whose
4716 definitions have already been compiled within the current compilation
4717 unit, will not be turned into long calls.  The exception to this rule is
4718 that weak function definitions, functions with the @samp{long-call}
4719 attribute or the @samp{section} attribute, and functions that are within
4720 the scope of a @samp{#pragma long_calls} directive, will always be
4721 turned into long calls.
4723 This feature is not enabled by default.  Specifying
4724 @samp{--no-long-calls} will restore the default behaviour, as will
4725 placing the function calls within the scope of a @samp{#pragma
4726 long_calls_off} directive.  Note these switches have no effect on how
4727 the compiler generates code to handle function calls via function
4728 pointers.  
4730 @item -mnop-fun-dllimport
4731 @kindex -mnop-fun-dllimport
4732 Disable the support for the @emph{dllimport} attribute.
4734 @item -msingle-pic-base
4735 @kindex -msingle-pic-base
4736 Treat the register used for PIC addressing as read-only, rather than
4737 loading it in the prologue for each function.  The run-time system is
4738 responsible for initialising this register with an appropriate value
4739 before execution begins.
4741 @item -mpic-register=<reg>
4742 @kindex -mpic-register=
4743 Specify the register to be used for PIC addressing.  The default is R10
4744 unless stack-checking is enabled, when R9 is used.
4746 @end table
4748 @node Thumb Options
4749 @subsection Thumb Options
4750 @cindex Thumb Options
4752 @table @code
4754 @item -mthumb-interwork
4755 @kindex -mthumb-interwork
4756 @kindex -mno-thumb-interwork
4757 Generate code which supports calling between the THUMB and ARM
4758 instruction sets.  Without this option the two instruction sets cannot
4759 be reliably used inside one program.  The default is
4760 @samp{-mno-thumb-interwork}, since slightly smaller code is generated
4761 with this option.
4763 @item -mtpcs-frame
4764 @kindex -mtpcs-frame
4765 @kindex -mno-tpcs-frame
4766 Generate a stack frame that is compliant with the Thumb Procedure Call
4767 Standard for all non-leaf functions.  (A leaf function is one that does
4768 not call any other functions).  The default is @samp{-mno-apcs-frame}. 
4770 @item -mtpcs-leaf-frame
4771 @kindex -mtpcs-leaf-frame
4772 @kindex -mno-tpcs-leaf-frame
4773 Generate a stack frame that is compliant with the Thumb Procedure Call
4774 Standard for all leaf functions.  (A leaf function is one that does
4775 not call any other functions).  The default is @samp{-mno-apcs-leaf-frame}. 
4777 @item -mlittle-endian
4778 @kindex -mlittle-endian
4779 Generate code for a processor running in little-endian mode.  This is
4780 the default for all standard configurations.
4782 @item -mbig-endian
4783 @kindex -mbig-endian
4784 Generate code for a processor running in big-endian mode.
4786 @item -mstructure-size-boundary=<n>
4787 @kindex -mstructure-size-boundary
4788 The size of all structures and unions will be rounded up to a multiple
4789 of the number of bits set by this option.  Permissible values are 8 and
4790 32.  The default value varies for different toolchains.  For the COFF
4791 targeted toolchain the default value is 8.  Specifying the larger number
4792 can produced faster, more efficient code, but can also increase the size
4793 of the program.  The two values are potentially incompatible.  Code
4794 compiled with one value cannot necessarily expect to work with code or
4795 libraries compiled with the other value, if they exchange information
4796 using structures or unions.  Programmers are encouraged to use the 32
4797 value as future versions of the toolchain may default to this value.
4799 @item -mnop-fun-dllimport
4800 @kindex -mnop-fun-dllimport
4801 Disable the support for the @emph{dllimport} attribute.
4803 @item -mcallee-super-interworking
4804 @kindex -mcallee-super-interworking
4805 Gives all externally visible functions in the file being compiled an ARM
4806 instruction set header which switches to Thumb mode before executing the
4807 rest of the function.  This allows these functions to be called from
4808 non-interworking code.
4810 @item -mcaller-super-interworking
4811 @kindex -mcaller-super-interworking
4812 Allows calls via function pointers (including virtual functions) to
4813 execute correctly regardless of whether the target code has been
4814 compiled for interworking or not.  There is a small overhead in the cost
4815 of executing a function pointer if this option is enabled.
4817 @item -msingle-pic-base
4818 @kindex -msingle-pic-base
4819 Treat the register used for PIC addressing as read-only, rather than
4820 loading it in the prologue for each function.  The run-time system is
4821 responsible for initialising this register with an appropriate value
4822 before execution begins.
4824 @item -mpic-register=<reg>
4825 @kindex -mpic-register=
4826 Specify the register to be used for PIC addressing.  The default is R10.
4828 @end table
4830 @node MN10200 Options
4831 @subsection MN10200 Options
4832 @cindex MN10200 options
4833 These @samp{-m} options are defined for Matsushita MN10200 architectures:
4834 @table @code
4836 @item -mrelax
4837 Indicate to the linker that it should perform a relaxation optimization pass
4838 to shorten branches, calls and absolute memory addresses.  This option only
4839 has an effect when used on the command line for the final link step.
4841 This option makes symbolic debugging impossible. 
4842 @end table
4844 @node MN10300 Options
4845 @subsection MN10300 Options
4846 @cindex MN10300 options
4847 These @samp{-m} options are defined for Matsushita MN10300 architectures:
4849 @table @code
4850 @item -mmult-bug
4851 Generate code to avoid bugs in the multiply instructions for the MN10300
4852 processors.  This is the default.
4854 @item -mno-mult-bug
4855 Do not generate code to avoid bugs in the multiply instructions for the
4856 MN10300 processors.
4858 @item -mam33
4859 Generate code which uses features specific to the AM33 processor.
4861 @item -mno-am33
4862 Do not generate code which uses features specific to the AM33 processor.  This
4863 is the default.
4865 @item -mrelax
4866 Indicate to the linker that it should perform a relaxation optimization pass
4867 to shorten branches, calls and absolute memory addresses.  This option only
4868 has an effect when used on the command line for the final link step.
4870 This option makes symbolic debugging impossible. 
4871 @end table
4874 @node M32R/D Options
4875 @subsection M32R/D Options
4876 @cindex M32R/D options
4878 These @samp{-m} options are defined for Mitsubishi M32R/D architectures:
4880 @table @code
4881 @item -mcode-model=small
4882 Assume all objects live in the lower 16MB of memory (so that their addresses
4883 can be loaded with the @code{ld24} instruction), and assume all subroutines
4884 are reachable with the @code{bl} instruction.
4885 This is the default.
4887 The addressability of a particular object can be set with the
4888 @code{model} attribute.
4890 @item -mcode-model=medium
4891 Assume objects may be anywhere in the 32 bit address space (the compiler
4892 will generate @code{seth/add3} instructions to load their addresses), and
4893 assume all subroutines are reachable with the @code{bl} instruction.
4895 @item -mcode-model=large
4896 Assume objects may be anywhere in the 32 bit address space (the compiler
4897 will generate @code{seth/add3} instructions to load their addresses), and
4898 assume subroutines may not be reachable with the @code{bl} instruction
4899 (the compiler will generate the much slower @code{seth/add3/jl}
4900 instruction sequence).
4902 @item -msdata=none
4903 Disable use of the small data area.  Variables will be put into
4904 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
4905 @code{section} attribute has been specified).
4906 This is the default.
4908 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
4909 Objects may be explicitly put in the small data area with the
4910 @code{section} attribute using one of these sections.
4912 @item -msdata=sdata
4913 Put small global and static data in the small data area, but do not
4914 generate special code to reference them.
4916 @item -msdata=use
4917 Put small global and static data in the small data area, and generate
4918 special instructions to reference them.
4920 @item -G @var{num}
4921 @cindex smaller data references
4922 Put global and static objects less than or equal to @var{num} bytes
4923 into the small data or bss sections instead of the normal data or bss
4924 sections.  The default value of @var{num} is 8.
4925 The @samp{-msdata} option must be set to one of @samp{sdata} or @samp{use}
4926 for this option to have any effect.
4928 All modules should be compiled with the same @samp{-G @var{num}} value.
4929 Compiling with different values of @var{num} may or may not work; if it
4930 doesn't the linker will give an error message - incorrect code will not be
4931 generated.
4933 @end table
4935 @node M88K Options
4936 @subsection M88K Options
4937 @cindex M88k options
4939 These @samp{-m} options are defined for Motorola 88k architectures:
4941 @table @code
4942 @item -m88000
4943 @kindex -m88000
4944 Generate code that works well on both the m88100 and the
4945 m88110.
4947 @item -m88100
4948 @kindex -m88100
4949 Generate code that works best for the m88100, but that also
4950 runs on the m88110.
4952 @item -m88110
4953 @kindex -m88110
4954 Generate code that works best for the m88110, and may not run
4955 on the m88100.
4957 @item -mbig-pic
4958 @kindex -mbig-pic
4959 Obsolete option to be removed from the next revision.
4960 Use @samp{-fPIC}.
4962 @item -midentify-revision
4963 @kindex -midentify-revision
4964 @kindex ident
4965 @cindex identifying source, compiler (88k)
4966 Include an @code{ident} directive in the assembler output recording the
4967 source file name, compiler name and version, timestamp, and compilation
4968 flags used.
4970 @item -mno-underscores
4971 @kindex -mno-underscores
4972 @cindex underscores, avoiding (88k)
4973 In assembler output, emit symbol names without adding an underscore
4974 character at the beginning of each name.  The default is to use an
4975 underscore as prefix on each name.
4977 @item -mocs-debug-info
4978 @itemx -mno-ocs-debug-info
4979 @kindex -mocs-debug-info
4980 @kindex -mno-ocs-debug-info
4981 @cindex OCS (88k)
4982 @cindex debugging, 88k OCS
4983 Include (or omit) additional debugging information (about registers used
4984 in each stack frame) as specified in the 88open Object Compatibility
4985 Standard, ``OCS''.  This extra information allows debugging of code that
4986 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
4987 Delta 88 SVr3.2 is to include this information; other 88k configurations
4988 omit this information by default.
4990 @item -mocs-frame-position
4991 @kindex -mocs-frame-position
4992 @cindex register positions in frame (88k)
4993 When emitting COFF debugging information for automatic variables and
4994 parameters stored on the stack, use the offset from the canonical frame
4995 address, which is the stack pointer (register 31) on entry to the
4996 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
4997 @samp{-mocs-frame-position}; other 88k configurations have the default
4998 @samp{-mno-ocs-frame-position}.
5000 @item -mno-ocs-frame-position
5001 @kindex -mno-ocs-frame-position
5002 @cindex register positions in frame (88k)
5003 When emitting COFF debugging information for automatic variables and
5004 parameters stored on the stack, use the offset from the frame pointer
5005 register (register 30).  When this option is in effect, the frame
5006 pointer is not eliminated when debugging information is selected by the
5007 -g switch.
5009 @item -moptimize-arg-area
5010 @itemx -mno-optimize-arg-area
5011 @kindex -moptimize-arg-area
5012 @kindex -mno-optimize-arg-area
5013 @cindex arguments in frame (88k)
5014 Control how function arguments are stored in stack frames.
5015 @samp{-moptimize-arg-area} saves space by optimizing them, but this
5016 conflicts with the 88open specifications.  The opposite alternative,
5017 @samp{-mno-optimize-arg-area}, agrees with 88open standards.  By default
5018 GCC does not optimize the argument area.
5020 @item -mshort-data-@var{num}
5021 @kindex -mshort-data-@var{num}
5022 @cindex smaller data references (88k)
5023 @cindex r0-relative references (88k)
5024 Generate smaller data references by making them relative to @code{r0},
5025 which allows loading a value using a single instruction (rather than the
5026 usual two).  You control which data references are affected by
5027 specifying @var{num} with this option.  For example, if you specify
5028 @samp{-mshort-data-512}, then the data references affected are those
5029 involving displacements of less than 512 bytes.
5030 @samp{-mshort-data-@var{num}} is not effective for @var{num} greater
5031 than 64k.
5033 @item -mserialize-volatile
5034 @kindex -mserialize-volatile
5035 @itemx -mno-serialize-volatile
5036 @kindex -mno-serialize-volatile
5037 @cindex sequential consistency on 88k
5038 Do, or don't, generate code to guarantee sequential consistency
5039 of volatile memory references.  By default, consistency is
5040 guaranteed.
5042 The order of memory references made by the MC88110 processor does
5043 not always match the order of the instructions requesting those
5044 references.  In particular, a load instruction may execute before
5045 a preceding store instruction.  Such reordering violates
5046 sequential consistency of volatile memory references, when there
5047 are multiple processors.   When consistency must be guaranteed,
5048 GNU C generates special instructions, as needed, to force
5049 execution in the proper order.
5051 The MC88100 processor does not reorder memory references and so
5052 always provides sequential consistency.  However, by default, GNU
5053 C generates the special instructions to guarantee consistency
5054 even when you use @samp{-m88100}, so that the code may be run on an
5055 MC88110 processor.  If you intend to run your code only on the
5056 MC88100 processor, you may use @samp{-mno-serialize-volatile}.
5058 The extra code generated to guarantee consistency may affect the
5059 performance of your application.  If you know that you can safely
5060 forgo this guarantee, you may use @samp{-mno-serialize-volatile}.
5062 @item -msvr4
5063 @itemx -msvr3
5064 @kindex -msvr4
5065 @kindex -msvr3
5066 @cindex assembler syntax, 88k
5067 @cindex SVr4
5068 Turn on (@samp{-msvr4}) or off (@samp{-msvr3}) compiler extensions
5069 related to System V release 4 (SVr4).  This controls the following:
5071 @enumerate
5072 @item
5073 Which variant of the assembler syntax to emit.
5074 @item
5075 @samp{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
5076 that is used on System V release 4.
5077 @item
5078 @samp{-msvr4} makes GCC issue additional declaration directives used in
5079 SVr4.
5080 @end enumerate
5082 @samp{-msvr4} is the default for the m88k-motorola-sysv4 and
5083 m88k-dg-dgux m88k configurations. @samp{-msvr3} is the default for all
5084 other m88k configurations.
5086 @item -mversion-03.00
5087 @kindex -mversion-03.00
5088 This option is obsolete, and is ignored.
5089 @c ??? which asm syntax better for GAS?  option there too?
5091 @item -mno-check-zero-division
5092 @itemx -mcheck-zero-division
5093 @kindex -mno-check-zero-division
5094 @kindex -mcheck-zero-division
5095 @cindex zero division on 88k
5096 Do, or don't, generate code to guarantee that integer division by
5097 zero will be detected.  By default, detection is guaranteed.
5099 Some models of the MC88100 processor fail to trap upon integer
5100 division by zero under certain conditions.  By default, when
5101 compiling code that might be run on such a processor, GNU C
5102 generates code that explicitly checks for zero-valued divisors
5103 and traps with exception number 503 when one is detected.  Use of
5104 mno-check-zero-division suppresses such checking for code
5105 generated to run on an MC88100 processor.
5107 GNU C assumes that the MC88110 processor correctly detects all
5108 instances of integer division by zero.  When @samp{-m88110} is
5109 specified, both @samp{-mcheck-zero-division} and
5110 @samp{-mno-check-zero-division} are ignored, and no explicit checks for
5111 zero-valued divisors are generated.
5113 @item -muse-div-instruction
5114 @kindex -muse-div-instruction
5115 @cindex divide instruction, 88k
5116 Use the div instruction for signed integer division on the
5117 MC88100 processor.  By default, the div instruction is not used.
5119 On the MC88100 processor the signed integer division instruction
5120 div) traps to the operating system on a negative operand.  The
5121 operating system transparently completes the operation, but at a
5122 large cost in execution time.  By default, when compiling code
5123 that might be run on an MC88100 processor, GNU C emulates signed
5124 integer division using the unsigned integer division instruction
5125 divu), thereby avoiding the large penalty of a trap to the
5126 operating system.  Such emulation has its own, smaller, execution
5127 cost in both time and space.  To the extent that your code's
5128 important signed integer division operations are performed on two
5129 nonnegative operands, it may be desirable to use the div
5130 instruction directly.
5132 On the MC88110 processor the div instruction (also known as the
5133 divs instruction) processes negative operands without trapping to
5134 the operating system.  When @samp{-m88110} is specified,
5135 @samp{-muse-div-instruction} is ignored, and the div instruction is used
5136 for signed integer division.
5138 Note that the result of dividing INT_MIN by -1 is undefined.  In
5139 particular, the behavior of such a division with and without
5140 @samp{-muse-div-instruction}  may differ.
5142 @item -mtrap-large-shift
5143 @itemx -mhandle-large-shift
5144 @kindex -mtrap-large-shift
5145 @kindex -mhandle-large-shift
5146 @cindex bit shift overflow (88k)
5147 @cindex large bit shifts (88k)
5148 Include code to detect bit-shifts of more than 31 bits; respectively,
5149 trap such shifts or emit code to handle them properly.  By default GCC
5150 makes no special provision for large bit shifts.
5152 @item -mwarn-passed-structs
5153 @kindex -mwarn-passed-structs
5154 @cindex structure passing (88k)
5155 Warn when a function passes a struct as an argument or result.
5156 Structure-passing conventions have changed during the evolution of the C
5157 language, and are often the source of portability problems.  By default,
5158 GCC issues no such warning.
5159 @end table
5161 @node RS/6000 and PowerPC Options
5162 @subsection IBM RS/6000 and PowerPC Options
5163 @cindex RS/6000 and PowerPC Options
5164 @cindex IBM RS/6000 and PowerPC Options
5166 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
5167 @table @code
5168 @item -mpower
5169 @itemx -mno-power
5170 @itemx -mpower2
5171 @itemx -mno-power2
5172 @itemx -mpowerpc
5173 @itemx -mno-powerpc
5174 @itemx -mpowerpc-gpopt
5175 @itemx -mno-powerpc-gpopt
5176 @itemx -mpowerpc-gfxopt
5177 @itemx -mno-powerpc-gfxopt
5178 @itemx -mpowerpc64
5179 @itemx -mno-powerpc64
5180 @kindex -mpower
5181 @kindex -mpower2
5182 @kindex -mpowerpc
5183 @kindex -mpowerpc-gpopt
5184 @kindex -mpowerpc-gfxopt
5185 @kindex -mpowerpc64
5186 GCC supports two related instruction set architectures for the
5187 RS/6000 and PowerPC.  The @dfn{POWER} instruction set are those
5188 instructions supported by the @samp{rios} chip set used in the original
5189 RS/6000 systems and the @dfn{PowerPC} instruction set is the
5190 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
5191 the IBM 4xx microprocessors.
5193 Neither architecture is a subset of the other.  However there is a
5194 large common subset of instructions supported by both.  An MQ
5195 register is included in processors supporting the POWER architecture.
5197 You use these options to specify which instructions are available on the
5198 processor you are using.  The default value of these options is
5199 determined when configuring GCC.  Specifying the
5200 @samp{-mcpu=@var{cpu_type}} overrides the specification of these
5201 options.  We recommend you use the @samp{-mcpu=@var{cpu_type}} option
5202 rather than the options listed above.
5204 The @samp{-mpower} option allows GCC to generate instructions that
5205 are found only in the POWER architecture and to use the MQ register.
5206 Specifying @samp{-mpower2} implies @samp{-power} and also allows GCC
5207 to generate instructions that are present in the POWER2 architecture but
5208 not the original POWER architecture.
5210 The @samp{-mpowerpc} option allows GCC to generate instructions that
5211 are found only in the 32-bit subset of the PowerPC architecture.
5212 Specifying @samp{-mpowerpc-gpopt} implies @samp{-mpowerpc} and also allows
5213 GCC to use the optional PowerPC architecture instructions in the
5214 General Purpose group, including floating-point square root.  Specifying
5215 @samp{-mpowerpc-gfxopt} implies @samp{-mpowerpc} and also allows GCC to
5216 use the optional PowerPC architecture instructions in the Graphics
5217 group, including floating-point select.
5219 The @samp{-mpowerpc64} option allows GCC to generate the additional
5220 64-bit instructions that are found in the full PowerPC64 architecture
5221 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
5222 @samp{-mno-powerpc64}.
5224 If you specify both @samp{-mno-power} and @samp{-mno-powerpc}, GCC
5225 will use only the instructions in the common subset of both
5226 architectures plus some special AIX common-mode calls, and will not use
5227 the MQ register.  Specifying both @samp{-mpower} and @samp{-mpowerpc}
5228 permits GCC to use any instruction from either architecture and to
5229 allow use of the MQ register; specify this for the Motorola MPC601.
5231 @item -mnew-mnemonics
5232 @itemx -mold-mnemonics
5233 @kindex -mnew-mnemonics
5234 @kindex -mold-mnemonics
5235 Select which mnemonics to use in the generated assembler code.
5236 @samp{-mnew-mnemonics} requests output that uses the assembler mnemonics
5237 defined for the PowerPC architecture, while @samp{-mold-mnemonics}
5238 requests the assembler mnemonics defined for the POWER architecture.
5239 Instructions defined in only one architecture have only one mnemonic;
5240 GCC uses that mnemonic irrespective of which of these options is
5241 specified.
5243 GCC defaults to the mnemonics appropriate for the architecture in
5244 use.  Specifying @samp{-mcpu=@var{cpu_type}} sometimes overrides the
5245 value of these option.  Unless you are building a cross-compiler, you
5246 should normally not specify either @samp{-mnew-mnemonics} or
5247 @samp{-mold-mnemonics}, but should instead accept the default.
5249 @item -mcpu=@var{cpu_type}
5250 @kindex -mcpu
5251 Set architecture type, register usage, choice of mnemonics, and
5252 instruction scheduling parameters for machine type @var{cpu_type}.
5253 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
5254 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
5255 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
5256 @samp{630}, @samp{740}, @samp{750}, @samp{power}, @samp{power2},
5257 @samp{powerpc}, @samp{403}, @samp{505}, @samp{801}, @samp{821},
5258 @samp{823}, and @samp{860} and @samp{common}.  @samp{-mcpu=power},
5259 @samp{-mcpu=power2}, @samp{-mcpu=powerpc}, and @samp{-mcpu=powerpc64}
5260 specify generic POWER, POWER2, pure 32-bit PowerPC (i.e., not MPC601),
5261 and 64-bit PowerPC architecture machine types, with an appropriate,
5262 generic processor model assumed for scheduling purposes.@refill
5264 Specifying any of the following options: 
5265 @samp{-mcpu=rios1}, @samp{-mcpu=rios2}, @samp{-mcpu=rsc},
5266 @samp{-mcpu=power}, or @samp{-mcpu=power2}  
5267 enables the @samp{-mpower} option and disables the @samp{-mpowerpc} option; 
5268 @samp{-mcpu=601} enables both the @samp{-mpower} and @samp{-mpowerpc} options.
5269 All of @samp{-mcpu=rs64a}, @samp{-mcpu=602}, @samp{-mcpu=603},
5270 @samp{-mcpu=603e}, @samp{-mcpu=604}, @samp{-mcpu=620}, @samp{-mcpu=630},
5271 @samp{-mcpu=740}, and @samp{-mcpu=750}
5272 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.  
5273 Exactly similarly, all of @samp{-mcpu=403},
5274 @samp{-mcpu=505}, @samp{-mcpu=821}, @samp{-mcpu=860} and @samp{-mcpu=powerpc} 
5275 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
5276 @samp{-mcpu=common} disables both the 
5277 @samp{-mpower} and @samp{-mpowerpc} options.@refill
5279 AIX versions 4 or greater selects @samp{-mcpu=common} by default, so
5280 that code will operate on all members of the RS/6000 POWER and PowerPC
5281 families.  In that case, GCC will use only the instructions in the
5282 common subset of both architectures plus some special AIX common-mode
5283 calls, and will not use the MQ register.  GCC assumes a generic
5284 processor model for scheduling purposes.
5286 Specifying any of the options @samp{-mcpu=rios1}, @samp{-mcpu=rios2},
5287 @samp{-mcpu=rsc}, @samp{-mcpu=power}, or @samp{-mcpu=power2} also
5288 disables the @samp{new-mnemonics} option.  Specifying @samp{-mcpu=601},
5289 @samp{-mcpu=602}, @samp{-mcpu=603}, @samp{-mcpu=603e}, @samp{-mcpu=604},
5290 @samp{-mcpu=620}, @samp{-mcpu=630}, @samp{-mcpu=403}, @samp{-mcpu=505},
5291 @samp{-mcpu=821}, @samp{-mcpu=860} or @samp{-mcpu=powerpc} also enables
5292 the @samp{new-mnemonics} option.@refill
5294 Specifying @samp{-mcpu=403}, @samp{-mcpu=821}, or @samp{-mcpu=860} also
5295 enables the @samp{-msoft-float} option.
5297 @item -mtune=@var{cpu_type}
5298 Set the instruction scheduling parameters for machine type
5299 @var{cpu_type}, but do not set the architecture type, register usage,
5300 choice of mnemonics like @samp{-mcpu=}@var{cpu_type} would.  The same
5301 values for @var{cpu_type} are used for @samp{-mtune=}@var{cpu_type} as
5302 for @samp{-mcpu=}@var{cpu_type}.  The @samp{-mtune=}@var{cpu_type}
5303 option overrides the @samp{-mcpu=}@var{cpu_type} option in terms of
5304 instruction scheduling parameters.
5306 @item -mfull-toc
5307 @itemx -mno-fp-in-toc
5308 @itemx -mno-sum-in-toc
5309 @itemx -mminimal-toc
5310 @kindex -mminimal-toc
5311 Modify generation of the TOC (Table Of Contents), which is created for
5312 every executable file.  The @samp{-mfull-toc} option is selected by
5313 default.  In that case, GCC will allocate at least one TOC entry for
5314 each unique non-automatic variable reference in your program.  GCC
5315 will also place floating-point constants in the TOC.  However, only
5316 16,384 entries are available in the TOC.
5318 If you receive a linker error message that saying you have overflowed
5319 the available TOC space, you can reduce the amount of TOC space used
5320 with the @samp{-mno-fp-in-toc} and @samp{-mno-sum-in-toc} options.
5321 @samp{-mno-fp-in-toc} prevents GCC from putting floating-point
5322 constants in the TOC and @samp{-mno-sum-in-toc} forces GCC to
5323 generate code to calculate the sum of an address and a constant at
5324 run-time instead of putting that sum into the TOC.  You may specify one
5325 or both of these options.  Each causes GCC to produce very slightly
5326 slower and larger code at the expense of conserving TOC space.
5328 If you still run out of space in the TOC even when you specify both of
5329 these options, specify @samp{-mminimal-toc} instead.  This option causes
5330 GCC to make only one TOC entry for every file.  When you specify this
5331 option, GCC will produce code that is slower and larger but which
5332 uses extremely little TOC space.  You may wish to use this option
5333 only on files that contain less frequently executed code. @refill
5335 @item -maix64
5336 @itemx -maix32
5337 @kindex -maix64
5338 @kindex -maix32
5339 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
5340 @code{long} type, and the infrastructure needed to support them.
5341 Specifying @samp{-maix64} implies @samp{-mpowerpc64} and
5342 @samp{-mpowerpc}, while @samp{-maix32} disables the 64-bit ABI and
5343 implies @samp{-mno-powerpc64}.  GCC defaults to @samp{-maix32}.
5345 @item -mxl-call
5346 @itemx -mno-xl-call
5347 @kindex -mxl-call
5348 On AIX, pass floating-point arguments to prototyped functions beyond the
5349 register save area (RSA) on the stack in addition to argument FPRs.  The
5350 AIX calling convention was extended but not initially documented to
5351 handle an obscure K&R C case of calling a function that takes the
5352 address of its arguments with fewer arguments than declared.  AIX XL
5353 compilers access floating point arguments which do not fit in the
5354 RSA from the stack when a subroutine is compiled without
5355 optimization.  Because always storing floating-point arguments on the
5356 stack is inefficient and rarely needed, this option is not enabled by
5357 default and only is necessary when calling subroutines compiled by AIX
5358 XL compilers without optimization.
5360 @item -mthreads
5361 @kindex -mthreads
5362 Support @dfn{AIX Threads}.  Link an application written to use
5363 @dfn{pthreads} with special libraries and startup code to enable the
5364 application to run.
5366 @item -mpe
5367 @kindex -mpe
5368 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE).  Link an
5369 application written to use message passing with special startup code to
5370 enable the application to run.  The system must have PE installed in the
5371 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
5372 must be overridden with the @samp{-specs=} option to specify the
5373 appropriate directory location.  The Parallel Environment does not
5374 support threads, so the @samp{-mpe} option and the @samp{-mthreads}
5375 option are incompatible.
5377 @item -msoft-float
5378 @itemx -mhard-float
5379 @kindex -msoft-float
5380 Generate code that does not use (uses) the floating-point register set.
5381 Software floating point emulation is provided if you use the
5382 @samp{-msoft-float} option, and pass the option to GCC when linking.
5384 @item -mmultiple
5385 @itemx -mno-multiple
5386 Generate code that uses (does not use) the load multiple word
5387 instructions and the store multiple word instructions.  These
5388 instructions are generated by default on POWER systems, and not
5389 generated on PowerPC systems.  Do not use @samp{-mmultiple} on little
5390 endian PowerPC systems, since those instructions do not work when the
5391 processor is in little endian mode.  The exceptions are PPC740 and
5392 PPC750 which permit the instructions usage in little endian mode.
5394 @item -mstring
5395 @itemx -mno-string
5396 @kindex -mstring
5397 Generate code that uses (does not use) the load string instructions
5398 and the store string word instructions to save multiple registers and
5399 do small block moves.  These instructions are generated by default on
5400 POWER systems, and not generated on PowerPC systems.  Do not use
5401 @samp{-mstring} on little endian PowerPC systems, since those
5402 instructions do not work when the processor is in little endian mode.
5403 The exceptions are PPC740 and PPC750 which permit the instructions
5404 usage in little endian mode.
5406 @item -mupdate
5407 @itemx -mno-update
5408 @kindex -mupdate
5409 Generate code that uses (does not use) the load or store instructions
5410 that update the base register to the address of the calculated memory
5411 location.  These instructions are generated by default.  If you use
5412 @samp{-mno-update}, there is a small window between the time that the
5413 stack pointer is updated and the address of the previous frame is
5414 stored, which means code that walks the stack frame across interrupts or
5415 signals may get corrupted data.
5417 @item -mfused-madd
5418 @itemx -mno-fused-madd
5419 @kindex -mfused-madd
5420 Generate code that uses (does not use) the floating point multiply and
5421 accumulate instructions.  These instructions are generated by default if
5422 hardware floating is used.
5424 @item -mno-bit-align
5425 @itemx -mbit-align
5426 @kindex -mbit-align
5427 On System V.4 and embedded PowerPC systems do not (do) force structures
5428 and unions that contain bit fields to be aligned to the base type of the
5429 bit field.
5431 For example, by default a structure containing nothing but 8
5432 @code{unsigned} bitfields of length 1 would be aligned to a 4 byte
5433 boundary and have a size of 4 bytes.  By using @samp{-mno-bit-align},
5434 the structure would be aligned to a 1 byte boundary and be one byte in
5435 size.
5437 @item -mno-strict-align
5438 @itemx -mstrict-align
5439 @kindex -mstrict-align
5440 On System V.4 and embedded PowerPC systems do not (do) assume that
5441 unaligned memory references will be handled by the system.
5443 @item -mrelocatable
5444 @itemx -mno-relocatable
5445 @kindex -mrelocatable
5446 On embedded PowerPC systems generate code that allows (does not allow)
5447 the program to be relocated to a different address at runtime.  If you
5448 use @samp{-mrelocatable} on any module, all objects linked together must
5449 be compiled with @samp{-mrelocatable} or @samp{-mrelocatable-lib}.
5451 @item -mrelocatable-lib
5452 @itemx -mno-relocatable-lib
5453 On embedded PowerPC systems generate code that allows (does not allow)
5454 the program to be relocated to a different address at runtime.  Modules
5455 compiled with @samp{-mrelocatable-lib} can be linked with either modules
5456 compiled without @samp{-mrelocatable} and @samp{-mrelocatable-lib} or
5457 with modules compiled with the @samp{-mrelocatable} options.
5459 @item -mno-toc
5460 @itemx -mtoc
5461 On System V.4 and embedded PowerPC systems do not (do) assume that
5462 register 2 contains a pointer to a global area pointing to the addresses
5463 used in the program.
5465 @item -mlittle
5466 @itemx -mlittle-endian
5467 On System V.4 and embedded PowerPC systems compile code for the
5468 processor in little endian mode.  The @samp{-mlittle-endian} option is
5469 the same as @samp{-mlittle}.
5471 @item -mbig
5472 @itemx -mbig-endian
5473 On System V.4 and embedded PowerPC systems compile code for the
5474 processor in big endian mode.  The @samp{-mbig-endian} option is
5475 the same as @samp{-mbig}.
5477 @item -mcall-sysv
5478 On System V.4 and embedded PowerPC systems compile code using calling
5479 conventions that adheres to the March 1995 draft of the System V
5480 Application Binary Interface, PowerPC processor supplement.  This is the
5481 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
5483 @item -mcall-sysv-eabi
5484 Specify both @samp{-mcall-sysv} and @samp{-meabi} options.
5486 @item -mcall-sysv-noeabi
5487 Specify both @samp{-mcall-sysv} and @samp{-mno-eabi} options.
5489 @item -mcall-aix
5490 On System V.4 and embedded PowerPC systems compile code using calling
5491 conventions that are similar to those used on AIX.  This is the
5492 default if you configured GCC using @samp{powerpc-*-eabiaix}.
5494 @item -mcall-solaris
5495 On System V.4 and embedded PowerPC systems compile code for the Solaris
5496 operating system.
5498 @item -mcall-linux
5499 On System V.4 and embedded PowerPC systems compile code for the
5500 Linux-based GNU system.
5502 @item -mprototype
5503 @itemx -mno-prototype
5504 On System V.4 and embedded PowerPC systems assume that all calls to
5505 variable argument functions are properly prototyped.  Otherwise, the
5506 compiler must insert an instruction before every non prototyped call to
5507 set or clear bit 6 of the condition code register (@var{CR}) to
5508 indicate whether floating point values were passed in the floating point
5509 registers in case the function takes a variable arguments.  With
5510 @samp{-mprototype}, only calls to prototyped variable argument functions
5511 will set or clear the bit.
5513 @item -msim
5514 On embedded PowerPC systems, assume that the startup module is called
5515 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
5516 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
5517 configurations.
5519 @item -mmvme
5520 On embedded PowerPC systems, assume that the startup module is called
5521 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
5522 @file{libc.a}.
5524 @item -mads
5525 On embedded PowerPC systems, assume that the startup module is called
5526 @file{crt0.o} and the standard C libraries are @file{libads.a} and
5527 @file{libc.a}.
5529 @item -myellowknife
5530 On embedded PowerPC systems, assume that the startup module is called
5531 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
5532 @file{libc.a}.
5534 @item -memb
5535 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
5536 header to indicate that @samp{eabi} extended relocations are used.
5538 @item -meabi
5539 @itemx -mno-eabi
5540 On System V.4 and embedded PowerPC systems do (do not) adhere to the
5541 Embedded Applications Binary Interface (eabi) which is a set of
5542 modifications to the System V.4 specifications.  Selecting @code{-meabi}
5543 means that the stack is aligned to an 8 byte boundary, a function
5544 @code{__eabi} is called to from @code{main} to set up the eabi
5545 environment, and the @samp{-msdata} option can use both @code{r2} and
5546 @code{r13} to point to two separate small data areas.  Selecting
5547 @code{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
5548 do not call an initialization function from @code{main}, and the
5549 @samp{-msdata} option will only use @code{r13} to point to a single
5550 small data area.  The @samp{-meabi} option is on by default if you
5551 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
5553 @item -msdata=eabi
5554 On System V.4 and embedded PowerPC systems, put small initialized
5555 @code{const} global and static data in the @samp{.sdata2} section, which
5556 is pointed to by register @code{r2}.  Put small initialized
5557 non-@code{const} global and static data in the @samp{.sdata} section,
5558 which is pointed to by register @code{r13}.  Put small uninitialized
5559 global and static data in the @samp{.sbss} section, which is adjacent to
5560 the @samp{.sdata} section.  The @samp{-msdata=eabi} option is
5561 incompatible with the @samp{-mrelocatable} option.  The
5562 @samp{-msdata=eabi} option also sets the @samp{-memb} option.
5564 @item -msdata=sysv
5565 On System V.4 and embedded PowerPC systems, put small global and static
5566 data in the @samp{.sdata} section, which is pointed to by register
5567 @code{r13}.  Put small uninitialized global and static data in the
5568 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
5569 The @samp{-msdata=sysv} option is incompatible with the
5570 @samp{-mrelocatable} option.
5572 @item -msdata=default
5573 @itemx -msdata
5574 On System V.4 and embedded PowerPC systems, if @samp{-meabi} is used,
5575 compile code the same as @samp{-msdata=eabi}, otherwise compile code the
5576 same as @samp{-msdata=sysv}.
5578 @item -msdata-data
5579 On System V.4 and embedded PowerPC systems, put small global and static
5580 data in the @samp{.sdata} section.  Put small uninitialized global and
5581 static data in the @samp{.sbss} section.  Do not use register @code{r13}
5582 to address small data however.  This is the default behavior unless
5583 other @samp{-msdata} options are used.
5585 @item -msdata=none
5586 @itemx -mno-sdata
5587 On embedded PowerPC systems, put all initialized global and static data
5588 in the @samp{.data} section, and all uninitialized data in the
5589 @samp{.bss} section.
5591 @item -G @var{num}
5592 @cindex smaller data references (PowerPC)
5593 @cindex .sdata/.sdata2 references (PowerPC)
5594 On embedded PowerPC systems, put global and static items less than or
5595 equal to @var{num} bytes into the small data or bss sections instead of
5596 the normal data or bss section.  By default, @var{num} is 8.  The
5597 @samp{-G @var{num}} switch is also passed to the linker.
5598 All modules should be compiled with the same @samp{-G @var{num}} value.
5600 @item -mregnames
5601 @itemx -mno-regnames
5602 On System V.4 and embedded PowerPC systems do (do not) emit register
5603 names in the assembly language output using symbolic forms.
5605 @end table
5607 @node RT Options
5608 @subsection IBM RT Options
5609 @cindex RT options
5610 @cindex IBM RT options
5612 These @samp{-m} options are defined for the IBM RT PC:
5614 @table @code
5615 @item -min-line-mul
5616 Use an in-line code sequence for integer multiplies.  This is the
5617 default.
5619 @item -mcall-lib-mul
5620 Call @code{lmul$$} for integer multiples.
5622 @item -mfull-fp-blocks
5623 Generate full-size floating point data blocks, including the minimum
5624 amount of scratch space recommended by IBM.  This is the default.
5626 @item -mminimum-fp-blocks
5627 Do not include extra scratch space in floating point data blocks.  This
5628 results in smaller code, but slower execution, since scratch space must
5629 be allocated dynamically.
5631 @cindex @file{varargs.h} and RT PC
5632 @cindex @file{stdarg.h} and RT PC
5633 @item -mfp-arg-in-fpregs
5634 Use a calling sequence incompatible with the IBM calling convention in
5635 which floating point arguments are passed in floating point registers.
5636 Note that @code{varargs.h} and @code{stdargs.h} will not work with
5637 floating point operands if this option is specified.
5639 @item -mfp-arg-in-gregs
5640 Use the normal calling convention for floating point arguments.  This is
5641 the default.
5643 @item -mhc-struct-return
5644 Return structures of more than one word in memory, rather than in a
5645 register.  This provides compatibility with the MetaWare HighC (hc)
5646 compiler.  Use the option @samp{-fpcc-struct-return} for compatibility
5647 with the Portable C Compiler (pcc).
5649 @item -mnohc-struct-return
5650 Return some structures of more than one word in registers, when
5651 convenient.  This is the default.  For compatibility with the
5652 IBM-supplied compilers, use the option @samp{-fpcc-struct-return} or the
5653 option @samp{-mhc-struct-return}.
5654 @end table
5656 @node MIPS Options
5657 @subsection MIPS Options
5658 @cindex MIPS options
5660 These @samp{-m} options are defined for the MIPS family of computers:
5662 @table @code
5663 @item -mcpu=@var{cpu type}
5664 Assume the defaults for the machine type @var{cpu type} when scheduling
5665 instructions.  The choices for @var{cpu type} are @samp{r2000}, @samp{r3000},
5666 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
5667 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
5668 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
5669 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
5670 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.  While picking a specific
5671 @var{cpu type} will schedule things appropriately for that particular
5672 chip, the compiler will not generate any code that does not meet level 1
5673 of the MIPS ISA (instruction set architecture) without a @samp{-mipsX}
5674 or @samp{-mabi} switch being used.
5676 @item -mips1
5677 Issue instructions from level 1 of the MIPS ISA.  This is the default.
5678 @samp{r3000} is the default @var{cpu type} at this ISA level.
5680 @item -mips2
5681 Issue instructions from level 2 of the MIPS ISA (branch likely, square
5682 root instructions).  @samp{r6000} is the default @var{cpu type} at this
5683 ISA level.
5685 @item -mips3
5686 Issue instructions from level 3 of the MIPS ISA (64 bit instructions).
5687 @samp{r4000} is the default @var{cpu type} at this ISA level.
5689 @item -mips4
5690 Issue instructions from level 4 of the MIPS ISA (conditional move,
5691 prefetch, enhanced FPU instructions).  @samp{r8000} is the default
5692 @var{cpu type} at this ISA level.
5694 @item -mfp32
5695 Assume that 32 32-bit floating point registers are available.  This is
5696 the default.
5698 @item -mfp64
5699 Assume that 32 64-bit floating point registers are available.  This is
5700 the default when the @samp{-mips3} option is used.
5702 @item -mgp32
5703 Assume that 32 32-bit general purpose registers are available.  This is
5704 the default.
5706 @item -mgp64
5707 Assume that 32 64-bit general purpose registers are available.  This is
5708 the default when the @samp{-mips3} option is used.
5710 @item -mint64
5711 Force int and long types to be 64 bits wide.  See @samp{-mlong32} for an
5712 explanation of the default, and the width of pointers.
5714 @item -mlong64
5715 Force long types to be 64 bits wide.  See @samp{-mlong32} for an
5716 explanation of the default, and the width of pointers.
5718 @item -mlong32
5719 Force long, int, and pointer types to be 32 bits wide.
5721 If none of @samp{-mlong32}, @samp{-mlong64}, or @samp{-mint64} are set,
5722 the size of ints, longs, and pointers depends on the ABI and ISA chosen.
5723 For @samp{-mabi=32}, and @samp{-mabi=n32}, ints and longs are 32 bits
5724 wide.  For @samp{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
5725 For @samp{-mabi=eabi} and either @samp{-mips1} or @samp{-mips2}, ints
5726 and longs are 32 bits wide.  For @samp{-mabi=eabi} and higher ISAs, ints
5727 are 32 bits, and longs are 64 bits wide.  The width of pointer types is
5728 the smaller of the width of longs or the width of general purpose
5729 registers (which in turn depends on the ISA).
5731 @item -mabi=32
5732 @itemx -mabi=o64
5733 @itemx -mabi=n32
5734 @itemx -mabi=64
5735 @itemx -mabi=eabi
5736 Generate code for the indicated ABI.  The default instruction level is
5737 @samp{-mips1} for @samp{32}, @samp{-mips3} for @samp{n32}, and
5738 @samp{-mips4} otherwise.  Conversely, with @samp{-mips1} or
5739 @samp{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
5740 is @samp{64}.
5742 @item -mmips-as
5743 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
5744 add normal debug information.  This is the default for all
5745 platforms except for the OSF/1 reference platform, using the OSF/rose
5746 object format.  If the either of the @samp{-gstabs} or @samp{-gstabs+}
5747 switches are used, the @file{mips-tfile} program will encapsulate the
5748 stabs within MIPS ECOFF.
5750 @item -mgas
5751 Generate code for the GNU assembler.  This is the default on the OSF/1
5752 reference platform, using the OSF/rose object format.  Also, this is
5753 the default if the configure option @samp{--with-gnu-as} is used.
5755 @item -msplit-addresses
5756 @itemx -mno-split-addresses
5757 Generate code to load the high and low parts of address constants separately.
5758 This allows @code{gcc} to optimize away redundant loads of the high order
5759 bits of addresses.  This optimization requires GNU as and GNU ld.
5760 This optimization is enabled by default for some embedded targets where
5761 GNU as and GNU ld are standard.
5763 @item -mrnames
5764 @itemx -mno-rnames
5765 The @samp{-mrnames} switch says to output code using the MIPS software
5766 names for the registers, instead of the hardware names (ie, @var{a0}
5767 instead of @var{$4}).  The only known assembler that supports this option
5768 is the Algorithmics assembler.
5770 @item -mgpopt
5771 @itemx -mno-gpopt
5772 The @samp{-mgpopt} switch says to write all of the data declarations
5773 before the instructions in the text section, this allows the MIPS
5774 assembler to generate one word memory references instead of using two
5775 words for short global or static data items.  This is on by default if
5776 optimization is selected.
5778 @item -mstats
5779 @itemx -mno-stats
5780 For each non-inline function processed, the @samp{-mstats} switch
5781 causes the compiler to emit one line to the standard error file to
5782 print statistics about the program (number of registers saved, stack
5783 size, etc.).
5785 @item -mmemcpy
5786 @itemx -mno-memcpy
5787 The @samp{-mmemcpy} switch makes all block moves call the appropriate
5788 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
5789 generating inline code.
5791 @item -mmips-tfile
5792 @itemx -mno-mips-tfile
5793 The @samp{-mno-mips-tfile} switch causes the compiler not
5794 postprocess the object file with the @file{mips-tfile} program,
5795 after the MIPS assembler has generated it to add debug support.  If
5796 @file{mips-tfile} is not run, then no local variables will be
5797 available to the debugger.  In addition, @file{stage2} and
5798 @file{stage3} objects will have the temporary file names passed to the
5799 assembler embedded in the object file, which means the objects will
5800 not compare the same.  The @samp{-mno-mips-tfile} switch should only
5801 be used when there are bugs in the @file{mips-tfile} program that
5802 prevents compilation.
5804 @item -msoft-float
5805 Generate output containing library calls for floating point.
5806 @strong{Warning:} the requisite libraries are not part of GCC.
5807 Normally the facilities of the machine's usual C compiler are used, but
5808 this can't be done directly in cross-compilation.  You must make your
5809 own arrangements to provide suitable library functions for
5810 cross-compilation.
5812 @item -mhard-float
5813 Generate output containing floating point instructions.  This is the
5814 default if you use the unmodified sources.
5816 @item -mabicalls
5817 @itemx -mno-abicalls
5818 Emit (or do not emit) the pseudo operations @samp{.abicalls},
5819 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
5820 position independent code.
5822 @item -mlong-calls
5823 @itemx -mno-long-calls
5824 Do all calls with the @samp{JALR} instruction, which requires
5825 loading up a function's address into a register before the call.
5826 You need to use this switch, if you call outside of the current
5827 512 megabyte segment to functions that are not through pointers.
5829 @item -mhalf-pic
5830 @itemx -mno-half-pic
5831 Put pointers to extern references into the data section and load them
5832 up, rather than put the references in the text section.
5834 @item -membedded-pic
5835 @itemx -mno-embedded-pic
5836 Generate PIC code suitable for some embedded systems.  All calls are
5837 made using PC relative address, and all data is addressed using the $gp
5838 register.  No more than 65536 bytes of global data may be used.  This
5839 requires GNU as and GNU ld which do most of the work.  This currently
5840 only works on targets which use ECOFF; it does not work with ELF.
5842 @item -membedded-data
5843 @itemx -mno-embedded-data
5844 Allocate variables to the read-only data section first if possible, then
5845 next in the small data section if possible, otherwise in data.  This gives
5846 slightly slower code than the default, but reduces the amount of RAM required
5847 when executing, and thus may be preferred for some embedded systems.
5849 @item -muninit-const-in-rodata
5850 @itemx -mno-uninit-const-in-rodata
5851 When used together with -membedded-data, it will always store uninitialized
5852 const variables in the read-only data section.
5853   
5854 @item -msingle-float
5855 @itemx -mdouble-float
5856 The @samp{-msingle-float} switch tells gcc to assume that the floating
5857 point coprocessor only supports single precision operations, as on the
5858 @samp{r4650} chip.  The @samp{-mdouble-float} switch permits gcc to use
5859 double precision operations.  This is the default.
5861 @item -mmad
5862 @itemx -mno-mad
5863 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
5864 as on the @samp{r4650} chip.
5866 @item -m4650
5867 Turns on @samp{-msingle-float}, @samp{-mmad}, and, at least for now,
5868 @samp{-mcpu=r4650}.
5870 @item -mips16
5871 @itemx -mno-mips16
5872 Enable 16-bit instructions.
5874 @item -mentry
5875 Use the entry and exit pseudo ops.  This option can only be used with
5876 @samp{-mips16}.
5878 @item -EL
5879 Compile code for the processor in little endian mode.
5880 The requisite libraries are assumed to exist.
5882 @item -EB
5883 Compile code for the processor in big endian mode.
5884 The requisite libraries are assumed to exist.
5886 @item -G @var{num}
5887 @cindex smaller data references (MIPS)
5888 @cindex gp-relative references (MIPS)
5889 Put global and static items less than or equal to @var{num} bytes into
5890 the small data or bss sections instead of the normal data or bss
5891 section.  This allows the assembler to emit one word memory reference
5892 instructions based on the global pointer (@var{gp} or @var{$28}),
5893 instead of the normal two words used.  By default, @var{num} is 8 when
5894 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
5895 @samp{-G @var{num}} switch is also passed to the assembler and linker.
5896 All modules should be compiled with the same @samp{-G @var{num}}
5897 value.
5899 @item -nocpp
5900 Tell the MIPS assembler to not run its preprocessor over user
5901 assembler files (with a @samp{.s} suffix) when assembling them.
5903 @item -mfix7000
5904 Pass an option to gas which will cause nops to be inserted if
5905 the read of the destination register of an mfhi or mflo instruction
5906 occurs in the following two instructions.
5908 @item -no-crt0
5909 Do not include the default crt0.
5910 @end table
5912 @ifset INTERNALS
5913 These options are defined by the macro
5914 @code{TARGET_SWITCHES} in the machine description.  The default for the
5915 options is also defined by that macro, which enables you to change the
5916 defaults.
5917 @end ifset
5919 @node i386 Options
5920 @subsection Intel 386 Options
5921 @cindex i386 Options
5922 @cindex Intel 386 Options
5924 These @samp{-m} options are defined for the i386 family of computers:
5926 @table @code
5927 @item -mcpu=@var{cpu type}
5928 Assume the defaults for the machine type @var{cpu type} when scheduling
5929 instructions.  The choices for @var{cpu type} are:
5931 @multitable @columnfractions .20 .20 .20 .20
5932 @item @samp{i386} @tab @samp{i486} @tab @samp{i586} @tab @samp{i686}
5933 @item @samp{pentium} @tab @samp{pentiumpro} @tab @samp{k6}
5934 @end multitable
5936 While picking a specific @var{cpu type} will schedule things appropriately
5937 for that particular chip, the compiler will not generate any code that
5938 does not run on the i386 without the @samp{-march=@var{cpu type}} option
5939 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
5940 is equivalent to @samp{pentiumpro}.  @samp{k6} is the AMD chip as
5941 opposed to the Intel ones.
5943 @item -march=@var{cpu type}
5944 Generate instructions for the machine type @var{cpu type}.  The choices
5945 for @var{cpu type} are the same as for @samp{-mcpu}.  Moreover, 
5946 specifying @samp{-march=@var{cpu type}} implies @samp{-mcpu=@var{cpu type}}.
5948 @item -m386
5949 @itemx -m486
5950 @itemx -mpentium
5951 @itemx -mpentiumpro
5952 Synonyms for -mcpu=i386, -mcpu=i486, -mcpu=pentium, and -mcpu=pentiumpro
5953 respectively.  These synonyms are deprecated.
5955 @item -mieee-fp
5956 @itemx -mno-ieee-fp
5957 Control whether or not the compiler uses IEEE floating point
5958 comparisons.  These handle correctly the case where the result of a
5959 comparison is unordered.
5961 @item -msoft-float
5962 Generate output containing library calls for floating point.
5963 @strong{Warning:} the requisite libraries are not part of GCC.
5964 Normally the facilities of the machine's usual C compiler are used, but
5965 this can't be done directly in cross-compilation.  You must make your
5966 own arrangements to provide suitable library functions for
5967 cross-compilation.
5969 On machines where a function returns floating point results in the 80387
5970 register stack, some floating point opcodes may be emitted even if
5971 @samp{-msoft-float} is used.
5973 @item -mno-fp-ret-in-387
5974 Do not use the FPU registers for return values of functions.
5976 The usual calling convention has functions return values of types
5977 @code{float} and @code{double} in an FPU register, even if there
5978 is no FPU.  The idea is that the operating system should emulate
5979 an FPU.
5981 The option @samp{-mno-fp-ret-in-387} causes such values to be returned
5982 in ordinary CPU registers instead.
5984 @item -mno-fancy-math-387
5985 Some 387 emulators do not support the @code{sin}, @code{cos} and
5986 @code{sqrt} instructions for the 387.  Specify this option to avoid
5987 generating those instructions. This option is the default on FreeBSD.
5988 As of revision 2.6.1, these instructions are not generated unless you
5989 also use the @samp{-ffast-math} switch.
5991 @item -malign-double
5992 @itemx -mno-align-double
5993 Control whether GCC aligns @code{double}, @code{long double}, and
5994 @code{long long} variables on a two word boundary or a one word
5995 boundary.  Aligning @code{double} variables on a two word boundary will
5996 produce code that runs somewhat faster on a @samp{Pentium} at the
5997 expense of more memory.
5999 @strong{Warning:} if you use the @samp{-malign-double} switch,
6000 structures containing the above types will be aligned differently than
6001 the published application binary interface specifications for the 386.
6003 @item -msvr3-shlib
6004 @itemx -mno-svr3-shlib
6005 Control whether GCC places uninitialized locals into @code{bss} or
6006 @code{data}.  @samp{-msvr3-shlib} places these locals into @code{bss}.
6007 These options are meaningful only on System V Release 3.
6009 @item -mno-wide-multiply
6010 @itemx -mwide-multiply
6011 Control whether GCC uses the @code{mul} and @code{imul} that produce
6012 64 bit results in @code{eax:edx} from 32 bit operands to do @code{long
6013 long} multiplies and 32-bit division by constants.
6015 @item -mrtd
6016 Use a different function-calling convention, in which functions that
6017 take a fixed number of arguments return with the @code{ret} @var{num}
6018 instruction, which pops their arguments while returning.  This saves one
6019 instruction in the caller since there is no need to pop the arguments
6020 there.
6022 You can specify that an individual function is called with this calling
6023 sequence with the function attribute @samp{stdcall}.  You can also
6024 override the @samp{-mrtd} option by using the function attribute
6025 @samp{cdecl}.  @xref{Function Attributes}.
6027 @strong{Warning:} this calling convention is incompatible with the one
6028 normally used on Unix, so you cannot use it if you need to call
6029 libraries compiled with the Unix compiler.
6031 Also, you must provide function prototypes for all functions that
6032 take variable numbers of arguments (including @code{printf});
6033 otherwise incorrect code will be generated for calls to those
6034 functions.
6036 In addition, seriously incorrect code will result if you call a
6037 function with too many arguments.  (Normally, extra arguments are
6038 harmlessly ignored.)
6040 @item -mreg-alloc=@var{regs}
6041 Control the default allocation order of integer registers.  The
6042 string @var{regs} is a series of letters specifying a register.  The
6043 supported letters are: @code{a} allocate EAX; @code{b} allocate EBX;
6044 @code{c} allocate ECX; @code{d} allocate EDX; @code{S} allocate ESI;
6045 @code{D} allocate EDI; @code{B} allocate EBP.
6047 @item -mregparm=@var{num}
6048 Control how many registers are used to pass integer arguments.  By
6049 default, no registers are used to pass arguments, and at most 3
6050 registers can be used.  You can control this behavior for a specific
6051 function by using the function attribute @samp{regparm}.
6052 @xref{Function Attributes}.
6054 @strong{Warning:} if you use this switch, and
6055 @var{num} is nonzero, then you must build all modules with the same
6056 value, including any libraries.  This includes the system libraries and
6057 startup modules.
6059 @item -malign-loops=@var{num}
6060 Align loops to a 2 raised to a @var{num} byte boundary.  If
6061 @samp{-malign-loops} is not specified, the default is 2 unless
6062 gas 2.8 (or later) is being used in which case the default is
6063 to align the loop on a 16 byte boundary if it is less than 8
6064 bytes away.
6066 @item -malign-jumps=@var{num}
6067 Align instructions that are only jumped to to a 2 raised to a @var{num}
6068 byte boundary.  If @samp{-malign-jumps} is not specified, the default is
6069 2 if optimizing for a 386, and 4 if optimizing for a 486 unless
6070 gas 2.8 (or later) is being used in which case the default is
6071 to align the instruction on a 16 byte boundary if it is less
6072 than 8 bytes away.
6074 @item -malign-functions=@var{num}
6075 Align the start of functions to a 2 raised to @var{num} byte boundary.
6076 If @samp{-malign-functions} is not specified, the default is 2 if optimizing
6077 for a 386, and 4 if optimizing for a 486.
6079 @item -mpreferred-stack-boundary=@var{num}
6080 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
6081 byte boundary.  If @samp{-mpreferred-stack-boundary} is not specified,
6082 the default is 4 (16 bytes or 128 bits).
6084 The stack is required to be aligned on a 4 byte boundary.  On Pentium
6085 and PentiumPro, @code{double} and @code{long double} values should be
6086 aligned to an 8 byte boundary (see @samp{-malign-double}) or suffer
6087 significant run time performance penalties.  On Pentium III, the
6088 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
6089 penalties if it is not 16 byte aligned.
6091 To ensure proper alignment of this values on the stack, the stack boundary
6092 must be as aligned as that required by any value stored on the stack. 
6093 Further, every function must be generated such that it keeps the stack
6094 aligned.  Thus calling a function compiled with a higher preferred
6095 stack boundary from a function compiled with a lower preferred stack
6096 boundary will most likely misalign the stack.  It is recommended that
6097 libraries that use callbacks always use the default setting.
6099 This extra alignment does consume extra stack space.  Code that is sensitive
6100 to stack space usage, such as embedded systems and operating system kernels,
6101 may want to reduce the preferred alignment to
6102 @samp{-mpreferred-stack-boundary=2}.
6104 @item -mpush-args
6105 @kindex -mpush-args
6106 Use PUSH operations to store outgoing parameters. This method is shorter
6107 and usually equally fast as method using SUB/MOV operations and is enabled
6108 by default. In some cases disabling it may improve performance because of
6109 improved scheduling and reduced dependencies.
6111 @item -maccumulate-outgoing-args
6112 @kindex -maccumulate-outgoing-args
6113 If enabled, the maximum amount of space required for outgoing arguments will be
6114 computed in the function prologue. This in faster on most modern CPUs
6115 because of reduced dependencies, improved scheduling and reduced stack usage
6116 when preferred stack boundary is not equal to 2.  The drawback is a notable
6117 increase in code size. This switch implies -mno-push-args.
6119 @item -mthreads
6120 @kindex -mthreads
6121 Support thread-safe exception handling on @samp{Mingw32}. Code that relies 
6122 on thread-safe exception handling must compile and link all code with the 
6123 @samp{-mthreads} option. When compiling, @samp{-mthreads} defines 
6124 @samp{-D_MT}; when linking, it links in a special thread helper library 
6125 @samp{-lmingwthrd} which cleans up per thread exception handling data.
6127 @item -mno-align-stringops
6128 @kindex -mno-align-stringops
6129 Do not align destination of inlined string operations. This switch reduces
6130 code size and improves performance in case the destination is already aligned,
6131 but gcc don't know about it.
6133 @item -minline-all-stringops
6134 @kindex -minline-all-stringops
6135 By default GCC inlines string operations only when destination is known to be
6136 aligned at least to 4 byte boundary. This enables more inlining, increase code
6137 size, but may improve performance of code that depends on fast memcpy, strlen
6138 and memset for short lengths.
6139 @end table
6141 @node HPPA Options
6142 @subsection HPPA Options
6143 @cindex HPPA Options
6145 These @samp{-m} options are defined for the HPPA family of computers:
6147 @table @code
6148 @item -march=@var{architecture type}
6149 Generate code for the specified architecture.  The choices for
6150 @var{architecture type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
6151 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
6152 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
6153 architecture option for your machine.  Code compiled for lower numbered
6154 architectures will run on higher numbered architectures, but not the
6155 other way around.
6157 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
6158 next release of binutils (current is 2.9.1) will probably contain PA 2.0
6159 support.  
6161 @item -mpa-risc-1-0
6162 @itemx -mpa-risc-1-1
6163 @itemx -mpa-risc-2-0
6164 Synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively.
6166 @item -mbig-switch
6167 Generate code suitable for big switch tables.  Use this option only if
6168 the assembler/linker complain about out of range branches within a switch
6169 table.
6171 @item -mjump-in-delay
6172 Fill delay slots of function calls with unconditional jump instructions
6173 by modifying the return pointer for the function call to be the target
6174 of the conditional jump.
6176 @item -mdisable-fpregs
6177 Prevent floating point registers from being used in any manner.  This is
6178 necessary for compiling kernels which perform lazy context switching of
6179 floating point registers.  If you use this option and attempt to perform
6180 floating point operations, the compiler will abort.
6182 @item -mdisable-indexing
6183 Prevent the compiler from using indexing address modes.  This avoids some
6184 rather obscure problems when compiling MIG generated code under MACH.
6186 @item -mno-space-regs
6187 Generate code that assumes the target has no space registers.  This allows
6188 GCC to generate faster indirect calls and use unscaled index address modes.
6190 Such code is suitable for level 0 PA systems and kernels.
6192 @item -mfast-indirect-calls
6193 Generate code that assumes calls never cross space boundaries.  This
6194 allows GCC to emit code which performs faster indirect calls.
6196 This option will not work in the presence of shared libraries or nested
6197 functions.
6199 @item -mlong-load-store
6200 Generate 3-instruction load and store sequences as sometimes required by
6201 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
6202 the HP compilers.
6204 @item -mportable-runtime
6205 Use the portable calling conventions proposed by HP for ELF systems.
6207 @item -mgas
6208 Enable the use of assembler directives only GAS understands.
6210 @item -mschedule=@var{cpu type}
6211 Schedule code according to the constraints for the machine type
6212 @var{cpu type}.  The choices for @var{cpu type} are @samp{700} 
6213 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}.  Refer to 
6214 @file{/usr/lib/sched.models} on an HP-UX system to determine the
6215 proper scheduling option for your machine.
6217 @item -mlinker-opt
6218 Enable the optimization pass in the HPUX linker.  Note this makes symbolic
6219 debugging impossible.  It also triggers a bug in the HPUX 8 and HPUX 9 linkers
6220 in which they give bogus error messages when linking some programs.
6222 @item -msoft-float
6223 Generate output containing library calls for floating point.
6224 @strong{Warning:} the requisite libraries are not available for all HPPA
6225 targets.  Normally the facilities of the machine's usual C compiler are
6226 used, but this cannot be done directly in cross-compilation.  You must make
6227 your own arrangements to provide suitable library functions for
6228 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
6229 does provide software floating point support.
6231 @samp{-msoft-float} changes the calling convention in the output file;
6232 therefore, it is only useful if you compile @emph{all} of a program with
6233 this option.  In particular, you need to compile @file{libgcc.a}, the
6234 library that comes with GCC, with @samp{-msoft-float} in order for
6235 this to work.
6236 @end table
6238 @node Intel 960 Options
6239 @subsection Intel 960 Options
6241 These @samp{-m} options are defined for the Intel 960 implementations:
6243 @table @code
6244 @item -m@var{cpu type}
6245 Assume the defaults for the machine type @var{cpu type} for some of
6246 the other options, including instruction scheduling, floating point
6247 support, and addressing modes.  The choices for @var{cpu type} are
6248 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
6249 @samp{sa}, and @samp{sb}.
6250 The default is
6251 @samp{kb}.
6253 @item -mnumerics
6254 @itemx -msoft-float
6255 The @samp{-mnumerics} option indicates that the processor does support
6256 floating-point instructions.  The @samp{-msoft-float} option indicates
6257 that floating-point support should not be assumed.
6259 @item -mleaf-procedures
6260 @itemx -mno-leaf-procedures
6261 Do (or do not) attempt to alter leaf procedures to be callable with the
6262 @code{bal} instruction as well as @code{call}.  This will result in more
6263 efficient code for explicit calls when the @code{bal} instruction can be
6264 substituted by the assembler or linker, but less efficient code in other
6265 cases, such as calls via function pointers, or using a linker that doesn't
6266 support this optimization.
6268 @item -mtail-call
6269 @itemx -mno-tail-call
6270 Do (or do not) make additional attempts (beyond those of the
6271 machine-independent portions of the compiler) to optimize tail-recursive
6272 calls into branches.  You may not want to do this because the detection of
6273 cases where this is not valid is not totally complete.  The default is
6274 @samp{-mno-tail-call}.
6276 @item -mcomplex-addr
6277 @itemx -mno-complex-addr
6278 Assume (or do not assume) that the use of a complex addressing mode is a
6279 win on this implementation of the i960.  Complex addressing modes may not
6280 be worthwhile on the K-series, but they definitely are on the C-series.
6281 The default is currently @samp{-mcomplex-addr} for all processors except
6282 the CB and CC.
6284 @item -mcode-align
6285 @itemx -mno-code-align
6286 Align code to 8-byte boundaries for faster fetching (or don't bother).
6287 Currently turned on by default for C-series implementations only.
6289 @ignore
6290 @item -mclean-linkage
6291 @itemx -mno-clean-linkage
6292 These options are not fully implemented.
6293 @end ignore
6295 @item -mic-compat
6296 @itemx -mic2.0-compat
6297 @itemx -mic3.0-compat
6298 Enable compatibility with iC960 v2.0 or v3.0.
6300 @item -masm-compat
6301 @itemx -mintel-asm
6302 Enable compatibility with the iC960 assembler.
6304 @item -mstrict-align
6305 @itemx -mno-strict-align
6306 Do not permit (do permit) unaligned accesses.
6308 @item -mold-align
6309 Enable structure-alignment compatibility with Intel's gcc release version
6310 1.3 (based on gcc 1.37).  This option implies @samp{-mstrict-align}.
6312 @item -mlong-double-64
6313 Implement type @samp{long double} as 64-bit floating point numbers.
6314 Without the option @samp{long double} is implemented by 80-bit
6315 floating point numbers.  The only reason we have it because there is
6316 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
6317 is only useful for people using soft-float targets.  Otherwise, we
6318 should recommend against use of it.
6320 @end table
6322 @node DEC Alpha Options
6323 @subsection DEC Alpha Options
6325 These @samp{-m} options are defined for the DEC Alpha implementations:
6327 @table @code
6328 @item -mno-soft-float
6329 @itemx -msoft-float
6330 Use (do not use) the hardware floating-point instructions for
6331 floating-point operations.  When @code{-msoft-float} is specified,
6332 functions in @file{libgcc1.c} will be used to perform floating-point
6333 operations.  Unless they are replaced by routines that emulate the
6334 floating-point operations, or compiled in such a way as to call such
6335 emulations routines, these routines will issue floating-point
6336 operations.   If you are compiling for an Alpha without floating-point
6337 operations, you must ensure that the library is built so as not to call
6338 them.
6340 Note that Alpha implementations without floating-point operations are
6341 required to have floating-point registers.
6343 @item -mfp-reg
6344 @itemx -mno-fp-regs
6345 Generate code that uses (does not use) the floating-point register set.
6346 @code{-mno-fp-regs} implies @code{-msoft-float}.  If the floating-point
6347 register set is not used, floating point operands are passed in integer
6348 registers as if they were integers and floating-point results are passed
6349 in $0 instead of $f0.  This is a non-standard calling sequence, so any
6350 function with a floating-point argument or return value called by code
6351 compiled with @code{-mno-fp-regs} must also be compiled with that
6352 option.
6354 A typical use of this option is building a kernel that does not use,
6355 and hence need not save and restore, any floating-point registers.
6357 @item -mieee
6358 The Alpha architecture implements floating-point hardware optimized for
6359 maximum performance.  It is mostly compliant with the IEEE floating
6360 point standard.  However, for full compliance, software assistance is
6361 required.  This option generates code fully IEEE compliant code
6362 @emph{except} that the @var{inexact flag} is not maintained (see below).
6363 If this option is turned on, the CPP macro @code{_IEEE_FP} is defined
6364 during compilation.  The option is a shorthand for: @samp{-D_IEEE_FP
6365 -mfp-trap-mode=su -mtrap-precision=i -mieee-conformant}.  The resulting
6366 code is less efficient but is able to correctly support denormalized
6367 numbers and exceptional IEEE values such as not-a-number and plus/minus
6368 infinity.  Other Alpha compilers call this option
6369 @code{-ieee_with_no_inexact}.
6371 @item -mieee-with-inexact
6372 @c overfull hbox here --bob 22 jul96
6373 @c original text between ignore ... end ignore
6374 @ignore
6375 This is like @samp{-mieee} except the generated code also maintains the
6376 IEEE @var{inexact flag}.  Turning on this option causes the generated
6377 code to implement fully-compliant IEEE math.  The option is a shorthand
6378 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus @samp{-mieee-conformant},
6379 @samp{-mfp-trap-mode=sui}, and @samp{-mtrap-precision=i}.  On some Alpha
6380 implementations the resulting code may execute significantly slower than
6381 the code generated by default.  Since there is very little code that
6382 depends on the @var{inexact flag}, you should normally not specify this
6383 option.  Other Alpha compilers call this option
6384 @samp{-ieee_with_inexact}.
6385 @end ignore
6386 @c            changed paragraph
6387 This is like @samp{-mieee} except the generated code also maintains the
6388 IEEE @var{inexact flag}.  Turning on this option causes the generated
6389 code to implement fully-compliant IEEE math.  The option is a shorthand
6390 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus the three following:
6391 @samp{-mieee-conformant},
6392 @samp{-mfp-trap-mode=sui}, 
6393 and @samp{-mtrap-precision=i}.  
6394 On some Alpha implementations the resulting code may execute
6395 significantly slower than the code generated by default.  Since there
6396 is very little code that depends on the @var{inexact flag}, you should
6397 normally not specify this option.  Other Alpha compilers call this
6398 option @samp{-ieee_with_inexact}.
6399 @c             end changes to prevent overfull hboxes
6401 @item -mfp-trap-mode=@var{trap mode}
6402 This option controls what floating-point related traps are enabled.
6403 Other Alpha compilers call this option @samp{-fptm }@var{trap mode}.
6404 The trap mode can be set to one of four values:
6406 @table @samp
6407 @item n
6408 This is the default (normal) setting.  The only traps that are enabled
6409 are the ones that cannot be disabled in software (e.g., division by zero
6410 trap).
6412 @item u
6413 In addition to the traps enabled by @samp{n}, underflow traps are enabled
6414 as well.
6416 @item su
6417 Like @samp{su}, but the instructions are marked to be safe for software
6418 completion (see Alpha architecture manual for details).
6420 @item sui
6421 Like @samp{su}, but inexact traps are enabled as well.
6422 @end table
6424 @item -mfp-rounding-mode=@var{rounding mode}
6425 Selects the IEEE rounding mode.  Other Alpha compilers call this option
6426 @samp{-fprm }@var{rounding mode}.  The @var{rounding mode} can be one
6429 @table @samp
6430 @item n
6431 Normal IEEE rounding mode.  Floating point numbers are rounded towards
6432 the nearest machine number or towards the even machine number in case
6433 of a tie.
6435 @item m
6436 Round towards minus infinity.
6438 @item c
6439 Chopped rounding mode.  Floating point numbers are rounded towards zero.
6441 @item d
6442 Dynamic rounding mode.  A field in the floating point control register
6443 (@var{fpcr}, see Alpha architecture reference manual) controls the
6444 rounding mode in effect.  The C library initializes this register for
6445 rounding towards plus infinity.  Thus, unless your program modifies the
6446 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
6447 @end table
6449 @item -mtrap-precision=@var{trap precision}
6450 In the Alpha architecture, floating point traps are imprecise.  This
6451 means without software assistance it is impossible to recover from a
6452 floating trap and program execution normally needs to be terminated.
6453 GCC can generate code that can assist operating system trap handlers
6454 in determining the exact location that caused a floating point trap.
6455 Depending on the requirements of an application, different levels of
6456 precisions can be selected:
6458 @table @samp
6459 @item p
6460 Program precision.  This option is the default and means a trap handler
6461 can only identify which program caused a floating point exception.
6463 @item f
6464 Function precision.  The trap handler can determine the function that
6465 caused a floating point exception.
6467 @item i
6468 Instruction precision.  The trap handler can determine the exact
6469 instruction that caused a floating point exception.
6470 @end table
6472 Other Alpha compilers provide the equivalent options called
6473 @samp{-scope_safe} and @samp{-resumption_safe}.
6475 @item -mieee-conformant
6476 This option marks the generated code as IEEE conformant.  You must not
6477 use this option unless you also specify @samp{-mtrap-precision=i} and either
6478 @samp{-mfp-trap-mode=su} or @samp{-mfp-trap-mode=sui}.  Its only effect
6479 is to emit the line @samp{.eflag 48} in the function prologue of the
6480 generated assembly file.  Under DEC Unix, this has the effect that
6481 IEEE-conformant math library routines will be linked in.
6483 @item -mbuild-constants
6484 Normally GCC examines a 32- or 64-bit integer constant to
6485 see if it can construct it from smaller constants in two or three
6486 instructions.  If it cannot, it will output the constant as a literal and
6487 generate code to load it from the data segment at runtime.
6489 Use this option to require GCC to construct @emph{all} integer constants
6490 using code, even if it takes more instructions (the maximum is six).
6492 You would typically use this option to build a shared library dynamic
6493 loader.  Itself a shared library, it must relocate itself in memory
6494 before it can find the variables and constants in its own data segment.
6496 @item -malpha-as
6497 @itemx -mgas
6498 Select whether to generate code to be assembled by the vendor-supplied
6499 assembler (@samp{-malpha-as}) or by the GNU assembler @samp{-mgas}.
6501 @item -mbwx
6502 @itemx -mno-bwx
6503 @itemx -mcix
6504 @itemx -mno-cix
6505 @itemx -mmax
6506 @itemx -mno-max
6507 Indicate whether GCC should generate code to use the optional BWX,
6508 CIX, and MAX instruction sets.  The default is to use the instruction sets
6509 supported by the CPU type specified via @samp{-mcpu=} option or that
6510 of the CPU on which GCC was built if none was specified.
6512 @item -mcpu=@var{cpu_type}
6513 Set the instruction set, register set, and instruction scheduling
6514 parameters for machine type @var{cpu_type}.  You can specify either the
6515 @samp{EV} style name or the corresponding chip number.  GCC
6516 supports scheduling parameters for the EV4 and EV5 family of processors
6517 and will choose the default values for the instruction set from
6518 the processor you specify.  If you do not specify a processor type,
6519 GCC will default to the processor on which the compiler was built.
6521 Supported values for @var{cpu_type} are
6523 @table @samp
6524 @item ev4
6525 @itemx 21064
6526 Schedules as an EV4 and has no instruction set extensions.
6528 @item ev5
6529 @itemx 21164
6530 Schedules as an EV5 and has no instruction set extensions.
6532 @item ev56
6533 @itemx 21164a
6534 Schedules as an EV5 and supports the BWX extension.
6536 @item pca56
6537 @itemx 21164pc
6538 @itemx 21164PC
6539 Schedules as an EV5 and supports the BWX and MAX extensions.
6541 @item ev6
6542 @itemx 21264
6543 Schedules as an EV5 (until Digital releases the scheduling parameters
6544 for the EV6) and supports the BWX, CIX, and MAX extensions.
6545 @end table
6547 @item -mmemory-latency=@var{time}
6548 Sets the latency the scheduler should assume for typical memory
6549 references as seen by the application.  This number is highly
6550 dependent on the memory access patterns used by the application
6551 and the size of the external cache on the machine.
6553 Valid options for @var{time} are
6555 @table @samp
6556 @item @var{number}
6557 A decimal number representing clock cycles.
6559 @item L1
6560 @itemx L2
6561 @itemx L3
6562 @itemx main
6563 The compiler contains estimates of the number of clock cycles for
6564 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
6565 (also called Dcache, Scache, and Bcache), as well as to main memory.
6566 Note that L3 is only valid for EV5.
6568 @end table
6569 @end table
6571 @node Clipper Options
6572 @subsection Clipper Options
6574 These @samp{-m} options are defined for the Clipper implementations:
6576 @table @code
6577 @item -mc300
6578 Produce code for a C300 Clipper processor. This is the default.
6580 @item -mc400
6581 Produce code for a C400 Clipper processor i.e. use floating point
6582 registers f8..f15.
6583 @end table
6585 @node H8/300 Options
6586 @subsection H8/300 Options
6588 These @samp{-m} options are defined for the H8/300 implementations:
6590 @table @code
6591 @item -mrelax
6592 Shorten some address references at link time, when possible; uses the
6593 linker option @samp{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
6594 ld.info, Using ld}, for a fuller description.
6596 @item -mh
6597 Generate code for the H8/300H.
6599 @item -ms
6600 Generate code for the H8/S.
6602 @item -mint32
6603 Make @code{int} data 32 bits by default.
6605 @item -malign-300
6606 On the h8/300h, use the same alignment rules as for the h8/300.
6607 The default for the h8/300h is to align longs and floats on 4 byte boundaries.
6608 @samp{-malign-300} causes them to be aligned on 2 byte boundaries.
6609 This option has no effect on the h8/300.
6610 @end table
6612 @node SH Options
6613 @subsection SH Options
6615 These @samp{-m} options are defined for the SH implementations:
6617 @table @code
6618 @item -m1
6619 Generate code for the SH1.
6621 @item -m2
6622 Generate code for the SH2.
6624 @item -m3
6625 Generate code for the SH3.
6627 @item -m3e
6628 Generate code for the SH3e.
6630 @item -mb
6631 Compile code for the processor in big endian mode.
6633 @item -ml
6634 Compile code for the processor in little endian mode.
6636 @item -mdalign
6637 Align doubles at 64 bit boundaries.  Note that this changes the calling
6638 conventions, and thus some functions from the standard C library will
6639 not work unless you recompile it first with -mdalign.
6641 @item -mrelax
6642 Shorten some address references at link time, when possible; uses the
6643 linker option @samp{-relax}.
6644 @end table
6646 @node System V Options
6647 @subsection Options for System V
6649 These additional options are available on System V Release 4 for
6650 compatibility with other compilers on those systems:
6652 @table @code
6653 @item -G
6654 Create a shared object.
6655 It is recommended that @samp{-symbolic} or @samp{-shared} be used instead.
6657 @item -Qy
6658 Identify the versions of each tool used by the compiler, in a
6659 @code{.ident} assembler directive in the output.
6661 @item -Qn
6662 Refrain from adding @code{.ident} directives to the output file (this is
6663 the default).
6665 @item -YP,@var{dirs}
6666 Search the directories @var{dirs}, and no others, for libraries
6667 specified with @samp{-l}.
6669 @item -Ym,@var{dir}
6670 Look in the directory @var{dir} to find the M4 preprocessor.
6671 The assembler uses this option.
6672 @c This is supposed to go with a -Yd for predefined M4 macro files, but
6673 @c the generic assembler that comes with Solaris takes just -Ym.
6674 @end table
6676 @node TMS320C3x/C4x Options
6677 @subsection TMS320C3x/C4x Options
6678 @cindex TMS320C3x/C4x Options
6680 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
6682 @table @code
6684 @item -mcpu=@var{cpu_type}
6685 Set the instruction set, register set, and instruction scheduling
6686 parameters for machine type @var{cpu_type}.  Supported values for
6687 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
6688 @samp{c44}.  The default is @samp{c40} to generate code for the
6689 TMS320C40.
6691 @item -mbig-memory
6692 @item -mbig
6693 @itemx -msmall-memory
6694 @itemx -msmall
6695 Generates code for the big or small memory model.  The small memory
6696 model assumed that all data fits into one 64K word page.  At run-time
6697 the data page (DP) register must be set to point to the 64K page
6698 containing the .bss and .data program sections.  The big memory model is
6699 the default and requires reloading of the DP register for every direct
6700 memory access.
6702 @item -mbk
6703 @itemx -mno-bk
6704 Allow (disallow) allocation of general integer operands into the block
6705 count register BK. 
6707 @item -mdb
6708 @itemx -mno-db
6709 Enable (disable) generation of code using decrement and branch,
6710 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
6711 on the safe side, this is disabled for the C3x, since the maximum
6712 iteration count on the C3x is 2^23 + 1 (but who iterates loops more than
6713 2^23 times on the C3x?).  Note that GCC will try to reverse a loop so
6714 that it can utilise the decrement and branch instruction, but will give
6715 up if there is more than one memory reference in the loop.  Thus a loop
6716 where the loop counter is decremented can generate slightly more
6717 efficient code, in cases where the RPTB instruction cannot be utilised.
6719 @item -mdp-isr-reload
6720 @itemx -mparanoid
6721 Force the DP register to be saved on entry to an interrupt service
6722 routine (ISR), reloaded to point to the data section, and restored on
6723 exit from the ISR.  This should not be required unless someone has
6724 violated the small memory model by modifying the DP register, say within
6725 an object library.
6727 @item -mmpyi
6728 @itemx -mno-mpyi
6729 For the C3x use the 24-bit MPYI instruction for integer multiplies
6730 instead of a library call to guarantee 32-bit results.  Note that if one
6731 of the operands is a constant, then the multiplication will be performed
6732 using shifts and adds.  If the -mmpyi option is not specified for the C3x,
6733 then squaring operations are performed inline instead of a library call.
6735 @item -mfast-fix
6736 @itemx -mno-fast-fix
6737 The C3x/C4x FIX instruction to convert a floating point value to an
6738 integer value chooses the nearest integer less than or equal to the
6739 floating point value rather than to the nearest integer.  Thus if the
6740 floating point number is negative, the result will be incorrectly
6741 truncated an additional code is necessary to detect and correct this
6742 case.  This option can be used to disable generation of the additional
6743 code required to correct the result.
6745 @item -mrptb
6746 @itemx -mno-rptb
6747 Enable (disable) generation of repeat block sequences using the RPTB
6748 instruction for zero overhead looping.  The RPTB construct is only used
6749 for innermost loops that do not call functions or jump across the loop
6750 boundaries.  There is no advantage having nested RPTB loops due to the
6751 overhead required to save and restore the RC, RS, and RE registers.
6752 This is enabled by default with -O2.
6754 @item -mrpts=@var{count}
6755 @itemx -mno-rpts
6756 Enable (disable) the use of the single instruction repeat instruction
6757 RPTS.  If a repeat block contains a single instruction, and the loop
6758 count can be guaranteed to be less than the value @var{count}, GCC will
6759 emit a RPTS instruction instead of a RPTB.  If no value is specified,
6760 then a RPTS will be emitted even if the loop count cannot be determined
6761 at compile time.  Note that the repeated instruction following RPTS does
6762 not have to be reloaded from memory each iteration, thus freeing up the
6763 CPU buses for operands.  However, since interrupts are blocked by this
6764 instruction, it is disabled by default.
6766 @item -mloop-unsigned
6767 @itemx -mno-loop-unsigned
6768 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
6769 is 2^31 + 1 since these instructions test if the iteration count is
6770 negative to terminate the loop.  If the iteration count is unsigned
6771 there is a possibility than the 2^31 + 1 maximum iteration count may be
6772 exceeded.  This switch allows an unsigned iteration count.
6774 @item -mti
6775 Try to emit an assembler syntax that the TI assembler (asm30) is happy
6776 with.  This also enforces compatibility with the API employed by the TI
6777 C3x C compiler.  For example, long doubles are passed as structures
6778 rather than in floating point registers.
6780 @item -mregparm
6781 @itemx -mmemparm
6782 Generate code that uses registers (stack) for passing arguments to functions.
6783 By default, arguments are passed in registers where possible rather
6784 than by pushing arguments on to the stack.
6786 @item -mparallel-insns
6787 @itemx -mno-parallel-insns
6788 Allow the generation of parallel instructions.  This is enabled by
6789 default with -O2.
6791 @item -mparallel-mpy
6792 @itemx -mno-parallel-mpy
6793 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
6794 provided -mparallel-insns is also specified.  These instructions have
6795 tight register constraints which can pessimize the code generation
6796 of large functions.
6798 @end table
6800 @node V850 Options
6801 @subsection V850 Options
6802 @cindex V850 Options
6804 These @samp{-m} options are defined for V850 implementations:
6806 @table @code
6807 @item -mlong-calls
6808 @itemx -mno-long-calls
6809 Treat all calls as being far away (near).  If calls are assumed to be
6810 far away, the compiler will always load the functions address up into a
6811 register, and call indirect through the pointer.
6813 @item -mno-ep
6814 @itemx -mep
6815 Do not optimize (do optimize) basic blocks that use the same index
6816 pointer 4 or more times to copy pointer into the @code{ep} register, and
6817 use the shorter @code{sld} and @code{sst} instructions.  The @samp{-mep}
6818 option is on by default if you optimize.
6820 @item -mno-prolog-function
6821 @itemx -mprolog-function
6822 Do not use (do use) external functions to save and restore registers at
6823 the prolog and epilog of a function.  The external functions are slower,
6824 but use less code space if more than one function saves the same number
6825 of registers.  The @samp{-mprolog-function} option is on by default if
6826 you optimize.
6828 @item -mspace
6829 Try to make the code as small as possible.  At present, this just turns
6830 on the @samp{-mep} and @samp{-mprolog-function} options.
6832 @item -mtda=@var{n}
6833 Put static or global variables whose size is @var{n} bytes or less into
6834 the tiny data area that register @code{ep} points to.  The tiny data
6835 area can hold up to 256 bytes in total (128 bytes for byte references).
6837 @item -msda=@var{n}
6838 Put static or global variables whose size is @var{n} bytes or less into
6839 the small data area that register @code{gp} points to.  The small data
6840 area can hold up to 64 kilobytes.
6842 @item -mzda=@var{n}
6843 Put static or global variables whose size is @var{n} bytes or less into
6844 the first 32 kilobytes of memory.
6846 @item -mv850
6847 Specify that the target processor is the V850.
6849 @item -mbig-switch
6850 Generate code suitable for big switch tables.  Use this option only if
6851 the assembler/linker complain about out of range branches within a switch
6852 table.
6853 @end table
6855 @node ARC Options
6856 @subsection ARC Options
6857 @cindex ARC Options
6859 These options are defined for ARC implementations:
6861 @table @code
6862 @item -EL
6863 Compile code for little endian mode.  This is the default.
6865 @item -EB
6866 Compile code for big endian mode.
6868 @item -mmangle-cpu
6869 Prepend the name of the cpu to all public symbol names.
6870 In multiple-processor systems, there are many ARC variants with different
6871 instruction and register set characteristics.  This flag prevents code
6872 compiled for one cpu to be linked with code compiled for another.
6873 No facility exists for handling variants that are "almost identical".
6874 This is an all or nothing option.
6876 @item -mcpu=@var{cpu}
6877 Compile code for ARC variant @var{cpu}.
6878 Which variants are supported depend on the configuration.
6879 All variants support @samp{-mcpu=base}, this is the default.
6881 @item -mtext=@var{text section}
6882 @itemx -mdata=@var{data section}
6883 @itemx -mrodata=@var{readonly data section}
6884 Put functions, data, and readonly data in @var{text section},
6885 @var{data section}, and @var{readonly data section} respectively
6886 by default.  This can be overridden with the @code{section} attribute.
6887 @xref{Variable Attributes}.
6889 @end table
6891 @node NS32K Options
6892 @subsection NS32K Options
6893 @cindex NS32K options
6895 These are the @samp{-m} options defined for the 32000 series.  The default
6896 values for these options depends on which style of 32000 was selected when
6897 the compiler was configured; the defaults for the most common choices are
6898 given below.
6900 @table @code
6901 @item -m32032
6902 @itemx -m32032
6903 Generate output for a 32032.  This is the default
6904 when the compiler is configured for 32032 and 32016 based systems.
6906 @item -m32332
6907 @itemx -m32332
6908 Generate output for a 32332.  This is the default
6909 when the compiler is configured for 32332-based systems.
6911 @item -m32532
6912 @itemx -m32532
6913 Generate output for a 32532.  This is the default
6914 when the compiler is configured for 32532-based systems.
6916 @item -m32081
6917 Generate output containing 32081 instructions for floating point.
6918 This is the default for all systems.
6920 @item -m32381
6921 Generate output containing 32381 instructions for floating point.  This
6922 also implies @samp{-m32081}. The 32381 is only compatible with the 32332
6923 and 32532 cpus. This is the default for the pc532-netbsd configuration.
6925 @item -mmulti-add
6926 Try and generate multiply-add floating point instructions @code{polyF}
6927 and @code{dotF}. This option is only available if the @samp{-m32381}
6928 option is in effect. Using these instructions requires changes to to
6929 register allocation which generally has a negative impact on
6930 performance.  This option should only be enabled when compiling code
6931 particularly likely to make heavy use of multiply-add instructions.
6933 @item -mnomulti-add
6934 Do not try and generate multiply-add floating point instructions
6935 @code{polyF} and @code{dotF}. This is the default on all platforms.
6937 @item -msoft-float
6938 Generate output containing library calls for floating point.
6939 @strong{Warning:} the requisite libraries may not be available.
6941 @item -mnobitfield
6942 Do not use the bit-field instructions. On some machines it is faster to
6943 use shifting and masking operations. This is the default for the pc532.
6945 @item -mbitfield
6946 Do use the bit-field instructions. This is the default for all platforms
6947 except the pc532.
6949 @item -mrtd
6950 Use a different function-calling convention, in which functions
6951 that take a fixed number of arguments return pop their
6952 arguments on return with the @code{ret} instruction.
6954 This calling convention is incompatible with the one normally
6955 used on Unix, so you cannot use it if you need to call libraries
6956 compiled with the Unix compiler.
6958 Also, you must provide function prototypes for all functions that
6959 take variable numbers of arguments (including @code{printf});
6960 otherwise incorrect code will be generated for calls to those
6961 functions.
6963 In addition, seriously incorrect code will result if you call a
6964 function with too many arguments.  (Normally, extra arguments are
6965 harmlessly ignored.)
6967 This option takes its name from the 680x0 @code{rtd} instruction.
6970 @item -mregparam
6971 Use a different function-calling convention where the first two arguments
6972 are passed in registers.
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 @item -mnoregparam
6979 Do not pass any arguments in registers. This is the default for all
6980 targets.
6982 @item -msb
6983 It is OK to use the sb as an index register which is always loaded with
6984 zero. This is the default for the pc532-netbsd target.
6986 @item -mnosb
6987 The sb register is not available for use or has not been initialized to
6988 zero by the run time system. This is the default for all targets except
6989 the pc532-netbsd. It is also implied whenever @samp{-mhimem} or
6990 @samp{-fpic} is set.
6992 @item -mhimem
6993 Many ns32000 series addressing modes use displacements of up to 512MB.
6994 If an address is above 512MB then displacements from zero can not be used.
6995 This option causes code to be generated which can be loaded above 512MB.
6996 This may be useful for operating systems or ROM code.
6998 @item -mnohimem
6999 Assume code will be loaded in the first 512MB of virtual address space.
7000 This is the default for all platforms.
7003 @end table
7005 @node AVR Options
7006 @subsection AVR Options
7007 @cindex AVR Options
7009 These options are defined for AVR implementations:
7011 @table @code
7012 @item -mmcu=@var{mcu}
7013 Specify ATMEL AVR mcu (at90s23xx,attiny22,at90s44xx,at90s85xx,atmega603,
7014 atmega103).
7016 @item -msize
7017 Output instruction size's to the asm file
7019 @item -minit-stack=@var{N}
7020 Specify the initial stack address
7022 @item -mno-interrupts
7023 Generated code is not compatible with hardware interrupts.
7024 Code size will be smaller.
7026 @item -mcall-prologues
7027 Functions prologues/epilogues expanded as call to appropriate
7028 subroutines. Code size will be smaller.
7029 @end table
7031 @node MCore Options
7032 @subsection MCore Options
7033 @cindex MCore options
7035 These are the @samp{-m} options defined for the Motorola M*Core
7036 processors.  
7038 @table @code
7040 @item -mhardlit
7041 @itemx -mhardlit
7042 @itemx -mno-hardlit
7043 Inline constants into the code stream if it can be done in two
7044 instructions or less.
7046 @item -mdiv
7047 @itemx -mdiv
7048 @itemx -mno-div
7049 Use the divide instruction.  (Enabled by default).
7051 @item -mrelax-immediate
7052 @itemx -mrelax-immediate
7053 @itemx -mno-relax-immediate
7054 Allow arbitrary sized immediates in bit operations.
7056 @item -mwide-bitfields
7057 @itemx -mwide-bitfields
7058 @itemx -mno-wide-bitfields
7059 Always treat bitfields as int-sized.
7061 @item -m4byte-functions
7062 @itemx -m4byte-functions
7063 @itemx -mno-4byte-functions
7064 Force all functions to be aligned to a four byte boundary.
7066 @item -mcallgraph-data
7067 @itemx -mcallgraph-data
7068 @itemx -mno-callgraph-data
7069 Emit callgraph information.
7071 @item -mslow-bytes
7072 @itemx -mslow-bytes
7073 @itemx -mno-slow-bytes
7074 Prefer word access when reading byte quantities.
7076 @item -mlittle-endian
7077 @itemx -mlittle-endian
7078 @itemx -mbig-endian
7079 Generate code for a little endian target.
7081 @item -m210
7082 @itemx -m210
7083 @itemx -m340
7084 Generate code for the 210 processor.
7086 @end table
7089 @node Code Gen Options
7090 @section Options for Code Generation Conventions
7091 @cindex code generation conventions
7092 @cindex options, code generation
7093 @cindex run-time options
7095 These machine-independent options control the interface conventions
7096 used in code generation.
7098 Most of them have both positive and negative forms; the negative form
7099 of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below, only
7100 one of the forms is listed---the one which is not the default.  You
7101 can figure out the other form by either removing @samp{no-} or adding
7104 @table @code
7105 @item -fexceptions
7106 Enable exception handling. Generates extra code needed to propagate
7107 exceptions.  For some targets, this implies GNU CC will generate frame
7108 unwind information for all functions, which can produce significant data
7109 size overhead, although it does not affect execution.  If you do not
7110 specify this option, GNU CC will enable it by default for languages like
7111 C++ which normally require exception handling, and disable itfor
7112 languages like C that do not normally require it.  However, you may need
7113 to enable this option when compiling C code that needs to interoperate
7114 properly with exception handlers written in C++.  You may also wish to
7115 disable this option if you are compiling older C++ programs that don't
7116 use exception handling.
7118 @item -funwind-tables
7119 Similar to @code{-fexceptions}, except that it will just generate any needed
7120 static data, but will not affect the generated code in any other way.
7121 You will normally not enable this option; instead, a language processor
7122 that needs this handling would enable it on your behalf.
7124 @item -fpcc-struct-return
7125 Return ``short'' @code{struct} and @code{union} values in memory like
7126 longer ones, rather than in registers.  This convention is less
7127 efficient, but it has the advantage of allowing intercallability between
7128 GCC-compiled files and files compiled with other compilers.
7130 The precise convention for returning structures in memory depends
7131 on the target configuration macros.
7133 Short structures and unions are those whose size and alignment match
7134 that of some integer type.
7136 @item -freg-struct-return
7137 Use the convention that @code{struct} and @code{union} values are
7138 returned in registers when possible.  This is more efficient for small
7139 structures than @samp{-fpcc-struct-return}.
7141 If you specify neither @samp{-fpcc-struct-return} nor its contrary
7142 @samp{-freg-struct-return}, GCC defaults to whichever convention is
7143 standard for the target.  If there is no standard convention, GCC
7144 defaults to @samp{-fpcc-struct-return}, except on targets where GCC
7145 is the principal compiler.  In those cases, we can choose the standard,
7146 and we chose the more efficient register return alternative.
7148 @item -fshort-enums
7149 Allocate to an @code{enum} type only as many bytes as it needs for the
7150 declared range of possible values.  Specifically, the @code{enum} type
7151 will be equivalent to the smallest integer type which has enough room.
7153 @item -fshort-double
7154 Use the same size for @code{double} as for @code{float}.
7156 @item -fshared-data
7157 Requests that the data and non-@code{const} variables of this
7158 compilation be shared data rather than private data.  The distinction
7159 makes sense only on certain operating systems, where shared data is
7160 shared between processes running the same program, while private data
7161 exists in one copy per process.
7163 @item -fno-common
7164 Allocate even uninitialized global variables in the data section of the
7165 object file, rather than generating them as common blocks.  This has the
7166 effect that if the same variable is declared (without @code{extern}) in
7167 two different compilations, you will get an error when you link them.
7168 The only reason this might be useful is if you wish to verify that the
7169 program will work on other systems which always work this way.
7171 @item -fno-ident
7172 Ignore the @samp{#ident} directive.
7174 @item -fno-gnu-linker
7175 Do not output global initializations (such as C++ constructors and
7176 destructors) in the form used by the GNU linker (on systems where the GNU
7177 linker is the standard method of handling them).  Use this option when
7178 you want to use a non-GNU linker, which also requires using the
7179 @code{collect2} program to make sure the system linker includes
7180 constructors and destructors.  (@code{collect2} is included in the GCC
7181 distribution.)  For systems which @emph{must} use @code{collect2}, the
7182 compiler driver @code{gcc} is configured to do this automatically.
7184 @item -finhibit-size-directive
7185 Don't output a @code{.size} assembler directive, or anything else that
7186 would cause trouble if the function is split in the middle, and the
7187 two halves are placed at locations far apart in memory.  This option is
7188 used when compiling @file{crtstuff.c}; you should not need to use it
7189 for anything else.
7191 @item -fverbose-asm
7192 Put extra commentary information in the generated assembly code to
7193 make it more readable.  This option is generally only of use to those
7194 who actually need to read the generated assembly code (perhaps while
7195 debugging the compiler itself).
7197 @samp{-fno-verbose-asm}, the default, causes the
7198 extra information to be omitted and is useful when comparing two assembler
7199 files.
7201 @item -fvolatile
7202 Consider all memory references through pointers to be volatile.
7204 @item -fvolatile-global
7205 Consider all memory references to extern and global data items to
7206 be volatile.  GCC does not consider static data items to be volatile
7207 because of this switch.
7209 @item -fvolatile-static
7210 Consider all memory references to static data to be volatile.
7212 @item -fpic
7213 @cindex global offset table
7214 @cindex PIC
7215 Generate position-independent code (PIC) suitable for use in a shared
7216 library, if supported for the target machine.  Such code accesses all
7217 constant addresses through a global offset table (GOT).  The dynamic
7218 loader resolves the GOT entries when the program starts (the dynamic
7219 loader is not part of GCC; it is part of the operating system).  If
7220 the GOT size for the linked executable exceeds a machine-specific
7221 maximum size, you get an error message from the linker indicating that
7222 @samp{-fpic} does not work; in that case, recompile with @samp{-fPIC}
7223 instead.  (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
7224 on the m68k and RS/6000.  The 386 has no such limit.)
7226 Position-independent code requires special support, and therefore works
7227 only on certain machines.  For the 386, GCC supports PIC for System V
7228 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
7229 position-independent.
7231 @item -fPIC
7232 If supported for the target machine, emit position-independent code,
7233 suitable for dynamic linking and avoiding any limit on the size of the
7234 global offset table.  This option makes a difference on the m68k, m88k,
7235 and the Sparc.
7237 Position-independent code requires special support, and therefore works
7238 only on certain machines.
7240 @item -ffixed-@var{reg}
7241 Treat the register named @var{reg} as a fixed register; generated code
7242 should never refer to it (except perhaps as a stack pointer, frame
7243 pointer or in some other fixed role).
7245 @var{reg} must be the name of a register.  The register names accepted
7246 are machine-specific and are defined in the @code{REGISTER_NAMES}
7247 macro in the machine description macro file.
7249 This flag does not have a negative form, because it specifies a
7250 three-way choice.
7252 @item -fcall-used-@var{reg}
7253 Treat the register named @var{reg} as an allocable register that is
7254 clobbered by function calls.  It may be allocated for temporaries or
7255 variables that do not live across a call.  Functions compiled this way
7256 will not save and restore the register @var{reg}.
7258 It is an error to used this flag with the frame pointer or stack pointer.
7259 Use of this flag for other registers that have fixed pervasive roles in
7260 the machine's execution model will produce disastrous results.
7262 This flag does not have a negative form, because it specifies a
7263 three-way choice.
7265 @item -fcall-saved-@var{reg}
7266 Treat the register named @var{reg} as an allocable register saved by
7267 functions.  It may be allocated even for temporaries or variables that
7268 live across a call.  Functions compiled this way will save and restore
7269 the register @var{reg} if they use it.
7271 It is an error to used this flag with the frame pointer or stack pointer.
7272 Use of this flag for other registers that have fixed pervasive roles in
7273 the machine's execution model will produce disastrous results.
7275 A different sort of disaster will result from the use of this flag for
7276 a register in which function values may be returned.
7278 This flag does not have a negative form, because it specifies a
7279 three-way choice.
7281 @item -fpack-struct
7282 Pack all structure members together without holes.  Usually you would
7283 not want to use this option, since it makes the code suboptimal, and
7284 the offsets of structure members won't agree with system libraries.
7286 @item -fcheck-memory-usage
7287 Generate extra code to check each memory access.  GCC will generate
7288 code that is suitable for a detector of bad memory accesses such as
7289 @file{Checker}.
7291 Normally, you should compile all, or none, of your code with this option.
7293 If you do mix code compiled with and without this option,
7294 you must ensure that all code that has side effects
7295 and that is called by code compiled with this option
7296 is, itself, compiled with this option.
7297 If you do not, you might get erroneous messages from the detector.
7299 If you use functions from a library that have side-effects (such as
7300 @code{read}), you might not be able to recompile the library and
7301 specify this option.  In that case, you can enable the
7302 @samp{-fprefix-function-name} option, which requests GCC to encapsulate
7303 your code and make other functions look as if they were compiled with
7304 @samp{-fcheck-memory-usage}.  This is done by calling ``stubs'',
7305 which are provided by the detector.  If you cannot find or build
7306 stubs for every function you call, you might have to specify
7307 @samp{-fcheck-memory-usage} without @samp{-fprefix-function-name}.
7309 If you specify this option, you can not use the @code{asm} or
7310 @code{__asm__} keywords in functions with memory checking enabled.  GNU
7311 CC cannot understand what the @code{asm} statement may do, and therefore
7312 cannot generate the appropriate code, so it will reject it.  However, if
7313 you specify the function attribute @code{no_check_memory_usage} (see
7314 @pxref{Function Attributes}, GNU CC will disable memory checking within a
7315 function; you may use @code{asm} statements inside such functions.  You
7316 may have an inline expansion of a non-checked function within a checked
7317 function; in that case GNU CC will not generate checks for the inlined
7318 function's memory accesses.
7320 If you move your @code{asm} statements to non-checked inline functions
7321 and they do access memory, you can add calls to the support code in your
7322 inline function, to indicate any reads, writes, or copies being done.
7323 These calls would be similar to those done in the stubs described above.
7325 @item -fprefix-function-name
7326 Request GCC to add a prefix to the symbols generated for function names.
7327 GCC adds a prefix to the names of functions defined as well as
7328 functions called.  Code compiled with this option and code compiled
7329 without the option can't be linked together, unless stubs are used.
7331 If you compile the following code with @samp{-fprefix-function-name}
7332 @example
7333 extern void bar (int);
7334 void
7335 foo (int a)
7337   return bar (a + 5);
7339 @end example
7341 @noindent
7342 GCC will compile the code as if it was written:
7343 @example
7344 extern void prefix_bar (int);
7345 void
7346 prefix_foo (int a)
7348   return prefix_bar (a + 5);
7350 @end example
7351 This option is designed to be used with @samp{-fcheck-memory-usage}.
7353 @item -finstrument-functions
7354 Generate instrumentation calls for entry and exit to functions.  Just
7355 after function entry and just before function exit, the following
7356 profiling functions will be called with the address of the current
7357 function and its call site.  (On some platforms,
7358 @code{__builtin_return_address} does not work beyond the current
7359 function, so the call site information may not be available to the
7360 profiling functions otherwise.)
7362 @example
7363 void __cyg_profile_func_enter (void *this_fn, void *call_site);
7364 void __cyg_profile_func_exit  (void *this_fn, void *call_site);
7365 @end example
7367 The first argument is the address of the start of the current function,
7368 which may be looked up exactly in the symbol table.
7370 This instrumentation is also done for functions expanded inline in other
7371 functions.  The profiling calls will indicate where, conceptually, the
7372 inline function is entered and exited.  This means that addressable
7373 versions of such functions must be available.  If all your uses of a
7374 function are expanded inline, this may mean an additional expansion of
7375 code size.  If you use @samp{extern inline} in your C code, an
7376 addressable version of such functions must be provided.  (This is
7377 normally the case anyways, but if you get lucky and the optimizer always
7378 expands the functions inline, you might have gotten away without
7379 providing static copies.)
7381 A function may be given the attribute @code{no_instrument_function}, in
7382 which case this instrumentation will not be done.  This can be used, for
7383 example, for the profiling functions listed above, high-priority
7384 interrupt routines, and any functions from which the profiling functions
7385 cannot safely be called (perhaps signal handlers, if the profiling
7386 routines generate output or allocate memory).
7388 @item -fstack-check
7389 Generate code to verify that you do not go beyond the boundary of the
7390 stack.  You should specify this flag if you are running in an
7391 environment with multiple threads, but only rarely need to specify it in
7392 a single-threaded environment since stack overflow is automatically
7393 detected on nearly all systems if there is only one stack.
7395 Note that this switch does not actually cause checking to be done; the
7396 operating system must do that.  The switch causes generation of code
7397 to ensure that the operating system sees the stack being extended.
7399 @item -fstack-limit-register=@var{reg}
7400 @itemx -fstack-limit-symbol=@var{sym}
7401 @itemx -fno-stack-limit
7402 Generate code to ensure that the stack does not grow beyond a certain value,
7403 either the value of a register or the address of a symbol.  If the stack
7404 would grow beyond the value, a signal is raised.  For most targets,
7405 the signal is raised before the stack overruns the boundary, so
7406 it is possible to catch the signal without taking special precautions.
7408 For instance, if the stack starts at address @samp{0x80000000} and grows
7409 downwards you can use the flags
7410 @samp{-fstack-limit-symbol=__stack_limit}
7411 @samp{-Wl,--defsym,__stack_limit=0x7ffe0000} which will enforce a stack
7412 limit of 128K.
7414 @cindex aliasing of parameters
7415 @cindex parameters, aliased
7416 @item -fargument-alias
7417 @itemx -fargument-noalias
7418 @itemx -fargument-noalias-global
7419 Specify the possible relationships among parameters and between
7420 parameters and global data.
7422 @samp{-fargument-alias} specifies that arguments (parameters) may
7423 alias each other and may alias global storage.
7424 @samp{-fargument-noalias} specifies that arguments do not alias
7425 each other, but may alias global storage.
7426 @samp{-fargument-noalias-global} specifies that arguments do not
7427 alias each other and do not alias global storage.
7429 Each language will automatically use whatever option is required by
7430 the language standard.  You should not need to use these options yourself.
7432 @item -fleading-underscore
7433 This option and its counterpart, -fno-leading-underscore, forcibly
7434 change the way C symbols are represented in the object file.  One use
7435 is to help link with legacy assembly code.
7437 Be warned that you should know what you are doing when invoking this
7438 option, and that not all targets provide complete support for it.
7439 @end table
7441 @node Environment Variables
7442 @section Environment Variables Affecting GCC
7443 @cindex environment variables
7445 This section describes several environment variables that affect how GCC
7446 operates.  Some of them work by specifying directories or prefixes to use
7447 when searching for various kinds of files. Some are used to specify other
7448 aspects of the compilation environment.
7450 @ifclear INTERNALS
7451 Note that you can also specify places to search using options such as
7452 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
7453 take precedence over places specified using environment variables, which
7454 in turn take precedence over those specified by the configuration of GCC.
7456 @end ifclear
7457 @ifset INTERNALS
7458 Note that you can also specify places to search using options such as
7459 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
7460 take precedence over places specified using environment variables, which
7461 in turn take precedence over those specified by the configuration of GCC.
7462 @xref{Driver}.
7463 @end ifset
7465 @table @code
7466 @item LANG
7467 @itemx LC_CTYPE
7468 @c @itemx LC_COLLATE
7469 @itemx LC_MESSAGES
7470 @c @itemx LC_MONETARY
7471 @c @itemx LC_NUMERIC
7472 @c @itemx LC_TIME
7473 @itemx LC_ALL
7474 @findex LANG
7475 @findex LC_CTYPE
7476 @c @findex LC_COLLATE
7477 @findex LC_MESSAGES
7478 @c @findex LC_MONETARY
7479 @c @findex LC_NUMERIC
7480 @c @findex LC_TIME
7481 @findex LC_ALL
7482 @cindex locale
7483 These environment variables control the way that GCC uses
7484 localization information that allow GCC to work with different
7485 national conventions.  GCC inspects the locale categories
7486 @code{LC_CTYPE} and @code{LC_MESSAGES} if it has been configured to do
7487 so.  These locale categories can be set to any value supported by your
7488 installation.  A typical value is @samp{en_UK} for English in the United
7489 Kingdom.
7491 The @code{LC_CTYPE} environment variable specifies character
7492 classification.  GCC uses it to determine the character boundaries in
7493 a string; this is needed for some multibyte encodings that contain quote
7494 and escape characters that would otherwise be interpreted as a string
7495 end or escape.
7497 The @code{LC_MESSAGES} environment variable specifies the language to
7498 use in diagnostic messages.
7500 If the @code{LC_ALL} environment variable is set, it overrides the value
7501 of @code{LC_CTYPE} and @code{LC_MESSAGES}; otherwise, @code{LC_CTYPE}
7502 and @code{LC_MESSAGES} default to the value of the @code{LANG}
7503 environment variable.  If none of these variables are set, GCC
7504 defaults to traditional C English behavior.
7506 @item TMPDIR
7507 @findex TMPDIR
7508 If @code{TMPDIR} is set, it specifies the directory to use for temporary
7509 files.  GCC uses temporary files to hold the output of one stage of
7510 compilation which is to be used as input to the next stage: for example,
7511 the output of the preprocessor, which is the input to the compiler
7512 proper.
7514 @item GCC_EXEC_PREFIX
7515 @findex GCC_EXEC_PREFIX
7516 If @code{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
7517 names of the subprograms executed by the compiler.  No slash is added
7518 when this prefix is combined with the name of a subprogram, but you can
7519 specify a prefix that ends with a slash if you wish.
7521 If @code{GCC_EXEC_PREFIX} is not set, GNU CC will attempt to figure out
7522 an appropriate prefix to use based on the pathname it was invoked with.
7524 If GCC cannot find the subprogram using the specified prefix, it
7525 tries looking in the usual places for the subprogram.
7527 The default value of @code{GCC_EXEC_PREFIX} is
7528 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
7529 of @code{prefix} when you ran the @file{configure} script.
7531 Other prefixes specified with @samp{-B} take precedence over this prefix.
7533 This prefix is also used for finding files such as @file{crt0.o} that are
7534 used for linking.
7536 In addition, the prefix is used in an unusual way in finding the
7537 directories to search for header files.  For each of the standard
7538 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
7539 (more precisely, with the value of @code{GCC_INCLUDE_DIR}), GCC tries
7540 replacing that beginning with the specified prefix to produce an
7541 alternate directory name.  Thus, with @samp{-Bfoo/}, GCC will search
7542 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
7543 These alternate directories are searched first; the standard directories
7544 come next.
7546 @item COMPILER_PATH
7547 @findex COMPILER_PATH
7548 The value of @code{COMPILER_PATH} is a colon-separated list of
7549 directories, much like @code{PATH}.  GCC tries the directories thus
7550 specified when searching for subprograms, if it can't find the
7551 subprograms using @code{GCC_EXEC_PREFIX}.
7553 @item LIBRARY_PATH
7554 @findex LIBRARY_PATH
7555 The value of @code{LIBRARY_PATH} is a colon-separated list of
7556 directories, much like @code{PATH}.  When configured as a native compiler,
7557 GCC tries the directories thus specified when searching for special
7558 linker files, if it can't find them using @code{GCC_EXEC_PREFIX}.  Linking
7559 using GCC also uses these directories when searching for ordinary
7560 libraries for the @samp{-l} option (but directories specified with
7561 @samp{-L} come first).
7563 @item C_INCLUDE_PATH
7564 @itemx CPLUS_INCLUDE_PATH
7565 @itemx OBJC_INCLUDE_PATH
7566 @findex C_INCLUDE_PATH
7567 @findex CPLUS_INCLUDE_PATH
7568 @findex OBJC_INCLUDE_PATH
7569 @c @itemx OBJCPLUS_INCLUDE_PATH
7570 These environment variables pertain to particular languages.  Each
7571 variable's value is a colon-separated list of directories, much like
7572 @code{PATH}.  When GCC searches for header files, it tries the
7573 directories listed in the variable for the language you are using, after
7574 the directories specified with @samp{-I} but before the standard header
7575 file directories.
7577 @item DEPENDENCIES_OUTPUT
7578 @findex DEPENDENCIES_OUTPUT
7579 @cindex dependencies for make as output
7580 If this variable is set, its value specifies how to output dependencies
7581 for Make based on the header files processed by the compiler.  This
7582 output looks much like the output from the @samp{-M} option
7583 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
7584 in addition to the usual results of compilation.
7586 The value of @code{DEPENDENCIES_OUTPUT} can be just a file name, in
7587 which case the Make rules are written to that file, guessing the target
7588 name from the source file name.  Or the value can have the form
7589 @samp{@var{file} @var{target}}, in which case the rules are written to
7590 file @var{file} using @var{target} as the target name.
7592 @item LANG
7593 @findex LANG
7594 @cindex locale definition
7595 This variable is used to pass locale information to the compiler. One way in
7596 which this information is used is to determine the character set to be used
7597 when character literals, string literals and comments are parsed in C and C++.
7598 When the compiler is configured to allow multibyte characters,
7599 the following values for @code{LANG} are recognized:
7601 @table @code
7602 @item C-JIS
7603 Recognize JIS characters.
7604 @item C-SJIS
7605 Recognize SJIS characters.
7606 @item C-EUCJP
7607 Recognize EUCJP characters.
7608 @end table
7610 If @code{LANG} is not defined, or if it has some other value, then the
7611 compiler will use mblen and mbtowc as defined by the default locale to
7612 recognize and translate multibyte characters.
7613 @end table
7615 @node Running Protoize
7616 @section Running Protoize
7618 The program @code{protoize} is an optional part of GNU C.  You can use
7619 it to add prototypes to a program, thus converting the program to ANSI
7620 C in one respect.  The companion program @code{unprotoize} does the
7621 reverse: it removes argument types from any prototypes that are found.
7623 When you run these programs, you must specify a set of source files as
7624 command line arguments.  The conversion programs start out by compiling
7625 these files to see what functions they define.  The information gathered
7626 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
7628 After scanning comes actual conversion.  The specified files are all
7629 eligible to be converted; any files they include (whether sources or
7630 just headers) are eligible as well.
7632 But not all the eligible files are converted.  By default,
7633 @code{protoize} and @code{unprotoize} convert only source and header
7634 files in the current directory.  You can specify additional directories
7635 whose files should be converted with the @samp{-d @var{directory}}
7636 option.  You can also specify particular files to exclude with the
7637 @samp{-x @var{file}} option.  A file is converted if it is eligible, its
7638 directory name matches one of the specified directory names, and its
7639 name within the directory has not been excluded.
7641 Basic conversion with @code{protoize} consists of rewriting most
7642 function definitions and function declarations to specify the types of
7643 the arguments.  The only ones not rewritten are those for varargs
7644 functions.
7646 @code{protoize} optionally inserts prototype declarations at the
7647 beginning of the source file, to make them available for any calls that
7648 precede the function's definition.  Or it can insert prototype
7649 declarations with block scope in the blocks where undeclared functions
7650 are called.
7652 Basic conversion with @code{unprotoize} consists of rewriting most
7653 function declarations to remove any argument types, and rewriting
7654 function definitions to the old-style pre-ANSI form.
7656 Both conversion programs print a warning for any function declaration or
7657 definition that they can't convert.  You can suppress these warnings
7658 with @samp{-q}.
7660 The output from @code{protoize} or @code{unprotoize} replaces the
7661 original source file.  The original file is renamed to a name ending
7662 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav} 
7663 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
7664 for DOS) file already exists, then the source file is simply discarded.
7666 @code{protoize} and @code{unprotoize} both depend on GCC itself to
7667 scan the program and collect information about the functions it uses.
7668 So neither of these programs will work until GCC is installed.
7670 Here is a table of the options you can use with @code{protoize} and
7671 @code{unprotoize}.  Each option works with both programs unless
7672 otherwise stated.
7674 @table @code
7675 @item -B @var{directory}
7676 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
7677 usual directory (normally @file{/usr/local/lib}).  This file contains
7678 prototype information about standard system functions.  This option
7679 applies only to @code{protoize}.
7681 @item -c @var{compilation-options}
7682 Use  @var{compilation-options} as the options when running @code{gcc} to
7683 produce the @samp{.X} files.  The special option @samp{-aux-info} is
7684 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
7686 Note that the compilation options must be given as a single argument to
7687 @code{protoize} or @code{unprotoize}.  If you want to specify several
7688 @code{gcc} options, you must quote the entire set of compilation options
7689 to make them a single word in the shell.
7691 There are certain @code{gcc} arguments that you cannot use, because they
7692 would produce the wrong kind of output.  These include @samp{-g},
7693 @samp{-O}, @samp{-c}, @samp{-S}, and @samp{-o} If you include these in
7694 the @var{compilation-options}, they are ignored.
7696 @item -C
7697 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
7698 systems) instead of @samp{.c}.  This is convenient if you are converting 
7699 a C program to C++.  This option applies only to @code{protoize}.
7701 @item -g
7702 Add explicit global declarations.  This means inserting explicit
7703 declarations at the beginning of each source file for each function
7704 that is called in the file and was not declared.  These declarations
7705 precede the first function definition that contains a call to an
7706 undeclared function.  This option applies only to @code{protoize}.
7708 @item -i @var{string}
7709 Indent old-style parameter declarations with the string @var{string}.
7710 This option applies only to @code{protoize}.
7712 @code{unprotoize} converts prototyped function definitions to old-style
7713 function definitions, where the arguments are declared between the
7714 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
7715 uses five spaces as the indentation.  If you want to indent with just
7716 one space instead, use @samp{-i " "}.
7718 @item -k
7719 Keep the @samp{.X} files.  Normally, they are deleted after conversion
7720 is finished.
7722 @item -l
7723 Add explicit local declarations.  @code{protoize} with @samp{-l} inserts
7724 a prototype declaration for each function in each block which calls the
7725 function without any declaration.  This option applies only to
7726 @code{protoize}.
7728 @item -n
7729 Make no real changes.  This mode just prints information about the conversions
7730 that would have been done without @samp{-n}.
7732 @item -N
7733 Make no @samp{.save} files.  The original files are simply deleted.
7734 Use this option with caution.
7736 @item -p @var{program}
7737 Use the program @var{program} as the compiler.  Normally, the name
7738 @file{gcc} is used.
7740 @item -q
7741 Work quietly.  Most warnings are suppressed.
7743 @item -v
7744 Print the version number, just like @samp{-v} for @code{gcc}.
7745 @end table
7747 If you need special compiler options to compile one of your program's
7748 source files, then you should generate that file's @samp{.X} file
7749 specially, by running @code{gcc} on that source file with the
7750 appropriate options and the option @samp{-aux-info}.  Then run
7751 @code{protoize} on the entire set of files.  @code{protoize} will use
7752 the existing @samp{.X} file because it is newer than the source file.
7753 For example:
7755 @example
7756 gcc -Dfoo=bar file1.c -aux-info
7757 protoize *.c
7758 @end example
7760 @noindent
7761 You need to include the special files along with the rest in the
7762 @code{protoize} command, even though their @samp{.X} files already
7763 exist, because otherwise they won't get converted.
7765 @xref{Protoize Caveats}, for more information on how to use
7766 @code{protoize} successfully.