OSDN Git Service

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