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