2001-02-14 Tom Tromey <tromey@redhat.com>
[official-gcc.git] / gcc / invoke.texi
blob896d9f93bf517e5ca864557157cd41694d223749
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin COPYRIGHT
7 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
8 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
10 Permission is granted to make and distribute verbatim copies of this
11 manual provided the copyright notice and this permission notice are
12 preserved on all copies.
14 Permission is granted to copy and distribute modified versions of this
15 manual under the conditions for verbatim copying, provided also that the
16 entire resulting derived work is distributed under the terms of a
17 permission notice identical to this one.
19 Permission is granted to copy and distribute translations of this manual
20 into another language, under the above conditions for modified versions,
21 except that this permission notice may be included in translations
22 approved by the Free Software Foundation instead of in the original
23 English.
24 @c man end
25 @c Set file name and title for the man page.
26 @setfilename gcc
27 @settitle GNU project C and C++ compiler
28 @c man begin SYNOPSIS
29 gcc [@samp{-c}|@samp{-S}|@samp{-E}] [@samp{-std=}@var{standard}]
30     [@samp{-g}] [@samp{-pg}] [@samp{-O}@var{level}]
31     [@samp{-W}@var{warn}...] [@samp{-pedantic}]
32     [@samp{-I}@var{dir}...] [@samp{-L}@var{dir}...]
33     [@samp{-D}@var{macro}[=@var{defn}]...] [@samp{-U}@var{macro}]
34     [@samp{-f}@var{option}...] [@samp{-m}@var{machine-option}...]
35     [@samp{-o} @var{outfile}] @var{infile}...
37 Only the most useful options are listed here; see below for the
38 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
39 @c man end
40 @c man begin SEEALSO
41 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
42 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
43 @file{ld}, @file{binutils} and @file{gdb}.
44 @c man end
45 @c man begin BUGS
46 For instructions on reporting bugs, see
47 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
48 script to report bugs is recommended.
49 @c man end
50 @c man begin AUTHOR
51 See the Info entry for @file{gcc}, or
52 @w{@uref{http://gcc.gnu.org/thanks.html}}, for contributors to GCC.
53 @c man end
54 @end ignore
56 @node Invoking GCC
57 @chapter GCC Command Options
58 @cindex GCC command options
59 @cindex command options
60 @cindex options, GCC command
62 @c man begin DESCRIPTION
64 When you invoke GCC, it normally does preprocessing, compilation,
65 assembly and linking.  The ``overall options'' allow you to stop this
66 process at an intermediate stage.  For example, the @samp{-c} option
67 says not to run the linker.  Then the output consists of object files
68 output by the assembler.
70 Other options are passed on to one stage of processing.  Some options
71 control the preprocessor and others the compiler itself.  Yet other
72 options control the assembler and linker; most of these are not
73 documented here, since you rarely need to use any of them.
75 @cindex C compilation options
76 Most of the command line options that you can use with GCC are useful
77 for C programs; when an option is only useful with another language
78 (usually C++), the explanation says so explicitly.  If the description
79 for a particular option does not mention a source language, you can use
80 that option with all supported languages.
82 @cindex C++ compilation options
83 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
84 options for compiling C++ programs.
86 @cindex grouping options
87 @cindex options, grouping
88 The @command{gcc} program accepts options and file names as operands.  Many
89 options have multi-letter names; therefore multiple single-letter options
90 may @emph{not} be grouped: @samp{-dr} is very different from @w{@samp{-d
91 -r}}.
93 @cindex order of options
94 @cindex options, order
95 You can mix options and other arguments.  For the most part, the order
96 you use doesn't matter.  Order does matter when you use several options
97 of the same kind; for example, if you specify @samp{-L} more than once,
98 the directories are searched in the order specified.
100 Many options have long names starting with @samp{-f} or with
101 @samp{-W}---for example, @samp{-fforce-mem},
102 @samp{-fstrength-reduce}, @samp{-Wformat} and so on.  Most of
103 these have both positive and negative forms; the negative form of
104 @samp{-ffoo} would be @samp{-fno-foo}.  This manual documents
105 only one of these two forms, whichever one is not the default.
107 @c man end
109 @menu
110 * Option Summary::      Brief list of all options, without explanations.
111 * Overall Options::     Controlling the kind of output:
112                         an executable, object files, assembler files,
113                         or preprocessed source.
114 * Invoking G++::        Compiling C++ programs.
115 * C Dialect Options::   Controlling the variant of C language compiled.
116 * C++ Dialect Options:: Variations on C++.
117 * Language Independent Options:: Controlling how diagnostics should be
118                         formatted. 
119 * Warning Options::     How picky should the compiler be?
120 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
121 * Optimize Options::    How much optimization?
122 * Preprocessor Options:: Controlling header files and macro definitions.
123                          Also, getting dependency information for Make.
124 * Assembler Options::   Passing options to the assembler.
125 * Link Options::        Specifying libraries and so on.
126 * Directory Options::   Where to find header files and libraries.
127                         Where to find the compiler executable files.
128 * Spec Files::          How to pass switches to sub-processes.
129 * Target Options::      Running a cross-compiler, or an old version of GCC.
130 * Submodel Options::    Specifying minor hardware or convention variations,
131                         such as 68010 vs 68020.
132 * Code Gen Options::    Specifying conventions for function calls, data layout
133                         and register usage.
134 * Environment Variables:: Env vars that affect GCC.
135 * Running Protoize::    Automatically adding or removing function prototypes.
136 @end menu
138 @c man begin OPTIONS
140 @node Option Summary
141 @section Option Summary
143 Here is a summary of all the options, grouped by type.  Explanations are
144 in the following sections.
146 @table @emph
147 @item Overall Options
148 @xref{Overall Options,,Options Controlling the Kind of Output}.
149 @gccoptlist{
150 -c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  -x @var{language} @gol
151 -v  --target-help  --help}
153 @item C Language Options
154 @xref{C Dialect Options,,Options Controlling C Dialect}.
155 @gccoptlist{
156 -ansi  -std=@var{standard}  -fno-asm  -fno-builtin @gol
157 -fhosted  -ffreestanding @gol
158 -trigraphs  -traditional  -traditional-cpp @gol
159 -fallow-single-precision  -fcond-mismatch @gol
160 -fsigned-bitfields  -fsigned-char @gol
161 -funsigned-bitfields  -funsigned-char @gol
162 -fwritable-strings  -fshort-wchar}
164 @item C++ Language Options
165 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
166 @gccoptlist{
167 -fno-access-control  -fcheck-new  -fconserve-space @gol
168 -fdollars-in-identifiers  -fno-elide-constructors @gol
169 -fno-enforce-eh-specs  -fexternal-templates @gol
170 -falt-external-templates @gol
171 -ffor-scope  -fno-for-scope  -fno-gnu-keywords  -fhonor-std @gol
172 -fhuge-objects  -fno-implicit-templates @gol
173 -fno-implicit-inline-templates @gol
174 -fno-implement-inlines  -fms-extensions @gol
175 -fname-mangling-version-@var{n}  -fno-operator-names @gol
176 -fno-optional-diags  -fpermissive @gol
177 -frepo  -fno-rtti  -fsquangle  -ftemplate-depth-@var{n} @gol
178 -fuse-cxa-atexit  -fvtable-thunks  -nostdinc++ @gol
179 -fno-default-inline  -Wctor-dtor-privacy @gol
180 -Wnon-virtual-dtor  -Wreorder @gol
181 -Weffc++  -Wno-deprecated @gol
182 -Wno-non-template-friend  -Wold-style-cast @gol
183 -Woverloaded-virtual  -Wno-pmf-conversions @gol
184 -Wsign-promo  -Wsynth}
186 @item Language Independent Options
187 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
188 @gccoptlist{
189 -fmessage-length=@var{n}  @gol
190 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
192 @item Warning Options
193 @xref{Warning Options,,Options to Request or Suppress Warnings}.
194 @gccoptlist{
195 -fsyntax-only  -pedantic  -pedantic-errors @gol
196 -w  -W  -Wall  -Waggregate-return @gol
197 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
198 -Wconversion  -Wdisabled-optimization -Werror @gol
199 -Wfloat-equal  -Wformat  -Wformat=2 @gol
200 -Wformat-nonliteral -Wformat-security @gol
201 -Wid-clash-@var{len}  -Wimplicit -Wimplicit-int  @gol
202 -Wimplicit-function-declaration @gol
203 -Werror-implicit-function-declaration @gol
204 -Wimport  -Winline @gol
205 -Wlarger-than-@var{len}  -Wlong-long @gol
206 -Wmain  -Wmissing-declarations @gol
207 -Wmissing-format-attribute  -Wmissing-noreturn @gol
208 -Wmultichar  -Wno-format-extra-args -Wno-format-y2k @gol
209 -Wno-import  -Wpacked  -Wpadded @gol
210 -Wparentheses -Wpointer-arith  -Wredundant-decls @gol
211 -Wreturn-type  -Wsequence-point  -Wshadow @gol
212 -Wsign-compare  -Wswitch  -Wsystem-headers @gol
213 -Wtrigraphs  -Wundef  -Wuninitialized @gol
214 -Wunknown-pragmas  -Wunreachable-code @gol
215 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
216 -Wunused-value  -Wunused-variable  -Wwrite-strings}
218 @item C-only Warning Options
219 @gccoptlist{
220 -Wbad-function-cast -Wmissing-prototypes -Wnested-externs @gol
221 -Wstrict-prototypes -Wtraditional}
223 @item Debugging Options
224 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
225 @gccoptlist{
226 -a  -ax  -d@var{letters}  -fdump-unnumbered -fdump-translation-unit=@var{file} @gol
227 -fdump-class-layout=@var{file} -fpretend-float -fprofile-arcs  -ftest-coverage @gol
228 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
229 -ggdb  -gstabs  -gstabs+  -gxcoff  -gxcoff+ @gol
230 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
231 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
232 -save-temps  -time}
234 @item Optimization Options
235 @xref{Optimize Options,,Options that Control Optimization}.
236 @gccoptlist{
237 -falign-functions=@var{n}  -falign-jumps=@var{n} @gol
238 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
239 -fbranch-probabilities  -fcaller-saves @gol
240 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections  -fdce @gol
241 -fdelayed-branch  -fdelete-null-pointer-checks @gol
242 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
243 -fforce-addr  -fforce-mem  -ffunction-sections  -fgcse  @gol
244 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
245 -fkeep-static-consts  -fmove-all-movables @gol
246 -fno-default-inline  -fno-defer-pop @gol
247 -fno-function-cse   -fno-guess-branch-probability
248 -fno-inline  -fno-math-errno  -fno-peephole @gol
249 -fomit-frame-pointer  -foptimize-register-move @gol
250 -foptimize-sibling-calls  -freduce-all-givs @gol
251 -fregmove  -frename-registers @gol
252 -frerun-cse-after-loop  -frerun-loop-opt @gol
253 -fschedule-insns  -fschedule-insns2 @gol
254 -fsingle-precision-constant  -fssa @gol
255 -fstrength-reduce  -fstrict-aliasing  -fthread-jumps  -ftrapv @gol
256 -funroll-all-loops  -funroll-loops  @gol
257 -O  -O0  -O1  -O2  -O3  -Os}
259 @item Preprocessor Options
260 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
261 @gccoptlist{
262 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
263 -C  -dD  -dI  -dM  -dN @gol
264 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
265 -idirafter @var{dir} @gol
266 -include @var{file}  -imacros @var{file} @gol
267 -iprefix @var{file}  -iwithprefix @var{dir} @gol
268 -iwithprefixbefore @var{dir}  -isystem @var{dir} -isystem-c++ @var{dir} @gol
269 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
270 -trigraphs  -undef  -U@var{macro}  -Wp\,@var{option}}
272 @item Assembler Option
273 @xref{Assembler Options,,Passing Options to the Assembler}.
274 @gccoptlist{
275 -Wa\,@var{option}}
277 @item Linker Options
278 @xref{Link Options,,Options for Linking}.
279 @gccoptlist{
280 @var{object-file-name}  -l@var{library} @gol
281 -nostartfiles  -nodefaultlibs  -nostdlib @gol
282 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
283 -Wl\,@var{option}  -Xlinker @var{option} @gol
284 -u @var{symbol}}
286 @item Directory Options
287 @xref{Directory Options,,Options for Directory Search}.
288 @gccoptlist{
289 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
291 @item Target Options
292 @c I wrote this xref this way to avoid overfull hbox. -- rms
293 @xref{Target Options}.
294 @gccoptlist{
295 -b @var{machine}  -V @var{version}}
297 @item Machine Dependent Options
298 @xref{Submodel Options,,Hardware Models and Configurations}.
299 @emph{M680x0 Options}
300 @gccoptlist{
301 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
302 -m68060  -mcpu32 -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
303 -mfpa -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
304 -malign-int -mstrict-align}
306 @emph{M68hc1x Options}
307 @gccoptlist{
308 -m6811  -m6812  -m68hc11  -m68hc12 @gol
309 -mauto-incdec  -mshort  -msoft-reg-count=@var{count}}
311 @emph{VAX Options}
312 @gccoptlist{
313 -mg  -mgnu  -munix}
315 @emph{SPARC Options}
316 @gccoptlist{
317 -mcpu=@var{cpu type} @gol
318 -mtune=@var{cpu type} @gol
319 -mcmodel=@var{code model} @gol
320 -m32  -m64 @gol
321 -mapp-regs  -mbroken-saverestore  -mcypress @gol
322 -mepilogue -mfaster-structs -mflat @gol
323 -mfpu  -mhard-float  -mhard-quad-float @gol
324 -mimpure-text  -mlive-g0  -mno-app-regs @gol
325 -mno-epilogue -mno-faster-structs -mno-flat  -mno-fpu @gol
326 -mno-impure-text -mno-stack-bias  -mno-unaligned-doubles @gol
327 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
328 -msupersparc  -munaligned-doubles  -mv8}
330 @emph{Convex Options}
331 @gccoptlist{
332 -mc1  -mc2  -mc32  -mc34  -mc38 @gol
333 -margcount  -mnoargcount @gol
334 -mlong32  -mlong64 @gol
335 -mvolatile-cache  -mvolatile-nocache}
337 @emph{AMD29K Options}
338 @gccoptlist{
339 -m29000  -m29050  -mbw  -mnbw  -mdw  -mndw @gol
340 -mlarge  -mnormal  -msmall @gol
341 -mkernel-registers  -mno-reuse-arg-regs @gol
342 -mno-stack-check  -mno-storem-bug @gol
343 -mreuse-arg-regs  -msoft-float  -mstack-check @gol
344 -mstorem-bug  -muser-registers}
346 @emph{ARM Options}
347 @gccoptlist{
348 -mapcs-frame -mno-apcs-frame @gol
349 -mapcs-26 -mapcs-32 @gol
350 -mapcs-stack-check -mno-apcs-stack-check @gol
351 -mapcs-float -mno-apcs-float @gol
352 -mapcs-reentrant -mno-apcs-reentrant @gol
353 -msched-prolog -mno-sched-prolog @gol
354 -mlittle-endian -mbig-endian -mwords-little-endian @gol
355 -malignment-traps -mno-alignment-traps @gol
356 -msoft-float -mhard-float -mfpe @gol
357 -mthumb-interwork -mno-thumb-interwork @gol
358 -mcpu= -march= -mfpe=  @gol
359 -mstructure-size-boundary= @gol
360 -mbsd -mxopen -mno-symrename @gol
361 -mabort-on-noreturn @gol
362 -mlong-calls -mno-long-calls @gol
363 -mnop-fun-dllimport -mno-nop-fun-dllimport @gol
364 -msingle-pic-base -mno-single-pic-base @gol
365 -mpic-register=}
367 @emph{Thumb Options}
368 @gccoptlist{
369 -mtpcs-frame -mno-tpcs-frame @gol
370 -mtpcs-leaf-frame -mno-tpcs-leaf-frame @gol
371 -mlittle-endian  -mbig-endian @gol
372 -mthumb-interwork -mno-thumb-interwork @gol
373 -mstructure-size-boundary= @gol
374 -mnop-fun-dllimport -mno-nop-fun-dllimport @gol
375 -mcallee-super-interworking -mno-callee-super-interworking @gol
376 -mcaller-super-interworking -mno-caller-super-interworking @gol
377 -msingle-pic-base -mno-single-pic-base @gol
378 -mpic-register=}
380 @emph{MN10200 Options}
381 @gccoptlist{
382 -mrelax}
384 @emph{MN10300 Options}
385 @gccoptlist{
386 -mmult-bug @gol
387 -mno-mult-bug @gol
388 -mam33 @gol
389 -mno-am33 @gol
390 -mrelax}
392 @emph{M32R/D Options}
393 @gccoptlist{
394 -mcode-model=@var{model type}  -msdata=@var{sdata type} @gol
395 -G @var{num}}
397 @emph{M88K Options}
398 @gccoptlist{
399 -m88000  -m88100  -m88110  -mbig-pic @gol
400 -mcheck-zero-division  -mhandle-large-shift @gol
401 -midentify-revision  -mno-check-zero-division @gol
402 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
403 -mno-optimize-arg-area  -mno-serialize-volatile @gol
404 -mno-underscores  -mocs-debug-info @gol
405 -mocs-frame-position  -moptimize-arg-area @gol
406 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
407 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
408 -mversion-03.00  -mwarn-passed-structs}
410 @emph{RS/6000 and PowerPC Options}
411 @gccoptlist{
412 -mcpu=@var{cpu type} @gol
413 -mtune=@var{cpu type} @gol
414 -mpower  -mno-power  -mpower2  -mno-power2 @gol
415 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
416 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
417 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
418 -mnew-mnemonics  -mold-mnemonics @gol
419 -mfull-toc   -mminimal-toc  -mno-fop-in-toc  -mno-sum-in-toc @gol
420 -m64  -m32  -mxl-call  -mno-xl-call  -mthreads  -mpe @gol
421 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
422 -mstring  -mno-string  -mupdate  -mno-update @gol
423 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
424 -mstrict-align  -mno-strict-align  -mrelocatable @gol
425 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
426 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
427 -mcall-aix  -mcall-sysv  -mprototype  -mno-prototype @gol
428 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
429 -msdata=@var{opt}  -mvxworks -G @var{num}}
431 @emph{RT Options}
432 @gccoptlist{
433 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
434 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
435 -mminimum-fp-blocks  -mnohc-struct-return}
437 @emph{MIPS Options}
438 @gccoptlist{
439 -mabicalls  -mcpu=@var{cpu type}
440 -membedded-data  -muninit-const-in-rodata @gol
441 -membedded-pic  -mfp32  -mfp64  -mgas  -mgp32  -mgp64 @gol
442 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
443 -mips2  -mips3 -mips4 -mlong64  -mlong32 -mlong-calls  -mmemcpy @gol
444 -mmips-as  -mmips-tfile  -mno-abicalls @gol
445 -mno-embedded-data  -mno-uninit-const-in-rodata  -mno-embedded-pic @gol
446 -mno-gpopt  -mno-long-calls @gol
447 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
448 -mrnames  -msoft-float @gol
449 -m4650  -msingle-float  -mmad @gol
450 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
451 -mabi=32 -mabi=n32 -mabi=64 -mabi=eabi @gol
452 -mfix7000 -mno-crt0}
454 @emph{i386 Options}
455 @gccoptlist{
456 -mcpu=@var{cpu type} -march=@var{cpu type} @gol
457 -mintel-syntax -mieee-fp  -mno-fancy-math-387 @gol
458 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
459 -mno-wide-multiply  -mrtd  -malign-double @gol
460 -malign-jumps=@var{num}  -malign-loops=@var{num} @gol
461 -malign-functions=@var{num} -mpreferred-stack-boundary=@var{num} @gol
462 -mthreads -mno-align-stringops -minline-all-stringops @gol
463 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
464 -m96bit-long-double -mregparm=@var{num}}
466 @emph{HPPA Options}
467 @gccoptlist{
468 -march=@var{architecture type} @gol
469 -mbig-switch  -mdisable-fpregs  -mdisable-indexing   @gol
470 -mfast-indirect-calls -mgas  -mjump-in-delay   @gol
471 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
472 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
473 -mno-jump-in-delay  -mno-long-load-store   @gol
474 -mno-portable-runtime  -mno-soft-float @gol
475 -mno-space-regs  -msoft-float  -mpa-risc-1-0   @gol
476 -mpa-risc-1-1  -mpa-risc-2-0 -mportable-runtime @gol
477 -mschedule=@var{cpu type}  -mspace-regs}
479 @emph{Intel 960 Options}
480 @gccoptlist{
481 -m@var{cpu type}  -masm-compat  -mclean-linkage @gol
482 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
483 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
484 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
485 -mno-complex-addr  -mno-leaf-procedures @gol
486 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
487 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
488 -mtail-call}
490 @emph{DEC Alpha Options}
491 @gccoptlist{
492 -mfp-regs  -mno-fp-regs -mno-soft-float  -msoft-float @gol
493 -malpha-as -mgas @gol
494 -mieee  -mieee-with-inexact  -mieee-conformant @gol
495 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
496 -mtrap-precision=@var{mode}  -mbuild-constants @gol
497 -mcpu=@var{cpu type} @gol
498 -mbwx -mno-bwx -mcix -mno-cix -mmax -mno-max @gol
499 -mmemory-latency=@var{time}}
501 @emph{Clipper Options}
502 @gccoptlist{
503 -mc300  -mc400}
505 @emph{H8/300 Options}
506 @gccoptlist{
507 -mrelax  -mh -ms -mint32  -malign-300}
509 @emph{SH Options}
510 @gccoptlist{
511 -m1  -m2  -m3  -m3e @gol
512 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
513 -mb  -ml  -mdalign  -mrelax @gol
514 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
515 -misize  -mpadstruct  -mspace @gol
516 -mprefergot
517 -musermode}
519 @emph{System V Options}
520 @gccoptlist{
521 -Qy  -Qn  -YP\,@var{paths}  -Ym\,@var{dir}}
523 @emph{ARC Options}
524 @gccoptlist{
525 -EB  -EL @gol
526 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text section} @gol
527 -mdata=@var{data section}  -mrodata=@var{readonly data section}}
529 @emph{TMS320C3x/C4x Options}
530 @gccoptlist{
531 -mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
532 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
533 -mrpts=@var{count}  -mrptb -mdb -mloop-unsigned @gol
534 -mparallel-insns -mparallel-mpy -mpreserve-float}
536 @emph{V850 Options}
537 @gccoptlist{
538 -mlong-calls -mno-long-calls -mep -mno-ep @gol
539 -mprolog-function -mno-prolog-function -mspace @gol
540 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
541 -mv850 -mbig-switch}
543 @emph{NS32K Options}
544 @gccoptlist{
545 -m32032 -m32332 -m32532 -m32081 -m32381 -mmult-add -mnomult-add @gol
546 -msoft-float -mrtd -mnortd -mregparam -mnoregparam -msb -mnosb @gol
547 -mbitfield -mnobitfield -mhimem -mnohimem}
549 @emph{AVR Options}
550 @gccoptlist{
551 -mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
552 -mcall-prologues -mno-tablejump -mtiny-stack}
554 @emph{MCore Options}
555 @gccoptlist{
556 -mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates  @gol
557 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
558 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
559 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
560 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
562 @emph{IA-64 Options}
563 @gccoptlist{
564 -mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
565 -mvolatile-asm-stop -mb-step -mregister-names -mno-sdata @gol
566 -mconstant-gp -mauto-pic -minline-divide-min-latency @gol
567 -minline-divide-max-throughput -mno-dwarf2-asm @gol
568 -mfixed-range=@var{register range}}
570 @item Code Generation Options
571 @xref{Code Gen Options,,Options for Code Generation Conventions}.
572 @gccoptlist{
573 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
574 -fexceptions  -funwind-tables  -ffixed-@var{reg} @gol
575 -finhibit-size-directive  -finstrument-functions @gol
576 -fcheck-memory-usage  -fprefix-function-name @gol
577 -fno-common  -fno-ident  -fno-gnu-linker @gol
578 -fpcc-struct-return  -fpic  -fPIC @gol
579 -freg-struct-return  -fshared-data  -fshort-enums @gol
580 -fshort-double  -fvolatile  -fvolatile-global -fvolatile-static @gol
581 -fverbose-asm  -fpack-struct  -fstack-check @gol
582 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
583 -fargument-alias  -fargument-noalias @gol
584 -fargument-noalias-global @gol
585 -fleading-underscore}
586 @end table
588 @menu
589 * Overall Options::     Controlling the kind of output:
590                         an executable, object files, assembler files,
591                         or preprocessed source.
592 * C Dialect Options::   Controlling the variant of C language compiled.
593 * C++ Dialect Options:: Variations on C++.
594 * Language Independent Options:: Controlling how diagnostics should be
595                         formatted. 
596 * Warning Options::     How picky should the compiler be?
597 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
598 * Optimize Options::    How much optimization?
599 * Preprocessor Options:: Controlling header files and macro definitions.
600                          Also, getting dependency information for Make.
601 * Assembler Options::   Passing options to the assembler.
602 * Link Options::        Specifying libraries and so on.
603 * Directory Options::   Where to find header files and libraries.
604                         Where to find the compiler executable files.
605 * Spec Files::          How to pass switches to sub-processes.
606 * Target Options::      Running a cross-compiler, or an old version of GCC.
607 @end menu
609 @node Overall Options
610 @section Options Controlling the Kind of Output
612 Compilation can involve up to four stages: preprocessing, compilation
613 proper, assembly and linking, always in that order.  The first three
614 stages apply to an individual source file, and end by producing an
615 object file; linking combines all the object files (those newly
616 compiled, and those specified as input) into an executable file.
618 @cindex file name suffix
619 For any given input file, the file name suffix determines what kind of
620 compilation is done:
622 @table @gcctabopt
623 @item @var{file}.c
624 C source code which must be preprocessed.
626 @item @var{file}.i
627 C source code which should not be preprocessed.
629 @item @var{file}.ii
630 C++ source code which should not be preprocessed.
632 @item @var{file}.m
633 Objective-C source code.  Note that you must link with the library
634 @file{libobjc.a} to make an Objective-C program work.
636 @item @var{file}.mi
637 Objective-C source code which should not be preprocessed.
639 @item @var{file}.h
640 C header file (not to be compiled or linked).
642 @item @var{file}.cc
643 @itemx @var{file}.cp
644 @itemx @var{file}.cxx
645 @itemx @var{file}.cpp
646 @itemx @var{file}.c++
647 @itemx @var{file}.C
648 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
649 the last two letters must both be literally @samp{x}.  Likewise,
650 @samp{.C} refers to a literal capital C.
652 @item @var{file}.f
653 @itemx @var{file}.for
654 @itemx @var{file}.FOR
655 Fortran source code which should not be preprocessed.
657 @item @var{file}.F
658 @itemx @var{file}.fpp
659 @itemx @var{file}.FPP
660 Fortran source code which must be preprocessed (with the traditional
661 preprocessor).
663 @item @var{file}.r
664 Fortran source code which must be preprocessed with a RATFOR
665 preprocessor (not included with GCC).
667 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
668 Using and Porting GNU Fortran}, for more details of the handling of
669 Fortran input files.
671 @c FIXME: Descriptions of Java file types.
672 @c @var{file}.java
673 @c @var{file}.class
674 @c @var{file}.zip
675 @c @var{file}.jar
677 @c GCC also knows about some suffixes for languages not yet included:
678 @c Ada:
679 @c @var{file}.ads
680 @c @var{file}.adb
681 @c @var{file}.ada
682 @c Pascal:
683 @c @var{file}.p
684 @c @var{file}.pas
686 @item @var{file}.ch
687 @itemx @var{file}.chi
688 CHILL source code (preprocessed with the traditional preprocessor).
690 @item @var{file}.s
691 Assembler code.
693 @item @var{file}.S
694 Assembler code which must be preprocessed.
696 @item @var{other}
697 An object file to be fed straight into linking.
698 Any file name with no recognized suffix is treated this way.
699 @end table
701 You can specify the input language explicitly with the @samp{-x} option:
703 @table @gcctabopt
704 @item -x @var{language}
705 Specify explicitly the @var{language} for the following input files
706 (rather than letting the compiler choose a default based on the file
707 name suffix).  This option applies to all following input files until
708 the next @samp{-x} option.  Possible values for @var{language} are:
709 @example
710 c  c-header  cpp-output
711 c++  c++-cpp-output
712 objective-c  objc-cpp-output
713 assembler  assembler-with-cpp
714 f77  f77-cpp-input  ratfor
715 java  chill
716 @end example
717 @c Also f77-version, for internal use only.
719 @item -x none
720 Turn off any specification of a language, so that subsequent files are
721 handled according to their file name suffixes (as they are if @samp{-x}
722 has not been used at all).
724 @item -pass-exit-codes
725 Normally the @command{gcc} program will exit with the code of 1 if any
726 phase of the compiler returns a non-success return code.  If you specify
727 @samp{-pass-exit-codes}, the @command{gcc} program will instead return with
728 numerically highest error produced by any phase that returned an error
729 indication.
730 @end table
732 If you only want some of the stages of compilation, you can use
733 @samp{-x} (or filename suffixes) to tell @command{gcc} where to start, and
734 one of the options @samp{-c}, @samp{-S}, or @samp{-E} to say where
735 @command{gcc} is to stop.  Note that some combinations (for example,
736 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
738 @table @gcctabopt
739 @item -c
740 Compile or assemble the source files, but do not link.  The linking
741 stage simply is not done.  The ultimate output is in the form of an
742 object file for each source file.
744 By default, the object file name for a source file is made by replacing
745 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
747 Unrecognized input files, not requiring compilation or assembly, are
748 ignored.
750 @item -S
751 Stop after the stage of compilation proper; do not assemble.  The output
752 is in the form of an assembler code file for each non-assembler input
753 file specified.
755 By default, the assembler file name for a source file is made by
756 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
758 Input files that don't require compilation are ignored.
760 @item -E
761 Stop after the preprocessing stage; do not run the compiler proper.  The
762 output is in the form of preprocessed source code, which is sent to the
763 standard output.
765 Input files which don't require preprocessing are ignored.
767 @cindex output file option
768 @item -o @var{file}
769 Place output in file @var{file}.  This applies regardless to whatever
770 sort of output is being produced, whether it be an executable file,
771 an object file, an assembler file or preprocessed C code.
773 Since only one output file can be specified, it does not make sense to
774 use @samp{-o} when compiling more than one input file, unless you are
775 producing an executable file as output.
777 If @samp{-o} is not specified, the default is to put an executable file
778 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
779 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
780 all preprocessed C source on standard output.@refill
782 @item -v
783 Print (on standard error output) the commands executed to run the stages
784 of compilation.  Also print the version number of the compiler driver
785 program and of the preprocessor and the compiler proper.
787 @item -pipe
788 Use pipes rather than temporary files for communication between the
789 various stages of compilation.  This fails to work on some systems where
790 the assembler is unable to read from a pipe; but the GNU assembler has
791 no trouble.
793 @item --help
794 Print (on the standard output) a description of the command line options
795 understood by @command{gcc}.  If the @option{-v} option is also specified
796 then @option{--help} will also be passed on to the various processes
797 invoked by @command{gcc}, so that they can display the command line options
798 they accept.  If the @option{-W} option is also specified then command
799 line options which have no documentation associated with them will also
800 be displayed.
802 @item --target-help
803 Print (on the standard output) a description of target specific command
804 line options for each tool.
805 @end table
807 @node Invoking G++
808 @section Compiling C++ Programs
810 @cindex suffixes for C++ source
811 @cindex C++ source file suffixes
812 C++ source files conventionally use one of the suffixes @samp{.C},
813 @samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
814 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
815 files with these names and compiles them as C++ programs even if you
816 call the compiler the same way as for compiling C programs (usually with
817 the name @command{gcc}).
819 @findex g++
820 @findex c++
821 However, C++ programs often require class libraries as well as a
822 compiler that understands the C++ language---and under some
823 circumstances, you might want to compile programs from standard input,
824 or otherwise without a suffix that flags them as C++ programs.
825 @command{g++} is a program that calls GCC with the default language
826 set to C++, and automatically specifies linking against the C++
827 library.  On many systems, @command{g++} is also
828 installed with the name @command{c++}.
830 @cindex invoking @command{g++}
831 When you compile C++ programs, you may specify many of the same
832 command-line options that you use for compiling programs in any
833 language; or command-line options meaningful for C and related
834 languages; or options that are meaningful only for C++ programs.
835 @xref{C Dialect Options,,Options Controlling C Dialect}, for
836 explanations of options for languages related to C.
837 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
838 explanations of options that are meaningful only for C++ programs.
840 @node C Dialect Options
841 @section Options Controlling C Dialect
842 @cindex dialect options
843 @cindex language dialect options
844 @cindex options, dialect
846 The following options control the dialect of C (or languages derived
847 from C, such as C++ and Objective C) that the compiler accepts:
849 @table @gcctabopt
850 @cindex ANSI support
851 @cindex ISO support
852 @item -ansi
853 In C mode, support all ISO C89 programs.  In C++ mode,
854 remove GNU extensions that conflict with ISO C++.
856 This turns off certain features of GCC that are incompatible with ISO
857 C (when compiling C code), or of standard C++ (when compiling C++ code),
858 such as the @code{asm} and @code{typeof} keywords, and
859 predefined macros such as @code{unix} and @code{vax} that identify the
860 type of system you are using.  It also enables the undesirable and
861 rarely used ISO trigraph feature.  For the C compiler, 
862 it disables recognition of C++ style @samp{//} comments as well as
863 the @code{inline} keyword.
865 The alternate keywords @code{__asm__}, @code{__extension__},
866 @code{__inline__} and @code{__typeof__} continue to work despite
867 @samp{-ansi}.  You would not want to use them in an ISO C program, of
868 course, but it is useful to put them in header files that might be included
869 in compilations done with @samp{-ansi}.  Alternate predefined macros
870 such as @code{__unix__} and @code{__vax__} are also available, with or
871 without @samp{-ansi}.
873 The @samp{-ansi} option does not cause non-ISO programs to be
874 rejected gratuitously.  For that, @samp{-pedantic} is required in
875 addition to @samp{-ansi}.  @xref{Warning Options}.
877 The macro @code{__STRICT_ANSI__} is predefined when the @samp{-ansi}
878 option is used.  Some header files may notice this macro and refrain
879 from declaring certain functions or defining certain macros that the
880 ISO standard doesn't call for; this is to avoid interfering with any
881 programs that might use these names for other things.
883 Functions which would normally be builtin but do not have semantics
884 defined by ISO C (such as @code{alloca} and @code{ffs}) are not builtin
885 functions with @samp{-ansi} is used.  @xref{Other Builtins,,Other
886 built-in functions provided by GNU CC}, for details of the functions
887 affected.
889 @item -std=
890 Determine the language standard.  A value for this option must be provided;
891 possible values are 
893 @table @samp
894 @item iso9899:1990
895 Same as @option{-ansi}
897 @item iso9899:199409
898 ISO C as modified in amend. 1
900 @item iso9899:1999
901 ISO C99.  Note that this standard is not yet fully supported; see
902 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.
904 @item c89
905 same as @option{-std=iso9899:1990}
907 @item c99
908 same as @option{-std=iso9899:1999}
910 @item gnu89
911 default, iso9899:1990 + gnu extensions
913 @item gnu99
914 iso9899:1999 + gnu extensions
916 @item iso9899:199x
917 same as @option{-std=iso9899:1999}, deprecated
919 @item c9x
920 same as @option{-std=iso9899:1999}, deprecated
922 @item gnu9x
923 same as @option{-std=gnu99}, deprecated
925 @end table
927 Even when this option is not specified, you can still use some of the
928 features of newer standards in so far as they do not conflict with
929 previous C standards.  For example, you may use @code{__restrict__} even
930 when @option{-std=c99} is not specified.
932 The @option{-std} options specifying some version of ISO C have the same
933 effects as @option{-ansi}, except that features that were not in ISO C89
934 but are in the specified version (for example, @samp{//} comments and
935 the @code{inline} keyword in ISO C99) are not disabled.
937 @xref{Standards,,Language Standards Supported by GCC}, for details of
938 these standard versions.
940 @item -fno-asm
941 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
942 keyword, so that code can use these words as identifiers.  You can use
943 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
944 instead.  @samp{-ansi} implies @samp{-fno-asm}.
946 In C++, this switch only affects the @code{typeof} keyword, since
947 @code{asm} and @code{inline} are standard keywords.  You may want to
948 use the @samp{-fno-gnu-keywords} flag instead, which has the same
949 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
950 switch only affects the @code{asm} and @code{typeof} keywords, since
951 @code{inline} is a standard keyword in ISO C99.
953 @item -fno-builtin
954 @cindex builtin functions
955 Don't recognize builtin functions that do not begin with
956 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
957 functions provided by GNU CC}, for details of the functions affected,
958 including those which are not builtin functions when @option{-ansi} or
959 @option{-std} options for strict ISO C conformance are used because they
960 do not have an ISO standard meaning.
962 GCC normally generates special code to handle certain builtin functions
963 more efficiently; for instance, calls to @code{alloca} may become single
964 instructions that adjust the stack directly, and calls to @code{memcpy}
965 may become inline copy loops.  The resulting code is often both smaller
966 and faster, but since the function calls no longer appear as such, you
967 cannot set a breakpoint on those calls, nor can you change the behavior
968 of the functions by linking with a different library.
970 @item -fhosted
971 @cindex hosted environment
973 Assert that compilation takes place in a hosted environment.  This implies
974 @samp{-fbuiltin}.  A hosted environment is one in which the
975 entire standard library is available, and in which @code{main} has a return
976 type of @code{int}.  Examples are nearly everything except a kernel.
977 This is equivalent to @samp{-fno-freestanding}.
979 @item -ffreestanding
980 @cindex hosted environment
982 Assert that compilation takes place in a freestanding environment.  This
983 implies @samp{-fno-builtin}.  A freestanding environment
984 is one in which the standard library may not exist, and program startup may
985 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
986 This is equivalent to @samp{-fno-hosted}.
988 @xref{Standards,,Language Standards Supported by GCC}, for details of
989 freestanding and hosted environments.
991 @item -trigraphs
992 Support ISO C trigraphs.  You don't want to know about this
993 brain-damage.  The @option{-ansi} option (and @option{-std} options for
994 strict ISO C conformance) implies @option{-trigraphs}.
996 @cindex traditional C language
997 @cindex C language, traditional
998 @item -traditional
999 Attempt to support some aspects of traditional C compilers.
1000 Specifically:
1002 @itemize @bullet
1003 @item
1004 All @code{extern} declarations take effect globally even if they
1005 are written inside of a function definition.  This includes implicit
1006 declarations of functions.
1008 @item
1009 The newer keywords @code{typeof}, @code{inline}, @code{signed}, @code{const}
1010 and @code{volatile} are not recognized.  (You can still use the
1011 alternative keywords such as @code{__typeof__}, @code{__inline__}, and
1012 so on.)
1014 @item
1015 Comparisons between pointers and integers are always allowed.
1017 @item
1018 Integer types @code{unsigned short} and @code{unsigned char} promote
1019 to @code{unsigned int}.
1021 @item
1022 Out-of-range floating point literals are not an error.
1024 @item
1025 Certain constructs which ISO regards as a single invalid preprocessing
1026 number, such as @samp{0xe-0xd}, are treated as expressions instead.
1028 @item
1029 String ``constants'' are not necessarily constant; they are stored in
1030 writable space, and identical looking constants are allocated
1031 separately.  (This is the same as the effect of
1032 @samp{-fwritable-strings}.)
1034 @cindex @code{longjmp} and automatic variables
1035 @item
1036 All automatic variables not declared @code{register} are preserved by
1037 @code{longjmp}.  Ordinarily, GNU C follows ISO C: automatic variables
1038 not declared @code{volatile} may be clobbered.
1040 @item
1041 @kindex \x
1042 @kindex \a
1043 @cindex escape sequences, traditional
1044 The character escape sequences @samp{\x} and @samp{\a} evaluate as the
1045 literal characters @samp{x} and @samp{a} respectively.  Without
1046 @w{@samp{-traditional}}, @samp{\x} is a prefix for the hexadecimal
1047 representation of a character, and @samp{\a} produces a bell.
1048 @end itemize
1050 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
1051 if your program uses names that are normally GNU C builtin functions for
1052 other purposes of its own.
1054 You cannot use @samp{-traditional} if you include any header files that
1055 rely on ISO C features.  Some vendors are starting to ship systems with
1056 ISO C header files and you cannot use @samp{-traditional} on such
1057 systems to compile files that include any system headers.
1059 The @samp{-traditional} option also enables @samp{-traditional-cpp},
1060 which is described next.
1062 @item -traditional-cpp
1063 Attempt to support some aspects of traditional C preprocessors.
1064 Specifically:
1066 @itemize @bullet
1067 @item
1068 Comments convert to nothing at all, rather than to a space.  This allows
1069 traditional token concatenation.
1071 @item
1072 In a preprocessing directive, the @samp{#} symbol must appear as the first
1073 character of a line.
1075 @item
1076 Macro arguments are recognized within string constants in a macro
1077 definition (and their values are stringified, though without additional
1078 quote marks, when they appear in such a context).  The preprocessor
1079 always considers a string constant to end at a newline.
1081 @item
1082 @cindex detecting @w{@samp{-traditional}}
1083 The predefined macro @code{__STDC__} is not defined when you use
1084 @samp{-traditional}, but @code{__GNUC__} is (since the GNU extensions
1085 which @code{__GNUC__} indicates are not affected by
1086 @samp{-traditional}).  If you need to write header files that work
1087 differently depending on whether @samp{-traditional} is in use, by
1088 testing both of these predefined macros you can distinguish four
1089 situations: GNU C, traditional GNU C, other ISO C compilers, and other
1090 old C compilers.  The predefined macro @code{__STDC_VERSION__} is also
1091 not defined when you use @samp{-traditional}.  @xref{Standard
1092 Predefined,,Standard Predefined Macros,cpp.info,The C Preprocessor},
1093 for more discussion of these and other predefined macros.
1095 @item
1096 @cindex string constants vs newline
1097 @cindex newline vs string constants
1098 The preprocessor considers a string constant to end at a newline (unless
1099 the newline is escaped with @samp{\}).  (Without @w{@samp{-traditional}},
1100 string constants can contain the newline character as typed.)
1101 @end itemize
1103 @item -fcond-mismatch
1104 Allow conditional expressions with mismatched types in the second and
1105 third arguments.  The value of such an expression is void.  This option
1106 is not supported for C++.
1108 @item -funsigned-char
1109 Let the type @code{char} be unsigned, like @code{unsigned char}.
1111 Each kind of machine has a default for what @code{char} should
1112 be.  It is either like @code{unsigned char} by default or like
1113 @code{signed char} by default.
1115 Ideally, a portable program should always use @code{signed char} or
1116 @code{unsigned char} when it depends on the signedness of an object.
1117 But many programs have been written to use plain @code{char} and
1118 expect it to be signed, or expect it to be unsigned, depending on the
1119 machines they were written for.  This option, and its inverse, let you
1120 make such a program work with the opposite default.
1122 The type @code{char} is always a distinct type from each of
1123 @code{signed char} or @code{unsigned char}, even though its behavior
1124 is always just like one of those two.
1126 @item -fsigned-char
1127 Let the type @code{char} be signed, like @code{signed char}.
1129 Note that this is equivalent to @samp{-fno-unsigned-char}, which is
1130 the negative form of @samp{-funsigned-char}.  Likewise, the option
1131 @samp{-fno-signed-char} is equivalent to @samp{-funsigned-char}.
1133 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
1134 if your program uses names that are normally GNU C builtin functions for
1135 other purposes of its own.
1137 You cannot use @samp{-traditional} if you include any header files that
1138 rely on ISO C features.  Some vendors are starting to ship systems with
1139 ISO C header files and you cannot use @samp{-traditional} on such
1140 systems to compile files that include any system headers.
1142 @item -fsigned-bitfields
1143 @itemx -funsigned-bitfields
1144 @itemx -fno-signed-bitfields
1145 @itemx -fno-unsigned-bitfields
1146 These options control whether a bitfield is signed or unsigned, when the
1147 declaration does not use either @code{signed} or @code{unsigned}.  By
1148 default, such a bitfield is signed, because this is consistent: the
1149 basic integer types such as @code{int} are signed types.
1151 However, when @samp{-traditional} is used, bitfields are all unsigned
1152 no matter what.
1154 @item -fwritable-strings
1155 Store string constants in the writable data segment and don't uniquize
1156 them.  This is for compatibility with old programs which assume they can
1157 write into string constants.  The option @samp{-traditional} also has
1158 this effect.
1160 Writing into string constants is a very bad idea; ``constants'' should
1161 be constant.
1163 @item -fallow-single-precision
1164 Do not promote single precision math operations to double precision,
1165 even when compiling with @samp{-traditional}.
1167 Traditional K&R C promotes all floating point operations to double
1168 precision, regardless of the sizes of the operands.   On the
1169 architecture for which you are compiling, single precision may be faster
1170 than double precision.   If you must use @samp{-traditional}, but want
1171 to use single precision operations when the operands are single
1172 precision, use this option.   This option has no effect when compiling
1173 with ISO or GNU C conventions (the default).
1175 @item -fshort-wchar
1176 Override the underlying type for @samp{wchar_t} to be @samp{short
1177 unsigned int} instead of the default for the target.  This option is
1178 useful for building programs to run under WINE.
1179 @end table
1181 @node C++ Dialect Options
1182 @section Options Controlling C++ Dialect
1184 @cindex compiler options, C++
1185 @cindex C++ options, command line
1186 @cindex options, C++
1187 This section describes the command-line options that are only meaningful
1188 for C++ programs; but you can also use most of the GNU compiler options
1189 regardless of what language your program is in.  For example, you
1190 might compile a file @code{firstClass.C} like this:
1192 @example
1193 g++ -g -frepo -O -c firstClass.C
1194 @end example
1196 @noindent
1197 In this example, only @samp{-frepo} is an option meant
1198 only for C++ programs; you can use the other options with any
1199 language supported by GCC.
1201 Here is a list of options that are @emph{only} for compiling C++ programs:
1203 @table @gcctabopt
1204 @item -fno-access-control
1205 Turn off all access checking.  This switch is mainly useful for working
1206 around bugs in the access control code.
1208 @item -fcheck-new
1209 Check that the pointer returned by @code{operator new} is non-null
1210 before attempting to modify the storage allocated.  The current Working
1211 Paper requires that @code{operator new} never return a null pointer, so
1212 this check is normally unnecessary.
1214 An alternative to using this option is to specify that your
1215 @code{operator new} does not throw any exceptions; if you declare it
1216 @samp{throw()}, g++ will check the return value.  See also @samp{new
1217 (nothrow)}.
1219 @item -fconserve-space
1220 Put uninitialized or runtime-initialized global variables into the
1221 common segment, as C does.  This saves space in the executable at the
1222 cost of not diagnosing duplicate definitions.  If you compile with this
1223 flag and your program mysteriously crashes after @code{main()} has
1224 completed, you may have an object that is being destroyed twice because
1225 two definitions were merged.
1227 This option is no longer useful on most targets, now that support has
1228 been added for putting variables into BSS without making them common.
1230 @item -fdollars-in-identifiers
1231 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1232 @samp{$} with the option @samp{-fno-dollars-in-identifiers}.  (GNU C allows
1233 @samp{$} by default on most target systems, but there are a few exceptions.)
1234 Traditional C allowed the character @samp{$} to form part of
1235 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1237 @item -fno-elide-constructors
1238 The C++ standard allows an implementation to omit creating a temporary
1239 which is only used to initialize another object of the same type.
1240 Specifying this option disables that optimization, and forces g++ to
1241 call the copy constructor in all cases.
1243 @item -fno-enforce-eh-specs
1244 Don't check for violation of exception specifications at runtime.  This
1245 option violates the C++ standard, but may be useful for reducing code
1246 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1247 will still optimize based on the exception specifications.
1249 @item -fexternal-templates
1250 Cause template instantiations to obey @samp{#pragma interface} and
1251 @samp{implementation}; template instances are emitted or not according
1252 to the location of the template definition.  @xref{Template
1253 Instantiation}, for more information.
1255 This option is deprecated.
1257 @item -falt-external-templates
1258 Similar to -fexternal-templates, but template instances are emitted or
1259 not according to the place where they are first instantiated.
1260 @xref{Template Instantiation}, for more information.
1262 This option is deprecated.
1264 @item -ffor-scope
1265 @itemx -fno-for-scope
1266 If -ffor-scope is specified, the scope of variables declared in
1267 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1268 as specified by the C++ standard.
1269 If -fno-for-scope is specified, the scope of variables declared in
1270 a @i{for-init-statement} extends to the end of the enclosing scope,
1271 as was the case in old versions of gcc, and other (traditional)
1272 implementations of C++.
1274 The default if neither flag is given to follow the standard,
1275 but to allow and give a warning for old-style code that would
1276 otherwise be invalid, or have different behavior.
1278 @item -fno-gnu-keywords
1279 Do not recognize @code{typeof} as a keyword, so that code can use this
1280 word as an identifier. You can use the keyword @code{__typeof__} instead.  
1281 @samp{-ansi} implies @samp{-fno-gnu-keywords}.
1283 @item -fhonor-std
1284 Treat the @code{namespace std} as a namespace, instead of ignoring
1285 it. For compatibility with earlier versions of g++, the compiler will,
1286 by default, ignore @code{namespace-declarations},
1287 @code{using-declarations}, @code{using-directives}, and
1288 @code{namespace-names}, if they involve @code{std}.
1290 @item -fhuge-objects
1291 Support virtual function calls for objects that exceed the size
1292 representable by a @samp{short int}.  Users should not use this flag by
1293 default; if you need to use it, the compiler will tell you so.
1295 This flag is not useful when compiling with -fvtable-thunks.
1297 Like all options that change the ABI, all C++ code, @emph{including
1298 libgcc} must be built with the same setting of this option.
1300 @item -fno-implicit-templates
1301 Never emit code for non-inline templates which are instantiated
1302 implicitly (i.e. by use); only emit code for explicit instantiations.
1303 @xref{Template Instantiation}, for more information.
1305 @item -fno-implicit-inline-templates
1306 Don't emit code for implicit instantiations of inline templates, either.
1307 The default is to handle inlines differently so that compiles with and
1308 without optimization will need the same set of explicit instantiations.
1310 @item -fno-implement-inlines
1311 To save space, do not emit out-of-line copies of inline functions
1312 controlled by @samp{#pragma implementation}.  This will cause linker
1313 errors if these functions are not inlined everywhere they are called.
1315 @item -fms-extensions
1316 Disable pedantic warnings about constructs used in MFC, such as implicit
1317 int and getting a pointer to member function via non-standard syntax.
1319 @item -fname-mangling-version-@var{n}
1320 Control the way in which names are mangled.  Version 0 is compatible
1321 with versions of g++ before 2.8.  Version 1 is the default.  Version 1
1322 will allow correct mangling of function templates.  For example, 
1323 version 0 mangling does not mangle foo<int, double> and foo<int, char>
1324 given this declaration:
1326 @example
1327 template <class T, class U> void foo(T t);
1328 @end example
1330 Like all options that change the ABI, all C++ code, @emph{including
1331 libgcc} must be built with the same setting of this option.
1333 @item -fno-operator-names
1334 Do not treat the operator name keywords @code{and}, @code{bitand},
1335 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1336 synonyms as keywords.
1338 @item -fno-optional-diags
1339 Disable diagnostics that the standard says a compiler does not need to
1340 issue.  Currently, the only such diagnostic issued by g++ is the one for
1341 a name having multiple meanings within a class.
1343 @item -fpermissive
1344 Downgrade messages about nonconformant code from errors to warnings.  By
1345 default, g++ effectively sets @samp{-pedantic-errors} without
1346 @samp{-pedantic}; this option reverses that.  This behavior and this
1347 option are superseded by @samp{-pedantic}, which works as it does for GNU C.
1349 @item -frepo
1350 Enable automatic template instantiation.  This option also implies
1351 @samp{-fno-implicit-templates}.  @xref{Template Instantiation}, for more
1352 information.
1354 @item -fno-rtti
1355 Disable generation of information about every class with virtual
1356 functions for use by the C++ runtime type identification features
1357 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1358 of the language, you can save some space by using this flag.  Note that
1359 exception handling uses the same information, but it will generate it as
1360 needed.
1362 @item -fsquangle
1363 @itemx -fno-squangle
1364 @samp{-fsquangle} will enable a compressed form of name mangling for
1365 identifiers. In particular, it helps to shorten very long names by recognizing
1366 types and class names which occur more than once, replacing them with special
1367 short ID codes.  This option also requires any C++ libraries being used to
1368 be compiled with this option as well.  The compiler has this disabled (the
1369 equivalent of @samp{-fno-squangle}) by default.
1371 Like all options that change the ABI, all C++ code, @emph{including
1372 libgcc.a} must be built with the same setting of this option.
1374 @item -ftemplate-depth-@var{n}
1375 Set the maximum instantiation depth for template classes to @var{n}.
1376 A limit on the template instantiation depth is needed to detect
1377 endless recursions during template class instantiation. ANSI/ISO C++
1378 conforming programs must not rely on a maximum depth greater than 17.
1380 @item -fuse-cxa-atexit
1381 Register destructors for objects with static storage duration with the
1382 @code{__cxa_atexit} function rather than the @code{atexit} function.
1383 This option is required for fully standards-compliant handling of static
1384 destructors, but will only work if your C library supports
1385 @code{__cxa_atexit}.
1387 @item -fvtable-thunks
1388 Use @samp{thunks} to implement the virtual function dispatch table
1389 (@samp{vtable}).  The traditional (cfront-style) approach to
1390 implementing vtables was to store a pointer to the function and two
1391 offsets for adjusting the @samp{this} pointer at the call site.  Newer
1392 implementations store a single pointer to a @samp{thunk} function which
1393 does any necessary adjustment and then calls the target function.
1395 This option also enables a heuristic for controlling emission of
1396 vtables; if a class has any non-inline virtual functions, the vtable
1397 will be emitted in the translation unit containing the first one of
1398 those.
1400 Like all options that change the ABI, all C++ code, @emph{including
1401 libgcc.a} must be built with the same setting of this option.
1403 @item -nostdinc++
1404 Do not search for header files in the standard directories specific to
1405 C++, but do still search the other standard directories.  (This option
1406 is used when building the C++ library.)
1407 @end table
1409 In addition, these optimization, warning, and code generation options
1410 have meanings only for C++ programs:
1412 @table @gcctabopt
1413 @item -fno-default-inline
1414 Do not assume @samp{inline} for functions defined inside a class scope.
1415 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1416 functions will have linkage like inline functions; they just won't be
1417 inlined by default.
1419 @item -Wctor-dtor-privacy (C++ only)
1420 Warn when a class seems unusable, because all the constructors or
1421 destructors in a class are private and the class has no friends or
1422 public static member functions.
1424 @item -Wnon-virtual-dtor (C++ only)
1425 Warn when a class declares a non-virtual destructor that should probably
1426 be virtual, because it looks like the class will be used polymorphically.
1428 @item -Wreorder (C++ only)
1429 @cindex reordering, warning
1430 @cindex warning for reordering of member initializers
1431 Warn when the order of member initializers given in the code does not
1432 match the order in which they must be executed.  For instance:
1434 @smallexample
1435 struct A @{
1436   int i;
1437   int j;
1438   A(): j (0), i (1) @{ @}
1440 @end smallexample
1442 Here the compiler will warn that the member initializers for @samp{i}
1443 and @samp{j} will be rearranged to match the declaration order of the
1444 members.
1445 @end table
1447 The following @samp{-W@dots{}} options are not affected by @samp{-Wall}.
1449 @table @gcctabopt
1450 @item -Weffc++ (C++ only)
1451 Warn about violations of various style guidelines from Scott Meyers'
1452 @cite{Effective C++} books.  If you use this option, you should be aware
1453 that the standard library headers do not obey all of these guidelines;
1454 you can use @samp{grep -v} to filter out those warnings.
1456 @item -Wno-deprecated (C++ only)
1457 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1459 @item -Wno-non-template-friend (C++ only)
1460 Disable warnings when non-templatized friend functions are declared
1461 within a template. With the advent of explicit template specification
1462 support in g++, if the name of the friend is an unqualified-id (ie,
1463 @samp{friend foo(int)}), the C++ language specification demands that the
1464 friend declare or define an ordinary, nontemplate function. (Section
1465 14.5.3). Before g++ implemented explicit specification, unqualified-ids
1466 could be interpreted as a particular specialization of a templatized
1467 function. Because this non-conforming behavior is no longer the default
1468 behavior for g++, @samp{-Wnon-template-friend} allows the compiler to
1469 check existing code for potential trouble spots, and is on by default.
1470 This new compiler behavior can be turned off with
1471 @samp{-Wno-non-template-friend} which keeps the conformant compiler code
1472 but disables the helpful warning.
1474 @item -Wold-style-cast (C++ only)
1475 Warn if an old-style (C-style) cast is used within a C++ program.  The
1476 new-style casts (@samp{static_cast}, @samp{reinterpret_cast}, and
1477 @samp{const_cast}) are less vulnerable to unintended effects.
1479 @item -Woverloaded-virtual (C++ only)
1480 @cindex overloaded virtual fn, warning
1481 @cindex warning for overloaded virtual fn
1482 Warn when a derived class function declaration may be an error in
1483 defining a virtual function.  In a derived class, the
1484 definitions of virtual functions must match the type signature of a
1485 virtual function declared in the base class.  With this option, the
1486 compiler warns when you define a function with the same name as a
1487 virtual function, but with a type signature that does not match any
1488 declarations from the base class.
1490 @item -Wno-pmf-conversions (C++ only)
1491 Disable the diagnostic for converting a bound pointer to member function
1492 to a plain pointer.
1494 @item -Wsign-promo (C++ only)
1495 Warn when overload resolution chooses a promotion from unsigned or
1496 enumeral type to a signed type over a conversion to an unsigned type of
1497 the same size.  Previous versions of g++ would try to preserve
1498 unsignedness, but the standard mandates the current behavior.
1500 @item -Wsynth (C++ only)
1501 @cindex warning for synthesized methods
1502 @cindex synthesized methods, warning
1503 Warn when g++'s synthesis behavior does not match that of cfront.  For
1504 instance:
1506 @smallexample
1507 struct A @{
1508   operator int ();
1509   A& operator = (int);
1512 main ()
1514   A a,b;
1515   a = b;
1517 @end smallexample
1519 In this example, g++ will synthesize a default @samp{A& operator =
1520 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1521 @end table
1523 @node Language Independent Options
1524 @section Options to Control Diagnostic Messages Formatting
1525 @cindex options to control diagnostics formatting
1526 @cindex diagnostic messages
1527 @cindex message formatting
1529 Traditionally, diagnostic messages have been formatted irrespective of
1530 the output device's aspect (e.g. its width, ...).  The options described
1531 below can be used to control the diagnostic messages formatting
1532 algorithm, e.g. how many characters per line, how often source location
1533 information should be reported.  Right now, only the C++ front-end can
1534 honor these options.  However it is expected, in the near future, that
1535 the remaining front-ends would be able to digest them correctly. 
1537 @table @gcctabopt
1538 @item -fmessage-length=@var{n}
1539 Try to format error messages so that they fit on lines of about @var{n}
1540 characters.  The default is 72 characters for g++ and 0 for the rest of
1541 the front-ends supported by GCC.  If @var{n} is zero, then no
1542 line-wrapping will be done; each error message will appear on a single 
1543 line.
1545 @item -fdiagnostics-show-location=once
1546 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1547 reporter to emit @emph{once} source location information; that is, in
1548 case the message is too long to fit on a single physical line and has to
1549 be wrapped, the source location won't be emitted (as prefix) again,
1550 over and over, in subsequent continuation lines.  This is the default
1551 behaviour. 
1553 @item -fdiagnostics-show-location=every-line
1554 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1555 messages reporter to emit the same source location information (as
1556 prefix) for physical lines that result from the process of breaking a
1557 a message which is too long to fit on a single line.
1559 @end table
1561 @node Warning Options
1562 @section Options to Request or Suppress Warnings
1563 @cindex options to control warnings
1564 @cindex warning messages
1565 @cindex messages, warning
1566 @cindex suppressing warnings
1568 Warnings are diagnostic messages that report constructions which
1569 are not inherently erroneous but which are risky or suggest there
1570 may have been an error.
1572 You can request many specific warnings with options beginning @samp{-W},
1573 for example @samp{-Wimplicit} to request warnings on implicit
1574 declarations.  Each of these specific warning options also has a
1575 negative form beginning @samp{-Wno-} to turn off warnings;
1576 for example, @samp{-Wno-implicit}.  This manual lists only one of the
1577 two forms, whichever is not the default.
1579 These options control the amount and kinds of warnings produced by GCC:
1581 @table @gcctabopt
1582 @cindex syntax checking
1583 @item -fsyntax-only
1584 Check the code for syntax errors, but don't do anything beyond that.
1586 @item -pedantic
1587 Issue all the warnings demanded by strict ISO C and ISO C++;
1588 reject all programs that use forbidden extensions, and some other
1589 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1590 version of the ISO C standard specified by any @samp{-std} option used.
1592 Valid ISO C and ISO C++ programs should compile properly with or without
1593 this option (though a rare few will require @option{-ansi} or a
1594 @option{-std} option specifying the required version of ISO C).  However,
1595 without this option, certain GNU extensions and traditional C and C++
1596 features are supported as well.  With this option, they are rejected.
1598 @samp{-pedantic} does not cause warning messages for use of the
1599 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1600 warnings are also disabled in the expression that follows
1601 @code{__extension__}.  However, only system header files should use
1602 these escape routes; application programs should avoid them.
1603 @xref{Alternate Keywords}.
1605 Some users try to use @samp{-pedantic} to check programs for strict ISO
1606 C conformance.  They soon find that it does not do quite what they want:
1607 it finds some non-ISO practices, but not all---only those for which
1608 ISO C @emph{requires} a diagnostic, and some others for which
1609 diagnostics have been added.
1611 A feature to report any failure to conform to ISO C might be useful in
1612 some instances, but would require considerable additional work and would
1613 be quite different from @samp{-pedantic}.  We don't have plans to
1614 support such a feature in the near future.
1616 @item -pedantic-errors
1617 Like @samp{-pedantic}, except that errors are produced rather than
1618 warnings.
1620 @item -w
1621 Inhibit all warning messages.
1623 @item -Wno-import
1624 Inhibit warning messages about the use of @samp{#import}.
1626 @item -Wchar-subscripts
1627 Warn if an array subscript has type @code{char}.  This is a common cause
1628 of error, as programmers often forget that this type is signed on some
1629 machines.
1631 @item -Wcomment
1632 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1633 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1635 @item -Wformat
1636 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1637 the arguments supplied have types appropriate to the format string
1638 specified, and that the conversions specified in the format string make
1639 sense.  This includes standard functions, and others specified by format
1640 attributes (@pxref{Function Attributes}), in the @code{printf},
1641 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1642 not in the C standard) families.
1644 The formats are checked against the format features supported by GNU
1645 libc version 2.2.  These include all ISO C89 and C99 features, as well
1646 as features from the Single Unix Specification and some BSD and GNU
1647 extensions.  Other library implementations may not support all these
1648 features; GCC does not support warning about features that go beyond a
1649 particular library's limitations.  However, if @samp{-pedantic} is used
1650 with @samp{-Wformat}, warnings will be given about format features not
1651 in the selected standard version (but not for @code{strfmon} formats,
1652 since those are not in any version of the C standard).  @xref{C Dialect
1653 Options,,Options Controlling C Dialect}.
1655 @samp{-Wformat} is included in @samp{-Wall}.  For more control over some
1656 aspects of format checking, the options @samp{-Wno-format-y2k},
1657 @samp{-Wno-format-extra-args}, @samp{-Wformat-nonliteral},
1658 @samp{-Wformat-security} and @samp{-Wformat=2} are available, but are
1659 not included in @samp{-Wall}.
1661 @item -Wno-format-y2k
1662 If @samp{-Wformat} is specified, do not warn about @code{strftime}
1663 formats which may yield only a two-digit year.
1665 @item -Wno-format-extra-args
1666 If @samp{-Wformat} is specified, do not warn about excess arguments to a
1667 @code{printf} or @code{scanf} format function.  The C standard specifies
1668 that such arguments are ignored.
1670 @item -Wformat-nonliteral
1671 If @samp{-Wformat} is specified, also warn if the format string is not a
1672 string literal and so cannot be checked, unless the format function
1673 takes its format arguments as a @code{va_list}.
1675 @item -Wformat-security
1676 If @samp{-Wformat} is specified, also warn about uses of format
1677 functions that represent possible security problems.  At present, this
1678 warns about calls to @code{printf} and @code{scanf} functions where the
1679 format string is not a string literal and there are no format arguments,
1680 as in @code{printf (foo);}.  This may be a security hole if the format
1681 string came from untrusted input and contains @samp{%n}.  (This is
1682 currently a subset of what @samp{-Wformat-nonliteral} warns about, but
1683 in future warnings may be added to @samp{-Wformat-security} that are not
1684 included in @samp{-Wformat-nonliteral}.)
1686 @item -Wformat=2
1687 Enable @samp{-Wformat} plus format checks not included in
1688 @samp{-Wformat}.  Currently equivalent to @samp{-Wformat
1689 -Wformat-nonliteral -Wformat-security}.
1691 @item -Wimplicit-int
1692 Warn when a declaration does not specify a type.
1694 @item -Wimplicit-function-declaration
1695 @itemx -Werror-implicit-function-declaration
1696 Give a warning (or error) whenever a function is used before being
1697 declared.
1699 @item -Wimplicit
1700 Same as @samp{-Wimplicit-int} and @samp{-Wimplicit-function-}@*
1701 @samp{declaration}.
1703 @item -Wmain
1704 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
1705 function with external linkage, returning int, taking either zero
1706 arguments, two, or three arguments of appropriate types.
1708 @item -Wmultichar
1709 Warn if a multicharacter constant (@samp{'FOOF'}) is used.  Usually they
1710 indicate a typo in the user's code, as they have implementation-defined
1711 values, and should not be used in portable code.
1713 @item -Wparentheses
1714 Warn if parentheses are omitted in certain contexts, such
1715 as when there is an assignment in a context where a truth value
1716 is expected, or when operators are nested whose precedence people
1717 often get confused about.
1719 Also warn about constructions where there may be confusion to which
1720 @code{if} statement an @code{else} branch belongs.  Here is an example of
1721 such a case:
1723 @smallexample
1725   if (a)
1726     if (b)
1727       foo ();
1728   else
1729     bar ();
1731 @end smallexample
1733 In C, every @code{else} branch belongs to the innermost possible @code{if}
1734 statement, which in this example is @code{if (b)}.  This is often not
1735 what the programmer expected, as illustrated in the above example by
1736 indentation the programmer chose.  When there is the potential for this
1737 confusion, GNU C will issue a warning when this flag is specified.
1738 To eliminate the warning, add explicit braces around the innermost
1739 @code{if} statement so there is no way the @code{else} could belong to
1740 the enclosing @code{if}.  The resulting code would look like this:
1742 @smallexample
1744   if (a)
1745     @{
1746       if (b)
1747         foo ();
1748       else
1749         bar ();
1750     @}
1752 @end smallexample
1754 @item -Wsequence-point
1755 Warn about code that may have undefined semantics because of violations
1756 of sequence point rules in the C standard.
1758 The C standard defines the order in which expressions in a C program are
1759 evaluated in terms of @dfn{sequence points}, which represent a partial
1760 ordering between the execution of parts of the program: those executed
1761 before the sequence point, and those executed after it.  These occur
1762 after the evaluation of a full expression (one which is not part of a
1763 larger expression), after the evaluation of the first operand of a
1764 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
1765 function is called (but after the evaluation of its arguments and the
1766 expression denoting the called function), and in certain other places.
1767 Other than as expressed by the sequence point rules, the order of
1768 evaluation of subexpressions of an expression is not specified.  All
1769 these rules describe only a partial order rather than a total order,
1770 since, for example, if two functions are called within one expression
1771 with no sequence point between them, the order in which the functions
1772 are called is not specified.  However, the standards committee have
1773 ruled that function calls do not overlap.
1775 It is not specified when between sequence points modifications to the
1776 values of objects take effect.  Programs whose behavior depends on this
1777 have undefined behavior; the C standard specifies that ``Between the
1778 previous and next sequence point an object shall have its stored value
1779 modified at most once by the evaluation of an expression.  Furthermore,
1780 the prior value shall be read only to determine the value to be
1781 stored.''.  If a program breaks these rules, the results on any
1782 particular implementation are entirely unpredictable.
1784 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
1785 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
1786 diagnosed by this option, and it may give an occasional false positive
1787 result, but in general it has been found fairly effective at detecting
1788 this sort of problem in programs.
1790 The present implementation of this option only works for C programs.  A
1791 future implementation may also work for C++ programs.
1793 There is some controversy over the precise meaning of the sequence point
1794 rules in subtle cases.  Alternative formal definitions may be found in
1795 Clive Feather's ``Annex S''
1796 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n925.htm}} and in
1797 Michael Norrish's thesis
1798 @w{@uref{http://www.cl.cam.ac.uk/users/mn200/PhD/thesis-report.ps.gz}}.
1799 Other discussions are by Raymond Mak
1800 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n926.htm}} and
1801 D. Hugh Redelmeier
1802 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n927.htm}}.
1804 @item -Wreturn-type
1805 Warn whenever a function is defined with a return-type that defaults to
1806 @code{int}.  Also warn about any @code{return} statement with no
1807 return-value in a function whose return-type is not @code{void}. 
1809 For C++, a function without return type always produces a diagnostic
1810 message, even when @samp{-Wno-return-type} is specified. The only
1811 exceptions are @samp{main} and functions defined in system headers.
1813 @item -Wswitch
1814 Warn whenever a @code{switch} statement has an index of enumeral type
1815 and lacks a @code{case} for one or more of the named codes of that
1816 enumeration.  (The presence of a @code{default} label prevents this
1817 warning.)  @code{case} labels outside the enumeration range also
1818 provoke warnings when this option is used.
1820 @item -Wtrigraphs
1821 Warn if any trigraphs are encountered that might change the meaning of
1822 the program (trigraphs within comments are not warned about).
1824 @item -Wunused-function
1825 Warn whenever a static function is declared but not defined or a
1826 non\-inline static function is unused.
1828 @item -Wunused-label
1829 Warn whenever a label is declared but not used.
1831 To suppress this warning use the @samp{unused} attribute
1832 (@pxref{Variable Attributes}).
1834 @item -Wunused-parameter
1835 Warn whenever a function parameter is unused aside from its declaration.
1837 To suppress this warning use the @samp{unused} attribute
1838 (@pxref{Variable Attributes}).
1840 @item -Wunused-variable
1841 Warn whenever a local variable or non-constant static variable is unused
1842 aside from its declaration
1844 To suppress this warning use the @samp{unused} attribute
1845 (@pxref{Variable Attributes}).
1847 @item -Wunused-value
1848 Warn whenever a statement computes a result that is explicitly not used.
1850 To suppress this warning cast the expression to @samp{void}.
1852 @item -Wunused
1853 All all the above @samp{-Wunused} options combined.
1855 In order to get a warning about an unused function parameter, you must
1856 either specify @samp{-W -Wunused} or separately specify
1857 @samp{-Wunused-parameter}.
1859 @item -Wuninitialized
1860 Warn if an automatic variable is used without first being initialized or
1861 if a variable may be clobbered by a @code{setjmp} call.
1863 These warnings are possible only in optimizing compilation,
1864 because they require data flow information that is computed only
1865 when optimizing.  If you don't specify @samp{-O}, you simply won't
1866 get these warnings.
1868 These warnings occur only for variables that are candidates for
1869 register allocation.  Therefore, they do not occur for a variable that
1870 is declared @code{volatile}, or whose address is taken, or whose size
1871 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
1872 structures, unions or arrays, even when they are in registers.
1874 Note that there may be no warning about a variable that is used only
1875 to compute a value that itself is never used, because such
1876 computations may be deleted by data flow analysis before the warnings
1877 are printed.
1879 These warnings are made optional because GCC is not smart
1880 enough to see all the reasons why the code might be correct
1881 despite appearing to have an error.  Here is one example of how
1882 this can happen:
1884 @smallexample
1886   int x;
1887   switch (y)
1888     @{
1889     case 1: x = 1;
1890       break;
1891     case 2: x = 4;
1892       break;
1893     case 3: x = 5;
1894     @}
1895   foo (x);
1897 @end smallexample
1899 @noindent
1900 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
1901 always initialized, but GCC doesn't know this.  Here is
1902 another common case:
1904 @smallexample
1906   int save_y;
1907   if (change_y) save_y = y, y = new_y;
1908   @dots{}
1909   if (change_y) y = save_y;
1911 @end smallexample
1913 @noindent
1914 This has no bug because @code{save_y} is used only if it is set.
1916 @cindex @code{longjmp} warnings
1917 This option also warns when a non-volatile automatic variable might be
1918 changed by a call to @code{longjmp}.  These warnings as well are possible
1919 only in optimizing compilation.
1921 The compiler sees only the calls to @code{setjmp}.  It cannot know
1922 where @code{longjmp} will be called; in fact, a signal handler could
1923 call it at any point in the code.  As a result, you may get a warning
1924 even when there is in fact no problem because @code{longjmp} cannot
1925 in fact be called at the place which would cause a problem.
1927 Some spurious warnings can be avoided if you declare all the functions
1928 you use that never return as @code{noreturn}.  @xref{Function
1929 Attributes}.
1931 @item -Wreorder (C++ only)
1932 @cindex reordering, warning
1933 @cindex warning for reordering of member initializers
1934 Warn when the order of member initializers given in the code does not
1935 match the order in which they must be executed.  For instance:
1937 @item -Wunknown-pragmas
1938 @cindex warning for unknown pragmas
1939 @cindex unknown pragmas, warning
1940 @cindex pragmas, warning of unknown
1941 Warn when a #pragma directive is encountered which is not understood by
1942 GCC.  If this command line option is used, warnings will even be issued
1943 for unknown pragmas in system header files.  This is not the case if
1944 the warnings were only enabled by the @samp{-Wall} command line option.
1946 @item -Wall
1947 All of the above @samp{-W} options combined.  This enables all the
1948 warnings about constructions that some users consider questionable, and
1949 that are easy to avoid (or modify to prevent the warning), even in
1950 conjunction with macros.
1952 @item -Wsystem-headers
1953 @cindex warnings from system headers
1954 @cindex system headers, warnings from
1955 Print warning messages for constructs found in system header files.
1956 Warnings from system headers are normally suppressed, on the assumption
1957 that they usually do not indicate real problems and would only make the
1958 compiler output harder to read.  Using this command line option tells
1959 GCC to emit warnings from system headers as if they occurred in user
1960 code.  However, note that using @samp{-Wall} in conjunction with this
1961 option will @emph{not} warn about unknown pragmas in system
1962 headers---for that, @samp{-Wunknown-pragmas} must also be used.
1963 @end table
1965 The following @samp{-W@dots{}} options are not implied by @samp{-Wall}.
1966 Some of them warn about constructions that users generally do not
1967 consider questionable, but which occasionally you might wish to check
1968 for; others warn about constructions that are necessary or hard to avoid
1969 in some cases, and there is no simple way to modify the code to suppress
1970 the warning.
1972 @table @gcctabopt
1973 @item -W
1974 Print extra warning messages for these events:
1976 @itemize @bullet
1977 @item
1978 A function can return either with or without a value.  (Falling
1979 off the end of the function body is considered returning without
1980 a value.)  For example, this function would evoke such a
1981 warning:
1983 @smallexample
1984 @group
1985 foo (a)
1987   if (a > 0)
1988     return a;
1990 @end group
1991 @end smallexample
1993 @item
1994 An expression-statement or the left-hand side of a comma expression
1995 contains no side effects.
1996 To suppress the warning, cast the unused expression to void.
1997 For example, an expression such as @samp{x[i,j]} will cause a warning,
1998 but @samp{x[(void)i,j]} will not.
2000 @item
2001 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
2003 @item
2004 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2005 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2006 that of ordinary mathematical notation.
2008 @item
2009 Storage-class specifiers like @code{static} are not the first things in
2010 a declaration.  According to the C Standard, this usage is obsolescent.
2012 @item
2013 The return type of a function has a type qualifier such as @code{const}.
2014 Such a type qualifier has no effect, since the value returned by a
2015 function is not an lvalue.  (But don't warn about the GNU extension of
2016 @code{volatile void} return types.  That extension will be warned about
2017 if @samp{-pedantic} is specified.)
2019 @item
2020 If @samp{-Wall} or @samp{-Wunused} is also specified, warn about unused
2021 arguments.
2023 @item
2024 A comparison between signed and unsigned values could produce an
2025 incorrect result when the signed value is converted to unsigned.
2026 (But don't warn if @samp{-Wno-sign-compare} is also specified.)
2028 @item
2029 An aggregate has a partly bracketed initializer.
2030 For example, the following code would evoke such a warning,
2031 because braces are missing around the initializer for @code{x.h}:
2033 @smallexample
2034 struct s @{ int f, g; @};
2035 struct t @{ struct s h; int i; @};
2036 struct t x = @{ 1, 2, 3 @};
2037 @end smallexample
2039 @item
2040 An aggregate has an initializer which does not initialize all members.
2041 For example, the following code would cause such a warning, because
2042 @code{x.h} would be implicitly initialized to zero:
2044 @smallexample
2045 struct s @{ int f, g, h; @};
2046 struct s x = @{ 3, 4 @};
2047 @end smallexample
2048 @end itemize
2050 @item -Wfloat-equal
2051 Warn if floating point values are used in equality comparisons.
2053 The idea behind this is that sometimes it is convenient (for the
2054 programmer) to consider floating-point values as approximations to
2055 infinitely precise real numbers.  If you are doing this, then you need
2056 to compute (by analysing the code, or in some other way) the maximum or
2057 likely maximum error that the computation introduces, and allow for it
2058 when performing comparisons (and when producing output, but that's a
2059 different problem).  In particular, instead of testing for equality, you
2060 would check to see whether the two values have ranges that overlap; and
2061 this is done with the relational operators, so equality comparisons are
2062 probably mistaken.
2064 @item -Wtraditional (C only)
2065 Warn about certain constructs that behave differently in traditional and
2066 ISO C.
2068 @itemize @bullet
2069 @item
2070 Macro parameters that appear within string literals in the macro body.
2071 In traditional C macro replacement takes place within string literals,
2072 but does not in ISO C.
2074 @item
2075 In traditional C, some preprocessor directives did not exist.
2076 Traditional preprocessors would only consider a line to be a directive
2077 if the @samp{#} appeared in column 1 on the line.  Therefore
2078 @samp{-Wtraditional} warns about directives that traditional C
2079 understands but would ignore because the @samp{#} does not appear as the
2080 first character on the line.  It also suggests you hide directives like
2081 @samp{#pragma} not understood by traditional C by indenting them.  Some
2082 traditional implementations would not recognise @samp{#elif}, so it
2083 suggests avoiding it altogether.
2085 @item
2086 A function-like macro that appears without arguments.
2088 @item
2089 The unary plus operator.
2091 @item
2092 The `U' integer constant suffix, or the `F' or `L' floating point
2093 constant suffixes.  (Traditonal C does support the `L' suffix on integer
2094 constants.)  Note, these suffixes appear in macros defined in the system
2095 headers of most modern systems, e.g. the _MIN/_MAX macros in limits.h.
2096 Use of these macros can lead to spurious warnings as they do not
2097 necessarily reflect whether the code in question is any less portable to
2098 traditional C given that suitable backup definitions are provided.
2100 @item
2101 A function declared external in one block and then used after the end of
2102 the block.
2104 @item
2105 A @code{switch} statement has an operand of type @code{long}.
2107 @item
2108 A non-@code{static} function declaration follows a @code{static} one.
2109 This construct is not accepted by some traditional C compilers.
2111 @item
2112 The ISO type of an integer constant has a different width or
2113 signedness from its traditional type.  This warning is only issued if
2114 the base of the constant is ten.  I.e. hexadecimal or octal values, which
2115 typically represent bit patterns, are not warned about.
2117 @item
2118 Usage of ISO string concatenation is detected.
2120 @item
2121 Initialization of automatic aggregates.
2123 @item
2124 Identifier conflicts with labels.  Traditional C lacks a separate
2125 namespace for labels.
2127 @item
2128 Initialization of unions.  If the initializer is zero, the warning is
2129 omitted.  This is done under the assumption that the zero initializer in
2130 user code appears conditioned on e.g. @code{__STDC__} to avoid missing
2131 initializer warnings and relies on default initialization to zero in the
2132 traditional C case.
2133 @end itemize
2135 @item -Wundef
2136 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2138 @item -Wshadow
2139 Warn whenever a local variable shadows another local variable.
2141 @item -Wid-clash-@var{len}
2142 Warn whenever two distinct identifiers match in the first @var{len}
2143 characters.  This may help you prepare a program that will compile
2144 with certain obsolete, brain-damaged compilers.
2146 @item -Wlarger-than-@var{len}
2147 Warn whenever an object of larger than @var{len} bytes is defined.
2149 @item -Wpointer-arith
2150 Warn about anything that depends on the ``size of'' a function type or
2151 of @code{void}.  GNU C assigns these types a size of 1, for
2152 convenience in calculations with @code{void *} pointers and pointers
2153 to functions.
2155 @item -Wbad-function-cast (C only)
2156 Warn whenever a function call is cast to a non-matching type.
2157 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2159 @item -Wcast-qual
2160 Warn whenever a pointer is cast so as to remove a type qualifier from
2161 the target type.  For example, warn if a @code{const char *} is cast
2162 to an ordinary @code{char *}.
2164 @item -Wcast-align
2165 Warn whenever a pointer is cast such that the required alignment of the
2166 target is increased.  For example, warn if a @code{char *} is cast to
2167 an @code{int *} on machines where integers can only be accessed at
2168 two- or four-byte boundaries.
2170 @item -Wwrite-strings
2171 Give string constants the type @code{const char[@var{length}]} so that
2172 copying the address of one into a non-@code{const} @code{char *}
2173 pointer will get a warning.  These warnings will help you find at
2174 compile time code that can try to write into a string constant, but
2175 only if you have been very careful about using @code{const} in
2176 declarations and prototypes.  Otherwise, it will just be a nuisance;
2177 this is why we did not make @samp{-Wall} request these warnings.
2179 @item -Wconversion
2180 Warn if a prototype causes a type conversion that is different from what
2181 would happen to the same argument in the absence of a prototype.  This
2182 includes conversions of fixed point to floating and vice versa, and
2183 conversions changing the width or signedness of a fixed point argument
2184 except when the same as the default promotion.
2186 Also, warn if a negative integer constant expression is implicitly
2187 converted to an unsigned type.  For example, warn about the assignment
2188 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2189 casts like @code{(unsigned) -1}.
2191 @item -Wsign-compare
2192 @cindex warning for comparison of signed and unsigned values
2193 @cindex comparison of signed and unsigned values, warning
2194 @cindex signed and unsigned values, comparison warning
2195 Warn when a comparison between signed and unsigned values could produce
2196 an incorrect result when the signed value is converted to unsigned.
2197 This warning is also enabled by @samp{-W}; to get the other warnings
2198 of @samp{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2200 @item -Waggregate-return
2201 Warn if any functions that return structures or unions are defined or
2202 called.  (In languages where you can return an array, this also elicits
2203 a warning.)
2205 @item -Wstrict-prototypes (C only)
2206 Warn if a function is declared or defined without specifying the
2207 argument types.  (An old-style function definition is permitted without
2208 a warning if preceded by a declaration which specifies the argument
2209 types.)
2211 @item -Wmissing-prototypes (C only)
2212 Warn if a global function is defined without a previous prototype
2213 declaration.  This warning is issued even if the definition itself
2214 provides a prototype.  The aim is to detect global functions that fail
2215 to be declared in header files.
2217 @item -Wmissing-declarations
2218 Warn if a global function is defined without a previous declaration.
2219 Do so even if the definition itself provides a prototype.
2220 Use this option to detect global functions that are not declared in
2221 header files.
2223 @item -Wmissing-noreturn
2224 Warn about functions which might be candidates for attribute @code{noreturn}.
2225 Note these are only possible candidates, not absolute ones.  Care should
2226 be taken to manually verify functions actually do not ever return before
2227 adding the @code{noreturn} attribute, otherwise subtle code generation
2228 bugs could be introduced.  You will not get a warning for @code{main} in
2229 hosted C environments.
2231 @item -Wmissing-format-attribute
2232 If @samp{-Wformat} is enabled, also warn about functions which might be
2233 candidates for @code{format} attributes.  Note these are only possible
2234 candidates, not absolute ones.  GCC will guess that @code{format}
2235 attributes might be appropriate for any function that calls a function
2236 like @code{vprintf} or @code{vscanf}, but this might not always be the
2237 case, and some functions for which @code{format} attributes are
2238 appropriate may not be detected.  This option has no effect unless
2239 @samp{-Wformat} is enabled (possibly by @samp{-Wall}).
2241 @item -Wpacked
2242 Warn if a structure is given the packed attribute, but the packed
2243 attribute has no effect on the layout or size of the structure.  
2244 Such structures may be mis-aligned for little benefit.  For
2245 instance, in this code, the variable @code{f.x} in @code{struct bar}
2246 will be misaligned even though @code{struct bar} does not itself
2247 have the packed attribute:
2249 @smallexample
2250 @group
2251 struct foo @{
2252   int x;
2253   char a, b, c, d;
2254 @} __attribute__((packed));
2255 struct bar @{
2256   char z;
2257   struct foo f;
2259 @end group
2260 @end smallexample
2262 @item -Wpadded
2263 Warn if padding is included in a structure, either to align an element
2264 of the structure or to align the whole structure.  Sometimes when this
2265 happens it is possible to rearrange the fields of the structure to
2266 reduce the padding and so make the structure smaller.
2268 @item -Wredundant-decls
2269 Warn if anything is declared more than once in the same scope, even in
2270 cases where multiple declaration is valid and changes nothing.
2272 @item -Wnested-externs (C only)
2273 Warn if an @code{extern} declaration is encountered within a function.
2275 @item -Wunreachable-code
2276 Warn if the compiler detects that code will never be executed.
2278 This option is intended to warn when the compiler detects that at
2279 least a whole line of source code will never be executed, because
2280 some condition is never satisfied or because it is after a
2281 procedure that never returns.
2283 It is possible for this option to produce a warning even though there
2284 are circumstances under which part of the affected line can be executed,
2285 so care should be taken when removing apparently-unreachable code.
2287 For instance, when a function is inlined, a warning may mean that the
2288 line is unreachable in only one inlined copy of the function.  
2290 This option is not made part of @samp{-Wall} because in a debugging
2291 version of a program there is often substantial code which checks
2292 correct functioning of the program and is, hopefully, unreachable
2293 because the program does work.  Another common use of unreachable
2294 code is to provide behaviour which is selectable at compile-time.
2296 @item -Winline
2297 Warn if a function can not be inlined and it was declared as inline.
2299 @item -Wlong-long
2300 Warn if @samp{long long} type is used.  This is default.  To inhibit
2301 the warning messages, use @samp{-Wno-long-long}.  Flags
2302 @samp{-Wlong-long} and @samp{-Wno-long-long} are taken into account
2303 only when @samp{-pedantic} flag is used.
2305 @item -Wdisabled-optimization
2306 Warn if a requested optimization pass is disabled.  This warning does
2307 not generally indicate that there is anything wrong with your code; it
2308 merely indicates that GCC's optimizers were unable to handle the code
2309 effectively.  Often, the problem is that your code is too big or too
2310 complex; GCC will refuse to optimize programs when the optimization
2311 itself is likely to take inordinate amounts of time.
2313 @item -Werror
2314 Make all warnings into errors.
2315 @end table
2317 @node Debugging Options
2318 @section Options for Debugging Your Program or GCC
2319 @cindex options, debugging
2320 @cindex debugging information options
2322 GCC has various special options that are used for debugging
2323 either your program or GCC:
2325 @table @gcctabopt
2326 @item -g
2327 Produce debugging information in the operating system's native format
2328 (stabs, COFF, XCOFF, or DWARF).  GDB can work with this debugging
2329 information.
2331 On most systems that use stabs format, @samp{-g} enables use of extra
2332 debugging information that only GDB can use; this extra information
2333 makes debugging work better in GDB but will probably make other debuggers
2334 crash or
2335 refuse to read the program.  If you want to control for certain whether
2336 to generate the extra information, use @samp{-gstabs+}, @samp{-gstabs},
2337 @samp{-gxcoff+}, @samp{-gxcoff}, @samp{-gdwarf-1+}, or @samp{-gdwarf-1}
2338 (see below).
2340 Unlike most other C compilers, GCC allows you to use @samp{-g} with
2341 @samp{-O}.  The shortcuts taken by optimized code may occasionally
2342 produce surprising results: some variables you declared may not exist
2343 at all; flow of control may briefly move where you did not expect it;
2344 some statements may not be executed because they compute constant
2345 results or their values were already at hand; some statements may
2346 execute in different places because they were moved out of loops.
2348 Nevertheless it proves possible to debug optimized output.  This makes
2349 it reasonable to use the optimizer for programs that might have bugs.
2351 The following options are useful when GCC is generated with the
2352 capability for more than one debugging format.
2354 @item -ggdb
2355 Produce debugging information for use by GDB.  This means to use the
2356 most expressive format available (DWARF 2, stabs, or the native format
2357 if neither of those are supported), including GDB extensions if at all
2358 possible.
2360 @item -gstabs
2361 Produce debugging information in stabs format (if that is supported),
2362 without GDB extensions.  This is the format used by DBX on most BSD
2363 systems.  On MIPS, Alpha and System V Release 4 systems this option
2364 produces stabs debugging output which is not understood by DBX or SDB.
2365 On System V Release 4 systems this option requires the GNU assembler.
2367 @item -gstabs+
2368 Produce debugging information in stabs format (if that is supported),
2369 using GNU extensions understood only by the GNU debugger (GDB).  The
2370 use of these extensions is likely to make other debuggers crash or
2371 refuse to read the program.
2373 @item -gcoff
2374 Produce debugging information in COFF format (if that is supported).
2375 This is the format used by SDB on most System V systems prior to
2376 System V Release 4.
2378 @item -gxcoff
2379 Produce debugging information in XCOFF format (if that is supported).
2380 This is the format used by the DBX debugger on IBM RS/6000 systems.
2382 @item -gxcoff+
2383 Produce debugging information in XCOFF format (if that is supported),
2384 using GNU extensions understood only by the GNU debugger (GDB).  The
2385 use of these extensions is likely to make other debuggers crash or
2386 refuse to read the program, and may cause assemblers other than the GNU
2387 assembler (GAS) to fail with an error.
2389 @item -gdwarf
2390 Produce debugging information in DWARF version 1 format (if that is
2391 supported).  This is the format used by SDB on most System V Release 4
2392 systems.
2394 @item -gdwarf+
2395 Produce debugging information in DWARF version 1 format (if that is
2396 supported), using GNU extensions understood only by the GNU debugger
2397 (GDB).  The use of these extensions is likely to make other debuggers
2398 crash or refuse to read the program.
2400 @item -gdwarf-2
2401 Produce debugging information in DWARF version 2 format (if that is
2402 supported).  This is the format used by DBX on IRIX 6.
2404 @item -g@var{level}
2405 @itemx -ggdb@var{level}
2406 @itemx -gstabs@var{level}
2407 @itemx -gcoff@var{level}
2408 @itemx -gxcoff@var{level}
2409 @itemx -gdwarf@var{level}
2410 @itemx -gdwarf-2@var{level}
2411 Request debugging information and also use @var{level} to specify how
2412 much information.  The default level is 2.
2414 Level 1 produces minimal information, enough for making backtraces in
2415 parts of the program that you don't plan to debug.  This includes
2416 descriptions of functions and external variables, but no information
2417 about local variables and no line numbers.
2419 Level 3 includes extra information, such as all the macro definitions
2420 present in the program.  Some debuggers support macro expansion when
2421 you use @samp{-g3}.
2423 @cindex @code{prof}
2424 @item -p
2425 Generate extra code to write profile information suitable for the
2426 analysis program @code{prof}.  You must use this option when compiling
2427 the source files you want data about, and you must also use it when
2428 linking.
2430 @cindex @code{gprof}
2431 @item -pg
2432 Generate extra code to write profile information suitable for the
2433 analysis program @code{gprof}.  You must use this option when compiling
2434 the source files you want data about, and you must also use it when
2435 linking.
2437 @cindex @code{tcov}
2438 @item -a
2439 Generate extra code to write profile information for basic blocks, which will
2440 record the number of times each basic block is executed, the basic block start
2441 address, and the function name containing the basic block.  If @samp{-g} is
2442 used, the line number and filename of the start of the basic block will also be
2443 recorded.  If not overridden by the machine description, the default action is
2444 to append to the text file @file{bb.out}.
2446 This data could be analyzed by a program like @code{tcov}.  Note,
2447 however, that the format of the data is not what @code{tcov} expects.
2448 Eventually GNU @code{gprof} should be extended to process this data.
2450 @item -Q
2451 Makes the compiler print out each function name as it is compiled, and
2452 print some statistics about each pass when it finishes.
2454 @item -ax
2455 Generate extra code to profile basic blocks.  Your executable will
2456 produce output that is a superset of that produced when @samp{-a} is
2457 used.  Additional output is the source and target address of the basic
2458 blocks where a jump takes place, the number of times a jump is executed,
2459 and (optionally) the complete sequence of basic blocks being executed.
2460 The output is appended to file @file{bb.out}.
2462 You can examine different profiling aspects without recompilation.  Your
2463 executable will read a list of function names from file @file{bb.in}.
2464 Profiling starts when a function on the list is entered and stops when
2465 that invocation is exited.  To exclude a function from profiling, prefix
2466 its name with `-'.  If a function name is not unique, you can
2467 disambiguate it by writing it in the form
2468 @samp{/path/filename.d:functionname}.  Your executable will write the
2469 available paths and filenames in file @file{bb.out}.
2471 Several function names have a special meaning:
2472 @table @code
2473 @item __bb_jumps__
2474 Write source, target and frequency of jumps to file @file{bb.out}.
2475 @item __bb_hidecall__
2476 Exclude function calls from frequency count.
2477 @item __bb_showret__
2478 Include function returns in frequency count.
2479 @item __bb_trace__
2480 Write the sequence of basic blocks executed to file @file{bbtrace.gz}.
2481 The file will be compressed using the program @samp{gzip}, which must
2482 exist in your @env{PATH}.  On systems without the @samp{popen}
2483 function, the file will be named @file{bbtrace} and will not be
2484 compressed.  @strong{Profiling for even a few seconds on these systems
2485 will produce a very large file.}  Note: @code{__bb_hidecall__} and
2486 @code{__bb_showret__} will not affect the sequence written to
2487 @file{bbtrace.gz}.
2488 @end table
2490 Here's a short example using different profiling parameters
2491 in file @file{bb.in}.  Assume function @code{foo} consists of basic blocks
2492 1 and 2 and is called twice from block 3 of function @code{main}.  After
2493 the calls, block 3 transfers control to block 4 of @code{main}.
2495 With @code{__bb_trace__} and @code{main} contained in file @file{bb.in},
2496 the following sequence of blocks is written to file @file{bbtrace.gz}:
2497 0 3 1 2 1 2 4.  The return from block 2 to block 3 is not shown, because
2498 the return is to a point inside the block and not to the top.  The
2499 block address 0 always indicates, that control is transferred
2500 to the trace from somewhere outside the observed functions.  With
2501 @samp{-foo} added to @file{bb.in}, the blocks of function
2502 @code{foo} are removed from the trace, so only 0 3 4 remains.
2504 With @code{__bb_jumps__} and @code{main} contained in file @file{bb.in},
2505 jump frequencies will be written to file @file{bb.out}.  The
2506 frequencies are obtained by constructing a trace of blocks
2507 and incrementing a counter for every neighbouring pair of blocks
2508 in the trace.  The trace 0 3 1 2 1 2 4 displays the following
2509 frequencies:
2511 @example
2512 Jump from block 0x0 to block 0x3 executed 1 time(s)
2513 Jump from block 0x3 to block 0x1 executed 1 time(s)
2514 Jump from block 0x1 to block 0x2 executed 2 time(s)
2515 Jump from block 0x2 to block 0x1 executed 1 time(s)
2516 Jump from block 0x2 to block 0x4 executed 1 time(s)
2517 @end example
2519 With @code{__bb_hidecall__}, control transfer due to call instructions
2520 is removed from the trace, that is the trace is cut into three parts: 0
2521 3 4, 0 1 2 and 0 1 2.  With @code{__bb_showret__}, control transfer due
2522 to return instructions is added to the trace.  The trace becomes: 0 3 1
2523 2 3 1 2 3 4.  Note, that this trace is not the same, as the sequence
2524 written to @file{bbtrace.gz}.  It is solely used for counting jump
2525 frequencies.
2527 @item -fprofile-arcs
2528 Instrument @dfn{arcs} during compilation.  For each function of your
2529 program, GCC creates a program flow graph, then finds a spanning tree
2530 for the graph.  Only arcs that are not on the spanning tree have to be
2531 instrumented: the compiler adds code to count the number of times that these
2532 arcs are executed.  When an arc is the only exit or only entrance to a
2533 block, the instrumentation code can be added to the block; otherwise, a
2534 new basic block must be created to hold the instrumentation code.
2536 Since not every arc in the program must be instrumented, programs
2537 compiled with this option run faster than programs compiled with
2538 @samp{-a}, which adds instrumentation code to every basic block in the
2539 program.  The tradeoff: since @code{gcov} does not have
2540 execution counts for all branches, it must start with the execution
2541 counts for the instrumented branches, and then iterate over the program
2542 flow graph until the entire graph has been solved.  Hence, @code{gcov}
2543 runs a little more slowly than a program which uses information from
2544 @samp{-a}.
2546 @samp{-fprofile-arcs} also makes it possible to estimate branch
2547 probabilities, and to calculate basic block execution counts.  In
2548 general, basic block execution counts do not give enough information to
2549 estimate all branch probabilities.  When the compiled program exits, it
2550 saves the arc execution counts to a file called
2551 @file{@var{sourcename}.da}.  Use the compiler option
2552 @samp{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2553 Control Optimization}) when recompiling, to optimize using estimated
2554 branch probabilities.
2556 @need 2000
2557 @item -ftest-coverage
2558 Create data files for the @code{gcov} code-coverage utility
2559 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
2560 The data file names begin with the name of your source file:
2562 @table @gcctabopt
2563 @item @var{sourcename}.bb
2564 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2565 associate basic block execution counts with line numbers.
2567 @item @var{sourcename}.bbg
2568 A list of all arcs in the program flow graph.  This allows @code{gcov}
2569 to reconstruct the program flow graph, so that it can compute all basic
2570 block and arc execution counts from the information in the
2571 @code{@var{sourcename}.da} file (this last file is the output from
2572 @samp{-fprofile-arcs}).
2573 @end table
2575 @item -d@var{letters}
2576 Says to make debugging dumps during compilation at times specified by
2577 @var{letters}.  This is used for debugging the compiler.  The file names
2578 for most of the dumps are made by appending a pass number and a word to
2579 the source file name (e.g.  @file{foo.c.00.rtl} or @file{foo.c.01.sibling}). 
2580 Here are the possible letters for use in @var{letters}, and their meanings:
2582 @table @samp
2583 @item A
2584 Annotate the assembler output with miscellaneous debugging information.
2585 @item b
2586 Dump after computing branch probabilities, to @file{@var{file}.11.bp}.
2587 @item B
2588 Dump after block reordering, to @file{@var{file}.26.bbro}.
2589 @item c
2590 Dump after instruction combination, to the file @file{@var{file}.14.combine}.
2591 @item C
2592 Dump after the first if conversion, to the file @file{@var{file}.15.ce}.
2593 @item d
2594 Dump after delayed branch scheduling, to @file{@var{file}.29.dbr}.
2595 @item D
2596 Dump all macro definitions, at the end of preprocessing, in addition to
2597 normal output.
2598 @item e
2599 Dump after SSA optimizations, to @file{@var{file}.05.ssa} and
2600 @file{@var{file}.06.ussa}.
2601 @item E
2602 Dump after the second if conversion, to @file{@var{file}.24.ce2}.
2603 @item f
2604 Dump after life analysis, to @file{@var{file}.13.life}.
2605 @item F
2606 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.04.addressof}.
2607 @item g
2608 Dump after global register allocation, to @file{@var{file}.19.greg}.
2609 @item o
2610 Dump after post-reload CSE and other optimizations, to @file{@var{file}.20.postreload}.
2611 @item G      
2612 Dump after GCSE, to @file{@var{file}.08.gcse}.
2613 @item i
2614 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
2615 @item j
2616 Dump after the first jump optimization, to @file{@var{file}.02.jump}.
2617 @item J
2618 Dump after the last jump optimization, to @file{@var{file}.27.jump2}.
2619 @item k
2620 Dump after conversion from registers to stack, to @file{@var{file}.29.stack}.
2621 @item l
2622 Dump after local register allocation, to @file{@var{file}.18.lreg}.
2623 @item L
2624 Dump after loop optimization, to @file{@var{file}.09.loop}.
2625 @item M
2626 Dump after performing the machine dependent reorganisation pass, to
2627 @file{@var{file}.28.mach}. 
2628 @item n
2629 Dump after register renumbering, to @file{@var{file}.23.rnreg}.
2630 @item N
2631 Dump after the register move pass, to @file{@var{file}.16.regmove}.
2632 @item r
2633 Dump after RTL generation, to @file{@var{file}.00.rtl}.
2634 @item R
2635 Dump after the second instruction scheduling pass, to
2636 @file{@var{file}.25.sched2}.
2637 @item s
2638 Dump after CSE (including the jump optimization that sometimes follows
2639 CSE), to @file{@var{file}.03.cse}. 
2640 @item S
2641 Dump after the first instruction scheduling pass, to
2642 @file{@var{file}.17.sched}.
2643 @item t
2644 Dump after the second CSE pass (including the jump optimization that
2645 sometimes follows CSE), to @file{@var{file}.10.cse2}.
2646 @item w
2647 Dump after the second flow pass, to @file{@var{file}.21.flow2}.
2648 @item X
2649 Dump after dead code elimination, to @file{@var{file}.06.dce}.
2650 @item z
2651 Dump after the peephole pass, to @file{@var{file}.22.peephole2}.
2652 @item a
2653 Produce all the dumps listed above.
2654 @item m
2655 Print statistics on memory usage, at the end of the run, to
2656 standard error.
2657 @item p
2658 Annotate the assembler output with a comment indicating which
2659 pattern and alternative was used.  The length of each instruction is
2660 also printed.
2661 @item P
2662 Dump the RTL in the assembler output as a comment before each instruction.
2663 Also turns on @samp{-dp} annotation.
2664 @item v
2665 For each of the other indicated dump files (except for
2666 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
2667 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
2668 @item x
2669 Just generate RTL for a function instead of compiling it.  Usually used
2670 with @samp{r}.
2671 @item y
2672 Dump debugging information during parsing, to standard error.
2673 @end table
2675 @item -fdump-unnumbered
2676 When doing debugging dumps (see -d option above), suppress instruction
2677 numbers and line number note output.  This makes it more feasible to
2678 use diff on debugging dumps for compiler invocations with different
2679 options, in particular with and without -g.
2681 @item -fdump-translation-unit=@var{file} (C and C++ only)
2682 Dump a representation of the tree structure for the entire translation
2683 unit to @var{file}.
2685 @item -fdump-class_layout=@var{file} (C++ only)
2686 @item -fdump-class_layout (C++ only)
2687 Dump a representation of each class's heirarchy to @var{file}, or
2688 @code{stderr} if not specified.
2690 @item -fpretend-float
2691 When running a cross-compiler, pretend that the target machine uses the
2692 same floating point format as the host machine.  This causes incorrect
2693 output of the actual floating constants, but the actual instruction
2694 sequence will probably be the same as GCC would make when running on
2695 the target machine.
2697 @item -save-temps
2698 Store the usual ``temporary'' intermediate files permanently; place them
2699 in the current directory and name them based on the source file.  Thus,
2700 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
2701 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
2702 preprocessed @file{foo.i} output file even though the compiler now
2703 normally uses an integrated preprocessor.
2705 @item -time
2706 Report the CPU time taken by each subprocess in the compilation
2707 sequence.  For C source files, this is the compiler proper and assembler
2708 (plus the linker if linking is done).  The output looks like this:
2710 @smallexample
2711 # cc1 0.12 0.01
2712 # as 0.00 0.01
2713 @end smallexample
2715 The first number on each line is the ``user time,'' that is time spent
2716 executing the program itself.  The second number is ``system time,''
2717 time spent executing operating system routines on behalf of the program.
2718 Both numbers are in seconds.
2720 @item -print-file-name=@var{library}
2721 Print the full absolute name of the library file @var{library} that
2722 would be used when linking---and don't do anything else.  With this
2723 option, GCC does not compile or link anything; it just prints the
2724 file name.
2726 @item -print-prog-name=@var{program}
2727 Like @samp{-print-file-name}, but searches for a program such as @samp{cpp}.
2729 @item -print-libgcc-file-name
2730 Same as @samp{-print-file-name=libgcc.a}.
2732 This is useful when you use @samp{-nostdlib} or @samp{-nodefaultlibs}
2733 but you do want to link with @file{libgcc.a}.  You can do
2735 @example
2736 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
2737 @end example
2739 @item -print-search-dirs
2740 Print the name of the configured installation directory and a list of
2741 program and library directories gcc will search---and don't do anything else.
2743 This is useful when gcc prints the error message
2744 @samp{installation problem, cannot exec cpp0: No such file or directory}.
2745 To resolve this you either need to put @file{cpp0} and the other compiler
2746 components where gcc expects to find them, or you can set the environment
2747 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
2748 Don't forget the trailing '/'.
2749 @xref{Environment Variables}.
2750 @end table
2752 @node Optimize Options
2753 @section Options That Control Optimization
2754 @cindex optimize options
2755 @cindex options, optimization
2757 These options control various sorts of optimizations:
2759 @table @gcctabopt
2760 @item -O
2761 @itemx -O1
2762 Optimize.  Optimizing compilation takes somewhat more time, and a lot
2763 more memory for a large function.
2765 Without @samp{-O}, the compiler's goal is to reduce the cost of
2766 compilation and to make debugging produce the expected results.
2767 Statements are independent: if you stop the program with a breakpoint
2768 between statements, you can then assign a new value to any variable or
2769 change the program counter to any other statement in the function and
2770 get exactly the results you would expect from the source code.
2772 Without @samp{-O}, the compiler only allocates variables declared
2773 @code{register} in registers.  The resulting compiled code is a little
2774 worse than produced by PCC without @samp{-O}.
2776 With @samp{-O}, the compiler tries to reduce code size and execution
2777 time.
2779 When you specify @samp{-O}, the compiler turns on @samp{-fthread-jumps}
2780 and @samp{-fdefer-pop} on all machines.  The compiler turns on
2781 @samp{-fdelayed-branch} on machines that have delay slots, and
2782 @samp{-fomit-frame-pointer} on machines that can support debugging even
2783 without a frame pointer.  On some machines the compiler also turns
2784 on other flags.@refill
2786 @item -O2
2787 Optimize even more.  GCC performs nearly all supported optimizations
2788 that do not involve a space-speed tradeoff.  The compiler does not
2789 perform loop unrolling or function inlining when you specify @samp{-O2}.
2790 As compared to @samp{-O}, this option increases both compilation time
2791 and the performance of the generated code.
2793 @samp{-O2} turns on all optional optimizations except for loop unrolling,
2794 function inlining, and register renaming.  It also turns on the
2795 @samp{-fforce-mem} option on all machines and frame pointer elimination
2796 on machines where doing so does not interfere with debugging.
2798 @item -O3
2799 Optimize yet more.  @samp{-O3} turns on all optimizations specified by
2800 @samp{-O2} and also turns on the @samp{-finline-functions} and
2801 @samp{-frename-registers} options.
2803 @item -O0
2804 Do not optimize.
2806 @item -Os
2807 Optimize for size.  @samp{-Os} enables all @samp{-O2} optimizations that
2808 do not typically increase code size.  It also performs further
2809 optimizations designed to reduce code size.
2811 If you use multiple @samp{-O} options, with or without level numbers,
2812 the last such option is the one that is effective.
2813 @end table
2815 Options of the form @samp{-f@var{flag}} specify machine-independent
2816 flags.  Most flags have both positive and negative forms; the negative
2817 form of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below,
2818 only one of the forms is listed---the one which is not the default.
2819 You can figure out the other form by either removing @samp{no-} or
2820 adding it.
2822 @table @gcctabopt
2823 @item -ffloat-store
2824 Do not store floating point variables in registers, and inhibit other
2825 options that might change whether a floating point value is taken from a
2826 register or memory.
2828 @cindex floating point precision
2829 This option prevents undesirable excess precision on machines such as
2830 the 68000 where the floating registers (of the 68881) keep more
2831 precision than a @code{double} is supposed to have.  Similarly for the
2832 x86 architecture.  For most programs, the excess precision does only
2833 good, but a few programs rely on the precise definition of IEEE floating
2834 point.  Use @samp{-ffloat-store} for such programs, after modifying
2835 them to store all pertinent intermediate computations into variables.
2837 @item -fno-default-inline
2838 Do not make member functions inline by default merely because they are
2839 defined inside the class scope (C++ only).  Otherwise, when you specify
2840 @w{@samp{-O}}, member functions defined inside class scope are compiled
2841 inline by default; i.e., you don't need to add @samp{inline} in front of
2842 the member function name.
2844 @item -fno-defer-pop
2845 Always pop the arguments to each function call as soon as that function
2846 returns.  For machines which must pop arguments after a function call,
2847 the compiler normally lets arguments accumulate on the stack for several
2848 function calls and pops them all at once.
2850 @item -fforce-mem
2851 Force memory operands to be copied into registers before doing
2852 arithmetic on them.  This produces better code by making all memory
2853 references potential common subexpressions.  When they are not common
2854 subexpressions, instruction combination should eliminate the separate
2855 register-load.  The @samp{-O2} option turns on this option.
2857 @item -fforce-addr
2858 Force memory address constants to be copied into registers before
2859 doing arithmetic on them.  This may produce better code just as
2860 @samp{-fforce-mem} may.
2862 @item -fomit-frame-pointer
2863 Don't keep the frame pointer in a register for functions that
2864 don't need one.  This avoids the instructions to save, set up and
2865 restore frame pointers; it also makes an extra register available
2866 in many functions.  @strong{It also makes debugging impossible on
2867 some machines.}
2869 @ifset INTERNALS
2870 On some machines, such as the Vax, this flag has no effect, because
2871 the standard calling sequence automatically handles the frame pointer
2872 and nothing is saved by pretending it doesn't exist.  The
2873 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2874 whether a target machine supports this flag.  @xref{Registers}.@refill
2875 @end ifset
2876 @ifclear INTERNALS
2877 On some machines, such as the Vax, this flag has no effect, because
2878 the standard calling sequence automatically handles the frame pointer
2879 and nothing is saved by pretending it doesn't exist.  The
2880 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2881 whether a target machine supports this flag.  @xref{Registers,,Register
2882 Usage, gcc.info, Using and Porting GCC}.@refill
2883 @end ifclear
2885 @item -foptimize-sibling-calls
2886 Optimize sibling and tail recursive calls.
2888 @item -ftrapv
2889 This option generates traps for signed overflow on addition, subtraction,
2890 multiplication operations.
2892 @item -fno-inline
2893 Don't pay attention to the @code{inline} keyword.  Normally this option
2894 is used to keep the compiler from expanding any functions inline.
2895 Note that if you are not optimizing, no functions can be expanded inline.
2897 @item -finline-functions
2898 Integrate all simple functions into their callers.  The compiler
2899 heuristically decides which functions are simple enough to be worth
2900 integrating in this way.
2902 If all calls to a given function are integrated, and the function is
2903 declared @code{static}, then the function is normally not output as
2904 assembler code in its own right.
2906 @item -finline-limit=@var{n}
2907 By default, gcc limits the size of functions that can be inlined.  This flag
2908 allows the control of this limit for functions that are explicitly marked as
2909 inline (ie marked with the inline keyword or defined within the class 
2910 definition in c++).  @var{n} is the size of functions that can be inlined in 
2911 number of pseudo instructions (not counting parameter handling).  The default
2912 value of n is 10000.  Increasing this value can result in more inlined code at
2913 the cost of compilation time and memory consumption.  Decreasing usually makes
2914 the compilation faster and less code will be inlined (which presumably 
2915 means slower programs).  This option is particularly useful for programs that 
2916 use inlining heavily such as those based on recursive templates with c++.
2918 @emph{Note:} pseudo instruction represents, in this particular context, an
2919 abstract measurement of function's size.  In no way, it represents a count
2920 of assembly instructions and as such its exact meaning might change from one
2921 release to an another.
2923 @item -fkeep-inline-functions
2924 Even if all calls to a given function are integrated, and the function
2925 is declared @code{static}, nevertheless output a separate run-time
2926 callable version of the function.  This switch does not affect
2927 @code{extern inline} functions.
2929 @item -fkeep-static-consts
2930 Emit variables declared @code{static const} when optimization isn't turned
2931 on, even if the variables aren't referenced.
2933 GCC enables this option by default.  If you want to force the compiler to
2934 check if the variable was referenced, regardless of whether or not
2935 optimization is turned on, use the @samp{-fno-keep-static-consts} option.
2937 @item -fno-function-cse
2938 Do not put function addresses in registers; make each instruction that
2939 calls a constant function contain the function's address explicitly.
2941 This option results in less efficient code, but some strange hacks
2942 that alter the assembler output may be confused by the optimizations
2943 performed when this option is not used.
2945 @item -ffast-math
2946 This option allows GCC to violate some ISO or IEEE rules and/or
2947 specifications in the interest of optimizing code for speed.  For
2948 example, it allows the compiler to assume arguments to the @code{sqrt}
2949 function are non-negative numbers and that no floating-point values
2950 are NaNs.
2952 This option should never be turned on by any @samp{-O} option since
2953 it can result in incorrect output for programs which depend on
2954 an exact implementation of IEEE or ISO rules/specifications for
2955 math functions.
2957 @item -fno-math-errno
2958 Do not set ERRNO after calling math functions that are executed
2959 with a single instruction, e.g., sqrt.  A program that relies on
2960 IEEE exceptions for math error handling may want to use this flag
2961 for speed while maintaining IEEE arithmetic compatibility.
2963 The default is @samp{-fmath-errno}.  The @samp{-ffast-math} option
2964 sets @samp{-fno-math-errno}.
2965 @end table
2967 @c following causes underfulls.. they don't look great, but we deal.
2968 @c --mew 26jan93
2969 The following options control specific optimizations.  The @samp{-O2}
2970 option turns on all of these optimizations except @samp{-funroll-loops}
2971 and @samp{-funroll-all-loops}.  On most machines, the @samp{-O} option
2972 turns on the @samp{-fthread-jumps} and @samp{-fdelayed-branch} options,
2973 but specific machines may handle it differently.
2975 You can use the following flags in the rare cases when ``fine-tuning''
2976 of optimizations to be performed is desired.
2978 @table @gcctabopt
2979 @item -fstrength-reduce
2980 Perform the optimizations of loop strength reduction and
2981 elimination of iteration variables.
2983 @item -fthread-jumps
2984 Perform optimizations where we check to see if a jump branches to a
2985 location where another comparison subsumed by the first is found.  If
2986 so, the first branch is redirected to either the destination of the
2987 second branch or a point immediately following it, depending on whether
2988 the condition is known to be true or false.
2990 @item -fcse-follow-jumps
2991 In common subexpression elimination, scan through jump instructions
2992 when the target of the jump is not reached by any other path.  For
2993 example, when CSE encounters an @code{if} statement with an
2994 @code{else} clause, CSE will follow the jump when the condition
2995 tested is false.
2997 @item -fcse-skip-blocks
2998 This is similar to @samp{-fcse-follow-jumps}, but causes CSE to
2999 follow jumps which conditionally skip over blocks.  When CSE
3000 encounters a simple @code{if} statement with no else clause,
3001 @samp{-fcse-skip-blocks} causes CSE to follow the jump around the
3002 body of the @code{if}.
3004 @item -frerun-cse-after-loop
3005 Re-run common subexpression elimination after loop optimizations has been
3006 performed.
3008 @item -frerun-loop-opt
3009 Run the loop optimizer twice.
3011 @item -fgcse
3012 Perform a global common subexpression elimination pass.
3013 This pass also performs global constant and copy propagation.
3015 @item -fdelete-null-pointer-checks
3016 Use global dataflow analysis to identify and eliminate useless null
3017 pointer checks.  Programs which rely on NULL pointer dereferences @emph{not}
3018 halting the program may not work properly with this option.  Use
3019 -fno-delete-null-pointer-checks to disable this optimizing for programs
3020 which depend on that behavior.
3022 @item -fexpensive-optimizations
3023 Perform a number of minor optimizations that are relatively expensive.
3025 @item -foptimize-register-move
3026 @itemx -fregmove
3027 Attempt to reassign register numbers in move instructions and as
3028 operands of other simple instructions in order to maximize the amount of
3029 register tying.  This is especially helpful on machines with two-operand
3030 instructions.  GCC enables this optimization by default with @samp{-O2}
3031 or higher.
3033 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3034 optimization.
3036 @item -fdelayed-branch
3037 If supported for the target machine, attempt to reorder instructions
3038 to exploit instruction slots available after delayed branch
3039 instructions.
3041 @item -fschedule-insns
3042 If supported for the target machine, attempt to reorder instructions to
3043 eliminate execution stalls due to required data being unavailable.  This
3044 helps machines that have slow floating point or memory load instructions
3045 by allowing other instructions to be issued until the result of the load
3046 or floating point instruction is required.
3048 @item -fschedule-insns2
3049 Similar to @samp{-fschedule-insns}, but requests an additional pass of
3050 instruction scheduling after register allocation has been done.  This is
3051 especially useful on machines with a relatively small number of
3052 registers and where memory load instructions take more than one cycle.
3054 @item -ffunction-sections
3055 @itemx -fdata-sections
3056 Place each function or data item into its own section in the output
3057 file if the target supports arbitrary sections.  The name of the
3058 function or the name of the data item determines the section's name
3059 in the output file.
3061 Use these options on systems where the linker can perform optimizations
3062 to improve locality of reference in the instruction space.  HPPA
3063 processors running HP-UX and Sparc processors running Solaris 2 have
3064 linkers with such optimizations.  Other systems using the ELF object format
3065 as well as AIX may have these optimizations in the future.
3067 Only use these options when there are significant benefits from doing
3068 so.  When you specify these options, the assembler and linker will
3069 create larger object and executable files and will also be slower.
3070 You will not be able to use @code{gprof} on all systems if you
3071 specify this option and you may have problems with debugging if
3072 you specify both this option and @samp{-g}.
3074 @item -fcaller-saves
3075 Enable values to be allocated in registers that will be clobbered by
3076 function calls, by emitting extra instructions to save and restore the
3077 registers around such calls.  Such allocation is done only when it
3078 seems to result in better code than would otherwise be produced.
3080 This option is always enabled by default on certain machines, usually
3081 those which have no call-preserved registers to use instead.
3083 For all machines, optimization level 2 and higher enables this flag by
3084 default.
3086 @item -funroll-loops
3087 Perform the optimization of loop unrolling.  This is only done for loops
3088 whose number of iterations can be determined at compile time or run time.
3089 @samp{-funroll-loops} implies both @samp{-fstrength-reduce} and
3090 @samp{-frerun-cse-after-loop}.
3092 @item -funroll-all-loops
3093 Perform the optimization of loop unrolling.  This is done for all loops
3094 and usually makes programs run more slowly.  @samp{-funroll-all-loops}
3095 implies @samp{-fstrength-reduce} as well as @samp{-frerun-cse-after-loop}.
3097 @item -fmove-all-movables
3098 Forces all invariant computations in loops to be moved
3099 outside the loop.
3101 @item -freduce-all-givs
3102 Forces all general-induction variables in loops to be
3103 strength-reduced.
3105 @emph{Note:} When compiling programs written in Fortran,
3106 @samp{-fmove-all-movables} and @samp{-freduce-all-givs} are enabled
3107 by default when you use the optimizer.
3109 These options may generate better or worse code; results are highly
3110 dependent on the structure of loops within the source code.
3112 These two options are intended to be removed someday, once
3113 they have helped determine the efficacy of various
3114 approaches to improving loop optimizations.
3116 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3117 know how use of these options affects
3118 the performance of your production code.
3119 We're very interested in code that runs @emph{slower}
3120 when these options are @emph{enabled}.
3122 @item -fno-peephole
3123 Disable any machine-specific peephole optimizations.
3125 @item -fbranch-probabilities
3126 After running a program compiled with @samp{-fprofile-arcs}
3127 (@pxref{Debugging Options,, Options for Debugging Your Program or
3128 @command{gcc}}), you can compile it a second time using
3129 @samp{-fbranch-probabilities}, to improve optimizations based on
3130 guessing the path a branch might take.
3132 @ifset INTERNALS
3133 With @samp{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
3134 note on the first instruction of each basic block, and a
3135 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3136 These can be used to improve optimization.  Currently, they are only
3137 used in one place: in @file{reorg.c}, instead of guessing which path a
3138 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3139 exactly determine which path is taken more often.
3140 @end ifset
3142 @item -fno-guess-branch-probability
3143 Sometimes gcc will opt to guess branch probabilities when none are
3144 available from either profile directed feedback (@samp{-fprofile-arcs})
3145 or @samp{__builtin_expect}.  In a hard real-time system, people don't
3146 want different runs of the compiler to produce code that has different
3147 behavior; minimizing non-determinism is of paramount import.  This
3148 switch allows users to reduce non-determinism, possibly at the expense
3149 of inferior optimization.
3151 @item -fstrict-aliasing
3152 Allows the compiler to assume the strictest aliasing rules applicable to
3153 the language being compiled.  For C (and C++), this activates
3154 optimizations based on the type of expressions.  In particular, an
3155 object of one type is assumed never to reside at the same address as an
3156 object of a different type, unless the types are almost the same.  For
3157 example, an @code{unsigned int} can alias an @code{int}, but not a
3158 @code{void*} or a @code{double}.  A character type may alias any other
3159 type.  
3161 Pay special attention to code like this:
3162 @example
3163 union a_union @{ 
3164   int i;
3165   double d;
3168 int f() @{
3169   a_union t;
3170   t.d = 3.0;
3171   return t.i;
3173 @end example
3174 The practice of reading from a different union member than the one most
3175 recently written to (called ``type-punning'') is common.  Even with
3176 @samp{-fstrict-aliasing}, type-punning is allowed, provided the memory
3177 is accessed through the union type.  So, the code above will work as
3178 expected.  However, this code might not:
3179 @example
3180 int f() @{ 
3181   a_union t;
3182   int* ip;
3183   t.d = 3.0;
3184   ip = &t.i;
3185   return *ip;
3187 @end example
3189 @ifset INTERNALS
3190 Every language that wishes to perform language-specific alias analysis
3191 should define a function that computes, given an @code{tree}
3192 node, an alias set for the node.  Nodes in different alias sets are not
3193 allowed to alias.  For an example, see the C front-end function
3194 @code{c_get_alias_set}.
3195 @end ifset
3197 @item -falign-functions
3198 @itemx -falign-functions=@var{n}
3199 Align the start of functions to the next power-of-two greater than
3200 @var{n}, skipping up to @var{n} bytes.  For instance,
3201 @samp{-falign-functions=32} aligns functions to the next 32-byte
3202 boundary, but @samp{-falign-functions=24} would align to the next
3203 32-byte boundary only if this can be done by skipping 23 bytes or less.
3205 @samp{-fno-align-functions} and @samp{-falign-functions=1} are
3206 equivalent and mean that functions will not be aligned.
3208 Some assemblers only support this flag when @var{n} is a power of two;
3209 in that case, it is rounded up.
3211 If @var{n} is not specified, use a machine-dependent default.
3213 @item -falign-labels
3214 @itemx -falign-labels=@var{n}
3215 Align all branch targets to a power-of-two boundary, skipping up to
3216 @var{n} bytes like @samp{-falign-functions}.  This option can easily
3217 make code slower, because it must insert dummy operations for when the
3218 branch target is reached in the usual flow of the code.
3220 If @samp{-falign-loops} or @samp{-falign-jumps} are applicable and
3221 are greater than this value, then their values are used instead.
3223 If @var{n} is not specified, use a machine-dependent default which is
3224 very likely to be @samp{1}, meaning no alignment.
3226 @item -falign-loops
3227 @itemx -falign-loops=@var{n}
3228 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
3229 like @samp{-falign-functions}.  The hope is that the loop will be
3230 executed many times, which will make up for any execution of the dummy
3231 operations.
3233 If @var{n} is not specified, use a machine-dependent default.
3235 @item -falign-jumps
3236 @itemx -falign-jumps=@var{n}
3237 Align branch targets to a power-of-two boundary, for branch targets
3238 where the targets can only be reached by jumping, skipping up to @var{n}
3239 bytes like @samp{-falign-functions}.  In this case, no dummy operations
3240 need be executed.
3242 If @var{n} is not specified, use a machine-dependent default.
3244 @item -fssa
3245 Perform optimizations in static single assignment form.  Each function's
3246 flow graph is translated into SSA form, optimizations are performed, and
3247 the flow graph is translated back from SSA form.  User's should not
3248 specify this option, since it is not yet ready for production use.
3250 @item -fdce
3251 Perform dead-code elimination in SSA form.  Requires @samp{-fssa}.  Like
3252 @samp{-fssa}, this is an experimental feature.
3254 @item -fsingle-precision-constant
3255 Treat floating point constant as single precision constant instead of
3256 implicitly converting it to double precision constant.
3258 @item -frename-registers
3259 Attempt to avoid false dependancies in scheduled code by making use
3260 of registers left over after register allocation.  This optimization
3261 will most benefit processors with lots of registers.  It can, however,
3262 make debugging impossible, since variables will no longer stay in
3263 a ``home register''.
3264 @end table
3266 @node Preprocessor Options
3267 @section Options Controlling the Preprocessor
3268 @cindex preprocessor options
3269 @cindex options, preprocessor
3271 These options control the C preprocessor, which is run on each C source
3272 file before actual compilation.
3274 If you use the @samp{-E} option, nothing is done except preprocessing.
3275 Some of these options make sense only together with @samp{-E} because
3276 they cause the preprocessor output to be unsuitable for actual
3277 compilation.
3279 @table @gcctabopt
3280 @item -include @var{file}
3281 Process @var{file} as input before processing the regular input file.
3282 In effect, the contents of @var{file} are compiled first.  Any @samp{-D}
3283 and @samp{-U} options on the command line are always processed before
3284 @samp{-include @var{file}}, regardless of the order in which they are
3285 written.  All the @samp{-include} and @samp{-imacros} options are
3286 processed in the order in which they are written.
3288 @item -imacros @var{file}
3289 Process @var{file} as input, discarding the resulting output, before
3290 processing the regular input file.  Because the output generated from
3291 @var{file} is discarded, the only effect of @samp{-imacros @var{file}}
3292 is to make the macros defined in @var{file} available for use in the
3293 main input.  All the @samp{-include} and @samp{-imacros} options are
3294 processed in the order in which they are written.
3296 @item -idirafter @var{dir}
3297 @cindex second include path
3298 Add the directory @var{dir} to the second include path.  The directories
3299 on the second include path are searched when a header file is not found
3300 in any of the directories in the main include path (the one that
3301 @samp{-I} adds to).
3303 @item -iprefix @var{prefix}
3304 Specify @var{prefix} as the prefix for subsequent @samp{-iwithprefix}
3305 options.
3307 @item -iwithprefix @var{dir}
3308 Add a directory to the second include path.  The directory's name is
3309 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
3310 specified previously with @samp{-iprefix}.  If you have not specified a
3311 prefix yet, the directory containing the installed passes of the
3312 compiler is used as the default.
3314 @item -iwithprefixbefore @var{dir}
3315 Add a directory to the main include path.  The directory's name is made
3316 by concatenating @var{prefix} and @var{dir}, as in the case of
3317 @samp{-iwithprefix}.
3319 @item -isystem @var{dir}
3320 Add a directory to the beginning of the second include path, marking it
3321 as a system directory, so that it gets the same special treatment as
3322 is applied to the standard system directories.
3324 @item -nostdinc
3325 Do not search the standard system directories for header files.  Only
3326 the directories you have specified with @samp{-I} options (and the
3327 current directory, if appropriate) are searched.  @xref{Directory
3328 Options}, for information on @samp{-I}.
3330 By using both @samp{-nostdinc} and @samp{-I-}, you can limit the include-file
3331 search path to only those directories you specify explicitly.
3333 @item -remap
3334 @findex -remap
3335 When searching for a header file in a directory, remap file names if a
3336 file named @file{header.gcc} exists in that directory.  This can be used
3337 to work around limitations of file systems with file name restrictions.
3338 The @file{header.gcc} file should contain a series of lines with two
3339 tokens on each line: the first token is the name to map, and the second
3340 token is the actual name to use.
3342 @item -undef
3343 Do not predefine any nonstandard macros.  (Including architecture flags).
3345 @item -E
3346 Run only the C preprocessor.  Preprocess all the C source files
3347 specified and output the results to standard output or to the
3348 specified output file.
3350 @item -C
3351 Tell the preprocessor not to discard comments.  Used with the
3352 @samp{-E} option.
3354 @item -P
3355 Tell the preprocessor not to generate @samp{#line} directives.
3356 Used with the @samp{-E} option.
3358 @cindex make
3359 @cindex dependencies, make
3360 @item -M
3361 @findex -M
3362 Instead of outputting the result of preprocessing, output a rule
3363 suitable for @code{make} describing the dependencies of the main source
3364 file.  The preprocessor outputs one @code{make} rule containing the
3365 object file name for that source file, a colon, and the names of all the
3366 included files.  Unless overridden explicitly, the object file name
3367 consists of the basename of the source file with any suffix replaced with
3368 object file suffix. If there are many included files then the
3369 rule is split into several lines using @samp{\}-newline.
3371 @samp{-M} implies @samp{-E}.
3373 @item -MM
3374 @findex -MM
3375 Like @samp{-M}, but mention only the files included with @samp{#include
3376 "@var{file}"}.  System header files included with @samp{#include
3377 <@var{file}>} are omitted.
3379 @item -MD
3380 @findex -MD
3381 Like @samp{-M} but the dependency information is written to a file
3382 rather than stdout.  @code{gcc} will use the same file name and
3383 directory as the object file, but with the suffix ".d" instead.
3385 This is in addition to compiling the main file as specified ---
3386 @samp{-MD} does not inhibit ordinary compilation the way @samp{-M} does,
3387 unless you also specify @samp{-MG}.
3389 With Mach, you can use the utility @code{md} to merge multiple
3390 dependency files into a single dependency file suitable for using with
3391 the @samp{make} command.
3393 @item -MMD
3394 @findex -MMD
3395 Like @samp{-MD} except mention only user header files, not system
3396 -header files.
3398 @item -MF @var{file}
3399 @findex -MF
3400 When used with @samp{-M} or @samp{-MM}, specifies a file to write the
3401 dependencies to.  This allows the preprocessor to write the preprocessed
3402 file to stdout normally.  If no @samp{-MF} switch is given, CPP sends
3403 the rules to stdout and suppresses normal preprocessed output.
3405 Another way to specify output of a @code{make} rule is by setting
3406 the environment variable @env{DEPENDENCIES_OUTPUT} (@pxref{Environment
3407 Variables}).
3409 @item -MG
3410 @findex -MG
3411 When used with @samp{-M} or @samp{-MM}, @samp{-MG} says to treat missing
3412 header files as generated files and assume they live in the same
3413 directory as the source file.  It suppresses preprocessed output, as a
3414 missing header file is ordinarily an error.
3416 This feature is used in automatic updating of makefiles.
3418 @item -MP
3419 @findex -MP
3420 This option instructs CPP to add a phony target for each dependency
3421 other than the main file, causing each to depend on nothing.  These
3422 dummy rules work around errors @code{make} gives if you remove header
3423 files without updating the @code{Makefile} to match.
3425 This is typical output:-
3427 @smallexample
3428 /tmp/test.o: /tmp/test.c /tmp/test.h
3430 /tmp/test.h:
3431 @end smallexample
3433 @item -MQ @var{target}
3434 @item -MT @var{target}
3435 @findex -MQ
3436 @findex -MT
3437 By default CPP uses the main file name, including any path, and appends
3438 the object suffix, normally ``.o'', to it to obtain the name of the
3439 target for dependency generation.  With @samp{-MT} you can specify a
3440 target yourself, overriding the default one.
3442 If you want multiple targets, you can specify them as a single argument
3443 to @samp{-MT}, or use multiple @samp{-MT} options.
3445 The targets you specify are output in the order they appear on the
3446 command line.  @samp{-MQ} is identical to @samp{-MT}, except that the
3447 target name is quoted for Make, but with @samp{-MT} it isn't.  For
3448 example, -MT '$(objpfx)foo.o' gives
3450 @smallexample
3451 $(objpfx)foo.o: /tmp/foo.c
3452 @end smallexample
3454 but -MQ '$(objpfx)foo.o' gives
3456 @smallexample
3457 $$(objpfx)foo.o: /tmp/foo.c
3458 @end smallexample
3460 The default target is automatically quoted, as if it were given with
3461 @samp{-MQ}.
3463 @item -H
3464 Print the name of each header file used, in addition to other normal
3465 activities.
3467 @item -A@var{question}(@var{answer})
3468 Assert the answer @var{answer} for @var{question}, in case it is tested
3469 with a preprocessing conditional such as @samp{#if
3470 #@var{question}(@var{answer})}.  @samp{-A-} disables the standard
3471 assertions that normally describe the target machine.
3473 @item -D@var{macro}
3474 Define macro @var{macro} with the string @samp{1} as its definition.
3476 @item -D@var{macro}=@var{defn}
3477 Define macro @var{macro} as @var{defn}.  All instances of @samp{-D} on
3478 the command line are processed before any @samp{-U} options.
3480 Any @samp{-D} and @samp{-U} options on the command line are processed in
3481 order, and always before @samp{-imacros @var{file}}, regardless of the
3482 order in which they are written.
3484 @item -U@var{macro}
3485 Undefine macro @var{macro}.  @samp{-U} options are evaluated after all
3486 @samp{-D} options, but before any @samp{-include} and @samp{-imacros}
3487 options.
3489 Any @samp{-D} and @samp{-U} options on the command line are processed in
3490 order, and always before @samp{-imacros @var{file}}, regardless of the
3491 order in which they are written.
3493 @item -dM
3494 Tell the preprocessor to output only a list of the macro definitions
3495 that are in effect at the end of preprocessing.  Used with the @samp{-E}
3496 option.
3498 @item -dD
3499 Tell the preprocessing to pass all macro definitions into the output, in
3500 their proper sequence in the rest of the output.
3502 @item -dN
3503 Like @samp{-dD} except that the macro arguments and contents are omitted.
3504 Only @samp{#define @var{name}} is included in the output.
3506 @item -dI
3507 @findex -dI
3508 Output @samp{#include} directives in addition to the result of
3509 preprocessing.
3511 @item -trigraphs
3512 @findex -trigraphs
3513 Process ISO standard trigraph sequences.  These are three-character
3514 sequences, all starting with @samp{??}, that are defined by ISO C to
3515 stand for single characters.  For example, @samp{??/} stands for
3516 @samp{\}, so @samp{'??/n'} is a character constant for a newline.  By
3517 default, GCC ignores trigraphs, but in standard-conforming modes it
3518 converts them.  See the @samp{-std} and @samp{-ansi} options.
3520 The nine trigraph sequences are
3521 @table @samp
3522 @item ??(
3523 -> @samp{[}
3525 @item ??)
3526 -> @samp{]}
3528 @item ??<
3529 -> @samp{@{}
3531 @item ??>
3532 -> @samp{@}}
3534 @item ??=
3535 -> @samp{#}
3537 @item ??/
3538 -> @samp{\}
3540 @item ??'
3541 -> @samp{^}
3543 @item ??!
3544 -> @samp{|}
3546 @item ??-
3547 -> @samp{~}
3549 @end table
3551 Trigraph support is not popular, so many compilers do not implement it
3552 properly.  Portable code should not rely on trigraphs being either
3553 converted or ignored.
3555 @item -Wp\,@var{option}
3556 Pass @var{option} as an option to the preprocessor.  If @var{option}
3557 contains commas, it is split into multiple options at the commas.
3558 @end table
3560 @node Assembler Options
3561 @section Passing Options to the Assembler
3563 @c prevent bad page break with this line
3564 You can pass options to the assembler.
3566 @table @gcctabopt
3567 @item -Wa\,@var{option}
3568 Pass @var{option} as an option to the assembler.  If @var{option}
3569 contains commas, it is split into multiple options at the commas.
3570 @end table
3572 @node Link Options
3573 @section Options for Linking
3574 @cindex link options
3575 @cindex options, linking
3577 These options come into play when the compiler links object files into
3578 an executable output file.  They are meaningless if the compiler is
3579 not doing a link step.
3581 @table @gcctabopt
3582 @cindex file names
3583 @item @var{object-file-name}
3584 A file name that does not end in a special recognized suffix is
3585 considered to name an object file or library.  (Object files are
3586 distinguished from libraries by the linker according to the file
3587 contents.)  If linking is done, these object files are used as input
3588 to the linker.
3590 @item -c
3591 @itemx -S
3592 @itemx -E
3593 If any of these options is used, then the linker is not run, and
3594 object file names should not be used as arguments.  @xref{Overall
3595 Options}.
3597 @cindex Libraries
3598 @item -l@var{library}
3599 Search the library named @var{library} when linking.
3601 It makes a difference where in the command you write this option; the
3602 linker searches processes libraries and object files in the order they
3603 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
3604 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
3605 to functions in @samp{z}, those functions may not be loaded.
3607 The linker searches a standard list of directories for the library,
3608 which is actually a file named @file{lib@var{library}.a}.  The linker
3609 then uses this file as if it had been specified precisely by name.
3611 The directories searched include several standard system directories
3612 plus any that you specify with @samp{-L}.
3614 Normally the files found this way are library files---archive files
3615 whose members are object files.  The linker handles an archive file by
3616 scanning through it for members which define symbols that have so far
3617 been referenced but not defined.  But if the file that is found is an
3618 ordinary object file, it is linked in the usual fashion.  The only
3619 difference between using an @samp{-l} option and specifying a file name
3620 is that @samp{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
3621 and searches several directories.
3623 @item -lobjc
3624 You need this special case of the @samp{-l} option in order to
3625 link an Objective C program.
3627 @item -nostartfiles
3628 Do not use the standard system startup files when linking.
3629 The standard system libraries are used normally, unless @option{-nostdlib}
3630 or @option{-nodefaultlibs} is used.
3632 @item -nodefaultlibs
3633 Do not use the standard system libraries when linking.
3634 Only the libraries you specify will be passed to the linker.
3635 The standard startup files are used normally, unless @option{-nostartfiles}
3636 is used.  The compiler may generate calls to memcmp, memset, and memcpy
3637 for System V (and ISO C) environments or to bcopy and bzero for
3638 BSD environments.  These entries are usually resolved by entries in
3639 libc.  These entry points should be supplied through some other
3640 mechanism when this option is specified.
3642 @item -nostdlib
3643 Do not use the standard system startup files or libraries when linking.
3644 No startup files and only the libraries you specify will be passed to
3645 the linker. The compiler may generate calls to memcmp, memset, and memcpy
3646 for System V (and ISO C) environments or to bcopy and bzero for
3647 BSD environments.  These entries are usually resolved by entries in
3648 libc.  These entry points should be supplied through some other
3649 mechanism when this option is specified.
3651 @cindex @code{-lgcc}, use with @code{-nostdlib}
3652 @cindex @code{-nostdlib} and unresolved references
3653 @cindex unresolved references and @code{-nostdlib}
3654 @cindex @code{-lgcc}, use with @code{-nodefaultlibs}
3655 @cindex @code{-nodefaultlibs} and unresolved references
3656 @cindex unresolved references and @code{-nodefaultlibs}
3657 One of the standard libraries bypassed by @samp{-nostdlib} and
3658 @samp{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
3659 that GCC uses to overcome shortcomings of particular machines, or special
3660 needs for some languages.
3661 @ifset INTERNALS
3662 (@xref{Interface,,Interfacing to GCC Output}, for more discussion of
3663 @file{libgcc.a}.)
3664 @end ifset
3665 @ifclear INTERNALS
3666 (@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
3667 for more discussion of @file{libgcc.a}.)
3668 @end ifclear
3669 In most cases, you need @file{libgcc.a} even when you want to avoid
3670 other standard libraries.  In other words, when you specify @samp{-nostdlib}
3671 or @samp{-nodefaultlibs} you should usually specify @samp{-lgcc} as well.
3672 This ensures that you have no unresolved references to internal GCC
3673 library subroutines.  (For example, @samp{__main}, used to ensure C++
3674 constructors will be called; @pxref{Collect2,,@command{collect2}}.)
3676 @item -s
3677 Remove all symbol table and relocation information from the executable.
3679 @item -static
3680 On systems that support dynamic linking, this prevents linking with the shared
3681 libraries.  On other systems, this option has no effect.
3683 @item -shared
3684 Produce a shared object which can then be linked with other objects to
3685 form an executable.  Not all systems support this option.  For predictable
3686 results, you must also specify the same set of options that were used to 
3687 generate code (@samp{-fpic}, @samp{-fPIC}, or model suboptions)
3688 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
3689 needs to build supplementary stub code for constructors to work. On
3690 multi-libbed systems, @samp{gcc -shared} must select the correct support
3691 libraries to link against.  Failing to supply the correct flags may lead
3692 to subtle defects. Supplying them in cases where they are not necessary
3693 is innocuous.}
3695 @item -shared-libgcc
3696 @itemx -static-libgcc
3697 On systems that provide @file{libgcc} as a shared library, these options
3698 force the use of either the shared or static version respectively.
3699 If no shared version of @file{libgcc} was built when the compiler was
3700 configured, these options have no effect.
3702 There are several situations in which an application should use the
3703 shared @file{libgcc} instead of the static version.  The most common
3704 of these is when the application wishes to throw and catch exceptions
3705 across different shared libraries.  In that case, each of the libraries
3706 as well as the application itself should use the shared @file{libgcc}.
3708 Therefore, whenever you specify the @samp{-shared} option, the GCC
3709 driver automatically adds @samp{-shared-libgcc}, unless you explicitly
3710 specify @samp{-static-libgcc}.  The G++ driver automatically adds
3711 @samp{-shared-libgcc} when you build a main executable as well because
3712 for C++ programs that is typically the right thing to do.
3713 (Exception-handling will not work reliably otherwise.)
3715 However, when linking a main executable written in C, you must
3716 explicitly say @samp{-shared-libgcc} if you want to use the shared
3717 @file{libgcc}.
3719 @item -symbolic
3720 Bind references to global symbols when building a shared object.  Warn
3721 about any unresolved references (unless overridden by the link editor
3722 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
3723 this option.
3725 @item -Xlinker @var{option}
3726 Pass @var{option} as an option to the linker.  You can use this to
3727 supply system-specific linker options which GCC does not know how to
3728 recognize.
3730 If you want to pass an option that takes an argument, you must use
3731 @samp{-Xlinker} twice, once for the option and once for the argument.
3732 For example, to pass @samp{-assert definitions}, you must write
3733 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
3734 @samp{-Xlinker "-assert definitions"}, because this passes the entire
3735 string as a single argument, which is not what the linker expects.
3737 @item -Wl\,@var{option}
3738 Pass @var{option} as an option to the linker.  If @var{option} contains
3739 commas, it is split into multiple options at the commas.
3741 @item -u @var{symbol}
3742 Pretend the symbol @var{symbol} is undefined, to force linking of
3743 library modules to define it.  You can use @samp{-u} multiple times with
3744 different symbols to force loading of additional library modules.
3745 @end table
3747 @node Directory Options
3748 @section Options for Directory Search
3749 @cindex directory options
3750 @cindex options, directory search
3751 @cindex search path
3753 These options specify directories to search for header files, for
3754 libraries and for parts of the compiler:
3756 @table @gcctabopt
3757 @item -I@var{dir}
3758 Add the directory @var{dir} to the head of the list of directories to be
3759 searched for header files.  This can be used to override a system header
3760 file, substituting your own version, since these directories are
3761 searched before the system header file directories.  If you use more
3762 than one @samp{-I} option, the directories are scanned in left-to-right
3763 order; the standard system directories come after.
3765 @item -I-
3766 Any directories you specify with @samp{-I} options before the @samp{-I-}
3767 option are searched only for the case of @samp{#include "@var{file}"};
3768 they are not searched for @samp{#include <@var{file}>}.
3770 If additional directories are specified with @samp{-I} options after
3771 the @samp{-I-}, these directories are searched for all @samp{#include}
3772 directives.  (Ordinarily @emph{all} @samp{-I} directories are used
3773 this way.)
3775 In addition, the @samp{-I-} option inhibits the use of the current
3776 directory (where the current input file came from) as the first search
3777 directory for @samp{#include "@var{file}"}.  There is no way to
3778 override this effect of @samp{-I-}.  With @samp{-I.} you can specify
3779 searching the directory which was current when the compiler was
3780 invoked.  That is not exactly the same as what the preprocessor does
3781 by default, but it is often satisfactory.
3783 @samp{-I-} does not inhibit the use of the standard system directories
3784 for header files.  Thus, @samp{-I-} and @samp{-nostdinc} are
3785 independent.
3787 @item -L@var{dir}
3788 Add directory @var{dir} to the list of directories to be searched
3789 for @samp{-l}.
3791 @item -B@var{prefix}
3792 This option specifies where to find the executables, libraries,
3793 include files, and data files of the compiler itself.
3795 The compiler driver program runs one or more of the subprograms
3796 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
3797 @var{prefix} as a prefix for each program it tries to run, both with and
3798 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
3800 For each subprogram to be run, the compiler driver first tries the
3801 @samp{-B} prefix, if any.  If that name is not found, or if @samp{-B}
3802 was not specified, the driver tries two standard prefixes, which are
3803 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
3804 those results in a file name that is found, the unmodified program
3805 name is searched for using the directories specified in your
3806 @env{PATH} environment variable.
3808 @samp{-B} prefixes that effectively specify directory names also apply
3809 to libraries in the linker, because the compiler translates these
3810 options into @samp{-L} options for the linker.  They also apply to
3811 includes files in the preprocessor, because the compiler translates these
3812 options into @samp{-isystem} options for the preprocessor.  In this case,
3813 the compiler appends @samp{include} to the prefix.
3815 The run-time support file @file{libgcc.a} can also be searched for using
3816 the @samp{-B} prefix, if needed.  If it is not found there, the two
3817 standard prefixes above are tried, and that is all.  The file is left
3818 out of the link if it is not found by those means.
3820 Another way to specify a prefix much like the @samp{-B} prefix is to use
3821 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
3822 Variables}.
3824 @item -specs=@var{file}
3825 Process @var{file} after the compiler reads in the standard @file{specs}
3826 file, in order to override the defaults that the @file{gcc} driver
3827 program uses when determining what switches to pass to @file{cc1},
3828 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
3829 @samp{-specs=}@var{file} can be specified on the command line, and they
3830 are processed in order, from left to right.
3831 @end table
3833 @c man end
3835 @node Spec Files
3836 @section Specifying subprocesses and the switches to pass to them
3837 @cindex Spec Files
3838 @command{gcc} is a driver program.  It performs its job by invoking a
3839 sequence of other programs to do the work of compiling, assembling and
3840 linking.  GCC interprets its command-line parameters and uses these to
3841 deduce which programs it should invoke, and which command-line options
3842 it ought to place on their command lines.  This behaviour is controlled
3843 by @dfn{spec strings}.  In most cases there is one spec string for each
3844 program that GCC can invoke, but a few programs have multiple spec
3845 strings to control their behaviour.  The spec strings built into GCC can
3846 be overridden by using the @samp{-specs=} command-line switch to specify
3847 a spec file.
3849 @dfn{Spec files} are plaintext files that are used to construct spec
3850 strings.  They consist of a sequence of directives separated by blank
3851 lines.  The type of directive is determined by the first non-whitespace
3852 character on the line and it can be one of the following:
3854 @table @code
3855 @item %@var{command}
3856 Issues a @var{command} to the spec file processor.  The commands that can
3857 appear here are: 
3859 @table @code
3860 @item %include <@var{file}>
3861 @cindex %include
3862 Search for @var{file} and insert its text at the current point in the
3863 specs file.
3865 @item %include_noerr <@var{file}>
3866 @cindex %include_noerr
3867 Just like @samp{%include}, but do not generate an error message if the include
3868 file cannot be found.
3870 @item %rename @var{old_name} @var{new_name}
3871 @cindex %rename
3872 Rename the spec string @var{old_name} to @var{new_name}.
3874 @end table
3876 @item *[@var{spec_name}]:
3877 This tells the compiler to create, override or delete the named spec
3878 string.  All lines after this directive up to the next directive or
3879 blank line are considered to be the text for the spec string.  If this
3880 results in an empty string then the spec will be deleted.  (Or, if the
3881 spec did not exist, then nothing will happened.)  Otherwise, if the spec
3882 does not currently exist a new spec will be created.  If the spec does
3883 exist then its contents will be overridden by the text of this
3884 directive, unless the first character of that text is the @samp{+}
3885 character, in which case the text will be appended to the spec.
3887 @item [@var{suffix}]:
3888 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
3889 and up to the next directive or blank line are considered to make up the
3890 spec string for the indicated suffix.  When the compiler encounters an 
3891 input file with the named suffix, it will processes the spec string in
3892 order to work out how to compile that file.  For example:
3894 @smallexample
3895 .ZZ:
3896 z-compile -input %i
3897 @end smallexample
3899 This says that any input file whose name ends in @samp{.ZZ} should be
3900 passed to the program @samp{z-compile}, which should be invoked with the
3901 command-line switch @samp{-input} and with the result of performing the
3902 @samp{%i} substitution.  (See below.)
3904 As an alternative to providing a spec string, the text that follows a
3905 suffix directive can be one of the following:
3907 @table @code
3908 @item @@@var{language}
3909 This says that the suffix is an alias for a known @var{language}.  This is
3910 similar to using the @option{-x} command-line switch to GCC to specify a
3911 language explicitly.  For example:
3913 @smallexample
3914 .ZZ:
3915 @@c++
3916 @end smallexample
3918 Says that .ZZ files are, in fact, C++ source files.
3920 @item #@var{name}
3921 This causes an error messages saying:
3923 @smallexample
3924 @var{name} compiler not installed on this system.
3925 @end smallexample
3926 @end table
3928 GCC already has an extensive list of suffixes built into it.
3929 This directive will add an entry to the end of the list of suffixes, but
3930 since the list is searched from the end backwards, it is effectively
3931 possible to override earlier entries using this technique.
3933 @end table
3935 GCC has the following spec strings built into it.  Spec files can
3936 override these strings or create their own.  Note that individual
3937 targets can also add their own spec strings to this list. 
3939 @smallexample
3940 asm          Options to pass to the assembler
3941 asm_final    Options to pass to the assembler post-processor
3942 cpp          Options to pass to the C preprocessor
3943 cc1          Options to pass to the C compiler
3944 cc1plus      Options to pass to the C++ compiler
3945 endfile      Object files to include at the end of the link
3946 link         Options to pass to the linker
3947 lib          Libraries to include on the command line to the linker
3948 libgcc       Decides which GCC support library to pass to the linker
3949 linker       Sets the name of the linker
3950 predefines   Defines to be passed to the C preprocessor
3951 signed_char  Defines to pass to CPP to say whether @code{char} is signed by default
3952 startfile    Object files to include at the start of the link
3953 @end smallexample
3955 Here is a small example of a spec file:
3957 @smallexample
3958 %rename lib                 old_lib
3960 *lib:
3961 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
3962 @end smallexample
3964 This example renames the spec called @samp{lib} to @samp{old_lib} and
3965 then overrides the previous definition of @samp{lib} with a new one.
3966 The new definition adds in some extra command-line options before
3967 including the text of the old definition.
3969 @dfn{Spec strings} are a list of command-line options to be passed to their
3970 corresponding program.  In addition, the spec strings can contain
3971 @samp{%}-prefixed sequences to substitute variable text or to
3972 conditionally insert text into the command line.  Using these constructs
3973 it is possible to generate quite complex command lines.
3975 Here is a table of all defined @samp{%}-sequences for spec
3976 strings.  Note that spaces are not generated automatically around the
3977 results of expanding these sequences.  Therefore you can concatenate them
3978 together or combine them with constant text in a single argument. 
3980 @table @code
3981 @item %%
3982 Substitute one @samp{%} into the program name or argument.
3984 @item %i
3985 Substitute the name of the input file being processed.
3987 @item %b
3988 Substitute the basename of the input file being processed.
3989 This is the substring up to (and not including) the last period
3990 and not including the directory.
3992 @item %B
3993 This is the same as @samp{%b}, but include the file suffix (text after
3994 the last period).
3996 @item %d
3997 Marks the argument containing or following the @samp{%d} as a
3998 temporary file name, so that that file will be deleted if GCC exits
3999 successfully.  Unlike @samp{%g}, this contributes no text to the
4000 argument. 
4002 @item %g@var{suffix}
4003 Substitute a file name that has suffix @var{suffix} and is chosen
4004 once per compilation, and mark the argument in the same way as
4005 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
4006 name is now chosen in a way that is hard to predict even when previously 
4007 chosen file names are known.  For example, @samp{%g.s ... %g.o ... %g.s}
4008 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
4009 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4010 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
4011 was simply substituted with a file name chosen once per compilation,
4012 without regard to any appended suffix (which was therefore treated
4013 just like ordinary text), making such attacks more likely to succeed.
4015 @item %u@var{suffix}
4016 Like @samp{%g}, but generates a new temporary file name even if
4017 @samp{%u@var{suffix}} was already seen.
4019 @item %U@var{suffix}
4020 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4021 new one if there is no such last file name.  In the absence of any
4022 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4023 the same suffix @emph{space}, so @samp{%g.s ... %U.s ... %g.s ... %U.s}
4024 would involve the generation of two distinct file names, one
4025 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
4026 simply substituted with a file name chosen for the previous @samp{%u},
4027 without regard to any appended suffix.
4029 @item %j@var{SUFFIX}
4030 Substitutes the name of the HOST_BIT_BUCKET, if any, and if it is 
4031 writable, and if save-temps is off; otherwise, substitute the name
4032 of a temporary file, just like @samp{%u}.  This temporary file is not
4033 meant for communication between processes, but rather as a junk
4034 disposal mechanism.
4036 @item %.@var{SUFFIX}
4037 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4038 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
4039 terminated by the next space or %.
4041 @item %w
4042 Marks the argument containing or following the @samp{%w} as the
4043 designated output file of this compilation.  This puts the argument
4044 into the sequence of arguments that @samp{%o} will substitute later.
4046 @item %o
4047 Substitutes the names of all the output files, with spaces
4048 automatically placed around them.  You should write spaces
4049 around the @samp{%o} as well or the results are undefined.
4050 @samp{%o} is for use in the specs for running the linker.
4051 Input files whose names have no recognized suffix are not compiled
4052 at all, but they are included among the output files, so they will
4053 be linked.
4055 @item %O
4056 Substitutes the suffix for object files.  Note that this is
4057 handled specially when it immediately follows @samp{%g, %u, or %U},
4058 because of the need for those to form complete file names.  The
4059 handling is such that @samp{%O} is treated exactly as if it had already
4060 been substituted, except that @samp{%g, %u, and %U} do not currently
4061 support additional @var{suffix} characters following @samp{%O} as they would
4062 following, for example, @samp{.o}.
4064 @item %p
4065 Substitutes the standard macro predefinitions for the
4066 current target machine.  Use this when running @code{cpp}.
4068 @item %P
4069 Like @samp{%p}, but puts @samp{__} before and after the name of each
4070 predefined macro, except for macros that start with @samp{__} or with
4071 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
4072 C.  
4074 @item %I
4075 Substitute a @samp{-iprefix} option made from GCC_EXEC_PREFIX.
4077 @item %s
4078 Current argument is the name of a library or startup file of some sort.
4079 Search for that file in a standard list of directories and substitute
4080 the full name found. 
4082 @item %e@var{str}
4083 Print @var{str} as an error message.  @var{str} is terminated by a newline.
4084 Use this when inconsistent options are detected.
4086 @item %|
4087 Output @samp{-} if the input for the current command is coming from a pipe.
4089 @item %(@var{name})
4090 Substitute the contents of spec string @var{name} at this point.
4092 @item %[@var{name}]
4093 Like @samp{%(...)} but put @samp{__} around @samp{-D} arguments.
4095 @item %x@{@var{option}@}
4096 Accumulate an option for @samp{%X}.
4098 @item %X
4099 Output the accumulated linker options specified by @samp{-Wl} or a @samp{%x}
4100 spec string.
4102 @item %Y
4103 Output the accumulated assembler options specified by @samp{-Wa}.
4105 @item %Z
4106 Output the accumulated preprocessor options specified by @samp{-Wp}.
4108 @item %v1
4109 Substitute the major version number of GCC.
4110 (For version 2.9.5, this is 2.)
4112 @item %v2
4113 Substitute the minor version number of GCC.
4114 (For version 2.9.5, this is 9.)
4116 @item %v3
4117 Substitute the patch level number of GCC.
4118 (For version 2.9.5, this is 5.)
4120 @item %a
4121 Process the @code{asm} spec.  This is used to compute the
4122 switches to be passed to the assembler.
4124 @item %A
4125 Process the @code{asm_final} spec.  This is a spec string for
4126 passing switches to an assembler post-processor, if such a program is
4127 needed.
4129 @item %l
4130 Process the @code{link} spec.  This is the spec for computing the
4131 command line passed to the linker.  Typically it will make use of the
4132 @samp{%L %G %S %D and %E} sequences.
4134 @item %D
4135 Dump out a @samp{-L} option for each directory that GCC believes might
4136 contain startup files.  If the target supports multilibs then the
4137 current multilib directory will be prepended to each of these paths. 
4139 @item %M
4140 Output the multilib directory with directory seperators replaced with
4141 "_".  If multilib directories are not set, or the multilib directory is
4142 "." then this option emits nothing.
4144 @item %L
4145 Process the @code{lib} spec.  This is a spec string for deciding which
4146 libraries should be included on the command line to the linker. 
4148 @item %G
4149 Process the @code{libgcc} spec.  This is a spec string for deciding
4150 which GCC support library should be included on the command line to the linker. 
4152 @item %S
4153 Process the @code{startfile} spec.  This is a spec for deciding which
4154 object files should be the first ones passed to the linker.  Typically
4155 this might be a file named @file{crt0.o}. 
4157 @item %E
4158 Process the @code{endfile} spec.  This is a spec string that specifies
4159 the last object files that will be passed to the linker.  
4161 @item %C
4162 Process the @code{cpp} spec.  This is used to construct the arguments
4163 to be passed to the C preprocessor.
4165 @item %c
4166 Process the @code{signed_char} spec.  This is intended to be used
4167 to tell cpp whether a char is signed.  It typically has the definition: 
4168 @smallexample
4169 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
4170 @end smallexample
4172 @item %1
4173 Process the @code{cc1} spec.  This is used to construct the options to be
4174 passed to the actual C compiler (@samp{cc1}).
4176 @item %2
4177 Process the @code{cc1plus} spec.  This is used to construct the options to be
4178 passed to the actual C++ compiler (@samp{cc1plus}).
4180 @item %*
4181 Substitute the variable part of a matched option.  See below.
4182 Note that each comma in the substituted string is replaced by
4183 a single space.
4185 @item %@{@code{S}@}
4186 Substitutes the @code{-S} switch, if that switch was given to GCC.
4187 If that switch was not specified, this substitutes nothing.  Note that
4188 the leading dash is omitted when specifying this option, and it is
4189 automatically inserted if the substitution is performed.  Thus the spec
4190 string @samp{%@{foo@}} would match the command-line option @samp{-foo}
4191 and would output the command line option @samp{-foo}.
4193 @item %W@{@code{S}@}
4194 Like %@{@code{S}@} but mark last argument supplied within as a file to be
4195 deleted on failure. 
4197 @item %@{@code{S}*@}
4198 Substitutes all the switches specified to GCC whose names start
4199 with @code{-S}, but which also take an argument.  This is used for
4200 switches like @samp{-o, -D, -I}, etc.  GCC considers @samp{-o foo} as being
4201 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
4202 text, including the space.  Thus two arguments would be generated. 
4204 @item %@{^@code{S}*@}
4205 Like %@{@code{S}*@}, but don't put a blank between a switch and its
4206 argument.  Thus %@{^o*@} would only generate one argument, not two.
4208 @item %@{@code{S}*&@code{T}*@}
4209 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4210 (the order of @code{S} and @code{T} in the spec is not significant).
4211 There can be any number of ampersand-separated variables; for each the
4212 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
4214 @item %@{<@code{S}@}
4215 Remove all occurrences of @code{-S} from the command line.  Note - this
4216 command is position dependent.  @samp{%} commands in the spec string
4217 before this option will see @code{-S}, @samp{%} commands in the spec
4218 string after this option will not.
4220 @item %@{@code{S}*:@code{X}@}
4221 Substitutes @code{X} if one or more switches whose names start with
4222 @code{-S} are specified to GCC.  Note that the tail part of the
4223 @code{-S} option (i.e. the part matched by the @samp{*}) will be substituted
4224 for each occurrence of @samp{%*} within @code{X}. 
4226 @item %@{@code{S}:@code{X}@}
4227 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC.
4229 @item %@{!@code{S}:@code{X}@}
4230 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC.
4232 @item %@{|@code{S}:@code{X}@}
4233 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4235 @item %@{|!@code{S}:@code{X}@}
4236 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4238 @item %@{.@code{S}:@code{X}@}
4239 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4241 @item %@{!.@code{S}:@code{X}@}
4242 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4244 @item %@{@code{S}|@code{P}:@code{X}@}
4245 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC.  This may be
4246 combined with @samp{!} and @samp{.} sequences as well, although they
4247 have a stronger binding than the @samp{|}.  For example a spec string
4248 like this:
4250 @smallexample
4251 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4252 @end smallexample
4254 will output the following command-line options from the following input
4255 command-line options:
4257 @smallexample
4258 fred.c        -foo -baz
4259 jim.d         -bar -boggle
4260 -d fred.c     -foo -baz -boggle
4261 -d jim.d      -bar -baz -boggle
4262 @end smallexample
4264 @end table
4266 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4267 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4268 or spaces, or even newlines.  They are processed as usual, as described
4269 above. 
4271 The @samp{-O, -f, -m, and -W} switches are handled specifically in these
4272 constructs.  If another value of @samp{-O} or the negated form of a @samp{-f, -m, or
4273 -W} switch is found later in the command line, the earlier switch
4274 value is ignored, except with @{@code{S}*@} where @code{S} is just one
4275 letter, which passes all matching options.
4277 The character @samp{|} at the beginning of the predicate text is used to indicate
4278 that a command should be piped to the following command, but only if @samp{-pipe}
4279 is specified.
4281 It is built into GCC which switches take arguments and which do not.
4282 (You might think it would be useful to generalize this to allow each
4283 compiler's spec to say which switches take arguments.  But this cannot
4284 be done in a consistent fashion.  GCC cannot even decide which input
4285 files have been specified without knowing which switches take arguments,
4286 and it must know which input files to compile in order to tell which
4287 compilers to run). 
4289 GCC also knows implicitly that arguments starting in @samp{-l} are to be
4290 treated as compiler output files, and passed to the linker in their
4291 proper position among the other output files.
4293 @c man begin OPTIONS
4295 @node Target Options
4296 @section Specifying Target Machine and Compiler Version
4297 @cindex target options
4298 @cindex cross compiling
4299 @cindex specifying machine version
4300 @cindex specifying compiler version and target machine
4301 @cindex compiler version, specifying
4302 @cindex target machine, specifying
4304 By default, GCC compiles code for the same type of machine that you
4305 are using.  However, it can also be installed as a cross-compiler, to
4306 compile for some other type of machine.  In fact, several different
4307 configurations of GCC, for different target machines, can be
4308 installed side by side.  Then you specify which one to use with the
4309 @samp{-b} option.
4311 In addition, older and newer versions of GCC can be installed side
4312 by side.  One of them (probably the newest) will be the default, but
4313 you may sometimes wish to use another.
4315 @table @gcctabopt
4316 @item -b @var{machine}
4317 The argument @var{machine} specifies the target machine for compilation.
4318 This is useful when you have installed GCC as a cross-compiler.
4320 The value to use for @var{machine} is the same as was specified as the
4321 machine type when configuring GCC as a cross-compiler.  For
4322 example, if a cross-compiler was configured with @samp{configure
4323 i386v}, meaning to compile for an 80386 running System V, then you
4324 would specify @samp{-b i386v} to run that cross compiler.
4326 When you do not specify @samp{-b}, it normally means to compile for
4327 the same type of machine that you are using.
4329 @item -V @var{version}
4330 The argument @var{version} specifies which version of GCC to run.
4331 This is useful when multiple versions are installed.  For example,
4332 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
4334 The default version, when you do not specify @samp{-V}, is the last
4335 version of GCC that you installed.
4336 @end table
4338 The @samp{-b} and @samp{-V} options actually work by controlling part of
4339 the file name used for the executable files and libraries used for
4340 compilation.  A given version of GCC, for a given target machine, is
4341 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.@refill
4343 Thus, sites can customize the effect of @samp{-b} or @samp{-V} either by
4344 changing the names of these directories or adding alternate names (or
4345 symbolic links).  If in directory @file{/usr/local/lib/gcc-lib/} the
4346 file @file{80386} is a link to the file @file{i386v}, then @samp{-b
4347 80386} becomes an alias for @samp{-b i386v}.
4349 In one respect, the @samp{-b} or @samp{-V} do not completely change
4350 to a different compiler: the top-level driver program @command{gcc}
4351 that you originally invoked continues to run and invoke the other
4352 executables (preprocessor, compiler per se, assembler and linker)
4353 that do the real work.  However, since no real work is done in the
4354 driver program, it usually does not matter that the driver program
4355 in use is not the one for the specified target.  It is common for the
4356 interface to the other executables to change incompatibly between
4357 compiler versions, so unless the version specified is very close to that
4358 of the driver (for example, @samp{-V 3.0} with a driver program from GCC
4359 version 3.0.1), use of @samp{-V} may not work; for example, using
4360 @samp{-V 2.95.2} will not work with a driver program from GCC 3.0.
4362 The only way that the driver program depends on the target machine is
4363 in the parsing and handling of special machine-specific options.
4364 However, this is controlled by a file which is found, along with the
4365 other executables, in the directory for the specified version and
4366 target machine.  As a result, a single installed driver program adapts
4367 to any specified target machine, and sufficiently similar compiler
4368 versions.
4370 The driver program executable does control one significant thing,
4371 however: the default version and target machine.  Therefore, you can
4372 install different instances of the driver program, compiled for
4373 different targets or versions, under different names.
4375 For example, if the driver for version 2.0 is installed as @command{ogcc}
4376 and that for version 2.1 is installed as @command{gcc}, then the command
4377 @command{gcc} will use version 2.1 by default, while @command{ogcc} will use
4378 2.0 by default.  However, you can choose either version with either
4379 command with the @samp{-V} option.
4381 @node Submodel Options
4382 @section Hardware Models and Configurations
4383 @cindex submodel options
4384 @cindex specifying hardware config
4385 @cindex hardware models and configurations, specifying
4386 @cindex machine dependent options
4388 Earlier we discussed the standard option @samp{-b} which chooses among
4389 different installed compilers for completely different target
4390 machines, such as Vax vs. 68000 vs. 80386.
4392 In addition, each of these target machine types can have its own
4393 special options, starting with @samp{-m}, to choose among various
4394 hardware models or configurations---for example, 68010 vs 68020,
4395 floating coprocessor or none.  A single installed version of the
4396 compiler can compile for any model or configuration, according to the
4397 options specified.
4399 Some configurations of the compiler also support additional special
4400 options, usually for compatibility with other compilers on the same
4401 platform.
4403 @ifset INTERNALS
4404 These options are defined by the macro @code{TARGET_SWITCHES} in the
4405 machine description.  The default for the options is also defined by
4406 that macro, which enables you to change the defaults.
4407 @end ifset
4409 @menu
4410 * M680x0 Options::
4411 * M68hc1x Options::
4412 * VAX Options::
4413 * SPARC Options::
4414 * Convex Options::
4415 * AMD29K Options::
4416 * ARM Options::
4417 * Thumb Options::
4418 * MN10200 Options::
4419 * MN10300 Options::
4420 * M32R/D Options::
4421 * M88K Options::
4422 * RS/6000 and PowerPC Options::
4423 * RT Options::
4424 * MIPS Options::
4425 * i386 Options::
4426 * HPPA Options::
4427 * Intel 960 Options::
4428 * DEC Alpha Options::
4429 * Clipper Options::
4430 * H8/300 Options::
4431 * SH Options::
4432 * System V Options::
4433 * TMS320C3x/C4x Options::
4434 * V850 Options::
4435 * ARC Options::
4436 * NS32K Options::
4437 * AVR Options::
4438 * MCore Options::
4439 * IA-64 Options::
4440 * D30V Options::
4441 @end menu
4443 @node M680x0 Options
4444 @subsection M680x0 Options
4445 @cindex M680x0 options
4447 These are the @samp{-m} options defined for the 68000 series.  The default
4448 values for these options depends on which style of 68000 was selected when
4449 the compiler was configured; the defaults for the most common choices are
4450 given below.
4452 @table @gcctabopt
4453 @item -m68000
4454 @itemx -mc68000
4455 Generate output for a 68000.  This is the default
4456 when the compiler is configured for 68000-based systems.
4458 Use this option for microcontrollers with a 68000 or EC000 core,
4459 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
4461 @item -m68020
4462 @itemx -mc68020
4463 Generate output for a 68020.  This is the default
4464 when the compiler is configured for 68020-based systems.
4466 @item -m68881
4467 Generate output containing 68881 instructions for floating point.
4468 This is the default for most 68020 systems unless @samp{-nfp} was
4469 specified when the compiler was configured.
4471 @item -m68030
4472 Generate output for a 68030.  This is the default when the compiler is
4473 configured for 68030-based systems.
4475 @item -m68040
4476 Generate output for a 68040.  This is the default when the compiler is
4477 configured for 68040-based systems.
4479 This option inhibits the use of 68881/68882 instructions that have to be
4480 emulated by software on the 68040.  Use this option if your 68040 does not
4481 have code to emulate those instructions.
4483 @item -m68060
4484 Generate output for a 68060.  This is the default when the compiler is
4485 configured for 68060-based systems.
4487 This option inhibits the use of 68020 and 68881/68882 instructions that
4488 have to be emulated by software on the 68060.  Use this option if your 68060
4489 does not have code to emulate those instructions.
4491 @item -mcpu32
4492 Generate output for a CPU32. This is the default
4493 when the compiler is configured for CPU32-based systems.
4495 Use this option for microcontrollers with a
4496 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
4497 68336, 68340, 68341, 68349 and 68360.
4499 @item -m5200
4500 Generate output for a 520X "coldfire" family cpu.  This is the default
4501 when the compiler is configured for 520X-based systems.
4503 Use this option for microcontroller with a 5200 core, including 
4504 the MCF5202, MCF5203, MCF5204 and MCF5202.
4507 @item -m68020-40
4508 Generate output for a 68040, without using any of the new instructions.
4509 This results in code which can run relatively efficiently on either a
4510 68020/68881 or a 68030 or a 68040.  The generated code does use the
4511 68881 instructions that are emulated on the 68040.
4513 @item -m68020-60
4514 Generate output for a 68060, without using any of the new instructions.
4515 This results in code which can run relatively efficiently on either a
4516 68020/68881 or a 68030 or a 68040.  The generated code does use the
4517 68881 instructions that are emulated on the 68060.
4519 @item -mfpa
4520 Generate output containing Sun FPA instructions for floating point.
4522 @item -msoft-float
4523 Generate output containing library calls for floating point.
4524 @strong{Warning:} the requisite libraries are not available for all m68k
4525 targets.  Normally the facilities of the machine's usual C compiler are
4526 used, but this can't be done directly in cross-compilation.  You must
4527 make your own arrangements to provide suitable library functions for
4528 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
4529 @samp{m68k-*-coff} do provide software floating point support.
4531 @item -mshort
4532 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4534 @item -mnobitfield
4535 Do not use the bit-field instructions.  The @samp{-m68000}, @samp{-mcpu32}
4536 and @samp{-m5200} options imply @w{@samp{-mnobitfield}}.
4538 @item -mbitfield
4539 Do use the bit-field instructions.  The @samp{-m68020} option implies
4540 @samp{-mbitfield}.  This is the default if you use a configuration
4541 designed for a 68020.
4543 @item -mrtd
4544 Use a different function-calling convention, in which functions
4545 that take a fixed number of arguments return with the @code{rtd}
4546 instruction, which pops their arguments while returning.  This
4547 saves one instruction in the caller since there is no need to pop
4548 the arguments there.
4550 This calling convention is incompatible with the one normally
4551 used on Unix, so you cannot use it if you need to call libraries
4552 compiled with the Unix compiler.
4554 Also, you must provide function prototypes for all functions that
4555 take variable numbers of arguments (including @code{printf});
4556 otherwise incorrect code will be generated for calls to those
4557 functions.
4559 In addition, seriously incorrect code will result if you call a
4560 function with too many arguments.  (Normally, extra arguments are
4561 harmlessly ignored.)
4563 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
4564 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
4566 @item -malign-int
4567 @itemx -mno-align-int
4568 Control whether GCC aligns @code{int}, @code{long}, @code{long long}, 
4569 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
4570 boundary (@samp{-malign-int}) or a 16-bit boundary (@samp{-mno-align-int}).
4571 Aligning variables on 32-bit boundaries produces code that runs somewhat
4572 faster on processors with 32-bit busses at the expense of more memory.
4574 @strong{Warning:} if you use the @samp{-malign-int} switch, GCC will
4575 align structures containing the above types  differently than
4576 most published application binary interface specifications for the m68k.
4578 @item -mpcrel
4579 Use the pc-relative addressing mode of the 68000 directly, instead of
4580 using a global offset table.  At present, this option implies -fpic,
4581 allowing at most a 16-bit offset for pc-relative addressing.  -fPIC is
4582 not presently supported with -mpcrel, though this could be supported for
4583 68020 and higher processors.
4585 @item -mno-strict-align
4586 @itemx -mstrict-align
4587 @kindex -mstrict-align
4588 Do not (do) assume that unaligned memory references will be handled by
4589 the system.
4591 @end table
4593 @node M68hc1x Options
4594 @subsection M68hc1x Options
4595 @cindex M68hc1x options
4597 These are the @samp{-m} options defined for the 68hc11 and 68hc12
4598 microcontrollers.  The default values for these options depends on 
4599 which style of microcontroller was selected when the compiler was configured;
4600 the defaults for the most common choices are given below.
4602 @table @gcctabopt
4603 @item -m6811
4604 @itemx -m68hc11
4605 Generate output for a 68HC11.  This is the default
4606 when the compiler is configured for 68HC11-based systems.
4608 @item -m6812
4609 @itemx -m68hc12
4610 Generate output for a 68HC12.  This is the default
4611 when the compiler is configured for 68HC12-based systems.
4613 @item -mauto-incdec
4614 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
4615 addressing modes.
4617 @item -mshort
4618 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4620 @item -msoft-reg-count=@var{count}
4621 Specify the number of pseudo-soft registers which are used for the
4622 code generation.  The maximum number is 32.  Using more pseudo-soft
4623 register may or may not result in better code depending on the program.
4624 The default is 4 for 68HC11 and 2 for 68HC12.
4626 @end table
4628 @node VAX Options
4629 @subsection VAX Options
4630 @cindex VAX options
4632 These @samp{-m} options are defined for the Vax:
4634 @table @gcctabopt
4635 @item -munix
4636 Do not output certain jump instructions (@code{aobleq} and so on)
4637 that the Unix assembler for the Vax cannot handle across long
4638 ranges.
4640 @item -mgnu
4641 Do output those jump instructions, on the assumption that you
4642 will assemble with the GNU assembler.
4644 @item -mg
4645 Output code for g-format floating point numbers instead of d-format.
4646 @end table
4648 @node SPARC Options
4649 @subsection SPARC Options
4650 @cindex SPARC options
4652 These @samp{-m} switches are supported on the SPARC:
4654 @table @gcctabopt
4655 @item -mno-app-regs
4656 @itemx -mapp-regs
4657 Specify @samp{-mapp-regs} to generate output using the global registers
4658 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
4659 is the default.
4661 To be fully SVR4 ABI compliant at the cost of some performance loss,
4662 specify @samp{-mno-app-regs}.  You should compile libraries and system
4663 software with this option.
4665 @item -mfpu
4666 @itemx -mhard-float
4667 Generate output containing floating point instructions.  This is the
4668 default.
4670 @item -mno-fpu
4671 @itemx -msoft-float
4672 Generate output containing library calls for floating point.
4673 @strong{Warning:} the requisite libraries are not available for all SPARC
4674 targets.  Normally the facilities of the machine's usual C compiler are
4675 used, but this cannot be done directly in cross-compilation.  You must make
4676 your own arrangements to provide suitable library functions for
4677 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
4678 @samp{sparclite-*-*} do provide software floating point support.
4680 @samp{-msoft-float} changes the calling convention in the output file;
4681 therefore, it is only useful if you compile @emph{all} of a program with
4682 this option.  In particular, you need to compile @file{libgcc.a}, the
4683 library that comes with GCC, with @samp{-msoft-float} in order for
4684 this to work.
4686 @item -mhard-quad-float
4687 Generate output containing quad-word (long double) floating point
4688 instructions.
4690 @item -msoft-quad-float
4691 Generate output containing library calls for quad-word (long double)
4692 floating point instructions.  The functions called are those specified
4693 in the SPARC ABI.  This is the default.
4695 As of this writing, there are no sparc implementations that have hardware
4696 support for the quad-word floating point instructions.  They all invoke
4697 a trap handler for one of these instructions, and then the trap handler
4698 emulates the effect of the instruction.  Because of the trap handler overhead,
4699 this is much slower than calling the ABI library routines.  Thus the
4700 @samp{-msoft-quad-float} option is the default.
4702 @item -mno-epilogue
4703 @itemx -mepilogue
4704 With @samp{-mepilogue} (the default), the compiler always emits code for
4705 function exit at the end of each function.  Any function exit in
4706 the middle of the function (such as a return statement in C) will
4707 generate a jump to the exit code at the end of the function.
4709 With @samp{-mno-epilogue}, the compiler tries to emit exit code inline
4710 at every function exit.
4712 @item -mno-flat
4713 @itemx -mflat
4714 With @samp{-mflat}, the compiler does not generate save/restore instructions
4715 and will use a "flat" or single register window calling convention.
4716 This model uses %i7 as the frame pointer and is compatible with the normal
4717 register window model.  Code from either may be intermixed.
4718 The local registers and the input registers (0-5) are still treated as
4719 "call saved" registers and will be saved on the stack as necessary.
4721 With @samp{-mno-flat} (the default), the compiler emits save/restore
4722 instructions (except for leaf functions) and is the normal mode of operation.
4724 @item -mno-unaligned-doubles
4725 @itemx -munaligned-doubles
4726 Assume that doubles have 8 byte alignment.  This is the default.
4728 With @samp{-munaligned-doubles}, GCC assumes that doubles have 8 byte
4729 alignment only if they are contained in another type, or if they have an
4730 absolute address.  Otherwise, it assumes they have 4 byte alignment.
4731 Specifying this option avoids some rare compatibility problems with code
4732 generated by other compilers.  It is not the default because it results
4733 in a performance loss, especially for floating point code.
4735 @item -mno-faster-structs
4736 @itemx -mfaster-structs
4737 With @samp{-mfaster-structs}, the compiler assumes that structures
4738 should have 8 byte alignment.  This enables the use of pairs of
4739 @code{ldd} and @code{std} instructions for copies in structure
4740 assignment, in place of twice as many @code{ld} and @code{st} pairs.
4741 However, the use of this changed alignment directly violates the Sparc
4742 ABI.  Thus, it's intended only for use on targets where the developer
4743 acknowledges that their resulting code will not be directly in line with
4744 the rules of the ABI.
4746 @item -mv8
4747 @itemx -msparclite
4748 These two options select variations on the SPARC architecture.
4750 By default (unless specifically configured for the Fujitsu SPARClite),
4751 GCC generates code for the v7 variant of the SPARC architecture.
4753 @samp{-mv8} will give you SPARC v8 code.  The only difference from v7
4754 code is that the compiler emits the integer multiply and integer
4755 divide instructions which exist in SPARC v8 but not in SPARC v7.
4757 @samp{-msparclite} will give you SPARClite code.  This adds the integer
4758 multiply, integer divide step and scan (@code{ffs}) instructions which
4759 exist in SPARClite but not in SPARC v7.
4761 These options are deprecated and will be deleted in a future GCC release.
4762 They have been replaced with @samp{-mcpu=xxx}.
4764 @item -mcypress
4765 @itemx -msupersparc
4766 These two options select the processor for which the code is optimised.
4768 With @samp{-mcypress} (the default), the compiler optimizes code for the
4769 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
4770 This is also appropriate for the older SparcStation 1, 2, IPX etc.
4772 With @samp{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
4773 used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
4774 of the full SPARC v8 instruction set.
4776 These options are deprecated and will be deleted in a future GCC release.
4777 They have been replaced with @samp{-mcpu=xxx}.
4779 @item -mcpu=@var{cpu_type}
4780 Set the instruction set, register set, and instruction scheduling parameters
4781 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
4782 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
4783 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
4784 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
4786 Default instruction scheduling parameters are used for values that select
4787 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
4788 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
4790 Here is a list of each supported architecture and their supported
4791 implementations.
4793 @smallexample
4794     v7:             cypress
4795     v8:             supersparc, hypersparc
4796     sparclite:      f930, f934, sparclite86x
4797     sparclet:       tsc701
4798     v9:             ultrasparc
4799 @end smallexample
4801 @item -mtune=@var{cpu_type}
4802 Set the instruction scheduling parameters for machine type
4803 @var{cpu_type}, but do not set the instruction set or register set that the
4804 option @samp{-mcpu=}@var{cpu_type} would.
4806 The same values for @samp{-mcpu=}@var{cpu_type} are used for
4807 @samp{-mtune=}@*@var{cpu_type}, though the only useful values are those that
4808 select a particular cpu implementation: @samp{cypress}, @samp{supersparc},
4809 @samp{hypersparc}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
4810 @samp{tsc701}, @samp{ultrasparc}.
4812 @end table
4814 These @samp{-m} switches are supported in addition to the above
4815 on the SPARCLET processor.
4817 @table @gcctabopt
4818 @item -mlittle-endian
4819 Generate code for a processor running in little-endian mode.
4821 @item -mlive-g0
4822 Treat register @code{%g0} as a normal register.
4823 GCC will continue to clobber it as necessary but will not assume
4824 it always reads as 0.
4826 @item -mbroken-saverestore
4827 Generate code that does not use non-trivial forms of the @code{save} and
4828 @code{restore} instructions.  Early versions of the SPARCLET processor do
4829 not correctly handle @code{save} and @code{restore} instructions used with
4830 arguments.  They correctly handle them used without arguments.  A @code{save}
4831 instruction used without arguments increments the current window pointer
4832 but does not allocate a new stack frame.  It is assumed that the window
4833 overflow trap handler will properly handle this case as will interrupt
4834 handlers.
4835 @end table
4837 These @samp{-m} switches are supported in addition to the above
4838 on SPARC V9 processors in 64 bit environments.
4840 @table @gcctabopt
4841 @item -mlittle-endian
4842 Generate code for a processor running in little-endian mode.
4844 @item -m32
4845 @itemx -m64
4846 Generate code for a 32 bit or 64 bit environment.
4847 The 32 bit environment sets int, long and pointer to 32 bits.
4848 The 64 bit environment sets int to 32 bits and long and pointer
4849 to 64 bits.
4851 @item -mcmodel=medlow
4852 Generate code for the Medium/Low code model: the program must be linked
4853 in the low 32 bits of the address space.  Pointers are 64 bits.
4854 Programs can be statically or dynamically linked.
4856 @item -mcmodel=medmid
4857 Generate code for the Medium/Middle code model: the program must be linked
4858 in the low 44 bits of the address space, the text segment must be less than
4859 2G bytes, and data segment must be within 2G of the text segment.
4860 Pointers are 64 bits.
4862 @item -mcmodel=medany
4863 Generate code for the Medium/Anywhere code model: the program may be linked
4864 anywhere in the address space, the text segment must be less than
4865 2G bytes, and data segment must be within 2G of the text segment.
4866 Pointers are 64 bits.
4868 @item -mcmodel=embmedany
4869 Generate code for the Medium/Anywhere code model for embedded systems:
4870 assume a 32 bit text and a 32 bit data segment, both starting anywhere
4871 (determined at link time).  Register %g4 points to the base of the
4872 data segment.  Pointers still 64 bits.
4873 Programs are statically linked, PIC is not supported.
4875 @item -mstack-bias
4876 @itemx -mno-stack-bias
4877 With @samp{-mstack-bias}, GCC assumes that the stack pointer, and
4878 frame pointer if present, are offset by -2047 which must be added back
4879 when making stack frame references.
4880 Otherwise, assume no such offset is present.
4881 @end table
4883 @node Convex Options
4884 @subsection Convex Options
4885 @cindex Convex options
4887 These @samp{-m} options are defined for Convex:
4889 @table @gcctabopt
4890 @item -mc1
4891 Generate output for C1.  The code will run on any Convex machine.
4892 The preprocessor symbol @code{__convex__c1__} is defined.
4894 @item -mc2
4895 Generate output for C2.  Uses instructions not available on C1.
4896 Scheduling and other optimizations are chosen for max performance on C2.
4897 The preprocessor symbol @code{__convex_c2__} is defined.
4899 @item -mc32
4900 Generate output for C32xx.  Uses instructions not available on C1.
4901 Scheduling and other optimizations are chosen for max performance on C32.
4902 The preprocessor symbol @code{__convex_c32__} is defined.
4904 @item -mc34
4905 Generate output for C34xx.  Uses instructions not available on C1.
4906 Scheduling and other optimizations are chosen for max performance on C34.
4907 The preprocessor symbol @code{__convex_c34__} is defined.
4909 @item -mc38
4910 Generate output for C38xx.  Uses instructions not available on C1.
4911 Scheduling and other optimizations are chosen for max performance on C38.
4912 The preprocessor symbol @code{__convex_c38__} is defined.
4914 @item -margcount
4915 Generate code which puts an argument count in the word preceding each
4916 argument list.  This is compatible with regular CC, and a few programs
4917 may need the argument count word.  GDB and other source-level debuggers
4918 do not need it; this info is in the symbol table.
4920 @item -mnoargcount
4921 Omit the argument count word.  This is the default.
4923 @item -mvolatile-cache
4924 Allow volatile references to be cached.  This is the default.
4926 @item -mvolatile-nocache
4927 Volatile references bypass the data cache, going all the way to memory.
4928 This is only needed for multi-processor code that does not use standard
4929 synchronization instructions.  Making non-volatile references to volatile
4930 locations will not necessarily work.
4932 @item -mlong32
4933 Type long is 32 bits, the same as type int.  This is the default.
4935 @item -mlong64
4936 Type long is 64 bits, the same as type long long.  This option is useless,
4937 because no library support exists for it.
4938 @end table
4940 @node AMD29K Options
4941 @subsection AMD29K Options
4942 @cindex AMD29K options
4944 These @samp{-m} options are defined for the AMD Am29000:
4946 @table @gcctabopt
4947 @item -mdw
4948 @kindex -mdw
4949 @cindex DW bit (29k)
4950 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
4951 halfword operations are directly supported by the hardware.  This is the
4952 default.
4954 @item -mndw
4955 @kindex -mndw
4956 Generate code that assumes the @code{DW} bit is not set.
4958 @item -mbw
4959 @kindex -mbw
4960 @cindex byte writes (29k)
4961 Generate code that assumes the system supports byte and halfword write
4962 operations.  This is the default.
4964 @item -mnbw
4965 @kindex -mnbw
4966 Generate code that assumes the systems does not support byte and
4967 halfword write operations.  @samp{-mnbw} implies @samp{-mndw}.
4969 @item -msmall
4970 @kindex -msmall
4971 @cindex memory model (29k)
4972 Use a small memory model that assumes that all function addresses are
4973 either within a single 256 KB segment or at an absolute address of less
4974 than 256k.  This allows the @code{call} instruction to be used instead
4975 of a @code{const}, @code{consth}, @code{calli} sequence.
4977 @item -mnormal
4978 @kindex -mnormal
4979 Use the normal memory model: Generate @code{call} instructions only when
4980 calling functions in the same file and @code{calli} instructions
4981 otherwise.  This works if each file occupies less than 256 KB but allows
4982 the entire executable to be larger than 256 KB.  This is the default.
4984 @item -mlarge
4985 Always use @code{calli} instructions.  Specify this option if you expect
4986 a single file to compile into more than 256 KB of code.
4988 @item -m29050
4989 @kindex -m29050
4990 @cindex processor selection (29k)
4991 Generate code for the Am29050.
4993 @item -m29000
4994 @kindex -m29000
4995 Generate code for the Am29000.  This is the default.
4997 @item -mkernel-registers
4998 @kindex -mkernel-registers
4999 @cindex kernel and user registers (29k)
5000 Generate references to registers @code{gr64-gr95} instead of to
5001 registers @code{gr96-gr127}.  This option can be used when compiling
5002 kernel code that wants a set of global registers disjoint from that used
5003 by user-mode code.
5005 Note that when this option is used, register names in @samp{-f} flags
5006 must use the normal, user-mode, names.
5008 @item -muser-registers
5009 @kindex -muser-registers
5010 Use the normal set of global registers, @code{gr96-gr127}.  This is the
5011 default.
5013 @item -mstack-check
5014 @itemx -mno-stack-check
5015 @kindex -mstack-check
5016 @cindex stack checks (29k)
5017 Insert (or do not insert) a call to @code{__msp_check} after each stack
5018 adjustment.  This is often used for kernel code.
5020 @item -mstorem-bug
5021 @itemx -mno-storem-bug
5022 @kindex -mstorem-bug
5023 @cindex storem bug (29k)
5024 @samp{-mstorem-bug} handles 29k processors which cannot handle the
5025 separation of a mtsrim insn and a storem instruction (most 29000 chips
5026 to date, but not the 29050).
5028 @item -mno-reuse-arg-regs
5029 @itemx -mreuse-arg-regs
5030 @kindex -mreuse-arg-regs
5031 @samp{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5032 registers for copying out arguments.  This helps detect calling a function
5033 with fewer arguments than it was declared with.
5035 @item -mno-impure-text
5036 @itemx -mimpure-text
5037 @kindex -mimpure-text
5038 @samp{-mimpure-text}, used in addition to @samp{-shared}, tells the compiler to
5039 not pass @samp{-assert pure-text} to the linker when linking a shared object.
5041 @item -msoft-float
5042 @kindex -msoft-float
5043 Generate output containing library calls for floating point.
5044 @strong{Warning:} the requisite libraries are not part of GCC.
5045 Normally the facilities of the machine's usual C compiler are used, but
5046 this can't be done directly in cross-compilation.  You must make your
5047 own arrangements to provide suitable library functions for
5048 cross-compilation.
5050 @item -mno-multm
5051 @kindex -mno-multm
5052 Do not generate multm or multmu instructions.  This is useful for some embedded
5053 systems which do not have trap handlers for these instructions.
5054 @end table
5056 @node ARM Options
5057 @subsection ARM Options
5058 @cindex ARM options
5060 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5061 architectures:
5063 @table @gcctabopt
5064 @item -mapcs-frame
5065 @kindex -mapcs-frame
5066 Generate a stack frame that is compliant with the ARM Procedure Call
5067 Standard for all functions, even if this is not strictly necessary for
5068 correct execution of the code.  Specifying @samp{-fomit-frame-pointer}
5069 with this option will cause the stack frames not to be generated for
5070 leaf functions.  The default is @samp{-mno-apcs-frame}.
5072 @item -mapcs
5073 @kindex -mapcs
5074 This is a synonym for @samp{-mapcs-frame}.
5076 @item -mapcs-26
5077 @kindex -mapcs-26
5078 Generate code for a processor running with a 26-bit program counter,
5079 and conforming to the function calling standards for the APCS 26-bit
5080 option.  This option replaces the @samp{-m2} and @samp{-m3} options
5081 of previous releases of the compiler.
5083 @item -mapcs-32
5084 @kindex -mapcs-32
5085 Generate code for a processor running with a 32-bit program counter,
5086 and conforming to the function calling standards for the APCS 32-bit
5087 option.  This option replaces the @samp{-m6} option of previous releases
5088 of the compiler.
5090 @item -mapcs-stack-check
5091 @kindex -mapcs-stack-check
5092 @kindex -mno-apcs-stack-check
5093 Generate code to check the amount of stack space available upon entry to
5094 every function (that actually uses some stack space).  If there is
5095 insufficient space available then either the function
5096 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5097 called, depending upon the amount of stack space required.  The run time
5098 system is required to provide these functions.  The default is
5099 @samp{-mno-apcs-stack-check}, since this produces smaller code.
5101 @item -mapcs-float
5102 @kindex -mapcs-float
5103 @kindex -mno-apcs-float
5104 Pass floating point arguments using the float point registers.  This is
5105 one of the variants of the APCS.  This option is recommended if the
5106 target hardware has a floating point unit or if a lot of floating point
5107 arithmetic is going to be performed by the code.  The default is
5108 @samp{-mno-apcs-float}, since integer only code is slightly increased in
5109 size if @samp{-mapcs-float} is used.
5111 @item -mapcs-reentrant
5112 @kindex -mapcs-reentrant
5113 @kindex -mno-apcs-reentrant
5114 Generate reentrant, position independent code.  This is the equivalent
5115 to specifying the @samp{-fpic} option.  The default is
5116 @samp{-mno-apcs-reentrant}.
5118 @item -mthumb-interwork
5119 @kindex -mthumb-interwork
5120 @kindex -mno-thumb-interwork
5121 Generate code which supports calling between the ARM and THUMB
5122 instruction sets.  Without this option the two instruction sets cannot
5123 be reliably used inside one program.  The default is
5124 @samp{-mno-thumb-interwork}, since slightly larger code is generated
5125 when @samp{-mthumb-interwork} is specified.
5127 @item -mno-sched-prolog
5128 @kindex -mno-sched-prolog
5129 @kindex -msched-prolog
5130 Prevent the reordering of instructions in the function prolog, or the
5131 merging of those instruction with the instructions in the function's
5132 body.  This means that all functions will start with a recognizable set
5133 of instructions (or in fact one of a choice from a small set of
5134 different function prologues), and this information can be used to
5135 locate the start if functions inside an executable piece of code.  The
5136 default is @samp{-msched-prolog}.
5138 @item -mhard-float
5139 Generate output containing floating point instructions.  This is the
5140 default.
5142 @item -msoft-float
5143 Generate output containing library calls for floating point.
5144 @strong{Warning:} the requisite libraries are not available for all ARM
5145 targets.  Normally the facilities of the machine's usual C compiler are
5146 used, but this cannot be done directly in cross-compilation.  You must make
5147 your own arrangements to provide suitable library functions for
5148 cross-compilation.
5150 @samp{-msoft-float} changes the calling convention in the output file;
5151 therefore, it is only useful if you compile @emph{all} of a program with
5152 this option.  In particular, you need to compile @file{libgcc.a}, the
5153 library that comes with GCC, with @samp{-msoft-float} in order for
5154 this to work.
5156 @item -mlittle-endian
5157 Generate code for a processor running in little-endian mode.  This is
5158 the default for all standard configurations.
5160 @item -mbig-endian
5161 Generate code for a processor running in big-endian mode; the default is
5162 to compile code for a little-endian processor.
5164 @item -mwords-little-endian
5165 This option only applies when generating code for big-endian processors.
5166 Generate code for a little-endian word order but a big-endian byte
5167 order.  That is, a byte order of the form @samp{32107654}.  Note: this
5168 option should only be used if you require compatibility with code for
5169 big-endian ARM processors generated by versions of the compiler prior to
5170 2.8.
5172 @item -malignment-traps
5173 @kindex -malignment-traps
5174 Generate code that will not trap if the MMU has alignment traps enabled.
5175 On ARM architectures prior to ARMv4, there were no instructions to
5176 access half-word objects stored in memory.  However, when reading from
5177 memory a feature of the ARM architecture allows a word load to be used,
5178 even if the address is unaligned, and the processor core will rotate the
5179 data as it is being loaded.  This option tells the compiler that such
5180 misaligned accesses will cause a MMU trap and that it should instead
5181 synthesise the access as a series of byte accesses.  The compiler can
5182 still use word accesses to load half-word data if it knows that the
5183 address is aligned to a word boundary.
5185 This option is ignored when compiling for ARM architecture 4 or later,
5186 since these processors have instructions to directly access half-word
5187 objects in memory. 
5188         
5189 @item -mno-alignment-traps
5190 @kindex -mno-alignment-traps
5191 Generate code that assumes that the MMU will not trap unaligned
5192 accesses.  This produces better code when the target instruction set
5193 does not have half-word memory operations (implementations prior to
5194 ARMv4). 
5196 Note that you cannot use this option to access unaligned word objects,
5197 since the processor will only fetch one 32-bit aligned object from
5198 memory. 
5200 The default setting for most targets is -mno-alignment-traps, since
5201 this produces better code when there are no half-word memory
5202 instructions available. 
5204 @item -mshort-load-bytes
5205 @kindex -mshort-load-bytes
5206 This is a deprecated alias for @samp{-malignment-traps}.
5208 @item -mno-short-load-bytes
5209 @kindex -mno-short-load-bytes
5210 This is a deprecated alias for @samp{-mno-alignment-traps}.
5212 @item -mshort-load-words
5213 @kindex -mshort-load-words
5214 This is a deprecated alias for @samp{-mno-alignment-traps}.
5216 @item -mno-short-load-words
5217 @kindex -mno-short-load-words
5218 This is a deprecated alias for @samp{-malignment-traps}.
5220 @item -mbsd
5221 @kindex -mbsd
5222 This option only applies to RISC iX.  Emulate the native BSD-mode
5223 compiler.  This is the default if @samp{-ansi} is not specified.
5225 @item -mxopen
5226 @kindex -mxopen
5227 This option only applies to RISC iX.  Emulate the native X/Open-mode
5228 compiler.
5230 @item -mno-symrename
5231 @kindex -mno-symrename
5232 This option only applies to RISC iX.  Do not run the assembler
5233 post-processor, @samp{symrename}, after code has been assembled.
5234 Normally it is necessary to modify some of the standard symbols in
5235 preparation for linking with the RISC iX C library; this option
5236 suppresses this pass.  The post-processor is never run when the
5237 compiler is built for cross-compilation.
5239 @item -mcpu=<name>
5240 @kindex -mcpu=
5241 This specifies the name of the target ARM processor.  GCC uses this name
5242 to determine what kind of instructions it can use when generating
5243 assembly code.  Permissible names are: arm2, arm250, arm3, arm6, arm60,
5244 arm600, arm610, arm620, arm7, arm7m, arm7d, arm7dm, arm7di, arm7dmi,
5245 arm70, arm700, arm700i, arm710, arm710c, arm7100, arm7500, arm7500fe,
5246 arm7tdmi, arm8, strongarm, strongarm110, strongarm1100, arm8, arm810,
5247 arm9, arm920, arm920t, arm9tdmi.
5249 @itemx -mtune=<name>
5250 @kindex -mtune=
5251 This option is very similar to the @samp{-mcpu=} option, except that
5252 instead of specifying the actual target processor type, and hence
5253 restricting which instructions can be used, it specifies that GCC should
5254 tune the performance of the code as if the target were of the type
5255 specified in this option, but still choosing the instructions that it
5256 will generate based on the cpu specified by a @samp{-mcpu=} option.
5257 For some arm implementations better performance can be obtained by using
5258 this option.
5260 @item -march=<name>
5261 @kindex -march=
5262 This specifies the name of the target ARM architecture.  GCC uses this
5263 name to determine what kind of instructions it can use when generating
5264 assembly code.  This option can be used in conjunction with or instead
5265 of the @samp{-mcpu=} option.  Permissible names are: armv2, armv2a,
5266 armv3, armv3m, armv4, armv4t, armv5.
5268 @item -mfpe=<number>
5269 @itemx -mfp=<number>
5270 @kindex -mfpe=
5271 @kindex -mfp=
5272 This specifies the version of the floating point emulation available on
5273 the target.  Permissible values are 2 and 3.  @samp{-mfp=} is a synonym
5274 for @samp{-mfpe=} to support older versions of GCC.
5276 @item -mstructure-size-boundary=<n>
5277 @kindex -mstructure-size-boundary
5278 The size of all structures and unions will be rounded up to a multiple
5279 of the number of bits set by this option.  Permissible values are 8 and
5280 32.  The default value varies for different toolchains.  For the COFF
5281 targeted toolchain the default value is 8.  Specifying the larger number
5282 can produce faster, more efficient code, but can also increase the size
5283 of the program.  The two values are potentially incompatible.  Code
5284 compiled with one value cannot necessarily expect to work with code or
5285 libraries compiled with the other value, if they exchange information
5286 using structures or unions.  Programmers are encouraged to use the 32
5287 value as future versions of the toolchain may default to this value.
5289 @item -mabort-on-noreturn
5290 @kindex -mabort-on-noreturn
5291 @kindex -mnoabort-on-noreturn
5292 Generate a call to the function abort at the end of a noreturn function.
5293 It will be executed if the function tries to return.
5295 @item -mlong-calls
5296 @itemx -mno-long-calls
5297 Tells the compiler to perform function calls by first loading the
5298 address of the function into a register and then performing a subroutine
5299 call on this register.  This switch is needed if the target function
5300 will lie outside of the 64 megabyte addressing range of the offset based
5301 version of subroutine call instruction. 
5303 Even if this switch is enabled, not all function calls will be turned
5304 into long calls.  The heuristic is that static functions, functions
5305 which have the @samp{short-call} attribute, functions that are inside
5306 the scope of a @samp{#pragma no_long_calls} directive and functions whose
5307 definitions have already been compiled within the current compilation
5308 unit, will not be turned into long calls.  The exception to this rule is
5309 that weak function definitions, functions with the @samp{long-call}
5310 attribute or the @samp{section} attribute, and functions that are within
5311 the scope of a @samp{#pragma long_calls} directive, will always be
5312 turned into long calls.
5314 This feature is not enabled by default.  Specifying
5315 @samp{--no-long-calls} will restore the default behaviour, as will
5316 placing the function calls within the scope of a @samp{#pragma
5317 long_calls_off} directive.  Note these switches have no effect on how
5318 the compiler generates code to handle function calls via function
5319 pointers.  
5321 @item -mnop-fun-dllimport
5322 @kindex -mnop-fun-dllimport
5323 Disable the support for the @emph{dllimport} attribute.
5325 @item -msingle-pic-base
5326 @kindex -msingle-pic-base
5327 Treat the register used for PIC addressing as read-only, rather than
5328 loading it in the prologue for each function.  The run-time system is
5329 responsible for initialising this register with an appropriate value
5330 before execution begins.
5332 @item -mpic-register=<reg>
5333 @kindex -mpic-register=
5334 Specify the register to be used for PIC addressing.  The default is R10
5335 unless stack-checking is enabled, when R9 is used.
5337 @end table
5339 @node Thumb Options
5340 @subsection Thumb Options
5341 @cindex Thumb Options
5343 @table @gcctabopt
5345 @item -mthumb-interwork
5346 @kindex -mthumb-interwork
5347 @kindex -mno-thumb-interwork
5348 Generate code which supports calling between the THUMB and ARM
5349 instruction sets.  Without this option the two instruction sets cannot
5350 be reliably used inside one program.  The default is
5351 @samp{-mno-thumb-interwork}, since slightly smaller code is generated
5352 with this option.
5354 @item -mtpcs-frame
5355 @kindex -mtpcs-frame
5356 @kindex -mno-tpcs-frame
5357 Generate a stack frame that is compliant with the Thumb Procedure Call
5358 Standard for all non-leaf functions.  (A leaf function is one that does
5359 not call any other functions).  The default is @samp{-mno-apcs-frame}. 
5361 @item -mtpcs-leaf-frame
5362 @kindex -mtpcs-leaf-frame
5363 @kindex -mno-tpcs-leaf-frame
5364 Generate a stack frame that is compliant with the Thumb Procedure Call
5365 Standard for all leaf functions.  (A leaf function is one that does
5366 not call any other functions).  The default is @samp{-mno-apcs-leaf-frame}. 
5368 @item -mlittle-endian
5369 @kindex -mlittle-endian
5370 Generate code for a processor running in little-endian mode.  This is
5371 the default for all standard configurations.
5373 @item -mbig-endian
5374 @kindex -mbig-endian
5375 Generate code for a processor running in big-endian mode.
5377 @item -mstructure-size-boundary=<n>
5378 @kindex -mstructure-size-boundary
5379 The size of all structures and unions will be rounded up to a multiple
5380 of the number of bits set by this option.  Permissible values are 8 and
5381 32.  The default value varies for different toolchains.  For the COFF
5382 targeted toolchain the default value is 8.  Specifying the larger number
5383 can produced faster, more efficient code, but can also increase the size
5384 of the program.  The two values are potentially incompatible.  Code
5385 compiled with one value cannot necessarily expect to work with code or
5386 libraries compiled with the other value, if they exchange information
5387 using structures or unions.  Programmers are encouraged to use the 32
5388 value as future versions of the toolchain may default to this value.
5390 @item -mnop-fun-dllimport
5391 @kindex -mnop-fun-dllimport
5392 Disable the support for the @emph{dllimport} attribute.
5394 @item -mcallee-super-interworking
5395 @kindex -mcallee-super-interworking
5396 Gives all externally visible functions in the file being compiled an ARM
5397 instruction set header which switches to Thumb mode before executing the
5398 rest of the function.  This allows these functions to be called from
5399 non-interworking code.
5401 @item -mcaller-super-interworking
5402 @kindex -mcaller-super-interworking
5403 Allows calls via function pointers (including virtual functions) to
5404 execute correctly regardless of whether the target code has been
5405 compiled for interworking or not.  There is a small overhead in the cost
5406 of executing a function pointer if this option is enabled.
5408 @item -msingle-pic-base
5409 @kindex -msingle-pic-base
5410 Treat the register used for PIC addressing as read-only, rather than
5411 loading it in the prologue for each function.  The run-time system is
5412 responsible for initialising this register with an appropriate value
5413 before execution begins.
5415 @item -mpic-register=<reg>
5416 @kindex -mpic-register=
5417 Specify the register to be used for PIC addressing.  The default is R10.
5419 @end table
5421 @node MN10200 Options
5422 @subsection MN10200 Options
5423 @cindex MN10200 options
5424 These @samp{-m} options are defined for Matsushita MN10200 architectures:
5425 @table @gcctabopt
5427 @item -mrelax
5428 Indicate to the linker that it should perform a relaxation optimization pass
5429 to shorten branches, calls and absolute memory addresses.  This option only
5430 has an effect when used on the command line for the final link step.
5432 This option makes symbolic debugging impossible. 
5433 @end table
5435 @node MN10300 Options
5436 @subsection MN10300 Options
5437 @cindex MN10300 options
5438 These @samp{-m} options are defined for Matsushita MN10300 architectures:
5440 @table @gcctabopt
5441 @item -mmult-bug
5442 Generate code to avoid bugs in the multiply instructions for the MN10300
5443 processors.  This is the default.
5445 @item -mno-mult-bug
5446 Do not generate code to avoid bugs in the multiply instructions for the
5447 MN10300 processors.
5449 @item -mam33
5450 Generate code which uses features specific to the AM33 processor.
5452 @item -mno-am33
5453 Do not generate code which uses features specific to the AM33 processor.  This
5454 is the default.
5456 @item -mrelax
5457 Indicate to the linker that it should perform a relaxation optimization pass
5458 to shorten branches, calls and absolute memory addresses.  This option only
5459 has an effect when used on the command line for the final link step.
5461 This option makes symbolic debugging impossible. 
5462 @end table
5465 @node M32R/D Options
5466 @subsection M32R/D Options
5467 @cindex M32R/D options
5469 These @samp{-m} options are defined for Mitsubishi M32R/D architectures:
5471 @table @gcctabopt
5472 @item -mcode-model=small
5473 Assume all objects live in the lower 16MB of memory (so that their addresses
5474 can be loaded with the @code{ld24} instruction), and assume all subroutines
5475 are reachable with the @code{bl} instruction.
5476 This is the default.
5478 The addressability of a particular object can be set with the
5479 @code{model} attribute.
5481 @item -mcode-model=medium
5482 Assume objects may be anywhere in the 32 bit address space (the compiler
5483 will generate @code{seth/add3} instructions to load their addresses), and
5484 assume all subroutines are reachable with the @code{bl} instruction.
5486 @item -mcode-model=large
5487 Assume objects may be anywhere in the 32 bit address space (the compiler
5488 will generate @code{seth/add3} instructions to load their addresses), and
5489 assume subroutines may not be reachable with the @code{bl} instruction
5490 (the compiler will generate the much slower @code{seth/add3/jl}
5491 instruction sequence).
5493 @item -msdata=none
5494 Disable use of the small data area.  Variables will be put into
5495 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
5496 @code{section} attribute has been specified).
5497 This is the default.
5499 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
5500 Objects may be explicitly put in the small data area with the
5501 @code{section} attribute using one of these sections.
5503 @item -msdata=sdata
5504 Put small global and static data in the small data area, but do not
5505 generate special code to reference them.
5507 @item -msdata=use
5508 Put small global and static data in the small data area, and generate
5509 special instructions to reference them.
5511 @item -G @var{num}
5512 @cindex smaller data references
5513 Put global and static objects less than or equal to @var{num} bytes
5514 into the small data or bss sections instead of the normal data or bss
5515 sections.  The default value of @var{num} is 8.
5516 The @samp{-msdata} option must be set to one of @samp{sdata} or @samp{use}
5517 for this option to have any effect.
5519 All modules should be compiled with the same @samp{-G @var{num}} value.
5520 Compiling with different values of @var{num} may or may not work; if it
5521 doesn't the linker will give an error message - incorrect code will not be
5522 generated.
5524 @end table
5526 @node M88K Options
5527 @subsection M88K Options
5528 @cindex M88k options
5530 These @samp{-m} options are defined for Motorola 88k architectures:
5532 @table @gcctabopt
5533 @item -m88000
5534 @kindex -m88000
5535 Generate code that works well on both the m88100 and the
5536 m88110.
5538 @item -m88100
5539 @kindex -m88100
5540 Generate code that works best for the m88100, but that also
5541 runs on the m88110.
5543 @item -m88110
5544 @kindex -m88110
5545 Generate code that works best for the m88110, and may not run
5546 on the m88100.
5548 @item -mbig-pic
5549 @kindex -mbig-pic
5550 Obsolete option to be removed from the next revision.
5551 Use @samp{-fPIC}.
5553 @item -midentify-revision
5554 @kindex -midentify-revision
5555 @kindex ident
5556 @cindex identifying source, compiler (88k)
5557 Include an @code{ident} directive in the assembler output recording the
5558 source file name, compiler name and version, timestamp, and compilation
5559 flags used.
5561 @item -mno-underscores
5562 @kindex -mno-underscores
5563 @cindex underscores, avoiding (88k)
5564 In assembler output, emit symbol names without adding an underscore
5565 character at the beginning of each name.  The default is to use an
5566 underscore as prefix on each name.
5568 @item -mocs-debug-info
5569 @itemx -mno-ocs-debug-info
5570 @kindex -mocs-debug-info
5571 @kindex -mno-ocs-debug-info
5572 @cindex OCS (88k)
5573 @cindex debugging, 88k OCS
5574 Include (or omit) additional debugging information (about registers used
5575 in each stack frame) as specified in the 88open Object Compatibility
5576 Standard, ``OCS''.  This extra information allows debugging of code that
5577 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
5578 Delta 88 SVr3.2 is to include this information; other 88k configurations
5579 omit this information by default.
5581 @item -mocs-frame-position
5582 @kindex -mocs-frame-position
5583 @cindex register positions in frame (88k)
5584 When emitting COFF debugging information for automatic variables and
5585 parameters stored on the stack, use the offset from the canonical frame
5586 address, which is the stack pointer (register 31) on entry to the
5587 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
5588 @samp{-mocs-frame-position}; other 88k configurations have the default
5589 @samp{-mno-ocs-frame-position}.
5591 @item -mno-ocs-frame-position
5592 @kindex -mno-ocs-frame-position
5593 @cindex register positions in frame (88k)
5594 When emitting COFF debugging information for automatic variables and
5595 parameters stored on the stack, use the offset from the frame pointer
5596 register (register 30).  When this option is in effect, the frame
5597 pointer is not eliminated when debugging information is selected by the
5598 -g switch.
5600 @item -moptimize-arg-area
5601 @itemx -mno-optimize-arg-area
5602 @kindex -moptimize-arg-area
5603 @kindex -mno-optimize-arg-area
5604 @cindex arguments in frame (88k)
5605 Control how function arguments are stored in stack frames.
5606 @samp{-moptimize-arg-area} saves space by optimizing them, but this
5607 conflicts with the 88open specifications.  The opposite alternative,
5608 @samp{-mno-optimize-arg-area}, agrees with 88open standards.  By default
5609 GCC does not optimize the argument area.
5611 @item -mshort-data-@var{num}
5612 @kindex -mshort-data-@var{num}
5613 @cindex smaller data references (88k)
5614 @cindex r0-relative references (88k)
5615 Generate smaller data references by making them relative to @code{r0},
5616 which allows loading a value using a single instruction (rather than the
5617 usual two).  You control which data references are affected by
5618 specifying @var{num} with this option.  For example, if you specify
5619 @samp{-mshort-data-512}, then the data references affected are those
5620 involving displacements of less than 512 bytes.
5621 @samp{-mshort-data-@var{num}} is not effective for @var{num} greater
5622 than 64k.
5624 @item -mserialize-volatile
5625 @kindex -mserialize-volatile
5626 @itemx -mno-serialize-volatile
5627 @kindex -mno-serialize-volatile
5628 @cindex sequential consistency on 88k
5629 Do, or don't, generate code to guarantee sequential consistency
5630 of volatile memory references.  By default, consistency is
5631 guaranteed.
5633 The order of memory references made by the MC88110 processor does
5634 not always match the order of the instructions requesting those
5635 references.  In particular, a load instruction may execute before
5636 a preceding store instruction.  Such reordering violates
5637 sequential consistency of volatile memory references, when there
5638 are multiple processors.   When consistency must be guaranteed,
5639 GNU C generates special instructions, as needed, to force
5640 execution in the proper order.
5642 The MC88100 processor does not reorder memory references and so
5643 always provides sequential consistency.  However, by default, GNU
5644 C generates the special instructions to guarantee consistency
5645 even when you use @samp{-m88100}, so that the code may be run on an
5646 MC88110 processor.  If you intend to run your code only on the
5647 MC88100 processor, you may use @samp{-mno-serialize-volatile}.
5649 The extra code generated to guarantee consistency may affect the
5650 performance of your application.  If you know that you can safely
5651 forgo this guarantee, you may use @samp{-mno-serialize-volatile}.
5653 @item -msvr4
5654 @itemx -msvr3
5655 @kindex -msvr4
5656 @kindex -msvr3
5657 @cindex assembler syntax, 88k
5658 @cindex SVr4
5659 Turn on (@samp{-msvr4}) or off (@samp{-msvr3}) compiler extensions
5660 related to System V release 4 (SVr4).  This controls the following:
5662 @enumerate
5663 @item
5664 Which variant of the assembler syntax to emit.
5665 @item
5666 @samp{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
5667 that is used on System V release 4.
5668 @item
5669 @samp{-msvr4} makes GCC issue additional declaration directives used in
5670 SVr4.
5671 @end enumerate
5673 @samp{-msvr4} is the default for the m88k-motorola-sysv4 and
5674 m88k-dg-dgux m88k configurations. @samp{-msvr3} is the default for all
5675 other m88k configurations.
5677 @item -mversion-03.00
5678 @kindex -mversion-03.00
5679 This option is obsolete, and is ignored.
5680 @c ??? which asm syntax better for GAS?  option there too?
5682 @item -mno-check-zero-division
5683 @itemx -mcheck-zero-division
5684 @kindex -mno-check-zero-division
5685 @kindex -mcheck-zero-division
5686 @cindex zero division on 88k
5687 Do, or don't, generate code to guarantee that integer division by
5688 zero will be detected.  By default, detection is guaranteed.
5690 Some models of the MC88100 processor fail to trap upon integer
5691 division by zero under certain conditions.  By default, when
5692 compiling code that might be run on such a processor, GNU C
5693 generates code that explicitly checks for zero-valued divisors
5694 and traps with exception number 503 when one is detected.  Use of
5695 mno-check-zero-division suppresses such checking for code
5696 generated to run on an MC88100 processor.
5698 GNU C assumes that the MC88110 processor correctly detects all
5699 instances of integer division by zero.  When @samp{-m88110} is
5700 specified, both @samp{-mcheck-zero-division} and
5701 @samp{-mno-check-zero-division} are ignored, and no explicit checks for
5702 zero-valued divisors are generated.
5704 @item -muse-div-instruction
5705 @kindex -muse-div-instruction
5706 @cindex divide instruction, 88k
5707 Use the div instruction for signed integer division on the
5708 MC88100 processor.  By default, the div instruction is not used.
5710 On the MC88100 processor the signed integer division instruction
5711 div) traps to the operating system on a negative operand.  The
5712 operating system transparently completes the operation, but at a
5713 large cost in execution time.  By default, when compiling code
5714 that might be run on an MC88100 processor, GNU C emulates signed
5715 integer division using the unsigned integer division instruction
5716 divu), thereby avoiding the large penalty of a trap to the
5717 operating system.  Such emulation has its own, smaller, execution
5718 cost in both time and space.  To the extent that your code's
5719 important signed integer division operations are performed on two
5720 nonnegative operands, it may be desirable to use the div
5721 instruction directly.
5723 On the MC88110 processor the div instruction (also known as the
5724 divs instruction) processes negative operands without trapping to
5725 the operating system.  When @samp{-m88110} is specified,
5726 @samp{-muse-div-instruction} is ignored, and the div instruction is used
5727 for signed integer division.
5729 Note that the result of dividing INT_MIN by -1 is undefined.  In
5730 particular, the behavior of such a division with and without
5731 @samp{-muse-div-instruction}  may differ.
5733 @item -mtrap-large-shift
5734 @itemx -mhandle-large-shift
5735 @kindex -mtrap-large-shift
5736 @kindex -mhandle-large-shift
5737 @cindex bit shift overflow (88k)
5738 @cindex large bit shifts (88k)
5739 Include code to detect bit-shifts of more than 31 bits; respectively,
5740 trap such shifts or emit code to handle them properly.  By default GCC
5741 makes no special provision for large bit shifts.
5743 @item -mwarn-passed-structs
5744 @kindex -mwarn-passed-structs
5745 @cindex structure passing (88k)
5746 Warn when a function passes a struct as an argument or result.
5747 Structure-passing conventions have changed during the evolution of the C
5748 language, and are often the source of portability problems.  By default,
5749 GCC issues no such warning.
5750 @end table
5752 @node RS/6000 and PowerPC Options
5753 @subsection IBM RS/6000 and PowerPC Options
5754 @cindex RS/6000 and PowerPC Options
5755 @cindex IBM RS/6000 and PowerPC Options
5757 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
5758 @table @gcctabopt
5759 @item -mpower
5760 @itemx -mno-power
5761 @itemx -mpower2
5762 @itemx -mno-power2
5763 @itemx -mpowerpc
5764 @itemx -mno-powerpc
5765 @itemx -mpowerpc-gpopt
5766 @itemx -mno-powerpc-gpopt
5767 @itemx -mpowerpc-gfxopt
5768 @itemx -mno-powerpc-gfxopt
5769 @itemx -mpowerpc64
5770 @itemx -mno-powerpc64
5771 @kindex -mpower
5772 @kindex -mpower2
5773 @kindex -mpowerpc
5774 @kindex -mpowerpc-gpopt
5775 @kindex -mpowerpc-gfxopt
5776 @kindex -mpowerpc64
5777 GCC supports two related instruction set architectures for the
5778 RS/6000 and PowerPC.  The @dfn{POWER} instruction set are those
5779 instructions supported by the @samp{rios} chip set used in the original
5780 RS/6000 systems and the @dfn{PowerPC} instruction set is the
5781 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
5782 the IBM 4xx microprocessors.
5784 Neither architecture is a subset of the other.  However there is a
5785 large common subset of instructions supported by both.  An MQ
5786 register is included in processors supporting the POWER architecture.
5788 You use these options to specify which instructions are available on the
5789 processor you are using.  The default value of these options is
5790 determined when configuring GCC.  Specifying the
5791 @samp{-mcpu=@var{cpu_type}} overrides the specification of these
5792 options.  We recommend you use the @samp{-mcpu=@var{cpu_type}} option
5793 rather than the options listed above.
5795 The @samp{-mpower} option allows GCC to generate instructions that
5796 are found only in the POWER architecture and to use the MQ register.
5797 Specifying @samp{-mpower2} implies @samp{-power} and also allows GCC
5798 to generate instructions that are present in the POWER2 architecture but
5799 not the original POWER architecture.
5801 The @samp{-mpowerpc} option allows GCC to generate instructions that
5802 are found only in the 32-bit subset of the PowerPC architecture.
5803 Specifying @samp{-mpowerpc-gpopt} implies @samp{-mpowerpc} and also allows
5804 GCC to use the optional PowerPC architecture instructions in the
5805 General Purpose group, including floating-point square root.  Specifying
5806 @samp{-mpowerpc-gfxopt} implies @samp{-mpowerpc} and also allows GCC to
5807 use the optional PowerPC architecture instructions in the Graphics
5808 group, including floating-point select.
5810 The @samp{-mpowerpc64} option allows GCC to generate the additional
5811 64-bit instructions that are found in the full PowerPC64 architecture
5812 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
5813 @samp{-mno-powerpc64}.
5815 If you specify both @samp{-mno-power} and @samp{-mno-powerpc}, GCC
5816 will use only the instructions in the common subset of both
5817 architectures plus some special AIX common-mode calls, and will not use
5818 the MQ register.  Specifying both @samp{-mpower} and @samp{-mpowerpc}
5819 permits GCC to use any instruction from either architecture and to
5820 allow use of the MQ register; specify this for the Motorola MPC601.
5822 @item -mnew-mnemonics
5823 @itemx -mold-mnemonics
5824 @kindex -mnew-mnemonics
5825 @kindex -mold-mnemonics
5826 Select which mnemonics to use in the generated assembler code.
5827 @samp{-mnew-mnemonics} requests output that uses the assembler mnemonics
5828 defined for the PowerPC architecture, while @samp{-mold-mnemonics}
5829 requests the assembler mnemonics defined for the POWER architecture.
5830 Instructions defined in only one architecture have only one mnemonic;
5831 GCC uses that mnemonic irrespective of which of these options is
5832 specified.
5834 GCC defaults to the mnemonics appropriate for the architecture in
5835 use.  Specifying @samp{-mcpu=@var{cpu_type}} sometimes overrides the
5836 value of these option.  Unless you are building a cross-compiler, you
5837 should normally not specify either @samp{-mnew-mnemonics} or
5838 @samp{-mold-mnemonics}, but should instead accept the default.
5840 @item -mcpu=@var{cpu_type}
5841 @kindex -mcpu
5842 Set architecture type, register usage, choice of mnemonics, and
5843 instruction scheduling parameters for machine type @var{cpu_type}.
5844 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
5845 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
5846 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
5847 @samp{630}, @samp{740}, @samp{750}, @samp{power}, @samp{power2},
5848 @samp{powerpc}, @samp{403}, @samp{505}, @samp{801}, @samp{821},
5849 @samp{823}, and @samp{860} and @samp{common}.  @samp{-mcpu=power},
5850 @samp{-mcpu=power2}, @samp{-mcpu=powerpc}, and @samp{-mcpu=powerpc64}
5851 specify generic POWER, POWER2, pure 32-bit PowerPC (i.e., not MPC601),
5852 and 64-bit PowerPC architecture machine types, with an appropriate,
5853 generic processor model assumed for scheduling purposes.@refill
5855 Specifying any of the following options: 
5856 @samp{-mcpu=rios1}, @samp{-mcpu=rios2}, @samp{-mcpu=rsc},
5857 @samp{-mcpu=power}, or @samp{-mcpu=power2}  
5858 enables the @samp{-mpower} option and disables the @samp{-mpowerpc} option; 
5859 @samp{-mcpu=601} enables both the @samp{-mpower} and @samp{-mpowerpc} options.
5860 All of @samp{-mcpu=rs64a}, @samp{-mcpu=602}, @samp{-mcpu=603},
5861 @samp{-mcpu=603e}, @samp{-mcpu=604}, @samp{-mcpu=620}, @samp{-mcpu=630},
5862 @samp{-mcpu=740}, and @samp{-mcpu=750}
5863 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.  
5864 Exactly similarly, all of @samp{-mcpu=403},
5865 @samp{-mcpu=505}, @samp{-mcpu=821}, @samp{-mcpu=860} and @samp{-mcpu=powerpc} 
5866 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
5867 @samp{-mcpu=common} disables both the 
5868 @samp{-mpower} and @samp{-mpowerpc} options.@refill
5870 AIX versions 4 or greater selects @samp{-mcpu=common} by default, so
5871 that code will operate on all members of the RS/6000 POWER and PowerPC
5872 families.  In that case, GCC will use only the instructions in the
5873 common subset of both architectures plus some special AIX common-mode
5874 calls, and will not use the MQ register.  GCC assumes a generic
5875 processor model for scheduling purposes.
5877 Specifying any of the options @samp{-mcpu=rios1}, @samp{-mcpu=rios2},
5878 @samp{-mcpu=rsc}, @samp{-mcpu=power}, or @samp{-mcpu=power2} also
5879 disables the @samp{new-mnemonics} option.  Specifying @samp{-mcpu=601},
5880 @samp{-mcpu=602}, @samp{-mcpu=603}, @samp{-mcpu=603e}, @samp{-mcpu=604},
5881 @samp{-mcpu=620}, @samp{-mcpu=630}, @samp{-mcpu=403}, @samp{-mcpu=505},
5882 @samp{-mcpu=821}, @samp{-mcpu=860} or @samp{-mcpu=powerpc} also enables
5883 the @samp{new-mnemonics} option.@refill
5885 Specifying @samp{-mcpu=403}, @samp{-mcpu=821}, or @samp{-mcpu=860} also
5886 enables the @samp{-msoft-float} option.
5888 @item -mtune=@var{cpu_type}
5889 Set the instruction scheduling parameters for machine type
5890 @var{cpu_type}, but do not set the architecture type, register usage,
5891 choice of mnemonics like @samp{-mcpu=}@var{cpu_type} would.  The same
5892 values for @var{cpu_type} are used for @samp{-mtune=}@var{cpu_type} as
5893 for @samp{-mcpu=}@var{cpu_type}.  The @samp{-mtune=}@var{cpu_type}
5894 option overrides the @samp{-mcpu=}@var{cpu_type} option in terms of
5895 instruction scheduling parameters.
5897 @item -mfull-toc
5898 @itemx -mno-fp-in-toc
5899 @itemx -mno-sum-in-toc
5900 @itemx -mminimal-toc
5901 @kindex -mminimal-toc
5902 Modify generation of the TOC (Table Of Contents), which is created for
5903 every executable file.  The @samp{-mfull-toc} option is selected by
5904 default.  In that case, GCC will allocate at least one TOC entry for
5905 each unique non-automatic variable reference in your program.  GCC
5906 will also place floating-point constants in the TOC.  However, only
5907 16,384 entries are available in the TOC.
5909 If you receive a linker error message that saying you have overflowed
5910 the available TOC space, you can reduce the amount of TOC space used
5911 with the @samp{-mno-fp-in-toc} and @samp{-mno-sum-in-toc} options.
5912 @samp{-mno-fp-in-toc} prevents GCC from putting floating-point
5913 constants in the TOC and @samp{-mno-sum-in-toc} forces GCC to
5914 generate code to calculate the sum of an address and a constant at
5915 run-time instead of putting that sum into the TOC.  You may specify one
5916 or both of these options.  Each causes GCC to produce very slightly
5917 slower and larger code at the expense of conserving TOC space.
5919 If you still run out of space in the TOC even when you specify both of
5920 these options, specify @samp{-mminimal-toc} instead.  This option causes
5921 GCC to make only one TOC entry for every file.  When you specify this
5922 option, GCC will produce code that is slower and larger but which
5923 uses extremely little TOC space.  You may wish to use this option
5924 only on files that contain less frequently executed code. @refill
5926 @item -maix64
5927 @itemx -maix32
5928 @kindex -maix64
5929 @kindex -maix32
5930 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
5931 @code{long} type, and the infrastructure needed to support them.
5932 Specifying @samp{-maix64} implies @samp{-mpowerpc64} and
5933 @samp{-mpowerpc}, while @samp{-maix32} disables the 64-bit ABI and
5934 implies @samp{-mno-powerpc64}.  GCC defaults to @samp{-maix32}.
5936 @item -mxl-call
5937 @itemx -mno-xl-call
5938 @kindex -mxl-call
5939 On AIX, pass floating-point arguments to prototyped functions beyond the
5940 register save area (RSA) on the stack in addition to argument FPRs.  The
5941 AIX calling convention was extended but not initially documented to
5942 handle an obscure K&R C case of calling a function that takes the
5943 address of its arguments with fewer arguments than declared.  AIX XL
5944 compilers access floating point arguments which do not fit in the
5945 RSA from the stack when a subroutine is compiled without
5946 optimization.  Because always storing floating-point arguments on the
5947 stack is inefficient and rarely needed, this option is not enabled by
5948 default and only is necessary when calling subroutines compiled by AIX
5949 XL compilers without optimization.
5951 @item -mthreads
5952 @kindex -mthreads
5953 Support @dfn{AIX Threads}.  Link an application written to use
5954 @dfn{pthreads} with special libraries and startup code to enable the
5955 application to run.
5957 @item -mpe
5958 @kindex -mpe
5959 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE).  Link an
5960 application written to use message passing with special startup code to
5961 enable the application to run.  The system must have PE installed in the
5962 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
5963 must be overridden with the @samp{-specs=} option to specify the
5964 appropriate directory location.  The Parallel Environment does not
5965 support threads, so the @samp{-mpe} option and the @samp{-mthreads}
5966 option are incompatible.
5968 @item -msoft-float
5969 @itemx -mhard-float
5970 @kindex -msoft-float
5971 Generate code that does not use (uses) the floating-point register set.
5972 Software floating point emulation is provided if you use the
5973 @samp{-msoft-float} option, and pass the option to GCC when linking.
5975 @item -mmultiple
5976 @itemx -mno-multiple
5977 Generate code that uses (does not use) the load multiple word
5978 instructions and the store multiple word instructions.  These
5979 instructions are generated by default on POWER systems, and not
5980 generated on PowerPC systems.  Do not use @samp{-mmultiple} on little
5981 endian PowerPC systems, since those instructions do not work when the
5982 processor is in little endian mode.  The exceptions are PPC740 and
5983 PPC750 which permit the instructions usage in little endian mode.
5985 @item -mstring
5986 @itemx -mno-string
5987 @kindex -mstring
5988 Generate code that uses (does not use) the load string instructions
5989 and the store string word instructions to save multiple registers and
5990 do small block moves.  These instructions are generated by default on
5991 POWER systems, and not generated on PowerPC systems.  Do not use
5992 @samp{-mstring} on little endian PowerPC systems, since those
5993 instructions do not work when the processor is in little endian mode.
5994 The exceptions are PPC740 and PPC750 which permit the instructions
5995 usage in little endian mode.
5997 @item -mupdate
5998 @itemx -mno-update
5999 @kindex -mupdate
6000 Generate code that uses (does not use) the load or store instructions
6001 that update the base register to the address of the calculated memory
6002 location.  These instructions are generated by default.  If you use
6003 @samp{-mno-update}, there is a small window between the time that the
6004 stack pointer is updated and the address of the previous frame is
6005 stored, which means code that walks the stack frame across interrupts or
6006 signals may get corrupted data.
6008 @item -mfused-madd
6009 @itemx -mno-fused-madd
6010 @kindex -mfused-madd
6011 Generate code that uses (does not use) the floating point multiply and
6012 accumulate instructions.  These instructions are generated by default if
6013 hardware floating is used.
6015 @item -mno-bit-align
6016 @itemx -mbit-align
6017 @kindex -mbit-align
6018 On System V.4 and embedded PowerPC systems do not (do) force structures
6019 and unions that contain bit fields to be aligned to the base type of the
6020 bit field.
6022 For example, by default a structure containing nothing but 8
6023 @code{unsigned} bitfields of length 1 would be aligned to a 4 byte
6024 boundary and have a size of 4 bytes.  By using @samp{-mno-bit-align},
6025 the structure would be aligned to a 1 byte boundary and be one byte in
6026 size.
6028 @item -mno-strict-align
6029 @itemx -mstrict-align
6030 @kindex -mstrict-align
6031 On System V.4 and embedded PowerPC systems do not (do) assume that
6032 unaligned memory references will be handled by the system.
6034 @item -mrelocatable
6035 @itemx -mno-relocatable
6036 @kindex -mrelocatable
6037 On embedded PowerPC systems generate code that allows (does not allow)
6038 the program to be relocated to a different address at runtime.  If you
6039 use @samp{-mrelocatable} on any module, all objects linked together must
6040 be compiled with @samp{-mrelocatable} or @samp{-mrelocatable-lib}.
6042 @item -mrelocatable-lib
6043 @itemx -mno-relocatable-lib
6044 On embedded PowerPC systems generate code that allows (does not allow)
6045 the program to be relocated to a different address at runtime.  Modules
6046 compiled with @samp{-mrelocatable-lib} can be linked with either modules
6047 compiled without @samp{-mrelocatable} and @samp{-mrelocatable-lib} or
6048 with modules compiled with the @samp{-mrelocatable} options.
6050 @item -mno-toc
6051 @itemx -mtoc
6052 On System V.4 and embedded PowerPC systems do not (do) assume that
6053 register 2 contains a pointer to a global area pointing to the addresses
6054 used in the program.
6056 @item -mlittle
6057 @itemx -mlittle-endian
6058 On System V.4 and embedded PowerPC systems compile code for the
6059 processor in little endian mode.  The @samp{-mlittle-endian} option is
6060 the same as @samp{-mlittle}.
6062 @item -mbig
6063 @itemx -mbig-endian
6064 On System V.4 and embedded PowerPC systems compile code for the
6065 processor in big endian mode.  The @samp{-mbig-endian} option is
6066 the same as @samp{-mbig}.
6068 @item -mcall-sysv
6069 On System V.4 and embedded PowerPC systems compile code using calling
6070 conventions that adheres to the March 1995 draft of the System V
6071 Application Binary Interface, PowerPC processor supplement.  This is the
6072 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6074 @item -mcall-sysv-eabi
6075 Specify both @samp{-mcall-sysv} and @samp{-meabi} options.
6077 @item -mcall-sysv-noeabi
6078 Specify both @samp{-mcall-sysv} and @samp{-mno-eabi} options.
6080 @item -mcall-aix
6081 On System V.4 and embedded PowerPC systems compile code using calling
6082 conventions that are similar to those used on AIX.  This is the
6083 default if you configured GCC using @samp{powerpc-*-eabiaix}.
6085 @item -mcall-solaris
6086 On System V.4 and embedded PowerPC systems compile code for the Solaris
6087 operating system.
6089 @item -mcall-linux
6090 On System V.4 and embedded PowerPC systems compile code for the
6091 Linux-based GNU system.
6093 @item -mprototype
6094 @itemx -mno-prototype
6095 On System V.4 and embedded PowerPC systems assume that all calls to
6096 variable argument functions are properly prototyped.  Otherwise, the
6097 compiler must insert an instruction before every non prototyped call to
6098 set or clear bit 6 of the condition code register (@var{CR}) to
6099 indicate whether floating point values were passed in the floating point
6100 registers in case the function takes a variable arguments.  With
6101 @samp{-mprototype}, only calls to prototyped variable argument functions
6102 will set or clear the bit.
6104 @item -msim
6105 On embedded PowerPC systems, assume that the startup module is called
6106 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6107 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
6108 configurations.
6110 @item -mmvme
6111 On embedded PowerPC systems, assume that the startup module is called
6112 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6113 @file{libc.a}.
6115 @item -mads
6116 On embedded PowerPC systems, assume that the startup module is called
6117 @file{crt0.o} and the standard C libraries are @file{libads.a} and
6118 @file{libc.a}.
6120 @item -myellowknife
6121 On embedded PowerPC systems, assume that the startup module is called
6122 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
6123 @file{libc.a}.
6125 @item -mvxworks
6126 On System V.4 and embedded PowerPC systems, specify that you are
6127 compiling for a VxWorks system.
6129 @item -memb
6130 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
6131 header to indicate that @samp{eabi} extended relocations are used.
6133 @item -meabi
6134 @itemx -mno-eabi
6135 On System V.4 and embedded PowerPC systems do (do not) adhere to the
6136 Embedded Applications Binary Interface (eabi) which is a set of
6137 modifications to the System V.4 specifications.  Selecting @option{-meabi}
6138 means that the stack is aligned to an 8 byte boundary, a function
6139 @code{__eabi} is called to from @code{main} to set up the eabi
6140 environment, and the @samp{-msdata} option can use both @code{r2} and
6141 @code{r13} to point to two separate small data areas.  Selecting
6142 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
6143 do not call an initialization function from @code{main}, and the
6144 @samp{-msdata} option will only use @code{r13} to point to a single
6145 small data area.  The @samp{-meabi} option is on by default if you
6146 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
6148 @item -msdata=eabi
6149 On System V.4 and embedded PowerPC systems, put small initialized
6150 @code{const} global and static data in the @samp{.sdata2} section, which
6151 is pointed to by register @code{r2}.  Put small initialized
6152 non-@code{const} global and static data in the @samp{.sdata} section,
6153 which is pointed to by register @code{r13}.  Put small uninitialized
6154 global and static data in the @samp{.sbss} section, which is adjacent to
6155 the @samp{.sdata} section.  The @samp{-msdata=eabi} option is
6156 incompatible with the @samp{-mrelocatable} option.  The
6157 @samp{-msdata=eabi} option also sets the @samp{-memb} option.
6159 @item -msdata=sysv
6160 On System V.4 and embedded PowerPC systems, put small global and static
6161 data in the @samp{.sdata} section, which is pointed to by register
6162 @code{r13}.  Put small uninitialized global and static data in the
6163 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
6164 The @samp{-msdata=sysv} option is incompatible with the
6165 @samp{-mrelocatable} option.
6167 @item -msdata=default
6168 @itemx -msdata
6169 On System V.4 and embedded PowerPC systems, if @samp{-meabi} is used,
6170 compile code the same as @samp{-msdata=eabi}, otherwise compile code the
6171 same as @samp{-msdata=sysv}.
6173 @item -msdata-data
6174 On System V.4 and embedded PowerPC systems, put small global and static
6175 data in the @samp{.sdata} section.  Put small uninitialized global and
6176 static data in the @samp{.sbss} section.  Do not use register @code{r13}
6177 to address small data however.  This is the default behavior unless
6178 other @samp{-msdata} options are used.
6180 @item -msdata=none
6181 @itemx -mno-sdata
6182 On embedded PowerPC systems, put all initialized global and static data
6183 in the @samp{.data} section, and all uninitialized data in the
6184 @samp{.bss} section.
6186 @item -G @var{num}
6187 @cindex smaller data references (PowerPC)
6188 @cindex .sdata/.sdata2 references (PowerPC)
6189 On embedded PowerPC systems, put global and static items less than or
6190 equal to @var{num} bytes into the small data or bss sections instead of
6191 the normal data or bss section.  By default, @var{num} is 8.  The
6192 @samp{-G @var{num}} switch is also passed to the linker.
6193 All modules should be compiled with the same @samp{-G @var{num}} value.
6195 @item -mregnames
6196 @itemx -mno-regnames
6197 On System V.4 and embedded PowerPC systems do (do not) emit register
6198 names in the assembly language output using symbolic forms.
6200 @end table
6202 @node RT Options
6203 @subsection IBM RT Options
6204 @cindex RT options
6205 @cindex IBM RT options
6207 These @samp{-m} options are defined for the IBM RT PC:
6209 @table @gcctabopt
6210 @item -min-line-mul
6211 Use an in-line code sequence for integer multiplies.  This is the
6212 default.
6214 @item -mcall-lib-mul
6215 Call @code{lmul$$} for integer multiples.
6217 @item -mfull-fp-blocks
6218 Generate full-size floating point data blocks, including the minimum
6219 amount of scratch space recommended by IBM.  This is the default.
6221 @item -mminimum-fp-blocks
6222 Do not include extra scratch space in floating point data blocks.  This
6223 results in smaller code, but slower execution, since scratch space must
6224 be allocated dynamically.
6226 @cindex @file{varargs.h} and RT PC
6227 @cindex @file{stdarg.h} and RT PC
6228 @item -mfp-arg-in-fpregs
6229 Use a calling sequence incompatible with the IBM calling convention in
6230 which floating point arguments are passed in floating point registers.
6231 Note that @code{varargs.h} and @code{stdargs.h} will not work with
6232 floating point operands if this option is specified.
6234 @item -mfp-arg-in-gregs
6235 Use the normal calling convention for floating point arguments.  This is
6236 the default.
6238 @item -mhc-struct-return
6239 Return structures of more than one word in memory, rather than in a
6240 register.  This provides compatibility with the MetaWare HighC (hc)
6241 compiler.  Use the option @samp{-fpcc-struct-return} for compatibility
6242 with the Portable C Compiler (pcc).
6244 @item -mnohc-struct-return
6245 Return some structures of more than one word in registers, when
6246 convenient.  This is the default.  For compatibility with the
6247 IBM-supplied compilers, use the option @samp{-fpcc-struct-return} or the
6248 option @samp{-mhc-struct-return}.
6249 @end table
6251 @node MIPS Options
6252 @subsection MIPS Options
6253 @cindex MIPS options
6255 These @samp{-m} options are defined for the MIPS family of computers:
6257 @table @gcctabopt
6258 @item -mcpu=@var{cpu type}
6259 Assume the defaults for the machine type @var{cpu type} when scheduling
6260 instructions.  The choices for @var{cpu type} are @samp{r2000}, @samp{r3000},
6261 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
6262 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
6263 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
6264 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
6265 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.  While picking a specific
6266 @var{cpu type} will schedule things appropriately for that particular
6267 chip, the compiler will not generate any code that does not meet level 1
6268 of the MIPS ISA (instruction set architecture) without a @samp{-mipsX}
6269 or @samp{-mabi} switch being used.
6271 @item -mips1
6272 Issue instructions from level 1 of the MIPS ISA.  This is the default.
6273 @samp{r3000} is the default @var{cpu type} at this ISA level.
6275 @item -mips2
6276 Issue instructions from level 2 of the MIPS ISA (branch likely, square
6277 root instructions).  @samp{r6000} is the default @var{cpu type} at this
6278 ISA level.
6280 @item -mips3
6281 Issue instructions from level 3 of the MIPS ISA (64 bit instructions).
6282 @samp{r4000} is the default @var{cpu type} at this ISA level.
6284 @item -mips4
6285 Issue instructions from level 4 of the MIPS ISA (conditional move,
6286 prefetch, enhanced FPU instructions).  @samp{r8000} is the default
6287 @var{cpu type} at this ISA level.
6289 @item -mfp32
6290 Assume that 32 32-bit floating point registers are available.  This is
6291 the default.
6293 @item -mfp64
6294 Assume that 32 64-bit floating point registers are available.  This is
6295 the default when the @samp{-mips3} option is used.
6297 @item -mgp32
6298 Assume that 32 32-bit general purpose registers are available.  This is
6299 the default.
6301 @item -mgp64
6302 Assume that 32 64-bit general purpose registers are available.  This is
6303 the default when the @samp{-mips3} option is used.
6305 @item -mint64
6306 Force int and long types to be 64 bits wide.  See @samp{-mlong32} for an
6307 explanation of the default, and the width of pointers.
6309 @item -mlong64
6310 Force long types to be 64 bits wide.  See @samp{-mlong32} for an
6311 explanation of the default, and the width of pointers.
6313 @item -mlong32
6314 Force long, int, and pointer types to be 32 bits wide.
6316 If none of @samp{-mlong32}, @samp{-mlong64}, or @samp{-mint64} are set,
6317 the size of ints, longs, and pointers depends on the ABI and ISA chosen.
6318 For @samp{-mabi=32}, and @samp{-mabi=n32}, ints and longs are 32 bits
6319 wide.  For @samp{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
6320 For @samp{-mabi=eabi} and either @samp{-mips1} or @samp{-mips2}, ints
6321 and longs are 32 bits wide.  For @samp{-mabi=eabi} and higher ISAs, ints
6322 are 32 bits, and longs are 64 bits wide.  The width of pointer types is
6323 the smaller of the width of longs or the width of general purpose
6324 registers (which in turn depends on the ISA).
6326 @item -mabi=32
6327 @itemx -mabi=o64
6328 @itemx -mabi=n32
6329 @itemx -mabi=64
6330 @itemx -mabi=eabi
6331 Generate code for the indicated ABI.  The default instruction level is
6332 @samp{-mips1} for @samp{32}, @samp{-mips3} for @samp{n32}, and
6333 @samp{-mips4} otherwise.  Conversely, with @samp{-mips1} or
6334 @samp{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
6335 is @samp{64}.
6337 @item -mmips-as
6338 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
6339 add normal debug information.  This is the default for all
6340 platforms except for the OSF/1 reference platform, using the OSF/rose
6341 object format.  If the either of the @samp{-gstabs} or @samp{-gstabs+}
6342 switches are used, the @file{mips-tfile} program will encapsulate the
6343 stabs within MIPS ECOFF.
6345 @item -mgas
6346 Generate code for the GNU assembler.  This is the default on the OSF/1
6347 reference platform, using the OSF/rose object format.  Also, this is
6348 the default if the configure option @samp{--with-gnu-as} is used.
6350 @item -msplit-addresses
6351 @itemx -mno-split-addresses
6352 Generate code to load the high and low parts of address constants separately.
6353 This allows @code{gcc} to optimize away redundant loads of the high order
6354 bits of addresses.  This optimization requires GNU as and GNU ld.
6355 This optimization is enabled by default for some embedded targets where
6356 GNU as and GNU ld are standard.
6358 @item -mrnames
6359 @itemx -mno-rnames
6360 The @samp{-mrnames} switch says to output code using the MIPS software
6361 names for the registers, instead of the hardware names (ie, @var{a0}
6362 instead of @var{$4}).  The only known assembler that supports this option
6363 is the Algorithmics assembler.
6365 @item -mgpopt
6366 @itemx -mno-gpopt
6367 The @samp{-mgpopt} switch says to write all of the data declarations
6368 before the instructions in the text section, this allows the MIPS
6369 assembler to generate one word memory references instead of using two
6370 words for short global or static data items.  This is on by default if
6371 optimization is selected.
6373 @item -mstats
6374 @itemx -mno-stats
6375 For each non-inline function processed, the @samp{-mstats} switch
6376 causes the compiler to emit one line to the standard error file to
6377 print statistics about the program (number of registers saved, stack
6378 size, etc.).
6380 @item -mmemcpy
6381 @itemx -mno-memcpy
6382 The @samp{-mmemcpy} switch makes all block moves call the appropriate
6383 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
6384 generating inline code.
6386 @item -mmips-tfile
6387 @itemx -mno-mips-tfile
6388 The @samp{-mno-mips-tfile} switch causes the compiler not
6389 postprocess the object file with the @file{mips-tfile} program,
6390 after the MIPS assembler has generated it to add debug support.  If
6391 @file{mips-tfile} is not run, then no local variables will be
6392 available to the debugger.  In addition, @file{stage2} and
6393 @file{stage3} objects will have the temporary file names passed to the
6394 assembler embedded in the object file, which means the objects will
6395 not compare the same.  The @samp{-mno-mips-tfile} switch should only
6396 be used when there are bugs in the @file{mips-tfile} program that
6397 prevents compilation.
6399 @item -msoft-float
6400 Generate output containing library calls for floating point.
6401 @strong{Warning:} the requisite libraries are not part of GCC.
6402 Normally the facilities of the machine's usual C compiler are used, but
6403 this can't be done directly in cross-compilation.  You must make your
6404 own arrangements to provide suitable library functions for
6405 cross-compilation.
6407 @item -mhard-float
6408 Generate output containing floating point instructions.  This is the
6409 default if you use the unmodified sources.
6411 @item -mabicalls
6412 @itemx -mno-abicalls
6413 Emit (or do not emit) the pseudo operations @samp{.abicalls},
6414 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
6415 position independent code.
6417 @item -mlong-calls
6418 @itemx -mno-long-calls
6419 Do all calls with the @samp{JALR} instruction, which requires
6420 loading up a function's address into a register before the call.
6421 You need to use this switch, if you call outside of the current
6422 512 megabyte segment to functions that are not through pointers.
6424 @item -mhalf-pic
6425 @itemx -mno-half-pic
6426 Put pointers to extern references into the data section and load them
6427 up, rather than put the references in the text section.
6429 @item -membedded-pic
6430 @itemx -mno-embedded-pic
6431 Generate PIC code suitable for some embedded systems.  All calls are
6432 made using PC relative address, and all data is addressed using the $gp
6433 register.  No more than 65536 bytes of global data may be used.  This
6434 requires GNU as and GNU ld which do most of the work.  This currently
6435 only works on targets which use ECOFF; it does not work with ELF.
6437 @item -membedded-data
6438 @itemx -mno-embedded-data
6439 Allocate variables to the read-only data section first if possible, then
6440 next in the small data section if possible, otherwise in data.  This gives
6441 slightly slower code than the default, but reduces the amount of RAM required
6442 when executing, and thus may be preferred for some embedded systems.
6444 @item -muninit-const-in-rodata
6445 @itemx -mno-uninit-const-in-rodata
6446 When used together with -membedded-data, it will always store uninitialized
6447 const variables in the read-only data section.
6448   
6449 @item -msingle-float
6450 @itemx -mdouble-float
6451 The @samp{-msingle-float} switch tells gcc to assume that the floating
6452 point coprocessor only supports single precision operations, as on the
6453 @samp{r4650} chip.  The @samp{-mdouble-float} switch permits gcc to use
6454 double precision operations.  This is the default.
6456 @item -mmad
6457 @itemx -mno-mad
6458 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
6459 as on the @samp{r4650} chip.
6461 @item -m4650
6462 Turns on @samp{-msingle-float}, @samp{-mmad}, and, at least for now,
6463 @samp{-mcpu=r4650}.
6465 @item -mips16
6466 @itemx -mno-mips16
6467 Enable 16-bit instructions.
6469 @item -mentry
6470 Use the entry and exit pseudo ops.  This option can only be used with
6471 @samp{-mips16}.
6473 @item -EL
6474 Compile code for the processor in little endian mode.
6475 The requisite libraries are assumed to exist.
6477 @item -EB
6478 Compile code for the processor in big endian mode.
6479 The requisite libraries are assumed to exist.
6481 @item -G @var{num}
6482 @cindex smaller data references (MIPS)
6483 @cindex gp-relative references (MIPS)
6484 Put global and static items less than or equal to @var{num} bytes into
6485 the small data or bss sections instead of the normal data or bss
6486 section.  This allows the assembler to emit one word memory reference
6487 instructions based on the global pointer (@var{gp} or @var{$28}),
6488 instead of the normal two words used.  By default, @var{num} is 8 when
6489 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
6490 @samp{-G @var{num}} switch is also passed to the assembler and linker.
6491 All modules should be compiled with the same @samp{-G @var{num}}
6492 value.
6494 @item -nocpp
6495 Tell the MIPS assembler to not run its preprocessor over user
6496 assembler files (with a @samp{.s} suffix) when assembling them.
6498 @item -mfix7000
6499 Pass an option to gas which will cause nops to be inserted if
6500 the read of the destination register of an mfhi or mflo instruction
6501 occurs in the following two instructions.
6503 @item -no-crt0
6504 Do not include the default crt0.
6505 @end table
6507 @ifset INTERNALS
6508 These options are defined by the macro
6509 @code{TARGET_SWITCHES} in the machine description.  The default for the
6510 options is also defined by that macro, which enables you to change the
6511 defaults.
6512 @end ifset
6514 @node i386 Options
6515 @subsection Intel 386 Options
6516 @cindex i386 Options
6517 @cindex Intel 386 Options
6519 These @samp{-m} options are defined for the i386 family of computers:
6521 @table @gcctabopt
6522 @item -mcpu=@var{cpu type}
6523 Assume the defaults for the machine type @var{cpu type} when scheduling
6524 instructions.  The choices for @var{cpu type} are @samp{i386},
6525 @samp{i486}, @samp{i586}, @samp{i686}, @samp{pentium},
6526 @samp{pentiumpro}, @samp{k6}, and @samp{athlon}
6528 While picking a specific @var{cpu type} will schedule things appropriately
6529 for that particular chip, the compiler will not generate any code that
6530 does not run on the i386 without the @samp{-march=@var{cpu type}} option
6531 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
6532 is equivalent to @samp{pentiumpro}.  @samp{k6} is the AMD chip as
6533 opposed to the Intel ones.
6535 @item -march=@var{cpu type}
6536 Generate instructions for the machine type @var{cpu type}.  The choices
6537 for @var{cpu type} are the same as for @samp{-mcpu}.  Moreover, 
6538 specifying @samp{-march=@var{cpu type}} implies @samp{-mcpu=@var{cpu type}}.
6540 @item -m386
6541 @itemx -m486
6542 @itemx -mpentium
6543 @itemx -mpentiumpro
6544 Synonyms for -mcpu=i386, -mcpu=i486, -mcpu=pentium, and -mcpu=pentiumpro
6545 respectively.  These synonyms are deprecated.
6547 @item -mintel-syntax
6548 Emit assembly using Intel syntax opcodes instead of AT&T syntax.
6550 @item -mieee-fp
6551 @itemx -mno-ieee-fp
6552 Control whether or not the compiler uses IEEE floating point
6553 comparisons.  These handle correctly the case where the result of a
6554 comparison is unordered.
6556 @item -msoft-float
6557 Generate output containing library calls for floating point.
6558 @strong{Warning:} the requisite libraries are not part of GCC.
6559 Normally the facilities of the machine's usual C compiler are used, but
6560 this can't be done directly in cross-compilation.  You must make your
6561 own arrangements to provide suitable library functions for
6562 cross-compilation.
6564 On machines where a function returns floating point results in the 80387
6565 register stack, some floating point opcodes may be emitted even if
6566 @samp{-msoft-float} is used.
6568 @item -mno-fp-ret-in-387
6569 Do not use the FPU registers for return values of functions.
6571 The usual calling convention has functions return values of types
6572 @code{float} and @code{double} in an FPU register, even if there
6573 is no FPU.  The idea is that the operating system should emulate
6574 an FPU.
6576 The option @samp{-mno-fp-ret-in-387} causes such values to be returned
6577 in ordinary CPU registers instead.
6579 @item -mno-fancy-math-387
6580 Some 387 emulators do not support the @code{sin}, @code{cos} and
6581 @code{sqrt} instructions for the 387.  Specify this option to avoid
6582 generating those instructions. This option is the default on FreeBSD.
6583 As of revision 2.6.1, these instructions are not generated unless you
6584 also use the @samp{-ffast-math} switch.
6586 @item -malign-double
6587 @itemx -mno-align-double
6588 Control whether GCC aligns @code{double}, @code{long double}, and
6589 @code{long long} variables on a two word boundary or a one word
6590 boundary.  Aligning @code{double} variables on a two word boundary will
6591 produce code that runs somewhat faster on a @samp{Pentium} at the
6592 expense of more memory.
6594 @item -m128bit-long-double
6595 @itemx -m128bit-long-double
6596 Control the size of @code{long double} type. i386 application binary interface
6597 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
6598 preffer @code{long double} aligned to 8 or 16 byte boundary.  This is
6599 impossible to reach with 12 byte long doubles in the array accesses.
6601 @strong{Warning:} if you use the @samp{-m128bit-long-double} switch, the
6602 structures and arrays containing @code{long double} will change their size as
6603 well as function calling convention for function taking @code{long double}
6604 will be modified. 
6606 @item -m96bit-long-double
6607 @itemx -m96bit-long-double
6608 Set the size of @code{long double} to 96 bits as required by the i386
6609 application binary interface.  This is the default.
6611 @item -msvr3-shlib
6612 @itemx -mno-svr3-shlib
6613 Control whether GCC places uninitialized locals into @code{bss} or
6614 @code{data}.  @samp{-msvr3-shlib} places these locals into @code{bss}.
6615 These options are meaningful only on System V Release 3.
6617 @item -mno-wide-multiply
6618 @itemx -mwide-multiply
6619 Control whether GCC uses the @code{mul} and @code{imul} that produce
6620 64 bit results in @code{eax:edx} from 32 bit operands to do @code{long
6621 long} multiplies and 32-bit division by constants.
6623 @item -mrtd
6624 Use a different function-calling convention, in which functions that
6625 take a fixed number of arguments return with the @code{ret} @var{num}
6626 instruction, which pops their arguments while returning.  This saves one
6627 instruction in the caller since there is no need to pop the arguments
6628 there.
6630 You can specify that an individual function is called with this calling
6631 sequence with the function attribute @samp{stdcall}.  You can also
6632 override the @samp{-mrtd} option by using the function attribute
6633 @samp{cdecl}.  @xref{Function Attributes}.
6635 @strong{Warning:} this calling convention is incompatible with the one
6636 normally used on Unix, so you cannot use it if you need to call
6637 libraries compiled with the Unix compiler.
6639 Also, you must provide function prototypes for all functions that
6640 take variable numbers of arguments (including @code{printf});
6641 otherwise incorrect code will be generated for calls to those
6642 functions.
6644 In addition, seriously incorrect code will result if you call a
6645 function with too many arguments.  (Normally, extra arguments are
6646 harmlessly ignored.)
6648 @item -mregparm=@var{num}
6649 Control how many registers are used to pass integer arguments.  By
6650 default, no registers are used to pass arguments, and at most 3
6651 registers can be used.  You can control this behavior for a specific
6652 function by using the function attribute @samp{regparm}.
6653 @xref{Function Attributes}.
6655 @strong{Warning:} if you use this switch, and
6656 @var{num} is nonzero, then you must build all modules with the same
6657 value, including any libraries.  This includes the system libraries and
6658 startup modules.
6660 @item -malign-loops=@var{num}
6661 Align loops to a 2 raised to a @var{num} byte boundary.  If
6662 @samp{-malign-loops} is not specified, the default is 2 unless
6663 gas 2.8 (or later) is being used in which case the default is
6664 to align the loop on a 16 byte boundary if it is less than 8
6665 bytes away.
6667 @item -malign-jumps=@var{num}
6668 Align instructions that are only jumped to to a 2 raised to a @var{num}
6669 byte boundary.  If @samp{-malign-jumps} is not specified, the default is
6670 2 if optimizing for a 386, and 4 if optimizing for a 486 unless
6671 gas 2.8 (or later) is being used in which case the default is
6672 to align the instruction on a 16 byte boundary if it is less
6673 than 8 bytes away.
6675 @item -malign-functions=@var{num}
6676 Align the start of functions to a 2 raised to @var{num} byte boundary.
6677 If @samp{-malign-functions} is not specified, the default is 2 if optimizing
6678 for a 386, and 4 if optimizing for a 486.
6680 @item -mpreferred-stack-boundary=@var{num}
6681 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
6682 byte boundary.  If @samp{-mpreferred-stack-boundary} is not specified,
6683 the default is 4 (16 bytes or 128 bits).
6685 The stack is required to be aligned on a 4 byte boundary.  On Pentium
6686 and PentiumPro, @code{double} and @code{long double} values should be
6687 aligned to an 8 byte boundary (see @samp{-malign-double}) or suffer
6688 significant run time performance penalties.  On Pentium III, the
6689 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
6690 penalties if it is not 16 byte aligned.
6692 To ensure proper alignment of this values on the stack, the stack boundary
6693 must be as aligned as that required by any value stored on the stack. 
6694 Further, every function must be generated such that it keeps the stack
6695 aligned.  Thus calling a function compiled with a higher preferred
6696 stack boundary from a function compiled with a lower preferred stack
6697 boundary will most likely misalign the stack.  It is recommended that
6698 libraries that use callbacks always use the default setting.
6700 This extra alignment does consume extra stack space.  Code that is sensitive
6701 to stack space usage, such as embedded systems and operating system kernels,
6702 may want to reduce the preferred alignment to
6703 @samp{-mpreferred-stack-boundary=2}.
6705 @item -mpush-args
6706 @kindex -mpush-args
6707 Use PUSH operations to store outgoing parameters. This method is shorter
6708 and usually equally fast as method using SUB/MOV operations and is enabled
6709 by default. In some cases disabling it may improve performance because of
6710 improved scheduling and reduced dependencies.
6712 @item -maccumulate-outgoing-args
6713 @kindex -maccumulate-outgoing-args
6714 If enabled, the maximum amount of space required for outgoing arguments will be
6715 computed in the function prologue. This in faster on most modern CPUs
6716 because of reduced dependencies, improved scheduling and reduced stack usage
6717 when preferred stack boundary is not equal to 2.  The drawback is a notable
6718 increase in code size. This switch implies -mno-push-args.
6720 @item -mthreads
6721 @kindex -mthreads
6722 Support thread-safe exception handling on @samp{Mingw32}. Code that relies 
6723 on thread-safe exception handling must compile and link all code with the 
6724 @samp{-mthreads} option. When compiling, @samp{-mthreads} defines 
6725 @samp{-D_MT}; when linking, it links in a special thread helper library 
6726 @samp{-lmingwthrd} which cleans up per thread exception handling data.
6728 @item -mno-align-stringops
6729 @kindex -mno-align-stringops
6730 Do not align destination of inlined string operations. This switch reduces
6731 code size and improves performance in case the destination is already aligned,
6732 but gcc don't know about it.
6734 @item -minline-all-stringops
6735 @kindex -minline-all-stringops
6736 By default GCC inlines string operations only when destination is known to be
6737 aligned at least to 4 byte boundary. This enables more inlining, increase code
6738 size, but may improve performance of code that depends on fast memcpy, strlen
6739 and memset for short lengths.
6740 @end table
6742 @node HPPA Options
6743 @subsection HPPA Options
6744 @cindex HPPA Options
6746 These @samp{-m} options are defined for the HPPA family of computers:
6748 @table @gcctabopt
6749 @item -march=@var{architecture type}
6750 Generate code for the specified architecture.  The choices for
6751 @var{architecture type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
6752 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
6753 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
6754 architecture option for your machine.  Code compiled for lower numbered
6755 architectures will run on higher numbered architectures, but not the
6756 other way around.
6758 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
6759 next release of binutils (current is 2.9.1) will probably contain PA 2.0
6760 support.  
6762 @item -mpa-risc-1-0
6763 @itemx -mpa-risc-1-1
6764 @itemx -mpa-risc-2-0
6765 Synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively.
6767 @item -mbig-switch
6768 Generate code suitable for big switch tables.  Use this option only if
6769 the assembler/linker complain about out of range branches within a switch
6770 table.
6772 @item -mjump-in-delay
6773 Fill delay slots of function calls with unconditional jump instructions
6774 by modifying the return pointer for the function call to be the target
6775 of the conditional jump.
6777 @item -mdisable-fpregs
6778 Prevent floating point registers from being used in any manner.  This is
6779 necessary for compiling kernels which perform lazy context switching of
6780 floating point registers.  If you use this option and attempt to perform
6781 floating point operations, the compiler will abort.
6783 @item -mdisable-indexing
6784 Prevent the compiler from using indexing address modes.  This avoids some
6785 rather obscure problems when compiling MIG generated code under MACH.
6787 @item -mno-space-regs
6788 Generate code that assumes the target has no space registers.  This allows
6789 GCC to generate faster indirect calls and use unscaled index address modes.
6791 Such code is suitable for level 0 PA systems and kernels.
6793 @item -mfast-indirect-calls
6794 Generate code that assumes calls never cross space boundaries.  This
6795 allows GCC to emit code which performs faster indirect calls.
6797 This option will not work in the presence of shared libraries or nested
6798 functions.
6800 @item -mlong-load-store
6801 Generate 3-instruction load and store sequences as sometimes required by
6802 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
6803 the HP compilers.
6805 @item -mportable-runtime
6806 Use the portable calling conventions proposed by HP for ELF systems.
6808 @item -mgas
6809 Enable the use of assembler directives only GAS understands.
6811 @item -mschedule=@var{cpu type}
6812 Schedule code according to the constraints for the machine type
6813 @var{cpu type}.  The choices for @var{cpu type} are @samp{700} 
6814 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}.  Refer to 
6815 @file{/usr/lib/sched.models} on an HP-UX system to determine the
6816 proper scheduling option for your machine.
6818 @item -mlinker-opt
6819 Enable the optimization pass in the HPUX linker.  Note this makes symbolic
6820 debugging impossible.  It also triggers a bug in the HPUX 8 and HPUX 9 linkers
6821 in which they give bogus error messages when linking some programs.
6823 @item -msoft-float
6824 Generate output containing library calls for floating point.
6825 @strong{Warning:} the requisite libraries are not available for all HPPA
6826 targets.  Normally the facilities of the machine's usual C compiler are
6827 used, but this cannot be done directly in cross-compilation.  You must make
6828 your own arrangements to provide suitable library functions for
6829 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
6830 does provide software floating point support.
6832 @samp{-msoft-float} changes the calling convention in the output file;
6833 therefore, it is only useful if you compile @emph{all} of a program with
6834 this option.  In particular, you need to compile @file{libgcc.a}, the
6835 library that comes with GCC, with @samp{-msoft-float} in order for
6836 this to work.
6837 @end table
6839 @node Intel 960 Options
6840 @subsection Intel 960 Options
6842 These @samp{-m} options are defined for the Intel 960 implementations:
6844 @table @gcctabopt
6845 @item -m@var{cpu type}
6846 Assume the defaults for the machine type @var{cpu type} for some of
6847 the other options, including instruction scheduling, floating point
6848 support, and addressing modes.  The choices for @var{cpu type} are
6849 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
6850 @samp{sa}, and @samp{sb}.
6851 The default is
6852 @samp{kb}.
6854 @item -mnumerics
6855 @itemx -msoft-float
6856 The @samp{-mnumerics} option indicates that the processor does support
6857 floating-point instructions.  The @samp{-msoft-float} option indicates
6858 that floating-point support should not be assumed.
6860 @item -mleaf-procedures
6861 @itemx -mno-leaf-procedures
6862 Do (or do not) attempt to alter leaf procedures to be callable with the
6863 @code{bal} instruction as well as @code{call}.  This will result in more
6864 efficient code for explicit calls when the @code{bal} instruction can be
6865 substituted by the assembler or linker, but less efficient code in other
6866 cases, such as calls via function pointers, or using a linker that doesn't
6867 support this optimization.
6869 @item -mtail-call
6870 @itemx -mno-tail-call
6871 Do (or do not) make additional attempts (beyond those of the
6872 machine-independent portions of the compiler) to optimize tail-recursive
6873 calls into branches.  You may not want to do this because the detection of
6874 cases where this is not valid is not totally complete.  The default is
6875 @samp{-mno-tail-call}.
6877 @item -mcomplex-addr
6878 @itemx -mno-complex-addr
6879 Assume (or do not assume) that the use of a complex addressing mode is a
6880 win on this implementation of the i960.  Complex addressing modes may not
6881 be worthwhile on the K-series, but they definitely are on the C-series.
6882 The default is currently @samp{-mcomplex-addr} for all processors except
6883 the CB and CC.
6885 @item -mcode-align
6886 @itemx -mno-code-align
6887 Align code to 8-byte boundaries for faster fetching (or don't bother).
6888 Currently turned on by default for C-series implementations only.
6890 @ignore
6891 @item -mclean-linkage
6892 @itemx -mno-clean-linkage
6893 These options are not fully implemented.
6894 @end ignore
6896 @item -mic-compat
6897 @itemx -mic2.0-compat
6898 @itemx -mic3.0-compat
6899 Enable compatibility with iC960 v2.0 or v3.0.
6901 @item -masm-compat
6902 @itemx -mintel-asm
6903 Enable compatibility with the iC960 assembler.
6905 @item -mstrict-align
6906 @itemx -mno-strict-align
6907 Do not permit (do permit) unaligned accesses.
6909 @item -mold-align
6910 Enable structure-alignment compatibility with Intel's gcc release version
6911 1.3 (based on gcc 1.37).  This option implies @samp{-mstrict-align}.
6913 @item -mlong-double-64
6914 Implement type @samp{long double} as 64-bit floating point numbers.
6915 Without the option @samp{long double} is implemented by 80-bit
6916 floating point numbers.  The only reason we have it because there is
6917 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
6918 is only useful for people using soft-float targets.  Otherwise, we
6919 should recommend against use of it.
6921 @end table
6923 @node DEC Alpha Options
6924 @subsection DEC Alpha Options
6926 These @samp{-m} options are defined for the DEC Alpha implementations:
6928 @table @gcctabopt
6929 @item -mno-soft-float
6930 @itemx -msoft-float
6931 Use (do not use) the hardware floating-point instructions for
6932 floating-point operations.  When @option{-msoft-float} is specified,
6933 functions in @file{libgcc1.c} will be used to perform floating-point
6934 operations.  Unless they are replaced by routines that emulate the
6935 floating-point operations, or compiled in such a way as to call such
6936 emulations routines, these routines will issue floating-point
6937 operations.   If you are compiling for an Alpha without floating-point
6938 operations, you must ensure that the library is built so as not to call
6939 them.
6941 Note that Alpha implementations without floating-point operations are
6942 required to have floating-point registers.
6944 @item -mfp-reg
6945 @itemx -mno-fp-regs
6946 Generate code that uses (does not use) the floating-point register set.
6947 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
6948 register set is not used, floating point operands are passed in integer
6949 registers as if they were integers and floating-point results are passed
6950 in $0 instead of $f0.  This is a non-standard calling sequence, so any
6951 function with a floating-point argument or return value called by code
6952 compiled with @option{-mno-fp-regs} must also be compiled with that
6953 option.
6955 A typical use of this option is building a kernel that does not use,
6956 and hence need not save and restore, any floating-point registers.
6958 @item -mieee
6959 The Alpha architecture implements floating-point hardware optimized for
6960 maximum performance.  It is mostly compliant with the IEEE floating
6961 point standard.  However, for full compliance, software assistance is
6962 required.  This option generates code fully IEEE compliant code
6963 @emph{except} that the @var{inexact flag} is not maintained (see below).
6964 If this option is turned on, the CPP macro @code{_IEEE_FP} is defined
6965 during compilation.  The option is a shorthand for: @samp{-D_IEEE_FP
6966 -mfp-trap-mode=su -mtrap-precision=i -mieee-conformant}.  The resulting
6967 code is less efficient but is able to correctly support denormalized
6968 numbers and exceptional IEEE values such as not-a-number and plus/minus
6969 infinity.  Other Alpha compilers call this option
6970 @option{-ieee_with_no_inexact}.
6972 @item -mieee-with-inexact
6973 @c overfull hbox here --bob 22 jul96
6974 @c original text between ignore ... end ignore
6975 @ignore
6976 This is like @samp{-mieee} except the generated code also maintains the
6977 IEEE @var{inexact flag}.  Turning on this option causes the generated
6978 code to implement fully-compliant IEEE math.  The option is a shorthand
6979 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus @samp{-mieee-conformant},
6980 @samp{-mfp-trap-mode=sui}, and @samp{-mtrap-precision=i}.  On some Alpha
6981 implementations the resulting code may execute significantly slower than
6982 the code generated by default.  Since there is very little code that
6983 depends on the @var{inexact flag}, you should normally not specify this
6984 option.  Other Alpha compilers call this option
6985 @samp{-ieee_with_inexact}.
6986 @end ignore
6987 @c            changed paragraph
6988 This is like @samp{-mieee} except the generated code also maintains the
6989 IEEE @var{inexact flag}.  Turning on this option causes the generated
6990 code to implement fully-compliant IEEE math.  The option is a shorthand
6991 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus the three following:
6992 @samp{-mieee-conformant},
6993 @samp{-mfp-trap-mode=sui}, 
6994 and @samp{-mtrap-precision=i}.  
6995 On some Alpha implementations the resulting code may execute
6996 significantly slower than the code generated by default.  Since there
6997 is very little code that depends on the @var{inexact flag}, you should
6998 normally not specify this option.  Other Alpha compilers call this
6999 option @samp{-ieee_with_inexact}.
7000 @c             end changes to prevent overfull hboxes
7002 @item -mfp-trap-mode=@var{trap mode}
7003 This option controls what floating-point related traps are enabled.
7004 Other Alpha compilers call this option @samp{-fptm }@var{trap mode}.
7005 The trap mode can be set to one of four values:
7007 @table @samp
7008 @item n
7009 This is the default (normal) setting.  The only traps that are enabled
7010 are the ones that cannot be disabled in software (e.g., division by zero
7011 trap).
7013 @item u
7014 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7015 as well.
7017 @item su
7018 Like @samp{su}, but the instructions are marked to be safe for software
7019 completion (see Alpha architecture manual for details).
7021 @item sui
7022 Like @samp{su}, but inexact traps are enabled as well.
7023 @end table
7025 @item -mfp-rounding-mode=@var{rounding mode}
7026 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7027 @samp{-fprm }@var{rounding mode}.  The @var{rounding mode} can be one
7030 @table @samp
7031 @item n
7032 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7033 the nearest machine number or towards the even machine number in case
7034 of a tie.
7036 @item m
7037 Round towards minus infinity.
7039 @item c
7040 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7042 @item d
7043 Dynamic rounding mode.  A field in the floating point control register
7044 (@var{fpcr}, see Alpha architecture reference manual) controls the
7045 rounding mode in effect.  The C library initializes this register for
7046 rounding towards plus infinity.  Thus, unless your program modifies the
7047 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7048 @end table
7050 @item -mtrap-precision=@var{trap precision}
7051 In the Alpha architecture, floating point traps are imprecise.  This
7052 means without software assistance it is impossible to recover from a
7053 floating trap and program execution normally needs to be terminated.
7054 GCC can generate code that can assist operating system trap handlers
7055 in determining the exact location that caused a floating point trap.
7056 Depending on the requirements of an application, different levels of
7057 precisions can be selected:
7059 @table @samp
7060 @item p
7061 Program precision.  This option is the default and means a trap handler
7062 can only identify which program caused a floating point exception.
7064 @item f
7065 Function precision.  The trap handler can determine the function that
7066 caused a floating point exception.
7068 @item i
7069 Instruction precision.  The trap handler can determine the exact
7070 instruction that caused a floating point exception.
7071 @end table
7073 Other Alpha compilers provide the equivalent options called
7074 @samp{-scope_safe} and @samp{-resumption_safe}.
7076 @item -mieee-conformant
7077 This option marks the generated code as IEEE conformant.  You must not
7078 use this option unless you also specify @samp{-mtrap-precision=i} and either
7079 @samp{-mfp-trap-mode=su} or @samp{-mfp-trap-mode=sui}.  Its only effect
7080 is to emit the line @samp{.eflag 48} in the function prologue of the
7081 generated assembly file.  Under DEC Unix, this has the effect that
7082 IEEE-conformant math library routines will be linked in.
7084 @item -mbuild-constants
7085 Normally GCC examines a 32- or 64-bit integer constant to
7086 see if it can construct it from smaller constants in two or three
7087 instructions.  If it cannot, it will output the constant as a literal and
7088 generate code to load it from the data segment at runtime.
7090 Use this option to require GCC to construct @emph{all} integer constants
7091 using code, even if it takes more instructions (the maximum is six).
7093 You would typically use this option to build a shared library dynamic
7094 loader.  Itself a shared library, it must relocate itself in memory
7095 before it can find the variables and constants in its own data segment.
7097 @item -malpha-as
7098 @itemx -mgas
7099 Select whether to generate code to be assembled by the vendor-supplied
7100 assembler (@samp{-malpha-as}) or by the GNU assembler @samp{-mgas}.
7102 @item -mbwx
7103 @itemx -mno-bwx
7104 @itemx -mcix
7105 @itemx -mno-cix
7106 @itemx -mmax
7107 @itemx -mno-max
7108 Indicate whether GCC should generate code to use the optional BWX,
7109 CIX, and MAX instruction sets.  The default is to use the instruction sets
7110 supported by the CPU type specified via @samp{-mcpu=} option or that
7111 of the CPU on which GCC was built if none was specified.
7113 @item -mcpu=@var{cpu_type}
7114 Set the instruction set, register set, and instruction scheduling
7115 parameters for machine type @var{cpu_type}.  You can specify either the
7116 @samp{EV} style name or the corresponding chip number.  GCC
7117 supports scheduling parameters for the EV4 and EV5 family of processors
7118 and will choose the default values for the instruction set from
7119 the processor you specify.  If you do not specify a processor type,
7120 GCC will default to the processor on which the compiler was built.
7122 Supported values for @var{cpu_type} are
7124 @table @samp
7125 @item ev4
7126 @itemx 21064
7127 Schedules as an EV4 and has no instruction set extensions.
7129 @item ev5
7130 @itemx 21164
7131 Schedules as an EV5 and has no instruction set extensions.
7133 @item ev56
7134 @itemx 21164a
7135 Schedules as an EV5 and supports the BWX extension.
7137 @item pca56
7138 @itemx 21164pc
7139 @itemx 21164PC
7140 Schedules as an EV5 and supports the BWX and MAX extensions.
7142 @item ev6
7143 @itemx 21264
7144 Schedules as an EV5 (until Digital releases the scheduling parameters
7145 for the EV6) and supports the BWX, CIX, and MAX extensions.
7146 @end table
7148 @item -mmemory-latency=@var{time}
7149 Sets the latency the scheduler should assume for typical memory
7150 references as seen by the application.  This number is highly
7151 dependent on the memory access patterns used by the application
7152 and the size of the external cache on the machine.
7154 Valid options for @var{time} are
7156 @table @samp
7157 @item @var{number}
7158 A decimal number representing clock cycles.
7160 @item L1
7161 @itemx L2
7162 @itemx L3
7163 @itemx main
7164 The compiler contains estimates of the number of clock cycles for
7165 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7166 (also called Dcache, Scache, and Bcache), as well as to main memory.
7167 Note that L3 is only valid for EV5.
7169 @end table
7170 @end table
7172 @node Clipper Options
7173 @subsection Clipper Options
7175 These @samp{-m} options are defined for the Clipper implementations:
7177 @table @gcctabopt
7178 @item -mc300
7179 Produce code for a C300 Clipper processor. This is the default.
7181 @item -mc400
7182 Produce code for a C400 Clipper processor i.e. use floating point
7183 registers f8..f15.
7184 @end table
7186 @node H8/300 Options
7187 @subsection H8/300 Options
7189 These @samp{-m} options are defined for the H8/300 implementations:
7191 @table @gcctabopt
7192 @item -mrelax
7193 Shorten some address references at link time, when possible; uses the
7194 linker option @samp{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
7195 ld.info, Using ld}, for a fuller description.
7197 @item -mh
7198 Generate code for the H8/300H.
7200 @item -ms
7201 Generate code for the H8/S.
7203 @item -ms2600
7204 Generate code for the H8/S2600.  This switch must be used with -ms.
7206 @item -mint32
7207 Make @code{int} data 32 bits by default.
7209 @item -malign-300
7210 On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
7211 The default for the H8/300H and H8/S is to align longs and floats on 4
7212 byte boundaries.
7213 @samp{-malign-300} causes them to be aligned on 2 byte boundaries.
7214 This option has no effect on the H8/300.
7215 @end table
7217 @node SH Options
7218 @subsection SH Options
7220 These @samp{-m} options are defined for the SH implementations:
7222 @table @gcctabopt
7223 @item -m1
7224 Generate code for the SH1.
7226 @item -m2
7227 Generate code for the SH2.
7229 @item -m3
7230 Generate code for the SH3.
7232 @item -m3e
7233 Generate code for the SH3e.
7235 @item -m4-nofpu
7236 Generate code for the SH4 without a floating-point unit.
7238 @item -m4-single-only
7239 Generate code for the SH4 with a floating-point unit that only
7240 supports single-precision arithmentic.
7242 @item -m4-single
7243 Generate code for the SH4 assuming the floating-point unit is in
7244 single-precision mode by default.
7246 @item -m4
7247 Generate code for the SH4.
7249 @item -mb
7250 Compile code for the processor in big endian mode.
7252 @item -ml
7253 Compile code for the processor in little endian mode.
7255 @item -mdalign
7256 Align doubles at 64 bit boundaries.  Note that this changes the calling
7257 conventions, and thus some functions from the standard C library will
7258 not work unless you recompile it first with -mdalign.
7260 @item -mrelax
7261 Shorten some address references at link time, when possible; uses the
7262 linker option @samp{-relax}.
7264 @item -mbigtable
7265 Use 32-bit offsets in @code{switch} tables.  The default is to use
7266 16-bit offsets.
7268 @item -mfmovd
7269 Enable the use of the instruction @code{fmovd}.
7271 @item -mhitachi
7272 Comply with the calling conventions defined by Hitachi.
7274 @item -mnomacsave
7275 Mark the @code{MAC} register as call-clobbered, even if
7276 @option{-mhitachi} is given.
7278 @item -misize
7279 Dump instruction size and location in the assembly code.
7281 @item -mpadstruct
7282 This option is deprecated.  It pads structures to multiple of 4 bytes,
7283 which is incompatible with the SH ABI.
7285 @item -mspace
7286 Optimize for space instead of speed.  Implied by @option{-Os}.
7288 @item -mprefergot
7289 When generating position-independent code, emit function calls using
7290 the Global Offset Table instead of the Procedure Linkage Table.
7292 @item -musermode
7293 Generate a library function call to invalidate instruction cache
7294 entries, after fixing up a trampoline.  This library function call
7295 doesn't assume it can write to the whole memory address space.  This
7296 is the default when the target is @code{sh-*-linux*}.
7297 @end table
7299 @node System V Options
7300 @subsection Options for System V
7302 These additional options are available on System V Release 4 for
7303 compatibility with other compilers on those systems:
7305 @table @gcctabopt
7306 @item -G
7307 Create a shared object.
7308 It is recommended that @samp{-symbolic} or @samp{-shared} be used instead.
7310 @item -Qy
7311 Identify the versions of each tool used by the compiler, in a
7312 @code{.ident} assembler directive in the output.
7314 @item -Qn
7315 Refrain from adding @code{.ident} directives to the output file (this is
7316 the default).
7318 @item -YP\,@var{dirs}
7319 Search the directories @var{dirs}, and no others, for libraries
7320 specified with @samp{-l}.
7322 @item -Ym\,@var{dir}
7323 Look in the directory @var{dir} to find the M4 preprocessor.
7324 The assembler uses this option.
7325 @c This is supposed to go with a -Yd for predefined M4 macro files, but
7326 @c the generic assembler that comes with Solaris takes just -Ym.
7327 @end table
7329 @node TMS320C3x/C4x Options
7330 @subsection TMS320C3x/C4x Options
7331 @cindex TMS320C3x/C4x Options
7333 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
7335 @table @gcctabopt
7337 @item -mcpu=@var{cpu_type}
7338 Set the instruction set, register set, and instruction scheduling
7339 parameters for machine type @var{cpu_type}.  Supported values for
7340 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
7341 @samp{c44}.  The default is @samp{c40} to generate code for the
7342 TMS320C40.
7344 @item -mbig-memory
7345 @item -mbig
7346 @itemx -msmall-memory
7347 @itemx -msmall
7348 Generates code for the big or small memory model.  The small memory
7349 model assumed that all data fits into one 64K word page.  At run-time
7350 the data page (DP) register must be set to point to the 64K page
7351 containing the .bss and .data program sections.  The big memory model is
7352 the default and requires reloading of the DP register for every direct
7353 memory access.
7355 @item -mbk
7356 @itemx -mno-bk
7357 Allow (disallow) allocation of general integer operands into the block
7358 count register BK. 
7360 @item -mdb
7361 @itemx -mno-db
7362 Enable (disable) generation of code using decrement and branch,
7363 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
7364 on the safe side, this is disabled for the C3x, since the maximum
7365 iteration count on the C3x is 2^23 + 1 (but who iterates loops more than
7366 2^23 times on the C3x?).  Note that GCC will try to reverse a loop so
7367 that it can utilise the decrement and branch instruction, but will give
7368 up if there is more than one memory reference in the loop.  Thus a loop
7369 where the loop counter is decremented can generate slightly more
7370 efficient code, in cases where the RPTB instruction cannot be utilised.
7372 @item -mdp-isr-reload
7373 @itemx -mparanoid
7374 Force the DP register to be saved on entry to an interrupt service
7375 routine (ISR), reloaded to point to the data section, and restored on
7376 exit from the ISR.  This should not be required unless someone has
7377 violated the small memory model by modifying the DP register, say within
7378 an object library.
7380 @item -mmpyi
7381 @itemx -mno-mpyi
7382 For the C3x use the 24-bit MPYI instruction for integer multiplies
7383 instead of a library call to guarantee 32-bit results.  Note that if one
7384 of the operands is a constant, then the multiplication will be performed
7385 using shifts and adds.  If the -mmpyi option is not specified for the C3x,
7386 then squaring operations are performed inline instead of a library call.
7388 @item -mfast-fix
7389 @itemx -mno-fast-fix
7390 The C3x/C4x FIX instruction to convert a floating point value to an
7391 integer value chooses the nearest integer less than or equal to the
7392 floating point value rather than to the nearest integer.  Thus if the
7393 floating point number is negative, the result will be incorrectly
7394 truncated an additional code is necessary to detect and correct this
7395 case.  This option can be used to disable generation of the additional
7396 code required to correct the result.
7398 @item -mrptb
7399 @itemx -mno-rptb
7400 Enable (disable) generation of repeat block sequences using the RPTB
7401 instruction for zero overhead looping.  The RPTB construct is only used
7402 for innermost loops that do not call functions or jump across the loop
7403 boundaries.  There is no advantage having nested RPTB loops due to the
7404 overhead required to save and restore the RC, RS, and RE registers.
7405 This is enabled by default with -O2.
7407 @item -mrpts=@var{count}
7408 @itemx -mno-rpts
7409 Enable (disable) the use of the single instruction repeat instruction
7410 RPTS.  If a repeat block contains a single instruction, and the loop
7411 count can be guaranteed to be less than the value @var{count}, GCC will
7412 emit a RPTS instruction instead of a RPTB.  If no value is specified,
7413 then a RPTS will be emitted even if the loop count cannot be determined
7414 at compile time.  Note that the repeated instruction following RPTS does
7415 not have to be reloaded from memory each iteration, thus freeing up the
7416 CPU buses for operands.  However, since interrupts are blocked by this
7417 instruction, it is disabled by default.
7419 @item -mloop-unsigned
7420 @itemx -mno-loop-unsigned
7421 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
7422 is 2^31 + 1 since these instructions test if the iteration count is
7423 negative to terminate the loop.  If the iteration count is unsigned
7424 there is a possibility than the 2^31 + 1 maximum iteration count may be
7425 exceeded.  This switch allows an unsigned iteration count.
7427 @item -mti
7428 Try to emit an assembler syntax that the TI assembler (asm30) is happy
7429 with.  This also enforces compatibility with the API employed by the TI
7430 C3x C compiler.  For example, long doubles are passed as structures
7431 rather than in floating point registers.
7433 @item -mregparm
7434 @itemx -mmemparm
7435 Generate code that uses registers (stack) for passing arguments to functions.
7436 By default, arguments are passed in registers where possible rather
7437 than by pushing arguments on to the stack.
7439 @item -mparallel-insns
7440 @itemx -mno-parallel-insns
7441 Allow the generation of parallel instructions.  This is enabled by
7442 default with -O2.
7444 @item -mparallel-mpy
7445 @itemx -mno-parallel-mpy
7446 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
7447 provided -mparallel-insns is also specified.  These instructions have
7448 tight register constraints which can pessimize the code generation
7449 of large functions.
7451 @end table
7453 @node V850 Options
7454 @subsection V850 Options
7455 @cindex V850 Options
7457 These @samp{-m} options are defined for V850 implementations:
7459 @table @gcctabopt
7460 @item -mlong-calls
7461 @itemx -mno-long-calls
7462 Treat all calls as being far away (near).  If calls are assumed to be
7463 far away, the compiler will always load the functions address up into a
7464 register, and call indirect through the pointer.
7466 @item -mno-ep
7467 @itemx -mep
7468 Do not optimize (do optimize) basic blocks that use the same index
7469 pointer 4 or more times to copy pointer into the @code{ep} register, and
7470 use the shorter @code{sld} and @code{sst} instructions.  The @samp{-mep}
7471 option is on by default if you optimize.
7473 @item -mno-prolog-function
7474 @itemx -mprolog-function
7475 Do not use (do use) external functions to save and restore registers at
7476 the prolog and epilog of a function.  The external functions are slower,
7477 but use less code space if more than one function saves the same number
7478 of registers.  The @samp{-mprolog-function} option is on by default if
7479 you optimize.
7481 @item -mspace
7482 Try to make the code as small as possible.  At present, this just turns
7483 on the @samp{-mep} and @samp{-mprolog-function} options.
7485 @item -mtda=@var{n}
7486 Put static or global variables whose size is @var{n} bytes or less into
7487 the tiny data area that register @code{ep} points to.  The tiny data
7488 area can hold up to 256 bytes in total (128 bytes for byte references).
7490 @item -msda=@var{n}
7491 Put static or global variables whose size is @var{n} bytes or less into
7492 the small data area that register @code{gp} points to.  The small data
7493 area can hold up to 64 kilobytes.
7495 @item -mzda=@var{n}
7496 Put static or global variables whose size is @var{n} bytes or less into
7497 the first 32 kilobytes of memory.
7499 @item -mv850
7500 Specify that the target processor is the V850.
7502 @item -mbig-switch
7503 Generate code suitable for big switch tables.  Use this option only if
7504 the assembler/linker complain about out of range branches within a switch
7505 table.
7506 @end table
7508 @node ARC Options
7509 @subsection ARC Options
7510 @cindex ARC Options
7512 These options are defined for ARC implementations:
7514 @table @gcctabopt
7515 @item -EL
7516 Compile code for little endian mode.  This is the default.
7518 @item -EB
7519 Compile code for big endian mode.
7521 @item -mmangle-cpu
7522 Prepend the name of the cpu to all public symbol names.
7523 In multiple-processor systems, there are many ARC variants with different
7524 instruction and register set characteristics.  This flag prevents code
7525 compiled for one cpu to be linked with code compiled for another.
7526 No facility exists for handling variants that are "almost identical".
7527 This is an all or nothing option.
7529 @item -mcpu=@var{cpu}
7530 Compile code for ARC variant @var{cpu}.
7531 Which variants are supported depend on the configuration.
7532 All variants support @samp{-mcpu=base}, this is the default.
7534 @item -mtext=@var{text section}
7535 @itemx -mdata=@var{data section}
7536 @itemx -mrodata=@var{readonly data section}
7537 Put functions, data, and readonly data in @var{text section},
7538 @var{data section}, and @var{readonly data section} respectively
7539 by default.  This can be overridden with the @code{section} attribute.
7540 @xref{Variable Attributes}.
7542 @end table
7544 @node NS32K Options
7545 @subsection NS32K Options
7546 @cindex NS32K options
7548 These are the @samp{-m} options defined for the 32000 series.  The default
7549 values for these options depends on which style of 32000 was selected when
7550 the compiler was configured; the defaults for the most common choices are
7551 given below.
7553 @table @gcctabopt
7554 @item -m32032
7555 @itemx -m32032
7556 Generate output for a 32032.  This is the default
7557 when the compiler is configured for 32032 and 32016 based systems.
7559 @item -m32332
7560 @itemx -m32332
7561 Generate output for a 32332.  This is the default
7562 when the compiler is configured for 32332-based systems.
7564 @item -m32532
7565 @itemx -m32532
7566 Generate output for a 32532.  This is the default
7567 when the compiler is configured for 32532-based systems.
7569 @item -m32081
7570 Generate output containing 32081 instructions for floating point.
7571 This is the default for all systems.
7573 @item -m32381
7574 Generate output containing 32381 instructions for floating point.  This
7575 also implies @samp{-m32081}. The 32381 is only compatible with the 32332
7576 and 32532 cpus. This is the default for the pc532-netbsd configuration.
7578 @item -mmulti-add
7579 Try and generate multiply-add floating point instructions @code{polyF}
7580 and @code{dotF}. This option is only available if the @samp{-m32381}
7581 option is in effect. Using these instructions requires changes to to
7582 register allocation which generally has a negative impact on
7583 performance.  This option should only be enabled when compiling code
7584 particularly likely to make heavy use of multiply-add instructions.
7586 @item -mnomulti-add
7587 Do not try and generate multiply-add floating point instructions
7588 @code{polyF} and @code{dotF}. This is the default on all platforms.
7590 @item -msoft-float
7591 Generate output containing library calls for floating point.
7592 @strong{Warning:} the requisite libraries may not be available.
7594 @item -mnobitfield
7595 Do not use the bit-field instructions. On some machines it is faster to
7596 use shifting and masking operations. This is the default for the pc532.
7598 @item -mbitfield
7599 Do use the bit-field instructions. This is the default for all platforms
7600 except the pc532.
7602 @item -mrtd
7603 Use a different function-calling convention, in which functions
7604 that take a fixed number of arguments return pop their
7605 arguments on return with the @code{ret} instruction.
7607 This calling convention is incompatible with the one normally
7608 used on Unix, so you cannot use it if you need to call libraries
7609 compiled with the Unix compiler.
7611 Also, you must provide function prototypes for all functions that
7612 take variable numbers of arguments (including @code{printf});
7613 otherwise incorrect code will be generated for calls to those
7614 functions.
7616 In addition, seriously incorrect code will result if you call a
7617 function with too many arguments.  (Normally, extra arguments are
7618 harmlessly ignored.)
7620 This option takes its name from the 680x0 @code{rtd} instruction.
7623 @item -mregparam
7624 Use a different function-calling convention where the first two arguments
7625 are passed in registers.
7627 This calling convention is incompatible with the one normally
7628 used on Unix, so you cannot use it if you need to call libraries
7629 compiled with the Unix compiler.
7631 @item -mnoregparam
7632 Do not pass any arguments in registers. This is the default for all
7633 targets.
7635 @item -msb
7636 It is OK to use the sb as an index register which is always loaded with
7637 zero. This is the default for the pc532-netbsd target.
7639 @item -mnosb
7640 The sb register is not available for use or has not been initialized to
7641 zero by the run time system. This is the default for all targets except
7642 the pc532-netbsd. It is also implied whenever @samp{-mhimem} or
7643 @samp{-fpic} is set.
7645 @item -mhimem
7646 Many ns32000 series addressing modes use displacements of up to 512MB.
7647 If an address is above 512MB then displacements from zero can not be used.
7648 This option causes code to be generated which can be loaded above 512MB.
7649 This may be useful for operating systems or ROM code.
7651 @item -mnohimem
7652 Assume code will be loaded in the first 512MB of virtual address space.
7653 This is the default for all platforms.
7656 @end table
7658 @node AVR Options
7659 @subsection AVR Options
7660 @cindex AVR Options
7662 These options are defined for AVR implementations:
7664 @table @gcctabopt
7665 @item -mmcu=@var{mcu}
7666 Specify ATMEL AVR instruction set or MCU type.
7668 Instruction set avr1 is for the minimal AVR core, not supported by the C
7669 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7670 attiny11, attiny12, attiny15, attiny28).
7672 Instruction set avr2 (default) is for the classic AVR core with up to
7673 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7674 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7675 at90c8534, at90s8535).
7677 Instruction set avr3 is for the classic AVR core with up to 128K program
7678 memory space (MCU types: atmega103, atmega603).
7680 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7681 memory space (MCU types: atmega83, atmega85).
7683 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7684 memory space (MCU types: atmega161, atmega163, atmega32, at94k).
7686 @item -msize
7687 Output instruction sizes to the asm file.
7689 @item -minit-stack=@var{N}
7690 Specify the initial stack address, which may be a symbol or numeric value,
7691 __stack is the default.
7693 @item -mno-interrupts
7694 Generated code is not compatible with hardware interrupts.
7695 Code size will be smaller.
7697 @item -mcall-prologues
7698 Functions prologues/epilogues expanded as call to appropriate
7699 subroutines. Code size will be smaller.
7701 @item -mno-tablejump
7702 Do not generate tablejump insns which sometimes increase code size.
7704 @item -mtiny-stack
7705 Change only the low 8 bits of the stack pointer.
7706 @end table
7708 @node MCore Options
7709 @subsection MCore Options
7710 @cindex MCore options
7712 These are the @samp{-m} options defined for the Motorola M*Core
7713 processors.  
7715 @table @gcctabopt
7717 @item -mhardlit
7718 @itemx -mhardlit
7719 @itemx -mno-hardlit
7720 Inline constants into the code stream if it can be done in two
7721 instructions or less.
7723 @item -mdiv
7724 @itemx -mdiv
7725 @itemx -mno-div
7726 Use the divide instruction.  (Enabled by default).
7728 @item -mrelax-immediate
7729 @itemx -mrelax-immediate
7730 @itemx -mno-relax-immediate
7731 Allow arbitrary sized immediates in bit operations.
7733 @item -mwide-bitfields
7734 @itemx -mwide-bitfields
7735 @itemx -mno-wide-bitfields
7736 Always treat bitfields as int-sized.
7738 @item -m4byte-functions
7739 @itemx -m4byte-functions
7740 @itemx -mno-4byte-functions
7741 Force all functions to be aligned to a four byte boundary.
7743 @item -mcallgraph-data
7744 @itemx -mcallgraph-data
7745 @itemx -mno-callgraph-data
7746 Emit callgraph information.
7748 @item -mslow-bytes
7749 @itemx -mslow-bytes
7750 @itemx -mno-slow-bytes
7751 Prefer word access when reading byte quantities.
7753 @item -mlittle-endian
7754 @itemx -mlittle-endian
7755 @itemx -mbig-endian
7756 Generate code for a little endian target.
7758 @item -m210
7759 @itemx -m210
7760 @itemx -m340
7761 Generate code for the 210 processor.
7762 @end table
7764 @node IA-64 Options
7765 @subsection IA-64 Options
7766 @cindex IA-64 Options
7768 These are the @samp{-m} options defined for the Intel IA-64 architecture.
7770 @table @gcctabopt
7771 @item -mbig-endian
7772 Generate code for a big endian target.  This is the default for HPUX.
7774 @item -mlittle-endian
7775 Generate code for a little endian target.  This is the default for AIX5
7776 and Linux.
7778 @item -mgnu-as
7779 @itemx -mno-gnu-as
7780 Generate (or don't) code for the GNU assembler.  This is the default.
7781 @c Also, this is the default if the configure option @samp{--with-gnu-as}
7782 @c is used.
7784 @item -mgnu-ld
7785 @itemx -mno-gnu-ld
7786 Generate (or don't) code for the GNU linker.  This is the default.
7787 @c Also, this is the default if the configure option @samp{--with-gnu-ld}
7788 @c is used.
7790 @item -mno-pic
7791 Generate code that does not use a global pointer register.  The result
7792 is not position independent code, and violates the IA-64 ABI.
7794 @item -mvolatile-asm-stop
7795 @itemx -mno-volatile-asm-stop
7796 Generate (or don't) a stop bit immediately before and after volatile asm
7797 statements.
7799 @item -mb-step
7800 Generate code that works around Itanium B step errata.
7802 @item -mregister-names
7803 @itemx -mno-register-names
7804 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
7805 the stacked registers.  This may make assembler output more readable.
7807 @item -mno-sdata
7808 @itemx -msdata
7809 Disable (or enable) optimizations that use the small data section.  This may
7810 be useful for working around optimizer bugs.
7812 @item -mconstant-gp
7813 Generate code that uses a single constant global pointer value.  This is
7814 useful when compiling kernel code.
7816 @item -mauto-pic
7817 Generate code that is self-relocatable.  This implies @samp{-mconstant-gp}.
7818 This is useful when compiling firmware code.
7820 @item -minline-divide-min-latency
7821 Generate code for inline divides using the minimum latency algorithm.
7823 @item -minline-divide-max-throughput
7824 Generate code for inline divides using the maximum throughput algorithm.
7826 @item -mno-dwarf2-asm
7827 @itemx -mdwarf2-asm
7828 Don't (or do) generate assembler code for the DWARF2 line number debugging
7829 info.  This may be useful when not using the GNU assembler.
7831 @item -mfixed-range=@var{register range}
7832 Generate code treating the given register range as fixed registers.
7833 A fixed register is one that the register allocator can not use.  This is
7834 useful when compiling kernel code.  A register range is specified as
7835 two registers separated by a dash.  Multiple register ranges can be
7836 specified separated by a comma.
7837 @end table
7839 @node D30V Options
7840 @subsection D30V Options
7841 @cindex D30V Options
7843 These @samp{-m} options are defined for D30V implementations:
7845 @table @gcctabopt
7846 @item -mextmem
7847 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
7848 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
7849 memory, which starts at location @code{0x80000000}.
7851 @item -mextmemory
7852 Same as the @samp{-mextmem} switch.
7854 @item -monchip
7855 Link the @samp{.text} section into onchip text memory, which starts at
7856 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
7857 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
7858 into onchip data memory, which starts at location @code{0x20000000}.
7860 @item -mno-asm-optimize
7861 @itemx -masm-optimize
7862 Disable (enable) passing @samp{-O} to the assembler when optimizing.
7863 The assembler uses the @samp{-O} option to automatically parallelize
7864 adjacent short instructions where possible.
7866 @item -mbranch-cost=@var{n}
7867 Increase the internal costs of branches to @var{n}.  Higher costs means
7868 that the compiler will issue more instructions to avoid doing a branch.
7869 The default is 2.
7871 @item -mcond-exec=@var{n}
7872 Specify the maximum number of conditionally executed instructions that
7873 replace a branch.  The default is 4.
7874 @end table
7876 @node Code Gen Options
7877 @section Options for Code Generation Conventions
7878 @cindex code generation conventions
7879 @cindex options, code generation
7880 @cindex run-time options
7882 These machine-independent options control the interface conventions
7883 used in code generation.
7885 Most of them have both positive and negative forms; the negative form
7886 of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below, only
7887 one of the forms is listed---the one which is not the default.  You
7888 can figure out the other form by either removing @samp{no-} or adding
7891 @table @gcctabopt
7892 @item -fexceptions
7893 Enable exception handling. Generates extra code needed to propagate
7894 exceptions.  For some targets, this implies GNU CC will generate frame
7895 unwind information for all functions, which can produce significant data
7896 size overhead, although it does not affect execution.  If you do not
7897 specify this option, GNU CC will enable it by default for languages like
7898 C++ which normally require exception handling, and disable itfor
7899 languages like C that do not normally require it.  However, you may need
7900 to enable this option when compiling C code that needs to interoperate
7901 properly with exception handlers written in C++.  You may also wish to
7902 disable this option if you are compiling older C++ programs that don't
7903 use exception handling.
7905 @item -funwind-tables
7906 Similar to @option{-fexceptions}, except that it will just generate any needed
7907 static data, but will not affect the generated code in any other way.
7908 You will normally not enable this option; instead, a language processor
7909 that needs this handling would enable it on your behalf.
7911 @item -fpcc-struct-return
7912 Return ``short'' @code{struct} and @code{union} values in memory like
7913 longer ones, rather than in registers.  This convention is less
7914 efficient, but it has the advantage of allowing intercallability between
7915 GCC-compiled files and files compiled with other compilers.
7917 The precise convention for returning structures in memory depends
7918 on the target configuration macros.
7920 Short structures and unions are those whose size and alignment match
7921 that of some integer type.
7923 @item -freg-struct-return
7924 Use the convention that @code{struct} and @code{union} values are
7925 returned in registers when possible.  This is more efficient for small
7926 structures than @samp{-fpcc-struct-return}.
7928 If you specify neither @samp{-fpcc-struct-return} nor its contrary
7929 @samp{-freg-struct-return}, GCC defaults to whichever convention is
7930 standard for the target.  If there is no standard convention, GCC
7931 defaults to @samp{-fpcc-struct-return}, except on targets where GCC
7932 is the principal compiler.  In those cases, we can choose the standard,
7933 and we chose the more efficient register return alternative.
7935 @item -fshort-enums
7936 Allocate to an @code{enum} type only as many bytes as it needs for the
7937 declared range of possible values.  Specifically, the @code{enum} type
7938 will be equivalent to the smallest integer type which has enough room.
7940 @item -fshort-double
7941 Use the same size for @code{double} as for @code{float}.
7943 @item -fshared-data
7944 Requests that the data and non-@code{const} variables of this
7945 compilation be shared data rather than private data.  The distinction
7946 makes sense only on certain operating systems, where shared data is
7947 shared between processes running the same program, while private data
7948 exists in one copy per process.
7950 @item -fno-common
7951 Allocate even uninitialized global variables in the data section of the
7952 object file, rather than generating them as common blocks.  This has the
7953 effect that if the same variable is declared (without @code{extern}) in
7954 two different compilations, you will get an error when you link them.
7955 The only reason this might be useful is if you wish to verify that the
7956 program will work on other systems which always work this way.
7958 @item -fno-ident
7959 Ignore the @samp{#ident} directive.
7961 @item -fno-gnu-linker
7962 Do not output global initializations (such as C++ constructors and
7963 destructors) in the form used by the GNU linker (on systems where the GNU
7964 linker is the standard method of handling them).  Use this option when
7965 you want to use a non-GNU linker, which also requires using the
7966 @command{collect2} program to make sure the system linker includes
7967 constructors and destructors.  (@command{collect2} is included in the GCC
7968 distribution.)  For systems which @emph{must} use @command{collect2}, the
7969 compiler driver @command{gcc} is configured to do this automatically.
7971 @item -finhibit-size-directive
7972 Don't output a @code{.size} assembler directive, or anything else that
7973 would cause trouble if the function is split in the middle, and the
7974 two halves are placed at locations far apart in memory.  This option is
7975 used when compiling @file{crtstuff.c}; you should not need to use it
7976 for anything else.
7978 @item -fverbose-asm
7979 Put extra commentary information in the generated assembly code to
7980 make it more readable.  This option is generally only of use to those
7981 who actually need to read the generated assembly code (perhaps while
7982 debugging the compiler itself).
7984 @samp{-fno-verbose-asm}, the default, causes the
7985 extra information to be omitted and is useful when comparing two assembler
7986 files.
7988 @item -fvolatile
7989 Consider all memory references through pointers to be volatile.
7991 @item -fvolatile-global
7992 Consider all memory references to extern and global data items to
7993 be volatile.  GCC does not consider static data items to be volatile
7994 because of this switch.
7996 @item -fvolatile-static
7997 Consider all memory references to static data to be volatile.
7999 @item -fpic
8000 @cindex global offset table
8001 @cindex PIC
8002 Generate position-independent code (PIC) suitable for use in a shared
8003 library, if supported for the target machine.  Such code accesses all
8004 constant addresses through a global offset table (GOT).  The dynamic
8005 loader resolves the GOT entries when the program starts (the dynamic
8006 loader is not part of GCC; it is part of the operating system).  If
8007 the GOT size for the linked executable exceeds a machine-specific
8008 maximum size, you get an error message from the linker indicating that
8009 @samp{-fpic} does not work; in that case, recompile with @samp{-fPIC}
8010 instead.  (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
8011 on the m68k and RS/6000.  The 386 has no such limit.)
8013 Position-independent code requires special support, and therefore works
8014 only on certain machines.  For the 386, GCC supports PIC for System V
8015 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
8016 position-independent.
8018 @item -fPIC
8019 If supported for the target machine, emit position-independent code,
8020 suitable for dynamic linking and avoiding any limit on the size of the
8021 global offset table.  This option makes a difference on the m68k, m88k,
8022 and the Sparc.
8024 Position-independent code requires special support, and therefore works
8025 only on certain machines.
8027 @item -ffixed-@var{reg}
8028 Treat the register named @var{reg} as a fixed register; generated code
8029 should never refer to it (except perhaps as a stack pointer, frame
8030 pointer or in some other fixed role).
8032 @var{reg} must be the name of a register.  The register names accepted
8033 are machine-specific and are defined in the @code{REGISTER_NAMES}
8034 macro in the machine description macro file.
8036 This flag does not have a negative form, because it specifies a
8037 three-way choice.
8039 @item -fcall-used-@var{reg}
8040 Treat the register named @var{reg} as an allocable register that is
8041 clobbered by function calls.  It may be allocated for temporaries or
8042 variables that do not live across a call.  Functions compiled this way
8043 will not save and restore the register @var{reg}.
8045 It is an error to used this flag with the frame pointer or stack pointer.
8046 Use of this flag for other registers that have fixed pervasive roles in
8047 the machine's execution model will produce disastrous results.
8049 This flag does not have a negative form, because it specifies a
8050 three-way choice.
8052 @item -fcall-saved-@var{reg}
8053 Treat the register named @var{reg} as an allocable register saved by
8054 functions.  It may be allocated even for temporaries or variables that
8055 live across a call.  Functions compiled this way will save and restore
8056 the register @var{reg} if they use it.
8058 It is an error to used this flag with the frame pointer or stack pointer.
8059 Use of this flag for other registers that have fixed pervasive roles in
8060 the machine's execution model will produce disastrous results.
8062 A different sort of disaster will result from the use of this flag for
8063 a register in which function values may be returned.
8065 This flag does not have a negative form, because it specifies a
8066 three-way choice.
8068 @item -fpack-struct
8069 Pack all structure members together without holes.  Usually you would
8070 not want to use this option, since it makes the code suboptimal, and
8071 the offsets of structure members won't agree with system libraries.
8073 @item -fcheck-memory-usage
8074 Generate extra code to check each memory access.  GCC will generate
8075 code that is suitable for a detector of bad memory accesses such as
8076 @file{Checker}.
8078 Normally, you should compile all, or none, of your code with this option.
8080 If you do mix code compiled with and without this option,
8081 you must ensure that all code that has side effects
8082 and that is called by code compiled with this option
8083 is, itself, compiled with this option.
8084 If you do not, you might get erroneous messages from the detector.
8086 If you use functions from a library that have side-effects (such as
8087 @code{read}), you might not be able to recompile the library and
8088 specify this option.  In that case, you can enable the
8089 @samp{-fprefix-function-name} option, which requests GCC to encapsulate
8090 your code and make other functions look as if they were compiled with
8091 @samp{-fcheck-memory-usage}.  This is done by calling ``stubs'',
8092 which are provided by the detector.  If you cannot find or build
8093 stubs for every function you call, you might have to specify
8094 @samp{-fcheck-memory-usage} without @samp{-fprefix-function-name}.
8096 If you specify this option, you can not use the @code{asm} or
8097 @code{__asm__} keywords in functions with memory checking enabled.  GNU
8098 CC cannot understand what the @code{asm} statement may do, and therefore
8099 cannot generate the appropriate code, so it will reject it.  However, if
8100 you specify the function attribute @code{no_check_memory_usage}
8101 (@pxref{Function Attributes}), GNU CC will disable memory checking within a
8102 function; you may use @code{asm} statements inside such functions.  You
8103 may have an inline expansion of a non-checked function within a checked
8104 function; in that case GNU CC will not generate checks for the inlined
8105 function's memory accesses.
8107 If you move your @code{asm} statements to non-checked inline functions
8108 and they do access memory, you can add calls to the support code in your
8109 inline function, to indicate any reads, writes, or copies being done.
8110 These calls would be similar to those done in the stubs described above.
8112 @item -fprefix-function-name
8113 Request GCC to add a prefix to the symbols generated for function names.
8114 GCC adds a prefix to the names of functions defined as well as
8115 functions called.  Code compiled with this option and code compiled
8116 without the option can't be linked together, unless stubs are used.
8118 If you compile the following code with @samp{-fprefix-function-name}
8119 @example
8120 extern void bar (int);
8121 void
8122 foo (int a)
8124   return bar (a + 5);
8126 @end example
8128 @noindent
8129 GCC will compile the code as if it was written:
8130 @example
8131 extern void prefix_bar (int);
8132 void
8133 prefix_foo (int a)
8135   return prefix_bar (a + 5);
8137 @end example
8138 This option is designed to be used with @samp{-fcheck-memory-usage}.
8140 @item -finstrument-functions
8141 Generate instrumentation calls for entry and exit to functions.  Just
8142 after function entry and just before function exit, the following
8143 profiling functions will be called with the address of the current
8144 function and its call site.  (On some platforms,
8145 @code{__builtin_return_address} does not work beyond the current
8146 function, so the call site information may not be available to the
8147 profiling functions otherwise.)
8149 @example
8150 void __cyg_profile_func_enter (void *this_fn, void *call_site);
8151 void __cyg_profile_func_exit  (void *this_fn, void *call_site);
8152 @end example
8154 The first argument is the address of the start of the current function,
8155 which may be looked up exactly in the symbol table.
8157 This instrumentation is also done for functions expanded inline in other
8158 functions.  The profiling calls will indicate where, conceptually, the
8159 inline function is entered and exited.  This means that addressable
8160 versions of such functions must be available.  If all your uses of a
8161 function are expanded inline, this may mean an additional expansion of
8162 code size.  If you use @samp{extern inline} in your C code, an
8163 addressable version of such functions must be provided.  (This is
8164 normally the case anyways, but if you get lucky and the optimizer always
8165 expands the functions inline, you might have gotten away without
8166 providing static copies.)
8168 A function may be given the attribute @code{no_instrument_function}, in
8169 which case this instrumentation will not be done.  This can be used, for
8170 example, for the profiling functions listed above, high-priority
8171 interrupt routines, and any functions from which the profiling functions
8172 cannot safely be called (perhaps signal handlers, if the profiling
8173 routines generate output or allocate memory).
8175 @item -fstack-check
8176 Generate code to verify that you do not go beyond the boundary of the
8177 stack.  You should specify this flag if you are running in an
8178 environment with multiple threads, but only rarely need to specify it in
8179 a single-threaded environment since stack overflow is automatically
8180 detected on nearly all systems if there is only one stack.
8182 Note that this switch does not actually cause checking to be done; the
8183 operating system must do that.  The switch causes generation of code
8184 to ensure that the operating system sees the stack being extended.
8186 @item -fstack-limit-register=@var{reg}
8187 @itemx -fstack-limit-symbol=@var{sym}
8188 @itemx -fno-stack-limit
8189 Generate code to ensure that the stack does not grow beyond a certain value,
8190 either the value of a register or the address of a symbol.  If the stack
8191 would grow beyond the value, a signal is raised.  For most targets,
8192 the signal is raised before the stack overruns the boundary, so
8193 it is possible to catch the signal without taking special precautions.
8195 For instance, if the stack starts at address @samp{0x80000000} and grows
8196 downwards you can use the flags
8197 @samp{-fstack-limit-symbol=__stack_limit}
8198 @samp{-Wl,--defsym,__stack_limit=0x7ffe0000} which will enforce a stack
8199 limit of 128K.
8201 @cindex aliasing of parameters
8202 @cindex parameters, aliased
8203 @item -fargument-alias
8204 @itemx -fargument-noalias
8205 @itemx -fargument-noalias-global
8206 Specify the possible relationships among parameters and between
8207 parameters and global data.
8209 @samp{-fargument-alias} specifies that arguments (parameters) may
8210 alias each other and may alias global storage.
8211 @samp{-fargument-noalias} specifies that arguments do not alias
8212 each other, but may alias global storage.
8213 @samp{-fargument-noalias-global} specifies that arguments do not
8214 alias each other and do not alias global storage.
8216 Each language will automatically use whatever option is required by
8217 the language standard.  You should not need to use these options yourself.
8219 @item -fleading-underscore
8220 This option and its counterpart, -fno-leading-underscore, forcibly
8221 change the way C symbols are represented in the object file.  One use
8222 is to help link with legacy assembly code.
8224 Be warned that you should know what you are doing when invoking this
8225 option, and that not all targets provide complete support for it.
8226 @end table
8228 @c man end
8230 @node Environment Variables
8231 @section Environment Variables Affecting GCC
8232 @cindex environment variables
8234 @c man begin ENVIRONMENT
8236 This section describes several environment variables that affect how GCC
8237 operates.  Some of them work by specifying directories or prefixes to use
8238 when searching for various kinds of files. Some are used to specify other
8239 aspects of the compilation environment.
8241 @ifclear INTERNALS
8242 Note that you can also specify places to search using options such as
8243 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
8244 take precedence over places specified using environment variables, which
8245 in turn take precedence over those specified by the configuration of GCC.
8247 @end ifclear
8248 @ifset INTERNALS
8249 Note that you can also specify places to search using options such as
8250 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
8251 take precedence over places specified using environment variables, which
8252 in turn take precedence over those specified by the configuration of GCC.
8253 @xref{Driver}.
8254 @end ifset
8256 @table @env
8257 @item LANG
8258 @itemx LC_CTYPE
8259 @c @itemx LC_COLLATE
8260 @itemx LC_MESSAGES
8261 @c @itemx LC_MONETARY
8262 @c @itemx LC_NUMERIC
8263 @c @itemx LC_TIME
8264 @itemx LC_ALL
8265 @findex LANG
8266 @findex LC_CTYPE
8267 @c @findex LC_COLLATE
8268 @findex LC_MESSAGES
8269 @c @findex LC_MONETARY
8270 @c @findex LC_NUMERIC
8271 @c @findex LC_TIME
8272 @findex LC_ALL
8273 @cindex locale
8274 These environment variables control the way that GCC uses
8275 localization information that allow GCC to work with different
8276 national conventions.  GCC inspects the locale categories
8277 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
8278 so.  These locale categories can be set to any value supported by your
8279 installation.  A typical value is @samp{en_UK} for English in the United
8280 Kingdom.
8282 The @env{LC_CTYPE} environment variable specifies character
8283 classification.  GCC uses it to determine the character boundaries in
8284 a string; this is needed for some multibyte encodings that contain quote
8285 and escape characters that would otherwise be interpreted as a string
8286 end or escape.
8288 The @env{LC_MESSAGES} environment variable specifies the language to
8289 use in diagnostic messages.
8291 If the @env{LC_ALL} environment variable is set, it overrides the value
8292 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
8293 and @env{LC_MESSAGES} default to the value of the @env{LANG}
8294 environment variable.  If none of these variables are set, GCC
8295 defaults to traditional C English behavior.
8297 @item TMPDIR
8298 @findex TMPDIR
8299 If @env{TMPDIR} is set, it specifies the directory to use for temporary
8300 files.  GCC uses temporary files to hold the output of one stage of
8301 compilation which is to be used as input to the next stage: for example,
8302 the output of the preprocessor, which is the input to the compiler
8303 proper.
8305 @item GCC_EXEC_PREFIX
8306 @findex GCC_EXEC_PREFIX
8307 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
8308 names of the subprograms executed by the compiler.  No slash is added
8309 when this prefix is combined with the name of a subprogram, but you can
8310 specify a prefix that ends with a slash if you wish.
8312 If @env{GCC_EXEC_PREFIX} is not set, GNU CC will attempt to figure out
8313 an appropriate prefix to use based on the pathname it was invoked with.
8315 If GCC cannot find the subprogram using the specified prefix, it
8316 tries looking in the usual places for the subprogram.
8318 The default value of @env{GCC_EXEC_PREFIX} is
8319 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
8320 of @code{prefix} when you ran the @file{configure} script.
8322 Other prefixes specified with @samp{-B} take precedence over this prefix.
8324 This prefix is also used for finding files such as @file{crt0.o} that are
8325 used for linking.
8327 In addition, the prefix is used in an unusual way in finding the
8328 directories to search for header files.  For each of the standard
8329 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
8330 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
8331 replacing that beginning with the specified prefix to produce an
8332 alternate directory name.  Thus, with @samp{-Bfoo/}, GCC will search
8333 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
8334 These alternate directories are searched first; the standard directories
8335 come next.
8337 @item COMPILER_PATH
8338 @findex COMPILER_PATH
8339 The value of @env{COMPILER_PATH} is a colon-separated list of
8340 directories, much like @env{PATH}.  GCC tries the directories thus
8341 specified when searching for subprograms, if it can't find the
8342 subprograms using @env{GCC_EXEC_PREFIX}.
8344 @item LIBRARY_PATH
8345 @findex LIBRARY_PATH
8346 The value of @env{LIBRARY_PATH} is a colon-separated list of
8347 directories, much like @env{PATH}.  When configured as a native compiler,
8348 GCC tries the directories thus specified when searching for special
8349 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
8350 using GCC also uses these directories when searching for ordinary
8351 libraries for the @samp{-l} option (but directories specified with
8352 @samp{-L} come first).
8354 @item C_INCLUDE_PATH
8355 @itemx CPLUS_INCLUDE_PATH
8356 @itemx OBJC_INCLUDE_PATH
8357 @findex C_INCLUDE_PATH
8358 @findex CPLUS_INCLUDE_PATH
8359 @findex OBJC_INCLUDE_PATH
8360 @c @itemx OBJCPLUS_INCLUDE_PATH
8361 These environment variables pertain to particular languages.  Each
8362 variable's value is a colon-separated list of directories, much like
8363 @env{PATH}.  When GCC searches for header files, it tries the
8364 directories listed in the variable for the language you are using, after
8365 the directories specified with @samp{-I} but before the standard header
8366 file directories.
8368 @item DEPENDENCIES_OUTPUT
8369 @findex DEPENDENCIES_OUTPUT
8370 @cindex dependencies for make as output
8371 If this variable is set, its value specifies how to output dependencies
8372 for Make based on the header files processed by the compiler.  This
8373 output looks much like the output from the @samp{-M} option
8374 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
8375 in addition to the usual results of compilation.
8377 The value of @env{DEPENDENCIES_OUTPUT} can be just a file name, in
8378 which case the Make rules are written to that file, guessing the target
8379 name from the source file name.  Or the value can have the form
8380 @samp{@var{file} @var{target}}, in which case the rules are written to
8381 file @var{file} using @var{target} as the target name.
8383 @item LANG
8384 @findex LANG
8385 @cindex locale definition
8386 This variable is used to pass locale information to the compiler. One way in
8387 which this information is used is to determine the character set to be used
8388 when character literals, string literals and comments are parsed in C and C++.
8389 When the compiler is configured to allow multibyte characters,
8390 the following values for @env{LANG} are recognized:
8392 @table @samp
8393 @item C-JIS
8394 Recognize JIS characters.
8395 @item C-SJIS
8396 Recognize SJIS characters.
8397 @item C-EUCJP
8398 Recognize EUCJP characters.
8399 @end table
8401 If @env{LANG} is not defined, or if it has some other value, then the
8402 compiler will use mblen and mbtowc as defined by the default locale to
8403 recognize and translate multibyte characters.
8404 @end table
8406 @c man end
8408 @node Running Protoize
8409 @section Running Protoize
8411 The program @code{protoize} is an optional part of GNU C.  You can use
8412 it to add prototypes to a program, thus converting the program to ISO
8413 C in one respect.  The companion program @code{unprotoize} does the
8414 reverse: it removes argument types from any prototypes that are found.
8416 When you run these programs, you must specify a set of source files as
8417 command line arguments.  The conversion programs start out by compiling
8418 these files to see what functions they define.  The information gathered
8419 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
8421 After scanning comes actual conversion.  The specified files are all
8422 eligible to be converted; any files they include (whether sources or
8423 just headers) are eligible as well.
8425 But not all the eligible files are converted.  By default,
8426 @code{protoize} and @code{unprotoize} convert only source and header
8427 files in the current directory.  You can specify additional directories
8428 whose files should be converted with the @samp{-d @var{directory}}
8429 option.  You can also specify particular files to exclude with the
8430 @samp{-x @var{file}} option.  A file is converted if it is eligible, its
8431 directory name matches one of the specified directory names, and its
8432 name within the directory has not been excluded.
8434 Basic conversion with @code{protoize} consists of rewriting most
8435 function definitions and function declarations to specify the types of
8436 the arguments.  The only ones not rewritten are those for varargs
8437 functions.
8439 @code{protoize} optionally inserts prototype declarations at the
8440 beginning of the source file, to make them available for any calls that
8441 precede the function's definition.  Or it can insert prototype
8442 declarations with block scope in the blocks where undeclared functions
8443 are called.
8445 Basic conversion with @code{unprotoize} consists of rewriting most
8446 function declarations to remove any argument types, and rewriting
8447 function definitions to the old-style pre-ISO form.
8449 Both conversion programs print a warning for any function declaration or
8450 definition that they can't convert.  You can suppress these warnings
8451 with @samp{-q}.
8453 The output from @code{protoize} or @code{unprotoize} replaces the
8454 original source file.  The original file is renamed to a name ending
8455 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav} 
8456 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
8457 for DOS) file already exists, then the source file is simply discarded.
8459 @code{protoize} and @code{unprotoize} both depend on GCC itself to
8460 scan the program and collect information about the functions it uses.
8461 So neither of these programs will work until GCC is installed.
8463 Here is a table of the options you can use with @code{protoize} and
8464 @code{unprotoize}.  Each option works with both programs unless
8465 otherwise stated.
8467 @table @code
8468 @item -B @var{directory}
8469 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
8470 usual directory (normally @file{/usr/local/lib}).  This file contains
8471 prototype information about standard system functions.  This option
8472 applies only to @code{protoize}.
8474 @item -c @var{compilation-options}
8475 Use  @var{compilation-options} as the options when running @code{gcc} to
8476 produce the @samp{.X} files.  The special option @samp{-aux-info} is
8477 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
8479 Note that the compilation options must be given as a single argument to
8480 @code{protoize} or @code{unprotoize}.  If you want to specify several
8481 @code{gcc} options, you must quote the entire set of compilation options
8482 to make them a single word in the shell.
8484 There are certain @code{gcc} arguments that you cannot use, because they
8485 would produce the wrong kind of output.  These include @samp{-g},
8486 @samp{-O}, @samp{-c}, @samp{-S}, and @samp{-o} If you include these in
8487 the @var{compilation-options}, they are ignored.
8489 @item -C
8490 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
8491 systems) instead of @samp{.c}.  This is convenient if you are converting 
8492 a C program to C++.  This option applies only to @code{protoize}.
8494 @item -g
8495 Add explicit global declarations.  This means inserting explicit
8496 declarations at the beginning of each source file for each function
8497 that is called in the file and was not declared.  These declarations
8498 precede the first function definition that contains a call to an
8499 undeclared function.  This option applies only to @code{protoize}.
8501 @item -i @var{string}
8502 Indent old-style parameter declarations with the string @var{string}.
8503 This option applies only to @code{protoize}.
8505 @code{unprotoize} converts prototyped function definitions to old-style
8506 function definitions, where the arguments are declared between the
8507 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
8508 uses five spaces as the indentation.  If you want to indent with just
8509 one space instead, use @samp{-i " "}.
8511 @item -k
8512 Keep the @samp{.X} files.  Normally, they are deleted after conversion
8513 is finished.
8515 @item -l
8516 Add explicit local declarations.  @code{protoize} with @samp{-l} inserts
8517 a prototype declaration for each function in each block which calls the
8518 function without any declaration.  This option applies only to
8519 @code{protoize}.
8521 @item -n
8522 Make no real changes.  This mode just prints information about the conversions
8523 that would have been done without @samp{-n}.
8525 @item -N
8526 Make no @samp{.save} files.  The original files are simply deleted.
8527 Use this option with caution.
8529 @item -p @var{program}
8530 Use the program @var{program} as the compiler.  Normally, the name
8531 @file{gcc} is used.
8533 @item -q
8534 Work quietly.  Most warnings are suppressed.
8536 @item -v
8537 Print the version number, just like @samp{-v} for @code{gcc}.
8538 @end table
8540 If you need special compiler options to compile one of your program's
8541 source files, then you should generate that file's @samp{.X} file
8542 specially, by running @code{gcc} on that source file with the
8543 appropriate options and the option @samp{-aux-info}.  Then run
8544 @code{protoize} on the entire set of files.  @code{protoize} will use
8545 the existing @samp{.X} file because it is newer than the source file.
8546 For example:
8548 @example
8549 gcc -Dfoo=bar file1.c -aux-info
8550 protoize *.c
8551 @end example
8553 @noindent
8554 You need to include the special files along with the rest in the
8555 @code{protoize} command, even though their @samp{.X} files already
8556 exist, because otherwise they won't get converted.
8558 @xref{Protoize Caveats}, for more information on how to use
8559 @code{protoize} successfully.