OSDN Git Service

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