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