OSDN Git Service

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