OSDN Git Service

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