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