OSDN Git Service

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