OSDN Git Service

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