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