OSDN Git Service

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