OSDN Git Service

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