* optimize.c (initialize_inlined_parameters): Take FN to which the
[official-gcc.git] / gcc / invoke.texi
blob6f5185acc26a5a1e9dccc4e34ffb9502b17431bc
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.
1729 @item
1730 Usage of ANSI string concatenation is detected.
1731 @end itemize
1733 @item -Wundef
1734 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
1736 @item -Wshadow
1737 Warn whenever a local variable shadows another local variable.
1739 @item -Wid-clash-@var{len}
1740 Warn whenever two distinct identifiers match in the first @var{len}
1741 characters.  This may help you prepare a program that will compile
1742 with certain obsolete, brain-damaged compilers.
1744 @item -Wlarger-than-@var{len}
1745 Warn whenever an object of larger than @var{len} bytes is defined.
1747 @item -Wpointer-arith
1748 Warn about anything that depends on the ``size of'' a function type or
1749 of @code{void}.  GNU C assigns these types a size of 1, for
1750 convenience in calculations with @code{void *} pointers and pointers
1751 to functions.
1753 @item -Wbad-function-cast (C only)
1754 Warn whenever a function call is cast to a non-matching type.
1755 For example, warn if @code{int malloc()} is cast to @code{anything *}.
1757 @item -Wcast-qual
1758 Warn whenever a pointer is cast so as to remove a type qualifier from
1759 the target type.  For example, warn if a @code{const char *} is cast
1760 to an ordinary @code{char *}.
1762 @item -Wcast-align
1763 Warn whenever a pointer is cast such that the required alignment of the
1764 target is increased.  For example, warn if a @code{char *} is cast to
1765 an @code{int *} on machines where integers can only be accessed at
1766 two- or four-byte boundaries.
1768 @item -Wwrite-strings
1769 Give string constants the type @code{const char[@var{length}]} so that
1770 copying the address of one into a non-@code{const} @code{char *}
1771 pointer will get a warning.  These warnings will help you find at
1772 compile time code that can try to write into a string constant, but
1773 only if you have been very careful about using @code{const} in
1774 declarations and prototypes.  Otherwise, it will just be a nuisance;
1775 this is why we did not make @samp{-Wall} request these warnings.
1777 @item -Wconversion
1778 Warn if a prototype causes a type conversion that is different from what
1779 would happen to the same argument in the absence of a prototype.  This
1780 includes conversions of fixed point to floating and vice versa, and
1781 conversions changing the width or signedness of a fixed point argument
1782 except when the same as the default promotion.
1784 Also, warn if a negative integer constant expression is implicitly
1785 converted to an unsigned type.  For example, warn about the assignment
1786 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
1787 casts like @code{(unsigned) -1}.
1789 @item -Wsign-compare
1790 @cindex warning for comparison of signed and unsigned values
1791 @cindex comparison of signed and unsigned values, warning
1792 @cindex signed and unsigned values, comparison warning
1793 Warn when a comparison between signed and unsigned values could produce
1794 an incorrect result when the signed value is converted to unsigned.
1795 This warning is also enabled by @samp{-W}; to get the other warnings
1796 of @samp{-W} without this warning, use @samp{-W -Wno-sign-compare}.
1798 @item -Waggregate-return
1799 Warn if any functions that return structures or unions are defined or
1800 called.  (In languages where you can return an array, this also elicits
1801 a warning.)
1803 @item -Wstrict-prototypes (C only)
1804 Warn if a function is declared or defined without specifying the
1805 argument types.  (An old-style function definition is permitted without
1806 a warning if preceded by a declaration which specifies the argument
1807 types.)
1809 @item -Wmissing-prototypes (C only)
1810 Warn if a global function is defined without a previous prototype
1811 declaration.  This warning is issued even if the definition itself
1812 provides a prototype.  The aim is to detect global functions that fail
1813 to be declared in header files.
1815 @item -Wmissing-declarations
1816 Warn if a global function is defined without a previous declaration.
1817 Do so even if the definition itself provides a prototype.
1818 Use this option to detect global functions that are not declared in
1819 header files.
1821 @item -Wmissing-noreturn
1822 Warn about functions which might be candidates for attribute @code{noreturn}.
1823 Note these are only possible candidates, not absolute ones.  Care should
1824 be taken to manually verify functions actually do not ever return before
1825 adding the @code{noreturn} attribute, otherwise subtle code generation
1826 bugs could be introduced.
1828 @item -Wpacked
1829 Warn if a structure is given the packed attribute, but the packed
1830 attribute has no effect on the layout or size of the structure.  
1831 Such structures may be mis-aligned for little benefit.  For
1832 instance, in this code, the variable @code{f.x} in @code{struct bar}
1833 will be misaligned even though @code{struct bar} does not itself
1834 have the packed attribute:
1836 @smallexample
1837 @group
1838 struct foo @{
1839   int x;
1840   char a, b, c, d;
1841 @} __attribute__((packed));
1842 struct bar @{
1843   char z;
1844   struct foo f;
1846 @end group
1847 @end smallexample
1849 @item -Wpadded
1850 Warn if padding is included in a structure, either to align an element
1851 of the structure or to align the whole structure.  Sometimes when this
1852 happens it is possible to rearrange the fields of the structure to
1853 reduce the padding and so make the structure smaller.
1855 @item -Wredundant-decls
1856 Warn if anything is declared more than once in the same scope, even in
1857 cases where multiple declaration is valid and changes nothing.
1859 @item -Wnested-externs (C only)
1860 Warn if an @code{extern} declaration is encountered within a function.
1862 @item -Wunreachable-code
1863 Warn if the compiler detects that code will never be executed.
1865 This option is intended to warn when the compiler detects that at
1866 least a whole line of source code will never be executed, because
1867 some condition is never satisfied or because it is after a
1868 procedure that never returns.
1870 It is possible for this option to produce a warning even though there
1871 are circumstances under which part of the affected line can be executed,
1872 so care should be taken when removing apparently-unreachable code.
1874 For instance, when a function is inlined, a warning may mean that the
1875 line is unreachable in only one inlined copy of the function.  
1877 This option is not made part of @samp{-Wall} because in a debugging
1878 version of a program there is often substantial code which checks
1879 correct functioning of the program and is, hopefully, unreachable
1880 because the program does work.  Another common use of unreachable
1881 code is to provide behaviour which is selectable at compile-time.
1883 @item -Winline
1884 Warn if a function can not be inlined and it was declared as inline.
1886 @item -Wlong-long
1887 Warn if @samp{long long} type is used.  This is default.  To inhibit
1888 the warning messages, use @samp{-Wno-long-long}.  Flags
1889 @samp{-Wlong-long} and @samp{-Wno-long-long} are taken into account
1890 only when @samp{-pedantic} flag is used.
1892 @item -Werror
1893 Make all warnings into errors.
1894 @end table
1896 @node Debugging Options
1897 @section Options for Debugging Your Program or GCC
1898 @cindex options, debugging
1899 @cindex debugging information options
1901 GCC has various special options that are used for debugging
1902 either your program or GCC:
1904 @table @code
1905 @item -g
1906 Produce debugging information in the operating system's native format
1907 (stabs, COFF, XCOFF, or DWARF).  GDB can work with this debugging
1908 information.
1910 On most systems that use stabs format, @samp{-g} enables use of extra
1911 debugging information that only GDB can use; this extra information
1912 makes debugging work better in GDB but will probably make other debuggers
1913 crash or
1914 refuse to read the program.  If you want to control for certain whether
1915 to generate the extra information, use @samp{-gstabs+}, @samp{-gstabs},
1916 @samp{-gxcoff+}, @samp{-gxcoff}, @samp{-gdwarf-1+}, or @samp{-gdwarf-1}
1917 (see below).
1919 Unlike most other C compilers, GCC allows you to use @samp{-g} with
1920 @samp{-O}.  The shortcuts taken by optimized code may occasionally
1921 produce surprising results: some variables you declared may not exist
1922 at all; flow of control may briefly move where you did not expect it;
1923 some statements may not be executed because they compute constant
1924 results or their values were already at hand; some statements may
1925 execute in different places because they were moved out of loops.
1927 Nevertheless it proves possible to debug optimized output.  This makes
1928 it reasonable to use the optimizer for programs that might have bugs.
1930 The following options are useful when GCC is generated with the
1931 capability for more than one debugging format.
1933 @item -ggdb
1934 Produce debugging information for use by GDB.  This means to use the
1935 most expressive format available (DWARF 2, stabs, or the native format
1936 if neither of those are supported), including GDB extensions if at all
1937 possible.
1939 @item -gstabs
1940 Produce debugging information in stabs format (if that is supported),
1941 without GDB extensions.  This is the format used by DBX on most BSD
1942 systems.  On MIPS, Alpha and System V Release 4 systems this option
1943 produces stabs debugging output which is not understood by DBX or SDB.
1944 On System V Release 4 systems this option requires the GNU assembler.
1946 @item -gstabs+
1947 Produce debugging information in stabs format (if that is supported),
1948 using GNU extensions understood only by the GNU debugger (GDB).  The
1949 use of these extensions is likely to make other debuggers crash or
1950 refuse to read the program.
1952 @item -gcoff
1953 Produce debugging information in COFF format (if that is supported).
1954 This is the format used by SDB on most System V systems prior to
1955 System V Release 4.
1957 @item -gxcoff
1958 Produce debugging information in XCOFF format (if that is supported).
1959 This is the format used by the DBX debugger on IBM RS/6000 systems.
1961 @item -gxcoff+
1962 Produce debugging information in XCOFF format (if that is supported),
1963 using GNU extensions understood only by the GNU debugger (GDB).  The
1964 use of these extensions is likely to make other debuggers crash or
1965 refuse to read the program, and may cause assemblers other than the GNU
1966 assembler (GAS) to fail with an error.
1968 @item -gdwarf
1969 Produce debugging information in DWARF version 1 format (if that is
1970 supported).  This is the format used by SDB on most System V Release 4
1971 systems.
1973 @item -gdwarf+
1974 Produce debugging information in DWARF version 1 format (if that is
1975 supported), using GNU extensions understood only by the GNU debugger
1976 (GDB).  The use of these extensions is likely to make other debuggers
1977 crash or refuse to read the program.
1979 @item -gdwarf-2
1980 Produce debugging information in DWARF version 2 format (if that is
1981 supported).  This is the format used by DBX on IRIX 6.
1983 @item -g@var{level}
1984 @itemx -ggdb@var{level}
1985 @itemx -gstabs@var{level}
1986 @itemx -gcoff@var{level}
1987 @itemx -gxcoff@var{level}
1988 @itemx -gdwarf@var{level}
1989 @itemx -gdwarf-2@var{level}
1990 Request debugging information and also use @var{level} to specify how
1991 much information.  The default level is 2.
1993 Level 1 produces minimal information, enough for making backtraces in
1994 parts of the program that you don't plan to debug.  This includes
1995 descriptions of functions and external variables, but no information
1996 about local variables and no line numbers.
1998 Level 3 includes extra information, such as all the macro definitions
1999 present in the program.  Some debuggers support macro expansion when
2000 you use @samp{-g3}.
2002 @cindex @code{prof}
2003 @item -p
2004 Generate extra code to write profile information suitable for the
2005 analysis program @code{prof}.  You must use this option when compiling
2006 the source files you want data about, and you must also use it when
2007 linking.
2009 @cindex @code{gprof}
2010 @item -pg
2011 Generate extra code to write profile information suitable for the
2012 analysis program @code{gprof}.  You must use this option when compiling
2013 the source files you want data about, and you must also use it when
2014 linking.
2016 @cindex @code{tcov}
2017 @item -a
2018 Generate extra code to write profile information for basic blocks, which will
2019 record the number of times each basic block is executed, the basic block start
2020 address, and the function name containing the basic block.  If @samp{-g} is
2021 used, the line number and filename of the start of the basic block will also be
2022 recorded.  If not overridden by the machine description, the default action is
2023 to append to the text file @file{bb.out}.
2025 This data could be analyzed by a program like @code{tcov}.  Note,
2026 however, that the format of the data is not what @code{tcov} expects.
2027 Eventually GNU @code{gprof} should be extended to process this data.
2029 @item -Q
2030 Makes the compiler print out each function name as it is compiled, and
2031 print some statistics about each pass when it finishes.
2033 @item -ax
2034 Generate extra code to profile basic blocks.  Your executable will
2035 produce output that is a superset of that produced when @samp{-a} is
2036 used.  Additional output is the source and target address of the basic
2037 blocks where a jump takes place, the number of times a jump is executed,
2038 and (optionally) the complete sequence of basic blocks being executed.
2039 The output is appended to file @file{bb.out}.
2041 You can examine different profiling aspects without recompilation.  Your
2042 executable will read a list of function names from file @file{bb.in}.
2043 Profiling starts when a function on the list is entered and stops when
2044 that invocation is exited.  To exclude a function from profiling, prefix
2045 its name with `-'.  If a function name is not unique, you can
2046 disambiguate it by writing it in the form
2047 @samp{/path/filename.d:functionname}.  Your executable will write the
2048 available paths and filenames in file @file{bb.out}.
2050 Several function names have a special meaning:
2051 @table @code
2052 @item __bb_jumps__
2053 Write source, target and frequency of jumps to file @file{bb.out}.
2054 @item __bb_hidecall__
2055 Exclude function calls from frequency count.
2056 @item __bb_showret__
2057 Include function returns in frequency count.
2058 @item __bb_trace__
2059 Write the sequence of basic blocks executed to file @file{bbtrace.gz}.
2060 The file will be compressed using the program @samp{gzip}, which must
2061 exist in your @code{PATH}.  On systems without the @samp{popen}
2062 function, the file will be named @file{bbtrace} and will not be
2063 compressed.  @strong{Profiling for even a few seconds on these systems
2064 will produce a very large file.}  Note: @code{__bb_hidecall__} and
2065 @code{__bb_showret__} will not affect the sequence written to
2066 @file{bbtrace.gz}.
2067 @end table
2069 Here's a short example using different profiling parameters
2070 in file @file{bb.in}.  Assume function @code{foo} consists of basic blocks
2071 1 and 2 and is called twice from block 3 of function @code{main}.  After
2072 the calls, block 3 transfers control to block 4 of @code{main}.
2074 With @code{__bb_trace__} and @code{main} contained in file @file{bb.in},
2075 the following sequence of blocks is written to file @file{bbtrace.gz}:
2076 0 3 1 2 1 2 4.  The return from block 2 to block 3 is not shown, because
2077 the return is to a point inside the block and not to the top.  The
2078 block address 0 always indicates, that control is transferred
2079 to the trace from somewhere outside the observed functions.  With
2080 @samp{-foo} added to @file{bb.in}, the blocks of function
2081 @code{foo} are removed from the trace, so only 0 3 4 remains.
2083 With @code{__bb_jumps__} and @code{main} contained in file @file{bb.in},
2084 jump frequencies will be written to file @file{bb.out}.  The
2085 frequencies are obtained by constructing a trace of blocks
2086 and incrementing a counter for every neighbouring pair of blocks
2087 in the trace.  The trace 0 3 1 2 1 2 4 displays the following
2088 frequencies:
2090 @example
2091 Jump from block 0x0 to block 0x3 executed 1 time(s)
2092 Jump from block 0x3 to block 0x1 executed 1 time(s)
2093 Jump from block 0x1 to block 0x2 executed 2 time(s)
2094 Jump from block 0x2 to block 0x1 executed 1 time(s)
2095 Jump from block 0x2 to block 0x4 executed 1 time(s)
2096 @end example
2098 With @code{__bb_hidecall__}, control transfer due to call instructions
2099 is removed from the trace, that is the trace is cut into three parts: 0
2100 3 4, 0 1 2 and 0 1 2.  With @code{__bb_showret__}, control transfer due
2101 to return instructions is added to the trace.  The trace becomes: 0 3 1
2102 2 3 1 2 3 4.  Note, that this trace is not the same, as the sequence
2103 written to @file{bbtrace.gz}.  It is solely used for counting jump
2104 frequencies.
2106 @item -fprofile-arcs
2107 Instrument @dfn{arcs} during compilation.  For each function of your
2108 program, GCC creates a program flow graph, then finds a spanning tree
2109 for the graph.  Only arcs that are not on the spanning tree have to be
2110 instrumented: the compiler adds code to count the number of times that these
2111 arcs are executed.  When an arc is the only exit or only entrance to a
2112 block, the instrumentation code can be added to the block; otherwise, a
2113 new basic block must be created to hold the instrumentation code.
2115 Since not every arc in the program must be instrumented, programs
2116 compiled with this option run faster than programs compiled with
2117 @samp{-a}, which adds instrumentation code to every basic block in the
2118 program.  The tradeoff: since @code{gcov} does not have
2119 execution counts for all branches, it must start with the execution
2120 counts for the instrumented branches, and then iterate over the program
2121 flow graph until the entire graph has been solved.  Hence, @code{gcov}
2122 runs a little more slowly than a program which uses information from
2123 @samp{-a}.
2125 @samp{-fprofile-arcs} also makes it possible to estimate branch
2126 probabilities, and to calculate basic block execution counts.  In
2127 general, basic block execution counts do not give enough information to
2128 estimate all branch probabilities.  When the compiled program exits, it
2129 saves the arc execution counts to a file called
2130 @file{@var{sourcename}.da}.  Use the compiler option
2131 @samp{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2132 Control Optimization}) when recompiling, to optimize using estimated
2133 branch probabilities.
2135 @need 2000
2136 @item -ftest-coverage
2137 Create data files for the @code{gcov} code-coverage utility
2138 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
2139 The data file names begin with the name of your source file:
2141 @table @code
2142 @item @var{sourcename}.bb
2143 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2144 associate basic block execution counts with line numbers.
2146 @item @var{sourcename}.bbg
2147 A list of all arcs in the program flow graph.  This allows @code{gcov}
2148 to reconstruct the program flow graph, so that it can compute all basic
2149 block and arc execution counts from the information in the
2150 @code{@var{sourcename}.da} file (this last file is the output from
2151 @samp{-fprofile-arcs}).
2152 @end table
2154 @item -d@var{letters}
2155 Says to make debugging dumps during compilation at times specified by
2156 @var{letters}.  This is used for debugging the compiler.  The file names
2157 for most of the dumps are made by appending a pass number and a word to
2158 the source file name (e.g.  @file{foo.c.00.rtl} or @file{foo.c.01.jump}). 
2159 Here are the possible letters for use in @var{letters}, and their meanings:
2161 @table @samp
2162 @item A
2163 Annotate the assembler output with miscellaneous debugging information.
2164 @item b
2165 Dump after computing branch probabilities, to @file{@var{file}.07.bp}.
2166 @item c
2167 Dump after instruction combination, to the file @file{@var{file}.09.combine}.
2168 @item d
2169 Dump after delayed branch scheduling, to @file{@var{file}.19.dbr}.
2170 @item D
2171 Dump all macro definitions, at the end of preprocessing, in addition to
2172 normal output.
2173 @item F
2174 Dump after purging ADDRESSOF, to @file{@var{file}.03.addressof}.
2175 @item f
2176 Dump after flow analysis, to @file{@var{file}.08.flow}.
2177 @item g
2178 Dump after global register allocation, to @file{@var{file}.13.greg}.
2179 @item G      
2180 Dump after GCSE, to @file{@var{file}.04.gcse}.
2181 @item j
2182 Dump after first jump optimization, to @file{@var{file}.01.jump}.
2183 @item J
2184 Dump after last jump optimization, to @file{@var{file}.17.jump2}.
2185 @item k
2186 Dump after conversion from registers to stack, to @file{@var{file}.20.stack}.
2187 @item l
2188 Dump after local register allocation, to @file{@var{file}.12.lreg}.
2189 @item L
2190 Dump after loop optimization, to @file{@var{file}.05.loop}.
2191 @item M
2192 Dump after performing the machine dependent reorganisation pass, to
2193 @file{@var{file}.18.mach}. 
2194 @item N
2195 Dump after the register move pass, to @file{@var{file}.10.regmove}.
2196 @item r
2197 Dump after RTL generation, to @file{@var{file}.00.rtl}.
2198 @item R
2199 Dump after the second instruction scheduling pass, to
2200 @file{@var{file}.16.sched2}.
2201 @item s
2202 Dump after CSE (including the jump optimization that sometimes follows
2203 CSE), to @file{@var{file}.02.cse}. 
2204 @item S
2205 Dump after the first instruction scheduling pass, to
2206 @file{@var{file}.11.sched}.
2207 @item t
2208 Dump after the second CSE pass (including the jump optimization that
2209 sometimes follows CSE), to @file{@var{file}.06.cse2}. 
2210 @item a
2211 Produce all the dumps listed above.
2212 @item m
2213 Print statistics on memory usage, at the end of the run, to
2214 standard error.
2215 @item p
2216 Annotate the assembler output with a comment indicating which
2217 pattern and alternative was used.  The length of each instruction is
2218 also printed.
2219 @item v
2220 For each of the other indicated dump files (except for
2221 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
2222 suitible for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
2223 @item w
2224 Dump after the second flow pass to @file{@var{file}.14.flow2}. 
2225 @item x
2226 Just generate RTL for a function instead of compiling it.  Usually used
2227 with @samp{r}.
2228 @item y
2229 Dump debugging information during parsing, to standard error.
2230 @item z
2231 Dump after the peephole2 pass to @file{@var{file}.15.peephole2}.
2232 @end table
2234 @item -fdump-unnumbered
2235 When doing debugging dumps (see -d option above), suppress instruction
2236 numbers and line number note output.  This makes it more feasible to
2237 use diff on debugging dumps for compiler invokations with different
2238 options, in particular with and without -g.
2240 @item -fdump-translation-unit-@var{file} (C++ only)
2241 Dump a representation of the tree structure for the entire translation
2242 unit to @var{file}.
2244 @item -fpretend-float
2245 When running a cross-compiler, pretend that the target machine uses the
2246 same floating point format as the host machine.  This causes incorrect
2247 output of the actual floating constants, but the actual instruction
2248 sequence will probably be the same as GCC would make when running on
2249 the target machine.
2251 @item -save-temps
2252 Store the usual ``temporary'' intermediate files permanently; place them
2253 in the current directory and name them based on the source file.  Thus,
2254 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
2255 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.
2257 @item -time
2258 Report the CPU time taken by each subprocess in the compilation
2259 sequence.  For C source files, this is the preprocessor, compiler
2260 proper, and assembler.  The output looks like this:
2262 @smallexample
2263 # cpp 0.04 0.04
2264 # cc1 0.12 0.01
2265 # as 0.00 0.01
2266 @end smallexample
2268 The first number on each line is the ``user time,'' that is time spent
2269 executing the program itself.  The second number is ``system time,''
2270 time spent executing operating system routines on behalf of the program.
2271 Both numbers are in seconds.
2273 @item -print-file-name=@var{library}
2274 Print the full absolute name of the library file @var{library} that
2275 would be used when linking---and don't do anything else.  With this
2276 option, GCC does not compile or link anything; it just prints the
2277 file name.
2279 @item -print-prog-name=@var{program}
2280 Like @samp{-print-file-name}, but searches for a program such as @samp{cpp}.
2282 @item -print-libgcc-file-name
2283 Same as @samp{-print-file-name=libgcc.a}.
2285 This is useful when you use @samp{-nostdlib} or @samp{-nodefaultlibs}
2286 but you do want to link with @file{libgcc.a}.  You can do
2288 @example
2289 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
2290 @end example
2292 @item -print-search-dirs
2293 Print the name of the configured installation directory and a list of
2294 program and library directories gcc will search---and don't do anything else.
2296 This is useful when gcc prints the error message
2297 @samp{installation problem, cannot exec cpp: No such file or directory}.
2298 To resolve this you either need to put @file{cpp} and the other compiler
2299 components where gcc expects to find them, or you can set the environment
2300 variable @code{GCC_EXEC_PREFIX} to the directory where you installed them.
2301 Don't forget the trailing '/'.
2302 @xref{Environment Variables}.
2303 @end table
2305 @node Optimize Options
2306 @section Options That Control Optimization
2307 @cindex optimize options
2308 @cindex options, optimization
2310 These options control various sorts of optimizations:
2312 @table @code
2313 @item -O
2314 @itemx -O1
2315 Optimize.  Optimizing compilation takes somewhat more time, and a lot
2316 more memory for a large function.
2318 Without @samp{-O}, the compiler's goal is to reduce the cost of
2319 compilation and to make debugging produce the expected results.
2320 Statements are independent: if you stop the program with a breakpoint
2321 between statements, you can then assign a new value to any variable or
2322 change the program counter to any other statement in the function and
2323 get exactly the results you would expect from the source code.
2325 Without @samp{-O}, the compiler only allocates variables declared
2326 @code{register} in registers.  The resulting compiled code is a little
2327 worse than produced by PCC without @samp{-O}.
2329 With @samp{-O}, the compiler tries to reduce code size and execution
2330 time.
2332 When you specify @samp{-O}, the compiler turns on @samp{-fthread-jumps}
2333 and @samp{-fdefer-pop} on all machines.  The compiler turns on
2334 @samp{-fdelayed-branch} on machines that have delay slots, and
2335 @samp{-fomit-frame-pointer} on machines that can support debugging even
2336 without a frame pointer.  On some machines the compiler also turns
2337 on other flags.@refill
2339 @item -O2
2340 Optimize even more.  GCC performs nearly all supported optimizations
2341 that do not involve a space-speed tradeoff.  The compiler does not
2342 perform loop unrolling or function inlining when you specify @samp{-O2}.
2343 As compared to @samp{-O}, this option increases both compilation time
2344 and the performance of the generated code.
2346 @samp{-O2} turns on all optional optimizations except for loop unrolling
2347 and function inlining.  It also turns on the @samp{-fforce-mem} option
2348 on all machines and frame pointer elimination on machines where doing so
2349 does not interfere with debugging.
2351 @item -O3
2352 Optimize yet more.  @samp{-O3} turns on all optimizations specified by
2353 @samp{-O2} and also turns on the @samp{inline-functions} option.
2355 @item -O0
2356 Do not optimize.
2358 @item -Os
2359 Optimize for size.  @samp{-Os} enables all @samp{-O2} optimizations that
2360 do not typically increase code size.  It also performs further
2361 optimizations designed to reduce code size.
2363 If you use multiple @samp{-O} options, with or without level numbers,
2364 the last such option is the one that is effective.
2365 @end table
2367 Options of the form @samp{-f@var{flag}} specify machine-independent
2368 flags.  Most flags have both positive and negative forms; the negative
2369 form of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below,
2370 only one of the forms is listed---the one which is not the default.
2371 You can figure out the other form by either removing @samp{no-} or
2372 adding it.
2374 @table @code
2375 @item -ffloat-store
2376 Do not store floating point variables in registers, and inhibit other
2377 options that might change whether a floating point value is taken from a
2378 register or memory.
2380 @cindex floating point precision
2381 This option prevents undesirable excess precision on machines such as
2382 the 68000 where the floating registers (of the 68881) keep more
2383 precision than a @code{double} is supposed to have.  Similarly for the
2384 x86 architecture.  For most programs, the excess precision does only
2385 good, but a few programs rely on the precise definition of IEEE floating
2386 point.  Use @samp{-ffloat-store} for such programs, after modifying
2387 them to store all pertinent intermediate computations into variables.
2389 @item -fno-default-inline
2390 Do not make member functions inline by default merely because they are
2391 defined inside the class scope (C++ only).  Otherwise, when you specify
2392 @w{@samp{-O}}, member functions defined inside class scope are compiled
2393 inline by default; i.e., you don't need to add @samp{inline} in front of
2394 the member function name.
2396 @item -fno-defer-pop
2397 Always pop the arguments to each function call as soon as that function
2398 returns.  For machines which must pop arguments after a function call,
2399 the compiler normally lets arguments accumulate on the stack for several
2400 function calls and pops them all at once.
2402 @item -fforce-mem
2403 Force memory operands to be copied into registers before doing
2404 arithmetic on them.  This produces better code by making all memory
2405 references potential common subexpressions.  When they are not common
2406 subexpressions, instruction combination should eliminate the separate
2407 register-load.  The @samp{-O2} option turns on this option.
2409 @item -fforce-addr
2410 Force memory address constants to be copied into registers before
2411 doing arithmetic on them.  This may produce better code just as
2412 @samp{-fforce-mem} may.
2414 @item -fomit-frame-pointer
2415 Don't keep the frame pointer in a register for functions that
2416 don't need one.  This avoids the instructions to save, set up and
2417 restore frame pointers; it also makes an extra register available
2418 in many functions.  @strong{It also makes debugging impossible on
2419 some machines.}
2421 @ifset INTERNALS
2422 On some machines, such as the Vax, this flag has no effect, because
2423 the standard calling sequence automatically handles the frame pointer
2424 and nothing is saved by pretending it doesn't exist.  The
2425 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2426 whether a target machine supports this flag.  @xref{Registers}.@refill
2427 @end ifset
2428 @ifclear INTERNALS
2429 On some machines, such as the Vax, this flag has no effect, because
2430 the standard calling sequence automatically handles the frame pointer
2431 and nothing is saved by pretending it doesn't exist.  The
2432 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2433 whether a target machine supports this flag.  @xref{Registers,,Register
2434 Usage, gcc.info, Using and Porting GCC}.@refill
2435 @end ifclear
2437 @item -fno-inline
2438 Don't pay attention to the @code{inline} keyword.  Normally this option
2439 is used to keep the compiler from expanding any functions inline.
2440 Note that if you are not optimizing, no functions can be expanded inline.
2442 @item -finline-functions
2443 Integrate all simple functions into their callers.  The compiler
2444 heuristically decides which functions are simple enough to be worth
2445 integrating in this way.
2447 If all calls to a given function are integrated, and the function is
2448 declared @code{static}, then the function is normally not output as
2449 assembler code in its own right.
2451 @item -finline-limit=@var{n}
2452 By default, gcc limits the size of functions that can be inlined.  This flag
2453 allows the control of this limit for functions that are explicitly marked as
2454 inline (ie marked with the inline keyword or defined within the class 
2455 definition in c++).  @var{n} is the size of functions that can be inlined in 
2456 number of pseudo instructions (not counting parameter handling).  The default
2457 value of n is 10000.  Increasing this value can result in more inlined code at
2458 the cost of compilation time and memory consumption.  Decreasing usually makes
2459 the compilation faster and less code will be inlined (which presumably 
2460 means slower programs).  This option is particularly useful for programs that 
2461 use inlining heavily such as those based on recursive templates with c++.
2463 @emph{Note:} pseudo instruction represents, in this particular context, an
2464 abstract measurement of function's size.  In no way, it represents a count
2465 of assembly instructions and as such its exact meaning might change from one
2466 release to an another.
2468 @item -fkeep-inline-functions
2469 Even if all calls to a given function are integrated, and the function
2470 is declared @code{static}, nevertheless output a separate run-time
2471 callable version of the function.  This switch does not affect
2472 @code{extern inline} functions.
2474 @item -fkeep-static-consts
2475 Emit variables declared @code{static const} when optimization isn't turned
2476 on, even if the variables aren't referenced.
2478 GCC enables this option by default.  If you want to force the compiler to
2479 check if the variable was referenced, regardless of whether or not
2480 optimization is turned on, use the @samp{-fno-keep-static-consts} option.
2482 @item -fno-function-cse
2483 Do not put function addresses in registers; make each instruction that
2484 calls a constant function contain the function's address explicitly.
2486 This option results in less efficient code, but some strange hacks
2487 that alter the assembler output may be confused by the optimizations
2488 performed when this option is not used.
2490 @item -ffast-math
2491 This option allows GCC to violate some ANSI or IEEE rules and/or
2492 specifications in the interest of optimizing code for speed.  For
2493 example, it allows the compiler to assume arguments to the @code{sqrt}
2494 function are non-negative numbers and that no floating-point values
2495 are NaNs.
2497 This option should never be turned on by any @samp{-O} option since
2498 it can result in incorrect output for programs which depend on
2499 an exact implementation of IEEE or ANSI rules/specifications for
2500 math functions.
2502 @item -fno-math-errno
2503 Do not set ERRNO after calling math functions that are executed
2504 with a single instruction, e.g., sqrt.  A program that relies on
2505 IEEE exceptions for math error handling may want to use this flag
2506 for speed while maintaining IEEE arithmetic compatibility.
2508 The default is @samp{-fmath-errno}.  The @samp{-ffast-math} option
2509 sets @samp{-fno-math-errno}.
2510 @end table
2512 @c following causes underfulls.. they don't look great, but we deal.
2513 @c --mew 26jan93
2514 The following options control specific optimizations.  The @samp{-O2}
2515 option turns on all of these optimizations except @samp{-funroll-loops}
2516 and @samp{-funroll-all-loops}.  On most machines, the @samp{-O} option
2517 turns on the @samp{-fthread-jumps} and @samp{-fdelayed-branch} options,
2518 but specific machines may handle it differently.
2520 You can use the following flags in the rare cases when ``fine-tuning''
2521 of optimizations to be performed is desired.
2523 @table @code
2524 @item -fstrength-reduce
2525 Perform the optimizations of loop strength reduction and
2526 elimination of iteration variables.
2528 @item -fthread-jumps
2529 Perform optimizations where we check to see if a jump branches to a
2530 location where another comparison subsumed by the first is found.  If
2531 so, the first branch is redirected to either the destination of the
2532 second branch or a point immediately following it, depending on whether
2533 the condition is known to be true or false.
2535 @item -fcse-follow-jumps
2536 In common subexpression elimination, scan through jump instructions
2537 when the target of the jump is not reached by any other path.  For
2538 example, when CSE encounters an @code{if} statement with an
2539 @code{else} clause, CSE will follow the jump when the condition
2540 tested is false.
2542 @item -fcse-skip-blocks
2543 This is similar to @samp{-fcse-follow-jumps}, but causes CSE to
2544 follow jumps which conditionally skip over blocks.  When CSE
2545 encounters a simple @code{if} statement with no else clause,
2546 @samp{-fcse-skip-blocks} causes CSE to follow the jump around the
2547 body of the @code{if}.
2549 @item -frerun-cse-after-loop
2550 Re-run common subexpression elimination after loop optimizations has been
2551 performed.
2553 @item -frerun-loop-opt
2554 Run the loop optimizer twice.
2556 @item -fgcse
2557 Perform a global common subexpression elimination pass.
2558 This pass also performs global constant and copy propagation.
2560 @item -fdelete-null-pointer-checks
2561 Use global dataflow analysis to identify and eliminate useless null
2562 pointer checks.  Programs which rely on NULL pointer dereferences @emph{not}
2563 halting the program may not work properly with this option.  Use
2564 -fno-delete-null-pointer-checks to disable this optimizing for programs
2565 which depend on that behavior.
2568 @item -fexpensive-optimizations
2569 Perform a number of minor optimizations that are relatively expensive.
2571 @item -foptimize-register-moves
2572 @itemx -fregmove
2573 Attempt to reassign register numbers in move instructions and as
2574 operands of other simple instructions in order to maximize the amount of
2575 register tying.  This is especially helpful on machines with two-operand
2576 instructions.  GCC enables this optimization by default with @samp{-O2}
2577 or higher.
2579 Note @code{-fregmove} and @code{-foptimize-register-moves} are the same
2580 optimization.
2582 @item -fdelayed-branch
2583 If supported for the target machine, attempt to reorder instructions
2584 to exploit instruction slots available after delayed branch
2585 instructions.
2587 @item -fschedule-insns
2588 If supported for the target machine, attempt to reorder instructions to
2589 eliminate execution stalls due to required data being unavailable.  This
2590 helps machines that have slow floating point or memory load instructions
2591 by allowing other instructions to be issued until the result of the load
2592 or floating point instruction is required.
2594 @item -fschedule-insns2
2595 Similar to @samp{-fschedule-insns}, but requests an additional pass of
2596 instruction scheduling after register allocation has been done.  This is
2597 especially useful on machines with a relatively small number of
2598 registers and where memory load instructions take more than one cycle.
2600 @item -ffunction-sections
2601 @itemx -fdata-sections
2602 Place each function or data item into its own section in the output
2603 file if the target supports arbitrary sections.  The name of the
2604 function or the name of the data item determines the section's name
2605 in the output file.
2607 Use these options on systems where the linker can perform optimizations
2608 to improve locality of reference in the instruction space.  HPPA
2609 processors running HP-UX and Sparc processors running Solaris 2 have
2610 linkers with such optimizations.  Other systems using the ELF object format
2611 as well as AIX may have these optimizations in the future.
2613 Only use these options when there are significant benefits from doing
2614 so.  When you specify these options, the assembler and linker will
2615 create larger object and executable files and will also be slower.
2616 You will not be able to use @code{gprof} on all systems if you
2617 specify this option and you may have problems with debugging if
2618 you specify both this option and @samp{-g}.
2620 @item -fcaller-saves
2621 Enable values to be allocated in registers that will be clobbered by
2622 function calls, by emitting extra instructions to save and restore the
2623 registers around such calls.  Such allocation is done only when it
2624 seems to result in better code than would otherwise be produced.
2626 This option is always enabled by default on certain machines, usually
2627 those which have no call-preserved registers to use instead.
2629 For all machines, optimization level 2 and higher enables this flag by
2630 default.
2632 @item -funroll-loops
2633 Perform the optimization of loop unrolling.  This is only done for loops
2634 whose number of iterations can be determined at compile time or run time.
2635 @samp{-funroll-loops} implies both @samp{-fstrength-reduce} and
2636 @samp{-frerun-cse-after-loop}.
2638 @item -funroll-all-loops
2639 Perform the optimization of loop unrolling.  This is done for all loops
2640 and usually makes programs run more slowly.  @samp{-funroll-all-loops}
2641 implies @samp{-fstrength-reduce} as well as @samp{-frerun-cse-after-loop}.
2643 @item -fmove-all-movables
2644 Forces all invariant computations in loops to be moved
2645 outside the loop.
2647 @item -freduce-all-givs
2648 Forces all general-induction variables in loops to be
2649 strength-reduced.
2651 @emph{Note:} When compiling programs written in Fortran,
2652 @samp{-fmove-all-movables} and @samp{-freduce-all-givs} are enabled
2653 by default when you use the optimizer.
2655 These options may generate better or worse code; results are highly
2656 dependent on the structure of loops within the source code.
2658 These two options are intended to be removed someday, once
2659 they have helped determine the efficacy of various
2660 approaches to improving loop optimizations.
2662 Please let us (@code{gcc@@gcc.gnu.org} and @code{fortran@@gnu.org})
2663 know how use of these options affects
2664 the performance of your production code.
2665 We're very interested in code that runs @emph{slower}
2666 when these options are @emph{enabled}.
2668 @item -fno-peephole
2669 Disable any machine-specific peephole optimizations.
2671 @item -fbranch-probabilities
2672 After running a program compiled with @samp{-fprofile-arcs}
2673 (@pxref{Debugging Options,, Options for Debugging Your Program or
2674 @code{gcc}}), you can compile it a second time using
2675 @samp{-fbranch-probabilities}, to improve optimizations based on
2676 guessing the path a branch might take.
2678 @ifset INTERNALS
2679 With @samp{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
2680 note on the first instruction of each basic block, and a
2681 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
2682 These can be used to improve optimization.  Currently, they are only
2683 used in one place: in @file{reorg.c}, instead of guessing which path a
2684 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
2685 exactly determine which path is taken more often.
2686 @end ifset
2688 @item -fstrict-aliasing
2689 Allows the compiler to assume the strictest aliasing rules applicable to
2690 the language being compiled.  For C (and C++), this activates
2691 optimizations based on the type of expressions.  In particular, an
2692 object of one type is assumed never to reside at the same address as an
2693 object of a different type, unless the types are almost the same.  For
2694 example, an @code{unsigned int} can alias an @code{int}, but not a
2695 @code{void*} or a @code{double}.  A character type may alias any other
2696 type.  
2698 Pay special attention to code like this:
2699 @example
2700 union a_union @{ 
2701   int i;
2702   double d;
2705 int f() @{
2706   a_union t;
2707   t.d = 3.0;
2708   return t.i;
2710 @end example
2711 The practice of reading from a different union member than the one most
2712 recently written to (called ``type-punning'') is common.  Even with
2713 @samp{-fstrict-aliasing}, type-punning is allowed, provided the memory
2714 is accessed through the union type.  So, the code above will work as
2715 expected.  However, this code might not:
2716 @example
2717 int f() @{ 
2718   a_union t;
2719   int* ip;
2720   t.d = 3.0;
2721   ip = &t.i;
2722   return *ip;
2724 @end example
2726 @ifset INTERNALS
2727 Every language that wishes to perform language-specific alias analysis
2728 should define a function that computes, given an @code{tree}
2729 node, an alias set for the node.  Nodes in different alias sets are not
2730 allowed to alias.  For an example, see the C front-end function
2731 @code{c_get_alias_set}.
2732 @end ifset
2734 @item -falign-functions
2735 @itemx -falign-functions=@var{n}
2736 Align the start of functions to the next power-of-two greater than
2737 @var{n}, skipping up to @var{n} bytes.  For instance,
2738 @samp{-falign-functions=32} aligns functions to the next 32-byte
2739 boundary, but @samp{-falign-functions=24} would align to the next
2740 32-byte boundary only if this can be done by skipping 23 bytes or less.
2742 @samp{-fno-align-functions} and @samp{-falign-functions=1} are
2743 equivalent and mean that functions will not be aligned.
2745 Some assemblers only support this flag when @var{n} is a power of two;
2746 in that case, it is rounded up.
2748 If @var{n} is not specified, use a machine-dependent default.
2750 @item -falign-labels
2751 @itemx -falign-labels=@var{n}
2752 Align all branch targets to a power-of-two boundary, skipping up to
2753 @var{n} bytes like @samp{-falign-functions}.  This option can easily
2754 make code slower, because it must insert dummy operations for when the
2755 branch target is reached in the usual flow of the code.
2757 If @samp{-falign-loops} or @samp{-falign-jumps} are applicable and
2758 are greater than this value, then their values are used instead.
2760 If @var{n} is not specified, use a machine-dependent default which is
2761 very likely to be @samp{1}, meaning no alignment.
2763 @item -falign-loops
2764 @itemx -falign-loops=@var{n}
2765 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
2766 like @samp{-falign-functions}.  The hope is that the loop will be
2767 executed many times, which will make up for any execution of the dummy
2768 operations.
2770 If @var{n} is not specified, use a machine-dependent default.
2772 @item -falign-jumps
2773 @itemx -falign-jumps=@var{n}
2774 Align branch targets to a power-of-two boundary, for branch targets
2775 where the targets can only be reached by jumping, skipping up to @var{n}
2776 bytes like @samp{-falign-functions}.  In this case, no dummy operations
2777 need be executed.
2779 If @var{n} is not specified, use a machine-dependent default.
2781 @end table
2783 @node Preprocessor Options
2784 @section Options Controlling the Preprocessor
2785 @cindex preprocessor options
2786 @cindex options, preprocessor
2788 These options control the C preprocessor, which is run on each C source
2789 file before actual compilation.
2791 If you use the @samp{-E} option, nothing is done except preprocessing.
2792 Some of these options make sense only together with @samp{-E} because
2793 they cause the preprocessor output to be unsuitable for actual
2794 compilation.
2796 @table @code
2797 @item -include @var{file}
2798 Process @var{file} as input before processing the regular input file.
2799 In effect, the contents of @var{file} are compiled first.  Any @samp{-D}
2800 and @samp{-U} options on the command line are always processed before
2801 @samp{-include @var{file}}, regardless of the order in which they are
2802 written.  All the @samp{-include} and @samp{-imacros} options are
2803 processed in the order in which they are written.
2805 @item -imacros @var{file}
2806 Process @var{file} as input, discarding the resulting output, before
2807 processing the regular input file.  Because the output generated from
2808 @var{file} is discarded, the only effect of @samp{-imacros @var{file}}
2809 is to make the macros defined in @var{file} available for use in the
2810 main input.
2812 Any @samp{-D} and @samp{-U} options on the command line are always
2813 processed before @samp{-imacros @var{file}}, regardless of the order in
2814 which they are written.  All the @samp{-include} and @samp{-imacros}
2815 options are processed in the order in which they are written.
2817 @item -idirafter @var{dir}
2818 @cindex second include path
2819 Add the directory @var{dir} to the second include path.  The directories
2820 on the second include path are searched when a header file is not found
2821 in any of the directories in the main include path (the one that
2822 @samp{-I} adds to).
2824 @item -iprefix @var{prefix}
2825 Specify @var{prefix} as the prefix for subsequent @samp{-iwithprefix}
2826 options.
2828 @item -iwithprefix @var{dir}
2829 Add a directory to the second include path.  The directory's name is
2830 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
2831 specified previously with @samp{-iprefix}.  If you have not specified a
2832 prefix yet, the directory containing the installed passes of the
2833 compiler is used as the default.
2835 @item -iwithprefixbefore @var{dir}
2836 Add a directory to the main include path.  The directory's name is made
2837 by concatenating @var{prefix} and @var{dir}, as in the case of
2838 @samp{-iwithprefix}.
2840 @item -isystem @var{dir}
2841 Add a directory to the beginning of the second include path, marking it
2842 as a system directory, so that it gets the same special treatment as
2843 is applied to the standard system directories.
2845 @item -nostdinc
2846 Do not search the standard system directories for header files.  Only
2847 the directories you have specified with @samp{-I} options (and the
2848 current directory, if appropriate) are searched.  @xref{Directory
2849 Options}, for information on @samp{-I}.
2851 By using both @samp{-nostdinc} and @samp{-I-}, you can limit the include-file
2852 search path to only those directories you specify explicitly.
2854 @item -undef
2855 Do not predefine any nonstandard macros.  (Including architecture flags).
2857 @item -E
2858 Run only the C preprocessor.  Preprocess all the C source files
2859 specified and output the results to standard output or to the
2860 specified output file.
2862 @item -C
2863 Tell the preprocessor not to discard comments.  Used with the
2864 @samp{-E} option.
2866 @item -P
2867 Tell the preprocessor not to generate @samp{#line} directives.
2868 Used with the @samp{-E} option.
2870 @cindex make
2871 @cindex dependencies, make
2872 @item -M
2873 Tell the preprocessor to output a rule suitable for @code{make}
2874 describing the dependencies of each object file.  For each source file,
2875 the preprocessor outputs one @code{make}-rule whose target is the object
2876 file name for that source file and whose dependencies are all the
2877 @code{#include} header files it uses.  This rule may be a single line or
2878 may be continued with @samp{\}-newline if it is long.  The list of rules
2879 is printed on standard output instead of the preprocessed C program.
2881 @samp{-M} implies @samp{-E}.
2883 Another way to specify output of a @code{make} rule is by setting
2884 the environment variable @code{DEPENDENCIES_OUTPUT} (@pxref{Environment
2885 Variables}).
2887 @item -MM
2888 Like @samp{-M} but the output mentions only the user header files
2889 included with @samp{#include "@var{file}"}.  System header files
2890 included with @samp{#include <@var{file}>} are omitted.
2892 @item -MD
2893 Like @samp{-M} but the dependency information is written to a file made by
2894 replacing ".c" with ".d" at the end of the input file names.
2895 This is in addition to compiling the file as specified---@samp{-MD} does
2896 not inhibit ordinary compilation the way @samp{-M} does.
2898 In Mach, you can use the utility @code{md} to merge multiple dependency
2899 files into a single dependency file suitable for using with the @samp{make}
2900 command.
2902 @item -MMD
2903 Like @samp{-MD} except mention only user header files, not system
2904 header files.
2906 @item -MG
2907 Treat missing header files as generated files and assume they live in the
2908 same directory as the source file.  If you specify @samp{-MG}, you
2909 must also specify either @samp{-M} or @samp{-MM}.  @samp{-MG} is not
2910 supported with @samp{-MD} or @samp{-MMD}.
2912 @item -H
2913 Print the name of each header file used, in addition to other normal
2914 activities.
2916 @item -A@var{question}(@var{answer})
2917 Assert the answer @var{answer} for @var{question}, in case it is tested
2918 with a preprocessing conditional such as @samp{#if
2919 #@var{question}(@var{answer})}.  @samp{-A-} disables the standard
2920 assertions that normally describe the target machine.
2922 @item -D@var{macro}
2923 Define macro @var{macro} with the string @samp{1} as its definition.
2925 @item -D@var{macro}=@var{defn}
2926 Define macro @var{macro} as @var{defn}.  All instances of @samp{-D} on
2927 the command line are processed before any @samp{-U} options.
2929 @item -U@var{macro}
2930 Undefine macro @var{macro}.  @samp{-U} options are evaluated after all
2931 @samp{-D} options, but before any @samp{-include} and @samp{-imacros}
2932 options.
2934 @item -dM
2935 Tell the preprocessor to output only a list of the macro definitions
2936 that are in effect at the end of preprocessing.  Used with the @samp{-E}
2937 option.
2939 @item -dD
2940 Tell the preprocessing to pass all macro definitions into the output, in
2941 their proper sequence in the rest of the output.
2943 @item -dN
2944 Like @samp{-dD} except that the macro arguments and contents are omitted.
2945 Only @samp{#define @var{name}} is included in the output.
2947 @item -trigraphs
2948 Support ANSI C trigraphs.  The @samp{-ansi} option also has this effect.
2950 @item -Wp,@var{option}
2951 Pass @var{option} as an option to the preprocessor.  If @var{option}
2952 contains commas, it is split into multiple options at the commas.
2953 @end table
2955 @node Assembler Options
2956 @section Passing Options to the Assembler
2958 @c prevent bad page break with this line
2959 You can pass options to the assembler.
2961 @table @code
2962 @item -Wa,@var{option}
2963 Pass @var{option} as an option to the assembler.  If @var{option}
2964 contains commas, it is split into multiple options at the commas.
2965 @end table
2967 @node Link Options
2968 @section Options for Linking
2969 @cindex link options
2970 @cindex options, linking
2972 These options come into play when the compiler links object files into
2973 an executable output file.  They are meaningless if the compiler is
2974 not doing a link step.
2976 @table @code
2977 @cindex file names
2978 @item @var{object-file-name}
2979 A file name that does not end in a special recognized suffix is
2980 considered to name an object file or library.  (Object files are
2981 distinguished from libraries by the linker according to the file
2982 contents.)  If linking is done, these object files are used as input
2983 to the linker.
2985 @item -c
2986 @itemx -S
2987 @itemx -E
2988 If any of these options is used, then the linker is not run, and
2989 object file names should not be used as arguments.  @xref{Overall
2990 Options}.
2992 @cindex Libraries
2993 @item -l@var{library}
2994 Search the library named @var{library} when linking.
2996 It makes a difference where in the command you write this option; the
2997 linker searches processes libraries and object files in the order they
2998 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
2999 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
3000 to functions in @samp{z}, those functions may not be loaded.
3002 The linker searches a standard list of directories for the library,
3003 which is actually a file named @file{lib@var{library}.a}.  The linker
3004 then uses this file as if it had been specified precisely by name.
3006 The directories searched include several standard system directories
3007 plus any that you specify with @samp{-L}.
3009 Normally the files found this way are library files---archive files
3010 whose members are object files.  The linker handles an archive file by
3011 scanning through it for members which define symbols that have so far
3012 been referenced but not defined.  But if the file that is found is an
3013 ordinary object file, it is linked in the usual fashion.  The only
3014 difference between using an @samp{-l} option and specifying a file name
3015 is that @samp{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
3016 and searches several directories.
3018 @item -lobjc
3019 You need this special case of the @samp{-l} option in order to
3020 link an Objective C program.
3022 @item -nostartfiles
3023 Do not use the standard system startup files when linking.
3024 The standard system libraries are used normally, unless @code{-nostdlib}
3025 or @code{-nodefaultlibs} is used.
3027 @item -nodefaultlibs
3028 Do not use the standard system libraries when linking.
3029 Only the libraries you specify will be passed to the linker.
3030 The standard startup files are used normally, unless @code{-nostartfiles}
3031 is used.  The compiler may generate calls to memcmp, memset, and memcpy
3032 for System V (and ANSI C) environments or to bcopy and bzero for
3033 BSD environments.  These entries are usually resolved by entries in
3034 libc.  These entry points should be supplied through some other
3035 mechanism when this option is specified.
3037 @item -nostdlib
3038 Do not use the standard system startup files or libraries when linking.
3039 No startup files and only the libraries you specify will be passed to
3040 the linker. The compiler may generate calls to memcmp, memset, and memcpy
3041 for System V (and ANSI C) environments or to bcopy and bzero for
3042 BSD environments.  These entries are usually resolved by entries in
3043 libc.  These entry points should be supplied through some other
3044 mechanism when this option is specified.
3046 @cindex @code{-lgcc}, use with @code{-nostdlib}
3047 @cindex @code{-nostdlib} and unresolved references
3048 @cindex unresolved references and @code{-nostdlib}
3049 @cindex @code{-lgcc}, use with @code{-nodefaultlibs}
3050 @cindex @code{-nodefaultlibs} and unresolved references
3051 @cindex unresolved references and @code{-nodefaultlibs}
3052 One of the standard libraries bypassed by @samp{-nostdlib} and
3053 @samp{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
3054 that GCC uses to overcome shortcomings of particular machines, or special
3055 needs for some languages.
3056 @ifset INTERNALS
3057 (@xref{Interface,,Interfacing to GCC Output}, for more discussion of
3058 @file{libgcc.a}.)
3059 @end ifset
3060 @ifclear INTERNALS
3061 (@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
3062 for more discussion of @file{libgcc.a}.)
3063 @end ifclear
3064 In most cases, you need @file{libgcc.a} even when you want to avoid
3065 other standard libraries.  In other words, when you specify @samp{-nostdlib}
3066 or @samp{-nodefaultlibs} you should usually specify @samp{-lgcc} as well.
3067 This ensures that you have no unresolved references to internal GCC
3068 library subroutines.  (For example, @samp{__main}, used to ensure C++
3069 constructors will be called; @pxref{Collect2,,@code{collect2}}.)
3071 @item -s
3072 Remove all symbol table and relocation information from the executable.
3074 @item -static
3075 On systems that support dynamic linking, this prevents linking with the shared
3076 libraries.  On other systems, this option has no effect.
3078 @item -shared
3079 Produce a shared object which can then be linked with other objects to
3080 form an executable.  Not all systems support this option.  You must
3081 also specify @samp{-fpic} or @samp{-fPIC} on some systems when
3082 you specify this option.
3084 @item -symbolic
3085 Bind references to global symbols when building a shared object.  Warn
3086 about any unresolved references (unless overridden by the link editor
3087 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
3088 this option.
3090 @item -Xlinker @var{option}
3091 Pass @var{option} as an option to the linker.  You can use this to
3092 supply system-specific linker options which GCC does not know how to
3093 recognize.
3095 If you want to pass an option that takes an argument, you must use
3096 @samp{-Xlinker} twice, once for the option and once for the argument.
3097 For example, to pass @samp{-assert definitions}, you must write
3098 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
3099 @samp{-Xlinker "-assert definitions"}, because this passes the entire
3100 string as a single argument, which is not what the linker expects.
3102 @item -Wl,@var{option}
3103 Pass @var{option} as an option to the linker.  If @var{option} contains
3104 commas, it is split into multiple options at the commas.
3106 @item -u @var{symbol}
3107 Pretend the symbol @var{symbol} is undefined, to force linking of
3108 library modules to define it.  You can use @samp{-u} multiple times with
3109 different symbols to force loading of additional library modules.
3110 @end table
3112 @node Directory Options
3113 @section Options for Directory Search
3114 @cindex directory options
3115 @cindex options, directory search
3116 @cindex search path
3118 These options specify directories to search for header files, for
3119 libraries and for parts of the compiler:
3121 @table @code
3122 @item -I@var{dir}
3123 Add the directory @var{dir} to the head of the list of directories to be
3124 searched for header files.  This can be used to override a system header
3125 file, substituting your own version, since these directories are
3126 searched before the system header file directories.  If you use more
3127 than one @samp{-I} option, the directories are scanned in left-to-right
3128 order; the standard system directories come after.
3130 @item -I-
3131 Any directories you specify with @samp{-I} options before the @samp{-I-}
3132 option are searched only for the case of @samp{#include "@var{file}"};
3133 they are not searched for @samp{#include <@var{file}>}.
3135 If additional directories are specified with @samp{-I} options after
3136 the @samp{-I-}, these directories are searched for all @samp{#include}
3137 directives.  (Ordinarily @emph{all} @samp{-I} directories are used
3138 this way.)
3140 In addition, the @samp{-I-} option inhibits the use of the current
3141 directory (where the current input file came from) as the first search
3142 directory for @samp{#include "@var{file}"}.  There is no way to
3143 override this effect of @samp{-I-}.  With @samp{-I.} you can specify
3144 searching the directory which was current when the compiler was
3145 invoked.  That is not exactly the same as what the preprocessor does
3146 by default, but it is often satisfactory.
3148 @samp{-I-} does not inhibit the use of the standard system directories
3149 for header files.  Thus, @samp{-I-} and @samp{-nostdinc} are
3150 independent.
3152 @item -L@var{dir}
3153 Add directory @var{dir} to the list of directories to be searched
3154 for @samp{-l}.
3156 @item -B@var{prefix}
3157 This option specifies where to find the executables, libraries,
3158 include files, and data files of the compiler itself.
3160 The compiler driver program runs one or more of the subprograms
3161 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
3162 @var{prefix} as a prefix for each program it tries to run, both with and
3163 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
3165 For each subprogram to be run, the compiler driver first tries the
3166 @samp{-B} prefix, if any.  If that name is not found, or if @samp{-B}
3167 was not specified, the driver tries two standard prefixes, which are
3168 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
3169 those results in a file name that is found, the unmodified program
3170 name is searched for using the directories specified in your
3171 @samp{PATH} environment variable.
3173 @samp{-B} prefixes that effectively specify directory names also apply
3174 to libraries in the linker, because the compiler translates these
3175 options into @samp{-L} options for the linker.  They also apply to
3176 includes files in the preprocessor, because the compiler translates these
3177 options into @samp{-isystem} options for the preprocessor.  In this case,
3178 the compiler appends @samp{include} to the prefix.
3180 The run-time support file @file{libgcc.a} can also be searched for using
3181 the @samp{-B} prefix, if needed.  If it is not found there, the two
3182 standard prefixes above are tried, and that is all.  The file is left
3183 out of the link if it is not found by those means.
3185 Another way to specify a prefix much like the @samp{-B} prefix is to use
3186 the environment variable @code{GCC_EXEC_PREFIX}.  @xref{Environment
3187 Variables}.
3189 @item -specs=@var{file}
3190 Process @var{file} after the compiler reads in the standard @file{specs}
3191 file, in order to override the defaults that the @file{gcc} driver
3192 program uses when determining what switches to pass to @file{cc1},
3193 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
3194 @samp{-specs=}@var{file} can be specified on the command line, and they
3195 are processed in order, from left to right.
3196 @end table
3198 @node Spec Files
3199 @section Specifying subprocesses and the switches to pass to them
3200 @cindex Spec Files
3201 @code{GCC} is a driver program.  It performs its job by invoking a
3202 sequence of other programs to do the work of compiling, assembling and
3203 linking.  GCC interprets its command-line parameters and uses these to
3204 deduce which programs it should invoke, and which command-line options
3205 it ought to place on their command lines.  This behaviour is controlled
3206 by @dfn{spec strings}.  In most cases there is one spec string for each
3207 program that GCC can invoke, but a few programs have multiple spec
3208 strings to control their behaviour.  The spec strings built into GCC can
3209 be overridden by using the @samp{-specs=} command-line switch to specify
3210 a spec file.
3212 @dfn{Spec files} are plaintext files that are used to construct spec
3213 strings.  They consist of a sequence of directives separated by blank
3214 lines.  The type of directive is determined by the first non-whitespace
3215 character on the line and it can be one of the following:
3217 @table @code
3218 @item %@var{command}
3219 Issues a @var{command} to the spec file processor.  The commands that can
3220 appear here are: 
3222 @table @code
3223 @item %include <@var{file}>
3224 @cindex %include
3225 Search for @var{file} and insert its text at the current point in the
3226 specs file.
3228 @item %include_noerr <@var{file}>
3229 @cindex %include_noerr
3230 Just like @samp{%include}, but do not generate an error message if the include
3231 file cannot be found.
3233 @item %rename @var{old_name} @var{new_name}
3234 @cindex %rename
3235 Rename the spec string @var{old_name} to @var{new_name}.
3237 @end table
3239 @item *[@var{spec_name}]:
3240 This tells the compiler to create, override or delete the named spec
3241 string.  All lines after this directive up to the next directive or
3242 blank line are considered to be the text for the spec string.  If this
3243 results in an empty string then the spec will be deleted.  (Or, if the
3244 spec did not exist, then nothing will happened.)  Otherwise, if the spec
3245 does not currently exist a new spec will be created.  If the spec does
3246 exist then its contents will be overridden by the text of this
3247 directive, unless the first character of that text is the @samp{+}
3248 character, in which case the text will be appended to the spec.
3250 @item [@var{suffix}]:
3251 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
3252 and up to the next directive or blank line are considered to make up the
3253 spec string for the indicated suffix.  When the compiler encounters an 
3254 input file with the named suffix, it will processes the spec string in
3255 order to work out how to compile that file.  For example:
3257 @smallexample
3258 .ZZ:
3259 z-compile -input %i
3260 @end smallexample
3262 This says that any input file whose name ends in @samp{.ZZ} should be
3263 passed to the program @samp{z-compile}, which should be invoked with the
3264 command-line switch @samp{-input} and with the result of performing the
3265 @samp{%i} substitution.  (See below.)
3267 As an alternative to providing a spec string, the text that follows a
3268 suffix directive can be one of the following:
3270 @table @code
3271 @item @@@var{language}
3272 This says that the suffix is an alias for a known @var{language}.  This is
3273 similar to using the @code{-x} command-line switch to GCC to specify a
3274 language explicitly.  For example:
3276 @smallexample
3277 .ZZ:
3278 @@c++
3279 @end smallexample
3281 Says that .ZZ files are, in fact, C++ source files.
3283 @item #@var{name}
3284 This causes an error messages saying:
3286 @smallexample
3287 @var{name} compiler not installed on this system.
3288 @end smallexample
3289 @end table
3291 GCC already has an extensive list of suffixes built into it.
3292 This directive will add an entry to the end of the list of suffixes, but
3293 since the list is searched from the end backwards, it is effectively
3294 possible to override earlier entries using this technique.
3296 @end table
3298 GCC has the following spec strings built into it.  Spec files can
3299 override these strings or create their own.  Note that individual
3300 targets can also add their own spec strings to this list. 
3302 @smallexample
3303 asm          Options to pass to the assembler
3304 asm_final    Options to pass to the assembler post-processor
3305 cpp          Options to pass to the C preprocessor
3306 cc1          Options to pass to the C compiler
3307 cc1plus      Options to pass to the C++ compiler
3308 endfile      Object files to include at the end of the link
3309 link         Options to pass to the linker
3310 lib          Libraries to include on the command line to the linker
3311 libgcc       Decides which GCC support library to pass to the linker
3312 linker       Sets the name of the linker
3313 predefines   Defines to be passed to the C preprocessor
3314 signed_char  Defines to pass to CPP to say whether @code{char} is signed by default
3315 startfile    Object files to include at the start of the link
3316 @end smallexample
3318 Here is a small example of a spec file:
3320 @smallexample
3321 %rename lib                 old_lib
3323 *lib:
3324 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
3325 @end smallexample
3327 This example renames the spec called @samp{lib} to @samp{old_lib} and
3328 then overrides the previous definition of @samp{lib} with a new one.
3329 The new definition adds in some extra command-line options before
3330 including the text of the old definition.
3332 @dfn{Spec strings} are a list of command-line options to be passed to their
3333 corresponding program.  In addition, the spec strings can contain
3334 @samp{%}-prefixed sequences to substitute variable text or to
3335 conditionally insert text into the command line.  Using these constructs
3336 it is possible to generate quite complex command lines.
3338 Here is a table of all defined @samp{%}-sequences for spec
3339 strings.  Note that spaces are not generated automatically around the
3340 results of expanding these sequences.  Therefore you can concatenate them
3341 together or combine them with constant text in a single argument. 
3343 @table @code
3344 @item %%
3345 Substitute one @samp{%} into the program name or argument.
3347 @item %i
3348 Substitute the name of the input file being processed.
3350 @item %b
3351 Substitute the basename of the input file being processed.
3352 This is the substring up to (and not including) the last period
3353 and not including the directory.
3355 @item %d
3356 Marks the argument containing or following the @samp{%d} as a
3357 temporary file name, so that that file will be deleted if GCC exits
3358 successfully.  Unlike @samp{%g}, this contributes no text to the
3359 argument. 
3361 @item %g@var{suffix}
3362 Substitute a file name that has suffix @var{suffix} and is chosen
3363 once per compilation, and mark the argument in the same way as
3364 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
3365 name is now chosen in a way that is hard to predict even when previously 
3366 chosen file names are known.  For example, @samp{%g.s ... %g.o ... %g.s}
3367 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
3368 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
3369 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
3370 was simply substituted with a file name chosen once per compilation,
3371 without regard to any appended suffix (which was therefore treated
3372 just like ordinary text), making such attacks more likely to succeed.
3374 @item %u@var{suffix}
3375 Like @samp{%g}, but generates a new temporary file name even if
3376 @samp{%u@var{suffix}} was already seen.
3378 @item %U@var{suffix}
3379 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
3380 new one if there is no such last file name.  In the absence of any
3381 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
3382 the same suffix @emph{space}, so @samp{%g.s ... %U.s ... %g.s ... %U.s}
3383 would involve the generation of two distinct file names, one
3384 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
3385 simply substituted with a file name chosen for the previous @samp{%u},
3386 without regard to any appended suffix.
3388 @item %w
3389 Marks the argument containing or following the @samp{%w} as the
3390 designated output file of this compilation.  This puts the argument
3391 into the sequence of arguments that @samp{%o} will substitute later.
3393 @item %o
3394 Substitutes the names of all the output files, with spaces
3395 automatically placed around them.  You should write spaces
3396 around the @samp{%o} as well or the results are undefined.
3397 @samp{%o} is for use in the specs for running the linker.
3398 Input files whose names have no recognized suffix are not compiled
3399 at all, but they are included among the output files, so they will
3400 be linked.
3402 @item %O
3403 Substitutes the suffix for object files.  Note that this is
3404 handled specially when it immediately follows @samp{%g, %u, or %U},
3405 because of the need for those to form complete file names.  The
3406 handling is such that @samp{%O} is treated exactly as if it had already
3407 been substituted, except that @samp{%g, %u, and %U} do not currently
3408 support additional @var{suffix} characters following @samp{%O} as they would
3409 following, for example, @samp{.o}.
3411 @item %p
3412 Substitutes the standard macro predefinitions for the
3413 current target machine.  Use this when running @code{cpp}.
3415 @item %P
3416 Like @samp{%p}, but puts @samp{__} before and after the name of each
3417 predefined macro, except for macros that start with @samp{__} or with
3418 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ANSI
3419 C.  
3421 @item %I
3422 Substitute a @samp{-iprefix} option made from GCC_EXEC_PREFIX.
3424 @item %s
3425 Current argument is the name of a library or startup file of some sort.
3426 Search for that file in a standard list of directories and substitute
3427 the full name found. 
3429 @item %e@var{str}
3430 Print @var{str} as an error message.  @var{str} is terminated by a newline.
3431 Use this when inconsistent options are detected.
3433 @item %|
3434 Output @samp{-} if the input for the current command is coming from a pipe.
3436 @item %(@var{name})
3437 Substitute the contents of spec string @var{name} at this point.
3439 @item %[@var{name}]
3440 Like @samp{%(...)} but put @samp{__} around @samp{-D} arguments.
3442 @item %x@{@var{option}@}
3443 Accumulate an option for @samp{%X}.
3445 @item %X
3446 Output the accumulated linker options specified by @samp{-Wl} or a @samp{%x}
3447 spec string.
3449 @item %Y
3450 Output the accumulated assembler options specified by @samp{-Wa}.
3452 @item %Z
3453 Output the accumulated preprocessor options specified by @samp{-Wp}.
3455 @item %v1
3456 Substitute the major version number of GCC.
3457 (For version 2.9.5, this is 2.)
3459 @item %v2
3460 Substitute the minor version number of GCC.
3461 (For version 2.9.5, this is 9.)
3463 @item %a
3464 Process the @code{asm} spec.  This is used to compute the
3465 switches to be passed to the assembler.
3467 @item %A
3468 Process the @code{asm_final} spec.  This is a spec string for
3469 passing switches to an assembler post-processor, if such a program is
3470 needed.
3472 @item %l
3473 Process the @code{link} spec.  This is the spec for computing the
3474 command line passed to the linker.  Typically it will make use of the
3475 @samp{%L %G %S %D and %E} sequences.
3477 @item %D
3478 Dump out a @samp{-L} option for each directory that GCC believes might
3479 contain startup files.  If the target supports multilibs then the
3480 current multilib directory will be prepended to each of these paths. 
3482 @item %L
3483 Process the @code{lib} spec.  This is a spec string for deciding which
3484 libraries should be included on the command line to the linker. 
3486 @item %G
3487 Process the @code{libgcc} spec.  This is a spec string for deciding
3488 which GCC support library should be included on the command line to the linker. 
3490 @item %S
3491 Process the @code{startfile} spec.  This is a spec for deciding which
3492 object files should be the first ones passed to the linker.  Typically
3493 this might be a file named @file{crt0.o}. 
3495 @item %E
3496 Process the @code{endfile} spec.  This is a spec string that specifies
3497 the last object files that will be passed to the linker.  
3499 @item %C
3500 Process the @code{cpp} spec.  This is used to construct the arguments
3501 to be passed to the C preprocessor.
3503 @item %c
3504 Process the @code{signed_char} spec.  This is intended to be used
3505 to tell cpp whether a char is signed.  It typically has the definition: 
3506 @smallexample
3507 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
3508 @end smallexample
3510 @item %1
3511 Process the @code{cc1} spec.  This is used to construct the options to be
3512 passed to the actual C compiler (@samp{cc1}).
3514 @item %2
3515 Process the @code{cc1plus} spec.  This is used to construct the options to be
3516 passed to the actual C++ compiler (@samp{cc1plus}).
3518 @item %*
3519 Substitute the variable part of a matched option.  See below.
3520 Note that each comma in the substituted string is replaced by
3521 a single space.
3523 @item %@{@code{S}@}
3524 Substitutes the @code{-S} switch, if that switch was given to GCC.
3525 If that switch was not specified, this substitutes nothing.  Note that
3526 the leading dash is omitted when specifying this option, and it is
3527 automatically inserted if the substitution is performed.  Thus the spec
3528 string @samp{%@{foo@}} would match the command-line option @samp{-foo}
3529 and would output the command line option @samp{-foo}.
3531 @item %W@{@code{S}@}
3532 Like %@{@code{S}@} but mark last argument supplied within as a file to be
3533 deleted on failure. 
3535 @item %@{@code{S}*@}
3536 Substitutes all the switches specified to GCC whose names start
3537 with @code{-S}, but which also take an argument.  This is used for
3538 switches like @samp{-o, -D, -I}, etc.  GCC considers @samp{-o foo} as being
3539 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
3540 text, including the space.  Thus two arguments would be generated. 
3542 @item %@{^@code{S}*@}
3543 Like %@{@code{S}*@}, but don't put a blank between a switch and its
3544 argument.  Thus %@{^o*@} would only generate one argument, not two.
3546 @item %@{@code{S}*:@code{X}@}
3547 Substitutes @code{X} if one or more switches whose names start with
3548 @code{-S} are specified to GCC.  Note that the tail part of the
3549 @code{-S} option (i.e. the part matched by the @samp{*}) will be substituted
3550 for each occurrence of @samp{%*} within @code{X}. 
3552 @item %@{@code{S}:@code{X}@}
3553 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC.
3555 @item %@{!@code{S}:@code{X}@}
3556 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC.
3558 @item %@{|@code{S}:@code{X}@}
3559 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
3561 @item %@{|!@code{S}:@code{X}@}
3562 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
3564 @item %@{.@code{S}:@code{X}@}
3565 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
3567 @item %@{!.@code{S}:@code{X}@}
3568 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
3570 @item %@{@code{S}|@code{P}:@code{X}@}
3571 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC.  This may be
3572 combined with @samp{!} and @samp{.} sequences as well, although they
3573 have a stronger binding than the @samp{|}.  For example a spec string
3574 like this:
3576 @smallexample
3577 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
3578 @end smallexample
3580 will output the following command-line options from the following input
3581 command-line options:
3583 @smallexample
3584 fred.c        -foo -baz
3585 jim.d         -bar -boggle
3586 -d fred.c     -foo -baz -boggle
3587 -d jim.d      -bar -baz -boggle
3588 @end smallexample
3590 @end table
3592 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
3593 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
3594 or spaces, or even newlines.  They are processed as usual, as described
3595 above. 
3597 The @samp{-O, -f, -m, and -W} switches are handled specifically in these
3598 constructs.  If another value of @samp{-O} or the negated form of a @samp{-f, -m, or
3599 -W} switch is found later in the command line, the earlier switch
3600 value is ignored, except with @{@code{S}*@} where @code{S} is just one
3601 letter, which passes all matching options.
3603 The character @samp{|} at the beginning of the predicate text is used to indicate
3604 that a command should be piped to the following command, but only if @samp{-pipe}
3605 is specified.
3607 It is built into GCC which switches take arguments and which do not.
3608 (You might think it would be useful to generalize this to allow each
3609 compiler's spec to say which switches take arguments.  But this cannot
3610 be done in a consistent fashion.  GCC cannot even decide which input
3611 files have been specified without knowing which switches take arguments,
3612 and it must know which input files to compile in order to tell which
3613 compilers to run). 
3615 GCC also knows implicitly that arguments starting in @samp{-l} are to be
3616 treated as compiler output files, and passed to the linker in their
3617 proper position among the other output files.
3619 @node Target Options
3620 @section Specifying Target Machine and Compiler Version
3621 @cindex target options
3622 @cindex cross compiling
3623 @cindex specifying machine version
3624 @cindex specifying compiler version and target machine
3625 @cindex compiler version, specifying
3626 @cindex target machine, specifying
3628 By default, GCC compiles code for the same type of machine that you
3629 are using.  However, it can also be installed as a cross-compiler, to
3630 compile for some other type of machine.  In fact, several different
3631 configurations of GCC, for different target machines, can be
3632 installed side by side.  Then you specify which one to use with the
3633 @samp{-b} option.
3635 In addition, older and newer versions of GCC can be installed side
3636 by side.  One of them (probably the newest) will be the default, but
3637 you may sometimes wish to use another.
3639 @table @code
3640 @item -b @var{machine}
3641 The argument @var{machine} specifies the target machine for compilation.
3642 This is useful when you have installed GCC as a cross-compiler.
3644 The value to use for @var{machine} is the same as was specified as the
3645 machine type when configuring GCC as a cross-compiler.  For
3646 example, if a cross-compiler was configured with @samp{configure
3647 i386v}, meaning to compile for an 80386 running System V, then you
3648 would specify @samp{-b i386v} to run that cross compiler.
3650 When you do not specify @samp{-b}, it normally means to compile for
3651 the same type of machine that you are using.
3653 @item -V @var{version}
3654 The argument @var{version} specifies which version of GCC to run.
3655 This is useful when multiple versions are installed.  For example,
3656 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
3658 The default version, when you do not specify @samp{-V}, is the last
3659 version of GCC that you installed.
3660 @end table
3662 The @samp{-b} and @samp{-V} options actually work by controlling part of
3663 the file name used for the executable files and libraries used for
3664 compilation.  A given version of GCC, for a given target machine, is
3665 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.@refill
3667 Thus, sites can customize the effect of @samp{-b} or @samp{-V} either by
3668 changing the names of these directories or adding alternate names (or
3669 symbolic links).  If in directory @file{/usr/local/lib/gcc-lib/} the
3670 file @file{80386} is a link to the file @file{i386v}, then @samp{-b
3671 80386} becomes an alias for @samp{-b i386v}.
3673 In one respect, the @samp{-b} or @samp{-V} do not completely change
3674 to a different compiler: the top-level driver program @code{gcc}
3675 that you originally invoked continues to run and invoke the other
3676 executables (preprocessor, compiler per se, assembler and linker)
3677 that do the real work.  However, since no real work is done in the
3678 driver program, it usually does not matter that the driver program
3679 in use is not the one for the specified target and version.
3681 The only way that the driver program depends on the target machine is
3682 in the parsing and handling of special machine-specific options.
3683 However, this is controlled by a file which is found, along with the
3684 other executables, in the directory for the specified version and
3685 target machine.  As a result, a single installed driver program adapts
3686 to any specified target machine and compiler version.
3688 The driver program executable does control one significant thing,
3689 however: the default version and target machine.  Therefore, you can
3690 install different instances of the driver program, compiled for
3691 different targets or versions, under different names.
3693 For example, if the driver for version 2.0 is installed as @code{ogcc}
3694 and that for version 2.1 is installed as @code{gcc}, then the command
3695 @code{gcc} will use version 2.1 by default, while @code{ogcc} will use
3696 2.0 by default.  However, you can choose either version with either
3697 command with the @samp{-V} option.
3699 @node Submodel Options
3700 @section Hardware Models and Configurations
3701 @cindex submodel options
3702 @cindex specifying hardware config
3703 @cindex hardware models and configurations, specifying
3704 @cindex machine dependent options
3706 Earlier we discussed the standard option @samp{-b} which chooses among
3707 different installed compilers for completely different target
3708 machines, such as Vax vs. 68000 vs. 80386.
3710 In addition, each of these target machine types can have its own
3711 special options, starting with @samp{-m}, to choose among various
3712 hardware models or configurations---for example, 68010 vs 68020,
3713 floating coprocessor or none.  A single installed version of the
3714 compiler can compile for any model or configuration, according to the
3715 options specified.
3717 Some configurations of the compiler also support additional special
3718 options, usually for compatibility with other compilers on the same
3719 platform.
3721 @ifset INTERNALS
3722 These options are defined by the macro @code{TARGET_SWITCHES} in the
3723 machine description.  The default for the options is also defined by
3724 that macro, which enables you to change the defaults.
3725 @end ifset
3727 @menu
3728 * M680x0 Options::
3729 * VAX Options::
3730 * SPARC Options::
3731 * Convex Options::
3732 * AMD29K Options::
3733 * ARM Options::
3734 * Thumb Options::
3735 * MN10200 Options::
3736 * MN10300 Options::
3737 * M32R/D Options::
3738 * M88K Options::
3739 * RS/6000 and PowerPC Options::
3740 * RT Options::
3741 * MIPS Options::
3742 * i386 Options::
3743 * HPPA Options::
3744 * Intel 960 Options::
3745 * DEC Alpha Options::
3746 * Clipper Options::
3747 * H8/300 Options::
3748 * SH Options::
3749 * System V Options::
3750 * TMS320C3x/C4x Options::
3751 * V850 Options::
3752 * ARC Options::
3753 * NS32K Options::
3754 @end menu
3756 @node M680x0 Options
3757 @subsection M680x0 Options
3758 @cindex M680x0 options
3760 These are the @samp{-m} options defined for the 68000 series.  The default
3761 values for these options depends on which style of 68000 was selected when
3762 the compiler was configured; the defaults for the most common choices are
3763 given below.
3765 @table @code
3766 @item -m68000
3767 @itemx -mc68000
3768 Generate output for a 68000.  This is the default
3769 when the compiler is configured for 68000-based systems.
3771 Use this option for microcontrollers with a 68000 or EC000 core,
3772 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
3774 @item -m68020
3775 @itemx -mc68020
3776 Generate output for a 68020.  This is the default
3777 when the compiler is configured for 68020-based systems.
3779 @item -m68881
3780 Generate output containing 68881 instructions for floating point.
3781 This is the default for most 68020 systems unless @samp{-nfp} was
3782 specified when the compiler was configured.
3784 @item -m68030
3785 Generate output for a 68030.  This is the default when the compiler is
3786 configured for 68030-based systems.
3788 @item -m68040
3789 Generate output for a 68040.  This is the default when the compiler is
3790 configured for 68040-based systems.
3792 This option inhibits the use of 68881/68882 instructions that have to be
3793 emulated by software on the 68040.  Use this option if your 68040 does not
3794 have code to emulate those instructions.
3796 @item -m68060
3797 Generate output for a 68060.  This is the default when the compiler is
3798 configured for 68060-based systems.
3800 This option inhibits the use of 68020 and 68881/68882 instructions that
3801 have to be emulated by software on the 68060.  Use this option if your 68060
3802 does not have code to emulate those instructions.
3804 @item -mcpu32
3805 Generate output for a CPU32. This is the default
3806 when the compiler is configured for CPU32-based systems.
3808 Use this option for microcontrollers with a
3809 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
3810 68336, 68340, 68341, 68349 and 68360.
3812 @item -m5200
3813 Generate output for a 520X "coldfire" family cpu.  This is the default
3814 when the compiler is configured for 520X-based systems.
3816 Use this option for microcontroller with a 5200 core, including 
3817 the MCF5202, MCF5203, MCF5204 and MCF5202.
3820 @item -m68020-40
3821 Generate output for a 68040, without using any of the new instructions.
3822 This results in code which can run relatively efficiently on either a
3823 68020/68881 or a 68030 or a 68040.  The generated code does use the
3824 68881 instructions that are emulated on the 68040.
3826 @item -m68020-60
3827 Generate output for a 68060, without using any of the new instructions.
3828 This results in code which can run relatively efficiently on either a
3829 68020/68881 or a 68030 or a 68040.  The generated code does use the
3830 68881 instructions that are emulated on the 68060.
3832 @item -mfpa
3833 Generate output containing Sun FPA instructions for floating point.
3835 @item -msoft-float
3836 Generate output containing library calls for floating point.
3837 @strong{Warning:} the requisite libraries are not available for all m68k
3838 targets.  Normally the facilities of the machine's usual C compiler are
3839 used, but this can't be done directly in cross-compilation.  You must
3840 make your own arrangements to provide suitable library functions for
3841 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
3842 @samp{m68k-*-coff} do provide software floating point support.
3844 @item -mshort
3845 Consider type @code{int} to be 16 bits wide, like @code{short int}.
3847 @item -mnobitfield
3848 Do not use the bit-field instructions.  The @samp{-m68000}, @samp{-mcpu32}
3849 and @samp{-m5200} options imply @w{@samp{-mnobitfield}}.
3851 @item -mbitfield
3852 Do use the bit-field instructions.  The @samp{-m68020} option implies
3853 @samp{-mbitfield}.  This is the default if you use a configuration
3854 designed for a 68020.
3856 @item -mrtd
3857 Use a different function-calling convention, in which functions
3858 that take a fixed number of arguments return with the @code{rtd}
3859 instruction, which pops their arguments while returning.  This
3860 saves one instruction in the caller since there is no need to pop
3861 the arguments there.
3863 This calling convention is incompatible with the one normally
3864 used on Unix, so you cannot use it if you need to call libraries
3865 compiled with the Unix compiler.
3867 Also, you must provide function prototypes for all functions that
3868 take variable numbers of arguments (including @code{printf});
3869 otherwise incorrect code will be generated for calls to those
3870 functions.
3872 In addition, seriously incorrect code will result if you call a
3873 function with too many arguments.  (Normally, extra arguments are
3874 harmlessly ignored.)
3876 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
3877 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
3879 @item -malign-int
3880 @itemx -mno-align-int
3881 Control whether GCC aligns @code{int}, @code{long}, @code{long long}, 
3882 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
3883 boundary (@samp{-malign-int}) or a 16-bit boundary (@samp{-mno-align-int}).
3884 Aligning variables on 32-bit boundaries produces code that runs somewhat
3885 faster on processors with 32-bit busses at the expense of more memory.
3887 @strong{Warning:} if you use the @samp{-malign-int} switch, GCC will
3888 align structures containing the above types  differently than
3889 most published application binary interface specifications for the m68k.
3891 @item -mpcrel
3892 Use the pc-relative addressing mode of the 68000 directly, instead of
3893 using a global offset table.  At present, this option implies -fpic,
3894 allowing at most a 16-bit offset for pc-relative addressing.  -fPIC is
3895 not presently supported with -mpcrel, though this could be supported for
3896 68020 and higher processors.
3898 @item -mno-strict-align
3899 @itemx -mstrict-align
3900 @kindex -mstrict-align
3901 Do not (do) assume that unaligned memory references will be handled by
3902 the system.
3904 @end table
3906 @node VAX Options
3907 @subsection VAX Options
3908 @cindex VAX options
3910 These @samp{-m} options are defined for the Vax:
3912 @table @code
3913 @item -munix
3914 Do not output certain jump instructions (@code{aobleq} and so on)
3915 that the Unix assembler for the Vax cannot handle across long
3916 ranges.
3918 @item -mgnu
3919 Do output those jump instructions, on the assumption that you
3920 will assemble with the GNU assembler.
3922 @item -mg
3923 Output code for g-format floating point numbers instead of d-format.
3924 @end table
3926 @node SPARC Options
3927 @subsection SPARC Options
3928 @cindex SPARC options
3930 These @samp{-m} switches are supported on the SPARC:
3932 @table @code
3933 @item -mno-app-regs
3934 @itemx -mapp-regs
3935 Specify @samp{-mapp-regs} to generate output using the global registers
3936 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
3937 is the default.
3939 To be fully SVR4 ABI compliant at the cost of some performance loss,
3940 specify @samp{-mno-app-regs}.  You should compile libraries and system
3941 software with this option.
3943 @item -mfpu
3944 @itemx -mhard-float
3945 Generate output containing floating point instructions.  This is the
3946 default.
3948 @item -mno-fpu
3949 @itemx -msoft-float
3950 Generate output containing library calls for floating point.
3951 @strong{Warning:} the requisite libraries are not available for all SPARC
3952 targets.  Normally the facilities of the machine's usual C compiler are
3953 used, but this cannot be done directly in cross-compilation.  You must make
3954 your own arrangements to provide suitable library functions for
3955 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
3956 @samp{sparclite-*-*} do provide software floating point support.
3958 @samp{-msoft-float} changes the calling convention in the output file;
3959 therefore, it is only useful if you compile @emph{all} of a program with
3960 this option.  In particular, you need to compile @file{libgcc.a}, the
3961 library that comes with GCC, with @samp{-msoft-float} in order for
3962 this to work.
3964 @item -mhard-quad-float
3965 Generate output containing quad-word (long double) floating point
3966 instructions.
3968 @item -msoft-quad-float
3969 Generate output containing library calls for quad-word (long double)
3970 floating point instructions.  The functions called are those specified
3971 in the SPARC ABI.  This is the default.
3973 As of this writing, there are no sparc implementations that have hardware
3974 support for the quad-word floating point instructions.  They all invoke
3975 a trap handler for one of these instructions, and then the trap handler
3976 emulates the effect of the instruction.  Because of the trap handler overhead,
3977 this is much slower than calling the ABI library routines.  Thus the
3978 @samp{-msoft-quad-float} option is the default.
3980 @item -mno-epilogue
3981 @itemx -mepilogue
3982 With @samp{-mepilogue} (the default), the compiler always emits code for
3983 function exit at the end of each function.  Any function exit in
3984 the middle of the function (such as a return statement in C) will
3985 generate a jump to the exit code at the end of the function.
3987 With @samp{-mno-epilogue}, the compiler tries to emit exit code inline
3988 at every function exit.
3990 @item -mno-flat
3991 @itemx -mflat
3992 With @samp{-mflat}, the compiler does not generate save/restore instructions
3993 and will use a "flat" or single register window calling convention.
3994 This model uses %i7 as the frame pointer and is compatible with the normal
3995 register window model.  Code from either may be intermixed.
3996 The local registers and the input registers (0-5) are still treated as
3997 "call saved" registers and will be saved on the stack as necessary.
3999 With @samp{-mno-flat} (the default), the compiler emits save/restore
4000 instructions (except for leaf functions) and is the normal mode of operation.
4002 @item -mno-unaligned-doubles
4003 @itemx -munaligned-doubles
4004 Assume that doubles have 8 byte alignment.  This is the default.
4006 With @samp{-munaligned-doubles}, GCC assumes that doubles have 8 byte
4007 alignment only if they are contained in another type, or if they have an
4008 absolute address.  Otherwise, it assumes they have 4 byte alignment.
4009 Specifying this option avoids some rare compatibility problems with code
4010 generated by other compilers.  It is not the default because it results
4011 in a performance loss, especially for floating point code.
4013 @item -mno-faster-structs
4014 @itemx -mfaster-structs
4015 With @samp{-mfaster-structs}, the compiler assumes that structures
4016 should have 8 byte alignment.  This enables the use of pairs of
4017 @code{ldd} and @code{std} instructions for copies in structure
4018 assignment, in place of twice as many @code{ld} and @code{st} pairs.
4019 However, the use of this changed alignment directly violates the Sparc
4020 ABI.  Thus, it's intended only for use on targets where the developer
4021 acknowledges that their resulting code will not be directly in line with
4022 the rules of the ABI.
4024 @item -mv8
4025 @itemx -msparclite
4026 These two options select variations on the SPARC architecture.
4028 By default (unless specifically configured for the Fujitsu SPARClite),
4029 GCC generates code for the v7 variant of the SPARC architecture.
4031 @samp{-mv8} will give you SPARC v8 code.  The only difference from v7
4032 code is that the compiler emits the integer multiply and integer
4033 divide instructions which exist in SPARC v8 but not in SPARC v7.
4035 @samp{-msparclite} will give you SPARClite code.  This adds the integer
4036 multiply, integer divide step and scan (@code{ffs}) instructions which
4037 exist in SPARClite but not in SPARC v7.
4039 These options are deprecated and will be deleted in a future GCC release.
4040 They have been replaced with @samp{-mcpu=xxx}.
4042 @item -mcypress
4043 @itemx -msupersparc
4044 These two options select the processor for which the code is optimised.
4046 With @samp{-mcypress} (the default), the compiler optimizes code for the
4047 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
4048 This is also appropriate for the older SparcStation 1, 2, IPX etc.
4050 With @samp{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
4051 used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
4052 of the full SPARC v8 instruction set.
4054 These options are deprecated and will be deleted in a future GCC release.
4055 They have been replaced with @samp{-mcpu=xxx}.
4057 @item -mcpu=@var{cpu_type}
4058 Set the instruction set, register set, and instruction scheduling parameters
4059 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
4060 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
4061 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
4062 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
4064 Default instruction scheduling parameters are used for values that select
4065 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
4066 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
4068 Here is a list of each supported architecture and their supported
4069 implementations.
4071 @smallexample
4072     v7:             cypress
4073     v8:             supersparc, hypersparc
4074     sparclite:      f930, f934, sparclite86x
4075     sparclet:       tsc701
4076     v9:             ultrasparc
4077 @end smallexample
4079 @item -mtune=@var{cpu_type}
4080 Set the instruction scheduling parameters for machine type
4081 @var{cpu_type}, but do not set the instruction set or register set that the
4082 option @samp{-mcpu=}@var{cpu_type} would.
4084 The same values for @samp{-mcpu=}@var{cpu_type} are used for
4085 @samp{-mtune=}@*@var{cpu_type}, though the only useful values are those that
4086 select a particular cpu implementation: @samp{cypress}, @samp{supersparc},
4087 @samp{hypersparc}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
4088 @samp{tsc701}, @samp{ultrasparc}.
4090 @end table
4092 These @samp{-m} switches are supported in addition to the above
4093 on the SPARCLET processor.
4095 @table @code
4096 @item -mlittle-endian
4097 Generate code for a processor running in little-endian mode.
4099 @item -mlive-g0
4100 Treat register @code{%g0} as a normal register.
4101 GCC will continue to clobber it as necessary but will not assume
4102 it always reads as 0.
4104 @item -mbroken-saverestore
4105 Generate code that does not use non-trivial forms of the @code{save} and
4106 @code{restore} instructions.  Early versions of the SPARCLET processor do
4107 not correctly handle @code{save} and @code{restore} instructions used with
4108 arguments.  They correctly handle them used without arguments.  A @code{save}
4109 instruction used without arguments increments the current window pointer
4110 but does not allocate a new stack frame.  It is assumed that the window
4111 overflow trap handler will properly handle this case as will interrupt
4112 handlers.
4113 @end table
4115 These @samp{-m} switches are supported in addition to the above
4116 on SPARC V9 processors in 64 bit environments.
4118 @table @code
4119 @item -mlittle-endian
4120 Generate code for a processor running in little-endian mode.
4122 @item -m32
4123 @itemx -m64
4124 Generate code for a 32 bit or 64 bit environment.
4125 The 32 bit environment sets int, long and pointer to 32 bits.
4126 The 64 bit environment sets int to 32 bits and long and pointer
4127 to 64 bits.
4129 @item -mcmodel=medlow
4130 Generate code for the Medium/Low code model: the program must be linked
4131 in the low 32 bits of the address space.  Pointers are 64 bits.
4132 Programs can be statically or dynamically linked.
4134 @item -mcmodel=medmid
4135 Generate code for the Medium/Middle code model: the program must be linked
4136 in the low 44 bits of the address space, the text segment must be less than
4137 2G bytes, and data segment must be within 2G of the text segment.
4138 Pointers are 64 bits.
4140 @item -mcmodel=medany
4141 Generate code for the Medium/Anywhere code model: the program may be linked
4142 anywhere in the address space, the text segment must be less than
4143 2G bytes, and data segment must be within 2G of the text segment.
4144 Pointers are 64 bits.
4146 @item -mcmodel=embmedany
4147 Generate code for the Medium/Anywhere code model for embedded systems:
4148 assume a 32 bit text and a 32 bit data segment, both starting anywhere
4149 (determined at link time).  Register %g4 points to the base of the
4150 data segment.  Pointers still 64 bits.
4151 Programs are statically linked, PIC is not supported.
4153 @item -mstack-bias
4154 @itemx -mno-stack-bias
4155 With @samp{-mstack-bias}, GCC assumes that the stack pointer, and
4156 frame pointer if present, are offset by -2047 which must be added back
4157 when making stack frame references.
4158 Otherwise, assume no such offset is present.
4159 @end table
4161 @node Convex Options
4162 @subsection Convex Options
4163 @cindex Convex options
4165 These @samp{-m} options are defined for Convex:
4167 @table @code
4168 @item -mc1
4169 Generate output for C1.  The code will run on any Convex machine.
4170 The preprocessor symbol @code{__convex__c1__} is defined.
4172 @item -mc2
4173 Generate output for C2.  Uses instructions not available on C1.
4174 Scheduling and other optimizations are chosen for max performance on C2.
4175 The preprocessor symbol @code{__convex_c2__} is defined.
4177 @item -mc32
4178 Generate output for C32xx.  Uses instructions not available on C1.
4179 Scheduling and other optimizations are chosen for max performance on C32.
4180 The preprocessor symbol @code{__convex_c32__} is defined.
4182 @item -mc34
4183 Generate output for C34xx.  Uses instructions not available on C1.
4184 Scheduling and other optimizations are chosen for max performance on C34.
4185 The preprocessor symbol @code{__convex_c34__} is defined.
4187 @item -mc38
4188 Generate output for C38xx.  Uses instructions not available on C1.
4189 Scheduling and other optimizations are chosen for max performance on C38.
4190 The preprocessor symbol @code{__convex_c38__} is defined.
4192 @item -margcount
4193 Generate code which puts an argument count in the word preceding each
4194 argument list.  This is compatible with regular CC, and a few programs
4195 may need the argument count word.  GDB and other source-level debuggers
4196 do not need it; this info is in the symbol table.
4198 @item -mnoargcount
4199 Omit the argument count word.  This is the default.
4201 @item -mvolatile-cache
4202 Allow volatile references to be cached.  This is the default.
4204 @item -mvolatile-nocache
4205 Volatile references bypass the data cache, going all the way to memory.
4206 This is only needed for multi-processor code that does not use standard
4207 synchronization instructions.  Making non-volatile references to volatile
4208 locations will not necessarily work.
4210 @item -mlong32
4211 Type long is 32 bits, the same as type int.  This is the default.
4213 @item -mlong64
4214 Type long is 64 bits, the same as type long long.  This option is useless,
4215 because no library support exists for it.
4216 @end table
4218 @node AMD29K Options
4219 @subsection AMD29K Options
4220 @cindex AMD29K options
4222 These @samp{-m} options are defined for the AMD Am29000:
4224 @table @code
4225 @item -mdw
4226 @kindex -mdw
4227 @cindex DW bit (29k)
4228 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
4229 halfword operations are directly supported by the hardware.  This is the
4230 default.
4232 @item -mndw
4233 @kindex -mndw
4234 Generate code that assumes the @code{DW} bit is not set.
4236 @item -mbw
4237 @kindex -mbw
4238 @cindex byte writes (29k)
4239 Generate code that assumes the system supports byte and halfword write
4240 operations.  This is the default.
4242 @item -mnbw
4243 @kindex -mnbw
4244 Generate code that assumes the systems does not support byte and
4245 halfword write operations.  @samp{-mnbw} implies @samp{-mndw}.
4247 @item -msmall
4248 @kindex -msmall
4249 @cindex memory model (29k)
4250 Use a small memory model that assumes that all function addresses are
4251 either within a single 256 KB segment or at an absolute address of less
4252 than 256k.  This allows the @code{call} instruction to be used instead
4253 of a @code{const}, @code{consth}, @code{calli} sequence.
4255 @item -mnormal
4256 @kindex -mnormal
4257 Use the normal memory model: Generate @code{call} instructions only when
4258 calling functions in the same file and @code{calli} instructions
4259 otherwise.  This works if each file occupies less than 256 KB but allows
4260 the entire executable to be larger than 256 KB.  This is the default.
4262 @item -mlarge
4263 Always use @code{calli} instructions.  Specify this option if you expect
4264 a single file to compile into more than 256 KB of code.
4266 @item -m29050
4267 @kindex -m29050
4268 @cindex processor selection (29k)
4269 Generate code for the Am29050.
4271 @item -m29000
4272 @kindex -m29000
4273 Generate code for the Am29000.  This is the default.
4275 @item -mkernel-registers
4276 @kindex -mkernel-registers
4277 @cindex kernel and user registers (29k)
4278 Generate references to registers @code{gr64-gr95} instead of to
4279 registers @code{gr96-gr127}.  This option can be used when compiling
4280 kernel code that wants a set of global registers disjoint from that used
4281 by user-mode code.
4283 Note that when this option is used, register names in @samp{-f} flags
4284 must use the normal, user-mode, names.
4286 @item -muser-registers
4287 @kindex -muser-registers
4288 Use the normal set of global registers, @code{gr96-gr127}.  This is the
4289 default.
4291 @item -mstack-check
4292 @itemx -mno-stack-check
4293 @kindex -mstack-check
4294 @cindex stack checks (29k)
4295 Insert (or do not insert) a call to @code{__msp_check} after each stack
4296 adjustment.  This is often used for kernel code.
4298 @item -mstorem-bug
4299 @itemx -mno-storem-bug
4300 @kindex -mstorem-bug
4301 @cindex storem bug (29k)
4302 @samp{-mstorem-bug} handles 29k processors which cannot handle the
4303 separation of a mtsrim insn and a storem instruction (most 29000 chips
4304 to date, but not the 29050).
4306 @item -mno-reuse-arg-regs
4307 @itemx -mreuse-arg-regs
4308 @kindex -mreuse-arg-regs
4309 @samp{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
4310 registers for copying out arguments.  This helps detect calling a function
4311 with fewer arguments than it was declared with.
4313 @item -mno-impure-text
4314 @itemx -mimpure-text
4315 @kindex -mimpure-text
4316 @samp{-mimpure-text}, used in addition to @samp{-shared}, tells the compiler to
4317 not pass @samp{-assert pure-text} to the linker when linking a shared object.
4319 @item -msoft-float
4320 @kindex -msoft-float
4321 Generate output containing library calls for floating point.
4322 @strong{Warning:} the requisite libraries are not part of GCC.
4323 Normally the facilities of the machine's usual C compiler are used, but
4324 this can't be done directly in cross-compilation.  You must make your
4325 own arrangements to provide suitable library functions for
4326 cross-compilation.
4328 @item -mno-multm
4329 @kindex -mno-multm
4330 Do not generate multm or multmu instructions.  This is useful for some embedded
4331 systems which do not have trap handlers for these instructions.
4332 @end table
4334 @node ARM Options
4335 @subsection ARM Options
4336 @cindex ARM options
4338 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
4339 architectures:
4341 @table @code
4342 @item -mapcs-frame
4343 @kindex -mapcs-frame
4344 Generate a stack frame that is compliant with the ARM Procedure Call
4345 Standard for all functions, even if this is not strictly necessary for
4346 correct execution of the code.  Specifying @samp{-fomit-frame-pointer}
4347 with this option will cause the stack frames not to be generated for
4348 leaf functions.  The default is @samp{-mno-apcs-frame}.
4350 @item -mapcs
4351 @kindex -mapcs
4352 This is a synonym for @samp{-mapcs-frame}.
4354 @item -mapcs-26
4355 @kindex -mapcs-26
4356 Generate code for a processor running with a 26-bit program counter,
4357 and conforming to the function calling standards for the APCS 26-bit
4358 option.  This option replaces the @samp{-m2} and @samp{-m3} options
4359 of previous releases of the compiler.
4361 @item -mapcs-32
4362 @kindex -mapcs-32
4363 Generate code for a processor running with a 32-bit program counter,
4364 and conforming to the function calling standards for the APCS 32-bit
4365 option.  This option replaces the @samp{-m6} option of previous releases
4366 of the compiler.
4368 @item -mapcs-stack-check
4369 @kindex -mapcs-stack-check
4370 @kindex -mno-apcs-stack-check
4371 Generate code to check the amount of stack space available upon entry to
4372 every function (that actually uses some stack space).  If there is
4373 insufficient space available then either the function
4374 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
4375 called, depending upon the amount of stack space required.  The run time
4376 system is required to provide these functions.  The default is
4377 @samp{-mno-apcs-stack-check}, since this produces smaller code.
4379 @item -mapcs-float
4380 @kindex -mapcs-float
4381 @kindex -mno-apcs-float
4382 Pass floating point arguments using the float point registers.  This is
4383 one of the variants of the APCS.  This option is recommended if the
4384 target hardware has a floating point unit or if a lot of floating point
4385 arithmetic is going to be performed by the code.  The default is
4386 @samp{-mno-apcs-float}, since integer only code is slightly increased in
4387 size if @samp{-mapcs-float} is used.
4389 @item -mapcs-reentrant
4390 @kindex -mapcs-reentrant
4391 @kindex -mno-apcs-reentrant
4392 Generate reentrant, position independent code.  This is the equivalent
4393 to specifying the @samp{-fpic} option.  The default is
4394 @samp{-mno-apcs-reentrant}.
4396 @item -mthumb-interwork
4397 @kindex -mthumb-interwork
4398 @kindex -mno-thumb-interwork
4399 Generate code which supports calling between the ARM and THUMB
4400 instruction sets.  Without this option the two instruction sets cannot
4401 be reliably used inside one program.  The default is
4402 @samp{-mno-thumb-interwork}, since slightly larger code is generated
4403 when @samp{-mthumb-interwork} is specified.
4405 @item -mno-sched-prolog
4406 @kindex -mno-sched-prolog
4407 @kindex -msched-prolog
4408 Prevent the reordering of instructions in the function prolog, or the
4409 merging of those instruction with the instructions in the function's
4410 body.  This means that all functions will start with a recognizable set
4411 of instructions (or in fact one of a choice from a small set of
4412 different function prologues), and this information can be used to
4413 locate the start if functions inside an executable piece of code.  The
4414 default is @samp{-msched-prolog}.
4416 @item -mhard-float
4417 Generate output containing floating point instructions.  This is the
4418 default.
4420 @item -msoft-float
4421 Generate output containing library calls for floating point.
4422 @strong{Warning:} the requisite libraries are not available for all ARM
4423 targets.  Normally the facilities of the machine's usual C compiler are
4424 used, but this cannot be done directly in cross-compilation.  You must make
4425 your own arrangements to provide suitable library functions for
4426 cross-compilation.
4428 @samp{-msoft-float} changes the calling convention in the output file;
4429 therefore, it is only useful if you compile @emph{all} of a program with
4430 this option.  In particular, you need to compile @file{libgcc.a}, the
4431 library that comes with GCC, with @samp{-msoft-float} in order for
4432 this to work.
4434 @item -mlittle-endian
4435 Generate code for a processor running in little-endian mode.  This is
4436 the default for all standard configurations.
4438 @item -mbig-endian
4439 Generate code for a processor running in big-endian mode; the default is
4440 to compile code for a little-endian processor.
4442 @item -mwords-little-endian
4443 This option only applies when generating code for big-endian processors.
4444 Generate code for a little-endian word order but a big-endian byte
4445 order.  That is, a byte order of the form @samp{32107654}.  Note: this
4446 option should only be used if you require compatibility with code for
4447 big-endian ARM processors generated by versions of the compiler prior to
4448 2.8.
4450 @item -malignment-traps
4451 @kindex -malignment-traps
4452 Generate code that will not trap if the MMU has alignment traps enabled.
4453 On ARM architectures prior to ARMv4, there were no instructions to
4454 access half-word objects stored in memory.  However, when reading from
4455 memory a feature of the ARM architecture allows a word load to be used,
4456 even if the address is unaligned, and the processor core will rotate the
4457 data as it is being loaded.  This option tells the compiler that such
4458 misaligned accesses will cause a MMU trap and that it should instead
4459 synthesise the access as a series of byte accesses.  The compiler can
4460 still use word accesses to load half-word data if it knows that the
4461 address is aligned to a word boundary.
4463 This option is ignored when compiling for ARM architecture 4 or later,
4464 since these processors have instructions to directly access half-word
4465 objects in memory. 
4466         
4467 @item -mno-alignment-traps
4468 @kindex -mno-alignment-traps
4469 Generate code that assumes that the MMU will not trap unaligned
4470 accesses.  This produces better code when the target instruction set
4471 does not have half-word memory operations (implementations prior to
4472 ARMv4). 
4474 Note that you cannot use this option to access unaligned word objects,
4475 since the processor will only fetch one 32-bit aligned object from
4476 memory. 
4478 The default setting for most targets is -mno-alignment-traps, since
4479 this produces better code when there are no half-word memory
4480 instructions available. 
4482 @item -mshort-load-bytes
4483 @kindex -mshort-load-bytes
4484 This is a depreciated alias for @samp{-malignment-traps}.
4486 @item -mno-short-load-bytes
4487 @kindex -mno-short-load-bytes
4488 This is a depreciated alias for @samp{-mno-alignment-traps}.
4490 @item -mshort-load-words
4491 @kindex -mshort-load-words
4492 This is a depreciated alias for @samp{-mno-alignment-traps}.
4494 @item -mno-short-load-words
4495 @kindex -mno-short-load-words
4496 This is a depreciated alias for @samp{-malignment-traps}.
4498 @item -mbsd
4499 @kindex -mbsd
4500 This option only applies to RISC iX.  Emulate the native BSD-mode
4501 compiler.  This is the default if @samp{-ansi} is not specified.
4503 @item -mxopen
4504 @kindex -mxopen
4505 This option only applies to RISC iX.  Emulate the native X/Open-mode
4506 compiler.
4508 @item -mno-symrename
4509 @kindex -mno-symrename
4510 This option only applies to RISC iX.  Do not run the assembler
4511 post-processor, @samp{symrename}, after code has been assembled.
4512 Normally it is necessary to modify some of the standard symbols in
4513 preparation for linking with the RISC iX C library; this option
4514 suppresses this pass.  The post-processor is never run when the
4515 compiler is built for cross-compilation.
4517 @item -mcpu=<name>
4518 @kindex -mcpu=
4519 This specifies the name of the target ARM processor.  GCC uses this name
4520 to determine what kind of instructions it can use when generating
4521 assembly code.  Permissible names are: arm2, arm250, arm3, arm6, arm60,
4522 arm600, arm610, arm620, arm7, arm7m, arm7d, arm7dm, arm7di, arm7dmi,
4523 arm70, arm700, arm700i, arm710, arm710c, arm7100, arm7500, arm7500fe,
4524 arm7tdmi, arm8, strongarm, strongarm110, strongarm1100, arm8, arm810,
4525 arm9, arm920, arm920t, arm9tdmi.
4527 @itemx -mtune=<name>
4528 @kindex -mtune=
4529 This option is very similar to the @samp{-mcpu=} option, except that
4530 instead of specifying the actual target processor type, and hence
4531 restricting which instructions can be used, it specifies that GCC should
4532 tune the performance of the code as if the target were of the type
4533 specified in this option, but still choosing the instructions that it
4534 will generate based on the cpu specified by a @samp{-mcpu=} option.
4535 For some arm implementations better performance can be obtained by using
4536 this option.
4538 @item -march=<name>
4539 @kindex -march=
4540 This specifies the name of the target ARM architecture.  GCC uses this
4541 name to determine what kind of instructions it can use when generating
4542 assembly code.  This option can be used in conjunction with or instead
4543 of the @samp{-mcpu=} option.  Permissible names are: armv2, armv2a,
4544 armv3, armv3m, armv4, armv4t, armv5.
4546 @item -mfpe=<number>
4547 @itemx -mfp=<number>
4548 @kindex -mfpe=
4549 @kindex -mfp=
4550 This specifes the version of the floating point emulation available on
4551 the target.  Permissible values are 2 and 3.  @samp{-mfp=} is a synonym
4552 for @samp{-mfpe=} to support older versions of GCC.
4554 @item -mstructure-size-boundary=<n>
4555 @kindex -mstructure-size-boundary
4556 The size of all structures and unions will be rounded up to a multiple
4557 of the number of bits set by this option.  Permissible values are 8 and
4558 32.  The default value varies for different toolchains.  For the COFF
4559 targeted toolchain the default value is 8.  Specifying the larger number
4560 can produce faster, more efficient code, but can also increase the size
4561 of the program.  The two values are potentially incompatible.  Code
4562 compiled with one value cannot necessarily expect to work with code or
4563 libraries compiled with the other value, if they exchange information
4564 using structures or unions.  Programmers are encouraged to use the 32
4565 value as future versions of the toolchain may default to this value.
4567 @item -mabort-on-noreturn
4568 @kindex -mabort-on-noreturn
4569 @kindex -mnoabort-on-noreturn
4570 Generate a call to the function abort at the end of a noreturn function.
4571 It will be executed if the function tries to return.
4573 @item -mnop-fun-dllimport
4574 @kindex -mnop-fun-dllimport
4575 Disable the support for the @emph{dllimport} attribute.
4577 @item -msingle-pic-base
4578 @kindex -msingle-pic-base
4579 Treat the register used for PIC addressing as read-only, rather than
4580 loading it in the prologue for each function.  The run-time system is
4581 responsible for initialising this register with an appropriate value
4582 before execution begins.
4584 @item -mpic-register=<reg>
4585 @kindex -mpic-register=
4586 Specify the register to be used for PIC addressing.  The default is R10
4587 unless stack-checking is enabled, when R9 is used.
4589 @end table
4591 @node Thumb Options
4592 @subsection Thumb Options
4593 @cindex Thumb Options
4595 @table @code
4597 @item -mthumb-interwork
4598 @kindex -mthumb-interwork
4599 @kindex -mno-thumb-interwork
4600 Generate code which supports calling between the THUMB and ARM
4601 instruction sets.  Without this option the two instruction sets cannot
4602 be reliably used inside one program.  The default is
4603 @samp{-mno-thumb-interwork}, since slightly smaller code is generated
4604 with this option.
4606 @item -mtpcs-frame
4607 @kindex -mtpcs-frame
4608 @kindex -mno-tpcs-frame
4609 Generate a stack frame that is compliant with the Thumb Procedure Call
4610 Standard for all non-leaf functions.  (A leaf function is one that does
4611 not call any other functions).  The default is @samp{-mno-apcs-frame}. 
4613 @item -mtpcs-leaf-frame
4614 @kindex -mtpcs-leaf-frame
4615 @kindex -mno-tpcs-leaf-frame
4616 Generate a stack frame that is compliant with the Thumb Procedure Call
4617 Standard for all leaf functions.  (A leaf function is one that does
4618 not call any other functions).  The default is @samp{-mno-apcs-leaf-frame}. 
4620 @item -mlittle-endian
4621 @kindex -mlittle-endian
4622 Generate code for a processor running in little-endian mode.  This is
4623 the default for all standard configurations.
4625 @item -mbig-endian
4626 @kindex -mbig-endian
4627 Generate code for a processor running in big-endian mode.
4629 @item -mstructure-size-boundary=<n>
4630 @kindex -mstructure-size-boundary
4631 The size of all structures and unions will be rounded up to a multiple
4632 of the number of bits set by this option.  Permissible values are 8 and
4633 32.  The default value varies for different toolchains.  For the COFF
4634 targeted toolchain the default value is 8.  Specifying the larger number
4635 can produced faster, more efficient code, but can also increase the size
4636 of the program.  The two values are potentially incompatible.  Code
4637 compiled with one value cannot necessarily expect to work with code or
4638 libraries compiled with the other value, if they exchange information
4639 using structures or unions.  Programmers are encouraged to use the 32
4640 value as future versions of the toolchain may default to this value.
4642 @item -mnop-fun-dllimport
4643 @kindex -mnop-fun-dllimport
4644 Disable the support for the @emph{dllimport} attribute.
4646 @item -mcallee-super-interworking
4647 @kindex -mcallee-super-interworking
4648 Gives all externally visible functions in the file being compiled an ARM
4649 instruction set header which switches to Thumb mode before executing the
4650 rest of the function.  This allows these functions to be called from
4651 non-interworking code.
4653 @item -mcaller-super-interworking
4654 @kindex -mcaller-super-interworking
4655 Allows calls via function pointers (including virtual functions) to
4656 execute correctly regardless of whether the target code has been
4657 compiled for interworking or not.  There is a small overhead in the cost
4658 of executing a function pointer if this option is enabled.
4660 @item -msingle-pic-base
4661 @kindex -msingle-pic-base
4662 Treat the register used for PIC addressing as read-only, rather than
4663 loading it in the prologue for each function.  The run-time system is
4664 responsible for initialising this register with an appropriate value
4665 before execution begins.
4667 @item -mpic-register=<reg>
4668 @kindex -mpic-register=
4669 Specify the register to be used for PIC addressing.  The default is R10.
4671 @end table
4673 @node MN10200 Options
4674 @subsection MN10200 Options
4675 @cindex MN10200 options
4676 These @samp{-m} options are defined for Matsushita MN10200 architectures:
4677 @table @code
4679 @item -mrelax
4680 Indicate to the linker that it should perform a relaxation optimization pass
4681 to shorten branches, calls and absolute memory addresses.  This option only
4682 has an effect when used on the command line for the final link step.
4684 This option makes symbolic debugging impossible. 
4685 @end table
4687 @node MN10300 Options
4688 @subsection MN10300 Options
4689 @cindex MN10300 options
4690 These @samp{-m} options are defined for Matsushita MN10300 architectures:
4692 @table @code
4693 @item -mmult-bug
4694 Generate code to avoid bugs in the multiply instructions for the MN10300
4695 processors.  This is the default.
4697 @item -mno-mult-bug
4698 Do not generate code to avoid bugs in the multiply instructions for the
4699 MN10300 processors.
4701 @item -mam33
4702 Generate code which uses features specific to the AM33 processor.
4704 @item -mno-am33
4705 Do not generate code which uses features specific to the AM33 processor.  This
4706 is the default.
4708 @item -mrelax
4709 Indicate to the linker that it should perform a relaxation optimization pass
4710 to shorten branches, calls and absolute memory addresses.  This option only
4711 has an effect when used on the command line for the final link step.
4713 This option makes symbolic debugging impossible. 
4714 @end table
4717 @node M32R/D Options
4718 @subsection M32R/D Options
4719 @cindex M32R/D options
4721 These @samp{-m} options are defined for Mitsubishi M32R/D architectures:
4723 @table @code
4724 @item -mcode-model=small
4725 Assume all objects live in the lower 16MB of memory (so that their addresses
4726 can be loaded with the @code{ld24} instruction), and assume all subroutines
4727 are reachable with the @code{bl} instruction.
4728 This is the default.
4730 The addressability of a particular object can be set with the
4731 @code{model} attribute.
4733 @item -mcode-model=medium
4734 Assume objects may be anywhere in the 32 bit address space (the compiler
4735 will generate @code{seth/add3} instructions to load their addresses), and
4736 assume all subroutines are reachable with the @code{bl} instruction.
4738 @item -mcode-model=large
4739 Assume objects may be anywhere in the 32 bit address space (the compiler
4740 will generate @code{seth/add3} instructions to load their addresses), and
4741 assume subroutines may not be reachable with the @code{bl} instruction
4742 (the compiler will generate the much slower @code{seth/add3/jl}
4743 instruction sequence).
4745 @item -msdata=none
4746 Disable use of the small data area.  Variables will be put into
4747 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
4748 @code{section} attribute has been specified).
4749 This is the default.
4751 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
4752 Objects may be explicitly put in the small data area with the
4753 @code{section} attribute using one of these sections.
4755 @item -msdata=sdata
4756 Put small global and static data in the small data area, but do not
4757 generate special code to reference them.
4759 @item -msdata=use
4760 Put small global and static data in the small data area, and generate
4761 special instructions to reference them.
4763 @item -G @var{num}
4764 @cindex smaller data references
4765 Put global and static objects less than or equal to @var{num} bytes
4766 into the small data or bss sections instead of the normal data or bss
4767 sections.  The default value of @var{num} is 8.
4768 The @samp{-msdata} option must be set to one of @samp{sdata} or @samp{use}
4769 for this option to have any effect.
4771 All modules should be compiled with the same @samp{-G @var{num}} value.
4772 Compiling with different values of @var{num} may or may not work; if it
4773 doesn't the linker will give an error message - incorrect code will not be
4774 generated.
4776 @end table
4778 @node M88K Options
4779 @subsection M88K Options
4780 @cindex M88k options
4782 These @samp{-m} options are defined for Motorola 88k architectures:
4784 @table @code
4785 @item -m88000
4786 @kindex -m88000
4787 Generate code that works well on both the m88100 and the
4788 m88110.
4790 @item -m88100
4791 @kindex -m88100
4792 Generate code that works best for the m88100, but that also
4793 runs on the m88110.
4795 @item -m88110
4796 @kindex -m88110
4797 Generate code that works best for the m88110, and may not run
4798 on the m88100.
4800 @item -mbig-pic
4801 @kindex -mbig-pic
4802 Obsolete option to be removed from the next revision.
4803 Use @samp{-fPIC}.
4805 @item -midentify-revision
4806 @kindex -midentify-revision
4807 @kindex ident
4808 @cindex identifying source, compiler (88k)
4809 Include an @code{ident} directive in the assembler output recording the
4810 source file name, compiler name and version, timestamp, and compilation
4811 flags used.
4813 @item -mno-underscores
4814 @kindex -mno-underscores
4815 @cindex underscores, avoiding (88k)
4816 In assembler output, emit symbol names without adding an underscore
4817 character at the beginning of each name.  The default is to use an
4818 underscore as prefix on each name.
4820 @item -mocs-debug-info
4821 @itemx -mno-ocs-debug-info
4822 @kindex -mocs-debug-info
4823 @kindex -mno-ocs-debug-info
4824 @cindex OCS (88k)
4825 @cindex debugging, 88k OCS
4826 Include (or omit) additional debugging information (about registers used
4827 in each stack frame) as specified in the 88open Object Compatibility
4828 Standard, ``OCS''.  This extra information allows debugging of code that
4829 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
4830 Delta 88 SVr3.2 is to include this information; other 88k configurations
4831 omit this information by default.
4833 @item -mocs-frame-position
4834 @kindex -mocs-frame-position
4835 @cindex register positions in frame (88k)
4836 When emitting COFF debugging information for automatic variables and
4837 parameters stored on the stack, use the offset from the canonical frame
4838 address, which is the stack pointer (register 31) on entry to the
4839 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
4840 @samp{-mocs-frame-position}; other 88k configurations have the default
4841 @samp{-mno-ocs-frame-position}.
4843 @item -mno-ocs-frame-position
4844 @kindex -mno-ocs-frame-position
4845 @cindex register positions in frame (88k)
4846 When emitting COFF debugging information for automatic variables and
4847 parameters stored on the stack, use the offset from the frame pointer
4848 register (register 30).  When this option is in effect, the frame
4849 pointer is not eliminated when debugging information is selected by the
4850 -g switch.
4852 @item -moptimize-arg-area
4853 @itemx -mno-optimize-arg-area
4854 @kindex -moptimize-arg-area
4855 @kindex -mno-optimize-arg-area
4856 @cindex arguments in frame (88k)
4857 Control how function arguments are stored in stack frames.
4858 @samp{-moptimize-arg-area} saves space by optimizing them, but this
4859 conflicts with the 88open specifications.  The opposite alternative,
4860 @samp{-mno-optimize-arg-area}, agrees with 88open standards.  By default
4861 GCC does not optimize the argument area.
4863 @item -mshort-data-@var{num}
4864 @kindex -mshort-data-@var{num}
4865 @cindex smaller data references (88k)
4866 @cindex r0-relative references (88k)
4867 Generate smaller data references by making them relative to @code{r0},
4868 which allows loading a value using a single instruction (rather than the
4869 usual two).  You control which data references are affected by
4870 specifying @var{num} with this option.  For example, if you specify
4871 @samp{-mshort-data-512}, then the data references affected are those
4872 involving displacements of less than 512 bytes.
4873 @samp{-mshort-data-@var{num}} is not effective for @var{num} greater
4874 than 64k.
4876 @item -mserialize-volatile
4877 @kindex -mserialize-volatile
4878 @itemx -mno-serialize-volatile
4879 @kindex -mno-serialize-volatile
4880 @cindex sequential consistency on 88k
4881 Do, or don't, generate code to guarantee sequential consistency
4882 of volatile memory references.  By default, consistency is
4883 guaranteed.
4885 The order of memory references made by the MC88110 processor does
4886 not always match the order of the instructions requesting those
4887 references.  In particular, a load instruction may execute before
4888 a preceding store instruction.  Such reordering violates
4889 sequential consistency of volatile memory references, when there
4890 are multiple processors.   When consistency must be guaranteed,
4891 GNU C generates special instructions, as needed, to force
4892 execution in the proper order.
4894 The MC88100 processor does not reorder memory references and so
4895 always provides sequential consistency.  However, by default, GNU
4896 C generates the special instructions to guarantee consistency
4897 even when you use @samp{-m88100}, so that the code may be run on an
4898 MC88110 processor.  If you intend to run your code only on the
4899 MC88100 processor, you may use @samp{-mno-serialize-volatile}.
4901 The extra code generated to guarantee consistency may affect the
4902 performance of your application.  If you know that you can safely
4903 forgo this guarantee, you may use @samp{-mno-serialize-volatile}.
4905 @item -msvr4
4906 @itemx -msvr3
4907 @kindex -msvr4
4908 @kindex -msvr3
4909 @cindex assembler syntax, 88k
4910 @cindex SVr4
4911 Turn on (@samp{-msvr4}) or off (@samp{-msvr3}) compiler extensions
4912 related to System V release 4 (SVr4).  This controls the following:
4914 @enumerate
4915 @item
4916 Which variant of the assembler syntax to emit.
4917 @item
4918 @samp{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
4919 that is used on System V release 4.
4920 @item
4921 @samp{-msvr4} makes GCC issue additional declaration directives used in
4922 SVr4.
4923 @end enumerate
4925 @samp{-msvr4} is the default for the m88k-motorola-sysv4 and
4926 m88k-dg-dgux m88k configurations. @samp{-msvr3} is the default for all
4927 other m88k configurations.
4929 @item -mversion-03.00
4930 @kindex -mversion-03.00
4931 This option is obsolete, and is ignored.
4932 @c ??? which asm syntax better for GAS?  option there too?
4934 @item -mno-check-zero-division
4935 @itemx -mcheck-zero-division
4936 @kindex -mno-check-zero-division
4937 @kindex -mcheck-zero-division
4938 @cindex zero division on 88k
4939 Do, or don't, generate code to guarantee that integer division by
4940 zero will be detected.  By default, detection is guaranteed.
4942 Some models of the MC88100 processor fail to trap upon integer
4943 division by zero under certain conditions.  By default, when
4944 compiling code that might be run on such a processor, GNU C
4945 generates code that explicitly checks for zero-valued divisors
4946 and traps with exception number 503 when one is detected.  Use of
4947 mno-check-zero-division suppresses such checking for code
4948 generated to run on an MC88100 processor.
4950 GNU C assumes that the MC88110 processor correctly detects all
4951 instances of integer division by zero.  When @samp{-m88110} is
4952 specified, both @samp{-mcheck-zero-division} and
4953 @samp{-mno-check-zero-division} are ignored, and no explicit checks for
4954 zero-valued divisors are generated.
4956 @item -muse-div-instruction
4957 @kindex -muse-div-instruction
4958 @cindex divide instruction, 88k
4959 Use the div instruction for signed integer division on the
4960 MC88100 processor.  By default, the div instruction is not used.
4962 On the MC88100 processor the signed integer division instruction
4963 div) traps to the operating system on a negative operand.  The
4964 operating system transparently completes the operation, but at a
4965 large cost in execution time.  By default, when compiling code
4966 that might be run on an MC88100 processor, GNU C emulates signed
4967 integer division using the unsigned integer division instruction
4968 divu), thereby avoiding the large penalty of a trap to the
4969 operating system.  Such emulation has its own, smaller, execution
4970 cost in both time and space.  To the extent that your code's
4971 important signed integer division operations are performed on two
4972 nonnegative operands, it may be desirable to use the div
4973 instruction directly.
4975 On the MC88110 processor the div instruction (also known as the
4976 divs instruction) processes negative operands without trapping to
4977 the operating system.  When @samp{-m88110} is specified,
4978 @samp{-muse-div-instruction} is ignored, and the div instruction is used
4979 for signed integer division.
4981 Note that the result of dividing INT_MIN by -1 is undefined.  In
4982 particular, the behavior of such a division with and without
4983 @samp{-muse-div-instruction}  may differ.
4985 @item -mtrap-large-shift
4986 @itemx -mhandle-large-shift
4987 @kindex -mtrap-large-shift
4988 @kindex -mhandle-large-shift
4989 @cindex bit shift overflow (88k)
4990 @cindex large bit shifts (88k)
4991 Include code to detect bit-shifts of more than 31 bits; respectively,
4992 trap such shifts or emit code to handle them properly.  By default GCC
4993 makes no special provision for large bit shifts.
4995 @item -mwarn-passed-structs
4996 @kindex -mwarn-passed-structs
4997 @cindex structure passing (88k)
4998 Warn when a function passes a struct as an argument or result.
4999 Structure-passing conventions have changed during the evolution of the C
5000 language, and are often the source of portability problems.  By default,
5001 GCC issues no such warning.
5002 @end table
5004 @node RS/6000 and PowerPC Options
5005 @subsection IBM RS/6000 and PowerPC Options
5006 @cindex RS/6000 and PowerPC Options
5007 @cindex IBM RS/6000 and PowerPC Options
5009 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
5010 @table @code
5011 @item -mpower
5012 @itemx -mno-power
5013 @itemx -mpower2
5014 @itemx -mno-power2
5015 @itemx -mpowerpc
5016 @itemx -mno-powerpc
5017 @itemx -mpowerpc-gpopt
5018 @itemx -mno-powerpc-gpopt
5019 @itemx -mpowerpc-gfxopt
5020 @itemx -mno-powerpc-gfxopt
5021 @itemx -mpowerpc64
5022 @itemx -mno-powerpc64
5023 @kindex -mpower
5024 @kindex -mpower2
5025 @kindex -mpowerpc
5026 @kindex -mpowerpc-gpopt
5027 @kindex -mpowerpc-gfxopt
5028 @kindex -mpowerpc64
5029 GCC supports two related instruction set architectures for the
5030 RS/6000 and PowerPC.  The @dfn{POWER} instruction set are those
5031 instructions supported by the @samp{rios} chip set used in the original
5032 RS/6000 systems and the @dfn{PowerPC} instruction set is the
5033 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
5034 the IBM 4xx microprocessors.
5036 Neither architecture is a subset of the other.  However there is a
5037 large common subset of instructions supported by both.  An MQ
5038 register is included in processors supporting the POWER architecture.
5040 You use these options to specify which instructions are available on the
5041 processor you are using.  The default value of these options is
5042 determined when configuring GCC.  Specifying the
5043 @samp{-mcpu=@var{cpu_type}} overrides the specification of these
5044 options.  We recommend you use the @samp{-mcpu=@var{cpu_type}} option
5045 rather than the options listed above.
5047 The @samp{-mpower} option allows GCC to generate instructions that
5048 are found only in the POWER architecture and to use the MQ register.
5049 Specifying @samp{-mpower2} implies @samp{-power} and also allows GCC
5050 to generate instructions that are present in the POWER2 architecture but
5051 not the original POWER architecture.
5053 The @samp{-mpowerpc} option allows GCC to generate instructions that
5054 are found only in the 32-bit subset of the PowerPC architecture.
5055 Specifying @samp{-mpowerpc-gpopt} implies @samp{-mpowerpc} and also allows
5056 GCC to use the optional PowerPC architecture instructions in the
5057 General Purpose group, including floating-point square root.  Specifying
5058 @samp{-mpowerpc-gfxopt} implies @samp{-mpowerpc} and also allows GCC to
5059 use the optional PowerPC architecture instructions in the Graphics
5060 group, including floating-point select.
5062 The @samp{-mpowerpc64} option allows GCC to generate the additional
5063 64-bit instructions that are found in the full PowerPC64 architecture
5064 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
5065 @samp{-mno-powerpc64}.
5067 If you specify both @samp{-mno-power} and @samp{-mno-powerpc}, GCC
5068 will use only the instructions in the common subset of both
5069 architectures plus some special AIX common-mode calls, and will not use
5070 the MQ register.  Specifying both @samp{-mpower} and @samp{-mpowerpc}
5071 permits GCC to use any instruction from either architecture and to
5072 allow use of the MQ register; specify this for the Motorola MPC601.
5074 @item -mnew-mnemonics
5075 @itemx -mold-mnemonics
5076 @kindex -mnew-mnemonics
5077 @kindex -mold-mnemonics
5078 Select which mnemonics to use in the generated assembler code.
5079 @samp{-mnew-mnemonics} requests output that uses the assembler mnemonics
5080 defined for the PowerPC architecture, while @samp{-mold-mnemonics}
5081 requests the assembler mnemonics defined for the POWER architecture.
5082 Instructions defined in only one architecture have only one mnemonic;
5083 GCC uses that mnemonic irrespective of which of these options is
5084 specified.
5086 GCC defaults to the mnemonics appropriate for the architecture in
5087 use.  Specifying @samp{-mcpu=@var{cpu_type}} sometimes overrides the
5088 value of these option.  Unless you are building a cross-compiler, you
5089 should normally not specify either @samp{-mnew-mnemonics} or
5090 @samp{-mold-mnemonics}, but should instead accept the default.
5092 @item -mcpu=@var{cpu_type}
5093 @kindex -mcpu
5094 Set architecture type, register usage, choice of mnemonics, and
5095 instruction scheduling parameters for machine type @var{cpu_type}.
5096 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
5097 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
5098 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
5099 @samp{630}, @samp{740}, @samp{750}, @samp{power}, @samp{power2},
5100 @samp{powerpc}, @samp{403}, @samp{505}, @samp{801}, @samp{821},
5101 @samp{823}, and @samp{860} and @samp{common}.  @samp{-mcpu=power},
5102 @samp{-mcpu=power2}, @samp{-mcpu=powerpc}, and @samp{-mcpu=powerpc64}
5103 specify generic POWER, POWER2, pure 32-bit PowerPC (i.e., not MPC601),
5104 and 64-bit PowerPC architecture machine types, with an appropriate,
5105 generic processor model assumed for scheduling purposes.@refill
5107 Specifying any of the following options: 
5108 @samp{-mcpu=rios1}, @samp{-mcpu=rios2}, @samp{-mcpu=rsc},
5109 @samp{-mcpu=power}, or @samp{-mcpu=power2}  
5110 enables the @samp{-mpower} option and disables the @samp{-mpowerpc} option; 
5111 @samp{-mcpu=601} enables both the @samp{-mpower} and @samp{-mpowerpc} options.
5112 All of @samp{-mcpu=rs64a}, @samp{-mcpu=602}, @samp{-mcpu=603},
5113 @samp{-mcpu=603e}, @samp{-mcpu=604}, @samp{-mcpu=620}, @samp{-mcpu=630},
5114 @samp{-mcpu=740}, and @samp{-mcpu=750}
5115 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.  
5116 Exactly similarly, all of @samp{-mcpu=403},
5117 @samp{-mcpu=505}, @samp{-mcpu=821}, @samp{-mcpu=860} and @samp{-mcpu=powerpc} 
5118 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
5119 @samp{-mcpu=common} disables both the 
5120 @samp{-mpower} and @samp{-mpowerpc} options.@refill
5122 AIX versions 4 or greater selects @samp{-mcpu=common} by default, so
5123 that code will operate on all members of the RS/6000 POWER and PowerPC
5124 families.  In that case, GCC will use only the instructions in the
5125 common subset of both architectures plus some special AIX common-mode
5126 calls, and will not use the MQ register.  GCC assumes a generic
5127 processor model for scheduling purposes.
5129 Specifying any of the options @samp{-mcpu=rios1}, @samp{-mcpu=rios2},
5130 @samp{-mcpu=rsc}, @samp{-mcpu=power}, or @samp{-mcpu=power2} also
5131 disables the @samp{new-mnemonics} option.  Specifying @samp{-mcpu=601},
5132 @samp{-mcpu=602}, @samp{-mcpu=603}, @samp{-mcpu=603e}, @samp{-mcpu=604},
5133 @samp{-mcpu=620}, @samp{-mcpu=630}, @samp{-mcpu=403}, @samp{-mcpu=505},
5134 @samp{-mcpu=821}, @samp{-mcpu=860} or @samp{-mcpu=powerpc} also enables
5135 the @samp{new-mnemonics} option.@refill
5137 Specifying @samp{-mcpu=403}, @samp{-mcpu=821}, or @samp{-mcpu=860} also
5138 enables the @samp{-msoft-float} option.
5140 @item -mtune=@var{cpu_type}
5141 Set the instruction scheduling parameters for machine type
5142 @var{cpu_type}, but do not set the architecture type, register usage,
5143 choice of mnemonics like @samp{-mcpu=}@var{cpu_type} would.  The same
5144 values for @var{cpu_type} are used for @samp{-mtune=}@var{cpu_type} as
5145 for @samp{-mcpu=}@var{cpu_type}.  The @samp{-mtune=}@var{cpu_type}
5146 option overrides the @samp{-mcpu=}@var{cpu_type} option in terms of
5147 instruction scheduling parameters.
5149 @item -mfull-toc
5150 @itemx -mno-fp-in-toc
5151 @itemx -mno-sum-in-toc
5152 @itemx -mminimal-toc
5153 @kindex -mminimal-toc
5154 Modify generation of the TOC (Table Of Contents), which is created for
5155 every executable file.  The @samp{-mfull-toc} option is selected by
5156 default.  In that case, GCC will allocate at least one TOC entry for
5157 each unique non-automatic variable reference in your program.  GCC
5158 will also place floating-point constants in the TOC.  However, only
5159 16,384 entries are available in the TOC.
5161 If you receive a linker error message that saying you have overflowed
5162 the available TOC space, you can reduce the amount of TOC space used
5163 with the @samp{-mno-fp-in-toc} and @samp{-mno-sum-in-toc} options.
5164 @samp{-mno-fp-in-toc} prevents GCC from putting floating-point
5165 constants in the TOC and @samp{-mno-sum-in-toc} forces GCC to
5166 generate code to calculate the sum of an address and a constant at
5167 run-time instead of putting that sum into the TOC.  You may specify one
5168 or both of these options.  Each causes GCC to produce very slightly
5169 slower and larger code at the expense of conserving TOC space.
5171 If you still run out of space in the TOC even when you specify both of
5172 these options, specify @samp{-mminimal-toc} instead.  This option causes
5173 GCC to make only one TOC entry for every file.  When you specify this
5174 option, GCC will produce code that is slower and larger but which
5175 uses extremely little TOC space.  You may wish to use this option
5176 only on files that contain less frequently executed code. @refill
5178 @item -m64
5179 @itemx -m32
5180 @kindex -m64
5181 @kindex -m32
5182 Enable 64-bit PowerPC ABI and calling convention: 64-bit pointers, 64-bit
5183 @code{long} type, and the infrastructure needed to support them.
5184 Specifying @samp{-m64} implies @samp{-mpowerpc64} and
5185 @samp{-mpowerpc}, while @samp{-m32} disables the 64-bit ABI and
5186 implies @samp{-mno-powerpc64}.  GCC defaults to @samp{-m32}.
5188 @item -mxl-call
5189 @itemx -mno-xl-call
5190 @kindex -mxl-call
5191 On AIX, pass floating-point arguments to prototyped functions beyond the
5192 register save area (RSA) on the stack in addition to argument FPRs.  The
5193 AIX calling convention was extended but not initially documented to
5194 handle an obscure K&R C case of calling a function that takes the
5195 address of its arguments with fewer arguments than declared.  AIX XL
5196 compilers access floating point arguments which do not fit in the
5197 RSA from the stack when a subroutine is compiled without
5198 optimization.  Because always storing floating-point arguments on the
5199 stack is inefficient and rarely needed, this option is not enabled by
5200 default and only is necessary when calling subroutines compiled by AIX
5201 XL compilers without optimization.
5203 @item -mthreads
5204 @kindex -mthreads
5205 Support @dfn{AIX Threads}.  Link an application written to use
5206 @dfn{pthreads} with special libraries and startup code to enable the
5207 application to run.
5209 @item -mpe
5210 @kindex -mpe
5211 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE).  Link an
5212 application written to use message passing with special startup code to
5213 enable the application to run.  The system must have PE installed in the
5214 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
5215 must be overridden with the @samp{-specs=} option to specify the
5216 appropriate directory location.  The Parallel Environment does not
5217 support threads, so the @samp{-mpe} option and the @samp{-mthreads}
5218 option are incompatible.
5220 @item -msoft-float
5221 @itemx -mhard-float
5222 @kindex -msoft-float
5223 Generate code that does not use (uses) the floating-point register set.
5224 Software floating point emulation is provided if you use the
5225 @samp{-msoft-float} option, and pass the option to GCC when linking.
5227 @item -mmultiple
5228 @itemx -mno-multiple
5229 Generate code that uses (does not use) the load multiple word
5230 instructions and the store multiple word instructions.  These
5231 instructions are generated by default on POWER systems, and not
5232 generated on PowerPC systems.  Do not use @samp{-mmultiple} on little
5233 endian PowerPC systems, since those instructions do not work when the
5234 processor is in little endian mode.  The exceptions are PPC740 and
5235 PPC750 which permit the instructions usage in little endian mode.
5237 @item -mstring
5238 @itemx -mno-string
5239 @kindex -mstring
5240 Generate code that uses (does not use) the load string instructions
5241 and the store string word instructions to save multiple registers and
5242 do small block moves.  These instructions are generated by default on
5243 POWER systems, and not generated on PowerPC systems.  Do not use
5244 @samp{-mstring} on little endian PowerPC systems, since those
5245 instructions do not work when the processor is in little endian mode.
5246 The exceptions are PPC740 and PPC750 which permit the instructions
5247 usage in little endian mode.
5249 @item -mupdate
5250 @itemx -mno-update
5251 @kindex -mupdate
5252 Generate code that uses (does not use) the load or store instructions
5253 that update the base register to the address of the calculated memory
5254 location.  These instructions are generated by default.  If you use
5255 @samp{-mno-update}, there is a small window between the time that the
5256 stack pointer is updated and the address of the previous frame is
5257 stored, which means code that walks the stack frame across interrupts or
5258 signals may get corrupted data.
5260 @item -mfused-madd
5261 @itemx -mno-fused-madd
5262 @kindex -mfused-madd
5263 Generate code that uses (does not use) the floating point multiply and
5264 accumulate instructions.  These instructions are generated by default if
5265 hardware floating is used.
5267 @item -mno-bit-align
5268 @itemx -mbit-align
5269 @kindex -mbit-align
5270 On System V.4 and embedded PowerPC systems do not (do) force structures
5271 and unions that contain bit fields to be aligned to the base type of the
5272 bit field.
5274 For example, by default a structure containing nothing but 8
5275 @code{unsigned} bitfields of length 1 would be aligned to a 4 byte
5276 boundary and have a size of 4 bytes.  By using @samp{-mno-bit-align},
5277 the structure would be aligned to a 1 byte boundary and be one byte in
5278 size.
5280 @item -mno-strict-align
5281 @itemx -mstrict-align
5282 @kindex -mstrict-align
5283 On System V.4 and embedded PowerPC systems do not (do) assume that
5284 unaligned memory references will be handled by the system.
5286 @item -mrelocatable
5287 @itemx -mno-relocatable
5288 @kindex -mrelocatable
5289 On embedded PowerPC systems generate code that allows (does not allow)
5290 the program to be relocated to a different address at runtime.  If you
5291 use @samp{-mrelocatable} on any module, all objects linked together must
5292 be compiled with @samp{-mrelocatable} or @samp{-mrelocatable-lib}.
5294 @item -mrelocatable-lib
5295 @itemx -mno-relocatable-lib
5296 On embedded PowerPC systems generate code that allows (does not allow)
5297 the program to be relocated to a different address at runtime.  Modules
5298 compiled with @samp{-mrelocatable-lib} can be linked with either modules
5299 compiled without @samp{-mrelocatable} and @samp{-mrelocatable-lib} or
5300 with modules compiled with the @samp{-mrelocatable} options.
5302 @item -mno-toc
5303 @itemx -mtoc
5304 On System V.4 and embedded PowerPC systems do not (do) assume that
5305 register 2 contains a pointer to a global area pointing to the addresses
5306 used in the program.
5308 @item -mlittle
5309 @itemx -mlittle-endian
5310 On System V.4 and embedded PowerPC systems compile code for the
5311 processor in little endian mode.  The @samp{-mlittle-endian} option is
5312 the same as @samp{-mlittle}.
5314 @item -mbig
5315 @itemx -mbig-endian
5316 On System V.4 and embedded PowerPC systems compile code for the
5317 processor in big endian mode.  The @samp{-mbig-endian} option is
5318 the same as @samp{-mbig}.
5320 @item -mcall-sysv
5321 On System V.4 and embedded PowerPC systems compile code using calling
5322 conventions that adheres to the March 1995 draft of the System V
5323 Application Binary Interface, PowerPC processor supplement.  This is the
5324 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
5326 @item -mcall-sysv-eabi
5327 Specify both @samp{-mcall-sysv} and @samp{-meabi} options.
5329 @item -mcall-sysv-noeabi
5330 Specify both @samp{-mcall-sysv} and @samp{-mno-eabi} options.
5332 @item -mcall-aix
5333 On System V.4 and embedded PowerPC systems compile code using calling
5334 conventions that are similar to those used on AIX.  This is the
5335 default if you configured GCC using @samp{powerpc-*-eabiaix}.
5337 @item -mcall-solaris
5338 On System V.4 and embedded PowerPC systems compile code for the Solaris
5339 operating system.
5341 @item -mcall-linux
5342 On System V.4 and embedded PowerPC systems compile code for the
5343 Linux-based GNU system.
5345 @item -mprototype
5346 @itemx -mno-prototype
5347 On System V.4 and embedded PowerPC systems assume that all calls to
5348 variable argument functions are properly prototyped.  Otherwise, the
5349 compiler must insert an instruction before every non prototyped call to
5350 set or clear bit 6 of the condition code register (@var{CR}) to
5351 indicate whether floating point values were passed in the floating point
5352 registers in case the function takes a variable arguments.  With
5353 @samp{-mprototype}, only calls to prototyped variable argument functions
5354 will set or clear the bit.
5356 @item -msim
5357 On embedded PowerPC systems, assume that the startup module is called
5358 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
5359 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
5360 configurations.
5362 @item -mmvme
5363 On embedded PowerPC systems, assume that the startup module is called
5364 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
5365 @file{libc.a}.
5367 @item -mads
5368 On embedded PowerPC systems, assume that the startup module is called
5369 @file{crt0.o} and the standard C libraries are @file{libads.a} and
5370 @file{libc.a}.
5372 @item -myellowknife
5373 On embedded PowerPC systems, assume that the startup module is called
5374 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
5375 @file{libc.a}.
5377 @item -memb
5378 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
5379 header to indicate that @samp{eabi} extended relocations are used.
5381 @item -meabi
5382 @itemx -mno-eabi
5383 On System V.4 and embedded PowerPC systems do (do not) adhere to the
5384 Embedded Applications Binary Interface (eabi) which is a set of
5385 modifications to the System V.4 specifications.  Selecting @code{-meabi}
5386 means that the stack is aligned to an 8 byte boundary, a function
5387 @code{__eabi} is called to from @code{main} to set up the eabi
5388 environment, and the @samp{-msdata} option can use both @code{r2} and
5389 @code{r13} to point to two separate small data areas.  Selecting
5390 @code{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
5391 do not call an initialization function from @code{main}, and the
5392 @samp{-msdata} option will only use @code{r13} to point to a single
5393 small data area.  The @samp{-meabi} option is on by default if you
5394 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
5396 @item -msdata=eabi
5397 On System V.4 and embedded PowerPC systems, put small initialized
5398 @code{const} global and static data in the @samp{.sdata2} section, which
5399 is pointed to by register @code{r2}.  Put small initialized
5400 non-@code{const} global and static data in the @samp{.sdata} section,
5401 which is pointed to by register @code{r13}.  Put small uninitialized
5402 global and static data in the @samp{.sbss} section, which is adjacent to
5403 the @samp{.sdata} section.  The @samp{-msdata=eabi} option is
5404 incompatible with the @samp{-mrelocatable} option.  The
5405 @samp{-msdata=eabi} option also sets the @samp{-memb} option.
5407 @item -msdata=sysv
5408 On System V.4 and embedded PowerPC systems, put small global and static
5409 data in the @samp{.sdata} section, which is pointed to by register
5410 @code{r13}.  Put small uninitialized global and static data in the
5411 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
5412 The @samp{-msdata=sysv} option is incompatible with the
5413 @samp{-mrelocatable} option.
5415 @item -msdata=default
5416 @itemx -msdata
5417 On System V.4 and embedded PowerPC systems, if @samp{-meabi} is used,
5418 compile code the same as @samp{-msdata=eabi}, otherwise compile code the
5419 same as @samp{-msdata=sysv}.
5421 @item -msdata-data
5422 On System V.4 and embedded PowerPC systems, put small global and static
5423 data in the @samp{.sdata} section.  Put small uninitialized global and
5424 static data in the @samp{.sbss} section.  Do not use register @code{r13}
5425 to address small data however.  This is the default behavior unless
5426 other @samp{-msdata} options are used.
5428 @item -msdata=none
5429 @itemx -mno-sdata
5430 On embedded PowerPC systems, put all initialized global and static data
5431 in the @samp{.data} section, and all uninitialized data in the
5432 @samp{.bss} section.
5434 @item -G @var{num}
5435 @cindex smaller data references (PowerPC)
5436 @cindex .sdata/.sdata2 references (PowerPC)
5437 On embedded PowerPC systems, put global and static items less than or
5438 equal to @var{num} bytes into the small data or bss sections instead of
5439 the normal data or bss section.  By default, @var{num} is 8.  The
5440 @samp{-G @var{num}} switch is also passed to the linker.
5441 All modules should be compiled with the same @samp{-G @var{num}} value.
5443 @item -mregnames
5444 @itemx -mno-regnames
5445 On System V.4 and embedded PowerPC systems do (do not) emit register
5446 names in the assembly language output using symbolic forms.
5448 @end table
5450 @node RT Options
5451 @subsection IBM RT Options
5452 @cindex RT options
5453 @cindex IBM RT options
5455 These @samp{-m} options are defined for the IBM RT PC:
5457 @table @code
5458 @item -min-line-mul
5459 Use an in-line code sequence for integer multiplies.  This is the
5460 default.
5462 @item -mcall-lib-mul
5463 Call @code{lmul$$} for integer multiples.
5465 @item -mfull-fp-blocks
5466 Generate full-size floating point data blocks, including the minimum
5467 amount of scratch space recommended by IBM.  This is the default.
5469 @item -mminimum-fp-blocks
5470 Do not include extra scratch space in floating point data blocks.  This
5471 results in smaller code, but slower execution, since scratch space must
5472 be allocated dynamically.
5474 @cindex @file{varargs.h} and RT PC
5475 @cindex @file{stdarg.h} and RT PC
5476 @item -mfp-arg-in-fpregs
5477 Use a calling sequence incompatible with the IBM calling convention in
5478 which floating point arguments are passed in floating point registers.
5479 Note that @code{varargs.h} and @code{stdargs.h} will not work with
5480 floating point operands if this option is specified.
5482 @item -mfp-arg-in-gregs
5483 Use the normal calling convention for floating point arguments.  This is
5484 the default.
5486 @item -mhc-struct-return
5487 Return structures of more than one word in memory, rather than in a
5488 register.  This provides compatibility with the MetaWare HighC (hc)
5489 compiler.  Use the option @samp{-fpcc-struct-return} for compatibility
5490 with the Portable C Compiler (pcc).
5492 @item -mnohc-struct-return
5493 Return some structures of more than one word in registers, when
5494 convenient.  This is the default.  For compatibility with the
5495 IBM-supplied compilers, use the option @samp{-fpcc-struct-return} or the
5496 option @samp{-mhc-struct-return}.
5497 @end table
5499 @node MIPS Options
5500 @subsection MIPS Options
5501 @cindex MIPS options
5503 These @samp{-m} options are defined for the MIPS family of computers:
5505 @table @code
5506 @item -mcpu=@var{cpu type}
5507 Assume the defaults for the machine type @var{cpu type} when scheduling
5508 instructions.  The choices for @var{cpu type} are @samp{r2000}, @samp{r3000},
5509 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
5510 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
5511 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
5512 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
5513 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.  While picking a specific
5514 @var{cpu type} will schedule things appropriately for that particular
5515 chip, the compiler will not generate any code that does not meet level 1
5516 of the MIPS ISA (instruction set architecture) without a @samp{-mipsX}
5517 or @samp{-mabi} switch being used.
5519 @item -mips1
5520 Issue instructions from level 1 of the MIPS ISA.  This is the default.
5521 @samp{r3000} is the default @var{cpu type} at this ISA level.
5523 @item -mips2
5524 Issue instructions from level 2 of the MIPS ISA (branch likely, square
5525 root instructions).  @samp{r6000} is the default @var{cpu type} at this
5526 ISA level.
5528 @item -mips3
5529 Issue instructions from level 3 of the MIPS ISA (64 bit instructions).
5530 @samp{r4000} is the default @var{cpu type} at this ISA level.
5532 @item -mips4
5533 Issue instructions from level 4 of the MIPS ISA (conditional move,
5534 prefetch, enhanced FPU instructions).  @samp{r8000} is the default
5535 @var{cpu type} at this ISA level.
5537 @item -mfp32
5538 Assume that 32 32-bit floating point registers are available.  This is
5539 the default.
5541 @item -mfp64
5542 Assume that 32 64-bit floating point registers are available.  This is
5543 the default when the @samp{-mips3} option is used.
5545 @item -mgp32
5546 Assume that 32 32-bit general purpose registers are available.  This is
5547 the default.
5549 @item -mgp64
5550 Assume that 32 64-bit general purpose registers are available.  This is
5551 the default when the @samp{-mips3} option is used.
5553 @item -mint64
5554 Force int and long types to be 64 bits wide.  See @samp{-mlong32} for an
5555 explanation of the default, and the width of pointers.
5557 @item -mlong64
5558 Force long types to be 64 bits wide.  See @samp{-mlong32} for an
5559 explanation of the default, and the width of pointers.
5561 @item -mlong32
5562 Force long, int, and pointer types to be 32 bits wide.
5564 If none of @samp{-mlong32}, @samp{-mlong64}, or @samp{-mint64} are set,
5565 the size of ints, longs, and pointers depends on the ABI and ISA choosen.
5566 For @samp{-mabi=32}, and @samp{-mabi=n32}, ints and longs are 32 bits
5567 wide.  For @samp{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
5568 For @samp{-mabi=eabi} and either @samp{-mips1} or @samp{-mips2}, ints
5569 and longs are 32 bits wide.  For @samp{-mabi=eabi} and higher ISAs, ints
5570 are 32 bits, and longs are 64 bits wide.  The width of pointer types is
5571 the smaller of the width of longs or the width of general purpose
5572 registers (which in turn depends on the ISA).
5574 @item -mabi=32
5575 @itemx -mabi=o64
5576 @itemx -mabi=n32
5577 @itemx -mabi=64
5578 @itemx -mabi=eabi
5579 Generate code for the indicated ABI.  The default instruction level is
5580 @samp{-mips1} for @samp{32}, @samp{-mips3} for @samp{n32}, and
5581 @samp{-mips4} otherwise.  Conversely, with @samp{-mips1} or
5582 @samp{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
5583 is @samp{64}.
5585 @item -mmips-as
5586 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
5587 add normal debug information.  This is the default for all
5588 platforms except for the OSF/1 reference platform, using the OSF/rose
5589 object format.  If the either of the @samp{-gstabs} or @samp{-gstabs+}
5590 switches are used, the @file{mips-tfile} program will encapsulate the
5591 stabs within MIPS ECOFF.
5593 @item -mgas
5594 Generate code for the GNU assembler.  This is the default on the OSF/1
5595 reference platform, using the OSF/rose object format.  Also, this is
5596 the default if the configure option @samp{--with-gnu-as} is used.
5598 @item -msplit-addresses
5599 @itemx -mno-split-addresses
5600 Generate code to load the high and low parts of address constants separately.
5601 This allows @code{gcc} to optimize away redundant loads of the high order
5602 bits of addresses.  This optimization requires GNU as and GNU ld.
5603 This optimization is enabled by default for some embedded targets where
5604 GNU as and GNU ld are standard.
5606 @item -mrnames
5607 @itemx -mno-rnames
5608 The @samp{-mrnames} switch says to output code using the MIPS software
5609 names for the registers, instead of the hardware names (ie, @var{a0}
5610 instead of @var{$4}).  The only known assembler that supports this option
5611 is the Algorithmics assembler.
5613 @item -mgpopt
5614 @itemx -mno-gpopt
5615 The @samp{-mgpopt} switch says to write all of the data declarations
5616 before the instructions in the text section, this allows the MIPS
5617 assembler to generate one word memory references instead of using two
5618 words for short global or static data items.  This is on by default if
5619 optimization is selected.
5621 @item -mstats
5622 @itemx -mno-stats
5623 For each non-inline function processed, the @samp{-mstats} switch
5624 causes the compiler to emit one line to the standard error file to
5625 print statistics about the program (number of registers saved, stack
5626 size, etc.).
5628 @item -mmemcpy
5629 @itemx -mno-memcpy
5630 The @samp{-mmemcpy} switch makes all block moves call the appropriate
5631 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
5632 generating inline code.
5634 @item -mmips-tfile
5635 @itemx -mno-mips-tfile
5636 The @samp{-mno-mips-tfile} switch causes the compiler not
5637 postprocess the object file with the @file{mips-tfile} program,
5638 after the MIPS assembler has generated it to add debug support.  If
5639 @file{mips-tfile} is not run, then no local variables will be
5640 available to the debugger.  In addition, @file{stage2} and
5641 @file{stage3} objects will have the temporary file names passed to the
5642 assembler embedded in the object file, which means the objects will
5643 not compare the same.  The @samp{-mno-mips-tfile} switch should only
5644 be used when there are bugs in the @file{mips-tfile} program that
5645 prevents compilation.
5647 @item -msoft-float
5648 Generate output containing library calls for floating point.
5649 @strong{Warning:} the requisite libraries are not part of GCC.
5650 Normally the facilities of the machine's usual C compiler are used, but
5651 this can't be done directly in cross-compilation.  You must make your
5652 own arrangements to provide suitable library functions for
5653 cross-compilation.
5655 @item -mhard-float
5656 Generate output containing floating point instructions.  This is the
5657 default if you use the unmodified sources.
5659 @item -mabicalls
5660 @itemx -mno-abicalls
5661 Emit (or do not emit) the pseudo operations @samp{.abicalls},
5662 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
5663 position independent code.
5665 @item -mlong-calls
5666 @itemx -mno-long-calls
5667 Do all calls with the @samp{JALR} instruction, which requires
5668 loading up a function's address into a register before the call.
5669 You need to use this switch, if you call outside of the current
5670 512 megabyte segment to functions that are not through pointers.
5672 @item -mhalf-pic
5673 @itemx -mno-half-pic
5674 Put pointers to extern references into the data section and load them
5675 up, rather than put the references in the text section.
5677 @item -membedded-pic
5678 @itemx -mno-embedded-pic
5679 Generate PIC code suitable for some embedded systems.  All calls are
5680 made using PC relative address, and all data is addressed using the $gp
5681 register.  No more than 65536 bytes of global data may be used.  This
5682 requires GNU as and GNU ld which do most of the work.  This currently
5683 only works on targets which use ECOFF; it does not work with ELF.
5685 @item -membedded-data
5686 @itemx -mno-embedded-data
5687 Allocate variables to the read-only data section first if possible, then
5688 next in the small data section if possible, otherwise in data.  This gives
5689 slightly slower code than the default, but reduces the amount of RAM required
5690 when executing, and thus may be preferred for some embedded systems.
5692 @item -muninit-const-in-rodata
5693 @itemx -mno-uninit-const-in-rodata
5694 When used together with -membedded-data, it will always store uninitialized
5695 const variables in the read-only data section.
5696   
5697 @item -msingle-float
5698 @itemx -mdouble-float
5699 The @samp{-msingle-float} switch tells gcc to assume that the floating
5700 point coprocessor only supports single precision operations, as on the
5701 @samp{r4650} chip.  The @samp{-mdouble-float} switch permits gcc to use
5702 double precision operations.  This is the default.
5704 @item -mmad
5705 @itemx -mno-mad
5706 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
5707 as on the @samp{r4650} chip.
5709 @item -m4650
5710 Turns on @samp{-msingle-float}, @samp{-mmad}, and, at least for now,
5711 @samp{-mcpu=r4650}.
5713 @item -mips16
5714 @itemx -mno-mips16
5715 Enable 16-bit instructions.
5717 @item -mentry
5718 Use the entry and exit pseudo ops.  This option can only be used with
5719 @samp{-mips16}.
5721 @item -EL
5722 Compile code for the processor in little endian mode.
5723 The requisite libraries are assumed to exist.
5725 @item -EB
5726 Compile code for the processor in big endian mode.
5727 The requisite libraries are assumed to exist.
5729 @item -G @var{num}
5730 @cindex smaller data references (MIPS)
5731 @cindex gp-relative references (MIPS)
5732 Put global and static items less than or equal to @var{num} bytes into
5733 the small data or bss sections instead of the normal data or bss
5734 section.  This allows the assembler to emit one word memory reference
5735 instructions based on the global pointer (@var{gp} or @var{$28}),
5736 instead of the normal two words used.  By default, @var{num} is 8 when
5737 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
5738 @samp{-G @var{num}} switch is also passed to the assembler and linker.
5739 All modules should be compiled with the same @samp{-G @var{num}}
5740 value.
5742 @item -nocpp
5743 Tell the MIPS assembler to not run its preprocessor over user
5744 assembler files (with a @samp{.s} suffix) when assembling them.
5746 @item -no-crt0
5747 Do not include the default crt0.
5748 @end table
5750 @ifset INTERNALS
5751 These options are defined by the macro
5752 @code{TARGET_SWITCHES} in the machine description.  The default for the
5753 options is also defined by that macro, which enables you to change the
5754 defaults.
5755 @end ifset
5757 @node i386 Options
5758 @subsection Intel 386 Options
5759 @cindex i386 Options
5760 @cindex Intel 386 Options
5762 These @samp{-m} options are defined for the i386 family of computers:
5764 @table @code
5765 @item -mcpu=@var{cpu type}
5766 Assume the defaults for the machine type @var{cpu type} when scheduling
5767 instructions.  The choices for @var{cpu type} are:
5769 @multitable @columnfractions .20 .20 .20 .20
5770 @item @samp{i386} @tab @samp{i486} @tab @samp{i586} @tab @samp{i686}
5771 @item @samp{pentium} @tab @samp{pentiumpro} @tab @samp{k6}
5772 @end multitable
5774 While picking a specific @var{cpu type} will schedule things appropriately
5775 for that particular chip, the compiler will not generate any code that
5776 does not run on the i386 without the @samp{-march=@var{cpu type}} option
5777 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
5778 is equivalent to @samp{pentiumpro}.  @samp{k6} is the AMD chip as
5779 opposed to the Intel ones.
5781 @item -march=@var{cpu type}
5782 Generate instructions for the machine type @var{cpu type}.  The choices
5783 for @var{cpu type} are the same as for @samp{-mcpu}.  Moreover, 
5784 specifying @samp{-march=@var{cpu type}} implies @samp{-mcpu=@var{cpu type}}.
5786 @item -m386
5787 @itemx -m486
5788 @itemx -mpentium
5789 @itemx -mpentiumpro
5790 Synonyms for -mcpu=i386, -mcpu=i486, -mcpu=pentium, and -mcpu=pentiumpro
5791 respectively.  These synonyms are deprecated.
5793 @item -mieee-fp
5794 @itemx -mno-ieee-fp
5795 Control whether or not the compiler uses IEEE floating point
5796 comparisons.  These handle correctly the case where the result of a
5797 comparison is unordered.
5799 @item -msoft-float
5800 Generate output containing library calls for floating point.
5801 @strong{Warning:} the requisite libraries are not part of GCC.
5802 Normally the facilities of the machine's usual C compiler are used, but
5803 this can't be done directly in cross-compilation.  You must make your
5804 own arrangements to provide suitable library functions for
5805 cross-compilation.
5807 On machines where a function returns floating point results in the 80387
5808 register stack, some floating point opcodes may be emitted even if
5809 @samp{-msoft-float} is used.
5811 @item -mno-fp-ret-in-387
5812 Do not use the FPU registers for return values of functions.
5814 The usual calling convention has functions return values of types
5815 @code{float} and @code{double} in an FPU register, even if there
5816 is no FPU.  The idea is that the operating system should emulate
5817 an FPU.
5819 The option @samp{-mno-fp-ret-in-387} causes such values to be returned
5820 in ordinary CPU registers instead.
5822 @item -mno-fancy-math-387
5823 Some 387 emulators do not support the @code{sin}, @code{cos} and
5824 @code{sqrt} instructions for the 387.  Specify this option to avoid
5825 generating those instructions. This option is the default on FreeBSD.
5826 As of revision 2.6.1, these instructions are not generated unless you
5827 also use the @samp{-ffast-math} switch.
5829 @item -malign-double
5830 @itemx -mno-align-double
5831 Control whether GCC aligns @code{double}, @code{long double}, and
5832 @code{long long} variables on a two word boundary or a one word
5833 boundary.  Aligning @code{double} variables on a two word boundary will
5834 produce code that runs somewhat faster on a @samp{Pentium} at the
5835 expense of more memory.
5837 @strong{Warning:} if you use the @samp{-malign-double} switch,
5838 structures containing the above types will be aligned differently than
5839 the published application binary interface specifications for the 386.
5841 @item -msvr3-shlib
5842 @itemx -mno-svr3-shlib
5843 Control whether GCC places uninitialized locals into @code{bss} or
5844 @code{data}.  @samp{-msvr3-shlib} places these locals into @code{bss}.
5845 These options are meaningful only on System V Release 3.
5847 @item -mno-wide-multiply
5848 @itemx -mwide-multiply
5849 Control whether GCC uses the @code{mul} and @code{imul} that produce
5850 64 bit results in @code{eax:edx} from 32 bit operands to do @code{long
5851 long} multiplies and 32-bit division by constants.
5853 @item -mrtd
5854 Use a different function-calling convention, in which functions that
5855 take a fixed number of arguments return with the @code{ret} @var{num}
5856 instruction, which pops their arguments while returning.  This saves one
5857 instruction in the caller since there is no need to pop the arguments
5858 there.
5860 You can specify that an individual function is called with this calling
5861 sequence with the function attribute @samp{stdcall}.  You can also
5862 override the @samp{-mrtd} option by using the function attribute
5863 @samp{cdecl}.  @xref{Function Attributes}.
5865 @strong{Warning:} this calling convention is incompatible with the one
5866 normally used on Unix, so you cannot use it if you need to call
5867 libraries compiled with the Unix compiler.
5869 Also, you must provide function prototypes for all functions that
5870 take variable numbers of arguments (including @code{printf});
5871 otherwise incorrect code will be generated for calls to those
5872 functions.
5874 In addition, seriously incorrect code will result if you call a
5875 function with too many arguments.  (Normally, extra arguments are
5876 harmlessly ignored.)
5878 @item -mreg-alloc=@var{regs}
5879 Control the default allocation order of integer registers.  The
5880 string @var{regs} is a series of letters specifying a register.  The
5881 supported letters are: @code{a} allocate EAX; @code{b} allocate EBX;
5882 @code{c} allocate ECX; @code{d} allocate EDX; @code{S} allocate ESI;
5883 @code{D} allocate EDI; @code{B} allocate EBP.
5885 @item -mregparm=@var{num}
5886 Control how many registers are used to pass integer arguments.  By
5887 default, no registers are used to pass arguments, and at most 3
5888 registers can be used.  You can control this behavior for a specific
5889 function by using the function attribute @samp{regparm}.
5890 @xref{Function Attributes}.
5892 @strong{Warning:} if you use this switch, and
5893 @var{num} is nonzero, then you must build all modules with the same
5894 value, including any libraries.  This includes the system libraries and
5895 startup modules.
5897 @item -malign-loops=@var{num}
5898 Align loops to a 2 raised to a @var{num} byte boundary.  If
5899 @samp{-malign-loops} is not specified, the default is 2 unless
5900 gas 2.8 (or later) is being used in which case the default is
5901 to align the loop on a 16 byte boundary if it is less than 8
5902 bytes away.
5904 @item -malign-jumps=@var{num}
5905 Align instructions that are only jumped to to a 2 raised to a @var{num}
5906 byte boundary.  If @samp{-malign-jumps} is not specified, the default is
5907 2 if optimizing for a 386, and 4 if optimizing for a 486 unless
5908 gas 2.8 (or later) is being used in which case the default is
5909 to align the instruction on a 16 byte boundary if it is less
5910 than 8 bytes away.
5912 @item -malign-functions=@var{num}
5913 Align the start of functions to a 2 raised to @var{num} byte boundary.
5914 If @samp{-malign-functions} is not specified, the default is 2 if optimizing
5915 for a 386, and 4 if optimizing for a 486.
5917 @item -mpreferred-stack-boundary=@var{num}
5918 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
5919 byte boundary.  If @samp{-mpreferred-stack-boundary} is not specified,
5920 the default is 4 (16 bytes or 128 bits).
5922 The stack is required to be aligned on a 4 byte boundary.  On Pentium
5923 and PentiumPro, @code{double} and @code{long double} values should be
5924 aligned to an 8 byte boundary (see @samp{-malign-double}) or suffer
5925 significant run time performance penalties.  On Pentium III, the
5926 Streaming SIMD Extention (SSE) data type @code{__m128} suffers similar
5927 penalties if it is not 16 byte aligned.
5929 To ensure proper alignment of this values on the stack, the stack boundary
5930 must be as aligned as that required by any value stored on the stack. 
5931 Further, every function must be generated such that it keeps the stack
5932 aligned.  Thus calling a function compiled with a higher preferred
5933 stack boundary from a function compiled with a lower preferred stack
5934 boundary will most likely misalign the stack.  It is recommended that
5935 libraries that use callbacks always use the default setting.
5937 This extra alignment does consume extra stack space.  Code that is sensitive
5938 to stack space usage, such as embedded systems and operating system kernels,
5939 may want to reduce the preferred alignment to
5940 @samp{-mpreferred-stack-boundary=2}.
5941 @end table
5943 @node HPPA Options
5944 @subsection HPPA Options
5945 @cindex HPPA Options
5947 These @samp{-m} options are defined for the HPPA family of computers:
5949 @table @code
5950 @item -march=@var{architecture type}
5951 Generate code for the specified architecture.  The choices for
5952 @var{architecture type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
5953 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
5954 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
5955 architecture option for your machine.  Code compiled for lower numbered
5956 architectures will run on higher numbered architectures, but not the
5957 other way around.
5959 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
5960 next release of binutils (current is 2.9.1) will probably contain PA 2.0
5961 support.  
5963 @item -mpa-risc-1-0
5964 @itemx -mpa-risc-1-1
5965 @itemx -mpa-risc-2-0
5966 Synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively.
5968 @item -mbig-switch
5969 Generate code suitable for big switch tables.  Use this option only if
5970 the assembler/linker complain about out of range branches within a switch
5971 table.
5973 @item -mjump-in-delay
5974 Fill delay slots of function calls with unconditional jump instructions
5975 by modifying the return pointer for the function call to be the target
5976 of the conditional jump.
5978 @item -mdisable-fpregs
5979 Prevent floating point registers from being used in any manner.  This is
5980 necessary for compiling kernels which perform lazy context switching of
5981 floating point registers.  If you use this option and attempt to perform
5982 floating point operations, the compiler will abort.
5984 @item -mdisable-indexing
5985 Prevent the compiler from using indexing address modes.  This avoids some
5986 rather obscure problems when compiling MIG generated code under MACH.
5988 @item -mno-space-regs
5989 Generate code that assumes the target has no space registers.  This allows
5990 GCC to generate faster indirect calls and use unscaled index address modes.
5992 Such code is suitable for level 0 PA systems and kernels.
5994 @item -mfast-indirect-calls
5995 Generate code that assumes calls never cross space boundaries.  This
5996 allows GCC to emit code which performs faster indirect calls.
5998 This option will not work in the presense of shared libraries or nested
5999 functions.
6001 @item -mlong-load-store
6002 Generate 3-instruction load and store sequences as sometimes required by
6003 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
6004 the HP compilers.
6006 @item -mportable-runtime
6007 Use the portable calling conventions proposed by HP for ELF systems.
6009 @item -mgas
6010 Enable the use of assembler directives only GAS understands.
6012 @item -mschedule=@var{cpu type}
6013 Schedule code according to the constraints for the machine type
6014 @var{cpu type}.  The choices for @var{cpu type} are @samp{700} 
6015 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}.  Refer to 
6016 @file{/usr/lib/sched.models} on an HP-UX system to determine the
6017 proper scheduling option for your machine.
6019 @item -mlinker-opt
6020 Enable the optimization pass in the HPUX linker.  Note this makes symbolic
6021 debugging impossible.  It also triggers a bug in the HPUX 8 and HPUX 9 linkers
6022 in which they give bogus error messages when linking some programs.
6024 @item -msoft-float
6025 Generate output containing library calls for floating point.
6026 @strong{Warning:} the requisite libraries are not available for all HPPA
6027 targets.  Normally the facilities of the machine's usual C compiler are
6028 used, but this cannot be done directly in cross-compilation.  You must make
6029 your own arrangements to provide suitable library functions for
6030 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
6031 does provide software floating point support.
6033 @samp{-msoft-float} changes the calling convention in the output file;
6034 therefore, it is only useful if you compile @emph{all} of a program with
6035 this option.  In particular, you need to compile @file{libgcc.a}, the
6036 library that comes with GCC, with @samp{-msoft-float} in order for
6037 this to work.
6038 @end table
6040 @node Intel 960 Options
6041 @subsection Intel 960 Options
6043 These @samp{-m} options are defined for the Intel 960 implementations:
6045 @table @code
6046 @item -m@var{cpu type}
6047 Assume the defaults for the machine type @var{cpu type} for some of
6048 the other options, including instruction scheduling, floating point
6049 support, and addressing modes.  The choices for @var{cpu type} are
6050 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
6051 @samp{sa}, and @samp{sb}.
6052 The default is
6053 @samp{kb}.
6055 @item -mnumerics
6056 @itemx -msoft-float
6057 The @samp{-mnumerics} option indicates that the processor does support
6058 floating-point instructions.  The @samp{-msoft-float} option indicates
6059 that floating-point support should not be assumed.
6061 @item -mleaf-procedures
6062 @itemx -mno-leaf-procedures
6063 Do (or do not) attempt to alter leaf procedures to be callable with the
6064 @code{bal} instruction as well as @code{call}.  This will result in more
6065 efficient code for explicit calls when the @code{bal} instruction can be
6066 substituted by the assembler or linker, but less efficient code in other
6067 cases, such as calls via function pointers, or using a linker that doesn't
6068 support this optimization.
6070 @item -mtail-call
6071 @itemx -mno-tail-call
6072 Do (or do not) make additional attempts (beyond those of the
6073 machine-independent portions of the compiler) to optimize tail-recursive
6074 calls into branches.  You may not want to do this because the detection of
6075 cases where this is not valid is not totally complete.  The default is
6076 @samp{-mno-tail-call}.
6078 @item -mcomplex-addr
6079 @itemx -mno-complex-addr
6080 Assume (or do not assume) that the use of a complex addressing mode is a
6081 win on this implementation of the i960.  Complex addressing modes may not
6082 be worthwhile on the K-series, but they definitely are on the C-series.
6083 The default is currently @samp{-mcomplex-addr} for all processors except
6084 the CB and CC.
6086 @item -mcode-align
6087 @itemx -mno-code-align
6088 Align code to 8-byte boundaries for faster fetching (or don't bother).
6089 Currently turned on by default for C-series implementations only.
6091 @ignore
6092 @item -mclean-linkage
6093 @itemx -mno-clean-linkage
6094 These options are not fully implemented.
6095 @end ignore
6097 @item -mic-compat
6098 @itemx -mic2.0-compat
6099 @itemx -mic3.0-compat
6100 Enable compatibility with iC960 v2.0 or v3.0.
6102 @item -masm-compat
6103 @itemx -mintel-asm
6104 Enable compatibility with the iC960 assembler.
6106 @item -mstrict-align
6107 @itemx -mno-strict-align
6108 Do not permit (do permit) unaligned accesses.
6110 @item -mold-align
6111 Enable structure-alignment compatibility with Intel's gcc release version
6112 1.3 (based on gcc 1.37).  This option implies @samp{-mstrict-align}.
6114 @item -mlong-double-64
6115 Implement type @samp{long double} as 64-bit floating point numbers.
6116 Without the option @samp{long double} is implemented by 80-bit
6117 floating point numbers.  The only reason we have it because there is
6118 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
6119 is only useful for people using soft-float targets.  Otherwise, we
6120 should recommend against use of it.
6122 @end table
6124 @node DEC Alpha Options
6125 @subsection DEC Alpha Options
6127 These @samp{-m} options are defined for the DEC Alpha implementations:
6129 @table @code
6130 @item -mno-soft-float
6131 @itemx -msoft-float
6132 Use (do not use) the hardware floating-point instructions for
6133 floating-point operations.  When @code{-msoft-float} is specified,
6134 functions in @file{libgcc1.c} will be used to perform floating-point
6135 operations.  Unless they are replaced by routines that emulate the
6136 floating-point operations, or compiled in such a way as to call such
6137 emulations routines, these routines will issue floating-point
6138 operations.   If you are compiling for an Alpha without floating-point
6139 operations, you must ensure that the library is built so as not to call
6140 them.
6142 Note that Alpha implementations without floating-point operations are
6143 required to have floating-point registers.
6145 @item -mfp-reg
6146 @itemx -mno-fp-regs
6147 Generate code that uses (does not use) the floating-point register set.
6148 @code{-mno-fp-regs} implies @code{-msoft-float}.  If the floating-point
6149 register set is not used, floating point operands are passed in integer
6150 registers as if they were integers and floating-point results are passed
6151 in $0 instead of $f0.  This is a non-standard calling sequence, so any
6152 function with a floating-point argument or return value called by code
6153 compiled with @code{-mno-fp-regs} must also be compiled with that
6154 option.
6156 A typical use of this option is building a kernel that does not use,
6157 and hence need not save and restore, any floating-point registers.
6159 @item -mieee
6160 The Alpha architecture implements floating-point hardware optimized for
6161 maximum performance.  It is mostly compliant with the IEEE floating
6162 point standard.  However, for full compliance, software assistance is
6163 required.  This option generates code fully IEEE compliant code
6164 @emph{except} that the @var{inexact flag} is not maintained (see below).
6165 If this option is turned on, the CPP macro @code{_IEEE_FP} is defined
6166 during compilation.  The option is a shorthand for: @samp{-D_IEEE_FP
6167 -mfp-trap-mode=su -mtrap-precision=i -mieee-conformant}.  The resulting
6168 code is less efficient but is able to correctly support denormalized
6169 numbers and exceptional IEEE values such as not-a-number and plus/minus
6170 infinity.  Other Alpha compilers call this option
6171 @code{-ieee_with_no_inexact}.
6173 @item -mieee-with-inexact
6174 @c overfull hbox here --bob 22 jul96
6175 @c original text between ignore ... end ignore
6176 @ignore
6177 This is like @samp{-mieee} except the generated code also maintains the
6178 IEEE @var{inexact flag}.  Turning on this option causes the generated
6179 code to implement fully-compliant IEEE math.  The option is a shorthand
6180 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus @samp{-mieee-conformant},
6181 @samp{-mfp-trap-mode=sui}, and @samp{-mtrap-precision=i}.  On some Alpha
6182 implementations the resulting code may execute significantly slower than
6183 the code generated by default.  Since there is very little code that
6184 depends on the @var{inexact flag}, you should normally not specify this
6185 option.  Other Alpha compilers call this option
6186 @samp{-ieee_with_inexact}.
6187 @end ignore
6188 @c            changed paragraph
6189 This is like @samp{-mieee} except the generated code also maintains the
6190 IEEE @var{inexact flag}.  Turning on this option causes the generated
6191 code to implement fully-compliant IEEE math.  The option is a shorthand
6192 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus the three following:
6193 @samp{-mieee-conformant},
6194 @samp{-mfp-trap-mode=sui}, 
6195 and @samp{-mtrap-precision=i}.  
6196 On some Alpha implementations the resulting code may execute
6197 significantly slower than the code generated by default.  Since there
6198 is very little code that depends on the @var{inexact flag}, you should
6199 normally not specify this option.  Other Alpha compilers call this
6200 option @samp{-ieee_with_inexact}.
6201 @c             end changes to prevent overfull hboxes
6203 @item -mfp-trap-mode=@var{trap mode}
6204 This option controls what floating-point related traps are enabled.
6205 Other Alpha compilers call this option @samp{-fptm }@var{trap mode}.
6206 The trap mode can be set to one of four values:
6208 @table @samp
6209 @item n
6210 This is the default (normal) setting.  The only traps that are enabled
6211 are the ones that cannot be disabled in software (e.g., division by zero
6212 trap).
6214 @item u
6215 In addition to the traps enabled by @samp{n}, underflow traps are enabled
6216 as well.
6218 @item su
6219 Like @samp{su}, but the instructions are marked to be safe for software
6220 completion (see Alpha architecture manual for details).
6222 @item sui
6223 Like @samp{su}, but inexact traps are enabled as well.
6224 @end table
6226 @item -mfp-rounding-mode=@var{rounding mode}
6227 Selects the IEEE rounding mode.  Other Alpha compilers call this option
6228 @samp{-fprm }@var{rounding mode}.  The @var{rounding mode} can be one
6231 @table @samp
6232 @item n
6233 Normal IEEE rounding mode.  Floating point numbers are rounded towards
6234 the nearest machine number or towards the even machine number in case
6235 of a tie.
6237 @item m
6238 Round towards minus infinity.
6240 @item c
6241 Chopped rounding mode.  Floating point numbers are rounded towards zero.
6243 @item d
6244 Dynamic rounding mode.  A field in the floating point control register
6245 (@var{fpcr}, see Alpha architecture reference manual) controls the
6246 rounding mode in effect.  The C library initializes this register for
6247 rounding towards plus infinity.  Thus, unless your program modifies the
6248 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
6249 @end table
6251 @item -mtrap-precision=@var{trap precision}
6252 In the Alpha architecture, floating point traps are imprecise.  This
6253 means without software assistance it is impossible to recover from a
6254 floating trap and program execution normally needs to be terminated.
6255 GCC can generate code that can assist operating system trap handlers
6256 in determining the exact location that caused a floating point trap.
6257 Depending on the requirements of an application, different levels of
6258 precisions can be selected:
6260 @table @samp
6261 @item p
6262 Program precision.  This option is the default and means a trap handler
6263 can only identify which program caused a floating point exception.
6265 @item f
6266 Function precision.  The trap handler can determine the function that
6267 caused a floating point exception.
6269 @item i
6270 Instruction precision.  The trap handler can determine the exact
6271 instruction that caused a floating point exception.
6272 @end table
6274 Other Alpha compilers provide the equivalent options called
6275 @samp{-scope_safe} and @samp{-resumption_safe}.
6277 @item -mieee-conformant
6278 This option marks the generated code as IEEE conformant.  You must not
6279 use this option unless you also specify @samp{-mtrap-precision=i} and either
6280 @samp{-mfp-trap-mode=su} or @samp{-mfp-trap-mode=sui}.  Its only effect
6281 is to emit the line @samp{.eflag 48} in the function prologue of the
6282 generated assembly file.  Under DEC Unix, this has the effect that
6283 IEEE-conformant math library routines will be linked in.
6285 @item -mbuild-constants
6286 Normally GCC examines a 32- or 64-bit integer constant to
6287 see if it can construct it from smaller constants in two or three
6288 instructions.  If it cannot, it will output the constant as a literal and
6289 generate code to load it from the data segment at runtime.
6291 Use this option to require GCC to construct @emph{all} integer constants
6292 using code, even if it takes more instructions (the maximum is six).
6294 You would typically use this option to build a shared library dynamic
6295 loader.  Itself a shared library, it must relocate itself in memory
6296 before it can find the variables and constants in its own data segment.
6298 @item -malpha-as
6299 @itemx -mgas
6300 Select whether to generate code to be assembled by the vendor-supplied
6301 assembler (@samp{-malpha-as}) or by the GNU assembler @samp{-mgas}.
6303 @item -mbwx
6304 @itemx -mno-bwx
6305 @itemx -mcix
6306 @itemx -mno-cix
6307 @itemx -mmax
6308 @itemx -mno-max
6309 Indicate whether GCC should generate code to use the optional BWX,
6310 CIX, and MAX instruction sets.  The default is to use the instruction sets
6311 supported by the CPU type specified via @samp{-mcpu=} option or that
6312 of the CPU on which GCC was built if none was specified.
6314 @item -mcpu=@var{cpu_type}
6315 Set the instruction set, register set, and instruction scheduling
6316 parameters for machine type @var{cpu_type}.  You can specify either the
6317 @samp{EV} style name or the corresponding chip number.  GCC
6318 supports scheduling parameters for the EV4 and EV5 family of processors
6319 and will choose the default values for the instruction set from
6320 the processor you specify.  If you do not specify a processor type,
6321 GCC will default to the processor on which the compiler was built.
6323 Supported values for @var{cpu_type} are
6325 @table @samp
6326 @item ev4
6327 @itemx 21064
6328 Schedules as an EV4 and has no instruction set extensions.
6330 @item ev5
6331 @itemx 21164
6332 Schedules as an EV5 and has no instruction set extensions.
6334 @item ev56
6335 @itemx 21164a
6336 Schedules as an EV5 and supports the BWX extension.
6338 @item pca56
6339 @itemx 21164pc
6340 @itemx 21164PC
6341 Schedules as an EV5 and supports the BWX and MAX extensions.
6343 @item ev6
6344 @itemx 21264
6345 Schedules as an EV5 (until Digital releases the scheduling parameters
6346 for the EV6) and supports the BWX, CIX, and MAX extensions.
6347 @end table
6349 @item -mmemory-latency=@var{time}
6350 Sets the latency the scheduler should assume for typical memory
6351 references as seen by the application.  This number is highly
6352 dependant on the memory access patterns used by the application
6353 and the size of the external cache on the machine.
6355 Valid options for @var{time} are
6357 @table @samp
6358 @item @var{number}
6359 A decimal number representing clock cycles.
6361 @item L1
6362 @itemx L2
6363 @itemx L3
6364 @itemx main
6365 The compiler contains estimates of the number of clock cycles for
6366 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
6367 (also called Dcache, Scache, and Bcache), as well as to main memory.
6368 Note that L3 is only valid for EV5.
6370 @end table
6371 @end table
6373 @node Clipper Options
6374 @subsection Clipper Options
6376 These @samp{-m} options are defined for the Clipper implementations:
6378 @table @code
6379 @item -mc300
6380 Produce code for a C300 Clipper processor. This is the default.
6382 @item -mc400
6383 Produce code for a C400 Clipper processor i.e. use floating point
6384 registers f8..f15.
6385 @end table
6387 @node H8/300 Options
6388 @subsection H8/300 Options
6390 These @samp{-m} options are defined for the H8/300 implementations:
6392 @table @code
6393 @item -mrelax
6394 Shorten some address references at link time, when possible; uses the
6395 linker option @samp{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
6396 ld.info, Using ld}, for a fuller description.
6398 @item -mh
6399 Generate code for the H8/300H.
6401 @item -ms
6402 Generate code for the H8/S.
6404 @item -mint32
6405 Make @code{int} data 32 bits by default.
6407 @item -malign-300
6408 On the h8/300h, use the same alignment rules as for the h8/300.
6409 The default for the h8/300h is to align longs and floats on 4 byte boundaries.
6410 @samp{-malign-300} causes them to be aligned on 2 byte boundaries.
6411 This option has no effect on the h8/300.
6412 @end table
6414 @node SH Options
6415 @subsection SH Options
6417 These @samp{-m} options are defined for the SH implementations:
6419 @table @code
6420 @item -m1
6421 Generate code for the SH1.
6423 @item -m2
6424 Generate code for the SH2.
6426 @item -m3
6427 Generate code for the SH3.
6429 @item -m3e
6430 Generate code for the SH3e.
6432 @item -mb
6433 Compile code for the processor in big endian mode.
6435 @item -ml
6436 Compile code for the processor in little endian mode.
6438 @item -mdalign
6439 Align doubles at 64 bit boundaries.  Note that this changes the calling
6440 conventions, and thus some functions from the standard C library will
6441 not work unless you recompile it first with -mdalign.
6443 @item -mrelax
6444 Shorten some address references at link time, when possible; uses the
6445 linker option @samp{-relax}.
6446 @end table
6448 @node System V Options
6449 @subsection Options for System V
6451 These additional options are available on System V Release 4 for
6452 compatibility with other compilers on those systems:
6454 @table @code
6455 @item -G
6456 Create a shared object.
6457 It is recommended that @samp{-symbolic} or @samp{-shared} be used instead.
6459 @item -Qy
6460 Identify the versions of each tool used by the compiler, in a
6461 @code{.ident} assembler directive in the output.
6463 @item -Qn
6464 Refrain from adding @code{.ident} directives to the output file (this is
6465 the default).
6467 @item -YP,@var{dirs}
6468 Search the directories @var{dirs}, and no others, for libraries
6469 specified with @samp{-l}.
6471 @item -Ym,@var{dir}
6472 Look in the directory @var{dir} to find the M4 preprocessor.
6473 The assembler uses this option.
6474 @c This is supposed to go with a -Yd for predefined M4 macro files, but
6475 @c the generic assembler that comes with Solaris takes just -Ym.
6476 @end table
6478 @node TMS320C3x/C4x Options
6479 @subsection TMS320C3x/C4x Options
6480 @cindex TMS320C3x/C4x Options
6482 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
6484 @table @code
6486 @item -mcpu=@var{cpu_type}
6487 Set the instruction set, register set, and instruction scheduling
6488 parameters for machine type @var{cpu_type}.  Supported values for
6489 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
6490 @samp{c44}.  The default is @samp{c40} to generate code for the
6491 TMS320C40.
6493 @item -mbig-memory
6494 @item -mbig
6495 @itemx -msmall-memory
6496 @itemx -msmall
6497 Generates code for the big or small memory model.  The small memory
6498 model assumed that all data fits into one 64K word page.  At run-time
6499 the data page (DP) register must be set to point to the 64K page
6500 containing the .bss and .data program sections.  The big memory model is
6501 the default and requires reloading of the DP register for every direct
6502 memory access.
6504 @item -mbk
6505 @itemx -mno-bk
6506 Allow (disallow) allocation of general integer operands into the block
6507 count register BK. 
6509 @item -mdb
6510 @itemx -mno-db
6511 Enable (disable) generation of code using decrement and branch,
6512 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
6513 on the safe side, this is disabled for the C3x, since the maximum
6514 iteration count on the C3x is 2^23 + 1 (but who iterates loops more than
6515 2^23 times on the C3x?).  Note that GCC will try to reverse a loop so
6516 that it can utilise the decrement and branch instruction, but will give
6517 up if there is more than one memory reference in the loop.  Thus a loop
6518 where the loop counter is decremented can generate slightly more
6519 efficient code, in cases where the RPTB instruction cannot be utilised.
6521 @item -mdp-isr-reload
6522 @itemx -mparanoid
6523 Force the DP register to be saved on entry to an interrupt service
6524 routine (ISR), reloaded to point to the data section, and restored on
6525 exit from the ISR.  This should not be required unless someone has
6526 violated the small memory model by modifying the DP register, say within
6527 an object library.
6529 @item -mmpyi
6530 @itemx -mno-mpyi
6531 For the C3x use the 24-bit MPYI instruction for integer multiplies
6532 instead of a library call to guarantee 32-bit results.  Note that if one
6533 of the operands is a constant, then the multiplication will be performed
6534 using shifts and adds.  If the -mmpyi option is not specified for the C3x,
6535 then squaring operations are performed inline instead of a library call.
6537 @item -mfast-fix
6538 @itemx -mno-fast-fix
6539 The C3x/C4x FIX instruction to convert a floating point value to an
6540 integer value chooses the nearest integer less than or equal to the
6541 floating point value rather than to the nearest integer.  Thus if the
6542 floating point number is negative, the result will be incorrectly
6543 truncated an additional code is necessary to detect and correct this
6544 case.  This option can be used to disable generation of the additional
6545 code required to correct the result.
6547 @item -mrptb
6548 @itemx -mno-rptb
6549 Enable (disable) generation of repeat block sequences using the RPTB
6550 instruction for zero overhead looping.  The RPTB construct is only used
6551 for innermost loops that do not call functions or jump across the loop
6552 boundaries.  There is no advantage having nested RPTB loops due to the
6553 overhead required to save and restore the RC, RS, and RE registers.
6554 This is enabled by default with -O2.
6556 @item -mrpts=@var{count}
6557 @itemx -mno-rpts
6558 Enable (disable) the use of the single instruction repeat instruction
6559 RPTS.  If a repeat block contains a single instruction, and the loop
6560 count can be guaranteed to be less than the value @var{count}, GCC will
6561 emit a RPTS instruction instead of a RPTB.  If no value is specified,
6562 then a RPTS will be emitted even if the loop count cannot be determined
6563 at compile time.  Note that the repeated instruction following RPTS does
6564 not have to be reloaded from memory each iteration, thus freeing up the
6565 CPU buses for oeprands.  However, since interrupts are blocked by this
6566 instruction, it is disabled by default.
6568 @item -mloop-unsigned
6569 @itemx -mno-loop-unsigned
6570 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
6571 is 2^31 + 1 since these instructions test if the iteration count is
6572 negative to terminate the loop.  If the iteration count is unsigned
6573 there is a possibility than the 2^31 + 1 maximum iteration count may be
6574 exceeded.  This switch allows an unsigned iteration count.
6576 @item -mti
6577 Try to emit an assembler syntax that the TI assembler (asm30) is happy
6578 with.  This also enforces compatibility with the API employed by the TI
6579 C3x C compiler.  For example, long doubles are passed as structures
6580 rather than in floating point registers.
6582 @item -mregparm
6583 @itemx -mmemparm
6584 Generate code that uses registers (stack) for passing arguments to functions.
6585 By default, arguments are passed in registers where possible rather
6586 than by pushing arguments on to the stack.
6588 @item -mparallel-insns
6589 @itemx -mno-parallel-insns
6590 Allow the generation of parallel instructions.  This is enabled by
6591 default with -O2.
6593 @item -mparallel-mpy
6594 @itemx -mno-parallel-mpy
6595 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
6596 provided -mparallel-insns is also specified.  These instructions have
6597 tight register constraints which can pessimize the code generation
6598 of large functions.
6600 @end table
6602 @node V850 Options
6603 @subsection V850 Options
6604 @cindex V850 Options
6606 These @samp{-m} options are defined for V850 implementations:
6608 @table @code
6609 @item -mlong-calls
6610 @itemx -mno-long-calls
6611 Treat all calls as being far away (near).  If calls are assumed to be
6612 far away, the compiler will always load the functions address up into a
6613 register, and call indirect through the pointer.
6615 @item -mno-ep
6616 @itemx -mep
6617 Do not optimize (do optimize) basic blocks that use the same index
6618 pointer 4 or more times to copy pointer into the @code{ep} register, and
6619 use the shorter @code{sld} and @code{sst} instructions.  The @samp{-mep}
6620 option is on by default if you optimize.
6622 @item -mno-prolog-function
6623 @itemx -mprolog-function
6624 Do not use (do use) external functions to save and restore registers at
6625 the prolog and epilog of a function.  The external functions are slower,
6626 but use less code space if more than one function saves the same number
6627 of registers.  The @samp{-mprolog-function} option is on by default if
6628 you optimize.
6630 @item -mspace
6631 Try to make the code as small as possible.  At present, this just turns
6632 on the @samp{-mep} and @samp{-mprolog-function} options.
6634 @item -mtda=@var{n}
6635 Put static or global variables whose size is @var{n} bytes or less into
6636 the tiny data area that register @code{ep} points to.  The tiny data
6637 area can hold up to 256 bytes in total (128 bytes for byte references).
6639 @item -msda=@var{n}
6640 Put static or global variables whose size is @var{n} bytes or less into
6641 the small data area that register @code{gp} points to.  The small data
6642 area can hold up to 64 kilobytes.
6644 @item -mzda=@var{n}
6645 Put static or global variables whose size is @var{n} bytes or less into
6646 the first 32 kilobytes of memory.
6648 @item -mv850
6649 Specify that the target processor is the V850.
6651 @item -mbig-switch
6652 Generate code suitable for big switch tables.  Use this option only if
6653 the assembler/linker complain about out of range branches within a switch
6654 table.
6655 @end table
6657 @node ARC Options
6658 @subsection ARC Options
6659 @cindex ARC Options
6661 These options are defined for ARC implementations:
6663 @table @code
6664 @item -EL
6665 Compile code for little endian mode.  This is the default.
6667 @item -EB
6668 Compile code for big endian mode.
6670 @item -mmangle-cpu
6671 Prepend the name of the cpu to all public symbol names.
6672 In multiple-processor systems, there are many ARC variants with different
6673 instruction and register set characteristics.  This flag prevents code
6674 compiled for one cpu to be linked with code compiled for another.
6675 No facility exists for handling variants that are "almost identical".
6676 This is an all or nothing option.
6678 @item -mcpu=@var{cpu}
6679 Compile code for ARC variant @var{cpu}.
6680 Which variants are supported depend on the configuration.
6681 All variants support @samp{-mcpu=base}, this is the default.
6683 @item -mtext=@var{text section}
6684 @itemx -mdata=@var{data section}
6685 @itemx -mrodata=@var{readonly data section}
6686 Put functions, data, and readonly data in @var{text section},
6687 @var{data section}, and @var{readonly data section} respectively
6688 by default.  This can be overridden with the @code{section} attribute.
6689 @xref{Variable Attributes}.
6691 @end table
6693 @node NS32K Options
6694 @subsection NS32K Options
6695 @cindex NS32K options
6697 These are the @samp{-m} options defined for the 32000 series.  The default
6698 values for these options depends on which style of 32000 was selected when
6699 the compiler was configured; the defaults for the most common choices are
6700 given below.
6702 @table @code
6703 @item -m32032
6704 @itemx -m32032
6705 Generate output for a 32032.  This is the default
6706 when the compiler is configured for 32032 and 32016 based systems.
6708 @item -m32332
6709 @itemx -m32332
6710 Generate output for a 32332.  This is the default
6711 when the compiler is configured for 32332-based systems.
6713 @item -m32532
6714 @itemx -m32532
6715 Generate output for a 32532.  This is the default
6716 when the compiler is configured for 32532-based systems.
6718 @item -m32081
6719 Generate output containing 32081 instructions for floating point.
6720 This is the default for all systems.
6722 @item -m32381
6723 Generate output containing 32381 instructions for floating point.  This
6724 also implies @samp{-m32081}. The 32381 is only compatible with the 32332
6725 and 32532 cpus. This is the default for the pc532-netbsd configuration.
6727 @item -mmulti-add
6728 Try and generate multiply-add floating point instructions @code{polyF}
6729 and @code{dotF}. This option is only available if the @samp{-m32381}
6730 option is in effect. Using these instructions requires changes to to
6731 register allocation which generally has a negative impact on
6732 performance.  This option should only be enabled when compiling code
6733 particularly likely to make heavy use of multiply-add instructions.
6735 @item -mnomulti-add
6736 Do not try and generate multiply-add floating point instructions
6737 @code{polyF} and @code{dotF}. This is the default on all platforms.
6739 @item -msoft-float
6740 Generate output containing library calls for floating point.
6741 @strong{Warning:} the requisite libraries may not be available.
6743 @item -mnobitfield
6744 Do not use the bit-field instructions. On some machines it is faster to
6745 use shifting and masking operations. This is the default for the pc532.
6747 @item -mbitfield
6748 Do use the bit-field instructions. This is the default for all platforms
6749 except the pc532.
6751 @item -mrtd
6752 Use a different function-calling convention, in which functions
6753 that take a fixed number of arguments return pop their
6754 arguments on return with the @code{ret} instruction.
6756 This calling convention is incompatible with the one normally
6757 used on Unix, so you cannot use it if you need to call libraries
6758 compiled with the Unix compiler.
6760 Also, you must provide function prototypes for all functions that
6761 take variable numbers of arguments (including @code{printf});
6762 otherwise incorrect code will be generated for calls to those
6763 functions.
6765 In addition, seriously incorrect code will result if you call a
6766 function with too many arguments.  (Normally, extra arguments are
6767 harmlessly ignored.)
6769 This option takes its name from the 680x0 @code{rtd} instruction.
6772 @item -mregparam
6773 Use a different function-calling convention where the first two arguments
6774 are passed in registers.
6776 This calling convention is incompatible with the one normally
6777 used on Unix, so you cannot use it if you need to call libraries
6778 compiled with the Unix compiler.
6780 @item -mnoregparam
6781 Do not pass any arguments in registers. This is the default for all
6782 targets.
6784 @item -msb
6785 It is OK to use the sb as an index register which is always loaded with
6786 zero. This is the default for the pc532-netbsd target.
6788 @item -mnosb
6789 The sb register is not available for use or has not been initialized to
6790 zero by the run time system. This is the default for all targets except
6791 the pc532-netbsd. It is also implied whenever @samp{-mhimem} or
6792 @samp{-fpic} is set.
6794 @item -mhimem
6795 Many ns32000 series addressing modes use displacements of up to 512MB.
6796 If an address is above 512MB then displacements from zero can not be used.
6797 This option causes code to be generated which can be loaded above 512MB.
6798 This may be useful for operating systems or ROM code.
6800 @item -mnohimem
6801 Assume code will be loaded in the first 512MB of virtual address space.
6802 This is the default for all platforms.
6805 @end table
6809 @node Code Gen Options
6810 @section Options for Code Generation Conventions
6811 @cindex code generation conventions
6812 @cindex options, code generation
6813 @cindex run-time options
6815 These machine-independent options control the interface conventions
6816 used in code generation.
6818 Most of them have both positive and negative forms; the negative form
6819 of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below, only
6820 one of the forms is listed---the one which is not the default.  You
6821 can figure out the other form by either removing @samp{no-} or adding
6824 @table @code
6825 @item -fexceptions
6826 Enable exception handling. Generates extra code needed to propagate
6827 exceptions.  For some targets, this implies GNU CC will generate frame
6828 unwind information for all functions, which can produce significant data
6829 size overhead, although it does not affect execution.  If you do not
6830 specify this option, GNU CC will enable it by default for languages like
6831 C++ which normally require exception handling, and disable itfor
6832 languages like C that do not normally require it.  However, you may need
6833 to enable this option when compiling C code that needs to interoperate
6834 properly with exception handlers written in C++.  You may also wish to
6835 disable this option if you are compiling older C++ programs that don't
6836 use exception handling.
6838 @item -funwind-tables
6839 Similar to @code{-fexceptions}, except that it will just generate any needed
6840 static data, but will not affect the generated code in any other way.
6841 You will normally not enable this option; instead, a language processor
6842 that needs this handling would enable it on your behalf.
6844 @item -fpcc-struct-return
6845 Return ``short'' @code{struct} and @code{union} values in memory like
6846 longer ones, rather than in registers.  This convention is less
6847 efficient, but it has the advantage of allowing intercallability between
6848 GCC-compiled files and files compiled with other compilers.
6850 The precise convention for returning structures in memory depends
6851 on the target configuration macros.
6853 Short structures and unions are those whose size and alignment match
6854 that of some integer type.
6856 @item -freg-struct-return
6857 Use the convention that @code{struct} and @code{union} values are
6858 returned in registers when possible.  This is more efficient for small
6859 structures than @samp{-fpcc-struct-return}.
6861 If you specify neither @samp{-fpcc-struct-return} nor its contrary
6862 @samp{-freg-struct-return}, GCC defaults to whichever convention is
6863 standard for the target.  If there is no standard convention, GCC
6864 defaults to @samp{-fpcc-struct-return}, except on targets where GCC
6865 is the principal compiler.  In those cases, we can choose the standard,
6866 and we chose the more efficient register return alternative.
6868 @item -fshort-enums
6869 Allocate to an @code{enum} type only as many bytes as it needs for the
6870 declared range of possible values.  Specifically, the @code{enum} type
6871 will be equivalent to the smallest integer type which has enough room.
6873 @item -fshort-double
6874 Use the same size for @code{double} as for @code{float}.
6876 @item -fshared-data
6877 Requests that the data and non-@code{const} variables of this
6878 compilation be shared data rather than private data.  The distinction
6879 makes sense only on certain operating systems, where shared data is
6880 shared between processes running the same program, while private data
6881 exists in one copy per process.
6883 @item -fno-common
6884 Allocate even uninitialized global variables in the data section of the
6885 object file, rather than generating them as common blocks.  This has the
6886 effect that if the same variable is declared (without @code{extern}) in
6887 two different compilations, you will get an error when you link them.
6888 The only reason this might be useful is if you wish to verify that the
6889 program will work on other systems which always work this way.
6891 @item -fno-ident
6892 Ignore the @samp{#ident} directive.
6894 @item -fno-gnu-linker
6895 Do not output global initializations (such as C++ constructors and
6896 destructors) in the form used by the GNU linker (on systems where the GNU
6897 linker is the standard method of handling them).  Use this option when
6898 you want to use a non-GNU linker, which also requires using the
6899 @code{collect2} program to make sure the system linker includes
6900 constructors and destructors.  (@code{collect2} is included in the GCC
6901 distribution.)  For systems which @emph{must} use @code{collect2}, the
6902 compiler driver @code{gcc} is configured to do this automatically.
6904 @item -finhibit-size-directive
6905 Don't output a @code{.size} assembler directive, or anything else that
6906 would cause trouble if the function is split in the middle, and the
6907 two halves are placed at locations far apart in memory.  This option is
6908 used when compiling @file{crtstuff.c}; you should not need to use it
6909 for anything else.
6911 @item -fverbose-asm
6912 Put extra commentary information in the generated assembly code to
6913 make it more readable.  This option is generally only of use to those
6914 who actually need to read the generated assembly code (perhaps while
6915 debugging the compiler itself).
6917 @samp{-fno-verbose-asm}, the default, causes the
6918 extra information to be omitted and is useful when comparing two assembler
6919 files.
6921 @item -fvolatile
6922 Consider all memory references through pointers to be volatile.
6924 @item -fvolatile-global
6925 Consider all memory references to extern and global data items to
6926 be volatile.  GCC does not consider static data items to be volatile
6927 because of this switch.
6929 @item -fvolatile-static
6930 Consider all memory references to static data to be volatile.
6932 @item -fpic
6933 @cindex global offset table
6934 @cindex PIC
6935 Generate position-independent code (PIC) suitable for use in a shared
6936 library, if supported for the target machine.  Such code accesses all
6937 constant addresses through a global offset table (GOT).  The dynamic
6938 loader resolves the GOT entries when the program starts (the dynamic
6939 loader is not part of GCC; it is part of the operating system).  If
6940 the GOT size for the linked executable exceeds a machine-specific
6941 maximum size, you get an error message from the linker indicating that
6942 @samp{-fpic} does not work; in that case, recompile with @samp{-fPIC}
6943 instead.  (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
6944 on the m68k and RS/6000.  The 386 has no such limit.)
6946 Position-independent code requires special support, and therefore works
6947 only on certain machines.  For the 386, GCC supports PIC for System V
6948 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
6949 position-independent.
6951 @item -fPIC
6952 If supported for the target machine, emit position-independent code,
6953 suitable for dynamic linking and avoiding any limit on the size of the
6954 global offset table.  This option makes a difference on the m68k, m88k,
6955 and the Sparc.
6957 Position-independent code requires special support, and therefore works
6958 only on certain machines.
6960 @item -ffixed-@var{reg}
6961 Treat the register named @var{reg} as a fixed register; generated code
6962 should never refer to it (except perhaps as a stack pointer, frame
6963 pointer or in some other fixed role).
6965 @var{reg} must be the name of a register.  The register names accepted
6966 are machine-specific and are defined in the @code{REGISTER_NAMES}
6967 macro in the machine description macro file.
6969 This flag does not have a negative form, because it specifies a
6970 three-way choice.
6972 @item -fcall-used-@var{reg}
6973 Treat the register named @var{reg} as an allocable register that is
6974 clobbered by function calls.  It may be allocated for temporaries or
6975 variables that do not live across a call.  Functions compiled this way
6976 will not save and restore the register @var{reg}.
6978 It is an error to used this flag with the frame pointer or stack pointer.
6979 Use of this flag for other registers that have fixed pervasive roles in
6980 the machine's execution model will produce disastrous results.
6982 This flag does not have a negative form, because it specifies a
6983 three-way choice.
6985 @item -fcall-saved-@var{reg}
6986 Treat the register named @var{reg} as an allocable register saved by
6987 functions.  It may be allocated even for temporaries or variables that
6988 live across a call.  Functions compiled this way will save and restore
6989 the register @var{reg} if they use it.
6991 It is an error to used this flag with the frame pointer or stack pointer.
6992 Use of this flag for other registers that have fixed pervasive roles in
6993 the machine's execution model will produce disastrous results.
6995 A different sort of disaster will result from the use of this flag for
6996 a register in which function values may be returned.
6998 This flag does not have a negative form, because it specifies a
6999 three-way choice.
7001 @item -fpack-struct
7002 Pack all structure members together without holes.  Usually you would
7003 not want to use this option, since it makes the code suboptimal, and
7004 the offsets of structure members won't agree with system libraries.
7006 @item -fcheck-memory-usage
7007 Generate extra code to check each memory access.  GCC will generate
7008 code that is suitable for a detector of bad memory accesses such as
7009 @file{Checker}.
7011 Normally, you should compile all, or none, of your code with this option.
7013 If you do mix code compiled with and without this option,
7014 you must ensure that all code that has side effects
7015 and that is called by code compiled with this option
7016 is, itself, compiled with this option.
7017 If you do not, you might get erroneous messages from the detector.
7019 If you use functions from a library that have side-effects (such as
7020 @code{read}), you might not be able to recompile the library and
7021 specify this option.  In that case, you can enable the
7022 @samp{-fprefix-function-name} option, which requests GCC to encapsulate
7023 your code and make other functions look as if they were compiled with
7024 @samp{-fcheck-memory-usage}.  This is done by calling ``stubs'',
7025 which are provided by the detector.  If you cannot find or build
7026 stubs for every function you call, you might have to specify
7027 @samp{-fcheck-memory-usage} without @samp{-fprefix-function-name}.
7029 If you specify this option, you can not use the @code{asm} or
7030 @code{__asm__} keywords in functions with memory checking enabled.  GNU
7031 CC cannot understand what the @code{asm} statement may do, and therefore
7032 cannot generate the appropriate code, so it will reject it.  However, if
7033 you specify the function attribute @code{no_check_memory_usage} (see
7034 @pxref{Function Attributes}, GNU CC will disable memory checking within a
7035 function; you may use @code{asm} statements inside such functions.  You
7036 may have an inline expansion of a non-checked function within a checked
7037 function; in that case GNU CC will not generate checks for the inlined
7038 function's memory accesses.
7040 If you move your @code{asm} statements to non-checked inline functions
7041 and they do access memory, you can add calls to the support code in your
7042 inline function, to indicate any reads, writes, or copies being done.
7043 These calls would be similar to those done in the stubs described above.
7045 @item -fprefix-function-name
7046 Request GCC to add a prefix to the symbols generated for function names.
7047 GCC adds a prefix to the names of functions defined as well as
7048 functions called.  Code compiled with this option and code compiled
7049 without the option can't be linked together, unless stubs are used.
7051 If you compile the following code with @samp{-fprefix-function-name}
7052 @example
7053 extern void bar (int);
7054 void
7055 foo (int a)
7057   return bar (a + 5);
7059 @end example
7061 @noindent
7062 GCC will compile the code as if it was written:
7063 @example
7064 extern void prefix_bar (int);
7065 void
7066 prefix_foo (int a)
7068   return prefix_bar (a + 5);
7070 @end example
7071 This option is designed to be used with @samp{-fcheck-memory-usage}.
7073 @item -finstrument-functions
7074 Generate instrumentation calls for entry and exit to functions.  Just
7075 after function entry and just before function exit, the following
7076 profiling functions will be called with the address of the current
7077 function and its call site.  (On some platforms,
7078 @code{__builtin_return_address} does not work beyond the current
7079 function, so the call site information may not be available to the
7080 profiling functions otherwise.)
7082 @example
7083 void __cyg_profile_func_enter (void *this_fn, void *call_site);
7084 void __cyg_profile_func_exit  (void *this_fn, void *call_site);
7085 @end example
7087 The first argument is the address of the start of the current function,
7088 which may be looked up exactly in the symbol table.
7090 This instrumentation is also done for functions expanded inline in other
7091 functions.  The profiling calls will indicate where, conceptually, the
7092 inline function is entered and exited.  This means that addressable
7093 versions of such functions must be available.  If all your uses of a
7094 function are expanded inline, this may mean an additional expansion of
7095 code size.  If you use @samp{extern inline} in your C code, an
7096 addressable version of such functions must be provided.  (This is
7097 normally the case anyways, but if you get lucky and the optimizer always
7098 expands the functions inline, you might have gotten away without
7099 providing static copies.)
7101 A function may be given the attribute @code{no_instrument_function}, in
7102 which case this instrumentation will not be done.  This can be used, for
7103 example, for the profiling functions listed above, high-priority
7104 interrupt routines, and any functions from which the profiling functions
7105 cannot safely be called (perhaps signal handlers, if the profiling
7106 routines generate output or allocate memory).
7108 @item -fstack-check
7109 Generate code to verify that you do not go beyond the boundary of the
7110 stack.  You should specify this flag if you are running in an
7111 environment with multiple threads, but only rarely need to specify it in
7112 a single-threaded environment since stack overflow is automatically
7113 detected on nearly all systems if there is only one stack.
7115 Note that this switch does not actually cause checking to be done; the
7116 operating system must do that.  The switch causes generation of code
7117 to ensure that the operating system sees the stack being extended.
7119 @item -fstack-limit-register=@var{reg}
7120 @itemx -fstack-limit-symbol=@var{sym}
7121 @itemx -fno-stack-limit
7122 Generate code to ensure that the stack does not grow beyond a certain value,
7123 either the value of a register or the address of a symbol.  If the stack
7124 would grow beyond the value, a signal is raised.  For most targets,
7125 the signal is raised before the stack overruns the boundary, so
7126 it is possible to catch the signal without taking special precautions.
7128 For instance, if the stack starts at address @samp{0x80000000} and grows
7129 downwards you can use the flags
7130 @samp{-fstack-limit-symbol=__stack_limit}
7131 @samp{-Wl,--defsym,__stack_limit=0x7ffe0000} which will enforce a stack
7132 limit of 128K.
7134 @cindex aliasing of parameters
7135 @cindex parameters, aliased
7136 @item -fargument-alias
7137 @itemx -fargument-noalias
7138 @itemx -fargument-noalias-global
7139 Specify the possible relationships among parameters and between
7140 parameters and global data.
7142 @samp{-fargument-alias} specifies that arguments (parameters) may
7143 alias each other and may alias global storage.
7144 @samp{-fargument-noalias} specifies that arguments do not alias
7145 each other, but may alias global storage.
7146 @samp{-fargument-noalias-global} specifies that arguments do not
7147 alias each other and do not alias global storage.
7149 Each language will automatically use whatever option is required by
7150 the language standard.  You should not need to use these options yourself.
7152 @item -fleading-underscore
7153 This option and its counterpart, -fno-leading-underscore, forcibly
7154 change the way C symbols are represented in the object file.  One use
7155 is to help link with legacy assembly code.
7157 Be warned that you should know what you are doing when invoking this
7158 option, and that not all targets provide complete support for it.
7159 @end table
7161 @node Environment Variables
7162 @section Environment Variables Affecting GCC
7163 @cindex environment variables
7165 This section describes several environment variables that affect how GCC
7166 operates.  Some of them work by specifying directories or prefixes to use
7167 when searching for various kinds of files. Some are used to specify other
7168 aspects of the compilation environment.
7170 @ifclear INTERNALS
7171 Note that you can also specify places to search using options such as
7172 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
7173 take precedence over places specified using environment variables, which
7174 in turn take precedence over those specified by the configuration of GCC.
7176 @end ifclear
7177 @ifset INTERNALS
7178 Note that you can also specify places to search using options such as
7179 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
7180 take precedence over places specified using environment variables, which
7181 in turn take precedence over those specified by the configuration of GCC.
7182 @xref{Driver}.
7183 @end ifset
7185 @table @code
7186 @item LANG
7187 @itemx LC_CTYPE
7188 @c @itemx LC_COLLATE
7189 @itemx LC_MESSAGES
7190 @c @itemx LC_MONETARY
7191 @c @itemx LC_NUMERIC
7192 @c @itemx LC_TIME
7193 @itemx LC_ALL
7194 @findex LANG
7195 @findex LC_CTYPE
7196 @c @findex LC_COLLATE
7197 @findex LC_MESSAGES
7198 @c @findex LC_MONETARY
7199 @c @findex LC_NUMERIC
7200 @c @findex LC_TIME
7201 @findex LC_ALL
7202 @cindex locale
7203 These environment variables control the way that GCC uses
7204 localization information that allow GCC to work with different
7205 national conventions.  GCC inspects the locale categories
7206 @code{LC_CTYPE} and @code{LC_MESSAGES} if it has been configured to do
7207 so.  These locale categories can be set to any value supported by your
7208 installation.  A typical value is @samp{en_UK} for English in the United
7209 Kingdom.
7211 The @code{LC_CTYPE} environment variable specifies character
7212 classification.  GCC uses it to determine the character boundaries in
7213 a string; this is needed for some multibyte encodings that contain quote
7214 and escape characters that would otherwise be interpreted as a string
7215 end or escape.
7217 The @code{LC_MESSAGES} environment variable specifies the language to
7218 use in diagnostic messages.
7220 If the @code{LC_ALL} environment variable is set, it overrides the value
7221 of @code{LC_CTYPE} and @code{LC_MESSAGES}; otherwise, @code{LC_CTYPE}
7222 and @code{LC_MESSAGES} default to the value of the @code{LANG}
7223 environment variable.  If none of these variables are set, GCC
7224 defaults to traditional C English behavior.
7226 @item TMPDIR
7227 @findex TMPDIR
7228 If @code{TMPDIR} is set, it specifies the directory to use for temporary
7229 files.  GCC uses temporary files to hold the output of one stage of
7230 compilation which is to be used as input to the next stage: for example,
7231 the output of the preprocessor, which is the input to the compiler
7232 proper.
7234 @item GCC_EXEC_PREFIX
7235 @findex GCC_EXEC_PREFIX
7236 If @code{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
7237 names of the subprograms executed by the compiler.  No slash is added
7238 when this prefix is combined with the name of a subprogram, but you can
7239 specify a prefix that ends with a slash if you wish.
7241 If @code{GCC_EXEC_PREFIX} is not set, GNU CC will attempt to figure out
7242 an appropriate prefix to use based on the pathname it was invoked with.
7244 If GCC cannot find the subprogram using the specified prefix, it
7245 tries looking in the usual places for the subprogram.
7247 The default value of @code{GCC_EXEC_PREFIX} is
7248 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
7249 of @code{prefix} when you ran the @file{configure} script.
7251 Other prefixes specified with @samp{-B} take precedence over this prefix.
7253 This prefix is also used for finding files such as @file{crt0.o} that are
7254 used for linking.
7256 In addition, the prefix is used in an unusual way in finding the
7257 directories to search for header files.  For each of the standard
7258 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
7259 (more precisely, with the value of @code{GCC_INCLUDE_DIR}), GCC tries
7260 replacing that beginning with the specified prefix to produce an
7261 alternate directory name.  Thus, with @samp{-Bfoo/}, GCC will search
7262 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
7263 These alternate directories are searched first; the standard directories
7264 come next.
7266 @item COMPILER_PATH
7267 @findex COMPILER_PATH
7268 The value of @code{COMPILER_PATH} is a colon-separated list of
7269 directories, much like @code{PATH}.  GCC tries the directories thus
7270 specified when searching for subprograms, if it can't find the
7271 subprograms using @code{GCC_EXEC_PREFIX}.
7273 @item LIBRARY_PATH
7274 @findex LIBRARY_PATH
7275 The value of @code{LIBRARY_PATH} is a colon-separated list of
7276 directories, much like @code{PATH}.  When configured as a native compiler,
7277 GCC tries the directories thus specified when searching for special
7278 linker files, if it can't find them using @code{GCC_EXEC_PREFIX}.  Linking
7279 using GCC also uses these directories when searching for ordinary
7280 libraries for the @samp{-l} option (but directories specified with
7281 @samp{-L} come first).
7283 @item C_INCLUDE_PATH
7284 @itemx CPLUS_INCLUDE_PATH
7285 @itemx OBJC_INCLUDE_PATH
7286 @findex C_INCLUDE_PATH
7287 @findex CPLUS_INCLUDE_PATH
7288 @findex OBJC_INCLUDE_PATH
7289 @c @itemx OBJCPLUS_INCLUDE_PATH
7290 These environment variables pertain to particular languages.  Each
7291 variable's value is a colon-separated list of directories, much like
7292 @code{PATH}.  When GCC searches for header files, it tries the
7293 directories listed in the variable for the language you are using, after
7294 the directories specified with @samp{-I} but before the standard header
7295 file directories.
7297 @item DEPENDENCIES_OUTPUT
7298 @findex DEPENDENCIES_OUTPUT
7299 @cindex dependencies for make as output
7300 If this variable is set, its value specifies how to output dependencies
7301 for Make based on the header files processed by the compiler.  This
7302 output looks much like the output from the @samp{-M} option
7303 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
7304 in addition to the usual results of compilation.
7306 The value of @code{DEPENDENCIES_OUTPUT} can be just a file name, in
7307 which case the Make rules are written to that file, guessing the target
7308 name from the source file name.  Or the value can have the form
7309 @samp{@var{file} @var{target}}, in which case the rules are written to
7310 file @var{file} using @var{target} as the target name.
7312 @item LANG
7313 @findex LANG
7314 @cindex locale definition
7315 This variable is used to pass locale information to the compiler. One way in
7316 which this information is used is to determine the character set to be used
7317 when character literals, string literals and comments are parsed in C and C++.
7318 When the compiler is configured to allow multibyte characters,
7319 the following values for @code{LANG} are recognized:
7321 @table @code
7322 @item C-JIS
7323 Recognize JIS characters.
7324 @item C-SJIS
7325 Recognize SJIS characters.
7326 @item C-EUCJP
7327 Recognize EUCJP characters.
7328 @end table
7330 If @code{LANG} is not defined, or if it has some other value, then the
7331 compiler will use mblen and mbtowc as defined by the default locale to
7332 recognize and translate multibyte characters.
7333 @end table
7335 @node Running Protoize
7336 @section Running Protoize
7338 The program @code{protoize} is an optional part of GNU C.  You can use
7339 it to add prototypes to a program, thus converting the program to ANSI
7340 C in one respect.  The companion program @code{unprotoize} does the
7341 reverse: it removes argument types from any prototypes that are found.
7343 When you run these programs, you must specify a set of source files as
7344 command line arguments.  The conversion programs start out by compiling
7345 these files to see what functions they define.  The information gathered
7346 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
7348 After scanning comes actual conversion.  The specified files are all
7349 eligible to be converted; any files they include (whether sources or
7350 just headers) are eligible as well.
7352 But not all the eligible files are converted.  By default,
7353 @code{protoize} and @code{unprotoize} convert only source and header
7354 files in the current directory.  You can specify additional directories
7355 whose files should be converted with the @samp{-d @var{directory}}
7356 option.  You can also specify particular files to exclude with the
7357 @samp{-x @var{file}} option.  A file is converted if it is eligible, its
7358 directory name matches one of the specified directory names, and its
7359 name within the directory has not been excluded.
7361 Basic conversion with @code{protoize} consists of rewriting most
7362 function definitions and function declarations to specify the types of
7363 the arguments.  The only ones not rewritten are those for varargs
7364 functions.
7366 @code{protoize} optionally inserts prototype declarations at the
7367 beginning of the source file, to make them available for any calls that
7368 precede the function's definition.  Or it can insert prototype
7369 declarations with block scope in the blocks where undeclared functions
7370 are called.
7372 Basic conversion with @code{unprotoize} consists of rewriting most
7373 function declarations to remove any argument types, and rewriting
7374 function definitions to the old-style pre-ANSI form.
7376 Both conversion programs print a warning for any function declaration or
7377 definition that they can't convert.  You can suppress these warnings
7378 with @samp{-q}.
7380 The output from @code{protoize} or @code{unprotoize} replaces the
7381 original source file.  The original file is renamed to a name ending
7382 with @samp{.save}.  If the @samp{.save} file already exists, then
7383 the source file is simply discarded.
7385 @code{protoize} and @code{unprotoize} both depend on GCC itself to
7386 scan the program and collect information about the functions it uses.
7387 So neither of these programs will work until GCC is installed.
7389 Here is a table of the options you can use with @code{protoize} and
7390 @code{unprotoize}.  Each option works with both programs unless
7391 otherwise stated.
7393 @table @code
7394 @item -B @var{directory}
7395 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
7396 usual directory (normally @file{/usr/local/lib}).  This file contains
7397 prototype information about standard system functions.  This option
7398 applies only to @code{protoize}.
7400 @item -c @var{compilation-options}
7401 Use  @var{compilation-options} as the options when running @code{gcc} to
7402 produce the @samp{.X} files.  The special option @samp{-aux-info} is
7403 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
7405 Note that the compilation options must be given as a single argument to
7406 @code{protoize} or @code{unprotoize}.  If you want to specify several
7407 @code{gcc} options, you must quote the entire set of compilation options
7408 to make them a single word in the shell.
7410 There are certain @code{gcc} arguments that you cannot use, because they
7411 would produce the wrong kind of output.  These include @samp{-g},
7412 @samp{-O}, @samp{-c}, @samp{-S}, and @samp{-o} If you include these in
7413 the @var{compilation-options}, they are ignored.
7415 @item -C
7416 Rename files to end in @samp{.C} instead of @samp{.c}.
7417 This is convenient if you are converting a C program to C++.
7418 This option applies only to @code{protoize}.
7420 @item -g
7421 Add explicit global declarations.  This means inserting explicit
7422 declarations at the beginning of each source file for each function
7423 that is called in the file and was not declared.  These declarations
7424 precede the first function definition that contains a call to an
7425 undeclared function.  This option applies only to @code{protoize}.
7427 @item -i @var{string}
7428 Indent old-style parameter declarations with the string @var{string}.
7429 This option applies only to @code{protoize}.
7431 @code{unprotoize} converts prototyped function definitions to old-style
7432 function definitions, where the arguments are declared between the
7433 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
7434 uses five spaces as the indentation.  If you want to indent with just
7435 one space instead, use @samp{-i " "}.
7437 @item -k
7438 Keep the @samp{.X} files.  Normally, they are deleted after conversion
7439 is finished.
7441 @item -l
7442 Add explicit local declarations.  @code{protoize} with @samp{-l} inserts
7443 a prototype declaration for each function in each block which calls the
7444 function without any declaration.  This option applies only to
7445 @code{protoize}.
7447 @item -n
7448 Make no real changes.  This mode just prints information about the conversions
7449 that would have been done without @samp{-n}.
7451 @item -N
7452 Make no @samp{.save} files.  The original files are simply deleted.
7453 Use this option with caution.
7455 @item -p @var{program}
7456 Use the program @var{program} as the compiler.  Normally, the name
7457 @file{gcc} is used.
7459 @item -q
7460 Work quietly.  Most warnings are suppressed.
7462 @item -v
7463 Print the version number, just like @samp{-v} for @code{gcc}.
7464 @end table
7466 If you need special compiler options to compile one of your program's
7467 source files, then you should generate that file's @samp{.X} file
7468 specially, by running @code{gcc} on that source file with the
7469 appropriate options and the option @samp{-aux-info}.  Then run
7470 @code{protoize} on the entire set of files.  @code{protoize} will use
7471 the existing @samp{.X} file because it is newer than the source file.
7472 For example:
7474 @example
7475 gcc -Dfoo=bar file1.c -aux-info
7476 protoize *.c
7477 @end example
7479 @noindent
7480 You need to include the special files along with the rest in the
7481 @code{protoize} command, even though their @samp{.X} files already
7482 exist, because otherwise they won't get converted.
7484 @xref{Protoize Caveats}, for more information on how to use
7485 @code{protoize} successfully.