* invoke.texi: Document -Wmissing-braces, -dumpspecs,
[official-gcc.git] / gcc / invoke.texi
blobfa7d047e9d78e9076c4c47e782ec8f357f5a8c74
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-braces  -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}  -dumpspecs  -dumpmachine  -dumpversion @gol
228 -fdump-unnumbered -fdump-translation-unit=@var{file} @gol
229 -fdump-class-layout=@var{file}  -fmem-report  -fpretend-float @gol
230 -fprofile-arcs  -ftest-coverage  -ftime-report @gol
231 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
232 -ggdb  -gstabs  -gstabs+  -gxcoff  -gxcoff+ @gol
233 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
234 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
235 -save-temps  -time}
237 @item Optimization Options
238 @xref{Optimize Options,,Options that Control Optimization}.
239 @gccoptlist{
240 -falign-functions=@var{n}  -falign-jumps=@var{n} @gol
241 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
242 -fbranch-probabilities  -fcaller-saves @gol
243 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections  -fdce @gol
244 -fdelayed-branch  -fdelete-null-pointer-checks @gol
245 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
246 -fforce-addr  -fforce-mem  -ffunction-sections  -fgcse  -fgcse-lm -fgcse-sm @gol
247 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
248 -fkeep-static-consts  -fmove-all-movables @gol
249 -fno-default-inline  -fno-defer-pop @gol
250 -fno-function-cse   -fno-guess-branch-probability @gol
251 -fno-inline  -fno-math-errno  -fno-peephole @gol
252 -funsafe-math-optimizations -fno-trapping-math @gol
253 -fomit-frame-pointer  -foptimize-register-move @gol
254 -foptimize-sibling-calls  -freduce-all-givs @gol
255 -fregmove  -frename-registers @gol
256 -frerun-cse-after-loop  -frerun-loop-opt @gol
257 -fschedule-insns  -fschedule-insns2 @gol
258 -fsingle-precision-constant  -fssa @gol
259 -fstrength-reduce  -fstrict-aliasing  -fthread-jumps  -ftrapv @gol
260 -funroll-all-loops  -funroll-loops  @gol
261 --param @var{name}=@var{value}
262 -O  -O0  -O1  -O2  -O3  -Os}
264 @item Preprocessor Options
265 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
266 @gccoptlist{
267 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
268 -C  -dD  -dI  -dM  -dN @gol
269 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
270 -idirafter @var{dir} @gol
271 -include @var{file}  -imacros @var{file} @gol
272 -iprefix @var{file}  -iwithprefix @var{dir} @gol
273 -iwithprefixbefore @var{dir}  -isystem @var{dir} -isystem-c++ @var{dir} @gol
274 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
275 -trigraphs  -undef  -U@var{macro}  -Wp\,@var{option}}
277 @item Assembler Option
278 @xref{Assembler Options,,Passing Options to the Assembler}.
279 @gccoptlist{
280 -Wa\,@var{option}}
282 @item Linker Options
283 @xref{Link Options,,Options for Linking}.
284 @gccoptlist{
285 @var{object-file-name}  -l@var{library} @gol
286 -nostartfiles  -nodefaultlibs  -nostdlib @gol
287 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
288 -Wl\,@var{option}  -Xlinker @var{option} @gol
289 -u @var{symbol}}
291 @item Directory Options
292 @xref{Directory Options,,Options for Directory Search}.
293 @gccoptlist{
294 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
296 @item Target Options
297 @c I wrote this xref this way to avoid overfull hbox. -- rms
298 @xref{Target Options}.
299 @gccoptlist{
300 -b @var{machine}  -V @var{version}}
302 @item Machine Dependent Options
303 @xref{Submodel Options,,Hardware Models and Configurations}.
304 @emph{M680x0 Options}
305 @gccoptlist{
306 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
307 -m68060  -mcpu32 -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
308 -mfpa -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
309 -malign-int -mstrict-align}
311 @emph{M68hc1x Options}
312 @gccoptlist{
313 -m6811  -m6812  -m68hc11  -m68hc12 @gol
314 -mauto-incdec  -mshort  -msoft-reg-count=@var{count}}
316 @emph{VAX Options}
317 @gccoptlist{
318 -mg  -mgnu  -munix}
320 @emph{SPARC Options}
321 @gccoptlist{
322 -mcpu=@var{cpu type} @gol
323 -mtune=@var{cpu type} @gol
324 -mcmodel=@var{code model} @gol
325 -m32  -m64 @gol
326 -mapp-regs  -mbroken-saverestore  -mcypress @gol
327 -mepilogue -mfaster-structs -mflat @gol
328 -mfpu  -mhard-float  -mhard-quad-float @gol
329 -mimpure-text  -mlive-g0  -mno-app-regs @gol
330 -mno-epilogue -mno-faster-structs -mno-flat  -mno-fpu @gol
331 -mno-impure-text -mno-stack-bias  -mno-unaligned-doubles @gol
332 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
333 -msupersparc  -munaligned-doubles  -mv8}
335 @emph{Convex Options}
336 @gccoptlist{
337 -mc1  -mc2  -mc32  -mc34  -mc38 @gol
338 -margcount  -mnoargcount @gol
339 -mlong32  -mlong64 @gol
340 -mvolatile-cache  -mvolatile-nocache}
342 @emph{AMD29K Options}
343 @gccoptlist{
344 -m29000  -m29050  -mbw  -mnbw  -mdw  -mndw @gol
345 -mlarge  -mnormal  -msmall @gol
346 -mkernel-registers  -mno-reuse-arg-regs @gol
347 -mno-stack-check  -mno-storem-bug @gol
348 -mreuse-arg-regs  -msoft-float  -mstack-check @gol
349 -mstorem-bug  -muser-registers}
351 @emph{ARM Options}
352 @gccoptlist{
353 -mapcs-frame -mno-apcs-frame @gol
354 -mapcs-26 -mapcs-32 @gol
355 -mapcs-stack-check -mno-apcs-stack-check @gol
356 -mapcs-float -mno-apcs-float @gol
357 -mapcs-reentrant -mno-apcs-reentrant @gol
358 -msched-prolog -mno-sched-prolog @gol
359 -mlittle-endian -mbig-endian -mwords-little-endian @gol
360 -malignment-traps -mno-alignment-traps @gol
361 -msoft-float -mhard-float -mfpe @gol
362 -mthumb-interwork -mno-thumb-interwork @gol
363 -mcpu= -march= -mfpe=  @gol
364 -mstructure-size-boundary= @gol
365 -mbsd -mxopen -mno-symrename @gol
366 -mabort-on-noreturn @gol
367 -mlong-calls -mno-long-calls @gol
368 -mnop-fun-dllimport -mno-nop-fun-dllimport @gol
369 -msingle-pic-base -mno-single-pic-base @gol
370 -mpic-register=}
372 @emph{Thumb Options}
373 @gccoptlist{
374 -mtpcs-frame -mno-tpcs-frame @gol
375 -mtpcs-leaf-frame -mno-tpcs-leaf-frame @gol
376 -mlittle-endian  -mbig-endian @gol
377 -mthumb-interwork -mno-thumb-interwork @gol
378 -mstructure-size-boundary= @gol
379 -mnop-fun-dllimport -mno-nop-fun-dllimport @gol
380 -mcallee-super-interworking -mno-callee-super-interworking @gol
381 -mcaller-super-interworking -mno-caller-super-interworking @gol
382 -msingle-pic-base -mno-single-pic-base @gol
383 -mpic-register=}
385 @emph{MN10200 Options}
386 @gccoptlist{
387 -mrelax}
389 @emph{MN10300 Options}
390 @gccoptlist{
391 -mmult-bug @gol
392 -mno-mult-bug @gol
393 -mam33 @gol
394 -mno-am33 @gol
395 -mrelax}
397 @emph{M32R/D Options}
398 @gccoptlist{
399 -mcode-model=@var{model type}  -msdata=@var{sdata type} @gol
400 -G @var{num}}
402 @emph{M88K Options}
403 @gccoptlist{
404 -m88000  -m88100  -m88110  -mbig-pic @gol
405 -mcheck-zero-division  -mhandle-large-shift @gol
406 -midentify-revision  -mno-check-zero-division @gol
407 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
408 -mno-optimize-arg-area  -mno-serialize-volatile @gol
409 -mno-underscores  -mocs-debug-info @gol
410 -mocs-frame-position  -moptimize-arg-area @gol
411 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
412 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
413 -mversion-03.00  -mwarn-passed-structs}
415 @emph{RS/6000 and PowerPC Options}
416 @gccoptlist{
417 -mcpu=@var{cpu type} @gol
418 -mtune=@var{cpu type} @gol
419 -mpower  -mno-power  -mpower2  -mno-power2 @gol
420 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
421 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
422 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
423 -mnew-mnemonics  -mold-mnemonics @gol
424 -mfull-toc   -mminimal-toc  -mno-fop-in-toc  -mno-sum-in-toc @gol
425 -m64  -m32  -mxl-call  -mno-xl-call  -mthreads  -mpe @gol
426 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
427 -mstring  -mno-string  -mupdate  -mno-update @gol
428 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
429 -mstrict-align  -mno-strict-align  -mrelocatable @gol
430 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
431 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
432 -mcall-aix  -mcall-sysv  -mprototype  -mno-prototype @gol
433 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
434 -msdata=@var{opt}  -mvxworks -G @var{num}}
436 @emph{RT Options}
437 @gccoptlist{
438 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
439 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
440 -mminimum-fp-blocks  -mnohc-struct-return}
442 @emph{MIPS Options}
443 @gccoptlist{
444 -mabicalls  -mcpu=@var{cpu type}
445 -membedded-data  -muninit-const-in-rodata @gol
446 -membedded-pic  -mfp32  -mfp64  -mgas  -mgp32  -mgp64 @gol
447 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
448 -mips2  -mips3 -mips4 -mlong64  -mlong32 -mlong-calls  -mmemcpy @gol
449 -mmips-as  -mmips-tfile  -mno-abicalls @gol
450 -mno-embedded-data  -mno-uninit-const-in-rodata  -mno-embedded-pic @gol
451 -mno-gpopt  -mno-long-calls @gol
452 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
453 -mrnames  -msoft-float @gol
454 -m4650  -msingle-float  -mmad @gol
455 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
456 -mabi=32 -mabi=n32 -mabi=64 -mabi=eabi @gol
457 -mfix7000 -mno-crt0}
459 @emph{i386 Options}
460 @gccoptlist{
461 -mcpu=@var{cpu type} -march=@var{cpu type} @gol
462 -mintel-syntax -mieee-fp  -mno-fancy-math-387 @gol
463 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
464 -mno-wide-multiply  -mrtd  -malign-double @gol
465 -malign-jumps=@var{num}  -malign-loops=@var{num} @gol
466 -malign-functions=@var{num} -mpreferred-stack-boundary=@var{num} @gol
467 -mthreads -mno-align-stringops -minline-all-stringops @gol
468 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
469 -m96bit-long-double -mregparm=@var{num}}
471 @emph{HPPA Options}
472 @gccoptlist{
473 -march=@var{architecture type} @gol
474 -mbig-switch  -mdisable-fpregs  -mdisable-indexing   @gol
475 -mfast-indirect-calls -mgas  -mjump-in-delay   @gol
476 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
477 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
478 -mno-jump-in-delay  -mno-long-load-store   @gol
479 -mno-portable-runtime  -mno-soft-float @gol
480 -mno-space-regs  -msoft-float  -mpa-risc-1-0   @gol
481 -mpa-risc-1-1  -mpa-risc-2-0 -mportable-runtime @gol
482 -mschedule=@var{cpu type}  -mspace-regs}
484 @emph{Intel 960 Options}
485 @gccoptlist{
486 -m@var{cpu type}  -masm-compat  -mclean-linkage @gol
487 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
488 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
489 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
490 -mno-complex-addr  -mno-leaf-procedures @gol
491 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
492 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
493 -mtail-call}
495 @emph{DEC Alpha Options}
496 @gccoptlist{
497 -mfp-regs  -mno-fp-regs -mno-soft-float  -msoft-float @gol
498 -malpha-as -mgas @gol
499 -mieee  -mieee-with-inexact  -mieee-conformant @gol
500 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
501 -mtrap-precision=@var{mode}  -mbuild-constants @gol
502 -mcpu=@var{cpu type} @gol
503 -mbwx -mno-bwx -mcix -mno-cix -mmax -mno-max @gol
504 -mmemory-latency=@var{time}}
506 @emph{Clipper Options}
507 @gccoptlist{
508 -mc300  -mc400}
510 @emph{H8/300 Options}
511 @gccoptlist{
512 -mrelax  -mh -ms -mint32  -malign-300}
514 @emph{SH Options}
515 @gccoptlist{
516 -m1  -m2  -m3  -m3e @gol
517 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
518 -mb  -ml  -mdalign  -mrelax @gol
519 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
520 -misize  -mpadstruct  -mspace @gol
521 -mprefergot
522 -musermode}
524 @emph{System V Options}
525 @gccoptlist{
526 -Qy  -Qn  -YP\,@var{paths}  -Ym\,@var{dir}}
528 @emph{ARC Options}
529 @gccoptlist{
530 -EB  -EL @gol
531 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text section} @gol
532 -mdata=@var{data section}  -mrodata=@var{readonly data section}}
534 @emph{TMS320C3x/C4x Options}
535 @gccoptlist{
536 -mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
537 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
538 -mrpts=@var{count}  -mrptb -mdb -mloop-unsigned @gol
539 -mparallel-insns -mparallel-mpy -mpreserve-float}
541 @emph{V850 Options}
542 @gccoptlist{
543 -mlong-calls -mno-long-calls -mep -mno-ep @gol
544 -mprolog-function -mno-prolog-function -mspace @gol
545 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
546 -mv850 -mbig-switch}
548 @emph{NS32K Options}
549 @gccoptlist{
550 -m32032 -m32332 -m32532 -m32081 -m32381 -mmult-add -mnomult-add @gol
551 -msoft-float -mrtd -mnortd -mregparam -mnoregparam -msb -mnosb @gol
552 -mbitfield -mnobitfield -mhimem -mnohimem}
554 @emph{AVR Options}
555 @gccoptlist{
556 -mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
557 -mcall-prologues -mno-tablejump -mtiny-stack}
559 @emph{MCore Options}
560 @gccoptlist{
561 -mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates  @gol
562 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
563 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
564 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
565 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
567 @emph{IA-64 Options}
568 @gccoptlist{
569 -mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
570 -mvolatile-asm-stop -mb-step -mregister-names -mno-sdata @gol
571 -mconstant-gp -mauto-pic -minline-divide-min-latency @gol
572 -minline-divide-max-throughput -mno-dwarf2-asm @gol
573 -mfixed-range=@var{register range}}
575 @item Code Generation Options
576 @xref{Code Gen Options,,Options for Code Generation Conventions}.
577 @gccoptlist{
578 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
579 -fexceptions  -funwind-tables  -ffixed-@var{reg} @gol
580 -finhibit-size-directive  -finstrument-functions @gol
581 -fcheck-memory-usage  -fprefix-function-name @gol
582 -fno-common  -fno-ident  -fno-gnu-linker @gol
583 -fpcc-struct-return  -fpic  -fPIC @gol
584 -freg-struct-return  -fshared-data  -fshort-enums @gol
585 -fshort-double  -fvolatile  -fvolatile-global -fvolatile-static @gol
586 -fverbose-asm  -fpack-struct  -fstack-check @gol
587 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
588 -fargument-alias  -fargument-noalias @gol
589 -fargument-noalias-global @gol
590 -fleading-underscore}
591 @end table
593 @menu
594 * Overall Options::     Controlling the kind of output:
595                         an executable, object files, assembler files,
596                         or preprocessed source.
597 * C Dialect Options::   Controlling the variant of C language compiled.
598 * C++ Dialect Options:: Variations on C++.
599 * Language Independent Options:: Controlling how diagnostics should be
600                         formatted. 
601 * Warning Options::     How picky should the compiler be?
602 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
603 * Optimize Options::    How much optimization?
604 * Preprocessor Options:: Controlling header files and macro definitions.
605                          Also, getting dependency information for Make.
606 * Assembler Options::   Passing options to the assembler.
607 * Link Options::        Specifying libraries and so on.
608 * Directory Options::   Where to find header files and libraries.
609                         Where to find the compiler executable files.
610 * Spec Files::          How to pass switches to sub-processes.
611 * Target Options::      Running a cross-compiler, or an old version of GCC.
612 @end menu
614 @node Overall Options
615 @section Options Controlling the Kind of Output
617 Compilation can involve up to four stages: preprocessing, compilation
618 proper, assembly and linking, always in that order.  The first three
619 stages apply to an individual source file, and end by producing an
620 object file; linking combines all the object files (those newly
621 compiled, and those specified as input) into an executable file.
623 @cindex file name suffix
624 For any given input file, the file name suffix determines what kind of
625 compilation is done:
627 @table @gcctabopt
628 @item @var{file}.c
629 C source code which must be preprocessed.
631 @item @var{file}.i
632 C source code which should not be preprocessed.
634 @item @var{file}.ii
635 C++ source code which should not be preprocessed.
637 @item @var{file}.m
638 Objective-C source code.  Note that you must link with the library
639 @file{libobjc.a} to make an Objective-C program work.
641 @item @var{file}.mi
642 Objective-C source code which should not be preprocessed.
644 @item @var{file}.h
645 C header file (not to be compiled or linked).
647 @item @var{file}.cc
648 @itemx @var{file}.cp
649 @itemx @var{file}.cxx
650 @itemx @var{file}.cpp
651 @itemx @var{file}.c++
652 @itemx @var{file}.C
653 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
654 the last two letters must both be literally @samp{x}.  Likewise,
655 @samp{.C} refers to a literal capital C.
657 @item @var{file}.f
658 @itemx @var{file}.for
659 @itemx @var{file}.FOR
660 Fortran source code which should not be preprocessed.
662 @item @var{file}.F
663 @itemx @var{file}.fpp
664 @itemx @var{file}.FPP
665 Fortran source code which must be preprocessed (with the traditional
666 preprocessor).
668 @item @var{file}.r
669 Fortran source code which must be preprocessed with a RATFOR
670 preprocessor (not included with GCC).
672 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
673 Using and Porting GNU Fortran}, for more details of the handling of
674 Fortran input files.
676 @c FIXME: Descriptions of Java file types.
677 @c @var{file}.java
678 @c @var{file}.class
679 @c @var{file}.zip
680 @c @var{file}.jar
682 @c GCC also knows about some suffixes for languages not yet included:
683 @c Ada:
684 @c @var{file}.ads
685 @c @var{file}.adb
686 @c @var{file}.ada
687 @c Pascal:
688 @c @var{file}.p
689 @c @var{file}.pas
691 @item @var{file}.ch
692 @itemx @var{file}.chi
693 CHILL source code (preprocessed with the traditional preprocessor).
695 @item @var{file}.s
696 Assembler code.
698 @item @var{file}.S
699 Assembler code which must be preprocessed.
701 @item @var{other}
702 An object file to be fed straight into linking.
703 Any file name with no recognized suffix is treated this way.
704 @end table
706 You can specify the input language explicitly with the @samp{-x} option:
708 @table @gcctabopt
709 @item -x @var{language}
710 Specify explicitly the @var{language} for the following input files
711 (rather than letting the compiler choose a default based on the file
712 name suffix).  This option applies to all following input files until
713 the next @samp{-x} option.  Possible values for @var{language} are:
714 @example
715 c  c-header  cpp-output
716 c++  c++-cpp-output
717 objective-c  objc-cpp-output
718 assembler  assembler-with-cpp
719 f77  f77-cpp-input  ratfor
720 java  chill
721 @end example
722 @c Also f77-version, for internal use only.
724 @item -x none
725 Turn off any specification of a language, so that subsequent files are
726 handled according to their file name suffixes (as they are if @samp{-x}
727 has not been used at all).
729 @item -pass-exit-codes
730 Normally the @command{gcc} program will exit with the code of 1 if any
731 phase of the compiler returns a non-success return code.  If you specify
732 @samp{-pass-exit-codes}, the @command{gcc} program will instead return with
733 numerically highest error produced by any phase that returned an error
734 indication.
735 @end table
737 If you only want some of the stages of compilation, you can use
738 @samp{-x} (or filename suffixes) to tell @command{gcc} where to start, and
739 one of the options @samp{-c}, @samp{-S}, or @samp{-E} to say where
740 @command{gcc} is to stop.  Note that some combinations (for example,
741 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
743 @table @gcctabopt
744 @item -c
745 Compile or assemble the source files, but do not link.  The linking
746 stage simply is not done.  The ultimate output is in the form of an
747 object file for each source file.
749 By default, the object file name for a source file is made by replacing
750 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
752 Unrecognized input files, not requiring compilation or assembly, are
753 ignored.
755 @item -S
756 Stop after the stage of compilation proper; do not assemble.  The output
757 is in the form of an assembler code file for each non-assembler input
758 file specified.
760 By default, the assembler file name for a source file is made by
761 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
763 Input files that don't require compilation are ignored.
765 @item -E
766 Stop after the preprocessing stage; do not run the compiler proper.  The
767 output is in the form of preprocessed source code, which is sent to the
768 standard output.
770 Input files which don't require preprocessing are ignored.
772 @cindex output file option
773 @item -o @var{file}
774 Place output in file @var{file}.  This applies regardless to whatever
775 sort of output is being produced, whether it be an executable file,
776 an object file, an assembler file or preprocessed C code.
778 Since only one output file can be specified, it does not make sense to
779 use @samp{-o} when compiling more than one input file, unless you are
780 producing an executable file as output.
782 If @samp{-o} is not specified, the default is to put an executable file
783 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
784 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
785 all preprocessed C source on standard output.@refill
787 @item -v
788 Print (on standard error output) the commands executed to run the stages
789 of compilation.  Also print the version number of the compiler driver
790 program and of the preprocessor and the compiler proper.
792 @item -pipe
793 Use pipes rather than temporary files for communication between the
794 various stages of compilation.  This fails to work on some systems where
795 the assembler is unable to read from a pipe; but the GNU assembler has
796 no trouble.
798 @item --help
799 Print (on the standard output) a description of the command line options
800 understood by @command{gcc}.  If the @option{-v} option is also specified
801 then @option{--help} will also be passed on to the various processes
802 invoked by @command{gcc}, so that they can display the command line options
803 they accept.  If the @option{-W} option is also specified then command
804 line options which have no documentation associated with them will also
805 be displayed.
807 @item --target-help
808 Print (on the standard output) a description of target specific command
809 line options for each tool.
810 @end table
812 @node Invoking G++
813 @section Compiling C++ Programs
815 @cindex suffixes for C++ source
816 @cindex C++ source file suffixes
817 C++ source files conventionally use one of the suffixes @samp{.C},
818 @samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
819 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
820 files with these names and compiles them as C++ programs even if you
821 call the compiler the same way as for compiling C programs (usually with
822 the name @command{gcc}).
824 @findex g++
825 @findex c++
826 However, C++ programs often require class libraries as well as a
827 compiler that understands the C++ language---and under some
828 circumstances, you might want to compile programs from standard input,
829 or otherwise without a suffix that flags them as C++ programs.
830 @command{g++} is a program that calls GCC with the default language
831 set to C++, and automatically specifies linking against the C++
832 library.  On many systems, @command{g++} is also
833 installed with the name @command{c++}.
835 @cindex invoking @command{g++}
836 When you compile C++ programs, you may specify many of the same
837 command-line options that you use for compiling programs in any
838 language; or command-line options meaningful for C and related
839 languages; or options that are meaningful only for C++ programs.
840 @xref{C Dialect Options,,Options Controlling C Dialect}, for
841 explanations of options for languages related to C.
842 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
843 explanations of options that are meaningful only for C++ programs.
845 @node C Dialect Options
846 @section Options Controlling C Dialect
847 @cindex dialect options
848 @cindex language dialect options
849 @cindex options, dialect
851 The following options control the dialect of C (or languages derived
852 from C, such as C++ and Objective C) that the compiler accepts:
854 @table @gcctabopt
855 @cindex ANSI support
856 @cindex ISO support
857 @item -ansi
858 In C mode, support all ISO C89 programs.  In C++ mode,
859 remove GNU extensions that conflict with ISO C++.
861 This turns off certain features of GCC that are incompatible with ISO
862 C (when compiling C code), or of standard C++ (when compiling C++ code),
863 such as the @code{asm} and @code{typeof} keywords, and
864 predefined macros such as @code{unix} and @code{vax} that identify the
865 type of system you are using.  It also enables the undesirable and
866 rarely used ISO trigraph feature.  For the C compiler, 
867 it disables recognition of C++ style @samp{//} comments as well as
868 the @code{inline} keyword.
870 The alternate keywords @code{__asm__}, @code{__extension__},
871 @code{__inline__} and @code{__typeof__} continue to work despite
872 @samp{-ansi}.  You would not want to use them in an ISO C program, of
873 course, but it is useful to put them in header files that might be included
874 in compilations done with @samp{-ansi}.  Alternate predefined macros
875 such as @code{__unix__} and @code{__vax__} are also available, with or
876 without @samp{-ansi}.
878 The @samp{-ansi} option does not cause non-ISO programs to be
879 rejected gratuitously.  For that, @samp{-pedantic} is required in
880 addition to @samp{-ansi}.  @xref{Warning Options}.
882 The macro @code{__STRICT_ANSI__} is predefined when the @samp{-ansi}
883 option is used.  Some header files may notice this macro and refrain
884 from declaring certain functions or defining certain macros that the
885 ISO standard doesn't call for; this is to avoid interfering with any
886 programs that might use these names for other things.
888 Functions which would normally be builtin but do not have semantics
889 defined by ISO C (such as @code{alloca} and @code{ffs}) are not builtin
890 functions with @samp{-ansi} is used.  @xref{Other Builtins,,Other
891 built-in functions provided by GNU CC}, for details of the functions
892 affected.
894 @item -std=
895 Determine the language standard.  A value for this option must be provided;
896 possible values are 
898 @table @samp
899 @item iso9899:1990
900 Same as @option{-ansi}
902 @item iso9899:199409
903 ISO C as modified in amend. 1
905 @item iso9899:1999
906 ISO C99.  Note that this standard is not yet fully supported; see
907 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.
909 @item c89
910 same as @option{-std=iso9899:1990}
912 @item c99
913 same as @option{-std=iso9899:1999}
915 @item gnu89
916 default, iso9899:1990 + gnu extensions
918 @item gnu99
919 iso9899:1999 + gnu extensions
921 @item iso9899:199x
922 same as @option{-std=iso9899:1999}, deprecated
924 @item c9x
925 same as @option{-std=iso9899:1999}, deprecated
927 @item gnu9x
928 same as @option{-std=gnu99}, deprecated
930 @end table
932 Even when this option is not specified, you can still use some of the
933 features of newer standards in so far as they do not conflict with
934 previous C standards.  For example, you may use @code{__restrict__} even
935 when @option{-std=c99} is not specified.
937 The @option{-std} options specifying some version of ISO C have the same
938 effects as @option{-ansi}, except that features that were not in ISO C89
939 but are in the specified version (for example, @samp{//} comments and
940 the @code{inline} keyword in ISO C99) are not disabled.
942 @xref{Standards,,Language Standards Supported by GCC}, for details of
943 these standard versions.
945 @item -fno-asm
946 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
947 keyword, so that code can use these words as identifiers.  You can use
948 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
949 instead.  @samp{-ansi} implies @samp{-fno-asm}.
951 In C++, this switch only affects the @code{typeof} keyword, since
952 @code{asm} and @code{inline} are standard keywords.  You may want to
953 use the @samp{-fno-gnu-keywords} flag instead, which has the same
954 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
955 switch only affects the @code{asm} and @code{typeof} keywords, since
956 @code{inline} is a standard keyword in ISO C99.
958 @item -fno-builtin
959 @cindex builtin functions
960 Don't recognize builtin functions that do not begin with
961 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
962 functions provided by GNU CC}, for details of the functions affected,
963 including those which are not builtin functions when @option{-ansi} or
964 @option{-std} options for strict ISO C conformance are used because they
965 do not have an ISO standard meaning.
967 GCC normally generates special code to handle certain builtin functions
968 more efficiently; for instance, calls to @code{alloca} may become single
969 instructions that adjust the stack directly, and calls to @code{memcpy}
970 may become inline copy loops.  The resulting code is often both smaller
971 and faster, but since the function calls no longer appear as such, you
972 cannot set a breakpoint on those calls, nor can you change the behavior
973 of the functions by linking with a different library.
975 @item -fhosted
976 @cindex hosted environment
978 Assert that compilation takes place in a hosted environment.  This implies
979 @samp{-fbuiltin}.  A hosted environment is one in which the
980 entire standard library is available, and in which @code{main} has a return
981 type of @code{int}.  Examples are nearly everything except a kernel.
982 This is equivalent to @samp{-fno-freestanding}.
984 @item -ffreestanding
985 @cindex hosted environment
987 Assert that compilation takes place in a freestanding environment.  This
988 implies @samp{-fno-builtin}.  A freestanding environment
989 is one in which the standard library may not exist, and program startup may
990 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
991 This is equivalent to @samp{-fno-hosted}.
993 @xref{Standards,,Language Standards Supported by GCC}, for details of
994 freestanding and hosted environments.
996 @item -trigraphs
997 Support ISO C trigraphs.  You don't want to know about this
998 brain-damage.  The @option{-ansi} option (and @option{-std} options for
999 strict ISO C conformance) implies @option{-trigraphs}.
1001 @cindex traditional C language
1002 @cindex C language, traditional
1003 @item -traditional
1004 Attempt to support some aspects of traditional C compilers.
1005 Specifically:
1007 @itemize @bullet
1008 @item
1009 All @code{extern} declarations take effect globally even if they
1010 are written inside of a function definition.  This includes implicit
1011 declarations of functions.
1013 @item
1014 The newer keywords @code{typeof}, @code{inline}, @code{signed}, @code{const}
1015 and @code{volatile} are not recognized.  (You can still use the
1016 alternative keywords such as @code{__typeof__}, @code{__inline__}, and
1017 so on.)
1019 @item
1020 Comparisons between pointers and integers are always allowed.
1022 @item
1023 Integer types @code{unsigned short} and @code{unsigned char} promote
1024 to @code{unsigned int}.
1026 @item
1027 Out-of-range floating point literals are not an error.
1029 @item
1030 Certain constructs which ISO regards as a single invalid preprocessing
1031 number, such as @samp{0xe-0xd}, are treated as expressions instead.
1033 @item
1034 String ``constants'' are not necessarily constant; they are stored in
1035 writable space, and identical looking constants are allocated
1036 separately.  (This is the same as the effect of
1037 @samp{-fwritable-strings}.)
1039 @cindex @code{longjmp} and automatic variables
1040 @item
1041 All automatic variables not declared @code{register} are preserved by
1042 @code{longjmp}.  Ordinarily, GNU C follows ISO C: automatic variables
1043 not declared @code{volatile} may be clobbered.
1045 @item
1046 @kindex \x
1047 @kindex \a
1048 @cindex escape sequences, traditional
1049 The character escape sequences @samp{\x} and @samp{\a} evaluate as the
1050 literal characters @samp{x} and @samp{a} respectively.  Without
1051 @w{@samp{-traditional}}, @samp{\x} is a prefix for the hexadecimal
1052 representation of a character, and @samp{\a} produces a bell.
1053 @end itemize
1055 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
1056 if your program uses names that are normally GNU C builtin functions for
1057 other purposes of its own.
1059 You cannot use @samp{-traditional} if you include any header files that
1060 rely on ISO C features.  Some vendors are starting to ship systems with
1061 ISO C header files and you cannot use @samp{-traditional} on such
1062 systems to compile files that include any system headers.
1064 The @samp{-traditional} option also enables @samp{-traditional-cpp},
1065 which is described next.
1067 @item -traditional-cpp
1068 Attempt to support some aspects of traditional C preprocessors.
1069 Specifically:
1071 @itemize @bullet
1072 @item
1073 Comments convert to nothing at all, rather than to a space.  This allows
1074 traditional token concatenation.
1076 @item
1077 In a preprocessing directive, the @samp{#} symbol must appear as the first
1078 character of a line.
1080 @item
1081 Macro arguments are recognized within string constants in a macro
1082 definition (and their values are stringified, though without additional
1083 quote marks, when they appear in such a context).  The preprocessor
1084 always considers a string constant to end at a newline.
1086 @item
1087 @cindex detecting @w{@samp{-traditional}}
1088 The predefined macro @code{__STDC__} is not defined when you use
1089 @samp{-traditional}, but @code{__GNUC__} is (since the GNU extensions
1090 which @code{__GNUC__} indicates are not affected by
1091 @samp{-traditional}).  If you need to write header files that work
1092 differently depending on whether @samp{-traditional} is in use, by
1093 testing both of these predefined macros you can distinguish four
1094 situations: GNU C, traditional GNU C, other ISO C compilers, and other
1095 old C compilers.  The predefined macro @code{__STDC_VERSION__} is also
1096 not defined when you use @samp{-traditional}.  @xref{Standard
1097 Predefined,,Standard Predefined Macros,cpp.info,The C Preprocessor},
1098 for more discussion of these and other predefined macros.
1100 @item
1101 @cindex string constants vs newline
1102 @cindex newline vs string constants
1103 The preprocessor considers a string constant to end at a newline (unless
1104 the newline is escaped with @samp{\}).  (Without @w{@samp{-traditional}},
1105 string constants can contain the newline character as typed.)
1106 @end itemize
1108 @item -fcond-mismatch
1109 Allow conditional expressions with mismatched types in the second and
1110 third arguments.  The value of such an expression is void.  This option
1111 is not supported for C++.
1113 @item -funsigned-char
1114 Let the type @code{char} be unsigned, like @code{unsigned char}.
1116 Each kind of machine has a default for what @code{char} should
1117 be.  It is either like @code{unsigned char} by default or like
1118 @code{signed char} by default.
1120 Ideally, a portable program should always use @code{signed char} or
1121 @code{unsigned char} when it depends on the signedness of an object.
1122 But many programs have been written to use plain @code{char} and
1123 expect it to be signed, or expect it to be unsigned, depending on the
1124 machines they were written for.  This option, and its inverse, let you
1125 make such a program work with the opposite default.
1127 The type @code{char} is always a distinct type from each of
1128 @code{signed char} or @code{unsigned char}, even though its behavior
1129 is always just like one of those two.
1131 @item -fsigned-char
1132 Let the type @code{char} be signed, like @code{signed char}.
1134 Note that this is equivalent to @samp{-fno-unsigned-char}, which is
1135 the negative form of @samp{-funsigned-char}.  Likewise, the option
1136 @samp{-fno-signed-char} is equivalent to @samp{-funsigned-char}.
1138 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
1139 if your program uses names that are normally GNU C builtin functions for
1140 other purposes of its own.
1142 You cannot use @samp{-traditional} if you include any header files that
1143 rely on ISO C features.  Some vendors are starting to ship systems with
1144 ISO C header files and you cannot use @samp{-traditional} on such
1145 systems to compile files that include any system headers.
1147 @item -fsigned-bitfields
1148 @itemx -funsigned-bitfields
1149 @itemx -fno-signed-bitfields
1150 @itemx -fno-unsigned-bitfields
1151 These options control whether a bitfield is signed or unsigned, when the
1152 declaration does not use either @code{signed} or @code{unsigned}.  By
1153 default, such a bitfield is signed, because this is consistent: the
1154 basic integer types such as @code{int} are signed types.
1156 However, when @samp{-traditional} is used, bitfields are all unsigned
1157 no matter what.
1159 @item -fwritable-strings
1160 Store string constants in the writable data segment and don't uniquize
1161 them.  This is for compatibility with old programs which assume they can
1162 write into string constants.  The option @samp{-traditional} also has
1163 this effect.
1165 Writing into string constants is a very bad idea; ``constants'' should
1166 be constant.
1168 @item -fallow-single-precision
1169 Do not promote single precision math operations to double precision,
1170 even when compiling with @samp{-traditional}.
1172 Traditional K&R C promotes all floating point operations to double
1173 precision, regardless of the sizes of the operands.   On the
1174 architecture for which you are compiling, single precision may be faster
1175 than double precision.   If you must use @samp{-traditional}, but want
1176 to use single precision operations when the operands are single
1177 precision, use this option.   This option has no effect when compiling
1178 with ISO or GNU C conventions (the default).
1180 @item -fshort-wchar
1181 Override the underlying type for @samp{wchar_t} to be @samp{short
1182 unsigned int} instead of the default for the target.  This option is
1183 useful for building programs to run under WINE.
1184 @end table
1186 @node C++ Dialect Options
1187 @section Options Controlling C++ Dialect
1189 @cindex compiler options, C++
1190 @cindex C++ options, command line
1191 @cindex options, C++
1192 This section describes the command-line options that are only meaningful
1193 for C++ programs; but you can also use most of the GNU compiler options
1194 regardless of what language your program is in.  For example, you
1195 might compile a file @code{firstClass.C} like this:
1197 @example
1198 g++ -g -frepo -O -c firstClass.C
1199 @end example
1201 @noindent
1202 In this example, only @samp{-frepo} is an option meant
1203 only for C++ programs; you can use the other options with any
1204 language supported by GCC.
1206 Here is a list of options that are @emph{only} for compiling C++ programs:
1208 @table @gcctabopt
1209 @item -fno-access-control
1210 Turn off all access checking.  This switch is mainly useful for working
1211 around bugs in the access control code.
1213 @item -fcheck-new
1214 Check that the pointer returned by @code{operator new} is non-null
1215 before attempting to modify the storage allocated.  The current Working
1216 Paper requires that @code{operator new} never return a null pointer, so
1217 this check is normally unnecessary.
1219 An alternative to using this option is to specify that your
1220 @code{operator new} does not throw any exceptions; if you declare it
1221 @samp{throw()}, g++ will check the return value.  See also @samp{new
1222 (nothrow)}.
1224 @item -fconserve-space
1225 Put uninitialized or runtime-initialized global variables into the
1226 common segment, as C does.  This saves space in the executable at the
1227 cost of not diagnosing duplicate definitions.  If you compile with this
1228 flag and your program mysteriously crashes after @code{main()} has
1229 completed, you may have an object that is being destroyed twice because
1230 two definitions were merged.
1232 This option is no longer useful on most targets, now that support has
1233 been added for putting variables into BSS without making them common.
1235 @item -fdollars-in-identifiers
1236 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1237 @samp{$} with the option @samp{-fno-dollars-in-identifiers}.  (GNU C allows
1238 @samp{$} by default on most target systems, but there are a few exceptions.)
1239 Traditional C allowed the character @samp{$} to form part of
1240 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1242 @item -fno-elide-constructors
1243 The C++ standard allows an implementation to omit creating a temporary
1244 which is only used to initialize another object of the same type.
1245 Specifying this option disables that optimization, and forces g++ to
1246 call the copy constructor in all cases.
1248 @item -fno-enforce-eh-specs
1249 Don't check for violation of exception specifications at runtime.  This
1250 option violates the C++ standard, but may be useful for reducing code
1251 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1252 will still optimize based on the exception specifications.
1254 @item -fexternal-templates
1255 Cause template instantiations to obey @samp{#pragma interface} and
1256 @samp{implementation}; template instances are emitted or not according
1257 to the location of the template definition.  @xref{Template
1258 Instantiation}, for more information.
1260 This option is deprecated.
1262 @item -falt-external-templates
1263 Similar to -fexternal-templates, but template instances are emitted or
1264 not according to the place where they are first instantiated.
1265 @xref{Template Instantiation}, for more information.
1267 This option is deprecated.
1269 @item -ffor-scope
1270 @itemx -fno-for-scope
1271 If -ffor-scope is specified, the scope of variables declared in
1272 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1273 as specified by the C++ standard.
1274 If -fno-for-scope is specified, the scope of variables declared in
1275 a @i{for-init-statement} extends to the end of the enclosing scope,
1276 as was the case in old versions of gcc, and other (traditional)
1277 implementations of C++.
1279 The default if neither flag is given to follow the standard,
1280 but to allow and give a warning for old-style code that would
1281 otherwise be invalid, or have different behavior.
1283 @item -fno-gnu-keywords
1284 Do not recognize @code{typeof} as a keyword, so that code can use this
1285 word as an identifier. You can use the keyword @code{__typeof__} instead.  
1286 @samp{-ansi} implies @samp{-fno-gnu-keywords}.
1288 @item -fhonor-std
1289 Treat the @code{namespace std} as a namespace, instead of ignoring
1290 it. For compatibility with earlier versions of g++, the compiler will,
1291 by default, ignore @code{namespace-declarations},
1292 @code{using-declarations}, @code{using-directives}, and
1293 @code{namespace-names}, if they involve @code{std}.
1295 @item -fhuge-objects
1296 Support virtual function calls for objects that exceed the size
1297 representable by a @samp{short int}.  Users should not use this flag by
1298 default; if you need to use it, the compiler will tell you so.
1300 This flag is not useful when compiling with -fvtable-thunks.
1302 Like all options that change the ABI, all C++ code, @emph{including
1303 libgcc} must be built with the same setting of this option.
1305 @item -fno-implicit-templates
1306 Never emit code for non-inline templates which are instantiated
1307 implicitly (i.e. by use); only emit code for explicit instantiations.
1308 @xref{Template Instantiation}, for more information.
1310 @item -fno-implicit-inline-templates
1311 Don't emit code for implicit instantiations of inline templates, either.
1312 The default is to handle inlines differently so that compiles with and
1313 without optimization will need the same set of explicit instantiations.
1315 @item -fno-implement-inlines
1316 To save space, do not emit out-of-line copies of inline functions
1317 controlled by @samp{#pragma implementation}.  This will cause linker
1318 errors if these functions are not inlined everywhere they are called.
1320 @item -fms-extensions
1321 Disable pedantic warnings about constructs used in MFC, such as implicit
1322 int and getting a pointer to member function via non-standard syntax.
1324 @item -fno-operator-names
1325 Do not treat the operator name keywords @code{and}, @code{bitand},
1326 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1327 synonyms as keywords.
1329 @item -fno-optional-diags
1330 Disable diagnostics that the standard says a compiler does not need to
1331 issue.  Currently, the only such diagnostic issued by g++ is the one for
1332 a name having multiple meanings within a class.
1334 @item -fpermissive
1335 Downgrade messages about nonconformant code from errors to warnings.  By
1336 default, g++ effectively sets @samp{-pedantic-errors} without
1337 @samp{-pedantic}; this option reverses that.  This behavior and this
1338 option are superseded by @samp{-pedantic}, which works as it does for GNU C.
1340 @item -frepo
1341 Enable automatic template instantiation.  This option also implies
1342 @samp{-fno-implicit-templates}.  @xref{Template Instantiation}, for more
1343 information.
1345 @item -fno-rtti
1346 Disable generation of information about every class with virtual
1347 functions for use by the C++ runtime type identification features
1348 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1349 of the language, you can save some space by using this flag.  Note that
1350 exception handling uses the same information, but it will generate it as
1351 needed.
1353 @item -ftemplate-depth-@var{n}
1354 Set the maximum instantiation depth for template classes to @var{n}.
1355 A limit on the template instantiation depth is needed to detect
1356 endless recursions during template class instantiation. ANSI/ISO C++
1357 conforming programs must not rely on a maximum depth greater than 17.
1359 @item -fuse-cxa-atexit
1360 Register destructors for objects with static storage duration with the
1361 @code{__cxa_atexit} function rather than the @code{atexit} function.
1362 This option is required for fully standards-compliant handling of static
1363 destructors, but will only work if your C library supports
1364 @code{__cxa_atexit}.
1366 @item -fvtable-thunks
1367 Use @samp{thunks} to implement the virtual function dispatch table
1368 (@samp{vtable}).  The traditional (cfront-style) approach to
1369 implementing vtables was to store a pointer to the function and two
1370 offsets for adjusting the @samp{this} pointer at the call site.  Newer
1371 implementations store a single pointer to a @samp{thunk} function which
1372 does any necessary adjustment and then calls the target function.
1374 This option also enables a heuristic for controlling emission of
1375 vtables; if a class has any non-inline virtual functions, the vtable
1376 will be emitted in the translation unit containing the first one of
1377 those.
1379 Like all options that change the ABI, all C++ code, @emph{including
1380 libgcc.a} must be built with the same setting of this option.
1382 @item -nostdinc++
1383 Do not search for header files in the standard directories specific to
1384 C++, but do still search the other standard directories.  (This option
1385 is used when building the C++ library.)
1386 @end table
1388 In addition, these optimization, warning, and code generation options
1389 have meanings only for C++ programs:
1391 @table @gcctabopt
1392 @item -fno-default-inline
1393 Do not assume @samp{inline} for functions defined inside a class scope.
1394 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1395 functions will have linkage like inline functions; they just won't be
1396 inlined by default.
1398 @item -Wctor-dtor-privacy (C++ only)
1399 Warn when a class seems unusable, because all the constructors or
1400 destructors in a class are private and the class has no friends or
1401 public static member functions.
1403 @item -Wnon-virtual-dtor (C++ only)
1404 Warn when a class declares a non-virtual destructor that should probably
1405 be virtual, because it looks like the class will be used polymorphically.
1407 @item -Wreorder (C++ only)
1408 @cindex reordering, warning
1409 @cindex warning for reordering of member initializers
1410 Warn when the order of member initializers given in the code does not
1411 match the order in which they must be executed.  For instance:
1413 @smallexample
1414 struct A @{
1415   int i;
1416   int j;
1417   A(): j (0), i (1) @{ @}
1419 @end smallexample
1421 Here the compiler will warn that the member initializers for @samp{i}
1422 and @samp{j} will be rearranged to match the declaration order of the
1423 members.
1424 @end table
1426 The following @samp{-W@dots{}} options are not affected by @samp{-Wall}.
1428 @table @gcctabopt
1429 @item -Weffc++ (C++ only)
1430 Warn about violations of various style guidelines from Scott Meyers'
1431 @cite{Effective C++} books.  If you use this option, you should be aware
1432 that the standard library headers do not obey all of these guidelines;
1433 you can use @samp{grep -v} to filter out those warnings.
1435 @item -Wno-deprecated (C++ only)
1436 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1438 @item -Wno-non-template-friend (C++ only)
1439 Disable warnings when non-templatized friend functions are declared
1440 within a template. With the advent of explicit template specification
1441 support in g++, if the name of the friend is an unqualified-id (ie,
1442 @samp{friend foo(int)}), the C++ language specification demands that the
1443 friend declare or define an ordinary, nontemplate function. (Section
1444 14.5.3). Before g++ implemented explicit specification, unqualified-ids
1445 could be interpreted as a particular specialization of a templatized
1446 function. Because this non-conforming behavior is no longer the default
1447 behavior for g++, @samp{-Wnon-template-friend} allows the compiler to
1448 check existing code for potential trouble spots, and is on by default.
1449 This new compiler behavior can be turned off with
1450 @samp{-Wno-non-template-friend} which keeps the conformant compiler code
1451 but disables the helpful warning.
1453 @item -Wold-style-cast (C++ only)
1454 Warn if an old-style (C-style) cast is used within a C++ program.  The
1455 new-style casts (@samp{static_cast}, @samp{reinterpret_cast}, and
1456 @samp{const_cast}) are less vulnerable to unintended effects.
1458 @item -Woverloaded-virtual (C++ only)
1459 @cindex overloaded virtual fn, warning
1460 @cindex warning for overloaded virtual fn
1461 Warn when a function declaration hides virtual functions from a
1462 base class.  For example, in:
1464 @smallexample
1465 struct A @{
1466   virtual void f();
1469 struct B: public A @{
1470   void f(int);
1472 @end smallexample
1474 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1475 like this:
1477 @smallexample
1478 B* b;
1479 b->f();
1480 @end smallexample
1482 will fail to compile.
1484 @item -Wno-pmf-conversions (C++ only)
1485 Disable the diagnostic for converting a bound pointer to member function
1486 to a plain pointer.
1488 @item -Wsign-promo (C++ only)
1489 Warn when overload resolution chooses a promotion from unsigned or
1490 enumeral type to a signed type over a conversion to an unsigned type of
1491 the same size.  Previous versions of g++ would try to preserve
1492 unsignedness, but the standard mandates the current behavior.
1494 @item -Wsynth (C++ only)
1495 @cindex warning for synthesized methods
1496 @cindex synthesized methods, warning
1497 Warn when g++'s synthesis behavior does not match that of cfront.  For
1498 instance:
1500 @smallexample
1501 struct A @{
1502   operator int ();
1503   A& operator = (int);
1506 main ()
1508   A a,b;
1509   a = b;
1511 @end smallexample
1513 In this example, g++ will synthesize a default @samp{A& operator =
1514 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1515 @end table
1517 @node Language Independent Options
1518 @section Options to Control Diagnostic Messages Formatting
1519 @cindex options to control diagnostics formatting
1520 @cindex diagnostic messages
1521 @cindex message formatting
1523 Traditionally, diagnostic messages have been formatted irrespective of
1524 the output device's aspect (e.g. its width, ...).  The options described
1525 below can be used to control the diagnostic messages formatting
1526 algorithm, e.g. how many characters per line, how often source location
1527 information should be reported.  Right now, only the C++ front-end can
1528 honor these options.  However it is expected, in the near future, that
1529 the remaining front-ends would be able to digest them correctly. 
1531 @table @gcctabopt
1532 @item -fmessage-length=@var{n}
1533 Try to format error messages so that they fit on lines of about @var{n}
1534 characters.  The default is 72 characters for g++ and 0 for the rest of
1535 the front-ends supported by GCC.  If @var{n} is zero, then no
1536 line-wrapping will be done; each error message will appear on a single 
1537 line.
1539 @item -fdiagnostics-show-location=once
1540 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1541 reporter to emit @emph{once} source location information; that is, in
1542 case the message is too long to fit on a single physical line and has to
1543 be wrapped, the source location won't be emitted (as prefix) again,
1544 over and over, in subsequent continuation lines.  This is the default
1545 behaviour. 
1547 @item -fdiagnostics-show-location=every-line
1548 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1549 messages reporter to emit the same source location information (as
1550 prefix) for physical lines that result from the process of breaking a
1551 a message which is too long to fit on a single line.
1553 @end table
1555 @node Warning Options
1556 @section Options to Request or Suppress Warnings
1557 @cindex options to control warnings
1558 @cindex warning messages
1559 @cindex messages, warning
1560 @cindex suppressing warnings
1562 Warnings are diagnostic messages that report constructions which
1563 are not inherently erroneous but which are risky or suggest there
1564 may have been an error.
1566 You can request many specific warnings with options beginning @samp{-W},
1567 for example @samp{-Wimplicit} to request warnings on implicit
1568 declarations.  Each of these specific warning options also has a
1569 negative form beginning @samp{-Wno-} to turn off warnings;
1570 for example, @samp{-Wno-implicit}.  This manual lists only one of the
1571 two forms, whichever is not the default.
1573 These options control the amount and kinds of warnings produced by GCC:
1575 @table @gcctabopt
1576 @cindex syntax checking
1577 @item -fsyntax-only
1578 Check the code for syntax errors, but don't do anything beyond that.
1580 @item -pedantic
1581 Issue all the warnings demanded by strict ISO C and ISO C++;
1582 reject all programs that use forbidden extensions, and some other
1583 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1584 version of the ISO C standard specified by any @samp{-std} option used.
1586 Valid ISO C and ISO C++ programs should compile properly with or without
1587 this option (though a rare few will require @option{-ansi} or a
1588 @option{-std} option specifying the required version of ISO C).  However,
1589 without this option, certain GNU extensions and traditional C and C++
1590 features are supported as well.  With this option, they are rejected.
1592 @samp{-pedantic} does not cause warning messages for use of the
1593 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1594 warnings are also disabled in the expression that follows
1595 @code{__extension__}.  However, only system header files should use
1596 these escape routes; application programs should avoid them.
1597 @xref{Alternate Keywords}.
1599 Some users try to use @samp{-pedantic} to check programs for strict ISO
1600 C conformance.  They soon find that it does not do quite what they want:
1601 it finds some non-ISO practices, but not all---only those for which
1602 ISO C @emph{requires} a diagnostic, and some others for which
1603 diagnostics have been added.
1605 A feature to report any failure to conform to ISO C might be useful in
1606 some instances, but would require considerable additional work and would
1607 be quite different from @samp{-pedantic}.  We don't have plans to
1608 support such a feature in the near future.
1610 @item -pedantic-errors
1611 Like @samp{-pedantic}, except that errors are produced rather than
1612 warnings.
1614 @item -w
1615 Inhibit all warning messages.
1617 @item -Wno-import
1618 Inhibit warning messages about the use of @samp{#import}.
1620 @item -Wchar-subscripts
1621 Warn if an array subscript has type @code{char}.  This is a common cause
1622 of error, as programmers often forget that this type is signed on some
1623 machines.
1625 @item -Wcomment
1626 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1627 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1629 @item -Wformat
1630 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1631 the arguments supplied have types appropriate to the format string
1632 specified, and that the conversions specified in the format string make
1633 sense.  This includes standard functions, and others specified by format
1634 attributes (@pxref{Function Attributes}), in the @code{printf},
1635 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1636 not in the C standard) families.
1638 The formats are checked against the format features supported by GNU
1639 libc version 2.2.  These include all ISO C89 and C99 features, as well
1640 as features from the Single Unix Specification and some BSD and GNU
1641 extensions.  Other library implementations may not support all these
1642 features; GCC does not support warning about features that go beyond a
1643 particular library's limitations.  However, if @samp{-pedantic} is used
1644 with @samp{-Wformat}, warnings will be given about format features not
1645 in the selected standard version (but not for @code{strfmon} formats,
1646 since those are not in any version of the C standard).  @xref{C Dialect
1647 Options,,Options Controlling C Dialect}.
1649 @samp{-Wformat} is included in @samp{-Wall}.  For more control over some
1650 aspects of format checking, the options @samp{-Wno-format-y2k},
1651 @samp{-Wno-format-extra-args}, @samp{-Wformat-nonliteral},
1652 @samp{-Wformat-security} and @samp{-Wformat=2} are available, but are
1653 not included in @samp{-Wall}.
1655 @item -Wno-format-y2k
1656 If @samp{-Wformat} is specified, do not warn about @code{strftime}
1657 formats which may yield only a two-digit year.
1659 @item -Wno-format-extra-args
1660 If @samp{-Wformat} is specified, do not warn about excess arguments to a
1661 @code{printf} or @code{scanf} format function.  The C standard specifies
1662 that such arguments are ignored.
1664 @item -Wformat-nonliteral
1665 If @samp{-Wformat} is specified, also warn if the format string is not a
1666 string literal and so cannot be checked, unless the format function
1667 takes its format arguments as a @code{va_list}.
1669 @item -Wformat-security
1670 If @samp{-Wformat} is specified, also warn about uses of format
1671 functions that represent possible security problems.  At present, this
1672 warns about calls to @code{printf} and @code{scanf} functions where the
1673 format string is not a string literal and there are no format arguments,
1674 as in @code{printf (foo);}.  This may be a security hole if the format
1675 string came from untrusted input and contains @samp{%n}.  (This is
1676 currently a subset of what @samp{-Wformat-nonliteral} warns about, but
1677 in future warnings may be added to @samp{-Wformat-security} that are not
1678 included in @samp{-Wformat-nonliteral}.)
1680 @item -Wformat=2
1681 Enable @samp{-Wformat} plus format checks not included in
1682 @samp{-Wformat}.  Currently equivalent to @samp{-Wformat
1683 -Wformat-nonliteral -Wformat-security}.
1685 @item -Wimplicit-int
1686 Warn when a declaration does not specify a type.
1688 @item -Wimplicit-function-declaration
1689 @itemx -Werror-implicit-function-declaration
1690 Give a warning (or error) whenever a function is used before being
1691 declared.
1693 @item -Wimplicit
1694 Same as @samp{-Wimplicit-int} and @samp{-Wimplicit-function-}@*
1695 @samp{declaration}.
1697 @item -Wmain
1698 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
1699 function with external linkage, returning int, taking either zero
1700 arguments, two, or three arguments of appropriate types.
1702 @item -Wmissing-braces
1703 Warn if an aggregate or union initializer is not fully bracketed.  In
1704 the following example, the initializer for @samp{a} is not fully
1705 bracketed, but that for @samp{b} is fully bracketed.
1707 @smallexample
1708 int a[2][2] = @{ 0, 1, 2, 3 @};
1709 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
1710 @end smallexample
1712 @item -Wmultichar
1713 Warn if a multicharacter constant (@samp{'FOOF'}) is used.  Usually they
1714 indicate a typo in the user's code, as they have implementation-defined
1715 values, and should not be used in portable code.
1717 @item -Wparentheses
1718 Warn if parentheses are omitted in certain contexts, such
1719 as when there is an assignment in a context where a truth value
1720 is expected, or when operators are nested whose precedence people
1721 often get confused about.
1723 Also warn about constructions where there may be confusion to which
1724 @code{if} statement an @code{else} branch belongs.  Here is an example of
1725 such a case:
1727 @smallexample
1729   if (a)
1730     if (b)
1731       foo ();
1732   else
1733     bar ();
1735 @end smallexample
1737 In C, every @code{else} branch belongs to the innermost possible @code{if}
1738 statement, which in this example is @code{if (b)}.  This is often not
1739 what the programmer expected, as illustrated in the above example by
1740 indentation the programmer chose.  When there is the potential for this
1741 confusion, GNU C will issue a warning when this flag is specified.
1742 To eliminate the warning, add explicit braces around the innermost
1743 @code{if} statement so there is no way the @code{else} could belong to
1744 the enclosing @code{if}.  The resulting code would look like this:
1746 @smallexample
1748   if (a)
1749     @{
1750       if (b)
1751         foo ();
1752       else
1753         bar ();
1754     @}
1756 @end smallexample
1758 @item -Wsequence-point
1759 Warn about code that may have undefined semantics because of violations
1760 of sequence point rules in the C standard.
1762 The C standard defines the order in which expressions in a C program are
1763 evaluated in terms of @dfn{sequence points}, which represent a partial
1764 ordering between the execution of parts of the program: those executed
1765 before the sequence point, and those executed after it.  These occur
1766 after the evaluation of a full expression (one which is not part of a
1767 larger expression), after the evaluation of the first operand of a
1768 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
1769 function is called (but after the evaluation of its arguments and the
1770 expression denoting the called function), and in certain other places.
1771 Other than as expressed by the sequence point rules, the order of
1772 evaluation of subexpressions of an expression is not specified.  All
1773 these rules describe only a partial order rather than a total order,
1774 since, for example, if two functions are called within one expression
1775 with no sequence point between them, the order in which the functions
1776 are called is not specified.  However, the standards committee have
1777 ruled that function calls do not overlap.
1779 It is not specified when between sequence points modifications to the
1780 values of objects take effect.  Programs whose behavior depends on this
1781 have undefined behavior; the C standard specifies that ``Between the
1782 previous and next sequence point an object shall have its stored value
1783 modified at most once by the evaluation of an expression.  Furthermore,
1784 the prior value shall be read only to determine the value to be
1785 stored.''.  If a program breaks these rules, the results on any
1786 particular implementation are entirely unpredictable.
1788 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
1789 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
1790 diagnosed by this option, and it may give an occasional false positive
1791 result, but in general it has been found fairly effective at detecting
1792 this sort of problem in programs.
1794 The present implementation of this option only works for C programs.  A
1795 future implementation may also work for C++ programs.
1797 There is some controversy over the precise meaning of the sequence point
1798 rules in subtle cases.  Alternative formal definitions may be found in
1799 Clive Feather's ``Annex S''
1800 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n925.htm}} and in
1801 Michael Norrish's thesis
1802 @w{@uref{http://www.cl.cam.ac.uk/users/mn200/PhD/thesis-report.ps.gz}}.
1803 Other discussions are by Raymond Mak
1804 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n926.htm}} and
1805 D. Hugh Redelmeier
1806 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n927.htm}}.
1808 @item -Wreturn-type
1809 Warn whenever a function is defined with a return-type that defaults to
1810 @code{int}.  Also warn about any @code{return} statement with no
1811 return-value in a function whose return-type is not @code{void}. 
1813 For C++, a function without return type always produces a diagnostic
1814 message, even when @samp{-Wno-return-type} is specified. The only
1815 exceptions are @samp{main} and functions defined in system headers.
1817 @item -Wswitch
1818 Warn whenever a @code{switch} statement has an index of enumeral type
1819 and lacks a @code{case} for one or more of the named codes of that
1820 enumeration.  (The presence of a @code{default} label prevents this
1821 warning.)  @code{case} labels outside the enumeration range also
1822 provoke warnings when this option is used.
1824 @item -Wtrigraphs
1825 Warn if any trigraphs are encountered that might change the meaning of
1826 the program (trigraphs within comments are not warned about).
1828 @item -Wunused-function
1829 Warn whenever a static function is declared but not defined or a
1830 non\-inline static function is unused.
1832 @item -Wunused-label
1833 Warn whenever a label is declared but not used.
1835 To suppress this warning use the @samp{unused} attribute
1836 (@pxref{Variable Attributes}).
1838 @item -Wunused-parameter
1839 Warn whenever a function parameter is unused aside from its declaration.
1841 To suppress this warning use the @samp{unused} attribute
1842 (@pxref{Variable Attributes}).
1844 @item -Wunused-variable
1845 Warn whenever a local variable or non-constant static variable is unused
1846 aside from its declaration
1848 To suppress this warning use the @samp{unused} attribute
1849 (@pxref{Variable Attributes}).
1851 @item -Wunused-value
1852 Warn whenever a statement computes a result that is explicitly not used.
1854 To suppress this warning cast the expression to @samp{void}.
1856 @item -Wunused
1857 All all the above @samp{-Wunused} options combined.
1859 In order to get a warning about an unused function parameter, you must
1860 either specify @samp{-W -Wunused} or separately specify
1861 @samp{-Wunused-parameter}.
1863 @item -Wuninitialized
1864 Warn if an automatic variable is used without first being initialized or
1865 if a variable may be clobbered by a @code{setjmp} call.
1867 These warnings are possible only in optimizing compilation,
1868 because they require data flow information that is computed only
1869 when optimizing.  If you don't specify @samp{-O}, you simply won't
1870 get these warnings.
1872 These warnings occur only for variables that are candidates for
1873 register allocation.  Therefore, they do not occur for a variable that
1874 is declared @code{volatile}, or whose address is taken, or whose size
1875 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
1876 structures, unions or arrays, even when they are in registers.
1878 Note that there may be no warning about a variable that is used only
1879 to compute a value that itself is never used, because such
1880 computations may be deleted by data flow analysis before the warnings
1881 are printed.
1883 These warnings are made optional because GCC is not smart
1884 enough to see all the reasons why the code might be correct
1885 despite appearing to have an error.  Here is one example of how
1886 this can happen:
1888 @smallexample
1890   int x;
1891   switch (y)
1892     @{
1893     case 1: x = 1;
1894       break;
1895     case 2: x = 4;
1896       break;
1897     case 3: x = 5;
1898     @}
1899   foo (x);
1901 @end smallexample
1903 @noindent
1904 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
1905 always initialized, but GCC doesn't know this.  Here is
1906 another common case:
1908 @smallexample
1910   int save_y;
1911   if (change_y) save_y = y, y = new_y;
1912   @dots{}
1913   if (change_y) y = save_y;
1915 @end smallexample
1917 @noindent
1918 This has no bug because @code{save_y} is used only if it is set.
1920 @cindex @code{longjmp} warnings
1921 This option also warns when a non-volatile automatic variable might be
1922 changed by a call to @code{longjmp}.  These warnings as well are possible
1923 only in optimizing compilation.
1925 The compiler sees only the calls to @code{setjmp}.  It cannot know
1926 where @code{longjmp} will be called; in fact, a signal handler could
1927 call it at any point in the code.  As a result, you may get a warning
1928 even when there is in fact no problem because @code{longjmp} cannot
1929 in fact be called at the place which would cause a problem.
1931 Some spurious warnings can be avoided if you declare all the functions
1932 you use that never return as @code{noreturn}.  @xref{Function
1933 Attributes}.
1935 @item -Wreorder (C++ only)
1936 @cindex reordering, warning
1937 @cindex warning for reordering of member initializers
1938 Warn when the order of member initializers given in the code does not
1939 match the order in which they must be executed.  For instance:
1941 @item -Wunknown-pragmas
1942 @cindex warning for unknown pragmas
1943 @cindex unknown pragmas, warning
1944 @cindex pragmas, warning of unknown
1945 Warn when a #pragma directive is encountered which is not understood by
1946 GCC.  If this command line option is used, warnings will even be issued
1947 for unknown pragmas in system header files.  This is not the case if
1948 the warnings were only enabled by the @samp{-Wall} command line option.
1950 @item -Wall
1951 All of the above @samp{-W} options combined.  This enables all the
1952 warnings about constructions that some users consider questionable, and
1953 that are easy to avoid (or modify to prevent the warning), even in
1954 conjunction with macros.
1956 @item -Wsystem-headers
1957 @cindex warnings from system headers
1958 @cindex system headers, warnings from
1959 Print warning messages for constructs found in system header files.
1960 Warnings from system headers are normally suppressed, on the assumption
1961 that they usually do not indicate real problems and would only make the
1962 compiler output harder to read.  Using this command line option tells
1963 GCC to emit warnings from system headers as if they occurred in user
1964 code.  However, note that using @samp{-Wall} in conjunction with this
1965 option will @emph{not} warn about unknown pragmas in system
1966 headers---for that, @samp{-Wunknown-pragmas} must also be used.
1967 @end table
1969 The following @samp{-W@dots{}} options are not implied by @samp{-Wall}.
1970 Some of them warn about constructions that users generally do not
1971 consider questionable, but which occasionally you might wish to check
1972 for; others warn about constructions that are necessary or hard to avoid
1973 in some cases, and there is no simple way to modify the code to suppress
1974 the warning.
1976 @table @gcctabopt
1977 @item -W
1978 Print extra warning messages for these events:
1980 @itemize @bullet
1981 @item
1982 A function can return either with or without a value.  (Falling
1983 off the end of the function body is considered returning without
1984 a value.)  For example, this function would evoke such a
1985 warning:
1987 @smallexample
1988 @group
1989 foo (a)
1991   if (a > 0)
1992     return a;
1994 @end group
1995 @end smallexample
1997 @item
1998 An expression-statement or the left-hand side of a comma expression
1999 contains no side effects.
2000 To suppress the warning, cast the unused expression to void.
2001 For example, an expression such as @samp{x[i,j]} will cause a warning,
2002 but @samp{x[(void)i,j]} will not.
2004 @item
2005 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
2007 @item
2008 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2009 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2010 that of ordinary mathematical notation.
2012 @item
2013 Storage-class specifiers like @code{static} are not the first things in
2014 a declaration.  According to the C Standard, this usage is obsolescent.
2016 @item
2017 The return type of a function has a type qualifier such as @code{const}.
2018 Such a type qualifier has no effect, since the value returned by a
2019 function is not an lvalue.  (But don't warn about the GNU extension of
2020 @code{volatile void} return types.  That extension will be warned about
2021 if @samp{-pedantic} is specified.)
2023 @item
2024 If @samp{-Wall} or @samp{-Wunused} is also specified, warn about unused
2025 arguments.
2027 @item
2028 A comparison between signed and unsigned values could produce an
2029 incorrect result when the signed value is converted to unsigned.
2030 (But don't warn if @samp{-Wno-sign-compare} is also specified.)
2032 @item
2033 An aggregate has a partly bracketed initializer.
2034 For example, the following code would evoke such a warning,
2035 because braces are missing around the initializer for @code{x.h}:
2037 @smallexample
2038 struct s @{ int f, g; @};
2039 struct t @{ struct s h; int i; @};
2040 struct t x = @{ 1, 2, 3 @};
2041 @end smallexample
2043 @item
2044 An aggregate has an initializer which does not initialize all members.
2045 For example, the following code would cause such a warning, because
2046 @code{x.h} would be implicitly initialized to zero:
2048 @smallexample
2049 struct s @{ int f, g, h; @};
2050 struct s x = @{ 3, 4 @};
2051 @end smallexample
2052 @end itemize
2054 @item -Wfloat-equal
2055 Warn if floating point values are used in equality comparisons.
2057 The idea behind this is that sometimes it is convenient (for the
2058 programmer) to consider floating-point values as approximations to
2059 infinitely precise real numbers.  If you are doing this, then you need
2060 to compute (by analysing the code, or in some other way) the maximum or
2061 likely maximum error that the computation introduces, and allow for it
2062 when performing comparisons (and when producing output, but that's a
2063 different problem).  In particular, instead of testing for equality, you
2064 would check to see whether the two values have ranges that overlap; and
2065 this is done with the relational operators, so equality comparisons are
2066 probably mistaken.
2068 @item -Wtraditional (C only)
2069 Warn about certain constructs that behave differently in traditional and
2070 ISO C.  Also warn about ISO C constructs that have no traditional C
2071 equivalent, and/or problematic constructs which should be avoided.
2073 @itemize @bullet
2074 @item
2075 Macro parameters that appear within string literals in the macro body.
2076 In traditional C macro replacement takes place within string literals,
2077 but does not in ISO C.
2079 @item
2080 In traditional C, some preprocessor directives did not exist.
2081 Traditional preprocessors would only consider a line to be a directive
2082 if the @samp{#} appeared in column 1 on the line.  Therefore
2083 @samp{-Wtraditional} warns about directives that traditional C
2084 understands but would ignore because the @samp{#} does not appear as the
2085 first character on the line.  It also suggests you hide directives like
2086 @samp{#pragma} not understood by traditional C by indenting them.  Some
2087 traditional implementations would not recognise @samp{#elif}, so it
2088 suggests avoiding it altogether.
2090 @item
2091 A function-like macro that appears without arguments.
2093 @item
2094 The unary plus operator.
2096 @item
2097 The `U' integer constant suffix, or the `F' or `L' floating point
2098 constant suffixes.  (Traditonal C does support the `L' suffix on integer
2099 constants.)  Note, these suffixes appear in macros defined in the system
2100 headers of most modern systems, e.g. the _MIN/_MAX macros in limits.h.
2101 Use of these macros in user code might normally lead to spurious
2102 warnings, however gcc's integrated preprocessor has enough context to
2103 avoid warning in these cases.
2105 @item
2106 A function declared external in one block and then used after the end of
2107 the block.
2109 @item
2110 A @code{switch} statement has an operand of type @code{long}.
2112 @item
2113 A non-@code{static} function declaration follows a @code{static} one.
2114 This construct is not accepted by some traditional C compilers.
2116 @item
2117 The ISO type of an integer constant has a different width or
2118 signedness from its traditional type.  This warning is only issued if
2119 the base of the constant is ten.  I.e. hexadecimal or octal values, which
2120 typically represent bit patterns, are not warned about.
2122 @item
2123 Usage of ISO string concatenation is detected.
2125 @item
2126 Initialization of automatic aggregates.
2128 @item
2129 Identifier conflicts with labels.  Traditional C lacks a separate
2130 namespace for labels.
2132 @item
2133 Initialization of unions.  If the initializer is zero, the warning is
2134 omitted.  This is done under the assumption that the zero initializer in
2135 user code appears conditioned on e.g. @code{__STDC__} to avoid missing
2136 initializer warnings and relies on default initialization to zero in the
2137 traditional C case.
2139 @item
2140 Conversions by prototypes between fixed/floating point values and vice
2141 versa.  The absence of these prototypes when compiling with traditional
2142 C would cause serious problems.  This is a subset of the possible
2143 conversion warnings, for the full set use @samp{-Wconversion}.
2144 @end itemize
2146 @item -Wundef
2147 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2149 @item -Wshadow
2150 Warn whenever a local variable shadows another local variable, parameter or
2151 global variable or whenever a built-in function is shadowed.
2153 @item -Wid-clash-@var{len}
2154 Warn whenever two distinct identifiers match in the first @var{len}
2155 characters.  This may help you prepare a program that will compile
2156 with certain obsolete, brain-damaged compilers.
2158 @item -Wlarger-than-@var{len}
2159 Warn whenever an object of larger than @var{len} bytes is defined.
2161 @item -Wpointer-arith
2162 Warn about anything that depends on the ``size of'' a function type or
2163 of @code{void}.  GNU C assigns these types a size of 1, for
2164 convenience in calculations with @code{void *} pointers and pointers
2165 to functions.
2167 @item -Wbad-function-cast (C only)
2168 Warn whenever a function call is cast to a non-matching type.
2169 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2171 @item -Wcast-qual
2172 Warn whenever a pointer is cast so as to remove a type qualifier from
2173 the target type.  For example, warn if a @code{const char *} is cast
2174 to an ordinary @code{char *}.
2176 @item -Wcast-align
2177 Warn whenever a pointer is cast such that the required alignment of the
2178 target is increased.  For example, warn if a @code{char *} is cast to
2179 an @code{int *} on machines where integers can only be accessed at
2180 two- or four-byte boundaries.
2182 @item -Wwrite-strings
2183 Give string constants the type @code{const char[@var{length}]} so that
2184 copying the address of one into a non-@code{const} @code{char *}
2185 pointer will get a warning.  These warnings will help you find at
2186 compile time code that can try to write into a string constant, but
2187 only if you have been very careful about using @code{const} in
2188 declarations and prototypes.  Otherwise, it will just be a nuisance;
2189 this is why we did not make @samp{-Wall} request these warnings.
2191 @item -Wconversion
2192 Warn if a prototype causes a type conversion that is different from what
2193 would happen to the same argument in the absence of a prototype.  This
2194 includes conversions of fixed point to floating and vice versa, and
2195 conversions changing the width or signedness of a fixed point argument
2196 except when the same as the default promotion.
2198 Also, warn if a negative integer constant expression is implicitly
2199 converted to an unsigned type.  For example, warn about the assignment
2200 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2201 casts like @code{(unsigned) -1}.
2203 @item -Wsign-compare
2204 @cindex warning for comparison of signed and unsigned values
2205 @cindex comparison of signed and unsigned values, warning
2206 @cindex signed and unsigned values, comparison warning
2207 Warn when a comparison between signed and unsigned values could produce
2208 an incorrect result when the signed value is converted to unsigned.
2209 This warning is also enabled by @samp{-W}; to get the other warnings
2210 of @samp{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2212 @item -Waggregate-return
2213 Warn if any functions that return structures or unions are defined or
2214 called.  (In languages where you can return an array, this also elicits
2215 a warning.)
2217 @item -Wstrict-prototypes (C only)
2218 Warn if a function is declared or defined without specifying the
2219 argument types.  (An old-style function definition is permitted without
2220 a warning if preceded by a declaration which specifies the argument
2221 types.)
2223 @item -Wmissing-prototypes (C only)
2224 Warn if a global function is defined without a previous prototype
2225 declaration.  This warning is issued even if the definition itself
2226 provides a prototype.  The aim is to detect global functions that fail
2227 to be declared in header files.
2229 @item -Wmissing-declarations
2230 Warn if a global function is defined without a previous declaration.
2231 Do so even if the definition itself provides a prototype.
2232 Use this option to detect global functions that are not declared in
2233 header files.
2235 @item -Wmissing-noreturn
2236 Warn about functions which might be candidates for attribute @code{noreturn}.
2237 Note these are only possible candidates, not absolute ones.  Care should
2238 be taken to manually verify functions actually do not ever return before
2239 adding the @code{noreturn} attribute, otherwise subtle code generation
2240 bugs could be introduced.  You will not get a warning for @code{main} in
2241 hosted C environments.
2243 @item -Wmissing-format-attribute
2244 If @samp{-Wformat} is enabled, also warn about functions which might be
2245 candidates for @code{format} attributes.  Note these are only possible
2246 candidates, not absolute ones.  GCC will guess that @code{format}
2247 attributes might be appropriate for any function that calls a function
2248 like @code{vprintf} or @code{vscanf}, but this might not always be the
2249 case, and some functions for which @code{format} attributes are
2250 appropriate may not be detected.  This option has no effect unless
2251 @samp{-Wformat} is enabled (possibly by @samp{-Wall}).
2253 @item -Wpacked
2254 Warn if a structure is given the packed attribute, but the packed
2255 attribute has no effect on the layout or size of the structure.  
2256 Such structures may be mis-aligned for little benefit.  For
2257 instance, in this code, the variable @code{f.x} in @code{struct bar}
2258 will be misaligned even though @code{struct bar} does not itself
2259 have the packed attribute:
2261 @smallexample
2262 @group
2263 struct foo @{
2264   int x;
2265   char a, b, c, d;
2266 @} __attribute__((packed));
2267 struct bar @{
2268   char z;
2269   struct foo f;
2271 @end group
2272 @end smallexample
2274 @item -Wpadded
2275 Warn if padding is included in a structure, either to align an element
2276 of the structure or to align the whole structure.  Sometimes when this
2277 happens it is possible to rearrange the fields of the structure to
2278 reduce the padding and so make the structure smaller.
2280 @item -Wredundant-decls
2281 Warn if anything is declared more than once in the same scope, even in
2282 cases where multiple declaration is valid and changes nothing.
2284 @item -Wnested-externs (C only)
2285 Warn if an @code{extern} declaration is encountered within a function.
2287 @item -Wunreachable-code
2288 Warn if the compiler detects that code will never be executed.
2290 This option is intended to warn when the compiler detects that at
2291 least a whole line of source code will never be executed, because
2292 some condition is never satisfied or because it is after a
2293 procedure that never returns.
2295 It is possible for this option to produce a warning even though there
2296 are circumstances under which part of the affected line can be executed,
2297 so care should be taken when removing apparently-unreachable code.
2299 For instance, when a function is inlined, a warning may mean that the
2300 line is unreachable in only one inlined copy of the function.  
2302 This option is not made part of @samp{-Wall} because in a debugging
2303 version of a program there is often substantial code which checks
2304 correct functioning of the program and is, hopefully, unreachable
2305 because the program does work.  Another common use of unreachable
2306 code is to provide behaviour which is selectable at compile-time.
2308 @item -Winline
2309 Warn if a function can not be inlined and it was declared as inline.
2311 @item -Wlong-long
2312 Warn if @samp{long long} type is used.  This is default.  To inhibit
2313 the warning messages, use @samp{-Wno-long-long}.  Flags
2314 @samp{-Wlong-long} and @samp{-Wno-long-long} are taken into account
2315 only when @samp{-pedantic} flag is used.
2317 @item -Wdisabled-optimization
2318 Warn if a requested optimization pass is disabled.  This warning does
2319 not generally indicate that there is anything wrong with your code; it
2320 merely indicates that GCC's optimizers were unable to handle the code
2321 effectively.  Often, the problem is that your code is too big or too
2322 complex; GCC will refuse to optimize programs when the optimization
2323 itself is likely to take inordinate amounts of time.
2325 @item -Werror
2326 Make all warnings into errors.
2327 @end table
2329 @node Debugging Options
2330 @section Options for Debugging Your Program or GCC
2331 @cindex options, debugging
2332 @cindex debugging information options
2334 GCC has various special options that are used for debugging
2335 either your program or GCC:
2337 @table @gcctabopt
2338 @item -g
2339 Produce debugging information in the operating system's native format
2340 (stabs, COFF, XCOFF, or DWARF).  GDB can work with this debugging
2341 information.
2343 On most systems that use stabs format, @samp{-g} enables use of extra
2344 debugging information that only GDB can use; this extra information
2345 makes debugging work better in GDB but will probably make other debuggers
2346 crash or
2347 refuse to read the program.  If you want to control for certain whether
2348 to generate the extra information, use @samp{-gstabs+}, @samp{-gstabs},
2349 @samp{-gxcoff+}, @samp{-gxcoff}, @samp{-gdwarf-1+}, or @samp{-gdwarf-1}
2350 (see below).
2352 Unlike most other C compilers, GCC allows you to use @samp{-g} with
2353 @samp{-O}.  The shortcuts taken by optimized code may occasionally
2354 produce surprising results: some variables you declared may not exist
2355 at all; flow of control may briefly move where you did not expect it;
2356 some statements may not be executed because they compute constant
2357 results or their values were already at hand; some statements may
2358 execute in different places because they were moved out of loops.
2360 Nevertheless it proves possible to debug optimized output.  This makes
2361 it reasonable to use the optimizer for programs that might have bugs.
2363 The following options are useful when GCC is generated with the
2364 capability for more than one debugging format.
2366 @item -ggdb
2367 Produce debugging information for use by GDB.  This means to use the
2368 most expressive format available (DWARF 2, stabs, or the native format
2369 if neither of those are supported), including GDB extensions if at all
2370 possible.
2372 @item -gstabs
2373 Produce debugging information in stabs format (if that is supported),
2374 without GDB extensions.  This is the format used by DBX on most BSD
2375 systems.  On MIPS, Alpha and System V Release 4 systems this option
2376 produces stabs debugging output which is not understood by DBX or SDB.
2377 On System V Release 4 systems this option requires the GNU assembler.
2379 @item -gstabs+
2380 Produce debugging information in stabs format (if that is supported),
2381 using GNU extensions understood only by the GNU debugger (GDB).  The
2382 use of these extensions is likely to make other debuggers crash or
2383 refuse to read the program.
2385 @item -gcoff
2386 Produce debugging information in COFF format (if that is supported).
2387 This is the format used by SDB on most System V systems prior to
2388 System V Release 4.
2390 @item -gxcoff
2391 Produce debugging information in XCOFF format (if that is supported).
2392 This is the format used by the DBX debugger on IBM RS/6000 systems.
2394 @item -gxcoff+
2395 Produce debugging information in XCOFF format (if that is supported),
2396 using GNU extensions understood only by the GNU debugger (GDB).  The
2397 use of these extensions is likely to make other debuggers crash or
2398 refuse to read the program, and may cause assemblers other than the GNU
2399 assembler (GAS) to fail with an error.
2401 @item -gdwarf
2402 Produce debugging information in DWARF version 1 format (if that is
2403 supported).  This is the format used by SDB on most System V Release 4
2404 systems.
2406 @item -gdwarf+
2407 Produce debugging information in DWARF version 1 format (if that is
2408 supported), using GNU extensions understood only by the GNU debugger
2409 (GDB).  The use of these extensions is likely to make other debuggers
2410 crash or refuse to read the program.
2412 @item -gdwarf-2
2413 Produce debugging information in DWARF version 2 format (if that is
2414 supported).  This is the format used by DBX on IRIX 6.
2416 @item -g@var{level}
2417 @itemx -ggdb@var{level}
2418 @itemx -gstabs@var{level}
2419 @itemx -gcoff@var{level}
2420 @itemx -gxcoff@var{level}
2421 @itemx -gdwarf@var{level}
2422 @itemx -gdwarf-2@var{level}
2423 Request debugging information and also use @var{level} to specify how
2424 much information.  The default level is 2.
2426 Level 1 produces minimal information, enough for making backtraces in
2427 parts of the program that you don't plan to debug.  This includes
2428 descriptions of functions and external variables, but no information
2429 about local variables and no line numbers.
2431 Level 3 includes extra information, such as all the macro definitions
2432 present in the program.  Some debuggers support macro expansion when
2433 you use @samp{-g3}.
2435 @cindex @code{prof}
2436 @item -p
2437 Generate extra code to write profile information suitable for the
2438 analysis program @code{prof}.  You must use this option when compiling
2439 the source files you want data about, and you must also use it when
2440 linking.
2442 @cindex @code{gprof}
2443 @item -pg
2444 Generate extra code to write profile information suitable for the
2445 analysis program @code{gprof}.  You must use this option when compiling
2446 the source files you want data about, and you must also use it when
2447 linking.
2449 @cindex @code{tcov}
2450 @item -a
2451 Generate extra code to write profile information for basic blocks, which will
2452 record the number of times each basic block is executed, the basic block start
2453 address, and the function name containing the basic block.  If @samp{-g} is
2454 used, the line number and filename of the start of the basic block will also be
2455 recorded.  If not overridden by the machine description, the default action is
2456 to append to the text file @file{bb.out}.
2458 This data could be analyzed by a program like @code{tcov}.  Note,
2459 however, that the format of the data is not what @code{tcov} expects.
2460 Eventually GNU @code{gprof} should be extended to process this data.
2462 @item -Q
2463 Makes the compiler print out each function name as it is compiled, and
2464 print some statistics about each pass when it finishes.
2466 @item -ftime-report
2467 Makes the compiler print some statistics about the time consumed by each
2468 pass when it finishes.
2470 @item -fmem-report
2471 Makes the compiler print some statistics about permanent memory
2472 allocation when it finishes.
2474 @item -ax
2475 Generate extra code to profile basic blocks.  Your executable will
2476 produce output that is a superset of that produced when @samp{-a} is
2477 used.  Additional output is the source and target address of the basic
2478 blocks where a jump takes place, the number of times a jump is executed,
2479 and (optionally) the complete sequence of basic blocks being executed.
2480 The output is appended to file @file{bb.out}.
2482 You can examine different profiling aspects without recompilation.  Your
2483 executable will read a list of function names from file @file{bb.in}.
2484 Profiling starts when a function on the list is entered and stops when
2485 that invocation is exited.  To exclude a function from profiling, prefix
2486 its name with `-'.  If a function name is not unique, you can
2487 disambiguate it by writing it in the form
2488 @samp{/path/filename.d:functionname}.  Your executable will write the
2489 available paths and filenames in file @file{bb.out}.
2491 Several function names have a special meaning:
2492 @table @code
2493 @item __bb_jumps__
2494 Write source, target and frequency of jumps to file @file{bb.out}.
2495 @item __bb_hidecall__
2496 Exclude function calls from frequency count.
2497 @item __bb_showret__
2498 Include function returns in frequency count.
2499 @item __bb_trace__
2500 Write the sequence of basic blocks executed to file @file{bbtrace.gz}.
2501 The file will be compressed using the program @samp{gzip}, which must
2502 exist in your @env{PATH}.  On systems without the @samp{popen}
2503 function, the file will be named @file{bbtrace} and will not be
2504 compressed.  @strong{Profiling for even a few seconds on these systems
2505 will produce a very large file.}  Note: @code{__bb_hidecall__} and
2506 @code{__bb_showret__} will not affect the sequence written to
2507 @file{bbtrace.gz}.
2508 @end table
2510 Here's a short example using different profiling parameters
2511 in file @file{bb.in}.  Assume function @code{foo} consists of basic blocks
2512 1 and 2 and is called twice from block 3 of function @code{main}.  After
2513 the calls, block 3 transfers control to block 4 of @code{main}.
2515 With @code{__bb_trace__} and @code{main} contained in file @file{bb.in},
2516 the following sequence of blocks is written to file @file{bbtrace.gz}:
2517 0 3 1 2 1 2 4.  The return from block 2 to block 3 is not shown, because
2518 the return is to a point inside the block and not to the top.  The
2519 block address 0 always indicates, that control is transferred
2520 to the trace from somewhere outside the observed functions.  With
2521 @samp{-foo} added to @file{bb.in}, the blocks of function
2522 @code{foo} are removed from the trace, so only 0 3 4 remains.
2524 With @code{__bb_jumps__} and @code{main} contained in file @file{bb.in},
2525 jump frequencies will be written to file @file{bb.out}.  The
2526 frequencies are obtained by constructing a trace of blocks
2527 and incrementing a counter for every neighbouring pair of blocks
2528 in the trace.  The trace 0 3 1 2 1 2 4 displays the following
2529 frequencies:
2531 @example
2532 Jump from block 0x0 to block 0x3 executed 1 time(s)
2533 Jump from block 0x3 to block 0x1 executed 1 time(s)
2534 Jump from block 0x1 to block 0x2 executed 2 time(s)
2535 Jump from block 0x2 to block 0x1 executed 1 time(s)
2536 Jump from block 0x2 to block 0x4 executed 1 time(s)
2537 @end example
2539 With @code{__bb_hidecall__}, control transfer due to call instructions
2540 is removed from the trace, that is the trace is cut into three parts: 0
2541 3 4, 0 1 2 and 0 1 2.  With @code{__bb_showret__}, control transfer due
2542 to return instructions is added to the trace.  The trace becomes: 0 3 1
2543 2 3 1 2 3 4.  Note, that this trace is not the same, as the sequence
2544 written to @file{bbtrace.gz}.  It is solely used for counting jump
2545 frequencies.
2547 @item -fprofile-arcs
2548 Instrument @dfn{arcs} during compilation.  For each function of your
2549 program, GCC creates a program flow graph, then finds a spanning tree
2550 for the graph.  Only arcs that are not on the spanning tree have to be
2551 instrumented: the compiler adds code to count the number of times that these
2552 arcs are executed.  When an arc is the only exit or only entrance to a
2553 block, the instrumentation code can be added to the block; otherwise, a
2554 new basic block must be created to hold the instrumentation code.
2556 Since not every arc in the program must be instrumented, programs
2557 compiled with this option run faster than programs compiled with
2558 @samp{-a}, which adds instrumentation code to every basic block in the
2559 program.  The tradeoff: since @code{gcov} does not have
2560 execution counts for all branches, it must start with the execution
2561 counts for the instrumented branches, and then iterate over the program
2562 flow graph until the entire graph has been solved.  Hence, @code{gcov}
2563 runs a little more slowly than a program which uses information from
2564 @samp{-a}.
2566 @samp{-fprofile-arcs} also makes it possible to estimate branch
2567 probabilities, and to calculate basic block execution counts.  In
2568 general, basic block execution counts do not give enough information to
2569 estimate all branch probabilities.  When the compiled program exits, it
2570 saves the arc execution counts to a file called
2571 @file{@var{sourcename}.da}.  Use the compiler option
2572 @samp{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2573 Control Optimization}) when recompiling, to optimize using estimated
2574 branch probabilities.
2576 @need 2000
2577 @item -ftest-coverage
2578 Create data files for the @code{gcov} code-coverage utility
2579 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
2580 The data file names begin with the name of your source file:
2582 @table @gcctabopt
2583 @item @var{sourcename}.bb
2584 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2585 associate basic block execution counts with line numbers.
2587 @item @var{sourcename}.bbg
2588 A list of all arcs in the program flow graph.  This allows @code{gcov}
2589 to reconstruct the program flow graph, so that it can compute all basic
2590 block and arc execution counts from the information in the
2591 @code{@var{sourcename}.da} file (this last file is the output from
2592 @samp{-fprofile-arcs}).
2593 @end table
2595 @item -d@var{letters}
2596 Says to make debugging dumps during compilation at times specified by
2597 @var{letters}.  This is used for debugging the compiler.  The file names
2598 for most of the dumps are made by appending a pass number and a word to
2599 the source file name (e.g.  @file{foo.c.00.rtl} or @file{foo.c.01.sibling}). 
2600 Here are the possible letters for use in @var{letters}, and their meanings:
2602 @table @samp
2603 @item A
2604 Annotate the assembler output with miscellaneous debugging information.
2605 @item b
2606 Dump after computing branch probabilities, to @file{@var{file}.11.bp}.
2607 @item B
2608 Dump after block reordering, to @file{@var{file}.26.bbro}.
2609 @item c
2610 Dump after instruction combination, to the file @file{@var{file}.14.combine}.
2611 @item C
2612 Dump after the first if conversion, to the file @file{@var{file}.15.ce}.
2613 @item d
2614 Dump after delayed branch scheduling, to @file{@var{file}.29.dbr}.
2615 @item D
2616 Dump all macro definitions, at the end of preprocessing, in addition to
2617 normal output.
2618 @item e
2619 Dump after SSA optimizations, to @file{@var{file}.05.ssa} and
2620 @file{@var{file}.06.ussa}.
2621 @item E
2622 Dump after the second if conversion, to @file{@var{file}.24.ce2}.
2623 @item f
2624 Dump after life analysis, to @file{@var{file}.13.life}.
2625 @item F
2626 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.04.addressof}.
2627 @item g
2628 Dump after global register allocation, to @file{@var{file}.19.greg}.
2629 @item o
2630 Dump after post-reload CSE and other optimizations, to @file{@var{file}.20.postreload}.
2631 @item G      
2632 Dump after GCSE, to @file{@var{file}.08.gcse}.
2633 @item i
2634 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
2635 @item j
2636 Dump after the first jump optimization, to @file{@var{file}.02.jump}.
2637 @item J
2638 Dump after the last jump optimization, to @file{@var{file}.27.jump2}.
2639 @item k
2640 Dump after conversion from registers to stack, to @file{@var{file}.29.stack}.
2641 @item l
2642 Dump after local register allocation, to @file{@var{file}.18.lreg}.
2643 @item L
2644 Dump after loop optimization, to @file{@var{file}.09.loop}.
2645 @item M
2646 Dump after performing the machine dependent reorganisation pass, to
2647 @file{@var{file}.28.mach}. 
2648 @item n
2649 Dump after register renumbering, to @file{@var{file}.23.rnreg}.
2650 @item N
2651 Dump after the register move pass, to @file{@var{file}.16.regmove}.
2652 @item r
2653 Dump after RTL generation, to @file{@var{file}.00.rtl}.
2654 @item R
2655 Dump after the second instruction scheduling pass, to
2656 @file{@var{file}.25.sched2}.
2657 @item s
2658 Dump after CSE (including the jump optimization that sometimes follows
2659 CSE), to @file{@var{file}.03.cse}. 
2660 @item S
2661 Dump after the first instruction scheduling pass, to
2662 @file{@var{file}.17.sched}.
2663 @item t
2664 Dump after the second CSE pass (including the jump optimization that
2665 sometimes follows CSE), to @file{@var{file}.10.cse2}.
2666 @item w
2667 Dump after the second flow pass, to @file{@var{file}.21.flow2}.
2668 @item X
2669 Dump after dead code elimination, to @file{@var{file}.06.dce}.
2670 @item z
2671 Dump after the peephole pass, to @file{@var{file}.22.peephole2}.
2672 @item a
2673 Produce all the dumps listed above.
2674 @item m
2675 Print statistics on memory usage, at the end of the run, to
2676 standard error.
2677 @item p
2678 Annotate the assembler output with a comment indicating which
2679 pattern and alternative was used.  The length of each instruction is
2680 also printed.
2681 @item P
2682 Dump the RTL in the assembler output as a comment before each instruction.
2683 Also turns on @samp{-dp} annotation.
2684 @item v
2685 For each of the other indicated dump files (except for
2686 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
2687 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
2688 @item x
2689 Just generate RTL for a function instead of compiling it.  Usually used
2690 with @samp{r}.
2691 @item y
2692 Dump debugging information during parsing, to standard error.
2693 @end table
2695 @item -fdump-unnumbered
2696 When doing debugging dumps (see -d option above), suppress instruction
2697 numbers and line number note output.  This makes it more feasible to
2698 use diff on debugging dumps for compiler invocations with different
2699 options, in particular with and without -g.
2701 @item -fdump-translation-unit=@var{file} (C and C++ only)
2702 Dump a representation of the tree structure for the entire translation
2703 unit to @var{file}.
2705 @item -fdump-class_layout=@var{file} (C++ only)
2706 @item -fdump-class_layout (C++ only)
2707 Dump a representation of each class's heirarchy to @var{file}, or
2708 @code{stderr} if not specified.
2710 @item -fpretend-float
2711 When running a cross-compiler, pretend that the target machine uses the
2712 same floating point format as the host machine.  This causes incorrect
2713 output of the actual floating constants, but the actual instruction
2714 sequence will probably be the same as GCC would make when running on
2715 the target machine.
2717 @item -save-temps
2718 Store the usual ``temporary'' intermediate files permanently; place them
2719 in the current directory and name them based on the source file.  Thus,
2720 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
2721 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
2722 preprocessed @file{foo.i} output file even though the compiler now
2723 normally uses an integrated preprocessor.
2725 @item -time
2726 Report the CPU time taken by each subprocess in the compilation
2727 sequence.  For C source files, this is the compiler proper and assembler
2728 (plus the linker if linking is done).  The output looks like this:
2730 @smallexample
2731 # cc1 0.12 0.01
2732 # as 0.00 0.01
2733 @end smallexample
2735 The first number on each line is the ``user time,'' that is time spent
2736 executing the program itself.  The second number is ``system time,''
2737 time spent executing operating system routines on behalf of the program.
2738 Both numbers are in seconds.
2740 @item -print-file-name=@var{library}
2741 Print the full absolute name of the library file @var{library} that
2742 would be used when linking---and don't do anything else.  With this
2743 option, GCC does not compile or link anything; it just prints the
2744 file name.
2746 @item -print-prog-name=@var{program}
2747 Like @samp{-print-file-name}, but searches for a program such as @samp{cpp}.
2749 @item -print-libgcc-file-name
2750 Same as @samp{-print-file-name=libgcc.a}.
2752 This is useful when you use @samp{-nostdlib} or @samp{-nodefaultlibs}
2753 but you do want to link with @file{libgcc.a}.  You can do
2755 @example
2756 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
2757 @end example
2759 @item -print-search-dirs
2760 Print the name of the configured installation directory and a list of
2761 program and library directories gcc will search---and don't do anything else.
2763 This is useful when gcc prints the error message
2764 @samp{installation problem, cannot exec cpp0: No such file or directory}.
2765 To resolve this you either need to put @file{cpp0} and the other compiler
2766 components where gcc expects to find them, or you can set the environment
2767 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
2768 Don't forget the trailing '/'.
2769 @xref{Environment Variables}.
2771 @item -dumpmachine
2772 Print the compiler's target machine (for example,
2773 @samp{i686-pc-linux-gnu})---and don't do anything else.
2775 @item -dumpversion
2776 Print the compiler version (for example, @samp{3.0})---and don't do
2777 anything else.
2779 @item -dumpspecs
2780 Print the compiler's built-in specs---and don't do anything else.  (This
2781 is used when GCC itself is being built.)  @xref{Spec Files}.
2782 @end table
2784 @node Optimize Options
2785 @section Options That Control Optimization
2786 @cindex optimize options
2787 @cindex options, optimization
2789 These options control various sorts of optimizations:
2791 @table @gcctabopt
2792 @item -O
2793 @itemx -O1
2794 Optimize.  Optimizing compilation takes somewhat more time, and a lot
2795 more memory for a large function.
2797 Without @samp{-O}, the compiler's goal is to reduce the cost of
2798 compilation and to make debugging produce the expected results.
2799 Statements are independent: if you stop the program with a breakpoint
2800 between statements, you can then assign a new value to any variable or
2801 change the program counter to any other statement in the function and
2802 get exactly the results you would expect from the source code.
2804 Without @samp{-O}, the compiler only allocates variables declared
2805 @code{register} in registers.  The resulting compiled code is a little
2806 worse than produced by PCC without @samp{-O}.
2808 With @samp{-O}, the compiler tries to reduce code size and execution
2809 time.
2811 When you specify @samp{-O}, the compiler turns on @samp{-fthread-jumps}
2812 and @samp{-fdefer-pop} on all machines.  The compiler turns on
2813 @samp{-fdelayed-branch} on machines that have delay slots, and
2814 @samp{-fomit-frame-pointer} on machines that can support debugging even
2815 without a frame pointer.  On some machines the compiler also turns
2816 on other flags.@refill
2818 @item -O2
2819 Optimize even more.  GCC performs nearly all supported optimizations
2820 that do not involve a space-speed tradeoff.  The compiler does not
2821 perform loop unrolling or function inlining when you specify @samp{-O2}.
2822 As compared to @samp{-O}, this option increases both compilation time
2823 and the performance of the generated code.
2825 @samp{-O2} turns on all optional optimizations except for loop unrolling,
2826 function inlining, and register renaming.  It also turns on the
2827 @samp{-fforce-mem} option on all machines and frame pointer elimination
2828 on machines where doing so does not interfere with debugging.
2830 @item -O3
2831 Optimize yet more.  @samp{-O3} turns on all optimizations specified by
2832 @samp{-O2} and also turns on the @samp{-finline-functions} and
2833 @samp{-frename-registers} options.
2835 @item -O0
2836 Do not optimize.
2838 @item -Os
2839 Optimize for size.  @samp{-Os} enables all @samp{-O2} optimizations that
2840 do not typically increase code size.  It also performs further
2841 optimizations designed to reduce code size.
2843 If you use multiple @samp{-O} options, with or without level numbers,
2844 the last such option is the one that is effective.
2845 @end table
2847 Options of the form @samp{-f@var{flag}} specify machine-independent
2848 flags.  Most flags have both positive and negative forms; the negative
2849 form of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below,
2850 only one of the forms is listed---the one which is not the default.
2851 You can figure out the other form by either removing @samp{no-} or
2852 adding it.
2854 @table @gcctabopt
2855 @item -ffloat-store
2856 Do not store floating point variables in registers, and inhibit other
2857 options that might change whether a floating point value is taken from a
2858 register or memory.
2860 @cindex floating point precision
2861 This option prevents undesirable excess precision on machines such as
2862 the 68000 where the floating registers (of the 68881) keep more
2863 precision than a @code{double} is supposed to have.  Similarly for the
2864 x86 architecture.  For most programs, the excess precision does only
2865 good, but a few programs rely on the precise definition of IEEE floating
2866 point.  Use @samp{-ffloat-store} for such programs, after modifying
2867 them to store all pertinent intermediate computations into variables.
2869 @item -fno-default-inline
2870 Do not make member functions inline by default merely because they are
2871 defined inside the class scope (C++ only).  Otherwise, when you specify
2872 @w{@samp{-O}}, member functions defined inside class scope are compiled
2873 inline by default; i.e., you don't need to add @samp{inline} in front of
2874 the member function name.
2876 @item -fno-defer-pop
2877 Always pop the arguments to each function call as soon as that function
2878 returns.  For machines which must pop arguments after a function call,
2879 the compiler normally lets arguments accumulate on the stack for several
2880 function calls and pops them all at once.
2882 @item -fforce-mem
2883 Force memory operands to be copied into registers before doing
2884 arithmetic on them.  This produces better code by making all memory
2885 references potential common subexpressions.  When they are not common
2886 subexpressions, instruction combination should eliminate the separate
2887 register-load.  The @samp{-O2} option turns on this option.
2889 @item -fforce-addr
2890 Force memory address constants to be copied into registers before
2891 doing arithmetic on them.  This may produce better code just as
2892 @samp{-fforce-mem} may.
2894 @item -fomit-frame-pointer
2895 Don't keep the frame pointer in a register for functions that
2896 don't need one.  This avoids the instructions to save, set up and
2897 restore frame pointers; it also makes an extra register available
2898 in many functions.  @strong{It also makes debugging impossible on
2899 some machines.}
2901 @ifset INTERNALS
2902 On some machines, such as the Vax, this flag has no effect, because
2903 the standard calling sequence automatically handles the frame pointer
2904 and nothing is saved by pretending it doesn't exist.  The
2905 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2906 whether a target machine supports this flag.  @xref{Registers}.@refill
2907 @end ifset
2908 @ifclear INTERNALS
2909 On some machines, such as the Vax, this flag has no effect, because
2910 the standard calling sequence automatically handles the frame pointer
2911 and nothing is saved by pretending it doesn't exist.  The
2912 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2913 whether a target machine supports this flag.  @xref{Registers,,Register
2914 Usage, gcc.info, Using and Porting GCC}.@refill
2915 @end ifclear
2917 @item -foptimize-sibling-calls
2918 Optimize sibling and tail recursive calls.
2920 @item -ftrapv
2921 This option generates traps for signed overflow on addition, subtraction,
2922 multiplication operations.
2924 @item -fno-inline
2925 Don't pay attention to the @code{inline} keyword.  Normally this option
2926 is used to keep the compiler from expanding any functions inline.
2927 Note that if you are not optimizing, no functions can be expanded inline.
2929 @item -finline-functions
2930 Integrate all simple functions into their callers.  The compiler
2931 heuristically decides which functions are simple enough to be worth
2932 integrating in this way.
2934 If all calls to a given function are integrated, and the function is
2935 declared @code{static}, then the function is normally not output as
2936 assembler code in its own right.
2938 @item -finline-limit=@var{n}
2939 By default, gcc limits the size of functions that can be inlined.  This flag
2940 allows the control of this limit for functions that are explicitly marked as
2941 inline (ie marked with the inline keyword or defined within the class 
2942 definition in c++).  @var{n} is the size of functions that can be inlined in 
2943 number of pseudo instructions (not counting parameter handling).  The default
2944 value of n is 10000.  Increasing this value can result in more inlined code at
2945 the cost of compilation time and memory consumption.  Decreasing usually makes
2946 the compilation faster and less code will be inlined (which presumably 
2947 means slower programs).  This option is particularly useful for programs that 
2948 use inlining heavily such as those based on recursive templates with c++.
2950 @emph{Note:} pseudo instruction represents, in this particular context, an
2951 abstract measurement of function's size.  In no way, it represents a count
2952 of assembly instructions and as such its exact meaning might change from one
2953 release to an another.
2955 @item -fkeep-inline-functions
2956 Even if all calls to a given function are integrated, and the function
2957 is declared @code{static}, nevertheless output a separate run-time
2958 callable version of the function.  This switch does not affect
2959 @code{extern inline} functions.
2961 @item -fkeep-static-consts
2962 Emit variables declared @code{static const} when optimization isn't turned
2963 on, even if the variables aren't referenced.
2965 GCC enables this option by default.  If you want to force the compiler to
2966 check if the variable was referenced, regardless of whether or not
2967 optimization is turned on, use the @samp{-fno-keep-static-consts} option.
2969 @item -fno-function-cse
2970 Do not put function addresses in registers; make each instruction that
2971 calls a constant function contain the function's address explicitly.
2973 This option results in less efficient code, but some strange hacks
2974 that alter the assembler output may be confused by the optimizations
2975 performed when this option is not used.
2977 @item -ffast-math
2978 Sets @samp{-fno-math-errno}, @samp{-funsafe-math-optimizations},
2979 and @samp{-fno-trapping-math}.
2981 This option causes the preprocessor macro __FAST_MATH__ to be defined.
2983 This option should never be turned on by any @samp{-O} option since
2984 it can result in incorrect output for programs which depend on
2985 an exact implementation of IEEE or ISO rules/specifications for
2986 math functions.
2988 @item -fno-math-errno
2989 Do not set ERRNO after calling math functions that are executed
2990 with a single instruction, e.g., sqrt.  A program that relies on
2991 IEEE exceptions for math error handling may want to use this flag
2992 for speed while maintaining IEEE arithmetic compatibility.
2994 This option should never be turned on by any @samp{-O} option since
2995 it can result in incorrect output for programs which depend on
2996 an exact implementation of IEEE or ISO rules/specifications for
2997 math functions.
2999 The default is @samp{-fmath-errno}.  The @samp{-ffast-math} option
3000 sets @samp{-fno-math-errno}.
3002 @item -funsafe-math-optimizations
3003 Allow optimizations for floating-point arithmetic that (a) assume
3004 that arguments and results are valid and (b) may violate IEEE or
3005 ANSI standards.  
3007 This option should never be turned on by any @samp{-O} option since
3008 it can result in incorrect output for programs which depend on
3009 an exact implementation of IEEE or ISO rules/specifications for
3010 math functions.
3012 The default is @samp{-fno-unsafe-math-optimizations}.  The
3013 @samp{-ffast-math} option sets @samp{-funsafe-math-optimizations}.
3015 @item -fno-trapping-math
3016 Compile code assuming that floating-point operations cannot generate
3017 user-visible traps.  Setting this option may allow faster code
3018 if one relies on ``non-stop'' IEEE arithmetic, for example.
3020 This option should never be turned on by any @samp{-O} option since
3021 it can result in incorrect output for programs which depend on
3022 an exact implementation of IEEE or ISO rules/specifications for
3023 math functions.
3025 The default is @samp{-ftrapping-math}.  The @samp{-ffast-math}
3026 option sets @samp{-fno-trapping-math}.
3027 @end table
3029 @c following causes underfulls.. they don't look great, but we deal.
3030 @c --mew 26jan93
3031 The following options control specific optimizations.  The @samp{-O2}
3032 option turns on all of these optimizations except @samp{-funroll-loops}
3033 and @samp{-funroll-all-loops}.  On most machines, the @samp{-O} option
3034 turns on the @samp{-fthread-jumps} and @samp{-fdelayed-branch} options,
3035 but specific machines may handle it differently.
3037 You can use the following flags in the rare cases when ``fine-tuning''
3038 of optimizations to be performed is desired.
3040 @table @gcctabopt
3041 @item -fstrength-reduce
3042 Perform the optimizations of loop strength reduction and
3043 elimination of iteration variables.
3045 @item -fthread-jumps
3046 Perform optimizations where we check to see if a jump branches to a
3047 location where another comparison subsumed by the first is found.  If
3048 so, the first branch is redirected to either the destination of the
3049 second branch or a point immediately following it, depending on whether
3050 the condition is known to be true or false.
3052 @item -fcse-follow-jumps
3053 In common subexpression elimination, scan through jump instructions
3054 when the target of the jump is not reached by any other path.  For
3055 example, when CSE encounters an @code{if} statement with an
3056 @code{else} clause, CSE will follow the jump when the condition
3057 tested is false.
3059 @item -fcse-skip-blocks
3060 This is similar to @samp{-fcse-follow-jumps}, but causes CSE to
3061 follow jumps which conditionally skip over blocks.  When CSE
3062 encounters a simple @code{if} statement with no else clause,
3063 @samp{-fcse-skip-blocks} causes CSE to follow the jump around the
3064 body of the @code{if}.
3066 @item -frerun-cse-after-loop
3067 Re-run common subexpression elimination after loop optimizations has been
3068 performed.
3070 @item -frerun-loop-opt
3071 Run the loop optimizer twice.
3073 @item -fgcse
3074 Perform a global common subexpression elimination pass.
3075 This pass also performs global constant and copy propagation.
3077 @item -fgcse-lm
3078 When -fgcse-lm is enabled, global common subexpression elimination will
3079 attempt to move loads which are only killed by stores into themselves. This
3080 allows a loop containing a load/store sequence to be changed to a load outside
3081 the loop, and a copy/store within the loop. 
3083 @item -fgcse-sm
3084 When -fgcse-sm is enabled, A store motion pass is run after global common 
3085 subexpression elimination. This pass will attempt to move stores out of loops.
3086 When used in conjunction with -fgcse-lm, loops containing a load/store sequence
3087 can be changed to a load before the loop and a store after the loop.
3089 @item -fdelete-null-pointer-checks
3090 Use global dataflow analysis to identify and eliminate useless null
3091 pointer checks.  Programs which rely on NULL pointer dereferences @emph{not}
3092 halting the program may not work properly with this option.  Use
3093 -fno-delete-null-pointer-checks to disable this optimizing for programs
3094 which depend on that behavior.
3096 @item -fexpensive-optimizations
3097 Perform a number of minor optimizations that are relatively expensive.
3099 @item -foptimize-register-move
3100 @itemx -fregmove
3101 Attempt to reassign register numbers in move instructions and as
3102 operands of other simple instructions in order to maximize the amount of
3103 register tying.  This is especially helpful on machines with two-operand
3104 instructions.  GCC enables this optimization by default with @samp{-O2}
3105 or higher.
3107 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3108 optimization.
3110 @item -fdelayed-branch
3111 If supported for the target machine, attempt to reorder instructions
3112 to exploit instruction slots available after delayed branch
3113 instructions.
3115 @item -fschedule-insns
3116 If supported for the target machine, attempt to reorder instructions to
3117 eliminate execution stalls due to required data being unavailable.  This
3118 helps machines that have slow floating point or memory load instructions
3119 by allowing other instructions to be issued until the result of the load
3120 or floating point instruction is required.
3122 @item -fschedule-insns2
3123 Similar to @samp{-fschedule-insns}, but requests an additional pass of
3124 instruction scheduling after register allocation has been done.  This is
3125 especially useful on machines with a relatively small number of
3126 registers and where memory load instructions take more than one cycle.
3128 @item -ffunction-sections
3129 @itemx -fdata-sections
3130 Place each function or data item into its own section in the output
3131 file if the target supports arbitrary sections.  The name of the
3132 function or the name of the data item determines the section's name
3133 in the output file.
3135 Use these options on systems where the linker can perform optimizations
3136 to improve locality of reference in the instruction space.  HPPA
3137 processors running HP-UX and Sparc processors running Solaris 2 have
3138 linkers with such optimizations.  Other systems using the ELF object format
3139 as well as AIX may have these optimizations in the future.
3141 Only use these options when there are significant benefits from doing
3142 so.  When you specify these options, the assembler and linker will
3143 create larger object and executable files and will also be slower.
3144 You will not be able to use @code{gprof} on all systems if you
3145 specify this option and you may have problems with debugging if
3146 you specify both this option and @samp{-g}.
3148 @item -fcaller-saves
3149 Enable values to be allocated in registers that will be clobbered by
3150 function calls, by emitting extra instructions to save and restore the
3151 registers around such calls.  Such allocation is done only when it
3152 seems to result in better code than would otherwise be produced.
3154 This option is always enabled by default on certain machines, usually
3155 those which have no call-preserved registers to use instead.
3157 For all machines, optimization level 2 and higher enables this flag by
3158 default.
3160 @item -funroll-loops
3161 Perform the optimization of loop unrolling.  This is only done for loops
3162 whose number of iterations can be determined at compile time or run time.
3163 @samp{-funroll-loops} implies both @samp{-fstrength-reduce} and
3164 @samp{-frerun-cse-after-loop}.
3166 @item -funroll-all-loops
3167 Perform the optimization of loop unrolling.  This is done for all loops
3168 and usually makes programs run more slowly.  @samp{-funroll-all-loops}
3169 implies @samp{-fstrength-reduce} as well as @samp{-frerun-cse-after-loop}.
3171 @item -fmove-all-movables
3172 Forces all invariant computations in loops to be moved
3173 outside the loop.
3175 @item -freduce-all-givs
3176 Forces all general-induction variables in loops to be
3177 strength-reduced.
3179 @emph{Note:} When compiling programs written in Fortran,
3180 @samp{-fmove-all-movables} and @samp{-freduce-all-givs} are enabled
3181 by default when you use the optimizer.
3183 These options may generate better or worse code; results are highly
3184 dependent on the structure of loops within the source code.
3186 These two options are intended to be removed someday, once
3187 they have helped determine the efficacy of various
3188 approaches to improving loop optimizations.
3190 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3191 know how use of these options affects
3192 the performance of your production code.
3193 We're very interested in code that runs @emph{slower}
3194 when these options are @emph{enabled}.
3196 @item -fno-peephole
3197 Disable any machine-specific peephole optimizations.
3199 @item -fbranch-probabilities
3200 After running a program compiled with @samp{-fprofile-arcs}
3201 (@pxref{Debugging Options,, Options for Debugging Your Program or
3202 @command{gcc}}), you can compile it a second time using
3203 @samp{-fbranch-probabilities}, to improve optimizations based on
3204 guessing the path a branch might take.
3206 @ifset INTERNALS
3207 With @samp{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
3208 note on the first instruction of each basic block, and a
3209 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3210 These can be used to improve optimization.  Currently, they are only
3211 used in one place: in @file{reorg.c}, instead of guessing which path a
3212 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3213 exactly determine which path is taken more often.
3214 @end ifset
3216 @item -fno-guess-branch-probability
3217 Sometimes gcc will opt to guess branch probabilities when none are
3218 available from either profile directed feedback (@samp{-fprofile-arcs})
3219 or @samp{__builtin_expect}.  In a hard real-time system, people don't
3220 want different runs of the compiler to produce code that has different
3221 behavior; minimizing non-determinism is of paramount import.  This
3222 switch allows users to reduce non-determinism, possibly at the expense
3223 of inferior optimization.
3225 @item -fstrict-aliasing
3226 Allows the compiler to assume the strictest aliasing rules applicable to
3227 the language being compiled.  For C (and C++), this activates
3228 optimizations based on the type of expressions.  In particular, an
3229 object of one type is assumed never to reside at the same address as an
3230 object of a different type, unless the types are almost the same.  For
3231 example, an @code{unsigned int} can alias an @code{int}, but not a
3232 @code{void*} or a @code{double}.  A character type may alias any other
3233 type.  
3235 Pay special attention to code like this:
3236 @example
3237 union a_union @{ 
3238   int i;
3239   double d;
3242 int f() @{
3243   a_union t;
3244   t.d = 3.0;
3245   return t.i;
3247 @end example
3248 The practice of reading from a different union member than the one most
3249 recently written to (called ``type-punning'') is common.  Even with
3250 @samp{-fstrict-aliasing}, type-punning is allowed, provided the memory
3251 is accessed through the union type.  So, the code above will work as
3252 expected.  However, this code might not:
3253 @example
3254 int f() @{ 
3255   a_union t;
3256   int* ip;
3257   t.d = 3.0;
3258   ip = &t.i;
3259   return *ip;
3261 @end example
3263 @ifset INTERNALS
3264 Every language that wishes to perform language-specific alias analysis
3265 should define a function that computes, given an @code{tree}
3266 node, an alias set for the node.  Nodes in different alias sets are not
3267 allowed to alias.  For an example, see the C front-end function
3268 @code{c_get_alias_set}.
3269 @end ifset
3271 @item -falign-functions
3272 @itemx -falign-functions=@var{n}
3273 Align the start of functions to the next power-of-two greater than
3274 @var{n}, skipping up to @var{n} bytes.  For instance,
3275 @samp{-falign-functions=32} aligns functions to the next 32-byte
3276 boundary, but @samp{-falign-functions=24} would align to the next
3277 32-byte boundary only if this can be done by skipping 23 bytes or less.
3279 @samp{-fno-align-functions} and @samp{-falign-functions=1} are
3280 equivalent and mean that functions will not be aligned.
3282 Some assemblers only support this flag when @var{n} is a power of two;
3283 in that case, it is rounded up.
3285 If @var{n} is not specified, use a machine-dependent default.
3287 @item -falign-labels
3288 @itemx -falign-labels=@var{n}
3289 Align all branch targets to a power-of-two boundary, skipping up to
3290 @var{n} bytes like @samp{-falign-functions}.  This option can easily
3291 make code slower, because it must insert dummy operations for when the
3292 branch target is reached in the usual flow of the code.
3294 If @samp{-falign-loops} or @samp{-falign-jumps} are applicable and
3295 are greater than this value, then their values are used instead.
3297 If @var{n} is not specified, use a machine-dependent default which is
3298 very likely to be @samp{1}, meaning no alignment.
3300 @item -falign-loops
3301 @itemx -falign-loops=@var{n}
3302 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
3303 like @samp{-falign-functions}.  The hope is that the loop will be
3304 executed many times, which will make up for any execution of the dummy
3305 operations.
3307 If @var{n} is not specified, use a machine-dependent default.
3309 @item -falign-jumps
3310 @itemx -falign-jumps=@var{n}
3311 Align branch targets to a power-of-two boundary, for branch targets
3312 where the targets can only be reached by jumping, skipping up to @var{n}
3313 bytes like @samp{-falign-functions}.  In this case, no dummy operations
3314 need be executed.
3316 If @var{n} is not specified, use a machine-dependent default.
3318 @item -fssa
3319 Perform optimizations in static single assignment form.  Each function's
3320 flow graph is translated into SSA form, optimizations are performed, and
3321 the flow graph is translated back from SSA form.  User's should not
3322 specify this option, since it is not yet ready for production use.
3324 @item -fdce
3325 Perform dead-code elimination in SSA form.  Requires @samp{-fssa}.  Like
3326 @samp{-fssa}, this is an experimental feature.
3328 @item -fsingle-precision-constant
3329 Treat floating point constant as single precision constant instead of
3330 implicitly converting it to double precision constant.
3332 @item -frename-registers
3333 Attempt to avoid false dependancies in scheduled code by making use
3334 of registers left over after register allocation.  This optimization
3335 will most benefit processors with lots of registers.  It can, however,
3336 make debugging impossible, since variables will no longer stay in
3337 a ``home register''.
3339 @item --param @var{name}=@var{value}
3340 In some places, GCC uses various constants to control the amount of
3341 optimization that is done.  For example, GCC will not inline functions
3342 that contain more that a certain number of instructions.  You can
3343 control some of these constants on the command-line using the
3344 @samp{--param} option.  
3346 In each case, the @var{value} is a integer.  The allowable choices for
3347 @var{name} are given in the following table:
3349 @table @gcctabopt
3350 @item max-inline-insns
3351 If an function contains more than this many instructions, it
3352 will not be inlined.  This option is precisely equivalent to
3353 @samp{-finline-limit}.
3355 @item max-gcse-memory
3356 The approximate maximum amount of memory that will be allocated in
3357 order to perform the global common subexpression elimination
3358 optimization.  If more memory than specified is required, the
3359 optimization will not be done.
3360 @end table
3362 @end table
3364 @node Preprocessor Options
3365 @section Options Controlling the Preprocessor
3366 @cindex preprocessor options
3367 @cindex options, preprocessor
3369 These options control the C preprocessor, which is run on each C source
3370 file before actual compilation.
3372 If you use the @samp{-E} option, nothing is done except preprocessing.
3373 Some of these options make sense only together with @samp{-E} because
3374 they cause the preprocessor output to be unsuitable for actual
3375 compilation.
3377 @table @gcctabopt
3378 @item -include @var{file}
3379 Process @var{file} as input before processing the regular input file.
3380 In effect, the contents of @var{file} are compiled first.  Any @samp{-D}
3381 and @samp{-U} options on the command line are always processed before
3382 @samp{-include @var{file}}, regardless of the order in which they are
3383 written.  All the @samp{-include} and @samp{-imacros} options are
3384 processed in the order in which they are written.
3386 @item -imacros @var{file}
3387 Process @var{file} as input, discarding the resulting output, before
3388 processing the regular input file.  Because the output generated from
3389 @var{file} is discarded, the only effect of @samp{-imacros @var{file}}
3390 is to make the macros defined in @var{file} available for use in the
3391 main input.  All the @samp{-include} and @samp{-imacros} options are
3392 processed in the order in which they are written.
3394 @item -idirafter @var{dir}
3395 @cindex second include path
3396 Add the directory @var{dir} to the second include path.  The directories
3397 on the second include path are searched when a header file is not found
3398 in any of the directories in the main include path (the one that
3399 @samp{-I} adds to).
3401 @item -iprefix @var{prefix}
3402 Specify @var{prefix} as the prefix for subsequent @samp{-iwithprefix}
3403 options.
3405 @item -iwithprefix @var{dir}
3406 Add a directory to the second include path.  The directory's name is
3407 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
3408 specified previously with @samp{-iprefix}.  If you have not specified a
3409 prefix yet, the directory containing the installed passes of the
3410 compiler is used as the default.
3412 @item -iwithprefixbefore @var{dir}
3413 Add a directory to the main include path.  The directory's name is made
3414 by concatenating @var{prefix} and @var{dir}, as in the case of
3415 @samp{-iwithprefix}.
3417 @item -isystem @var{dir}
3418 Add a directory to the beginning of the second include path, marking it
3419 as a system directory, so that it gets the same special treatment as
3420 is applied to the standard system directories.
3422 @item -nostdinc
3423 Do not search the standard system directories for header files.  Only
3424 the directories you have specified with @samp{-I} options (and the
3425 current directory, if appropriate) are searched.  @xref{Directory
3426 Options}, for information on @samp{-I}.
3428 By using both @samp{-nostdinc} and @samp{-I-}, you can limit the include-file
3429 search path to only those directories you specify explicitly.
3431 @item -remap
3432 @findex -remap
3433 When searching for a header file in a directory, remap file names if a
3434 file named @file{header.gcc} exists in that directory.  This can be used
3435 to work around limitations of file systems with file name restrictions.
3436 The @file{header.gcc} file should contain a series of lines with two
3437 tokens on each line: the first token is the name to map, and the second
3438 token is the actual name to use.
3440 @item -undef
3441 Do not predefine any nonstandard macros.  (Including architecture flags).
3443 @item -E
3444 Run only the C preprocessor.  Preprocess all the C source files
3445 specified and output the results to standard output or to the
3446 specified output file.
3448 @item -C
3449 Tell the preprocessor not to discard comments.  Used with the
3450 @samp{-E} option.
3452 @item -P
3453 Tell the preprocessor not to generate @samp{#line} directives.
3454 Used with the @samp{-E} option.
3456 @cindex make
3457 @cindex dependencies, make
3458 @item -M
3459 @findex -M
3460 Instead of outputting the result of preprocessing, output a rule
3461 suitable for @code{make} describing the dependencies of the main source
3462 file.  The preprocessor outputs one @code{make} rule containing the
3463 object file name for that source file, a colon, and the names of all the
3464 included files.  Unless overridden explicitly, the object file name
3465 consists of the basename of the source file with any suffix replaced with
3466 object file suffix. If there are many included files then the
3467 rule is split into several lines using @samp{\}-newline.
3469 @samp{-M} implies @samp{-E}.
3471 @item -MM
3472 @findex -MM
3473 Like @samp{-M}, but mention only the files included with @samp{#include
3474 "@var{file}"}.  System header files included with @samp{#include
3475 <@var{file}>} are omitted.
3477 @item -MD
3478 @findex -MD
3479 Like @samp{-M} but the dependency information is written to a file
3480 rather than stdout.  @code{gcc} will use the same file name and
3481 directory as the object file, but with the suffix ".d" instead.
3483 This is in addition to compiling the main file as specified ---
3484 @samp{-MD} does not inhibit ordinary compilation the way @samp{-M} does,
3485 unless you also specify @samp{-MG}.
3487 With Mach, you can use the utility @code{md} to merge multiple
3488 dependency files into a single dependency file suitable for using with
3489 the @samp{make} command.
3491 @item -MMD
3492 @findex -MMD
3493 Like @samp{-MD} except mention only user header files, not system
3494 -header files.
3496 @item -MF @var{file}
3497 @findex -MF
3498 When used with @samp{-M} or @samp{-MM}, specifies a file to write the
3499 dependencies to.  This allows the preprocessor to write the preprocessed
3500 file to stdout normally.  If no @samp{-MF} switch is given, CPP sends
3501 the rules to stdout and suppresses normal preprocessed output.
3503 Another way to specify output of a @code{make} rule is by setting
3504 the environment variable @env{DEPENDENCIES_OUTPUT} (@pxref{Environment
3505 Variables}).
3507 @item -MG
3508 @findex -MG
3509 When used with @samp{-M} or @samp{-MM}, @samp{-MG} says to treat missing
3510 header files as generated files and assume they live in the same
3511 directory as the source file.  It suppresses preprocessed output, as a
3512 missing header file is ordinarily an error.
3514 This feature is used in automatic updating of makefiles.
3516 @item -MP
3517 @findex -MP
3518 This option instructs CPP to add a phony target for each dependency
3519 other than the main file, causing each to depend on nothing.  These
3520 dummy rules work around errors @code{make} gives if you remove header
3521 files without updating the @code{Makefile} to match.
3523 This is typical output:-
3525 @smallexample
3526 /tmp/test.o: /tmp/test.c /tmp/test.h
3528 /tmp/test.h:
3529 @end smallexample
3531 @item -MQ @var{target}
3532 @item -MT @var{target}
3533 @findex -MQ
3534 @findex -MT
3535 By default CPP uses the main file name, including any path, and appends
3536 the object suffix, normally ``.o'', to it to obtain the name of the
3537 target for dependency generation.  With @samp{-MT} you can specify a
3538 target yourself, overriding the default one.
3540 If you want multiple targets, you can specify them as a single argument
3541 to @samp{-MT}, or use multiple @samp{-MT} options.
3543 The targets you specify are output in the order they appear on the
3544 command line.  @samp{-MQ} is identical to @samp{-MT}, except that the
3545 target name is quoted for Make, but with @samp{-MT} it isn't.  For
3546 example, -MT '$(objpfx)foo.o' gives
3548 @smallexample
3549 $(objpfx)foo.o: /tmp/foo.c
3550 @end smallexample
3552 but -MQ '$(objpfx)foo.o' gives
3554 @smallexample
3555 $$(objpfx)foo.o: /tmp/foo.c
3556 @end smallexample
3558 The default target is automatically quoted, as if it were given with
3559 @samp{-MQ}.
3561 @item -H
3562 Print the name of each header file used, in addition to other normal
3563 activities.
3565 @item -A@var{question}(@var{answer})
3566 Assert the answer @var{answer} for @var{question}, in case it is tested
3567 with a preprocessing conditional such as @samp{#if
3568 #@var{question}(@var{answer})}.  @samp{-A-} disables the standard
3569 assertions that normally describe the target machine.
3571 @item -D@var{macro}
3572 Define macro @var{macro} with the string @samp{1} as its definition.
3574 @item -D@var{macro}=@var{defn}
3575 Define macro @var{macro} as @var{defn}.  All instances of @samp{-D} on
3576 the command line are processed before any @samp{-U} options.
3578 Any @samp{-D} and @samp{-U} options on the command line are processed in
3579 order, and always before @samp{-imacros @var{file}}, regardless of the
3580 order in which they are written.
3582 @item -U@var{macro}
3583 Undefine macro @var{macro}.  @samp{-U} options are evaluated after all
3584 @samp{-D} options, but before any @samp{-include} and @samp{-imacros}
3585 options.
3587 Any @samp{-D} and @samp{-U} options on the command line are processed in
3588 order, and always before @samp{-imacros @var{file}}, regardless of the
3589 order in which they are written.
3591 @item -dM
3592 Tell the preprocessor to output only a list of the macro definitions
3593 that are in effect at the end of preprocessing.  Used with the @samp{-E}
3594 option.
3596 @item -dD
3597 Tell the preprocessing to pass all macro definitions into the output, in
3598 their proper sequence in the rest of the output.
3600 @item -dN
3601 Like @samp{-dD} except that the macro arguments and contents are omitted.
3602 Only @samp{#define @var{name}} is included in the output.
3604 @item -dI
3605 @findex -dI
3606 Output @samp{#include} directives in addition to the result of
3607 preprocessing.
3609 @item -trigraphs
3610 @findex -trigraphs
3611 Process ISO standard trigraph sequences.  These are three-character
3612 sequences, all starting with @samp{??}, that are defined by ISO C to
3613 stand for single characters.  For example, @samp{??/} stands for
3614 @samp{\}, so @samp{'??/n'} is a character constant for a newline.  By
3615 default, GCC ignores trigraphs, but in standard-conforming modes it
3616 converts them.  See the @samp{-std} and @samp{-ansi} options.
3618 The nine trigraph sequences are
3619 @table @samp
3620 @item ??(
3621 -> @samp{[}
3623 @item ??)
3624 -> @samp{]}
3626 @item ??<
3627 -> @samp{@{}
3629 @item ??>
3630 -> @samp{@}}
3632 @item ??=
3633 -> @samp{#}
3635 @item ??/
3636 -> @samp{\}
3638 @item ??'
3639 -> @samp{^}
3641 @item ??!
3642 -> @samp{|}
3644 @item ??-
3645 -> @samp{~}
3647 @end table
3649 Trigraph support is not popular, so many compilers do not implement it
3650 properly.  Portable code should not rely on trigraphs being either
3651 converted or ignored.
3653 @item -Wp\,@var{option}
3654 Pass @var{option} as an option to the preprocessor.  If @var{option}
3655 contains commas, it is split into multiple options at the commas.
3656 @end table
3658 @node Assembler Options
3659 @section Passing Options to the Assembler
3661 @c prevent bad page break with this line
3662 You can pass options to the assembler.
3664 @table @gcctabopt
3665 @item -Wa\,@var{option}
3666 Pass @var{option} as an option to the assembler.  If @var{option}
3667 contains commas, it is split into multiple options at the commas.
3668 @end table
3670 @node Link Options
3671 @section Options for Linking
3672 @cindex link options
3673 @cindex options, linking
3675 These options come into play when the compiler links object files into
3676 an executable output file.  They are meaningless if the compiler is
3677 not doing a link step.
3679 @table @gcctabopt
3680 @cindex file names
3681 @item @var{object-file-name}
3682 A file name that does not end in a special recognized suffix is
3683 considered to name an object file or library.  (Object files are
3684 distinguished from libraries by the linker according to the file
3685 contents.)  If linking is done, these object files are used as input
3686 to the linker.
3688 @item -c
3689 @itemx -S
3690 @itemx -E
3691 If any of these options is used, then the linker is not run, and
3692 object file names should not be used as arguments.  @xref{Overall
3693 Options}.
3695 @cindex Libraries
3696 @item -l@var{library}
3697 Search the library named @var{library} when linking.
3699 It makes a difference where in the command you write this option; the
3700 linker searches processes libraries and object files in the order they
3701 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
3702 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
3703 to functions in @samp{z}, those functions may not be loaded.
3705 The linker searches a standard list of directories for the library,
3706 which is actually a file named @file{lib@var{library}.a}.  The linker
3707 then uses this file as if it had been specified precisely by name.
3709 The directories searched include several standard system directories
3710 plus any that you specify with @samp{-L}.
3712 Normally the files found this way are library files---archive files
3713 whose members are object files.  The linker handles an archive file by
3714 scanning through it for members which define symbols that have so far
3715 been referenced but not defined.  But if the file that is found is an
3716 ordinary object file, it is linked in the usual fashion.  The only
3717 difference between using an @samp{-l} option and specifying a file name
3718 is that @samp{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
3719 and searches several directories.
3721 @item -lobjc
3722 You need this special case of the @samp{-l} option in order to
3723 link an Objective C program.
3725 @item -nostartfiles
3726 Do not use the standard system startup files when linking.
3727 The standard system libraries are used normally, unless @option{-nostdlib}
3728 or @option{-nodefaultlibs} is used.
3730 @item -nodefaultlibs
3731 Do not use the standard system libraries when linking.
3732 Only the libraries you specify will be passed to the linker.
3733 The standard startup files are used normally, unless @option{-nostartfiles}
3734 is used.  The compiler may generate calls to memcmp, memset, and memcpy
3735 for System V (and ISO C) environments or to bcopy and bzero for
3736 BSD environments.  These entries are usually resolved by entries in
3737 libc.  These entry points should be supplied through some other
3738 mechanism when this option is specified.
3740 @item -nostdlib
3741 Do not use the standard system startup files or libraries when linking.
3742 No startup files and only the libraries you specify will be passed to
3743 the linker. The compiler may generate calls to memcmp, memset, and memcpy
3744 for System V (and ISO C) environments or to bcopy and bzero for
3745 BSD environments.  These entries are usually resolved by entries in
3746 libc.  These entry points should be supplied through some other
3747 mechanism when this option is specified.
3749 @cindex @code{-lgcc}, use with @code{-nostdlib}
3750 @cindex @code{-nostdlib} and unresolved references
3751 @cindex unresolved references and @code{-nostdlib}
3752 @cindex @code{-lgcc}, use with @code{-nodefaultlibs}
3753 @cindex @code{-nodefaultlibs} and unresolved references
3754 @cindex unresolved references and @code{-nodefaultlibs}
3755 One of the standard libraries bypassed by @samp{-nostdlib} and
3756 @samp{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
3757 that GCC uses to overcome shortcomings of particular machines, or special
3758 needs for some languages.
3759 @ifset INTERNALS
3760 (@xref{Interface,,Interfacing to GCC Output}, for more discussion of
3761 @file{libgcc.a}.)
3762 @end ifset
3763 @ifclear INTERNALS
3764 (@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
3765 for more discussion of @file{libgcc.a}.)
3766 @end ifclear
3767 In most cases, you need @file{libgcc.a} even when you want to avoid
3768 other standard libraries.  In other words, when you specify @samp{-nostdlib}
3769 or @samp{-nodefaultlibs} you should usually specify @samp{-lgcc} as well.
3770 This ensures that you have no unresolved references to internal GCC
3771 library subroutines.  (For example, @samp{__main}, used to ensure C++
3772 constructors will be called; @pxref{Collect2,,@command{collect2}}.)
3774 @item -s
3775 Remove all symbol table and relocation information from the executable.
3777 @item -static
3778 On systems that support dynamic linking, this prevents linking with the shared
3779 libraries.  On other systems, this option has no effect.
3781 @item -shared
3782 Produce a shared object which can then be linked with other objects to
3783 form an executable.  Not all systems support this option.  For predictable
3784 results, you must also specify the same set of options that were used to 
3785 generate code (@samp{-fpic}, @samp{-fPIC}, or model suboptions)
3786 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
3787 needs to build supplementary stub code for constructors to work. On
3788 multi-libbed systems, @samp{gcc -shared} must select the correct support
3789 libraries to link against.  Failing to supply the correct flags may lead
3790 to subtle defects. Supplying them in cases where they are not necessary
3791 is innocuous.}
3793 @item -shared-libgcc
3794 @itemx -static-libgcc
3795 On systems that provide @file{libgcc} as a shared library, these options
3796 force the use of either the shared or static version respectively.
3797 If no shared version of @file{libgcc} was built when the compiler was
3798 configured, these options have no effect.
3800 There are several situations in which an application should use the
3801 shared @file{libgcc} instead of the static version.  The most common
3802 of these is when the application wishes to throw and catch exceptions
3803 across different shared libraries.  In that case, each of the libraries
3804 as well as the application itself should use the shared @file{libgcc}.
3806 Therefore, whenever you specify the @samp{-shared} option, the GCC
3807 driver automatically adds @samp{-shared-libgcc}, unless you explicitly
3808 specify @samp{-static-libgcc}.  The G++ driver automatically adds
3809 @samp{-shared-libgcc} when you build a main executable as well because
3810 for C++ programs that is typically the right thing to do.
3811 (Exception-handling will not work reliably otherwise.)
3813 However, when linking a main executable written in C, you must
3814 explicitly say @samp{-shared-libgcc} if you want to use the shared
3815 @file{libgcc}.
3817 @item -symbolic
3818 Bind references to global symbols when building a shared object.  Warn
3819 about any unresolved references (unless overridden by the link editor
3820 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
3821 this option.
3823 @item -Xlinker @var{option}
3824 Pass @var{option} as an option to the linker.  You can use this to
3825 supply system-specific linker options which GCC does not know how to
3826 recognize.
3828 If you want to pass an option that takes an argument, you must use
3829 @samp{-Xlinker} twice, once for the option and once for the argument.
3830 For example, to pass @samp{-assert definitions}, you must write
3831 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
3832 @samp{-Xlinker "-assert definitions"}, because this passes the entire
3833 string as a single argument, which is not what the linker expects.
3835 @item -Wl\,@var{option}
3836 Pass @var{option} as an option to the linker.  If @var{option} contains
3837 commas, it is split into multiple options at the commas.
3839 @item -u @var{symbol}
3840 Pretend the symbol @var{symbol} is undefined, to force linking of
3841 library modules to define it.  You can use @samp{-u} multiple times with
3842 different symbols to force loading of additional library modules.
3843 @end table
3845 @node Directory Options
3846 @section Options for Directory Search
3847 @cindex directory options
3848 @cindex options, directory search
3849 @cindex search path
3851 These options specify directories to search for header files, for
3852 libraries and for parts of the compiler:
3854 @table @gcctabopt
3855 @item -I@var{dir}
3856 Add the directory @var{dir} to the head of the list of directories to be
3857 searched for header files.  This can be used to override a system header
3858 file, substituting your own version, since these directories are
3859 searched before the system header file directories.  However, you should
3860 not use this option to add directories that contain vendor-supplied
3861 system header files (use @samp{-isystem} for that). If you use more than
3862 one @samp{-I} option, the directories are scanned in left-to-right
3863 order; the standard system directories come after.
3865 @item -I-
3866 Any directories you specify with @samp{-I} options before the @samp{-I-}
3867 option are searched only for the case of @samp{#include "@var{file}"};
3868 they are not searched for @samp{#include <@var{file}>}.
3870 If additional directories are specified with @samp{-I} options after
3871 the @samp{-I-}, these directories are searched for all @samp{#include}
3872 directives.  (Ordinarily @emph{all} @samp{-I} directories are used
3873 this way.)
3875 In addition, the @samp{-I-} option inhibits the use of the current
3876 directory (where the current input file came from) as the first search
3877 directory for @samp{#include "@var{file}"}.  There is no way to
3878 override this effect of @samp{-I-}.  With @samp{-I.} you can specify
3879 searching the directory which was current when the compiler was
3880 invoked.  That is not exactly the same as what the preprocessor does
3881 by default, but it is often satisfactory.
3883 @samp{-I-} does not inhibit the use of the standard system directories
3884 for header files.  Thus, @samp{-I-} and @samp{-nostdinc} are
3885 independent.
3887 @item -L@var{dir}
3888 Add directory @var{dir} to the list of directories to be searched
3889 for @samp{-l}.
3891 @item -B@var{prefix}
3892 This option specifies where to find the executables, libraries,
3893 include files, and data files of the compiler itself.
3895 The compiler driver program runs one or more of the subprograms
3896 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
3897 @var{prefix} as a prefix for each program it tries to run, both with and
3898 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
3900 For each subprogram to be run, the compiler driver first tries the
3901 @samp{-B} prefix, if any.  If that name is not found, or if @samp{-B}
3902 was not specified, the driver tries two standard prefixes, which are
3903 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
3904 those results in a file name that is found, the unmodified program
3905 name is searched for using the directories specified in your
3906 @env{PATH} environment variable.
3908 @samp{-B} prefixes that effectively specify directory names also apply
3909 to libraries in the linker, because the compiler translates these
3910 options into @samp{-L} options for the linker.  They also apply to
3911 includes files in the preprocessor, because the compiler translates these
3912 options into @samp{-isystem} options for the preprocessor.  In this case,
3913 the compiler appends @samp{include} to the prefix.
3915 The run-time support file @file{libgcc.a} can also be searched for using
3916 the @samp{-B} prefix, if needed.  If it is not found there, the two
3917 standard prefixes above are tried, and that is all.  The file is left
3918 out of the link if it is not found by those means.
3920 Another way to specify a prefix much like the @samp{-B} prefix is to use
3921 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
3922 Variables}.
3924 @item -specs=@var{file}
3925 Process @var{file} after the compiler reads in the standard @file{specs}
3926 file, in order to override the defaults that the @file{gcc} driver
3927 program uses when determining what switches to pass to @file{cc1},
3928 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
3929 @samp{-specs=}@var{file} can be specified on the command line, and they
3930 are processed in order, from left to right.
3931 @end table
3933 @c man end
3935 @node Spec Files
3936 @section Specifying subprocesses and the switches to pass to them
3937 @cindex Spec Files
3938 @command{gcc} is a driver program.  It performs its job by invoking a
3939 sequence of other programs to do the work of compiling, assembling and
3940 linking.  GCC interprets its command-line parameters and uses these to
3941 deduce which programs it should invoke, and which command-line options
3942 it ought to place on their command lines.  This behaviour is controlled
3943 by @dfn{spec strings}.  In most cases there is one spec string for each
3944 program that GCC can invoke, but a few programs have multiple spec
3945 strings to control their behaviour.  The spec strings built into GCC can
3946 be overridden by using the @samp{-specs=} command-line switch to specify
3947 a spec file.
3949 @dfn{Spec files} are plaintext files that are used to construct spec
3950 strings.  They consist of a sequence of directives separated by blank
3951 lines.  The type of directive is determined by the first non-whitespace
3952 character on the line and it can be one of the following:
3954 @table @code
3955 @item %@var{command}
3956 Issues a @var{command} to the spec file processor.  The commands that can
3957 appear here are: 
3959 @table @code
3960 @item %include <@var{file}>
3961 @cindex %include
3962 Search for @var{file} and insert its text at the current point in the
3963 specs file.
3965 @item %include_noerr <@var{file}>
3966 @cindex %include_noerr
3967 Just like @samp{%include}, but do not generate an error message if the include
3968 file cannot be found.
3970 @item %rename @var{old_name} @var{new_name}
3971 @cindex %rename
3972 Rename the spec string @var{old_name} to @var{new_name}.
3974 @end table
3976 @item *[@var{spec_name}]:
3977 This tells the compiler to create, override or delete the named spec
3978 string.  All lines after this directive up to the next directive or
3979 blank line are considered to be the text for the spec string.  If this
3980 results in an empty string then the spec will be deleted.  (Or, if the
3981 spec did not exist, then nothing will happened.)  Otherwise, if the spec
3982 does not currently exist a new spec will be created.  If the spec does
3983 exist then its contents will be overridden by the text of this
3984 directive, unless the first character of that text is the @samp{+}
3985 character, in which case the text will be appended to the spec.
3987 @item [@var{suffix}]:
3988 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
3989 and up to the next directive or blank line are considered to make up the
3990 spec string for the indicated suffix.  When the compiler encounters an 
3991 input file with the named suffix, it will processes the spec string in
3992 order to work out how to compile that file.  For example:
3994 @smallexample
3995 .ZZ:
3996 z-compile -input %i
3997 @end smallexample
3999 This says that any input file whose name ends in @samp{.ZZ} should be
4000 passed to the program @samp{z-compile}, which should be invoked with the
4001 command-line switch @samp{-input} and with the result of performing the
4002 @samp{%i} substitution.  (See below.)
4004 As an alternative to providing a spec string, the text that follows a
4005 suffix directive can be one of the following:
4007 @table @code
4008 @item @@@var{language}
4009 This says that the suffix is an alias for a known @var{language}.  This is
4010 similar to using the @option{-x} command-line switch to GCC to specify a
4011 language explicitly.  For example:
4013 @smallexample
4014 .ZZ:
4015 @@c++
4016 @end smallexample
4018 Says that .ZZ files are, in fact, C++ source files.
4020 @item #@var{name}
4021 This causes an error messages saying:
4023 @smallexample
4024 @var{name} compiler not installed on this system.
4025 @end smallexample
4026 @end table
4028 GCC already has an extensive list of suffixes built into it.
4029 This directive will add an entry to the end of the list of suffixes, but
4030 since the list is searched from the end backwards, it is effectively
4031 possible to override earlier entries using this technique.
4033 @end table
4035 GCC has the following spec strings built into it.  Spec files can
4036 override these strings or create their own.  Note that individual
4037 targets can also add their own spec strings to this list. 
4039 @smallexample
4040 asm          Options to pass to the assembler
4041 asm_final    Options to pass to the assembler post-processor
4042 cpp          Options to pass to the C preprocessor
4043 cc1          Options to pass to the C compiler
4044 cc1plus      Options to pass to the C++ compiler
4045 endfile      Object files to include at the end of the link
4046 link         Options to pass to the linker
4047 lib          Libraries to include on the command line to the linker
4048 libgcc       Decides which GCC support library to pass to the linker
4049 linker       Sets the name of the linker
4050 predefines   Defines to be passed to the C preprocessor
4051 signed_char  Defines to pass to CPP to say whether @code{char} is signed by default
4052 startfile    Object files to include at the start of the link
4053 @end smallexample
4055 Here is a small example of a spec file:
4057 @smallexample
4058 %rename lib                 old_lib
4060 *lib:
4061 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
4062 @end smallexample
4064 This example renames the spec called @samp{lib} to @samp{old_lib} and
4065 then overrides the previous definition of @samp{lib} with a new one.
4066 The new definition adds in some extra command-line options before
4067 including the text of the old definition.
4069 @dfn{Spec strings} are a list of command-line options to be passed to their
4070 corresponding program.  In addition, the spec strings can contain
4071 @samp{%}-prefixed sequences to substitute variable text or to
4072 conditionally insert text into the command line.  Using these constructs
4073 it is possible to generate quite complex command lines.
4075 Here is a table of all defined @samp{%}-sequences for spec
4076 strings.  Note that spaces are not generated automatically around the
4077 results of expanding these sequences.  Therefore you can concatenate them
4078 together or combine them with constant text in a single argument. 
4080 @table @code
4081 @item %%
4082 Substitute one @samp{%} into the program name or argument.
4084 @item %i
4085 Substitute the name of the input file being processed.
4087 @item %b
4088 Substitute the basename of the input file being processed.
4089 This is the substring up to (and not including) the last period
4090 and not including the directory.
4092 @item %B
4093 This is the same as @samp{%b}, but include the file suffix (text after
4094 the last period).
4096 @item %d
4097 Marks the argument containing or following the @samp{%d} as a
4098 temporary file name, so that that file will be deleted if GCC exits
4099 successfully.  Unlike @samp{%g}, this contributes no text to the
4100 argument. 
4102 @item %g@var{suffix}
4103 Substitute a file name that has suffix @var{suffix} and is chosen
4104 once per compilation, and mark the argument in the same way as
4105 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
4106 name is now chosen in a way that is hard to predict even when previously 
4107 chosen file names are known.  For example, @samp{%g.s ... %g.o ... %g.s}
4108 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
4109 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4110 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
4111 was simply substituted with a file name chosen once per compilation,
4112 without regard to any appended suffix (which was therefore treated
4113 just like ordinary text), making such attacks more likely to succeed.
4115 @item %u@var{suffix}
4116 Like @samp{%g}, but generates a new temporary file name even if
4117 @samp{%u@var{suffix}} was already seen.
4119 @item %U@var{suffix}
4120 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4121 new one if there is no such last file name.  In the absence of any
4122 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4123 the same suffix @emph{space}, so @samp{%g.s ... %U.s ... %g.s ... %U.s}
4124 would involve the generation of two distinct file names, one
4125 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
4126 simply substituted with a file name chosen for the previous @samp{%u},
4127 without regard to any appended suffix.
4129 @item %j@var{SUFFIX}
4130 Substitutes the name of the HOST_BIT_BUCKET, if any, and if it is 
4131 writable, and if save-temps is off; otherwise, substitute the name
4132 of a temporary file, just like @samp{%u}.  This temporary file is not
4133 meant for communication between processes, but rather as a junk
4134 disposal mechanism.
4136 @item %.@var{SUFFIX}
4137 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4138 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
4139 terminated by the next space or %.
4141 @item %w
4142 Marks the argument containing or following the @samp{%w} as the
4143 designated output file of this compilation.  This puts the argument
4144 into the sequence of arguments that @samp{%o} will substitute later.
4146 @item %o
4147 Substitutes the names of all the output files, with spaces
4148 automatically placed around them.  You should write spaces
4149 around the @samp{%o} as well or the results are undefined.
4150 @samp{%o} is for use in the specs for running the linker.
4151 Input files whose names have no recognized suffix are not compiled
4152 at all, but they are included among the output files, so they will
4153 be linked.
4155 @item %O
4156 Substitutes the suffix for object files.  Note that this is
4157 handled specially when it immediately follows @samp{%g, %u, or %U},
4158 because of the need for those to form complete file names.  The
4159 handling is such that @samp{%O} is treated exactly as if it had already
4160 been substituted, except that @samp{%g, %u, and %U} do not currently
4161 support additional @var{suffix} characters following @samp{%O} as they would
4162 following, for example, @samp{.o}.
4164 @item %p
4165 Substitutes the standard macro predefinitions for the
4166 current target machine.  Use this when running @code{cpp}.
4168 @item %P
4169 Like @samp{%p}, but puts @samp{__} before and after the name of each
4170 predefined macro, except for macros that start with @samp{__} or with
4171 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
4172 C.  
4174 @item %I
4175 Substitute a @samp{-iprefix} option made from GCC_EXEC_PREFIX.
4177 @item %s
4178 Current argument is the name of a library or startup file of some sort.
4179 Search for that file in a standard list of directories and substitute
4180 the full name found. 
4182 @item %e@var{str}
4183 Print @var{str} as an error message.  @var{str} is terminated by a newline.
4184 Use this when inconsistent options are detected.
4186 @item %|
4187 Output @samp{-} if the input for the current command is coming from a pipe.
4189 @item %(@var{name})
4190 Substitute the contents of spec string @var{name} at this point.
4192 @item %[@var{name}]
4193 Like @samp{%(...)} but put @samp{__} around @samp{-D} arguments.
4195 @item %x@{@var{option}@}
4196 Accumulate an option for @samp{%X}.
4198 @item %X
4199 Output the accumulated linker options specified by @samp{-Wl} or a @samp{%x}
4200 spec string.
4202 @item %Y
4203 Output the accumulated assembler options specified by @samp{-Wa}.
4205 @item %Z
4206 Output the accumulated preprocessor options specified by @samp{-Wp}.
4208 @item %v1
4209 Substitute the major version number of GCC.
4210 (For version 2.9.5, this is 2.)
4212 @item %v2
4213 Substitute the minor version number of GCC.
4214 (For version 2.9.5, this is 9.)
4216 @item %v3
4217 Substitute the patch level number of GCC.
4218 (For version 2.9.5, this is 5.)
4220 @item %a
4221 Process the @code{asm} spec.  This is used to compute the
4222 switches to be passed to the assembler.
4224 @item %A
4225 Process the @code{asm_final} spec.  This is a spec string for
4226 passing switches to an assembler post-processor, if such a program is
4227 needed.
4229 @item %l
4230 Process the @code{link} spec.  This is the spec for computing the
4231 command line passed to the linker.  Typically it will make use of the
4232 @samp{%L %G %S %D and %E} sequences.
4234 @item %D
4235 Dump out a @samp{-L} option for each directory that GCC believes might
4236 contain startup files.  If the target supports multilibs then the
4237 current multilib directory will be prepended to each of these paths. 
4239 @item %M
4240 Output the multilib directory with directory seperators replaced with
4241 "_".  If multilib directories are not set, or the multilib directory is
4242 "." then this option emits nothing.
4244 @item %L
4245 Process the @code{lib} spec.  This is a spec string for deciding which
4246 libraries should be included on the command line to the linker. 
4248 @item %G
4249 Process the @code{libgcc} spec.  This is a spec string for deciding
4250 which GCC support library should be included on the command line to the linker. 
4252 @item %S
4253 Process the @code{startfile} spec.  This is a spec for deciding which
4254 object files should be the first ones passed to the linker.  Typically
4255 this might be a file named @file{crt0.o}. 
4257 @item %E
4258 Process the @code{endfile} spec.  This is a spec string that specifies
4259 the last object files that will be passed to the linker.  
4261 @item %C
4262 Process the @code{cpp} spec.  This is used to construct the arguments
4263 to be passed to the C preprocessor.
4265 @item %c
4266 Process the @code{signed_char} spec.  This is intended to be used
4267 to tell cpp whether a char is signed.  It typically has the definition: 
4268 @smallexample
4269 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
4270 @end smallexample
4272 @item %1
4273 Process the @code{cc1} spec.  This is used to construct the options to be
4274 passed to the actual C compiler (@samp{cc1}).
4276 @item %2
4277 Process the @code{cc1plus} spec.  This is used to construct the options to be
4278 passed to the actual C++ compiler (@samp{cc1plus}).
4280 @item %*
4281 Substitute the variable part of a matched option.  See below.
4282 Note that each comma in the substituted string is replaced by
4283 a single space.
4285 @item %@{@code{S}@}
4286 Substitutes the @code{-S} switch, if that switch was given to GCC.
4287 If that switch was not specified, this substitutes nothing.  Note that
4288 the leading dash is omitted when specifying this option, and it is
4289 automatically inserted if the substitution is performed.  Thus the spec
4290 string @samp{%@{foo@}} would match the command-line option @samp{-foo}
4291 and would output the command line option @samp{-foo}.
4293 @item %W@{@code{S}@}
4294 Like %@{@code{S}@} but mark last argument supplied within as a file to be
4295 deleted on failure. 
4297 @item %@{@code{S}*@}
4298 Substitutes all the switches specified to GCC whose names start
4299 with @code{-S}, but which also take an argument.  This is used for
4300 switches like @samp{-o, -D, -I}, etc.  GCC considers @samp{-o foo} as being
4301 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
4302 text, including the space.  Thus two arguments would be generated. 
4304 @item %@{^@code{S}*@}
4305 Like %@{@code{S}*@}, but don't put a blank between a switch and its
4306 argument.  Thus %@{^o*@} would only generate one argument, not two.
4308 @item %@{@code{S}*&@code{T}*@}
4309 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4310 (the order of @code{S} and @code{T} in the spec is not significant).
4311 There can be any number of ampersand-separated variables; for each the
4312 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
4314 @item %@{<@code{S}@}
4315 Remove all occurrences of @code{-S} from the command line.  Note - this
4316 command is position dependent.  @samp{%} commands in the spec string
4317 before this option will see @code{-S}, @samp{%} commands in the spec
4318 string after this option will not.
4320 @item %@{@code{S}*:@code{X}@}
4321 Substitutes @code{X} if one or more switches whose names start with
4322 @code{-S} are specified to GCC.  Note that the tail part of the
4323 @code{-S} option (i.e. the part matched by the @samp{*}) will be substituted
4324 for each occurrence of @samp{%*} within @code{X}. 
4326 @item %@{@code{S}:@code{X}@}
4327 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC.
4329 @item %@{!@code{S}:@code{X}@}
4330 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC.
4332 @item %@{|@code{S}:@code{X}@}
4333 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4335 @item %@{|!@code{S}:@code{X}@}
4336 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4338 @item %@{.@code{S}:@code{X}@}
4339 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4341 @item %@{!.@code{S}:@code{X}@}
4342 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4344 @item %@{@code{S}|@code{P}:@code{X}@}
4345 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC.  This may be
4346 combined with @samp{!} and @samp{.} sequences as well, although they
4347 have a stronger binding than the @samp{|}.  For example a spec string
4348 like this:
4350 @smallexample
4351 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4352 @end smallexample
4354 will output the following command-line options from the following input
4355 command-line options:
4357 @smallexample
4358 fred.c        -foo -baz
4359 jim.d         -bar -boggle
4360 -d fred.c     -foo -baz -boggle
4361 -d jim.d      -bar -baz -boggle
4362 @end smallexample
4364 @end table
4366 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4367 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4368 or spaces, or even newlines.  They are processed as usual, as described
4369 above. 
4371 The @samp{-O, -f, -m, and -W} switches are handled specifically in these
4372 constructs.  If another value of @samp{-O} or the negated form of a @samp{-f, -m, or
4373 -W} switch is found later in the command line, the earlier switch
4374 value is ignored, except with @{@code{S}*@} where @code{S} is just one
4375 letter, which passes all matching options.
4377 The character @samp{|} at the beginning of the predicate text is used to indicate
4378 that a command should be piped to the following command, but only if @samp{-pipe}
4379 is specified.
4381 It is built into GCC which switches take arguments and which do not.
4382 (You might think it would be useful to generalize this to allow each
4383 compiler's spec to say which switches take arguments.  But this cannot
4384 be done in a consistent fashion.  GCC cannot even decide which input
4385 files have been specified without knowing which switches take arguments,
4386 and it must know which input files to compile in order to tell which
4387 compilers to run). 
4389 GCC also knows implicitly that arguments starting in @samp{-l} are to be
4390 treated as compiler output files, and passed to the linker in their
4391 proper position among the other output files.
4393 @c man begin OPTIONS
4395 @node Target Options
4396 @section Specifying Target Machine and Compiler Version
4397 @cindex target options
4398 @cindex cross compiling
4399 @cindex specifying machine version
4400 @cindex specifying compiler version and target machine
4401 @cindex compiler version, specifying
4402 @cindex target machine, specifying
4404 By default, GCC compiles code for the same type of machine that you
4405 are using.  However, it can also be installed as a cross-compiler, to
4406 compile for some other type of machine.  In fact, several different
4407 configurations of GCC, for different target machines, can be
4408 installed side by side.  Then you specify which one to use with the
4409 @samp{-b} option.
4411 In addition, older and newer versions of GCC can be installed side
4412 by side.  One of them (probably the newest) will be the default, but
4413 you may sometimes wish to use another.
4415 @table @gcctabopt
4416 @item -b @var{machine}
4417 The argument @var{machine} specifies the target machine for compilation.
4418 This is useful when you have installed GCC as a cross-compiler.
4420 The value to use for @var{machine} is the same as was specified as the
4421 machine type when configuring GCC as a cross-compiler.  For
4422 example, if a cross-compiler was configured with @samp{configure
4423 i386v}, meaning to compile for an 80386 running System V, then you
4424 would specify @samp{-b i386v} to run that cross compiler.
4426 When you do not specify @samp{-b}, it normally means to compile for
4427 the same type of machine that you are using.
4429 @item -V @var{version}
4430 The argument @var{version} specifies which version of GCC to run.
4431 This is useful when multiple versions are installed.  For example,
4432 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
4434 The default version, when you do not specify @samp{-V}, is the last
4435 version of GCC that you installed.
4436 @end table
4438 The @samp{-b} and @samp{-V} options actually work by controlling part of
4439 the file name used for the executable files and libraries used for
4440 compilation.  A given version of GCC, for a given target machine, is
4441 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.@refill
4443 Thus, sites can customize the effect of @samp{-b} or @samp{-V} either by
4444 changing the names of these directories or adding alternate names (or
4445 symbolic links).  If in directory @file{/usr/local/lib/gcc-lib/} the
4446 file @file{80386} is a link to the file @file{i386v}, then @samp{-b
4447 80386} becomes an alias for @samp{-b i386v}.
4449 In one respect, the @samp{-b} or @samp{-V} do not completely change
4450 to a different compiler: the top-level driver program @command{gcc}
4451 that you originally invoked continues to run and invoke the other
4452 executables (preprocessor, compiler per se, assembler and linker)
4453 that do the real work.  However, since no real work is done in the
4454 driver program, it usually does not matter that the driver program
4455 in use is not the one for the specified target.  It is common for the
4456 interface to the other executables to change incompatibly between
4457 compiler versions, so unless the version specified is very close to that
4458 of the driver (for example, @samp{-V 3.0} with a driver program from GCC
4459 version 3.0.1), use of @samp{-V} may not work; for example, using
4460 @samp{-V 2.95.2} will not work with a driver program from GCC 3.0.
4462 The only way that the driver program depends on the target machine is
4463 in the parsing and handling of special machine-specific options.
4464 However, this is controlled by a file which is found, along with the
4465 other executables, in the directory for the specified version and
4466 target machine.  As a result, a single installed driver program adapts
4467 to any specified target machine, and sufficiently similar compiler
4468 versions.
4470 The driver program executable does control one significant thing,
4471 however: the default version and target machine.  Therefore, you can
4472 install different instances of the driver program, compiled for
4473 different targets or versions, under different names.
4475 For example, if the driver for version 2.0 is installed as @command{ogcc}
4476 and that for version 2.1 is installed as @command{gcc}, then the command
4477 @command{gcc} will use version 2.1 by default, while @command{ogcc} will use
4478 2.0 by default.  However, you can choose either version with either
4479 command with the @samp{-V} option.
4481 @node Submodel Options
4482 @section Hardware Models and Configurations
4483 @cindex submodel options
4484 @cindex specifying hardware config
4485 @cindex hardware models and configurations, specifying
4486 @cindex machine dependent options
4488 Earlier we discussed the standard option @samp{-b} which chooses among
4489 different installed compilers for completely different target
4490 machines, such as Vax vs. 68000 vs. 80386.
4492 In addition, each of these target machine types can have its own
4493 special options, starting with @samp{-m}, to choose among various
4494 hardware models or configurations---for example, 68010 vs 68020,
4495 floating coprocessor or none.  A single installed version of the
4496 compiler can compile for any model or configuration, according to the
4497 options specified.
4499 Some configurations of the compiler also support additional special
4500 options, usually for compatibility with other compilers on the same
4501 platform.
4503 @ifset INTERNALS
4504 These options are defined by the macro @code{TARGET_SWITCHES} in the
4505 machine description.  The default for the options is also defined by
4506 that macro, which enables you to change the defaults.
4507 @end ifset
4509 @menu
4510 * M680x0 Options::
4511 * M68hc1x Options::
4512 * VAX Options::
4513 * SPARC Options::
4514 * Convex Options::
4515 * AMD29K Options::
4516 * ARM Options::
4517 * Thumb Options::
4518 * MN10200 Options::
4519 * MN10300 Options::
4520 * M32R/D Options::
4521 * M88K Options::
4522 * RS/6000 and PowerPC Options::
4523 * RT Options::
4524 * MIPS Options::
4525 * i386 Options::
4526 * HPPA Options::
4527 * Intel 960 Options::
4528 * DEC Alpha Options::
4529 * Clipper Options::
4530 * H8/300 Options::
4531 * SH Options::
4532 * System V Options::
4533 * TMS320C3x/C4x Options::
4534 * V850 Options::
4535 * ARC Options::
4536 * NS32K Options::
4537 * AVR Options::
4538 * MCore Options::
4539 * IA-64 Options::
4540 * D30V Options::
4541 @end menu
4543 @node M680x0 Options
4544 @subsection M680x0 Options
4545 @cindex M680x0 options
4547 These are the @samp{-m} options defined for the 68000 series.  The default
4548 values for these options depends on which style of 68000 was selected when
4549 the compiler was configured; the defaults for the most common choices are
4550 given below.
4552 @table @gcctabopt
4553 @item -m68000
4554 @itemx -mc68000
4555 Generate output for a 68000.  This is the default
4556 when the compiler is configured for 68000-based systems.
4558 Use this option for microcontrollers with a 68000 or EC000 core,
4559 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
4561 @item -m68020
4562 @itemx -mc68020
4563 Generate output for a 68020.  This is the default
4564 when the compiler is configured for 68020-based systems.
4566 @item -m68881
4567 Generate output containing 68881 instructions for floating point.
4568 This is the default for most 68020 systems unless @samp{-nfp} was
4569 specified when the compiler was configured.
4571 @item -m68030
4572 Generate output for a 68030.  This is the default when the compiler is
4573 configured for 68030-based systems.
4575 @item -m68040
4576 Generate output for a 68040.  This is the default when the compiler is
4577 configured for 68040-based systems.
4579 This option inhibits the use of 68881/68882 instructions that have to be
4580 emulated by software on the 68040.  Use this option if your 68040 does not
4581 have code to emulate those instructions.
4583 @item -m68060
4584 Generate output for a 68060.  This is the default when the compiler is
4585 configured for 68060-based systems.
4587 This option inhibits the use of 68020 and 68881/68882 instructions that
4588 have to be emulated by software on the 68060.  Use this option if your 68060
4589 does not have code to emulate those instructions.
4591 @item -mcpu32
4592 Generate output for a CPU32. This is the default
4593 when the compiler is configured for CPU32-based systems.
4595 Use this option for microcontrollers with a
4596 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
4597 68336, 68340, 68341, 68349 and 68360.
4599 @item -m5200
4600 Generate output for a 520X "coldfire" family cpu.  This is the default
4601 when the compiler is configured for 520X-based systems.
4603 Use this option for microcontroller with a 5200 core, including 
4604 the MCF5202, MCF5203, MCF5204 and MCF5202.
4607 @item -m68020-40
4608 Generate output for a 68040, without using any of the new instructions.
4609 This results in code which can run relatively efficiently on either a
4610 68020/68881 or a 68030 or a 68040.  The generated code does use the
4611 68881 instructions that are emulated on the 68040.
4613 @item -m68020-60
4614 Generate output for a 68060, without using any of the new instructions.
4615 This results in code which can run relatively efficiently on either a
4616 68020/68881 or a 68030 or a 68040.  The generated code does use the
4617 68881 instructions that are emulated on the 68060.
4619 @item -mfpa
4620 Generate output containing Sun FPA instructions for floating point.
4622 @item -msoft-float
4623 Generate output containing library calls for floating point.
4624 @strong{Warning:} the requisite libraries are not available for all m68k
4625 targets.  Normally the facilities of the machine's usual C compiler are
4626 used, but this can't be done directly in cross-compilation.  You must
4627 make your own arrangements to provide suitable library functions for
4628 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
4629 @samp{m68k-*-coff} do provide software floating point support.
4631 @item -mshort
4632 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4634 @item -mnobitfield
4635 Do not use the bit-field instructions.  The @samp{-m68000}, @samp{-mcpu32}
4636 and @samp{-m5200} options imply @w{@samp{-mnobitfield}}.
4638 @item -mbitfield
4639 Do use the bit-field instructions.  The @samp{-m68020} option implies
4640 @samp{-mbitfield}.  This is the default if you use a configuration
4641 designed for a 68020.
4643 @item -mrtd
4644 Use a different function-calling convention, in which functions
4645 that take a fixed number of arguments return with the @code{rtd}
4646 instruction, which pops their arguments while returning.  This
4647 saves one instruction in the caller since there is no need to pop
4648 the arguments there.
4650 This calling convention is incompatible with the one normally
4651 used on Unix, so you cannot use it if you need to call libraries
4652 compiled with the Unix compiler.
4654 Also, you must provide function prototypes for all functions that
4655 take variable numbers of arguments (including @code{printf});
4656 otherwise incorrect code will be generated for calls to those
4657 functions.
4659 In addition, seriously incorrect code will result if you call a
4660 function with too many arguments.  (Normally, extra arguments are
4661 harmlessly ignored.)
4663 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
4664 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
4666 @item -malign-int
4667 @itemx -mno-align-int
4668 Control whether GCC aligns @code{int}, @code{long}, @code{long long}, 
4669 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
4670 boundary (@samp{-malign-int}) or a 16-bit boundary (@samp{-mno-align-int}).
4671 Aligning variables on 32-bit boundaries produces code that runs somewhat
4672 faster on processors with 32-bit busses at the expense of more memory.
4674 @strong{Warning:} if you use the @samp{-malign-int} switch, GCC will
4675 align structures containing the above types  differently than
4676 most published application binary interface specifications for the m68k.
4678 @item -mpcrel
4679 Use the pc-relative addressing mode of the 68000 directly, instead of
4680 using a global offset table.  At present, this option implies -fpic,
4681 allowing at most a 16-bit offset for pc-relative addressing.  -fPIC is
4682 not presently supported with -mpcrel, though this could be supported for
4683 68020 and higher processors.
4685 @item -mno-strict-align
4686 @itemx -mstrict-align
4687 @kindex -mstrict-align
4688 Do not (do) assume that unaligned memory references will be handled by
4689 the system.
4691 @end table
4693 @node M68hc1x Options
4694 @subsection M68hc1x Options
4695 @cindex M68hc1x options
4697 These are the @samp{-m} options defined for the 68hc11 and 68hc12
4698 microcontrollers.  The default values for these options depends on 
4699 which style of microcontroller was selected when the compiler was configured;
4700 the defaults for the most common choices are given below.
4702 @table @gcctabopt
4703 @item -m6811
4704 @itemx -m68hc11
4705 Generate output for a 68HC11.  This is the default
4706 when the compiler is configured for 68HC11-based systems.
4708 @item -m6812
4709 @itemx -m68hc12
4710 Generate output for a 68HC12.  This is the default
4711 when the compiler is configured for 68HC12-based systems.
4713 @item -mauto-incdec
4714 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
4715 addressing modes.
4717 @item -mshort
4718 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4720 @item -msoft-reg-count=@var{count}
4721 Specify the number of pseudo-soft registers which are used for the
4722 code generation.  The maximum number is 32.  Using more pseudo-soft
4723 register may or may not result in better code depending on the program.
4724 The default is 4 for 68HC11 and 2 for 68HC12.
4726 @end table
4728 @node VAX Options
4729 @subsection VAX Options
4730 @cindex VAX options
4732 These @samp{-m} options are defined for the Vax:
4734 @table @gcctabopt
4735 @item -munix
4736 Do not output certain jump instructions (@code{aobleq} and so on)
4737 that the Unix assembler for the Vax cannot handle across long
4738 ranges.
4740 @item -mgnu
4741 Do output those jump instructions, on the assumption that you
4742 will assemble with the GNU assembler.
4744 @item -mg
4745 Output code for g-format floating point numbers instead of d-format.
4746 @end table
4748 @node SPARC Options
4749 @subsection SPARC Options
4750 @cindex SPARC options
4752 These @samp{-m} switches are supported on the SPARC:
4754 @table @gcctabopt
4755 @item -mno-app-regs
4756 @itemx -mapp-regs
4757 Specify @samp{-mapp-regs} to generate output using the global registers
4758 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
4759 is the default.
4761 To be fully SVR4 ABI compliant at the cost of some performance loss,
4762 specify @samp{-mno-app-regs}.  You should compile libraries and system
4763 software with this option.
4765 @item -mfpu
4766 @itemx -mhard-float
4767 Generate output containing floating point instructions.  This is the
4768 default.
4770 @item -mno-fpu
4771 @itemx -msoft-float
4772 Generate output containing library calls for floating point.
4773 @strong{Warning:} the requisite libraries are not available for all SPARC
4774 targets.  Normally the facilities of the machine's usual C compiler are
4775 used, but this cannot be done directly in cross-compilation.  You must make
4776 your own arrangements to provide suitable library functions for
4777 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
4778 @samp{sparclite-*-*} do provide software floating point support.
4780 @samp{-msoft-float} changes the calling convention in the output file;
4781 therefore, it is only useful if you compile @emph{all} of a program with
4782 this option.  In particular, you need to compile @file{libgcc.a}, the
4783 library that comes with GCC, with @samp{-msoft-float} in order for
4784 this to work.
4786 @item -mhard-quad-float
4787 Generate output containing quad-word (long double) floating point
4788 instructions.
4790 @item -msoft-quad-float
4791 Generate output containing library calls for quad-word (long double)
4792 floating point instructions.  The functions called are those specified
4793 in the SPARC ABI.  This is the default.
4795 As of this writing, there are no sparc implementations that have hardware
4796 support for the quad-word floating point instructions.  They all invoke
4797 a trap handler for one of these instructions, and then the trap handler
4798 emulates the effect of the instruction.  Because of the trap handler overhead,
4799 this is much slower than calling the ABI library routines.  Thus the
4800 @samp{-msoft-quad-float} option is the default.
4802 @item -mno-epilogue
4803 @itemx -mepilogue
4804 With @samp{-mepilogue} (the default), the compiler always emits code for
4805 function exit at the end of each function.  Any function exit in
4806 the middle of the function (such as a return statement in C) will
4807 generate a jump to the exit code at the end of the function.
4809 With @samp{-mno-epilogue}, the compiler tries to emit exit code inline
4810 at every function exit.
4812 @item -mno-flat
4813 @itemx -mflat
4814 With @samp{-mflat}, the compiler does not generate save/restore instructions
4815 and will use a "flat" or single register window calling convention.
4816 This model uses %i7 as the frame pointer and is compatible with the normal
4817 register window model.  Code from either may be intermixed.
4818 The local registers and the input registers (0-5) are still treated as
4819 "call saved" registers and will be saved on the stack as necessary.
4821 With @samp{-mno-flat} (the default), the compiler emits save/restore
4822 instructions (except for leaf functions) and is the normal mode of operation.
4824 @item -mno-unaligned-doubles
4825 @itemx -munaligned-doubles
4826 Assume that doubles have 8 byte alignment.  This is the default.
4828 With @samp{-munaligned-doubles}, GCC assumes that doubles have 8 byte
4829 alignment only if they are contained in another type, or if they have an
4830 absolute address.  Otherwise, it assumes they have 4 byte alignment.
4831 Specifying this option avoids some rare compatibility problems with code
4832 generated by other compilers.  It is not the default because it results
4833 in a performance loss, especially for floating point code.
4835 @item -mno-faster-structs
4836 @itemx -mfaster-structs
4837 With @samp{-mfaster-structs}, the compiler assumes that structures
4838 should have 8 byte alignment.  This enables the use of pairs of
4839 @code{ldd} and @code{std} instructions for copies in structure
4840 assignment, in place of twice as many @code{ld} and @code{st} pairs.
4841 However, the use of this changed alignment directly violates the Sparc
4842 ABI.  Thus, it's intended only for use on targets where the developer
4843 acknowledges that their resulting code will not be directly in line with
4844 the rules of the ABI.
4846 @item -mv8
4847 @itemx -msparclite
4848 These two options select variations on the SPARC architecture.
4850 By default (unless specifically configured for the Fujitsu SPARClite),
4851 GCC generates code for the v7 variant of the SPARC architecture.
4853 @samp{-mv8} will give you SPARC v8 code.  The only difference from v7
4854 code is that the compiler emits the integer multiply and integer
4855 divide instructions which exist in SPARC v8 but not in SPARC v7.
4857 @samp{-msparclite} will give you SPARClite code.  This adds the integer
4858 multiply, integer divide step and scan (@code{ffs}) instructions which
4859 exist in SPARClite but not in SPARC v7.
4861 These options are deprecated and will be deleted in a future GCC release.
4862 They have been replaced with @samp{-mcpu=xxx}.
4864 @item -mcypress
4865 @itemx -msupersparc
4866 These two options select the processor for which the code is optimised.
4868 With @samp{-mcypress} (the default), the compiler optimizes code for the
4869 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
4870 This is also appropriate for the older SparcStation 1, 2, IPX etc.
4872 With @samp{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
4873 used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
4874 of the full SPARC v8 instruction set.
4876 These options are deprecated and will be deleted in a future GCC release.
4877 They have been replaced with @samp{-mcpu=xxx}.
4879 @item -mcpu=@var{cpu_type}
4880 Set the instruction set, register set, and instruction scheduling parameters
4881 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
4882 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
4883 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
4884 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
4886 Default instruction scheduling parameters are used for values that select
4887 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
4888 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
4890 Here is a list of each supported architecture and their supported
4891 implementations.
4893 @smallexample
4894     v7:             cypress
4895     v8:             supersparc, hypersparc
4896     sparclite:      f930, f934, sparclite86x
4897     sparclet:       tsc701
4898     v9:             ultrasparc
4899 @end smallexample
4901 @item -mtune=@var{cpu_type}
4902 Set the instruction scheduling parameters for machine type
4903 @var{cpu_type}, but do not set the instruction set or register set that the
4904 option @samp{-mcpu=}@var{cpu_type} would.
4906 The same values for @samp{-mcpu=}@var{cpu_type} are used for
4907 @samp{-mtune=}@*@var{cpu_type}, though the only useful values are those that
4908 select a particular cpu implementation: @samp{cypress}, @samp{supersparc},
4909 @samp{hypersparc}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
4910 @samp{tsc701}, @samp{ultrasparc}.
4912 @end table
4914 These @samp{-m} switches are supported in addition to the above
4915 on the SPARCLET processor.
4917 @table @gcctabopt
4918 @item -mlittle-endian
4919 Generate code for a processor running in little-endian mode.
4921 @item -mlive-g0
4922 Treat register @code{%g0} as a normal register.
4923 GCC will continue to clobber it as necessary but will not assume
4924 it always reads as 0.
4926 @item -mbroken-saverestore
4927 Generate code that does not use non-trivial forms of the @code{save} and
4928 @code{restore} instructions.  Early versions of the SPARCLET processor do
4929 not correctly handle @code{save} and @code{restore} instructions used with
4930 arguments.  They correctly handle them used without arguments.  A @code{save}
4931 instruction used without arguments increments the current window pointer
4932 but does not allocate a new stack frame.  It is assumed that the window
4933 overflow trap handler will properly handle this case as will interrupt
4934 handlers.
4935 @end table
4937 These @samp{-m} switches are supported in addition to the above
4938 on SPARC V9 processors in 64 bit environments.
4940 @table @gcctabopt
4941 @item -mlittle-endian
4942 Generate code for a processor running in little-endian mode.
4944 @item -m32
4945 @itemx -m64
4946 Generate code for a 32 bit or 64 bit environment.
4947 The 32 bit environment sets int, long and pointer to 32 bits.
4948 The 64 bit environment sets int to 32 bits and long and pointer
4949 to 64 bits.
4951 @item -mcmodel=medlow
4952 Generate code for the Medium/Low code model: the program must be linked
4953 in the low 32 bits of the address space.  Pointers are 64 bits.
4954 Programs can be statically or dynamically linked.
4956 @item -mcmodel=medmid
4957 Generate code for the Medium/Middle code model: the program must be linked
4958 in the low 44 bits of the address space, the text segment must be less than
4959 2G bytes, and data segment must be within 2G of the text segment.
4960 Pointers are 64 bits.
4962 @item -mcmodel=medany
4963 Generate code for the Medium/Anywhere code model: the program may be linked
4964 anywhere in the address space, the text segment must be less than
4965 2G bytes, and data segment must be within 2G of the text segment.
4966 Pointers are 64 bits.
4968 @item -mcmodel=embmedany
4969 Generate code for the Medium/Anywhere code model for embedded systems:
4970 assume a 32 bit text and a 32 bit data segment, both starting anywhere
4971 (determined at link time).  Register %g4 points to the base of the
4972 data segment.  Pointers still 64 bits.
4973 Programs are statically linked, PIC is not supported.
4975 @item -mstack-bias
4976 @itemx -mno-stack-bias
4977 With @samp{-mstack-bias}, GCC assumes that the stack pointer, and
4978 frame pointer if present, are offset by -2047 which must be added back
4979 when making stack frame references.
4980 Otherwise, assume no such offset is present.
4981 @end table
4983 @node Convex Options
4984 @subsection Convex Options
4985 @cindex Convex options
4987 These @samp{-m} options are defined for Convex:
4989 @table @gcctabopt
4990 @item -mc1
4991 Generate output for C1.  The code will run on any Convex machine.
4992 The preprocessor symbol @code{__convex__c1__} is defined.
4994 @item -mc2
4995 Generate output for C2.  Uses instructions not available on C1.
4996 Scheduling and other optimizations are chosen for max performance on C2.
4997 The preprocessor symbol @code{__convex_c2__} is defined.
4999 @item -mc32
5000 Generate output for C32xx.  Uses instructions not available on C1.
5001 Scheduling and other optimizations are chosen for max performance on C32.
5002 The preprocessor symbol @code{__convex_c32__} is defined.
5004 @item -mc34
5005 Generate output for C34xx.  Uses instructions not available on C1.
5006 Scheduling and other optimizations are chosen for max performance on C34.
5007 The preprocessor symbol @code{__convex_c34__} is defined.
5009 @item -mc38
5010 Generate output for C38xx.  Uses instructions not available on C1.
5011 Scheduling and other optimizations are chosen for max performance on C38.
5012 The preprocessor symbol @code{__convex_c38__} is defined.
5014 @item -margcount
5015 Generate code which puts an argument count in the word preceding each
5016 argument list.  This is compatible with regular CC, and a few programs
5017 may need the argument count word.  GDB and other source-level debuggers
5018 do not need it; this info is in the symbol table.
5020 @item -mnoargcount
5021 Omit the argument count word.  This is the default.
5023 @item -mvolatile-cache
5024 Allow volatile references to be cached.  This is the default.
5026 @item -mvolatile-nocache
5027 Volatile references bypass the data cache, going all the way to memory.
5028 This is only needed for multi-processor code that does not use standard
5029 synchronization instructions.  Making non-volatile references to volatile
5030 locations will not necessarily work.
5032 @item -mlong32
5033 Type long is 32 bits, the same as type int.  This is the default.
5035 @item -mlong64
5036 Type long is 64 bits, the same as type long long.  This option is useless,
5037 because no library support exists for it.
5038 @end table
5040 @node AMD29K Options
5041 @subsection AMD29K Options
5042 @cindex AMD29K options
5044 These @samp{-m} options are defined for the AMD Am29000:
5046 @table @gcctabopt
5047 @item -mdw
5048 @kindex -mdw
5049 @cindex DW bit (29k)
5050 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
5051 halfword operations are directly supported by the hardware.  This is the
5052 default.
5054 @item -mndw
5055 @kindex -mndw
5056 Generate code that assumes the @code{DW} bit is not set.
5058 @item -mbw
5059 @kindex -mbw
5060 @cindex byte writes (29k)
5061 Generate code that assumes the system supports byte and halfword write
5062 operations.  This is the default.
5064 @item -mnbw
5065 @kindex -mnbw
5066 Generate code that assumes the systems does not support byte and
5067 halfword write operations.  @samp{-mnbw} implies @samp{-mndw}.
5069 @item -msmall
5070 @kindex -msmall
5071 @cindex memory model (29k)
5072 Use a small memory model that assumes that all function addresses are
5073 either within a single 256 KB segment or at an absolute address of less
5074 than 256k.  This allows the @code{call} instruction to be used instead
5075 of a @code{const}, @code{consth}, @code{calli} sequence.
5077 @item -mnormal
5078 @kindex -mnormal
5079 Use the normal memory model: Generate @code{call} instructions only when
5080 calling functions in the same file and @code{calli} instructions
5081 otherwise.  This works if each file occupies less than 256 KB but allows
5082 the entire executable to be larger than 256 KB.  This is the default.
5084 @item -mlarge
5085 Always use @code{calli} instructions.  Specify this option if you expect
5086 a single file to compile into more than 256 KB of code.
5088 @item -m29050
5089 @kindex -m29050
5090 @cindex processor selection (29k)
5091 Generate code for the Am29050.
5093 @item -m29000
5094 @kindex -m29000
5095 Generate code for the Am29000.  This is the default.
5097 @item -mkernel-registers
5098 @kindex -mkernel-registers
5099 @cindex kernel and user registers (29k)
5100 Generate references to registers @code{gr64-gr95} instead of to
5101 registers @code{gr96-gr127}.  This option can be used when compiling
5102 kernel code that wants a set of global registers disjoint from that used
5103 by user-mode code.
5105 Note that when this option is used, register names in @samp{-f} flags
5106 must use the normal, user-mode, names.
5108 @item -muser-registers
5109 @kindex -muser-registers
5110 Use the normal set of global registers, @code{gr96-gr127}.  This is the
5111 default.
5113 @item -mstack-check
5114 @itemx -mno-stack-check
5115 @kindex -mstack-check
5116 @cindex stack checks (29k)
5117 Insert (or do not insert) a call to @code{__msp_check} after each stack
5118 adjustment.  This is often used for kernel code.
5120 @item -mstorem-bug
5121 @itemx -mno-storem-bug
5122 @kindex -mstorem-bug
5123 @cindex storem bug (29k)
5124 @samp{-mstorem-bug} handles 29k processors which cannot handle the
5125 separation of a mtsrim insn and a storem instruction (most 29000 chips
5126 to date, but not the 29050).
5128 @item -mno-reuse-arg-regs
5129 @itemx -mreuse-arg-regs
5130 @kindex -mreuse-arg-regs
5131 @samp{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5132 registers for copying out arguments.  This helps detect calling a function
5133 with fewer arguments than it was declared with.
5135 @item -mno-impure-text
5136 @itemx -mimpure-text
5137 @kindex -mimpure-text
5138 @samp{-mimpure-text}, used in addition to @samp{-shared}, tells the compiler to
5139 not pass @samp{-assert pure-text} to the linker when linking a shared object.
5141 @item -msoft-float
5142 @kindex -msoft-float
5143 Generate output containing library calls for floating point.
5144 @strong{Warning:} the requisite libraries are not part of GCC.
5145 Normally the facilities of the machine's usual C compiler are used, but
5146 this can't be done directly in cross-compilation.  You must make your
5147 own arrangements to provide suitable library functions for
5148 cross-compilation.
5150 @item -mno-multm
5151 @kindex -mno-multm
5152 Do not generate multm or multmu instructions.  This is useful for some embedded
5153 systems which do not have trap handlers for these instructions.
5154 @end table
5156 @node ARM Options
5157 @subsection ARM Options
5158 @cindex ARM options
5160 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5161 architectures:
5163 @table @gcctabopt
5164 @item -mapcs-frame
5165 @kindex -mapcs-frame
5166 Generate a stack frame that is compliant with the ARM Procedure Call
5167 Standard for all functions, even if this is not strictly necessary for
5168 correct execution of the code.  Specifying @samp{-fomit-frame-pointer}
5169 with this option will cause the stack frames not to be generated for
5170 leaf functions.  The default is @samp{-mno-apcs-frame}.
5172 @item -mapcs
5173 @kindex -mapcs
5174 This is a synonym for @samp{-mapcs-frame}.
5176 @item -mapcs-26
5177 @kindex -mapcs-26
5178 Generate code for a processor running with a 26-bit program counter,
5179 and conforming to the function calling standards for the APCS 26-bit
5180 option.  This option replaces the @samp{-m2} and @samp{-m3} options
5181 of previous releases of the compiler.
5183 @item -mapcs-32
5184 @kindex -mapcs-32
5185 Generate code for a processor running with a 32-bit program counter,
5186 and conforming to the function calling standards for the APCS 32-bit
5187 option.  This option replaces the @samp{-m6} option of previous releases
5188 of the compiler.
5190 @item -mapcs-stack-check
5191 @kindex -mapcs-stack-check
5192 @kindex -mno-apcs-stack-check
5193 Generate code to check the amount of stack space available upon entry to
5194 every function (that actually uses some stack space).  If there is
5195 insufficient space available then either the function
5196 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5197 called, depending upon the amount of stack space required.  The run time
5198 system is required to provide these functions.  The default is
5199 @samp{-mno-apcs-stack-check}, since this produces smaller code.
5201 @item -mapcs-float
5202 @kindex -mapcs-float
5203 @kindex -mno-apcs-float
5204 Pass floating point arguments using the float point registers.  This is
5205 one of the variants of the APCS.  This option is recommended if the
5206 target hardware has a floating point unit or if a lot of floating point
5207 arithmetic is going to be performed by the code.  The default is
5208 @samp{-mno-apcs-float}, since integer only code is slightly increased in
5209 size if @samp{-mapcs-float} is used.
5211 @item -mapcs-reentrant
5212 @kindex -mapcs-reentrant
5213 @kindex -mno-apcs-reentrant
5214 Generate reentrant, position independent code.  This is the equivalent
5215 to specifying the @samp{-fpic} option.  The default is
5216 @samp{-mno-apcs-reentrant}.
5218 @item -mthumb-interwork
5219 @kindex -mthumb-interwork
5220 @kindex -mno-thumb-interwork
5221 Generate code which supports calling between the ARM and THUMB
5222 instruction sets.  Without this option the two instruction sets cannot
5223 be reliably used inside one program.  The default is
5224 @samp{-mno-thumb-interwork}, since slightly larger code is generated
5225 when @samp{-mthumb-interwork} is specified.
5227 @item -mno-sched-prolog
5228 @kindex -mno-sched-prolog
5229 @kindex -msched-prolog
5230 Prevent the reordering of instructions in the function prolog, or the
5231 merging of those instruction with the instructions in the function's
5232 body.  This means that all functions will start with a recognizable set
5233 of instructions (or in fact one of a choice from a small set of
5234 different function prologues), and this information can be used to
5235 locate the start if functions inside an executable piece of code.  The
5236 default is @samp{-msched-prolog}.
5238 @item -mhard-float
5239 Generate output containing floating point instructions.  This is the
5240 default.
5242 @item -msoft-float
5243 Generate output containing library calls for floating point.
5244 @strong{Warning:} the requisite libraries are not available for all ARM
5245 targets.  Normally the facilities of the machine's usual C compiler are
5246 used, but this cannot be done directly in cross-compilation.  You must make
5247 your own arrangements to provide suitable library functions for
5248 cross-compilation.
5250 @samp{-msoft-float} changes the calling convention in the output file;
5251 therefore, it is only useful if you compile @emph{all} of a program with
5252 this option.  In particular, you need to compile @file{libgcc.a}, the
5253 library that comes with GCC, with @samp{-msoft-float} in order for
5254 this to work.
5256 @item -mlittle-endian
5257 Generate code for a processor running in little-endian mode.  This is
5258 the default for all standard configurations.
5260 @item -mbig-endian
5261 Generate code for a processor running in big-endian mode; the default is
5262 to compile code for a little-endian processor.
5264 @item -mwords-little-endian
5265 This option only applies when generating code for big-endian processors.
5266 Generate code for a little-endian word order but a big-endian byte
5267 order.  That is, a byte order of the form @samp{32107654}.  Note: this
5268 option should only be used if you require compatibility with code for
5269 big-endian ARM processors generated by versions of the compiler prior to
5270 2.8.
5272 @item -malignment-traps
5273 @kindex -malignment-traps
5274 Generate code that will not trap if the MMU has alignment traps enabled.
5275 On ARM architectures prior to ARMv4, there were no instructions to
5276 access half-word objects stored in memory.  However, when reading from
5277 memory a feature of the ARM architecture allows a word load to be used,
5278 even if the address is unaligned, and the processor core will rotate the
5279 data as it is being loaded.  This option tells the compiler that such
5280 misaligned accesses will cause a MMU trap and that it should instead
5281 synthesise the access as a series of byte accesses.  The compiler can
5282 still use word accesses to load half-word data if it knows that the
5283 address is aligned to a word boundary.
5285 This option is ignored when compiling for ARM architecture 4 or later,
5286 since these processors have instructions to directly access half-word
5287 objects in memory. 
5288         
5289 @item -mno-alignment-traps
5290 @kindex -mno-alignment-traps
5291 Generate code that assumes that the MMU will not trap unaligned
5292 accesses.  This produces better code when the target instruction set
5293 does not have half-word memory operations (implementations prior to
5294 ARMv4). 
5296 Note that you cannot use this option to access unaligned word objects,
5297 since the processor will only fetch one 32-bit aligned object from
5298 memory. 
5300 The default setting for most targets is -mno-alignment-traps, since
5301 this produces better code when there are no half-word memory
5302 instructions available. 
5304 @item -mshort-load-bytes
5305 @kindex -mshort-load-bytes
5306 This is a deprecated alias for @samp{-malignment-traps}.
5308 @item -mno-short-load-bytes
5309 @kindex -mno-short-load-bytes
5310 This is a deprecated alias for @samp{-mno-alignment-traps}.
5312 @item -mshort-load-words
5313 @kindex -mshort-load-words
5314 This is a deprecated alias for @samp{-mno-alignment-traps}.
5316 @item -mno-short-load-words
5317 @kindex -mno-short-load-words
5318 This is a deprecated alias for @samp{-malignment-traps}.
5320 @item -mbsd
5321 @kindex -mbsd
5322 This option only applies to RISC iX.  Emulate the native BSD-mode
5323 compiler.  This is the default if @samp{-ansi} is not specified.
5325 @item -mxopen
5326 @kindex -mxopen
5327 This option only applies to RISC iX.  Emulate the native X/Open-mode
5328 compiler.
5330 @item -mno-symrename
5331 @kindex -mno-symrename
5332 This option only applies to RISC iX.  Do not run the assembler
5333 post-processor, @samp{symrename}, after code has been assembled.
5334 Normally it is necessary to modify some of the standard symbols in
5335 preparation for linking with the RISC iX C library; this option
5336 suppresses this pass.  The post-processor is never run when the
5337 compiler is built for cross-compilation.
5339 @item -mcpu=<name>
5340 @kindex -mcpu=
5341 This specifies the name of the target ARM processor.  GCC uses this name
5342 to determine what kind of instructions it can use when generating
5343 assembly code.  Permissible names are: arm2, arm250, arm3, arm6, arm60,
5344 arm600, arm610, arm620, arm7, arm7m, arm7d, arm7dm, arm7di, arm7dmi,
5345 arm70, arm700, arm700i, arm710, arm710c, arm7100, arm7500, arm7500fe,
5346 arm7tdmi, arm8, strongarm, strongarm110, strongarm1100, arm8, arm810,
5347 arm9, arm920, arm920t, arm9tdmi.
5349 @itemx -mtune=<name>
5350 @kindex -mtune=
5351 This option is very similar to the @samp{-mcpu=} option, except that
5352 instead of specifying the actual target processor type, and hence
5353 restricting which instructions can be used, it specifies that GCC should
5354 tune the performance of the code as if the target were of the type
5355 specified in this option, but still choosing the instructions that it
5356 will generate based on the cpu specified by a @samp{-mcpu=} option.
5357 For some arm implementations better performance can be obtained by using
5358 this option.
5360 @item -march=<name>
5361 @kindex -march=
5362 This specifies the name of the target ARM architecture.  GCC uses this
5363 name to determine what kind of instructions it can use when generating
5364 assembly code.  This option can be used in conjunction with or instead
5365 of the @samp{-mcpu=} option.  Permissible names are: armv2, armv2a,
5366 armv3, armv3m, armv4, armv4t, armv5.
5368 @item -mfpe=<number>
5369 @itemx -mfp=<number>
5370 @kindex -mfpe=
5371 @kindex -mfp=
5372 This specifies the version of the floating point emulation available on
5373 the target.  Permissible values are 2 and 3.  @samp{-mfp=} is a synonym
5374 for @samp{-mfpe=} to support older versions of GCC.
5376 @item -mstructure-size-boundary=<n>
5377 @kindex -mstructure-size-boundary
5378 The size of all structures and unions will be rounded up to a multiple
5379 of the number of bits set by this option.  Permissible values are 8 and
5380 32.  The default value varies for different toolchains.  For the COFF
5381 targeted toolchain the default value is 8.  Specifying the larger number
5382 can produce faster, more efficient code, but can also increase the size
5383 of the program.  The two values are potentially incompatible.  Code
5384 compiled with one value cannot necessarily expect to work with code or
5385 libraries compiled with the other value, if they exchange information
5386 using structures or unions.  Programmers are encouraged to use the 32
5387 value as future versions of the toolchain may default to this value.
5389 @item -mabort-on-noreturn
5390 @kindex -mabort-on-noreturn
5391 @kindex -mnoabort-on-noreturn
5392 Generate a call to the function abort at the end of a noreturn function.
5393 It will be executed if the function tries to return.
5395 @item -mlong-calls
5396 @itemx -mno-long-calls
5397 Tells the compiler to perform function calls by first loading the
5398 address of the function into a register and then performing a subroutine
5399 call on this register.  This switch is needed if the target function
5400 will lie outside of the 64 megabyte addressing range of the offset based
5401 version of subroutine call instruction. 
5403 Even if this switch is enabled, not all function calls will be turned
5404 into long calls.  The heuristic is that static functions, functions
5405 which have the @samp{short-call} attribute, functions that are inside
5406 the scope of a @samp{#pragma no_long_calls} directive and functions whose
5407 definitions have already been compiled within the current compilation
5408 unit, will not be turned into long calls.  The exception to this rule is
5409 that weak function definitions, functions with the @samp{long-call}
5410 attribute or the @samp{section} attribute, and functions that are within
5411 the scope of a @samp{#pragma long_calls} directive, will always be
5412 turned into long calls.
5414 This feature is not enabled by default.  Specifying
5415 @samp{--no-long-calls} will restore the default behaviour, as will
5416 placing the function calls within the scope of a @samp{#pragma
5417 long_calls_off} directive.  Note these switches have no effect on how
5418 the compiler generates code to handle function calls via function
5419 pointers.  
5421 @item -mnop-fun-dllimport
5422 @kindex -mnop-fun-dllimport
5423 Disable the support for the @emph{dllimport} attribute.
5425 @item -msingle-pic-base
5426 @kindex -msingle-pic-base
5427 Treat the register used for PIC addressing as read-only, rather than
5428 loading it in the prologue for each function.  The run-time system is
5429 responsible for initialising this register with an appropriate value
5430 before execution begins.
5432 @item -mpic-register=<reg>
5433 @kindex -mpic-register=
5434 Specify the register to be used for PIC addressing.  The default is R10
5435 unless stack-checking is enabled, when R9 is used.
5437 @end table
5439 @node Thumb Options
5440 @subsection Thumb Options
5441 @cindex Thumb Options
5443 @table @gcctabopt
5445 @item -mthumb-interwork
5446 @kindex -mthumb-interwork
5447 @kindex -mno-thumb-interwork
5448 Generate code which supports calling between the THUMB and ARM
5449 instruction sets.  Without this option the two instruction sets cannot
5450 be reliably used inside one program.  The default is
5451 @samp{-mno-thumb-interwork}, since slightly smaller code is generated
5452 with this option.
5454 @item -mtpcs-frame
5455 @kindex -mtpcs-frame
5456 @kindex -mno-tpcs-frame
5457 Generate a stack frame that is compliant with the Thumb Procedure Call
5458 Standard for all non-leaf functions.  (A leaf function is one that does
5459 not call any other functions).  The default is @samp{-mno-apcs-frame}. 
5461 @item -mtpcs-leaf-frame
5462 @kindex -mtpcs-leaf-frame
5463 @kindex -mno-tpcs-leaf-frame
5464 Generate a stack frame that is compliant with the Thumb Procedure Call
5465 Standard for all leaf functions.  (A leaf function is one that does
5466 not call any other functions).  The default is @samp{-mno-apcs-leaf-frame}. 
5468 @item -mlittle-endian
5469 @kindex -mlittle-endian
5470 Generate code for a processor running in little-endian mode.  This is
5471 the default for all standard configurations.
5473 @item -mbig-endian
5474 @kindex -mbig-endian
5475 Generate code for a processor running in big-endian mode.
5477 @item -mstructure-size-boundary=<n>
5478 @kindex -mstructure-size-boundary
5479 The size of all structures and unions will be rounded up to a multiple
5480 of the number of bits set by this option.  Permissible values are 8 and
5481 32.  The default value varies for different toolchains.  For the COFF
5482 targeted toolchain the default value is 8.  Specifying the larger number
5483 can produced faster, more efficient code, but can also increase the size
5484 of the program.  The two values are potentially incompatible.  Code
5485 compiled with one value cannot necessarily expect to work with code or
5486 libraries compiled with the other value, if they exchange information
5487 using structures or unions.  Programmers are encouraged to use the 32
5488 value as future versions of the toolchain may default to this value.
5490 @item -mnop-fun-dllimport
5491 @kindex -mnop-fun-dllimport
5492 Disable the support for the @emph{dllimport} attribute.
5494 @item -mcallee-super-interworking
5495 @kindex -mcallee-super-interworking
5496 Gives all externally visible functions in the file being compiled an ARM
5497 instruction set header which switches to Thumb mode before executing the
5498 rest of the function.  This allows these functions to be called from
5499 non-interworking code.
5501 @item -mcaller-super-interworking
5502 @kindex -mcaller-super-interworking
5503 Allows calls via function pointers (including virtual functions) to
5504 execute correctly regardless of whether the target code has been
5505 compiled for interworking or not.  There is a small overhead in the cost
5506 of executing a function pointer if this option is enabled.
5508 @item -msingle-pic-base
5509 @kindex -msingle-pic-base
5510 Treat the register used for PIC addressing as read-only, rather than
5511 loading it in the prologue for each function.  The run-time system is
5512 responsible for initialising this register with an appropriate value
5513 before execution begins.
5515 @item -mpic-register=<reg>
5516 @kindex -mpic-register=
5517 Specify the register to be used for PIC addressing.  The default is R10.
5519 @end table
5521 @node MN10200 Options
5522 @subsection MN10200 Options
5523 @cindex MN10200 options
5524 These @samp{-m} options are defined for Matsushita MN10200 architectures:
5525 @table @gcctabopt
5527 @item -mrelax
5528 Indicate to the linker that it should perform a relaxation optimization pass
5529 to shorten branches, calls and absolute memory addresses.  This option only
5530 has an effect when used on the command line for the final link step.
5532 This option makes symbolic debugging impossible. 
5533 @end table
5535 @node MN10300 Options
5536 @subsection MN10300 Options
5537 @cindex MN10300 options
5538 These @samp{-m} options are defined for Matsushita MN10300 architectures:
5540 @table @gcctabopt
5541 @item -mmult-bug
5542 Generate code to avoid bugs in the multiply instructions for the MN10300
5543 processors.  This is the default.
5545 @item -mno-mult-bug
5546 Do not generate code to avoid bugs in the multiply instructions for the
5547 MN10300 processors.
5549 @item -mam33
5550 Generate code which uses features specific to the AM33 processor.
5552 @item -mno-am33
5553 Do not generate code which uses features specific to the AM33 processor.  This
5554 is the default.
5556 @item -mrelax
5557 Indicate to the linker that it should perform a relaxation optimization pass
5558 to shorten branches, calls and absolute memory addresses.  This option only
5559 has an effect when used on the command line for the final link step.
5561 This option makes symbolic debugging impossible. 
5562 @end table
5565 @node M32R/D Options
5566 @subsection M32R/D Options
5567 @cindex M32R/D options
5569 These @samp{-m} options are defined for Mitsubishi M32R/D architectures:
5571 @table @gcctabopt
5572 @item -mcode-model=small
5573 Assume all objects live in the lower 16MB of memory (so that their addresses
5574 can be loaded with the @code{ld24} instruction), and assume all subroutines
5575 are reachable with the @code{bl} instruction.
5576 This is the default.
5578 The addressability of a particular object can be set with the
5579 @code{model} attribute.
5581 @item -mcode-model=medium
5582 Assume objects may be anywhere in the 32 bit address space (the compiler
5583 will generate @code{seth/add3} instructions to load their addresses), and
5584 assume all subroutines are reachable with the @code{bl} instruction.
5586 @item -mcode-model=large
5587 Assume objects may be anywhere in the 32 bit address space (the compiler
5588 will generate @code{seth/add3} instructions to load their addresses), and
5589 assume subroutines may not be reachable with the @code{bl} instruction
5590 (the compiler will generate the much slower @code{seth/add3/jl}
5591 instruction sequence).
5593 @item -msdata=none
5594 Disable use of the small data area.  Variables will be put into
5595 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
5596 @code{section} attribute has been specified).
5597 This is the default.
5599 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
5600 Objects may be explicitly put in the small data area with the
5601 @code{section} attribute using one of these sections.
5603 @item -msdata=sdata
5604 Put small global and static data in the small data area, but do not
5605 generate special code to reference them.
5607 @item -msdata=use
5608 Put small global and static data in the small data area, and generate
5609 special instructions to reference them.
5611 @item -G @var{num}
5612 @cindex smaller data references
5613 Put global and static objects less than or equal to @var{num} bytes
5614 into the small data or bss sections instead of the normal data or bss
5615 sections.  The default value of @var{num} is 8.
5616 The @samp{-msdata} option must be set to one of @samp{sdata} or @samp{use}
5617 for this option to have any effect.
5619 All modules should be compiled with the same @samp{-G @var{num}} value.
5620 Compiling with different values of @var{num} may or may not work; if it
5621 doesn't the linker will give an error message - incorrect code will not be
5622 generated.
5624 @end table
5626 @node M88K Options
5627 @subsection M88K Options
5628 @cindex M88k options
5630 These @samp{-m} options are defined for Motorola 88k architectures:
5632 @table @gcctabopt
5633 @item -m88000
5634 @kindex -m88000
5635 Generate code that works well on both the m88100 and the
5636 m88110.
5638 @item -m88100
5639 @kindex -m88100
5640 Generate code that works best for the m88100, but that also
5641 runs on the m88110.
5643 @item -m88110
5644 @kindex -m88110
5645 Generate code that works best for the m88110, and may not run
5646 on the m88100.
5648 @item -mbig-pic
5649 @kindex -mbig-pic
5650 Obsolete option to be removed from the next revision.
5651 Use @samp{-fPIC}.
5653 @item -midentify-revision
5654 @kindex -midentify-revision
5655 @kindex ident
5656 @cindex identifying source, compiler (88k)
5657 Include an @code{ident} directive in the assembler output recording the
5658 source file name, compiler name and version, timestamp, and compilation
5659 flags used.
5661 @item -mno-underscores
5662 @kindex -mno-underscores
5663 @cindex underscores, avoiding (88k)
5664 In assembler output, emit symbol names without adding an underscore
5665 character at the beginning of each name.  The default is to use an
5666 underscore as prefix on each name.
5668 @item -mocs-debug-info
5669 @itemx -mno-ocs-debug-info
5670 @kindex -mocs-debug-info
5671 @kindex -mno-ocs-debug-info
5672 @cindex OCS (88k)
5673 @cindex debugging, 88k OCS
5674 Include (or omit) additional debugging information (about registers used
5675 in each stack frame) as specified in the 88open Object Compatibility
5676 Standard, ``OCS''.  This extra information allows debugging of code that
5677 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
5678 Delta 88 SVr3.2 is to include this information; other 88k configurations
5679 omit this information by default.
5681 @item -mocs-frame-position
5682 @kindex -mocs-frame-position
5683 @cindex register positions in frame (88k)
5684 When emitting COFF debugging information for automatic variables and
5685 parameters stored on the stack, use the offset from the canonical frame
5686 address, which is the stack pointer (register 31) on entry to the
5687 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
5688 @samp{-mocs-frame-position}; other 88k configurations have the default
5689 @samp{-mno-ocs-frame-position}.
5691 @item -mno-ocs-frame-position
5692 @kindex -mno-ocs-frame-position
5693 @cindex register positions in frame (88k)
5694 When emitting COFF debugging information for automatic variables and
5695 parameters stored on the stack, use the offset from the frame pointer
5696 register (register 30).  When this option is in effect, the frame
5697 pointer is not eliminated when debugging information is selected by the
5698 -g switch.
5700 @item -moptimize-arg-area
5701 @itemx -mno-optimize-arg-area
5702 @kindex -moptimize-arg-area
5703 @kindex -mno-optimize-arg-area
5704 @cindex arguments in frame (88k)
5705 Control how function arguments are stored in stack frames.
5706 @samp{-moptimize-arg-area} saves space by optimizing them, but this
5707 conflicts with the 88open specifications.  The opposite alternative,
5708 @samp{-mno-optimize-arg-area}, agrees with 88open standards.  By default
5709 GCC does not optimize the argument area.
5711 @item -mshort-data-@var{num}
5712 @kindex -mshort-data-@var{num}
5713 @cindex smaller data references (88k)
5714 @cindex r0-relative references (88k)
5715 Generate smaller data references by making them relative to @code{r0},
5716 which allows loading a value using a single instruction (rather than the
5717 usual two).  You control which data references are affected by
5718 specifying @var{num} with this option.  For example, if you specify
5719 @samp{-mshort-data-512}, then the data references affected are those
5720 involving displacements of less than 512 bytes.
5721 @samp{-mshort-data-@var{num}} is not effective for @var{num} greater
5722 than 64k.
5724 @item -mserialize-volatile
5725 @kindex -mserialize-volatile
5726 @itemx -mno-serialize-volatile
5727 @kindex -mno-serialize-volatile
5728 @cindex sequential consistency on 88k
5729 Do, or don't, generate code to guarantee sequential consistency
5730 of volatile memory references.  By default, consistency is
5731 guaranteed.
5733 The order of memory references made by the MC88110 processor does
5734 not always match the order of the instructions requesting those
5735 references.  In particular, a load instruction may execute before
5736 a preceding store instruction.  Such reordering violates
5737 sequential consistency of volatile memory references, when there
5738 are multiple processors.   When consistency must be guaranteed,
5739 GNU C generates special instructions, as needed, to force
5740 execution in the proper order.
5742 The MC88100 processor does not reorder memory references and so
5743 always provides sequential consistency.  However, by default, GNU
5744 C generates the special instructions to guarantee consistency
5745 even when you use @samp{-m88100}, so that the code may be run on an
5746 MC88110 processor.  If you intend to run your code only on the
5747 MC88100 processor, you may use @samp{-mno-serialize-volatile}.
5749 The extra code generated to guarantee consistency may affect the
5750 performance of your application.  If you know that you can safely
5751 forgo this guarantee, you may use @samp{-mno-serialize-volatile}.
5753 @item -msvr4
5754 @itemx -msvr3
5755 @kindex -msvr4
5756 @kindex -msvr3
5757 @cindex assembler syntax, 88k
5758 @cindex SVr4
5759 Turn on (@samp{-msvr4}) or off (@samp{-msvr3}) compiler extensions
5760 related to System V release 4 (SVr4).  This controls the following:
5762 @enumerate
5763 @item
5764 Which variant of the assembler syntax to emit.
5765 @item
5766 @samp{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
5767 that is used on System V release 4.
5768 @item
5769 @samp{-msvr4} makes GCC issue additional declaration directives used in
5770 SVr4.
5771 @end enumerate
5773 @samp{-msvr4} is the default for the m88k-motorola-sysv4 and
5774 m88k-dg-dgux m88k configurations. @samp{-msvr3} is the default for all
5775 other m88k configurations.
5777 @item -mversion-03.00
5778 @kindex -mversion-03.00
5779 This option is obsolete, and is ignored.
5780 @c ??? which asm syntax better for GAS?  option there too?
5782 @item -mno-check-zero-division
5783 @itemx -mcheck-zero-division
5784 @kindex -mno-check-zero-division
5785 @kindex -mcheck-zero-division
5786 @cindex zero division on 88k
5787 Do, or don't, generate code to guarantee that integer division by
5788 zero will be detected.  By default, detection is guaranteed.
5790 Some models of the MC88100 processor fail to trap upon integer
5791 division by zero under certain conditions.  By default, when
5792 compiling code that might be run on such a processor, GNU C
5793 generates code that explicitly checks for zero-valued divisors
5794 and traps with exception number 503 when one is detected.  Use of
5795 mno-check-zero-division suppresses such checking for code
5796 generated to run on an MC88100 processor.
5798 GNU C assumes that the MC88110 processor correctly detects all
5799 instances of integer division by zero.  When @samp{-m88110} is
5800 specified, both @samp{-mcheck-zero-division} and
5801 @samp{-mno-check-zero-division} are ignored, and no explicit checks for
5802 zero-valued divisors are generated.
5804 @item -muse-div-instruction
5805 @kindex -muse-div-instruction
5806 @cindex divide instruction, 88k
5807 Use the div instruction for signed integer division on the
5808 MC88100 processor.  By default, the div instruction is not used.
5810 On the MC88100 processor the signed integer division instruction
5811 div) traps to the operating system on a negative operand.  The
5812 operating system transparently completes the operation, but at a
5813 large cost in execution time.  By default, when compiling code
5814 that might be run on an MC88100 processor, GNU C emulates signed
5815 integer division using the unsigned integer division instruction
5816 divu), thereby avoiding the large penalty of a trap to the
5817 operating system.  Such emulation has its own, smaller, execution
5818 cost in both time and space.  To the extent that your code's
5819 important signed integer division operations are performed on two
5820 nonnegative operands, it may be desirable to use the div
5821 instruction directly.
5823 On the MC88110 processor the div instruction (also known as the
5824 divs instruction) processes negative operands without trapping to
5825 the operating system.  When @samp{-m88110} is specified,
5826 @samp{-muse-div-instruction} is ignored, and the div instruction is used
5827 for signed integer division.
5829 Note that the result of dividing INT_MIN by -1 is undefined.  In
5830 particular, the behavior of such a division with and without
5831 @samp{-muse-div-instruction}  may differ.
5833 @item -mtrap-large-shift
5834 @itemx -mhandle-large-shift
5835 @kindex -mtrap-large-shift
5836 @kindex -mhandle-large-shift
5837 @cindex bit shift overflow (88k)
5838 @cindex large bit shifts (88k)
5839 Include code to detect bit-shifts of more than 31 bits; respectively,
5840 trap such shifts or emit code to handle them properly.  By default GCC
5841 makes no special provision for large bit shifts.
5843 @item -mwarn-passed-structs
5844 @kindex -mwarn-passed-structs
5845 @cindex structure passing (88k)
5846 Warn when a function passes a struct as an argument or result.
5847 Structure-passing conventions have changed during the evolution of the C
5848 language, and are often the source of portability problems.  By default,
5849 GCC issues no such warning.
5850 @end table
5852 @node RS/6000 and PowerPC Options
5853 @subsection IBM RS/6000 and PowerPC Options
5854 @cindex RS/6000 and PowerPC Options
5855 @cindex IBM RS/6000 and PowerPC Options
5857 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
5858 @table @gcctabopt
5859 @item -mpower
5860 @itemx -mno-power
5861 @itemx -mpower2
5862 @itemx -mno-power2
5863 @itemx -mpowerpc
5864 @itemx -mno-powerpc
5865 @itemx -mpowerpc-gpopt
5866 @itemx -mno-powerpc-gpopt
5867 @itemx -mpowerpc-gfxopt
5868 @itemx -mno-powerpc-gfxopt
5869 @itemx -mpowerpc64
5870 @itemx -mno-powerpc64
5871 @kindex -mpower
5872 @kindex -mpower2
5873 @kindex -mpowerpc
5874 @kindex -mpowerpc-gpopt
5875 @kindex -mpowerpc-gfxopt
5876 @kindex -mpowerpc64
5877 GCC supports two related instruction set architectures for the
5878 RS/6000 and PowerPC.  The @dfn{POWER} instruction set are those
5879 instructions supported by the @samp{rios} chip set used in the original
5880 RS/6000 systems and the @dfn{PowerPC} instruction set is the
5881 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
5882 the IBM 4xx microprocessors.
5884 Neither architecture is a subset of the other.  However there is a
5885 large common subset of instructions supported by both.  An MQ
5886 register is included in processors supporting the POWER architecture.
5888 You use these options to specify which instructions are available on the
5889 processor you are using.  The default value of these options is
5890 determined when configuring GCC.  Specifying the
5891 @samp{-mcpu=@var{cpu_type}} overrides the specification of these
5892 options.  We recommend you use the @samp{-mcpu=@var{cpu_type}} option
5893 rather than the options listed above.
5895 The @samp{-mpower} option allows GCC to generate instructions that
5896 are found only in the POWER architecture and to use the MQ register.
5897 Specifying @samp{-mpower2} implies @samp{-power} and also allows GCC
5898 to generate instructions that are present in the POWER2 architecture but
5899 not the original POWER architecture.
5901 The @samp{-mpowerpc} option allows GCC to generate instructions that
5902 are found only in the 32-bit subset of the PowerPC architecture.
5903 Specifying @samp{-mpowerpc-gpopt} implies @samp{-mpowerpc} and also allows
5904 GCC to use the optional PowerPC architecture instructions in the
5905 General Purpose group, including floating-point square root.  Specifying
5906 @samp{-mpowerpc-gfxopt} implies @samp{-mpowerpc} and also allows GCC to
5907 use the optional PowerPC architecture instructions in the Graphics
5908 group, including floating-point select.
5910 The @samp{-mpowerpc64} option allows GCC to generate the additional
5911 64-bit instructions that are found in the full PowerPC64 architecture
5912 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
5913 @samp{-mno-powerpc64}.
5915 If you specify both @samp{-mno-power} and @samp{-mno-powerpc}, GCC
5916 will use only the instructions in the common subset of both
5917 architectures plus some special AIX common-mode calls, and will not use
5918 the MQ register.  Specifying both @samp{-mpower} and @samp{-mpowerpc}
5919 permits GCC to use any instruction from either architecture and to
5920 allow use of the MQ register; specify this for the Motorola MPC601.
5922 @item -mnew-mnemonics
5923 @itemx -mold-mnemonics
5924 @kindex -mnew-mnemonics
5925 @kindex -mold-mnemonics
5926 Select which mnemonics to use in the generated assembler code.
5927 @samp{-mnew-mnemonics} requests output that uses the assembler mnemonics
5928 defined for the PowerPC architecture, while @samp{-mold-mnemonics}
5929 requests the assembler mnemonics defined for the POWER architecture.
5930 Instructions defined in only one architecture have only one mnemonic;
5931 GCC uses that mnemonic irrespective of which of these options is
5932 specified.
5934 GCC defaults to the mnemonics appropriate for the architecture in
5935 use.  Specifying @samp{-mcpu=@var{cpu_type}} sometimes overrides the
5936 value of these option.  Unless you are building a cross-compiler, you
5937 should normally not specify either @samp{-mnew-mnemonics} or
5938 @samp{-mold-mnemonics}, but should instead accept the default.
5940 @item -mcpu=@var{cpu_type}
5941 @kindex -mcpu
5942 Set architecture type, register usage, choice of mnemonics, and
5943 instruction scheduling parameters for machine type @var{cpu_type}.
5944 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
5945 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
5946 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
5947 @samp{630}, @samp{740}, @samp{750}, @samp{power}, @samp{power2},
5948 @samp{powerpc}, @samp{403}, @samp{505}, @samp{801}, @samp{821},
5949 @samp{823}, and @samp{860} and @samp{common}.  @samp{-mcpu=power},
5950 @samp{-mcpu=power2}, @samp{-mcpu=powerpc}, and @samp{-mcpu=powerpc64}
5951 specify generic POWER, POWER2, pure 32-bit PowerPC (i.e., not MPC601),
5952 and 64-bit PowerPC architecture machine types, with an appropriate,
5953 generic processor model assumed for scheduling purposes.@refill
5955 Specifying any of the following options: 
5956 @samp{-mcpu=rios1}, @samp{-mcpu=rios2}, @samp{-mcpu=rsc},
5957 @samp{-mcpu=power}, or @samp{-mcpu=power2}  
5958 enables the @samp{-mpower} option and disables the @samp{-mpowerpc} option; 
5959 @samp{-mcpu=601} enables both the @samp{-mpower} and @samp{-mpowerpc} options.
5960 All of @samp{-mcpu=rs64a}, @samp{-mcpu=602}, @samp{-mcpu=603},
5961 @samp{-mcpu=603e}, @samp{-mcpu=604}, @samp{-mcpu=620}, @samp{-mcpu=630},
5962 @samp{-mcpu=740}, and @samp{-mcpu=750}
5963 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.  
5964 Exactly similarly, all of @samp{-mcpu=403},
5965 @samp{-mcpu=505}, @samp{-mcpu=821}, @samp{-mcpu=860} and @samp{-mcpu=powerpc} 
5966 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
5967 @samp{-mcpu=common} disables both the 
5968 @samp{-mpower} and @samp{-mpowerpc} options.@refill
5970 AIX versions 4 or greater selects @samp{-mcpu=common} by default, so
5971 that code will operate on all members of the RS/6000 POWER and PowerPC
5972 families.  In that case, GCC will use only the instructions in the
5973 common subset of both architectures plus some special AIX common-mode
5974 calls, and will not use the MQ register.  GCC assumes a generic
5975 processor model for scheduling purposes.
5977 Specifying any of the options @samp{-mcpu=rios1}, @samp{-mcpu=rios2},
5978 @samp{-mcpu=rsc}, @samp{-mcpu=power}, or @samp{-mcpu=power2} also
5979 disables the @samp{new-mnemonics} option.  Specifying @samp{-mcpu=601},
5980 @samp{-mcpu=602}, @samp{-mcpu=603}, @samp{-mcpu=603e}, @samp{-mcpu=604},
5981 @samp{-mcpu=620}, @samp{-mcpu=630}, @samp{-mcpu=403}, @samp{-mcpu=505},
5982 @samp{-mcpu=821}, @samp{-mcpu=860} or @samp{-mcpu=powerpc} also enables
5983 the @samp{new-mnemonics} option.@refill
5985 Specifying @samp{-mcpu=403}, @samp{-mcpu=821}, or @samp{-mcpu=860} also
5986 enables the @samp{-msoft-float} option.
5988 @item -mtune=@var{cpu_type}
5989 Set the instruction scheduling parameters for machine type
5990 @var{cpu_type}, but do not set the architecture type, register usage,
5991 choice of mnemonics like @samp{-mcpu=}@var{cpu_type} would.  The same
5992 values for @var{cpu_type} are used for @samp{-mtune=}@var{cpu_type} as
5993 for @samp{-mcpu=}@var{cpu_type}.  The @samp{-mtune=}@var{cpu_type}
5994 option overrides the @samp{-mcpu=}@var{cpu_type} option in terms of
5995 instruction scheduling parameters.
5997 @item -mfull-toc
5998 @itemx -mno-fp-in-toc
5999 @itemx -mno-sum-in-toc
6000 @itemx -mminimal-toc
6001 @kindex -mminimal-toc
6002 Modify generation of the TOC (Table Of Contents), which is created for
6003 every executable file.  The @samp{-mfull-toc} option is selected by
6004 default.  In that case, GCC will allocate at least one TOC entry for
6005 each unique non-automatic variable reference in your program.  GCC
6006 will also place floating-point constants in the TOC.  However, only
6007 16,384 entries are available in the TOC.
6009 If you receive a linker error message that saying you have overflowed
6010 the available TOC space, you can reduce the amount of TOC space used
6011 with the @samp{-mno-fp-in-toc} and @samp{-mno-sum-in-toc} options.
6012 @samp{-mno-fp-in-toc} prevents GCC from putting floating-point
6013 constants in the TOC and @samp{-mno-sum-in-toc} forces GCC to
6014 generate code to calculate the sum of an address and a constant at
6015 run-time instead of putting that sum into the TOC.  You may specify one
6016 or both of these options.  Each causes GCC to produce very slightly
6017 slower and larger code at the expense of conserving TOC space.
6019 If you still run out of space in the TOC even when you specify both of
6020 these options, specify @samp{-mminimal-toc} instead.  This option causes
6021 GCC to make only one TOC entry for every file.  When you specify this
6022 option, GCC will produce code that is slower and larger but which
6023 uses extremely little TOC space.  You may wish to use this option
6024 only on files that contain less frequently executed code. @refill
6026 @item -maix64
6027 @itemx -maix32
6028 @kindex -maix64
6029 @kindex -maix32
6030 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6031 @code{long} type, and the infrastructure needed to support them.
6032 Specifying @samp{-maix64} implies @samp{-mpowerpc64} and
6033 @samp{-mpowerpc}, while @samp{-maix32} disables the 64-bit ABI and
6034 implies @samp{-mno-powerpc64}.  GCC defaults to @samp{-maix32}.
6036 @item -mxl-call
6037 @itemx -mno-xl-call
6038 @kindex -mxl-call
6039 On AIX, pass floating-point arguments to prototyped functions beyond the
6040 register save area (RSA) on the stack in addition to argument FPRs.  The
6041 AIX calling convention was extended but not initially documented to
6042 handle an obscure K&R C case of calling a function that takes the
6043 address of its arguments with fewer arguments than declared.  AIX XL
6044 compilers access floating point arguments which do not fit in the
6045 RSA from the stack when a subroutine is compiled without
6046 optimization.  Because always storing floating-point arguments on the
6047 stack is inefficient and rarely needed, this option is not enabled by
6048 default and only is necessary when calling subroutines compiled by AIX
6049 XL compilers without optimization.
6051 @item -mthreads
6052 @kindex -mthreads
6053 Support @dfn{AIX Threads}.  Link an application written to use
6054 @dfn{pthreads} with special libraries and startup code to enable the
6055 application to run.
6057 @item -mpe
6058 @kindex -mpe
6059 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE).  Link an
6060 application written to use message passing with special startup code to
6061 enable the application to run.  The system must have PE installed in the
6062 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6063 must be overridden with the @samp{-specs=} option to specify the
6064 appropriate directory location.  The Parallel Environment does not
6065 support threads, so the @samp{-mpe} option and the @samp{-mthreads}
6066 option are incompatible.
6068 @item -msoft-float
6069 @itemx -mhard-float
6070 @kindex -msoft-float
6071 Generate code that does not use (uses) the floating-point register set.
6072 Software floating point emulation is provided if you use the
6073 @samp{-msoft-float} option, and pass the option to GCC when linking.
6075 @item -mmultiple
6076 @itemx -mno-multiple
6077 Generate code that uses (does not use) the load multiple word
6078 instructions and the store multiple word instructions.  These
6079 instructions are generated by default on POWER systems, and not
6080 generated on PowerPC systems.  Do not use @samp{-mmultiple} on little
6081 endian PowerPC systems, since those instructions do not work when the
6082 processor is in little endian mode.  The exceptions are PPC740 and
6083 PPC750 which permit the instructions usage in little endian mode.
6085 @item -mstring
6086 @itemx -mno-string
6087 @kindex -mstring
6088 Generate code that uses (does not use) the load string instructions
6089 and the store string word instructions to save multiple registers and
6090 do small block moves.  These instructions are generated by default on
6091 POWER systems, and not generated on PowerPC systems.  Do not use
6092 @samp{-mstring} on little endian PowerPC systems, since those
6093 instructions do not work when the processor is in little endian mode.
6094 The exceptions are PPC740 and PPC750 which permit the instructions
6095 usage in little endian mode.
6097 @item -mupdate
6098 @itemx -mno-update
6099 @kindex -mupdate
6100 Generate code that uses (does not use) the load or store instructions
6101 that update the base register to the address of the calculated memory
6102 location.  These instructions are generated by default.  If you use
6103 @samp{-mno-update}, there is a small window between the time that the
6104 stack pointer is updated and the address of the previous frame is
6105 stored, which means code that walks the stack frame across interrupts or
6106 signals may get corrupted data.
6108 @item -mfused-madd
6109 @itemx -mno-fused-madd
6110 @kindex -mfused-madd
6111 Generate code that uses (does not use) the floating point multiply and
6112 accumulate instructions.  These instructions are generated by default if
6113 hardware floating is used.
6115 @item -mno-bit-align
6116 @itemx -mbit-align
6117 @kindex -mbit-align
6118 On System V.4 and embedded PowerPC systems do not (do) force structures
6119 and unions that contain bit fields to be aligned to the base type of the
6120 bit field.
6122 For example, by default a structure containing nothing but 8
6123 @code{unsigned} bitfields of length 1 would be aligned to a 4 byte
6124 boundary and have a size of 4 bytes.  By using @samp{-mno-bit-align},
6125 the structure would be aligned to a 1 byte boundary and be one byte in
6126 size.
6128 @item -mno-strict-align
6129 @itemx -mstrict-align
6130 @kindex -mstrict-align
6131 On System V.4 and embedded PowerPC systems do not (do) assume that
6132 unaligned memory references will be handled by the system.
6134 @item -mrelocatable
6135 @itemx -mno-relocatable
6136 @kindex -mrelocatable
6137 On embedded PowerPC systems generate code that allows (does not allow)
6138 the program to be relocated to a different address at runtime.  If you
6139 use @samp{-mrelocatable} on any module, all objects linked together must
6140 be compiled with @samp{-mrelocatable} or @samp{-mrelocatable-lib}.
6142 @item -mrelocatable-lib
6143 @itemx -mno-relocatable-lib
6144 On embedded PowerPC systems generate code that allows (does not allow)
6145 the program to be relocated to a different address at runtime.  Modules
6146 compiled with @samp{-mrelocatable-lib} can be linked with either modules
6147 compiled without @samp{-mrelocatable} and @samp{-mrelocatable-lib} or
6148 with modules compiled with the @samp{-mrelocatable} options.
6150 @item -mno-toc
6151 @itemx -mtoc
6152 On System V.4 and embedded PowerPC systems do not (do) assume that
6153 register 2 contains a pointer to a global area pointing to the addresses
6154 used in the program.
6156 @item -mlittle
6157 @itemx -mlittle-endian
6158 On System V.4 and embedded PowerPC systems compile code for the
6159 processor in little endian mode.  The @samp{-mlittle-endian} option is
6160 the same as @samp{-mlittle}.
6162 @item -mbig
6163 @itemx -mbig-endian
6164 On System V.4 and embedded PowerPC systems compile code for the
6165 processor in big endian mode.  The @samp{-mbig-endian} option is
6166 the same as @samp{-mbig}.
6168 @item -mcall-sysv
6169 On System V.4 and embedded PowerPC systems compile code using calling
6170 conventions that adheres to the March 1995 draft of the System V
6171 Application Binary Interface, PowerPC processor supplement.  This is the
6172 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6174 @item -mcall-sysv-eabi
6175 Specify both @samp{-mcall-sysv} and @samp{-meabi} options.
6177 @item -mcall-sysv-noeabi
6178 Specify both @samp{-mcall-sysv} and @samp{-mno-eabi} options.
6180 @item -mcall-aix
6181 On System V.4 and embedded PowerPC systems compile code using calling
6182 conventions that are similar to those used on AIX.  This is the
6183 default if you configured GCC using @samp{powerpc-*-eabiaix}.
6185 @item -mcall-solaris
6186 On System V.4 and embedded PowerPC systems compile code for the Solaris
6187 operating system.
6189 @item -mcall-linux
6190 On System V.4 and embedded PowerPC systems compile code for the
6191 Linux-based GNU system.
6193 @item -mprototype
6194 @itemx -mno-prototype
6195 On System V.4 and embedded PowerPC systems assume that all calls to
6196 variable argument functions are properly prototyped.  Otherwise, the
6197 compiler must insert an instruction before every non prototyped call to
6198 set or clear bit 6 of the condition code register (@var{CR}) to
6199 indicate whether floating point values were passed in the floating point
6200 registers in case the function takes a variable arguments.  With
6201 @samp{-mprototype}, only calls to prototyped variable argument functions
6202 will set or clear the bit.
6204 @item -msim
6205 On embedded PowerPC systems, assume that the startup module is called
6206 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6207 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
6208 configurations.
6210 @item -mmvme
6211 On embedded PowerPC systems, assume that the startup module is called
6212 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6213 @file{libc.a}.
6215 @item -mads
6216 On embedded PowerPC systems, assume that the startup module is called
6217 @file{crt0.o} and the standard C libraries are @file{libads.a} and
6218 @file{libc.a}.
6220 @item -myellowknife
6221 On embedded PowerPC systems, assume that the startup module is called
6222 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
6223 @file{libc.a}.
6225 @item -mvxworks
6226 On System V.4 and embedded PowerPC systems, specify that you are
6227 compiling for a VxWorks system.
6229 @item -memb
6230 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
6231 header to indicate that @samp{eabi} extended relocations are used.
6233 @item -meabi
6234 @itemx -mno-eabi
6235 On System V.4 and embedded PowerPC systems do (do not) adhere to the
6236 Embedded Applications Binary Interface (eabi) which is a set of
6237 modifications to the System V.4 specifications.  Selecting @option{-meabi}
6238 means that the stack is aligned to an 8 byte boundary, a function
6239 @code{__eabi} is called to from @code{main} to set up the eabi
6240 environment, and the @samp{-msdata} option can use both @code{r2} and
6241 @code{r13} to point to two separate small data areas.  Selecting
6242 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
6243 do not call an initialization function from @code{main}, and the
6244 @samp{-msdata} option will only use @code{r13} to point to a single
6245 small data area.  The @samp{-meabi} option is on by default if you
6246 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
6248 @item -msdata=eabi
6249 On System V.4 and embedded PowerPC systems, put small initialized
6250 @code{const} global and static data in the @samp{.sdata2} section, which
6251 is pointed to by register @code{r2}.  Put small initialized
6252 non-@code{const} global and static data in the @samp{.sdata} section,
6253 which is pointed to by register @code{r13}.  Put small uninitialized
6254 global and static data in the @samp{.sbss} section, which is adjacent to
6255 the @samp{.sdata} section.  The @samp{-msdata=eabi} option is
6256 incompatible with the @samp{-mrelocatable} option.  The
6257 @samp{-msdata=eabi} option also sets the @samp{-memb} option.
6259 @item -msdata=sysv
6260 On System V.4 and embedded PowerPC systems, put small global and static
6261 data in the @samp{.sdata} section, which is pointed to by register
6262 @code{r13}.  Put small uninitialized global and static data in the
6263 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
6264 The @samp{-msdata=sysv} option is incompatible with the
6265 @samp{-mrelocatable} option.
6267 @item -msdata=default
6268 @itemx -msdata
6269 On System V.4 and embedded PowerPC systems, if @samp{-meabi} is used,
6270 compile code the same as @samp{-msdata=eabi}, otherwise compile code the
6271 same as @samp{-msdata=sysv}.
6273 @item -msdata-data
6274 On System V.4 and embedded PowerPC systems, put small global and static
6275 data in the @samp{.sdata} section.  Put small uninitialized global and
6276 static data in the @samp{.sbss} section.  Do not use register @code{r13}
6277 to address small data however.  This is the default behavior unless
6278 other @samp{-msdata} options are used.
6280 @item -msdata=none
6281 @itemx -mno-sdata
6282 On embedded PowerPC systems, put all initialized global and static data
6283 in the @samp{.data} section, and all uninitialized data in the
6284 @samp{.bss} section.
6286 @item -G @var{num}
6287 @cindex smaller data references (PowerPC)
6288 @cindex .sdata/.sdata2 references (PowerPC)
6289 On embedded PowerPC systems, put global and static items less than or
6290 equal to @var{num} bytes into the small data or bss sections instead of
6291 the normal data or bss section.  By default, @var{num} is 8.  The
6292 @samp{-G @var{num}} switch is also passed to the linker.
6293 All modules should be compiled with the same @samp{-G @var{num}} value.
6295 @item -mregnames
6296 @itemx -mno-regnames
6297 On System V.4 and embedded PowerPC systems do (do not) emit register
6298 names in the assembly language output using symbolic forms.
6300 @end table
6302 @node RT Options
6303 @subsection IBM RT Options
6304 @cindex RT options
6305 @cindex IBM RT options
6307 These @samp{-m} options are defined for the IBM RT PC:
6309 @table @gcctabopt
6310 @item -min-line-mul
6311 Use an in-line code sequence for integer multiplies.  This is the
6312 default.
6314 @item -mcall-lib-mul
6315 Call @code{lmul$$} for integer multiples.
6317 @item -mfull-fp-blocks
6318 Generate full-size floating point data blocks, including the minimum
6319 amount of scratch space recommended by IBM.  This is the default.
6321 @item -mminimum-fp-blocks
6322 Do not include extra scratch space in floating point data blocks.  This
6323 results in smaller code, but slower execution, since scratch space must
6324 be allocated dynamically.
6326 @cindex @file{varargs.h} and RT PC
6327 @cindex @file{stdarg.h} and RT PC
6328 @item -mfp-arg-in-fpregs
6329 Use a calling sequence incompatible with the IBM calling convention in
6330 which floating point arguments are passed in floating point registers.
6331 Note that @code{varargs.h} and @code{stdargs.h} will not work with
6332 floating point operands if this option is specified.
6334 @item -mfp-arg-in-gregs
6335 Use the normal calling convention for floating point arguments.  This is
6336 the default.
6338 @item -mhc-struct-return
6339 Return structures of more than one word in memory, rather than in a
6340 register.  This provides compatibility with the MetaWare HighC (hc)
6341 compiler.  Use the option @samp{-fpcc-struct-return} for compatibility
6342 with the Portable C Compiler (pcc).
6344 @item -mnohc-struct-return
6345 Return some structures of more than one word in registers, when
6346 convenient.  This is the default.  For compatibility with the
6347 IBM-supplied compilers, use the option @samp{-fpcc-struct-return} or the
6348 option @samp{-mhc-struct-return}.
6349 @end table
6351 @node MIPS Options
6352 @subsection MIPS Options
6353 @cindex MIPS options
6355 These @samp{-m} options are defined for the MIPS family of computers:
6357 @table @gcctabopt
6358 @item -mcpu=@var{cpu type}
6359 Assume the defaults for the machine type @var{cpu type} when scheduling
6360 instructions.  The choices for @var{cpu type} are @samp{r2000}, @samp{r3000},
6361 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
6362 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
6363 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
6364 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
6365 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.  While picking a specific
6366 @var{cpu type} will schedule things appropriately for that particular
6367 chip, the compiler will not generate any code that does not meet level 1
6368 of the MIPS ISA (instruction set architecture) without a @samp{-mipsX}
6369 or @samp{-mabi} switch being used.
6371 @item -mips1
6372 Issue instructions from level 1 of the MIPS ISA.  This is the default.
6373 @samp{r3000} is the default @var{cpu type} at this ISA level.
6375 @item -mips2
6376 Issue instructions from level 2 of the MIPS ISA (branch likely, square
6377 root instructions).  @samp{r6000} is the default @var{cpu type} at this
6378 ISA level.
6380 @item -mips3
6381 Issue instructions from level 3 of the MIPS ISA (64 bit instructions).
6382 @samp{r4000} is the default @var{cpu type} at this ISA level.
6384 @item -mips4
6385 Issue instructions from level 4 of the MIPS ISA (conditional move,
6386 prefetch, enhanced FPU instructions).  @samp{r8000} is the default
6387 @var{cpu type} at this ISA level.
6389 @item -mfp32
6390 Assume that 32 32-bit floating point registers are available.  This is
6391 the default.
6393 @item -mfp64
6394 Assume that 32 64-bit floating point registers are available.  This is
6395 the default when the @samp{-mips3} option is used.
6397 @item -mgp32
6398 Assume that 32 32-bit general purpose registers are available.  This is
6399 the default.
6401 @item -mgp64
6402 Assume that 32 64-bit general purpose registers are available.  This is
6403 the default when the @samp{-mips3} option is used.
6405 @item -mint64
6406 Force int and long types to be 64 bits wide.  See @samp{-mlong32} for an
6407 explanation of the default, and the width of pointers.
6409 @item -mlong64
6410 Force long types to be 64 bits wide.  See @samp{-mlong32} for an
6411 explanation of the default, and the width of pointers.
6413 @item -mlong32
6414 Force long, int, and pointer types to be 32 bits wide.
6416 If none of @samp{-mlong32}, @samp{-mlong64}, or @samp{-mint64} are set,
6417 the size of ints, longs, and pointers depends on the ABI and ISA chosen.
6418 For @samp{-mabi=32}, and @samp{-mabi=n32}, ints and longs are 32 bits
6419 wide.  For @samp{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
6420 For @samp{-mabi=eabi} and either @samp{-mips1} or @samp{-mips2}, ints
6421 and longs are 32 bits wide.  For @samp{-mabi=eabi} and higher ISAs, ints
6422 are 32 bits, and longs are 64 bits wide.  The width of pointer types is
6423 the smaller of the width of longs or the width of general purpose
6424 registers (which in turn depends on the ISA).
6426 @item -mabi=32
6427 @itemx -mabi=o64
6428 @itemx -mabi=n32
6429 @itemx -mabi=64
6430 @itemx -mabi=eabi
6431 Generate code for the indicated ABI.  The default instruction level is
6432 @samp{-mips1} for @samp{32}, @samp{-mips3} for @samp{n32}, and
6433 @samp{-mips4} otherwise.  Conversely, with @samp{-mips1} or
6434 @samp{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
6435 is @samp{64}.
6437 @item -mmips-as
6438 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
6439 add normal debug information.  This is the default for all
6440 platforms except for the OSF/1 reference platform, using the OSF/rose
6441 object format.  If the either of the @samp{-gstabs} or @samp{-gstabs+}
6442 switches are used, the @file{mips-tfile} program will encapsulate the
6443 stabs within MIPS ECOFF.
6445 @item -mgas
6446 Generate code for the GNU assembler.  This is the default on the OSF/1
6447 reference platform, using the OSF/rose object format.  Also, this is
6448 the default if the configure option @samp{--with-gnu-as} is used.
6450 @item -msplit-addresses
6451 @itemx -mno-split-addresses
6452 Generate code to load the high and low parts of address constants separately.
6453 This allows @code{gcc} to optimize away redundant loads of the high order
6454 bits of addresses.  This optimization requires GNU as and GNU ld.
6455 This optimization is enabled by default for some embedded targets where
6456 GNU as and GNU ld are standard.
6458 @item -mrnames
6459 @itemx -mno-rnames
6460 The @samp{-mrnames} switch says to output code using the MIPS software
6461 names for the registers, instead of the hardware names (ie, @var{a0}
6462 instead of @var{$4}).  The only known assembler that supports this option
6463 is the Algorithmics assembler.
6465 @item -mgpopt
6466 @itemx -mno-gpopt
6467 The @samp{-mgpopt} switch says to write all of the data declarations
6468 before the instructions in the text section, this allows the MIPS
6469 assembler to generate one word memory references instead of using two
6470 words for short global or static data items.  This is on by default if
6471 optimization is selected.
6473 @item -mstats
6474 @itemx -mno-stats
6475 For each non-inline function processed, the @samp{-mstats} switch
6476 causes the compiler to emit one line to the standard error file to
6477 print statistics about the program (number of registers saved, stack
6478 size, etc.).
6480 @item -mmemcpy
6481 @itemx -mno-memcpy
6482 The @samp{-mmemcpy} switch makes all block moves call the appropriate
6483 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
6484 generating inline code.
6486 @item -mmips-tfile
6487 @itemx -mno-mips-tfile
6488 The @samp{-mno-mips-tfile} switch causes the compiler not
6489 postprocess the object file with the @file{mips-tfile} program,
6490 after the MIPS assembler has generated it to add debug support.  If
6491 @file{mips-tfile} is not run, then no local variables will be
6492 available to the debugger.  In addition, @file{stage2} and
6493 @file{stage3} objects will have the temporary file names passed to the
6494 assembler embedded in the object file, which means the objects will
6495 not compare the same.  The @samp{-mno-mips-tfile} switch should only
6496 be used when there are bugs in the @file{mips-tfile} program that
6497 prevents compilation.
6499 @item -msoft-float
6500 Generate output containing library calls for floating point.
6501 @strong{Warning:} the requisite libraries are not part of GCC.
6502 Normally the facilities of the machine's usual C compiler are used, but
6503 this can't be done directly in cross-compilation.  You must make your
6504 own arrangements to provide suitable library functions for
6505 cross-compilation.
6507 @item -mhard-float
6508 Generate output containing floating point instructions.  This is the
6509 default if you use the unmodified sources.
6511 @item -mabicalls
6512 @itemx -mno-abicalls
6513 Emit (or do not emit) the pseudo operations @samp{.abicalls},
6514 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
6515 position independent code.
6517 @item -mlong-calls
6518 @itemx -mno-long-calls
6519 Do all calls with the @samp{JALR} instruction, which requires
6520 loading up a function's address into a register before the call.
6521 You need to use this switch, if you call outside of the current
6522 512 megabyte segment to functions that are not through pointers.
6524 @item -mhalf-pic
6525 @itemx -mno-half-pic
6526 Put pointers to extern references into the data section and load them
6527 up, rather than put the references in the text section.
6529 @item -membedded-pic
6530 @itemx -mno-embedded-pic
6531 Generate PIC code suitable for some embedded systems.  All calls are
6532 made using PC relative address, and all data is addressed using the $gp
6533 register.  No more than 65536 bytes of global data may be used.  This
6534 requires GNU as and GNU ld which do most of the work.  This currently
6535 only works on targets which use ECOFF; it does not work with ELF.
6537 @item -membedded-data
6538 @itemx -mno-embedded-data
6539 Allocate variables to the read-only data section first if possible, then
6540 next in the small data section if possible, otherwise in data.  This gives
6541 slightly slower code than the default, but reduces the amount of RAM required
6542 when executing, and thus may be preferred for some embedded systems.
6544 @item -muninit-const-in-rodata
6545 @itemx -mno-uninit-const-in-rodata
6546 When used together with -membedded-data, it will always store uninitialized
6547 const variables in the read-only data section.
6548   
6549 @item -msingle-float
6550 @itemx -mdouble-float
6551 The @samp{-msingle-float} switch tells gcc to assume that the floating
6552 point coprocessor only supports single precision operations, as on the
6553 @samp{r4650} chip.  The @samp{-mdouble-float} switch permits gcc to use
6554 double precision operations.  This is the default.
6556 @item -mmad
6557 @itemx -mno-mad
6558 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
6559 as on the @samp{r4650} chip.
6561 @item -m4650
6562 Turns on @samp{-msingle-float}, @samp{-mmad}, and, at least for now,
6563 @samp{-mcpu=r4650}.
6565 @item -mips16
6566 @itemx -mno-mips16
6567 Enable 16-bit instructions.
6569 @item -mentry
6570 Use the entry and exit pseudo ops.  This option can only be used with
6571 @samp{-mips16}.
6573 @item -EL
6574 Compile code for the processor in little endian mode.
6575 The requisite libraries are assumed to exist.
6577 @item -EB
6578 Compile code for the processor in big endian mode.
6579 The requisite libraries are assumed to exist.
6581 @item -G @var{num}
6582 @cindex smaller data references (MIPS)
6583 @cindex gp-relative references (MIPS)
6584 Put global and static items less than or equal to @var{num} bytes into
6585 the small data or bss sections instead of the normal data or bss
6586 section.  This allows the assembler to emit one word memory reference
6587 instructions based on the global pointer (@var{gp} or @var{$28}),
6588 instead of the normal two words used.  By default, @var{num} is 8 when
6589 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
6590 @samp{-G @var{num}} switch is also passed to the assembler and linker.
6591 All modules should be compiled with the same @samp{-G @var{num}}
6592 value.
6594 @item -nocpp
6595 Tell the MIPS assembler to not run its preprocessor over user
6596 assembler files (with a @samp{.s} suffix) when assembling them.
6598 @item -mfix7000
6599 Pass an option to gas which will cause nops to be inserted if
6600 the read of the destination register of an mfhi or mflo instruction
6601 occurs in the following two instructions.
6603 @item -no-crt0
6604 Do not include the default crt0.
6605 @end table
6607 @ifset INTERNALS
6608 These options are defined by the macro
6609 @code{TARGET_SWITCHES} in the machine description.  The default for the
6610 options is also defined by that macro, which enables you to change the
6611 defaults.
6612 @end ifset
6614 @node i386 Options
6615 @subsection Intel 386 Options
6616 @cindex i386 Options
6617 @cindex Intel 386 Options
6619 These @samp{-m} options are defined for the i386 family of computers:
6621 @table @gcctabopt
6622 @item -mcpu=@var{cpu type}
6623 Assume the defaults for the machine type @var{cpu type} when scheduling
6624 instructions.  The choices for @var{cpu type} are @samp{i386},
6625 @samp{i486}, @samp{i586}, @samp{i686}, @samp{pentium},
6626 @samp{pentiumpro}, @samp{pentium4}, @samp{k6}, and @samp{athlon}
6628 While picking a specific @var{cpu type} will schedule things appropriately
6629 for that particular chip, the compiler will not generate any code that
6630 does not run on the i386 without the @samp{-march=@var{cpu type}} option
6631 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
6632 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
6633 AMD chips as opposed to the Intel ones.
6635 @item -march=@var{cpu type}
6636 Generate instructions for the machine type @var{cpu type}.  The choices
6637 for @var{cpu type} are the same as for @samp{-mcpu}.  Moreover, 
6638 specifying @samp{-march=@var{cpu type}} implies @samp{-mcpu=@var{cpu type}}.
6640 @item -m386
6641 @itemx -m486
6642 @itemx -mpentium
6643 @itemx -mpentiumpro
6644 Synonyms for -mcpu=i386, -mcpu=i486, -mcpu=pentium, and -mcpu=pentiumpro
6645 respectively.  These synonyms are deprecated.
6647 @item -mintel-syntax
6648 Emit assembly using Intel syntax opcodes instead of AT&T syntax.
6650 @item -mieee-fp
6651 @itemx -mno-ieee-fp
6652 Control whether or not the compiler uses IEEE floating point
6653 comparisons.  These handle correctly the case where the result of a
6654 comparison is unordered.
6656 @item -msoft-float
6657 Generate output containing library calls for floating point.
6658 @strong{Warning:} the requisite libraries are not part of GCC.
6659 Normally the facilities of the machine's usual C compiler are used, but
6660 this can't be done directly in cross-compilation.  You must make your
6661 own arrangements to provide suitable library functions for
6662 cross-compilation.
6664 On machines where a function returns floating point results in the 80387
6665 register stack, some floating point opcodes may be emitted even if
6666 @samp{-msoft-float} is used.
6668 @item -mno-fp-ret-in-387
6669 Do not use the FPU registers for return values of functions.
6671 The usual calling convention has functions return values of types
6672 @code{float} and @code{double} in an FPU register, even if there
6673 is no FPU.  The idea is that the operating system should emulate
6674 an FPU.
6676 The option @samp{-mno-fp-ret-in-387} causes such values to be returned
6677 in ordinary CPU registers instead.
6679 @item -mno-fancy-math-387
6680 Some 387 emulators do not support the @code{sin}, @code{cos} and
6681 @code{sqrt} instructions for the 387.  Specify this option to avoid
6682 generating those instructions. This option is the default on FreeBSD.
6683 As of revision 2.6.1, these instructions are not generated unless you
6684 also use the @samp{-funsafe-math-optimizations} switch.
6686 @item -malign-double
6687 @itemx -mno-align-double
6688 Control whether GCC aligns @code{double}, @code{long double}, and
6689 @code{long long} variables on a two word boundary or a one word
6690 boundary.  Aligning @code{double} variables on a two word boundary will
6691 produce code that runs somewhat faster on a @samp{Pentium} at the
6692 expense of more memory.
6694 @item -m128bit-long-double
6695 @itemx -m128bit-long-double
6696 Control the size of @code{long double} type. i386 application binary interface
6697 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
6698 preffer @code{long double} aligned to 8 or 16 byte boundary.  This is
6699 impossible to reach with 12 byte long doubles in the array accesses.
6701 @strong{Warning:} if you use the @samp{-m128bit-long-double} switch, the
6702 structures and arrays containing @code{long double} will change their size as
6703 well as function calling convention for function taking @code{long double}
6704 will be modified. 
6706 @item -m96bit-long-double
6707 @itemx -m96bit-long-double
6708 Set the size of @code{long double} to 96 bits as required by the i386
6709 application binary interface.  This is the default.
6711 @item -msvr3-shlib
6712 @itemx -mno-svr3-shlib
6713 Control whether GCC places uninitialized locals into @code{bss} or
6714 @code{data}.  @samp{-msvr3-shlib} places these locals into @code{bss}.
6715 These options are meaningful only on System V Release 3.
6717 @item -mno-wide-multiply
6718 @itemx -mwide-multiply
6719 Control whether GCC uses the @code{mul} and @code{imul} that produce
6720 64 bit results in @code{eax:edx} from 32 bit operands to do @code{long
6721 long} multiplies and 32-bit division by constants.
6723 @item -mrtd
6724 Use a different function-calling convention, in which functions that
6725 take a fixed number of arguments return with the @code{ret} @var{num}
6726 instruction, which pops their arguments while returning.  This saves one
6727 instruction in the caller since there is no need to pop the arguments
6728 there.
6730 You can specify that an individual function is called with this calling
6731 sequence with the function attribute @samp{stdcall}.  You can also
6732 override the @samp{-mrtd} option by using the function attribute
6733 @samp{cdecl}.  @xref{Function Attributes}.
6735 @strong{Warning:} this calling convention is incompatible with the one
6736 normally used on Unix, so you cannot use it if you need to call
6737 libraries compiled with the Unix compiler.
6739 Also, you must provide function prototypes for all functions that
6740 take variable numbers of arguments (including @code{printf});
6741 otherwise incorrect code will be generated for calls to those
6742 functions.
6744 In addition, seriously incorrect code will result if you call a
6745 function with too many arguments.  (Normally, extra arguments are
6746 harmlessly ignored.)
6748 @item -mregparm=@var{num}
6749 Control how many registers are used to pass integer arguments.  By
6750 default, no registers are used to pass arguments, and at most 3
6751 registers can be used.  You can control this behavior for a specific
6752 function by using the function attribute @samp{regparm}.
6753 @xref{Function Attributes}.
6755 @strong{Warning:} if you use this switch, and
6756 @var{num} is nonzero, then you must build all modules with the same
6757 value, including any libraries.  This includes the system libraries and
6758 startup modules.
6760 @item -malign-loops=@var{num}
6761 Align loops to a 2 raised to a @var{num} byte boundary.  If
6762 @samp{-malign-loops} is not specified, the default is 2 unless
6763 gas 2.8 (or later) is being used in which case the default is
6764 to align the loop on a 16 byte boundary if it is less than 8
6765 bytes away.
6767 @item -malign-jumps=@var{num}
6768 Align instructions that are only jumped to to a 2 raised to a @var{num}
6769 byte boundary.  If @samp{-malign-jumps} is not specified, the default is
6770 2 if optimizing for a 386, and 4 if optimizing for a 486 unless
6771 gas 2.8 (or later) is being used in which case the default is
6772 to align the instruction on a 16 byte boundary if it is less
6773 than 8 bytes away.
6775 @item -malign-functions=@var{num}
6776 Align the start of functions to a 2 raised to @var{num} byte boundary.
6777 If @samp{-malign-functions} is not specified, the default is 2 if optimizing
6778 for a 386, and 4 if optimizing for a 486.
6780 @item -mpreferred-stack-boundary=@var{num}
6781 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
6782 byte boundary.  If @samp{-mpreferred-stack-boundary} is not specified,
6783 the default is 4 (16 bytes or 128 bits).
6785 The stack is required to be aligned on a 4 byte boundary.  On Pentium
6786 and PentiumPro, @code{double} and @code{long double} values should be
6787 aligned to an 8 byte boundary (see @samp{-malign-double}) or suffer
6788 significant run time performance penalties.  On Pentium III, the
6789 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
6790 penalties if it is not 16 byte aligned.
6792 To ensure proper alignment of this values on the stack, the stack boundary
6793 must be as aligned as that required by any value stored on the stack. 
6794 Further, every function must be generated such that it keeps the stack
6795 aligned.  Thus calling a function compiled with a higher preferred
6796 stack boundary from a function compiled with a lower preferred stack
6797 boundary will most likely misalign the stack.  It is recommended that
6798 libraries that use callbacks always use the default setting.
6800 This extra alignment does consume extra stack space.  Code that is sensitive
6801 to stack space usage, such as embedded systems and operating system kernels,
6802 may want to reduce the preferred alignment to
6803 @samp{-mpreferred-stack-boundary=2}.
6805 @item -mpush-args
6806 @kindex -mpush-args
6807 Use PUSH operations to store outgoing parameters. This method is shorter
6808 and usually equally fast as method using SUB/MOV operations and is enabled
6809 by default. In some cases disabling it may improve performance because of
6810 improved scheduling and reduced dependencies.
6812 @item -maccumulate-outgoing-args
6813 @kindex -maccumulate-outgoing-args
6814 If enabled, the maximum amount of space required for outgoing arguments will be
6815 computed in the function prologue. This in faster on most modern CPUs
6816 because of reduced dependencies, improved scheduling and reduced stack usage
6817 when preferred stack boundary is not equal to 2.  The drawback is a notable
6818 increase in code size. This switch implies -mno-push-args.
6820 @item -mthreads
6821 @kindex -mthreads
6822 Support thread-safe exception handling on @samp{Mingw32}. Code that relies 
6823 on thread-safe exception handling must compile and link all code with the 
6824 @samp{-mthreads} option. When compiling, @samp{-mthreads} defines 
6825 @samp{-D_MT}; when linking, it links in a special thread helper library 
6826 @samp{-lmingwthrd} which cleans up per thread exception handling data.
6828 @item -mno-align-stringops
6829 @kindex -mno-align-stringops
6830 Do not align destination of inlined string operations. This switch reduces
6831 code size and improves performance in case the destination is already aligned,
6832 but gcc don't know about it.
6834 @item -minline-all-stringops
6835 @kindex -minline-all-stringops
6836 By default GCC inlines string operations only when destination is known to be
6837 aligned at least to 4 byte boundary. This enables more inlining, increase code
6838 size, but may improve performance of code that depends on fast memcpy, strlen
6839 and memset for short lengths.
6840 @end table
6842 @node HPPA Options
6843 @subsection HPPA Options
6844 @cindex HPPA Options
6846 These @samp{-m} options are defined for the HPPA family of computers:
6848 @table @gcctabopt
6849 @item -march=@var{architecture type}
6850 Generate code for the specified architecture.  The choices for
6851 @var{architecture type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
6852 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
6853 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
6854 architecture option for your machine.  Code compiled for lower numbered
6855 architectures will run on higher numbered architectures, but not the
6856 other way around.
6858 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
6859 next release of binutils (current is 2.9.1) will probably contain PA 2.0
6860 support.  
6862 @item -mpa-risc-1-0
6863 @itemx -mpa-risc-1-1
6864 @itemx -mpa-risc-2-0
6865 Synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively.
6867 @item -mbig-switch
6868 Generate code suitable for big switch tables.  Use this option only if
6869 the assembler/linker complain about out of range branches within a switch
6870 table.
6872 @item -mjump-in-delay
6873 Fill delay slots of function calls with unconditional jump instructions
6874 by modifying the return pointer for the function call to be the target
6875 of the conditional jump.
6877 @item -mdisable-fpregs
6878 Prevent floating point registers from being used in any manner.  This is
6879 necessary for compiling kernels which perform lazy context switching of
6880 floating point registers.  If you use this option and attempt to perform
6881 floating point operations, the compiler will abort.
6883 @item -mdisable-indexing
6884 Prevent the compiler from using indexing address modes.  This avoids some
6885 rather obscure problems when compiling MIG generated code under MACH.
6887 @item -mno-space-regs
6888 Generate code that assumes the target has no space registers.  This allows
6889 GCC to generate faster indirect calls and use unscaled index address modes.
6891 Such code is suitable for level 0 PA systems and kernels.
6893 @item -mfast-indirect-calls
6894 Generate code that assumes calls never cross space boundaries.  This
6895 allows GCC to emit code which performs faster indirect calls.
6897 This option will not work in the presence of shared libraries or nested
6898 functions.
6900 @item -mlong-load-store
6901 Generate 3-instruction load and store sequences as sometimes required by
6902 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
6903 the HP compilers.
6905 @item -mportable-runtime
6906 Use the portable calling conventions proposed by HP for ELF systems.
6908 @item -mgas
6909 Enable the use of assembler directives only GAS understands.
6911 @item -mschedule=@var{cpu type}
6912 Schedule code according to the constraints for the machine type
6913 @var{cpu type}.  The choices for @var{cpu type} are @samp{700} 
6914 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}.  Refer to 
6915 @file{/usr/lib/sched.models} on an HP-UX system to determine the
6916 proper scheduling option for your machine.
6918 @item -mlinker-opt
6919 Enable the optimization pass in the HPUX linker.  Note this makes symbolic
6920 debugging impossible.  It also triggers a bug in the HPUX 8 and HPUX 9 linkers
6921 in which they give bogus error messages when linking some programs.
6923 @item -msoft-float
6924 Generate output containing library calls for floating point.
6925 @strong{Warning:} the requisite libraries are not available for all HPPA
6926 targets.  Normally the facilities of the machine's usual C compiler are
6927 used, but this cannot be done directly in cross-compilation.  You must make
6928 your own arrangements to provide suitable library functions for
6929 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
6930 does provide software floating point support.
6932 @samp{-msoft-float} changes the calling convention in the output file;
6933 therefore, it is only useful if you compile @emph{all} of a program with
6934 this option.  In particular, you need to compile @file{libgcc.a}, the
6935 library that comes with GCC, with @samp{-msoft-float} in order for
6936 this to work.
6937 @end table
6939 @node Intel 960 Options
6940 @subsection Intel 960 Options
6942 These @samp{-m} options are defined for the Intel 960 implementations:
6944 @table @gcctabopt
6945 @item -m@var{cpu type}
6946 Assume the defaults for the machine type @var{cpu type} for some of
6947 the other options, including instruction scheduling, floating point
6948 support, and addressing modes.  The choices for @var{cpu type} are
6949 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
6950 @samp{sa}, and @samp{sb}.
6951 The default is
6952 @samp{kb}.
6954 @item -mnumerics
6955 @itemx -msoft-float
6956 The @samp{-mnumerics} option indicates that the processor does support
6957 floating-point instructions.  The @samp{-msoft-float} option indicates
6958 that floating-point support should not be assumed.
6960 @item -mleaf-procedures
6961 @itemx -mno-leaf-procedures
6962 Do (or do not) attempt to alter leaf procedures to be callable with the
6963 @code{bal} instruction as well as @code{call}.  This will result in more
6964 efficient code for explicit calls when the @code{bal} instruction can be
6965 substituted by the assembler or linker, but less efficient code in other
6966 cases, such as calls via function pointers, or using a linker that doesn't
6967 support this optimization.
6969 @item -mtail-call
6970 @itemx -mno-tail-call
6971 Do (or do not) make additional attempts (beyond those of the
6972 machine-independent portions of the compiler) to optimize tail-recursive
6973 calls into branches.  You may not want to do this because the detection of
6974 cases where this is not valid is not totally complete.  The default is
6975 @samp{-mno-tail-call}.
6977 @item -mcomplex-addr
6978 @itemx -mno-complex-addr
6979 Assume (or do not assume) that the use of a complex addressing mode is a
6980 win on this implementation of the i960.  Complex addressing modes may not
6981 be worthwhile on the K-series, but they definitely are on the C-series.
6982 The default is currently @samp{-mcomplex-addr} for all processors except
6983 the CB and CC.
6985 @item -mcode-align
6986 @itemx -mno-code-align
6987 Align code to 8-byte boundaries for faster fetching (or don't bother).
6988 Currently turned on by default for C-series implementations only.
6990 @ignore
6991 @item -mclean-linkage
6992 @itemx -mno-clean-linkage
6993 These options are not fully implemented.
6994 @end ignore
6996 @item -mic-compat
6997 @itemx -mic2.0-compat
6998 @itemx -mic3.0-compat
6999 Enable compatibility with iC960 v2.0 or v3.0.
7001 @item -masm-compat
7002 @itemx -mintel-asm
7003 Enable compatibility with the iC960 assembler.
7005 @item -mstrict-align
7006 @itemx -mno-strict-align
7007 Do not permit (do permit) unaligned accesses.
7009 @item -mold-align
7010 Enable structure-alignment compatibility with Intel's gcc release version
7011 1.3 (based on gcc 1.37).  This option implies @samp{-mstrict-align}.
7013 @item -mlong-double-64
7014 Implement type @samp{long double} as 64-bit floating point numbers.
7015 Without the option @samp{long double} is implemented by 80-bit
7016 floating point numbers.  The only reason we have it because there is
7017 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
7018 is only useful for people using soft-float targets.  Otherwise, we
7019 should recommend against use of it.
7021 @end table
7023 @node DEC Alpha Options
7024 @subsection DEC Alpha Options
7026 These @samp{-m} options are defined for the DEC Alpha implementations:
7028 @table @gcctabopt
7029 @item -mno-soft-float
7030 @itemx -msoft-float
7031 Use (do not use) the hardware floating-point instructions for
7032 floating-point operations.  When @option{-msoft-float} is specified,
7033 functions in @file{libgcc1.c} will be used to perform floating-point
7034 operations.  Unless they are replaced by routines that emulate the
7035 floating-point operations, or compiled in such a way as to call such
7036 emulations routines, these routines will issue floating-point
7037 operations.   If you are compiling for an Alpha without floating-point
7038 operations, you must ensure that the library is built so as not to call
7039 them.
7041 Note that Alpha implementations without floating-point operations are
7042 required to have floating-point registers.
7044 @item -mfp-reg
7045 @itemx -mno-fp-regs
7046 Generate code that uses (does not use) the floating-point register set.
7047 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7048 register set is not used, floating point operands are passed in integer
7049 registers as if they were integers and floating-point results are passed
7050 in $0 instead of $f0.  This is a non-standard calling sequence, so any
7051 function with a floating-point argument or return value called by code
7052 compiled with @option{-mno-fp-regs} must also be compiled with that
7053 option.
7055 A typical use of this option is building a kernel that does not use,
7056 and hence need not save and restore, any floating-point registers.
7058 @item -mieee
7059 The Alpha architecture implements floating-point hardware optimized for
7060 maximum performance.  It is mostly compliant with the IEEE floating
7061 point standard.  However, for full compliance, software assistance is
7062 required.  This option generates code fully IEEE compliant code
7063 @emph{except} that the @var{inexact flag} is not maintained (see below).
7064 If this option is turned on, the CPP macro @code{_IEEE_FP} is defined
7065 during compilation.  The option is a shorthand for: @samp{-D_IEEE_FP
7066 -mfp-trap-mode=su -mtrap-precision=i -mieee-conformant}.  The resulting
7067 code is less efficient but is able to correctly support denormalized
7068 numbers and exceptional IEEE values such as not-a-number and plus/minus
7069 infinity.  Other Alpha compilers call this option
7070 @option{-ieee_with_no_inexact}.
7072 @item -mieee-with-inexact
7073 @c overfull hbox here --bob 22 jul96
7074 @c original text between ignore ... end ignore
7075 @ignore
7076 This is like @samp{-mieee} except the generated code also maintains the
7077 IEEE @var{inexact flag}.  Turning on this option causes the generated
7078 code to implement fully-compliant IEEE math.  The option is a shorthand
7079 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus @samp{-mieee-conformant},
7080 @samp{-mfp-trap-mode=sui}, and @samp{-mtrap-precision=i}.  On some Alpha
7081 implementations the resulting code may execute significantly slower than
7082 the code generated by default.  Since there is very little code that
7083 depends on the @var{inexact flag}, you should normally not specify this
7084 option.  Other Alpha compilers call this option
7085 @samp{-ieee_with_inexact}.
7086 @end ignore
7087 @c            changed paragraph
7088 This is like @samp{-mieee} except the generated code also maintains the
7089 IEEE @var{inexact flag}.  Turning on this option causes the generated
7090 code to implement fully-compliant IEEE math.  The option is a shorthand
7091 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus the three following:
7092 @samp{-mieee-conformant},
7093 @samp{-mfp-trap-mode=sui}, 
7094 and @samp{-mtrap-precision=i}.  
7095 On some Alpha implementations the resulting code may execute
7096 significantly slower than the code generated by default.  Since there
7097 is very little code that depends on the @var{inexact flag}, you should
7098 normally not specify this option.  Other Alpha compilers call this
7099 option @samp{-ieee_with_inexact}.
7100 @c             end changes to prevent overfull hboxes
7102 @item -mfp-trap-mode=@var{trap mode}
7103 This option controls what floating-point related traps are enabled.
7104 Other Alpha compilers call this option @samp{-fptm }@var{trap mode}.
7105 The trap mode can be set to one of four values:
7107 @table @samp
7108 @item n
7109 This is the default (normal) setting.  The only traps that are enabled
7110 are the ones that cannot be disabled in software (e.g., division by zero
7111 trap).
7113 @item u
7114 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7115 as well.
7117 @item su
7118 Like @samp{su}, but the instructions are marked to be safe for software
7119 completion (see Alpha architecture manual for details).
7121 @item sui
7122 Like @samp{su}, but inexact traps are enabled as well.
7123 @end table
7125 @item -mfp-rounding-mode=@var{rounding mode}
7126 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7127 @samp{-fprm }@var{rounding mode}.  The @var{rounding mode} can be one
7130 @table @samp
7131 @item n
7132 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7133 the nearest machine number or towards the even machine number in case
7134 of a tie.
7136 @item m
7137 Round towards minus infinity.
7139 @item c
7140 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7142 @item d
7143 Dynamic rounding mode.  A field in the floating point control register
7144 (@var{fpcr}, see Alpha architecture reference manual) controls the
7145 rounding mode in effect.  The C library initializes this register for
7146 rounding towards plus infinity.  Thus, unless your program modifies the
7147 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7148 @end table
7150 @item -mtrap-precision=@var{trap precision}
7151 In the Alpha architecture, floating point traps are imprecise.  This
7152 means without software assistance it is impossible to recover from a
7153 floating trap and program execution normally needs to be terminated.
7154 GCC can generate code that can assist operating system trap handlers
7155 in determining the exact location that caused a floating point trap.
7156 Depending on the requirements of an application, different levels of
7157 precisions can be selected:
7159 @table @samp
7160 @item p
7161 Program precision.  This option is the default and means a trap handler
7162 can only identify which program caused a floating point exception.
7164 @item f
7165 Function precision.  The trap handler can determine the function that
7166 caused a floating point exception.
7168 @item i
7169 Instruction precision.  The trap handler can determine the exact
7170 instruction that caused a floating point exception.
7171 @end table
7173 Other Alpha compilers provide the equivalent options called
7174 @samp{-scope_safe} and @samp{-resumption_safe}.
7176 @item -mieee-conformant
7177 This option marks the generated code as IEEE conformant.  You must not
7178 use this option unless you also specify @samp{-mtrap-precision=i} and either
7179 @samp{-mfp-trap-mode=su} or @samp{-mfp-trap-mode=sui}.  Its only effect
7180 is to emit the line @samp{.eflag 48} in the function prologue of the
7181 generated assembly file.  Under DEC Unix, this has the effect that
7182 IEEE-conformant math library routines will be linked in.
7184 @item -mbuild-constants
7185 Normally GCC examines a 32- or 64-bit integer constant to
7186 see if it can construct it from smaller constants in two or three
7187 instructions.  If it cannot, it will output the constant as a literal and
7188 generate code to load it from the data segment at runtime.
7190 Use this option to require GCC to construct @emph{all} integer constants
7191 using code, even if it takes more instructions (the maximum is six).
7193 You would typically use this option to build a shared library dynamic
7194 loader.  Itself a shared library, it must relocate itself in memory
7195 before it can find the variables and constants in its own data segment.
7197 @item -malpha-as
7198 @itemx -mgas
7199 Select whether to generate code to be assembled by the vendor-supplied
7200 assembler (@samp{-malpha-as}) or by the GNU assembler @samp{-mgas}.
7202 @item -mbwx
7203 @itemx -mno-bwx
7204 @itemx -mcix
7205 @itemx -mno-cix
7206 @itemx -mmax
7207 @itemx -mno-max
7208 Indicate whether GCC should generate code to use the optional BWX,
7209 CIX, and MAX instruction sets.  The default is to use the instruction sets
7210 supported by the CPU type specified via @samp{-mcpu=} option or that
7211 of the CPU on which GCC was built if none was specified.
7213 @item -mcpu=@var{cpu_type}
7214 Set the instruction set, register set, and instruction scheduling
7215 parameters for machine type @var{cpu_type}.  You can specify either the
7216 @samp{EV} style name or the corresponding chip number.  GCC
7217 supports scheduling parameters for the EV4 and EV5 family of processors
7218 and will choose the default values for the instruction set from
7219 the processor you specify.  If you do not specify a processor type,
7220 GCC will default to the processor on which the compiler was built.
7222 Supported values for @var{cpu_type} are
7224 @table @samp
7225 @item ev4
7226 @itemx 21064
7227 Schedules as an EV4 and has no instruction set extensions.
7229 @item ev5
7230 @itemx 21164
7231 Schedules as an EV5 and has no instruction set extensions.
7233 @item ev56
7234 @itemx 21164a
7235 Schedules as an EV5 and supports the BWX extension.
7237 @item pca56
7238 @itemx 21164pc
7239 @itemx 21164PC
7240 Schedules as an EV5 and supports the BWX and MAX extensions.
7242 @item ev6
7243 @itemx 21264
7244 Schedules as an EV5 (until Digital releases the scheduling parameters
7245 for the EV6) and supports the BWX, CIX, and MAX extensions.
7246 @end table
7248 @item -mmemory-latency=@var{time}
7249 Sets the latency the scheduler should assume for typical memory
7250 references as seen by the application.  This number is highly
7251 dependent on the memory access patterns used by the application
7252 and the size of the external cache on the machine.
7254 Valid options for @var{time} are
7256 @table @samp
7257 @item @var{number}
7258 A decimal number representing clock cycles.
7260 @item L1
7261 @itemx L2
7262 @itemx L3
7263 @itemx main
7264 The compiler contains estimates of the number of clock cycles for
7265 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7266 (also called Dcache, Scache, and Bcache), as well as to main memory.
7267 Note that L3 is only valid for EV5.
7269 @end table
7270 @end table
7272 @node Clipper Options
7273 @subsection Clipper Options
7275 These @samp{-m} options are defined for the Clipper implementations:
7277 @table @gcctabopt
7278 @item -mc300
7279 Produce code for a C300 Clipper processor. This is the default.
7281 @item -mc400
7282 Produce code for a C400 Clipper processor i.e. use floating point
7283 registers f8..f15.
7284 @end table
7286 @node H8/300 Options
7287 @subsection H8/300 Options
7289 These @samp{-m} options are defined for the H8/300 implementations:
7291 @table @gcctabopt
7292 @item -mrelax
7293 Shorten some address references at link time, when possible; uses the
7294 linker option @samp{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
7295 ld.info, Using ld}, for a fuller description.
7297 @item -mh
7298 Generate code for the H8/300H.
7300 @item -ms
7301 Generate code for the H8/S.
7303 @item -ms2600
7304 Generate code for the H8/S2600.  This switch must be used with -ms.
7306 @item -mint32
7307 Make @code{int} data 32 bits by default.
7309 @item -malign-300
7310 On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
7311 The default for the H8/300H and H8/S is to align longs and floats on 4
7312 byte boundaries.
7313 @samp{-malign-300} causes them to be aligned on 2 byte boundaries.
7314 This option has no effect on the H8/300.
7315 @end table
7317 @node SH Options
7318 @subsection SH Options
7320 These @samp{-m} options are defined for the SH implementations:
7322 @table @gcctabopt
7323 @item -m1
7324 Generate code for the SH1.
7326 @item -m2
7327 Generate code for the SH2.
7329 @item -m3
7330 Generate code for the SH3.
7332 @item -m3e
7333 Generate code for the SH3e.
7335 @item -m4-nofpu
7336 Generate code for the SH4 without a floating-point unit.
7338 @item -m4-single-only
7339 Generate code for the SH4 with a floating-point unit that only
7340 supports single-precision arithmentic.
7342 @item -m4-single
7343 Generate code for the SH4 assuming the floating-point unit is in
7344 single-precision mode by default.
7346 @item -m4
7347 Generate code for the SH4.
7349 @item -mb
7350 Compile code for the processor in big endian mode.
7352 @item -ml
7353 Compile code for the processor in little endian mode.
7355 @item -mdalign
7356 Align doubles at 64 bit boundaries.  Note that this changes the calling
7357 conventions, and thus some functions from the standard C library will
7358 not work unless you recompile it first with -mdalign.
7360 @item -mrelax
7361 Shorten some address references at link time, when possible; uses the
7362 linker option @samp{-relax}.
7364 @item -mbigtable
7365 Use 32-bit offsets in @code{switch} tables.  The default is to use
7366 16-bit offsets.
7368 @item -mfmovd
7369 Enable the use of the instruction @code{fmovd}.
7371 @item -mhitachi
7372 Comply with the calling conventions defined by Hitachi.
7374 @item -mnomacsave
7375 Mark the @code{MAC} register as call-clobbered, even if
7376 @option{-mhitachi} is given.
7378 @item -misize
7379 Dump instruction size and location in the assembly code.
7381 @item -mpadstruct
7382 This option is deprecated.  It pads structures to multiple of 4 bytes,
7383 which is incompatible with the SH ABI.
7385 @item -mspace
7386 Optimize for space instead of speed.  Implied by @option{-Os}.
7388 @item -mprefergot
7389 When generating position-independent code, emit function calls using
7390 the Global Offset Table instead of the Procedure Linkage Table.
7392 @item -musermode
7393 Generate a library function call to invalidate instruction cache
7394 entries, after fixing up a trampoline.  This library function call
7395 doesn't assume it can write to the whole memory address space.  This
7396 is the default when the target is @code{sh-*-linux*}.
7397 @end table
7399 @node System V Options
7400 @subsection Options for System V
7402 These additional options are available on System V Release 4 for
7403 compatibility with other compilers on those systems:
7405 @table @gcctabopt
7406 @item -G
7407 Create a shared object.
7408 It is recommended that @samp{-symbolic} or @samp{-shared} be used instead.
7410 @item -Qy
7411 Identify the versions of each tool used by the compiler, in a
7412 @code{.ident} assembler directive in the output.
7414 @item -Qn
7415 Refrain from adding @code{.ident} directives to the output file (this is
7416 the default).
7418 @item -YP\,@var{dirs}
7419 Search the directories @var{dirs}, and no others, for libraries
7420 specified with @samp{-l}.
7422 @item -Ym\,@var{dir}
7423 Look in the directory @var{dir} to find the M4 preprocessor.
7424 The assembler uses this option.
7425 @c This is supposed to go with a -Yd for predefined M4 macro files, but
7426 @c the generic assembler that comes with Solaris takes just -Ym.
7427 @end table
7429 @node TMS320C3x/C4x Options
7430 @subsection TMS320C3x/C4x Options
7431 @cindex TMS320C3x/C4x Options
7433 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
7435 @table @gcctabopt
7437 @item -mcpu=@var{cpu_type}
7438 Set the instruction set, register set, and instruction scheduling
7439 parameters for machine type @var{cpu_type}.  Supported values for
7440 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
7441 @samp{c44}.  The default is @samp{c40} to generate code for the
7442 TMS320C40.
7444 @item -mbig-memory
7445 @item -mbig
7446 @itemx -msmall-memory
7447 @itemx -msmall
7448 Generates code for the big or small memory model.  The small memory
7449 model assumed that all data fits into one 64K word page.  At run-time
7450 the data page (DP) register must be set to point to the 64K page
7451 containing the .bss and .data program sections.  The big memory model is
7452 the default and requires reloading of the DP register for every direct
7453 memory access.
7455 @item -mbk
7456 @itemx -mno-bk
7457 Allow (disallow) allocation of general integer operands into the block
7458 count register BK. 
7460 @item -mdb
7461 @itemx -mno-db
7462 Enable (disable) generation of code using decrement and branch,
7463 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
7464 on the safe side, this is disabled for the C3x, since the maximum
7465 iteration count on the C3x is 2^23 + 1 (but who iterates loops more than
7466 2^23 times on the C3x?).  Note that GCC will try to reverse a loop so
7467 that it can utilise the decrement and branch instruction, but will give
7468 up if there is more than one memory reference in the loop.  Thus a loop
7469 where the loop counter is decremented can generate slightly more
7470 efficient code, in cases where the RPTB instruction cannot be utilised.
7472 @item -mdp-isr-reload
7473 @itemx -mparanoid
7474 Force the DP register to be saved on entry to an interrupt service
7475 routine (ISR), reloaded to point to the data section, and restored on
7476 exit from the ISR.  This should not be required unless someone has
7477 violated the small memory model by modifying the DP register, say within
7478 an object library.
7480 @item -mmpyi
7481 @itemx -mno-mpyi
7482 For the C3x use the 24-bit MPYI instruction for integer multiplies
7483 instead of a library call to guarantee 32-bit results.  Note that if one
7484 of the operands is a constant, then the multiplication will be performed
7485 using shifts and adds.  If the -mmpyi option is not specified for the C3x,
7486 then squaring operations are performed inline instead of a library call.
7488 @item -mfast-fix
7489 @itemx -mno-fast-fix
7490 The C3x/C4x FIX instruction to convert a floating point value to an
7491 integer value chooses the nearest integer less than or equal to the
7492 floating point value rather than to the nearest integer.  Thus if the
7493 floating point number is negative, the result will be incorrectly
7494 truncated an additional code is necessary to detect and correct this
7495 case.  This option can be used to disable generation of the additional
7496 code required to correct the result.
7498 @item -mrptb
7499 @itemx -mno-rptb
7500 Enable (disable) generation of repeat block sequences using the RPTB
7501 instruction for zero overhead looping.  The RPTB construct is only used
7502 for innermost loops that do not call functions or jump across the loop
7503 boundaries.  There is no advantage having nested RPTB loops due to the
7504 overhead required to save and restore the RC, RS, and RE registers.
7505 This is enabled by default with -O2.
7507 @item -mrpts=@var{count}
7508 @itemx -mno-rpts
7509 Enable (disable) the use of the single instruction repeat instruction
7510 RPTS.  If a repeat block contains a single instruction, and the loop
7511 count can be guaranteed to be less than the value @var{count}, GCC will
7512 emit a RPTS instruction instead of a RPTB.  If no value is specified,
7513 then a RPTS will be emitted even if the loop count cannot be determined
7514 at compile time.  Note that the repeated instruction following RPTS does
7515 not have to be reloaded from memory each iteration, thus freeing up the
7516 CPU buses for operands.  However, since interrupts are blocked by this
7517 instruction, it is disabled by default.
7519 @item -mloop-unsigned
7520 @itemx -mno-loop-unsigned
7521 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
7522 is 2^31 + 1 since these instructions test if the iteration count is
7523 negative to terminate the loop.  If the iteration count is unsigned
7524 there is a possibility than the 2^31 + 1 maximum iteration count may be
7525 exceeded.  This switch allows an unsigned iteration count.
7527 @item -mti
7528 Try to emit an assembler syntax that the TI assembler (asm30) is happy
7529 with.  This also enforces compatibility with the API employed by the TI
7530 C3x C compiler.  For example, long doubles are passed as structures
7531 rather than in floating point registers.
7533 @item -mregparm
7534 @itemx -mmemparm
7535 Generate code that uses registers (stack) for passing arguments to functions.
7536 By default, arguments are passed in registers where possible rather
7537 than by pushing arguments on to the stack.
7539 @item -mparallel-insns
7540 @itemx -mno-parallel-insns
7541 Allow the generation of parallel instructions.  This is enabled by
7542 default with -O2.
7544 @item -mparallel-mpy
7545 @itemx -mno-parallel-mpy
7546 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
7547 provided -mparallel-insns is also specified.  These instructions have
7548 tight register constraints which can pessimize the code generation
7549 of large functions.
7551 @end table
7553 @node V850 Options
7554 @subsection V850 Options
7555 @cindex V850 Options
7557 These @samp{-m} options are defined for V850 implementations:
7559 @table @gcctabopt
7560 @item -mlong-calls
7561 @itemx -mno-long-calls
7562 Treat all calls as being far away (near).  If calls are assumed to be
7563 far away, the compiler will always load the functions address up into a
7564 register, and call indirect through the pointer.
7566 @item -mno-ep
7567 @itemx -mep
7568 Do not optimize (do optimize) basic blocks that use the same index
7569 pointer 4 or more times to copy pointer into the @code{ep} register, and
7570 use the shorter @code{sld} and @code{sst} instructions.  The @samp{-mep}
7571 option is on by default if you optimize.
7573 @item -mno-prolog-function
7574 @itemx -mprolog-function
7575 Do not use (do use) external functions to save and restore registers at
7576 the prolog and epilog of a function.  The external functions are slower,
7577 but use less code space if more than one function saves the same number
7578 of registers.  The @samp{-mprolog-function} option is on by default if
7579 you optimize.
7581 @item -mspace
7582 Try to make the code as small as possible.  At present, this just turns
7583 on the @samp{-mep} and @samp{-mprolog-function} options.
7585 @item -mtda=@var{n}
7586 Put static or global variables whose size is @var{n} bytes or less into
7587 the tiny data area that register @code{ep} points to.  The tiny data
7588 area can hold up to 256 bytes in total (128 bytes for byte references).
7590 @item -msda=@var{n}
7591 Put static or global variables whose size is @var{n} bytes or less into
7592 the small data area that register @code{gp} points to.  The small data
7593 area can hold up to 64 kilobytes.
7595 @item -mzda=@var{n}
7596 Put static or global variables whose size is @var{n} bytes or less into
7597 the first 32 kilobytes of memory.
7599 @item -mv850
7600 Specify that the target processor is the V850.
7602 @item -mbig-switch
7603 Generate code suitable for big switch tables.  Use this option only if
7604 the assembler/linker complain about out of range branches within a switch
7605 table.
7606 @end table
7608 @node ARC Options
7609 @subsection ARC Options
7610 @cindex ARC Options
7612 These options are defined for ARC implementations:
7614 @table @gcctabopt
7615 @item -EL
7616 Compile code for little endian mode.  This is the default.
7618 @item -EB
7619 Compile code for big endian mode.
7621 @item -mmangle-cpu
7622 Prepend the name of the cpu to all public symbol names.
7623 In multiple-processor systems, there are many ARC variants with different
7624 instruction and register set characteristics.  This flag prevents code
7625 compiled for one cpu to be linked with code compiled for another.
7626 No facility exists for handling variants that are "almost identical".
7627 This is an all or nothing option.
7629 @item -mcpu=@var{cpu}
7630 Compile code for ARC variant @var{cpu}.
7631 Which variants are supported depend on the configuration.
7632 All variants support @samp{-mcpu=base}, this is the default.
7634 @item -mtext=@var{text section}
7635 @itemx -mdata=@var{data section}
7636 @itemx -mrodata=@var{readonly data section}
7637 Put functions, data, and readonly data in @var{text section},
7638 @var{data section}, and @var{readonly data section} respectively
7639 by default.  This can be overridden with the @code{section} attribute.
7640 @xref{Variable Attributes}.
7642 @end table
7644 @node NS32K Options
7645 @subsection NS32K Options
7646 @cindex NS32K options
7648 These are the @samp{-m} options defined for the 32000 series.  The default
7649 values for these options depends on which style of 32000 was selected when
7650 the compiler was configured; the defaults for the most common choices are
7651 given below.
7653 @table @gcctabopt
7654 @item -m32032
7655 @itemx -m32032
7656 Generate output for a 32032.  This is the default
7657 when the compiler is configured for 32032 and 32016 based systems.
7659 @item -m32332
7660 @itemx -m32332
7661 Generate output for a 32332.  This is the default
7662 when the compiler is configured for 32332-based systems.
7664 @item -m32532
7665 @itemx -m32532
7666 Generate output for a 32532.  This is the default
7667 when the compiler is configured for 32532-based systems.
7669 @item -m32081
7670 Generate output containing 32081 instructions for floating point.
7671 This is the default for all systems.
7673 @item -m32381
7674 Generate output containing 32381 instructions for floating point.  This
7675 also implies @samp{-m32081}. The 32381 is only compatible with the 32332
7676 and 32532 cpus. This is the default for the pc532-netbsd configuration.
7678 @item -mmulti-add
7679 Try and generate multiply-add floating point instructions @code{polyF}
7680 and @code{dotF}. This option is only available if the @samp{-m32381}
7681 option is in effect. Using these instructions requires changes to to
7682 register allocation which generally has a negative impact on
7683 performance.  This option should only be enabled when compiling code
7684 particularly likely to make heavy use of multiply-add instructions.
7686 @item -mnomulti-add
7687 Do not try and generate multiply-add floating point instructions
7688 @code{polyF} and @code{dotF}. This is the default on all platforms.
7690 @item -msoft-float
7691 Generate output containing library calls for floating point.
7692 @strong{Warning:} the requisite libraries may not be available.
7694 @item -mnobitfield
7695 Do not use the bit-field instructions. On some machines it is faster to
7696 use shifting and masking operations. This is the default for the pc532.
7698 @item -mbitfield
7699 Do use the bit-field instructions. This is the default for all platforms
7700 except the pc532.
7702 @item -mrtd
7703 Use a different function-calling convention, in which functions
7704 that take a fixed number of arguments return pop their
7705 arguments on return with the @code{ret} instruction.
7707 This calling convention is incompatible with the one normally
7708 used on Unix, so you cannot use it if you need to call libraries
7709 compiled with the Unix compiler.
7711 Also, you must provide function prototypes for all functions that
7712 take variable numbers of arguments (including @code{printf});
7713 otherwise incorrect code will be generated for calls to those
7714 functions.
7716 In addition, seriously incorrect code will result if you call a
7717 function with too many arguments.  (Normally, extra arguments are
7718 harmlessly ignored.)
7720 This option takes its name from the 680x0 @code{rtd} instruction.
7723 @item -mregparam
7724 Use a different function-calling convention where the first two arguments
7725 are passed in registers.
7727 This calling convention is incompatible with the one normally
7728 used on Unix, so you cannot use it if you need to call libraries
7729 compiled with the Unix compiler.
7731 @item -mnoregparam
7732 Do not pass any arguments in registers. This is the default for all
7733 targets.
7735 @item -msb
7736 It is OK to use the sb as an index register which is always loaded with
7737 zero. This is the default for the pc532-netbsd target.
7739 @item -mnosb
7740 The sb register is not available for use or has not been initialized to
7741 zero by the run time system. This is the default for all targets except
7742 the pc532-netbsd. It is also implied whenever @samp{-mhimem} or
7743 @samp{-fpic} is set.
7745 @item -mhimem
7746 Many ns32000 series addressing modes use displacements of up to 512MB.
7747 If an address is above 512MB then displacements from zero can not be used.
7748 This option causes code to be generated which can be loaded above 512MB.
7749 This may be useful for operating systems or ROM code.
7751 @item -mnohimem
7752 Assume code will be loaded in the first 512MB of virtual address space.
7753 This is the default for all platforms.
7756 @end table
7758 @node AVR Options
7759 @subsection AVR Options
7760 @cindex AVR Options
7762 These options are defined for AVR implementations:
7764 @table @gcctabopt
7765 @item -mmcu=@var{mcu}
7766 Specify ATMEL AVR instruction set or MCU type.
7768 Instruction set avr1 is for the minimal AVR core, not supported by the C
7769 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7770 attiny11, attiny12, attiny15, attiny28).
7772 Instruction set avr2 (default) is for the classic AVR core with up to
7773 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7774 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7775 at90c8534, at90s8535).
7777 Instruction set avr3 is for the classic AVR core with up to 128K program
7778 memory space (MCU types: atmega103, atmega603).
7780 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7781 memory space (MCU types: atmega83, atmega85).
7783 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7784 memory space (MCU types: atmega161, atmega163, atmega32, at94k).
7786 @item -msize
7787 Output instruction sizes to the asm file.
7789 @item -minit-stack=@var{N}
7790 Specify the initial stack address, which may be a symbol or numeric value,
7791 __stack is the default.
7793 @item -mno-interrupts
7794 Generated code is not compatible with hardware interrupts.
7795 Code size will be smaller.
7797 @item -mcall-prologues
7798 Functions prologues/epilogues expanded as call to appropriate
7799 subroutines. Code size will be smaller.
7801 @item -mno-tablejump
7802 Do not generate tablejump insns which sometimes increase code size.
7804 @item -mtiny-stack
7805 Change only the low 8 bits of the stack pointer.
7806 @end table
7808 @node MCore Options
7809 @subsection MCore Options
7810 @cindex MCore options
7812 These are the @samp{-m} options defined for the Motorola M*Core
7813 processors.  
7815 @table @gcctabopt
7817 @item -mhardlit
7818 @itemx -mhardlit
7819 @itemx -mno-hardlit
7820 Inline constants into the code stream if it can be done in two
7821 instructions or less.
7823 @item -mdiv
7824 @itemx -mdiv
7825 @itemx -mno-div
7826 Use the divide instruction.  (Enabled by default).
7828 @item -mrelax-immediate
7829 @itemx -mrelax-immediate
7830 @itemx -mno-relax-immediate
7831 Allow arbitrary sized immediates in bit operations.
7833 @item -mwide-bitfields
7834 @itemx -mwide-bitfields
7835 @itemx -mno-wide-bitfields
7836 Always treat bitfields as int-sized.
7838 @item -m4byte-functions
7839 @itemx -m4byte-functions
7840 @itemx -mno-4byte-functions
7841 Force all functions to be aligned to a four byte boundary.
7843 @item -mcallgraph-data
7844 @itemx -mcallgraph-data
7845 @itemx -mno-callgraph-data
7846 Emit callgraph information.
7848 @item -mslow-bytes
7849 @itemx -mslow-bytes
7850 @itemx -mno-slow-bytes
7851 Prefer word access when reading byte quantities.
7853 @item -mlittle-endian
7854 @itemx -mlittle-endian
7855 @itemx -mbig-endian
7856 Generate code for a little endian target.
7858 @item -m210
7859 @itemx -m210
7860 @itemx -m340
7861 Generate code for the 210 processor.
7862 @end table
7864 @node IA-64 Options
7865 @subsection IA-64 Options
7866 @cindex IA-64 Options
7868 These are the @samp{-m} options defined for the Intel IA-64 architecture.
7870 @table @gcctabopt
7871 @item -mbig-endian
7872 Generate code for a big endian target.  This is the default for HPUX.
7874 @item -mlittle-endian
7875 Generate code for a little endian target.  This is the default for AIX5
7876 and Linux.
7878 @item -mgnu-as
7879 @itemx -mno-gnu-as
7880 Generate (or don't) code for the GNU assembler.  This is the default.
7881 @c Also, this is the default if the configure option @samp{--with-gnu-as}
7882 @c is used.
7884 @item -mgnu-ld
7885 @itemx -mno-gnu-ld
7886 Generate (or don't) code for the GNU linker.  This is the default.
7887 @c Also, this is the default if the configure option @samp{--with-gnu-ld}
7888 @c is used.
7890 @item -mno-pic
7891 Generate code that does not use a global pointer register.  The result
7892 is not position independent code, and violates the IA-64 ABI.
7894 @item -mvolatile-asm-stop
7895 @itemx -mno-volatile-asm-stop
7896 Generate (or don't) a stop bit immediately before and after volatile asm
7897 statements.
7899 @item -mb-step
7900 Generate code that works around Itanium B step errata.
7902 @item -mregister-names
7903 @itemx -mno-register-names
7904 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
7905 the stacked registers.  This may make assembler output more readable.
7907 @item -mno-sdata
7908 @itemx -msdata
7909 Disable (or enable) optimizations that use the small data section.  This may
7910 be useful for working around optimizer bugs.
7912 @item -mconstant-gp
7913 Generate code that uses a single constant global pointer value.  This is
7914 useful when compiling kernel code.
7916 @item -mauto-pic
7917 Generate code that is self-relocatable.  This implies @samp{-mconstant-gp}.
7918 This is useful when compiling firmware code.
7920 @item -minline-divide-min-latency
7921 Generate code for inline divides using the minimum latency algorithm.
7923 @item -minline-divide-max-throughput
7924 Generate code for inline divides using the maximum throughput algorithm.
7926 @item -mno-dwarf2-asm
7927 @itemx -mdwarf2-asm
7928 Don't (or do) generate assembler code for the DWARF2 line number debugging
7929 info.  This may be useful when not using the GNU assembler.
7931 @item -mfixed-range=@var{register range}
7932 Generate code treating the given register range as fixed registers.
7933 A fixed register is one that the register allocator can not use.  This is
7934 useful when compiling kernel code.  A register range is specified as
7935 two registers separated by a dash.  Multiple register ranges can be
7936 specified separated by a comma.
7937 @end table
7939 @node D30V Options
7940 @subsection D30V Options
7941 @cindex D30V Options
7943 These @samp{-m} options are defined for D30V implementations:
7945 @table @gcctabopt
7946 @item -mextmem
7947 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
7948 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
7949 memory, which starts at location @code{0x80000000}.
7951 @item -mextmemory
7952 Same as the @samp{-mextmem} switch.
7954 @item -monchip
7955 Link the @samp{.text} section into onchip text memory, which starts at
7956 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
7957 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
7958 into onchip data memory, which starts at location @code{0x20000000}.
7960 @item -mno-asm-optimize
7961 @itemx -masm-optimize
7962 Disable (enable) passing @samp{-O} to the assembler when optimizing.
7963 The assembler uses the @samp{-O} option to automatically parallelize
7964 adjacent short instructions where possible.
7966 @item -mbranch-cost=@var{n}
7967 Increase the internal costs of branches to @var{n}.  Higher costs means
7968 that the compiler will issue more instructions to avoid doing a branch.
7969 The default is 2.
7971 @item -mcond-exec=@var{n}
7972 Specify the maximum number of conditionally executed instructions that
7973 replace a branch.  The default is 4.
7974 @end table
7976 @node Code Gen Options
7977 @section Options for Code Generation Conventions
7978 @cindex code generation conventions
7979 @cindex options, code generation
7980 @cindex run-time options
7982 These machine-independent options control the interface conventions
7983 used in code generation.
7985 Most of them have both positive and negative forms; the negative form
7986 of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below, only
7987 one of the forms is listed---the one which is not the default.  You
7988 can figure out the other form by either removing @samp{no-} or adding
7991 @table @gcctabopt
7992 @item -fexceptions
7993 Enable exception handling. Generates extra code needed to propagate
7994 exceptions.  For some targets, this implies GNU CC will generate frame
7995 unwind information for all functions, which can produce significant data
7996 size overhead, although it does not affect execution.  If you do not
7997 specify this option, GNU CC will enable it by default for languages like
7998 C++ which normally require exception handling, and disable itfor
7999 languages like C that do not normally require it.  However, you may need
8000 to enable this option when compiling C code that needs to interoperate
8001 properly with exception handlers written in C++.  You may also wish to
8002 disable this option if you are compiling older C++ programs that don't
8003 use exception handling.
8005 @item -funwind-tables
8006 Similar to @option{-fexceptions}, except that it will just generate any needed
8007 static data, but will not affect the generated code in any other way.
8008 You will normally not enable this option; instead, a language processor
8009 that needs this handling would enable it on your behalf.
8011 @item -fpcc-struct-return
8012 Return ``short'' @code{struct} and @code{union} values in memory like
8013 longer ones, rather than in registers.  This convention is less
8014 efficient, but it has the advantage of allowing intercallability between
8015 GCC-compiled files and files compiled with other compilers.
8017 The precise convention for returning structures in memory depends
8018 on the target configuration macros.
8020 Short structures and unions are those whose size and alignment match
8021 that of some integer type.
8023 @item -freg-struct-return
8024 Use the convention that @code{struct} and @code{union} values are
8025 returned in registers when possible.  This is more efficient for small
8026 structures than @samp{-fpcc-struct-return}.
8028 If you specify neither @samp{-fpcc-struct-return} nor its contrary
8029 @samp{-freg-struct-return}, GCC defaults to whichever convention is
8030 standard for the target.  If there is no standard convention, GCC
8031 defaults to @samp{-fpcc-struct-return}, except on targets where GCC
8032 is the principal compiler.  In those cases, we can choose the standard,
8033 and we chose the more efficient register return alternative.
8035 @item -fshort-enums
8036 Allocate to an @code{enum} type only as many bytes as it needs for the
8037 declared range of possible values.  Specifically, the @code{enum} type
8038 will be equivalent to the smallest integer type which has enough room.
8040 @item -fshort-double
8041 Use the same size for @code{double} as for @code{float}.
8043 @item -fshared-data
8044 Requests that the data and non-@code{const} variables of this
8045 compilation be shared data rather than private data.  The distinction
8046 makes sense only on certain operating systems, where shared data is
8047 shared between processes running the same program, while private data
8048 exists in one copy per process.
8050 @item -fno-common
8051 Allocate even uninitialized global variables in the data section of the
8052 object file, rather than generating them as common blocks.  This has the
8053 effect that if the same variable is declared (without @code{extern}) in
8054 two different compilations, you will get an error when you link them.
8055 The only reason this might be useful is if you wish to verify that the
8056 program will work on other systems which always work this way.
8058 @item -fno-ident
8059 Ignore the @samp{#ident} directive.
8061 @item -fno-gnu-linker
8062 Do not output global initializations (such as C++ constructors and
8063 destructors) in the form used by the GNU linker (on systems where the GNU
8064 linker is the standard method of handling them).  Use this option when
8065 you want to use a non-GNU linker, which also requires using the
8066 @command{collect2} program to make sure the system linker includes
8067 constructors and destructors.  (@command{collect2} is included in the GCC
8068 distribution.)  For systems which @emph{must} use @command{collect2}, the
8069 compiler driver @command{gcc} is configured to do this automatically.
8071 @item -finhibit-size-directive
8072 Don't output a @code{.size} assembler directive, or anything else that
8073 would cause trouble if the function is split in the middle, and the
8074 two halves are placed at locations far apart in memory.  This option is
8075 used when compiling @file{crtstuff.c}; you should not need to use it
8076 for anything else.
8078 @item -fverbose-asm
8079 Put extra commentary information in the generated assembly code to
8080 make it more readable.  This option is generally only of use to those
8081 who actually need to read the generated assembly code (perhaps while
8082 debugging the compiler itself).
8084 @samp{-fno-verbose-asm}, the default, causes the
8085 extra information to be omitted and is useful when comparing two assembler
8086 files.
8088 @item -fvolatile
8089 Consider all memory references through pointers to be volatile.
8091 @item -fvolatile-global
8092 Consider all memory references to extern and global data items to
8093 be volatile.  GCC does not consider static data items to be volatile
8094 because of this switch.
8096 @item -fvolatile-static
8097 Consider all memory references to static data to be volatile.
8099 @item -fpic
8100 @cindex global offset table
8101 @cindex PIC
8102 Generate position-independent code (PIC) suitable for use in a shared
8103 library, if supported for the target machine.  Such code accesses all
8104 constant addresses through a global offset table (GOT).  The dynamic
8105 loader resolves the GOT entries when the program starts (the dynamic
8106 loader is not part of GCC; it is part of the operating system).  If
8107 the GOT size for the linked executable exceeds a machine-specific
8108 maximum size, you get an error message from the linker indicating that
8109 @samp{-fpic} does not work; in that case, recompile with @samp{-fPIC}
8110 instead.  (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
8111 on the m68k and RS/6000.  The 386 has no such limit.)
8113 Position-independent code requires special support, and therefore works
8114 only on certain machines.  For the 386, GCC supports PIC for System V
8115 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
8116 position-independent.
8118 @item -fPIC
8119 If supported for the target machine, emit position-independent code,
8120 suitable for dynamic linking and avoiding any limit on the size of the
8121 global offset table.  This option makes a difference on the m68k, m88k,
8122 and the Sparc.
8124 Position-independent code requires special support, and therefore works
8125 only on certain machines.
8127 @item -ffixed-@var{reg}
8128 Treat the register named @var{reg} as a fixed register; generated code
8129 should never refer to it (except perhaps as a stack pointer, frame
8130 pointer or in some other fixed role).
8132 @var{reg} must be the name of a register.  The register names accepted
8133 are machine-specific and are defined in the @code{REGISTER_NAMES}
8134 macro in the machine description macro file.
8136 This flag does not have a negative form, because it specifies a
8137 three-way choice.
8139 @item -fcall-used-@var{reg}
8140 Treat the register named @var{reg} as an allocable register that is
8141 clobbered by function calls.  It may be allocated for temporaries or
8142 variables that do not live across a call.  Functions compiled this way
8143 will not save and restore the register @var{reg}.
8145 It is an error to used this flag with the frame pointer or stack pointer.
8146 Use of this flag for other registers that have fixed pervasive roles in
8147 the machine's execution model will produce disastrous results.
8149 This flag does not have a negative form, because it specifies a
8150 three-way choice.
8152 @item -fcall-saved-@var{reg}
8153 Treat the register named @var{reg} as an allocable register saved by
8154 functions.  It may be allocated even for temporaries or variables that
8155 live across a call.  Functions compiled this way will save and restore
8156 the register @var{reg} if they use it.
8158 It is an error to used this flag with the frame pointer or stack pointer.
8159 Use of this flag for other registers that have fixed pervasive roles in
8160 the machine's execution model will produce disastrous results.
8162 A different sort of disaster will result from the use of this flag for
8163 a register in which function values may be returned.
8165 This flag does not have a negative form, because it specifies a
8166 three-way choice.
8168 @item -fpack-struct
8169 Pack all structure members together without holes.  Usually you would
8170 not want to use this option, since it makes the code suboptimal, and
8171 the offsets of structure members won't agree with system libraries.
8173 @item -fcheck-memory-usage
8174 Generate extra code to check each memory access.  GCC will generate
8175 code that is suitable for a detector of bad memory accesses such as
8176 @file{Checker}.
8178 Normally, you should compile all, or none, of your code with this option.
8180 If you do mix code compiled with and without this option,
8181 you must ensure that all code that has side effects
8182 and that is called by code compiled with this option
8183 is, itself, compiled with this option.
8184 If you do not, you might get erroneous messages from the detector.
8186 If you use functions from a library that have side-effects (such as
8187 @code{read}), you might not be able to recompile the library and
8188 specify this option.  In that case, you can enable the
8189 @samp{-fprefix-function-name} option, which requests GCC to encapsulate
8190 your code and make other functions look as if they were compiled with
8191 @samp{-fcheck-memory-usage}.  This is done by calling ``stubs'',
8192 which are provided by the detector.  If you cannot find or build
8193 stubs for every function you call, you might have to specify
8194 @samp{-fcheck-memory-usage} without @samp{-fprefix-function-name}.
8196 If you specify this option, you can not use the @code{asm} or
8197 @code{__asm__} keywords in functions with memory checking enabled.  GNU
8198 CC cannot understand what the @code{asm} statement may do, and therefore
8199 cannot generate the appropriate code, so it will reject it.  However, if
8200 you specify the function attribute @code{no_check_memory_usage}
8201 (@pxref{Function Attributes}), GNU CC will disable memory checking within a
8202 function; you may use @code{asm} statements inside such functions.  You
8203 may have an inline expansion of a non-checked function within a checked
8204 function; in that case GNU CC will not generate checks for the inlined
8205 function's memory accesses.
8207 If you move your @code{asm} statements to non-checked inline functions
8208 and they do access memory, you can add calls to the support code in your
8209 inline function, to indicate any reads, writes, or copies being done.
8210 These calls would be similar to those done in the stubs described above.
8212 @item -fprefix-function-name
8213 Request GCC to add a prefix to the symbols generated for function names.
8214 GCC adds a prefix to the names of functions defined as well as
8215 functions called.  Code compiled with this option and code compiled
8216 without the option can't be linked together, unless stubs are used.
8218 If you compile the following code with @samp{-fprefix-function-name}
8219 @example
8220 extern void bar (int);
8221 void
8222 foo (int a)
8224   return bar (a + 5);
8226 @end example
8228 @noindent
8229 GCC will compile the code as if it was written:
8230 @example
8231 extern void prefix_bar (int);
8232 void
8233 prefix_foo (int a)
8235   return prefix_bar (a + 5);
8237 @end example
8238 This option is designed to be used with @samp{-fcheck-memory-usage}.
8240 @item -finstrument-functions
8241 Generate instrumentation calls for entry and exit to functions.  Just
8242 after function entry and just before function exit, the following
8243 profiling functions will be called with the address of the current
8244 function and its call site.  (On some platforms,
8245 @code{__builtin_return_address} does not work beyond the current
8246 function, so the call site information may not be available to the
8247 profiling functions otherwise.)
8249 @example
8250 void __cyg_profile_func_enter (void *this_fn, void *call_site);
8251 void __cyg_profile_func_exit  (void *this_fn, void *call_site);
8252 @end example
8254 The first argument is the address of the start of the current function,
8255 which may be looked up exactly in the symbol table.
8257 This instrumentation is also done for functions expanded inline in other
8258 functions.  The profiling calls will indicate where, conceptually, the
8259 inline function is entered and exited.  This means that addressable
8260 versions of such functions must be available.  If all your uses of a
8261 function are expanded inline, this may mean an additional expansion of
8262 code size.  If you use @samp{extern inline} in your C code, an
8263 addressable version of such functions must be provided.  (This is
8264 normally the case anyways, but if you get lucky and the optimizer always
8265 expands the functions inline, you might have gotten away without
8266 providing static copies.)
8268 A function may be given the attribute @code{no_instrument_function}, in
8269 which case this instrumentation will not be done.  This can be used, for
8270 example, for the profiling functions listed above, high-priority
8271 interrupt routines, and any functions from which the profiling functions
8272 cannot safely be called (perhaps signal handlers, if the profiling
8273 routines generate output or allocate memory).
8275 @item -fstack-check
8276 Generate code to verify that you do not go beyond the boundary of the
8277 stack.  You should specify this flag if you are running in an
8278 environment with multiple threads, but only rarely need to specify it in
8279 a single-threaded environment since stack overflow is automatically
8280 detected on nearly all systems if there is only one stack.
8282 Note that this switch does not actually cause checking to be done; the
8283 operating system must do that.  The switch causes generation of code
8284 to ensure that the operating system sees the stack being extended.
8286 @item -fstack-limit-register=@var{reg}
8287 @itemx -fstack-limit-symbol=@var{sym}
8288 @itemx -fno-stack-limit
8289 Generate code to ensure that the stack does not grow beyond a certain value,
8290 either the value of a register or the address of a symbol.  If the stack
8291 would grow beyond the value, a signal is raised.  For most targets,
8292 the signal is raised before the stack overruns the boundary, so
8293 it is possible to catch the signal without taking special precautions.
8295 For instance, if the stack starts at address @samp{0x80000000} and grows
8296 downwards you can use the flags
8297 @samp{-fstack-limit-symbol=__stack_limit}
8298 @samp{-Wl,--defsym,__stack_limit=0x7ffe0000} which will enforce a stack
8299 limit of 128K.
8301 @cindex aliasing of parameters
8302 @cindex parameters, aliased
8303 @item -fargument-alias
8304 @itemx -fargument-noalias
8305 @itemx -fargument-noalias-global
8306 Specify the possible relationships among parameters and between
8307 parameters and global data.
8309 @samp{-fargument-alias} specifies that arguments (parameters) may
8310 alias each other and may alias global storage.
8311 @samp{-fargument-noalias} specifies that arguments do not alias
8312 each other, but may alias global storage.
8313 @samp{-fargument-noalias-global} specifies that arguments do not
8314 alias each other and do not alias global storage.
8316 Each language will automatically use whatever option is required by
8317 the language standard.  You should not need to use these options yourself.
8319 @item -fleading-underscore
8320 This option and its counterpart, -fno-leading-underscore, forcibly
8321 change the way C symbols are represented in the object file.  One use
8322 is to help link with legacy assembly code.
8324 Be warned that you should know what you are doing when invoking this
8325 option, and that not all targets provide complete support for it.
8326 @end table
8328 @c man end
8330 @node Environment Variables
8331 @section Environment Variables Affecting GCC
8332 @cindex environment variables
8334 @c man begin ENVIRONMENT
8336 This section describes several environment variables that affect how GCC
8337 operates.  Some of them work by specifying directories or prefixes to use
8338 when searching for various kinds of files. Some are used to specify other
8339 aspects of the compilation environment.
8341 @ifclear INTERNALS
8342 Note that you can also specify places to search using options such as
8343 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
8344 take precedence over places specified using environment variables, which
8345 in turn take precedence over those specified by the configuration of GCC.
8347 @end ifclear
8348 @ifset INTERNALS
8349 Note that you can also specify places to search using options such as
8350 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
8351 take precedence over places specified using environment variables, which
8352 in turn take precedence over those specified by the configuration of GCC.
8353 @xref{Driver}.
8354 @end ifset
8356 @table @env
8357 @item LANG
8358 @itemx LC_CTYPE
8359 @c @itemx LC_COLLATE
8360 @itemx LC_MESSAGES
8361 @c @itemx LC_MONETARY
8362 @c @itemx LC_NUMERIC
8363 @c @itemx LC_TIME
8364 @itemx LC_ALL
8365 @findex LANG
8366 @findex LC_CTYPE
8367 @c @findex LC_COLLATE
8368 @findex LC_MESSAGES
8369 @c @findex LC_MONETARY
8370 @c @findex LC_NUMERIC
8371 @c @findex LC_TIME
8372 @findex LC_ALL
8373 @cindex locale
8374 These environment variables control the way that GCC uses
8375 localization information that allow GCC to work with different
8376 national conventions.  GCC inspects the locale categories
8377 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
8378 so.  These locale categories can be set to any value supported by your
8379 installation.  A typical value is @samp{en_UK} for English in the United
8380 Kingdom.
8382 The @env{LC_CTYPE} environment variable specifies character
8383 classification.  GCC uses it to determine the character boundaries in
8384 a string; this is needed for some multibyte encodings that contain quote
8385 and escape characters that would otherwise be interpreted as a string
8386 end or escape.
8388 The @env{LC_MESSAGES} environment variable specifies the language to
8389 use in diagnostic messages.
8391 If the @env{LC_ALL} environment variable is set, it overrides the value
8392 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
8393 and @env{LC_MESSAGES} default to the value of the @env{LANG}
8394 environment variable.  If none of these variables are set, GCC
8395 defaults to traditional C English behavior.
8397 @item TMPDIR
8398 @findex TMPDIR
8399 If @env{TMPDIR} is set, it specifies the directory to use for temporary
8400 files.  GCC uses temporary files to hold the output of one stage of
8401 compilation which is to be used as input to the next stage: for example,
8402 the output of the preprocessor, which is the input to the compiler
8403 proper.
8405 @item GCC_EXEC_PREFIX
8406 @findex GCC_EXEC_PREFIX
8407 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
8408 names of the subprograms executed by the compiler.  No slash is added
8409 when this prefix is combined with the name of a subprogram, but you can
8410 specify a prefix that ends with a slash if you wish.
8412 If @env{GCC_EXEC_PREFIX} is not set, GNU CC will attempt to figure out
8413 an appropriate prefix to use based on the pathname it was invoked with.
8415 If GCC cannot find the subprogram using the specified prefix, it
8416 tries looking in the usual places for the subprogram.
8418 The default value of @env{GCC_EXEC_PREFIX} is
8419 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
8420 of @code{prefix} when you ran the @file{configure} script.
8422 Other prefixes specified with @samp{-B} take precedence over this prefix.
8424 This prefix is also used for finding files such as @file{crt0.o} that are
8425 used for linking.
8427 In addition, the prefix is used in an unusual way in finding the
8428 directories to search for header files.  For each of the standard
8429 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
8430 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
8431 replacing that beginning with the specified prefix to produce an
8432 alternate directory name.  Thus, with @samp{-Bfoo/}, GCC will search
8433 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
8434 These alternate directories are searched first; the standard directories
8435 come next.
8437 @item COMPILER_PATH
8438 @findex COMPILER_PATH
8439 The value of @env{COMPILER_PATH} is a colon-separated list of
8440 directories, much like @env{PATH}.  GCC tries the directories thus
8441 specified when searching for subprograms, if it can't find the
8442 subprograms using @env{GCC_EXEC_PREFIX}.
8444 @item LIBRARY_PATH
8445 @findex LIBRARY_PATH
8446 The value of @env{LIBRARY_PATH} is a colon-separated list of
8447 directories, much like @env{PATH}.  When configured as a native compiler,
8448 GCC tries the directories thus specified when searching for special
8449 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
8450 using GCC also uses these directories when searching for ordinary
8451 libraries for the @samp{-l} option (but directories specified with
8452 @samp{-L} come first).
8454 @item C_INCLUDE_PATH
8455 @itemx CPLUS_INCLUDE_PATH
8456 @itemx OBJC_INCLUDE_PATH
8457 @findex C_INCLUDE_PATH
8458 @findex CPLUS_INCLUDE_PATH
8459 @findex OBJC_INCLUDE_PATH
8460 @c @itemx OBJCPLUS_INCLUDE_PATH
8461 These environment variables pertain to particular languages.  Each
8462 variable's value is a colon-separated list of directories, much like
8463 @env{PATH}.  When GCC searches for header files, it tries the
8464 directories listed in the variable for the language you are using, after
8465 the directories specified with @samp{-I} but before the standard header
8466 file directories.
8468 @item DEPENDENCIES_OUTPUT
8469 @findex DEPENDENCIES_OUTPUT
8470 @cindex dependencies for make as output
8471 If this variable is set, its value specifies how to output dependencies
8472 for Make based on the header files processed by the compiler.  This
8473 output looks much like the output from the @samp{-M} option
8474 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
8475 in addition to the usual results of compilation.
8477 The value of @env{DEPENDENCIES_OUTPUT} can be just a file name, in
8478 which case the Make rules are written to that file, guessing the target
8479 name from the source file name.  Or the value can have the form
8480 @samp{@var{file} @var{target}}, in which case the rules are written to
8481 file @var{file} using @var{target} as the target name.
8483 @item LANG
8484 @findex LANG
8485 @cindex locale definition
8486 This variable is used to pass locale information to the compiler. One way in
8487 which this information is used is to determine the character set to be used
8488 when character literals, string literals and comments are parsed in C and C++.
8489 When the compiler is configured to allow multibyte characters,
8490 the following values for @env{LANG} are recognized:
8492 @table @samp
8493 @item C-JIS
8494 Recognize JIS characters.
8495 @item C-SJIS
8496 Recognize SJIS characters.
8497 @item C-EUCJP
8498 Recognize EUCJP characters.
8499 @end table
8501 If @env{LANG} is not defined, or if it has some other value, then the
8502 compiler will use mblen and mbtowc as defined by the default locale to
8503 recognize and translate multibyte characters.
8504 @end table
8506 @c man end
8508 @node Running Protoize
8509 @section Running Protoize
8511 The program @code{protoize} is an optional part of GNU C.  You can use
8512 it to add prototypes to a program, thus converting the program to ISO
8513 C in one respect.  The companion program @code{unprotoize} does the
8514 reverse: it removes argument types from any prototypes that are found.
8516 When you run these programs, you must specify a set of source files as
8517 command line arguments.  The conversion programs start out by compiling
8518 these files to see what functions they define.  The information gathered
8519 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
8521 After scanning comes actual conversion.  The specified files are all
8522 eligible to be converted; any files they include (whether sources or
8523 just headers) are eligible as well.
8525 But not all the eligible files are converted.  By default,
8526 @code{protoize} and @code{unprotoize} convert only source and header
8527 files in the current directory.  You can specify additional directories
8528 whose files should be converted with the @samp{-d @var{directory}}
8529 option.  You can also specify particular files to exclude with the
8530 @samp{-x @var{file}} option.  A file is converted if it is eligible, its
8531 directory name matches one of the specified directory names, and its
8532 name within the directory has not been excluded.
8534 Basic conversion with @code{protoize} consists of rewriting most
8535 function definitions and function declarations to specify the types of
8536 the arguments.  The only ones not rewritten are those for varargs
8537 functions.
8539 @code{protoize} optionally inserts prototype declarations at the
8540 beginning of the source file, to make them available for any calls that
8541 precede the function's definition.  Or it can insert prototype
8542 declarations with block scope in the blocks where undeclared functions
8543 are called.
8545 Basic conversion with @code{unprotoize} consists of rewriting most
8546 function declarations to remove any argument types, and rewriting
8547 function definitions to the old-style pre-ISO form.
8549 Both conversion programs print a warning for any function declaration or
8550 definition that they can't convert.  You can suppress these warnings
8551 with @samp{-q}.
8553 The output from @code{protoize} or @code{unprotoize} replaces the
8554 original source file.  The original file is renamed to a name ending
8555 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav} 
8556 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
8557 for DOS) file already exists, then the source file is simply discarded.
8559 @code{protoize} and @code{unprotoize} both depend on GCC itself to
8560 scan the program and collect information about the functions it uses.
8561 So neither of these programs will work until GCC is installed.
8563 Here is a table of the options you can use with @code{protoize} and
8564 @code{unprotoize}.  Each option works with both programs unless
8565 otherwise stated.
8567 @table @code
8568 @item -B @var{directory}
8569 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
8570 usual directory (normally @file{/usr/local/lib}).  This file contains
8571 prototype information about standard system functions.  This option
8572 applies only to @code{protoize}.
8574 @item -c @var{compilation-options}
8575 Use  @var{compilation-options} as the options when running @code{gcc} to
8576 produce the @samp{.X} files.  The special option @samp{-aux-info} is
8577 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
8579 Note that the compilation options must be given as a single argument to
8580 @code{protoize} or @code{unprotoize}.  If you want to specify several
8581 @code{gcc} options, you must quote the entire set of compilation options
8582 to make them a single word in the shell.
8584 There are certain @code{gcc} arguments that you cannot use, because they
8585 would produce the wrong kind of output.  These include @samp{-g},
8586 @samp{-O}, @samp{-c}, @samp{-S}, and @samp{-o} If you include these in
8587 the @var{compilation-options}, they are ignored.
8589 @item -C
8590 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
8591 systems) instead of @samp{.c}.  This is convenient if you are converting 
8592 a C program to C++.  This option applies only to @code{protoize}.
8594 @item -g
8595 Add explicit global declarations.  This means inserting explicit
8596 declarations at the beginning of each source file for each function
8597 that is called in the file and was not declared.  These declarations
8598 precede the first function definition that contains a call to an
8599 undeclared function.  This option applies only to @code{protoize}.
8601 @item -i @var{string}
8602 Indent old-style parameter declarations with the string @var{string}.
8603 This option applies only to @code{protoize}.
8605 @code{unprotoize} converts prototyped function definitions to old-style
8606 function definitions, where the arguments are declared between the
8607 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
8608 uses five spaces as the indentation.  If you want to indent with just
8609 one space instead, use @samp{-i " "}.
8611 @item -k
8612 Keep the @samp{.X} files.  Normally, they are deleted after conversion
8613 is finished.
8615 @item -l
8616 Add explicit local declarations.  @code{protoize} with @samp{-l} inserts
8617 a prototype declaration for each function in each block which calls the
8618 function without any declaration.  This option applies only to
8619 @code{protoize}.
8621 @item -n
8622 Make no real changes.  This mode just prints information about the conversions
8623 that would have been done without @samp{-n}.
8625 @item -N
8626 Make no @samp{.save} files.  The original files are simply deleted.
8627 Use this option with caution.
8629 @item -p @var{program}
8630 Use the program @var{program} as the compiler.  Normally, the name
8631 @file{gcc} is used.
8633 @item -q
8634 Work quietly.  Most warnings are suppressed.
8636 @item -v
8637 Print the version number, just like @samp{-v} for @code{gcc}.
8638 @end table
8640 If you need special compiler options to compile one of your program's
8641 source files, then you should generate that file's @samp{.X} file
8642 specially, by running @code{gcc} on that source file with the
8643 appropriate options and the option @samp{-aux-info}.  Then run
8644 @code{protoize} on the entire set of files.  @code{protoize} will use
8645 the existing @samp{.X} file because it is newer than the source file.
8646 For example:
8648 @example
8649 gcc -Dfoo=bar file1.c -aux-info
8650 protoize *.c
8651 @end example
8653 @noindent
8654 You need to include the special files along with the rest in the
8655 @code{protoize} command, even though their @samp{.X} files already
8656 exist, because otherwise they won't get converted.
8658 @xref{Protoize Caveats}, for more information on how to use
8659 @code{protoize} successfully.