OSDN Git Service

* doc/invoke.texi (i386 Options): -mwide-multiply is not
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
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.
5
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.
10
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.
14
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.
19
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 [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
31     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
32     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
33     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
34     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
35     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
36     [@option{-o} @var{outfile}] @var{infile}@dots{}
37
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
56
57 @node Invoking GCC
58 @chapter GCC Command Options
59 @cindex GCC command options
60 @cindex command options
61 @cindex options, GCC command
62
63 @c man begin DESCRIPTION
64
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 @option{-c} option
68 says not to run the linker.  Then the output consists of object files
69 output by the assembler.
70
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.
75
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.
82
83 @cindex C++ compilation options
84 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
85 options for compiling C++ programs.
86
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: @option{-dr} is very different from @w{@samp{-d
92 -r}}.
93
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 @option{-L} more than once,
99 the directories are searched in the order specified.
100
101 Many options have long names starting with @samp{-f} or with
102 @samp{-W}---for example, @option{-fforce-mem},
103 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
104 these have both positive and negative forms; the negative form of
105 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
106 only one of these two forms, whichever one is not the default.
107
108 @c man end
109
110 @xref{Option Index}, for an index to GCC's options.
111
112 @menu
113 * Option Summary::      Brief list of all options, without explanations.
114 * Overall Options::     Controlling the kind of output:
115                         an executable, object files, assembler files,
116                         or preprocessed source.
117 * Invoking G++::        Compiling C++ programs.
118 * C Dialect Options::   Controlling the variant of C language compiled.
119 * C++ Dialect Options:: Variations on C++.
120 * Objective-C Dialect Options:: Variations on Objective-C.
121 * Language Independent Options:: Controlling how diagnostics should be
122                         formatted.
123 * Warning Options::     How picky should the compiler be?
124 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
125 * Optimize Options::    How much optimization?
126 * Preprocessor Options:: Controlling header files and macro definitions.
127                          Also, getting dependency information for Make.
128 * Assembler Options::   Passing options to the assembler.
129 * Link Options::        Specifying libraries and so on.
130 * Directory Options::   Where to find header files and libraries.
131                         Where to find the compiler executable files.
132 * Spec Files::          How to pass switches to sub-processes.
133 * Target Options::      Running a cross-compiler, or an old version of GCC.
134 * Submodel Options::    Specifying minor hardware or convention variations,
135                         such as 68010 vs 68020.
136 * Code Gen Options::    Specifying conventions for function calls, data layout
137                         and register usage.
138 * Environment Variables:: Env vars that affect GCC.
139 * Running Protoize::    Automatically adding or removing function prototypes.
140 @end menu
141
142 @c man begin OPTIONS
143
144 @node Option Summary
145 @section Option Summary
146
147 Here is a summary of all the options, grouped by type.  Explanations are
148 in the following sections.
149
150 @table @emph
151 @item Overall Options
152 @xref{Overall Options,,Options Controlling the Kind of Output}.
153 @gccoptlist{
154 -c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  -x @var{language} @gol
155 -v  --target-help  --help}
156
157 @item C Language Options
158 @xref{C Dialect Options,,Options Controlling C Dialect}.
159 @gccoptlist{
160 -ansi  -std=@var{standard}  -aux-info @var{filename} @gol
161 -fno-asm  -fno-builtin @gol
162 -fhosted  -ffreestanding @gol
163 -trigraphs  -traditional  -traditional-cpp @gol
164 -fallow-single-precision  -fcond-mismatch @gol
165 -fsigned-bitfields  -fsigned-char @gol
166 -funsigned-bitfields  -funsigned-char @gol
167 -fwritable-strings  -fshort-wchar}
168
169 @item C++ Language Options
170 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
171 @gccoptlist{
172 -fno-access-control  -fcheck-new  -fconserve-space @gol
173 -fno-const-strings  -fdollars-in-identifiers @gol
174 -fno-elide-constructors @gol
175 -fno-enforce-eh-specs  -fexternal-templates @gol
176 -falt-external-templates @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fuse-cxa-atexit  -fvtable-gc  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -Wctor-dtor-privacy @gol
186 -Wnon-virtual-dtor  -Wreorder @gol
187 -Weffc++  -Wno-deprecated @gol
188 -Wno-non-template-friend  -Wold-style-cast @gol
189 -Woverloaded-virtual  -Wno-pmf-conversions @gol
190 -Wsign-promo  -Wsynth}
191
192 @item Objective-C Language Options
193 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
194 @gccoptlist{
195 -fconstant-string-class=@var{class-name} @gol
196 -fgnu-runtime  -fnext-runtime  -gen-decls @gol
197 -Wno-protocol  -Wselector}
198
199 @item Language Independent Options
200 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
201 @gccoptlist{
202 -fmessage-length=@var{n}  @gol
203 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
204
205 @item Warning Options
206 @xref{Warning Options,,Options to Request or Suppress Warnings}.
207 @gccoptlist{
208 -fsyntax-only  -pedantic  -pedantic-errors @gol
209 -w  -W  -Wall  -Waggregate-return @gol
210 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
211 -Wconversion  -Wdisabled-optimization  -Werror @gol
212 -Wfloat-equal  -Wformat  -Wformat=2 @gol
213 -Wformat-nonliteral  -Wformat-security @gol
214 -Wimplicit  -Wimplicit-int  @gol
215 -Wimplicit-function-declaration @gol
216 -Werror-implicit-function-declaration @gol
217 -Wimport  -Winline @gol
218 -Wlarger-than-@var{len}  -Wlong-long @gol
219 -Wmain  -Wmissing-braces  -Wmissing-declarations @gol
220 -Wmissing-format-attribute  -Wmissing-noreturn @gol
221 -Wmultichar  -Wno-format-extra-args  -Wno-format-y2k @gol
222 -Wno-import  -Wpacked  -Wpadded @gol
223 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
224 -Wreturn-type  -Wsequence-point  -Wshadow @gol
225 -Wsign-compare  -Wswitch  -Wsystem-headers @gol
226 -Wtrigraphs  -Wundef  -Wuninitialized @gol
227 -Wunknown-pragmas  -Wunreachable-code @gol
228 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
229 -Wunused-value  -Wunused-variable  -Wwrite-strings}
230
231 @item C-only Warning Options
232 @gccoptlist{
233 -Wbad-function-cast  -Wmissing-prototypes  -Wnested-externs @gol
234 -Wstrict-prototypes  -Wtraditional}
235
236 @item Debugging Options
237 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
238 @gccoptlist{
239 -a  -ax  -d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
240 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
241 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
242 -fdump-tree-original@r{[}-@var{n}@r{]} -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
243 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
244 -fmem-report  -fpretend-float @gol
245 -fprofile-arcs  -ftest-coverage  -ftime-report @gol
246 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
247 -ggdb  -gstabs  -gstabs+  -gxcoff  -gxcoff+ @gol
248 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
249 -print-multi-directory  -print-multi-lib @gol
250 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
251 -save-temps  -time}
252
253 @item Optimization Options
254 @xref{Optimize Options,,Options that Control Optimization}.
255 @gccoptlist{
256 -falign-functions=@var{n}  -falign-jumps=@var{n} @gol
257 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
258 -fbranch-probabilities  -fcaller-saves @gol
259 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
260 -fdelayed-branch  -fdelete-null-pointer-checks @gol
261 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
262 -fforce-addr  -fforce-mem  -ffunction-sections @gol
263 -fgcse  -fgcse-lm  -fgcse-sm @gol
264 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
265 -fkeep-static-consts  -fmove-all-movables @gol
266 -fno-default-inline  -fno-defer-pop @gol
267 -fno-function-cse  -fno-guess-branch-probability @gol
268 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
269 -funsafe-math-optimizations -fno-trapping-math @gol
270 -fomit-frame-pointer  -foptimize-register-move @gol
271 -foptimize-sibling-calls  -freduce-all-givs @gol
272 -fregmove  -frename-registers @gol
273 -frerun-cse-after-loop  -frerun-loop-opt @gol
274 -fschedule-insns  -fschedule-insns2 @gol
275 -fsingle-precision-constant  -fssa -fssa-ccp -fssa-dce @gol
276 -fstrength-reduce  -fstrict-aliasing  -fthread-jumps  -ftrapv @gol
277 -funroll-all-loops  -funroll-loops  @gol
278 --param @var{name}=@var{value}
279 -O  -O0  -O1  -O2  -O3  -Os}
280
281 @item Preprocessor Options
282 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
283 @gccoptlist{
284 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
285 -C  -dD  -dI  -dM  -dN @gol
286 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
287 -idirafter @var{dir} @gol
288 -include @var{file}  -imacros @var{file} @gol
289 -iprefix @var{file}  -iwithprefix @var{dir} @gol
290 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
291 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
292 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option}}
293
294 @item Assembler Option
295 @xref{Assembler Options,,Passing Options to the Assembler}.
296 @gccoptlist{
297 -Wa,@var{option}}
298
299 @item Linker Options
300 @xref{Link Options,,Options for Linking}.
301 @gccoptlist{
302 @var{object-file-name}  -l@var{library} @gol
303 -nostartfiles  -nodefaultlibs  -nostdlib @gol
304 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
305 -Wl,@var{option}  -Xlinker @var{option} @gol
306 -u @var{symbol}}
307
308 @item Directory Options
309 @xref{Directory Options,,Options for Directory Search}.
310 @gccoptlist{
311 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
312
313 @item Target Options
314 @c I wrote this xref this way to avoid overfull hbox. -- rms
315 @xref{Target Options}.
316 @gccoptlist{
317 -b @var{machine}  -V @var{version}}
318
319 @item Machine Dependent Options
320 @xref{Submodel Options,,Hardware Models and Configurations}.
321 @emph{M680x0 Options}
322 @gccoptlist{
323 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
324 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
325 -mfpa  -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
326 -malign-int  -mstrict-align}
327
328 @emph{M68hc1x Options}
329 @gccoptlist{
330 -m6811  -m6812  -m68hc11  -m68hc12 @gol
331 -mauto-incdec  -mshort  -msoft-reg-count=@var{count}}
332
333 @emph{VAX Options}
334 @gccoptlist{
335 -mg  -mgnu  -munix}
336
337 @emph{SPARC Options}
338 @gccoptlist{
339 -mcpu=@var{cpu-type} @gol
340 -mtune=@var{cpu-type} @gol
341 -mcmodel=@var{code-model} @gol
342 -m32  -m64 @gol
343 -mapp-regs  -mbroken-saverestore  -mcypress @gol
344 -mepilogue  -mfaster-structs  -mflat @gol
345 -mfpu  -mhard-float  -mhard-quad-float @gol
346 -mimpure-text  -mlive-g0  -mno-app-regs @gol
347 -mno-epilogue  -mno-faster-structs  -mno-flat  -mno-fpu @gol
348 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
349 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
350 -msupersparc  -munaligned-doubles  -mv8}
351
352 @emph{Convex Options}
353 @gccoptlist{
354 -mc1  -mc2  -mc32  -mc34  -mc38 @gol
355 -margcount  -mnoargcount @gol
356 -mlong32  -mlong64 @gol
357 -mvolatile-cache  -mvolatile-nocache}
358
359 @emph{AMD29K Options}
360 @gccoptlist{
361 -m29000  -m29050  -mbw  -mnbw  -mdw  -mndw @gol
362 -mlarge  -mnormal  -msmall @gol
363 -mkernel-registers  -mno-reuse-arg-regs @gol
364 -mno-stack-check  -mno-storem-bug @gol
365 -mreuse-arg-regs  -msoft-float  -mstack-check @gol
366 -mstorem-bug  -muser-registers}
367
368 @emph{ARM Options}
369 @gccoptlist{
370 -mapcs-frame  -mno-apcs-frame @gol
371 -mapcs-26  -mapcs-32 @gol
372 -mapcs-stack-check  -mno-apcs-stack-check @gol
373 -mapcs-float  -mno-apcs-float @gol
374 -mapcs-reentrant  -mno-apcs-reentrant @gol
375 -msched-prolog  -mno-sched-prolog @gol
376 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
377 -malignment-traps  -mno-alignment-traps @gol
378 -msoft-float  -mhard-float  -mfpe @gol
379 -mthumb-interwork  -mno-thumb-interwork @gol
380 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
381 -mstructure-size-boundary=@var{n} @gol
382 -mbsd -mxopen  -mno-symrename @gol
383 -mabort-on-noreturn @gol
384 -mlong-calls  -mno-long-calls @gol
385 -msingle-pic-base  -mno-single-pic-base @gol
386 -mpic-register=@var{reg} @gol
387 -mnop-fun-dllimport @gol
388 -mpoke-function-name @gol
389 -mthumb  -marm @gol
390 -mtpcs-frame  -mtpcs-leaf-frame @gol
391 -mcaller-super-interworking  -mcallee-super-interworking }
392
393 @emph{MN10200 Options}
394 @gccoptlist{
395 -mrelax}
396
397 @emph{MN10300 Options}
398 @gccoptlist{
399 -mmult-bug  -mno-mult-bug @gol
400 -mam33  -mno-am33 @gol
401 -mno-crt0  -mrelax}
402
403 @emph{M32R/D Options}
404 @gccoptlist{
405 -mcode-model=@var{model-type}  -msdata=@var{sdata-type} @gol
406 -G @var{num}}
407
408 @emph{M88K Options}
409 @gccoptlist{
410 -m88000  -m88100  -m88110  -mbig-pic @gol
411 -mcheck-zero-division  -mhandle-large-shift @gol
412 -midentify-revision  -mno-check-zero-division @gol
413 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
414 -mno-optimize-arg-area  -mno-serialize-volatile @gol
415 -mno-underscores  -mocs-debug-info @gol
416 -mocs-frame-position  -moptimize-arg-area @gol
417 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
418 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
419 -mversion-03.00  -mwarn-passed-structs}
420
421 @emph{RS/6000 and PowerPC Options}
422 @gccoptlist{
423 -mcpu=@var{cpu-type} @gol
424 -mtune=@var{cpu-type} @gol
425 -mpower  -mno-power  -mpower2  -mno-power2 @gol
426 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
427 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
428 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
429 -mnew-mnemonics  -mold-mnemonics @gol
430 -mfull-toc   -mminimal-toc  -mno-fop-in-toc  -mno-sum-in-toc @gol
431 -m64  -m32  -mxl-call  -mno-xl-call  -mthreads  -mpe @gol
432 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
433 -mstring  -mno-string  -mupdate  -mno-update @gol
434 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
435 -mstrict-align  -mno-strict-align  -mrelocatable @gol
436 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
437 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
438 -mcall-aix -mcall-sysv -mcall-netbsd @gol
439 -mprototype  -mno-prototype @gol
440 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
441 -msdata=@var{opt}  -mvxworks -G @var{num}}
442
443 @emph{RT Options}
444 @gccoptlist{
445 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
446 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
447 -mminimum-fp-blocks  -mnohc-struct-return}
448
449 @emph{MIPS Options}
450 @gccoptlist{
451 -mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
452 -mcpu=@var{cpu-type} -membedded-data  -muninit-const-in-rodata @gol
453 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
454 -mgas  -mgp32  -mgp64 @gol
455 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
456 -mips2  -mips3  -mips4  -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
457 -mmips-as  -mmips-tfile  -mno-abicalls @gol
458 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
459 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
460 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
461 -mrnames  -msoft-float @gol
462 -m4650  -msingle-float  -mmad @gol
463 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
464 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi @gol
465 -mfix7000  -mno-crt0}
466
467 @emph{i386 Options}
468 @gccoptlist{
469 -mcpu=@var{cpu-type}  -march=@var{cpu-type} @gol
470 -mintel-syntax -mieee-fp  -mno-fancy-math-387 @gol
471 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
472 -mno-wide-multiply  -mrtd  -malign-double @gol
473 -mpreferred-stack-boundary=@var{num} @gol
474 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
475 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
476 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer}
477
478 @emph{HPPA Options}
479 @gccoptlist{
480 -march=@var{architecture-type} @gol
481 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
482 -mfast-indirect-calls  -mgas  -mjump-in-delay @gol
483 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
484 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
485 -mno-jump-in-delay  -mno-long-load-store @gol
486 -mno-portable-runtime  -mno-soft-float @gol
487 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
488 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
489 -mschedule=@var{cpu-type}  -mspace-regs}
490
491 @emph{Intel 960 Options}
492 @gccoptlist{
493 -m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
494 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
495 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
496 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
497 -mno-complex-addr  -mno-leaf-procedures @gol
498 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
499 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
500 -mtail-call}
501
502 @emph{DEC Alpha Options}
503 @gccoptlist{
504 -mfp-regs  -mno-fp-regs  -mno-soft-float  -msoft-float @gol
505 -malpha-as  -mgas @gol
506 -mieee  -mieee-with-inexact  -mieee-conformant @gol
507 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
508 -mtrap-precision=@var{mode}  -mbuild-constants @gol
509 -mcpu=@var{cpu-type} @gol
510 -mbwx  -mno-bwx  -mcix  -mno-cix  -mmax  -mno-max @gol
511 -mmemory-latency=@var{time}}
512
513 @emph{Clipper Options}
514 @gccoptlist{
515 -mc300  -mc400}
516
517 @emph{H8/300 Options}
518 @gccoptlist{
519 -mrelax  -mh  -ms  -mint32  -malign-300}
520
521 @emph{SH Options}
522 @gccoptlist{
523 -m1  -m2  -m3  -m3e @gol
524 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
525 -mb  -ml  -mdalign  -mrelax @gol
526 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
527 -mieee  -misize  -mpadstruct  -mspace @gol
528 -mprefergot  -musermode}
529
530 @emph{System V Options}
531 @gccoptlist{
532 -Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
533
534 @emph{ARC Options}
535 @gccoptlist{
536 -EB  -EL @gol
537 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
538 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
539
540 @emph{TMS320C3x/C4x Options}
541 @gccoptlist{
542 -mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
543 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
544 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
545 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
546
547 @emph{V850 Options}
548 @gccoptlist{
549 -mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
550 -mprolog-function  -mno-prolog-function  -mspace @gol
551 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
552 -mv850  -mbig-switch}
553
554 @emph{NS32K Options}
555 @gccoptlist{
556 -m32032  -m32332  -m32532  -m32081  -m32381 @gol
557 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
558 -mregparam  -mnoregparam  -msb  -mnosb @gol
559 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
560
561 @emph{AVR Options}
562 @gccoptlist{
563 -mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
564 -mcall-prologues  -mno-tablejump  -mtiny-stack}
565
566 @emph{MCore Options}
567 @gccoptlist{
568 -mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
569 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
570 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
571 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
572 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
573
574 @emph{IA-64 Options}
575 @gccoptlist{
576 -mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
577 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
578 -mconstant-gp  -mauto-pic  -minline-divide-min-latency @gol
579 -minline-divide-max-throughput  -mno-dwarf2-asm @gol
580 -mfixed-range=@var{register-range}}
581
582 @emph{S/390 and zSeries Options}
583 @gccoptlist{
584 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
585 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
586 -m64 -m31 -mdebug -mno-debug}
587
588 @item Code Generation Options
589 @xref{Code Gen Options,,Options for Code Generation Conventions}.
590 @gccoptlist{
591 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
592 -ffixed-@var{reg} -fexceptions @gol
593 -fnon-call-exceptions  -funwind-tables @gol
594 -finhibit-size-directive  -finstrument-functions @gol
595 -fcheck-memory-usage  -fprefix-function-name @gol
596 -fno-common  -fno-ident  -fno-gnu-linker @gol
597 -fpcc-struct-return  -fpic  -fPIC @gol
598 -freg-struct-return  -fshared-data  -fshort-enums @gol
599 -fshort-double  -fvolatile @gol
600 -fvolatile-global  -fvolatile-static @gol
601 -fverbose-asm  -fpack-struct  -fstack-check @gol
602 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
603 -fargument-alias  -fargument-noalias @gol
604 -fargument-noalias-global  -fleading-underscore}
605 @end table
606
607 @menu
608 * Overall Options::     Controlling the kind of output:
609                         an executable, object files, assembler files,
610                         or preprocessed source.
611 * C Dialect Options::   Controlling the variant of C language compiled.
612 * C++ Dialect Options:: Variations on C++.
613 * Objective-C Dialect Options:: Variations on Objective-C.
614 * Language Independent Options:: Controlling how diagnostics should be
615                         formatted.
616 * Warning Options::     How picky should the compiler be?
617 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
618 * Optimize Options::    How much optimization?
619 * Preprocessor Options:: Controlling header files and macro definitions.
620                          Also, getting dependency information for Make.
621 * Assembler Options::   Passing options to the assembler.
622 * Link Options::        Specifying libraries and so on.
623 * Directory Options::   Where to find header files and libraries.
624                         Where to find the compiler executable files.
625 * Spec Files::          How to pass switches to sub-processes.
626 * Target Options::      Running a cross-compiler, or an old version of GCC.
627 @end menu
628
629 @node Overall Options
630 @section Options Controlling the Kind of Output
631
632 Compilation can involve up to four stages: preprocessing, compilation
633 proper, assembly and linking, always in that order.  The first three
634 stages apply to an individual source file, and end by producing an
635 object file; linking combines all the object files (those newly
636 compiled, and those specified as input) into an executable file.
637
638 @cindex file name suffix
639 For any given input file, the file name suffix determines what kind of
640 compilation is done:
641
642 @table @gcctabopt
643 @item @var{file}.c
644 C source code which must be preprocessed.
645
646 @item @var{file}.i
647 C source code which should not be preprocessed.
648
649 @item @var{file}.ii
650 C++ source code which should not be preprocessed.
651
652 @item @var{file}.m
653 Objective-C source code.  Note that you must link with the library
654 @file{libobjc.a} to make an Objective-C program work.
655
656 @item @var{file}.mi
657 Objective-C source code which should not be preprocessed.
658
659 @item @var{file}.h
660 C header file (not to be compiled or linked).
661
662 @item @var{file}.cc
663 @itemx @var{file}.cp
664 @itemx @var{file}.cxx
665 @itemx @var{file}.cpp
666 @itemx @var{file}.c++
667 @itemx @var{file}.C
668 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
669 the last two letters must both be literally @samp{x}.  Likewise,
670 @samp{.C} refers to a literal capital C@.
671
672 @item @var{file}.f
673 @itemx @var{file}.for
674 @itemx @var{file}.FOR
675 Fortran source code which should not be preprocessed.
676
677 @item @var{file}.F
678 @itemx @var{file}.fpp
679 @itemx @var{file}.FPP
680 Fortran source code which must be preprocessed (with the traditional
681 preprocessor).
682
683 @item @var{file}.r
684 Fortran source code which must be preprocessed with a RATFOR
685 preprocessor (not included with GCC)@.
686
687 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
688 Using and Porting GNU Fortran}, for more details of the handling of
689 Fortran input files.
690
691 @c FIXME: Descriptions of Java file types.
692 @c @var{file}.java
693 @c @var{file}.class
694 @c @var{file}.zip
695 @c @var{file}.jar
696
697 @c GCC also knows about some suffixes for languages not yet included:
698 @c Ada:
699 @c @var{file}.ads
700 @c @var{file}.adb
701 @c @var{file}.ada
702 @c Pascal:
703 @c @var{file}.p
704 @c @var{file}.pas
705
706 @item @var{file}.ch
707 @itemx @var{file}.chi
708 CHILL source code (preprocessed with the traditional preprocessor).
709
710 @item @var{file}.s
711 Assembler code.
712
713 @item @var{file}.S
714 Assembler code which must be preprocessed.
715
716 @item @var{other}
717 An object file to be fed straight into linking.
718 Any file name with no recognized suffix is treated this way.
719 @end table
720
721 @opindex x
722 You can specify the input language explicitly with the @option{-x} option:
723
724 @table @gcctabopt
725 @item -x @var{language}
726 Specify explicitly the @var{language} for the following input files
727 (rather than letting the compiler choose a default based on the file
728 name suffix).  This option applies to all following input files until
729 the next @option{-x} option.  Possible values for @var{language} are:
730 @example
731 c  c-header  cpp-output
732 c++  c++-cpp-output
733 objective-c  objc-cpp-output
734 assembler  assembler-with-cpp
735 f77  f77-cpp-input  ratfor
736 java  chill
737 @end example
738 @c Also f77-version, for internal use only.
739
740 @item -x none
741 Turn off any specification of a language, so that subsequent files are
742 handled according to their file name suffixes (as they are if @option{-x}
743 has not been used at all).
744
745 @item -pass-exit-codes
746 @opindex pass-exit-codes
747 Normally the @command{gcc} program will exit with the code of 1 if any
748 phase of the compiler returns a non-success return code.  If you specify
749 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
750 numerically highest error produced by any phase that returned an error
751 indication.
752 @end table
753
754 If you only want some of the stages of compilation, you can use
755 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
756 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
757 @command{gcc} is to stop.  Note that some combinations (for example,
758 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
759
760 @table @gcctabopt
761 @item -c
762 @opindex c
763 Compile or assemble the source files, but do not link.  The linking
764 stage simply is not done.  The ultimate output is in the form of an
765 object file for each source file.
766
767 By default, the object file name for a source file is made by replacing
768 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
769
770 Unrecognized input files, not requiring compilation or assembly, are
771 ignored.
772
773 @item -S
774 @opindex S
775 Stop after the stage of compilation proper; do not assemble.  The output
776 is in the form of an assembler code file for each non-assembler input
777 file specified.
778
779 By default, the assembler file name for a source file is made by
780 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
781
782 Input files that don't require compilation are ignored.
783
784 @item -E
785 @opindex E
786 Stop after the preprocessing stage; do not run the compiler proper.  The
787 output is in the form of preprocessed source code, which is sent to the
788 standard output.
789
790 Input files which don't require preprocessing are ignored.
791
792 @cindex output file option
793 @item -o @var{file}
794 @opindex o
795 Place output in file @var{file}.  This applies regardless to whatever
796 sort of output is being produced, whether it be an executable file,
797 an object file, an assembler file or preprocessed C code.
798
799 Since only one output file can be specified, it does not make sense to
800 use @option{-o} when compiling more than one input file, unless you are
801 producing an executable file as output.
802
803 If @option{-o} is not specified, the default is to put an executable file
804 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
805 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
806 all preprocessed C source on standard output.
807
808 @item -v
809 @opindex v
810 Print (on standard error output) the commands executed to run the stages
811 of compilation.  Also print the version number of the compiler driver
812 program and of the preprocessor and the compiler proper.
813
814 @item -pipe
815 @opindex pipe
816 Use pipes rather than temporary files for communication between the
817 various stages of compilation.  This fails to work on some systems where
818 the assembler is unable to read from a pipe; but the GNU assembler has
819 no trouble.
820
821 @item --help
822 @opindex help
823 Print (on the standard output) a description of the command line options
824 understood by @command{gcc}.  If the @option{-v} option is also specified
825 then @option{--help} will also be passed on to the various processes
826 invoked by @command{gcc}, so that they can display the command line options
827 they accept.  If the @option{-W} option is also specified then command
828 line options which have no documentation associated with them will also
829 be displayed.
830
831 @item --target-help
832 @opindex target-help
833 Print (on the standard output) a description of target specific command
834 line options for each tool.
835 @end table
836
837 @node Invoking G++
838 @section Compiling C++ Programs
839
840 @cindex suffixes for C++ source
841 @cindex C++ source file suffixes
842 C++ source files conventionally use one of the suffixes @samp{.C},
843 @samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
844 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
845 files with these names and compiles them as C++ programs even if you
846 call the compiler the same way as for compiling C programs (usually with
847 the name @command{gcc}).
848
849 @findex g++
850 @findex c++
851 However, C++ programs often require class libraries as well as a
852 compiler that understands the C++ language---and under some
853 circumstances, you might want to compile programs from standard input,
854 or otherwise without a suffix that flags them as C++ programs.
855 @command{g++} is a program that calls GCC with the default language
856 set to C++, and automatically specifies linking against the C++
857 library.  On many systems, @command{g++} is also
858 installed with the name @command{c++}.
859
860 @cindex invoking @command{g++}
861 When you compile C++ programs, you may specify many of the same
862 command-line options that you use for compiling programs in any
863 language; or command-line options meaningful for C and related
864 languages; or options that are meaningful only for C++ programs.
865 @xref{C Dialect Options,,Options Controlling C Dialect}, for
866 explanations of options for languages related to C@.
867 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
868 explanations of options that are meaningful only for C++ programs.
869
870 @node C Dialect Options
871 @section Options Controlling C Dialect
872 @cindex dialect options
873 @cindex language dialect options
874 @cindex options, dialect
875
876 The following options control the dialect of C (or languages derived
877 from C, such as C++ and Objective-C) that the compiler accepts:
878
879 @table @gcctabopt
880 @cindex ANSI support
881 @cindex ISO support
882 @item -ansi
883 @opindex ansi
884 In C mode, support all ISO C89 programs.  In C++ mode,
885 remove GNU extensions that conflict with ISO C++.
886
887 This turns off certain features of GCC that are incompatible with ISO
888 C89 (when compiling C code), or of standard C++ (when compiling C++ code),
889 such as the @code{asm} and @code{typeof} keywords, and
890 predefined macros such as @code{unix} and @code{vax} that identify the
891 type of system you are using.  It also enables the undesirable and
892 rarely used ISO trigraph feature.  For the C compiler,
893 it disables recognition of C++ style @samp{//} comments as well as
894 the @code{inline} keyword.
895
896 The alternate keywords @code{__asm__}, @code{__extension__},
897 @code{__inline__} and @code{__typeof__} continue to work despite
898 @option{-ansi}.  You would not want to use them in an ISO C program, of
899 course, but it is useful to put them in header files that might be included
900 in compilations done with @option{-ansi}.  Alternate predefined macros
901 such as @code{__unix__} and @code{__vax__} are also available, with or
902 without @option{-ansi}.
903
904 The @option{-ansi} option does not cause non-ISO programs to be
905 rejected gratuitously.  For that, @option{-pedantic} is required in
906 addition to @option{-ansi}.  @xref{Warning Options}.
907
908 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
909 option is used.  Some header files may notice this macro and refrain
910 from declaring certain functions or defining certain macros that the
911 ISO standard doesn't call for; this is to avoid interfering with any
912 programs that might use these names for other things.
913
914 Functions which would normally be built in but do not have semantics
915 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
916 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
917 built-in functions provided by GCC}, for details of the functions
918 affected.
919
920 @item -std=
921 @opindex std
922 Determine the language standard.  This option is currently only
923 supported when compiling C@.  A value for this option must be provided;
924 possible values are
925
926 @table @samp
927 @item c89
928 @itemx iso9899:1990
929 ISO C89 (same as @option{-ansi}).
930
931 @item iso9899:199409
932 ISO C89 as modified in amendment 1.
933
934 @item c99
935 @itemx c9x
936 @itemx iso9899:1999
937 @itemx iso9899:199x
938 ISO C99.  Note that this standard is not yet fully supported; see
939 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
940 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
941
942 @item gnu89
943 Default, ISO C89 plus GNU extensions (including some C99 features).
944
945 @item gnu99
946 @item gnu9x
947 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
948 this will become the default.  The name @samp{gnu9x} is deprecated.
949
950 @end table
951
952 Even when this option is not specified, you can still use some of the
953 features of newer standards in so far as they do not conflict with
954 previous C standards.  For example, you may use @code{__restrict__} even
955 when @option{-std=c99} is not specified.
956
957 The @option{-std} options specifying some version of ISO C have the same
958 effects as @option{-ansi}, except that features that were not in ISO C89
959 but are in the specified version (for example, @samp{//} comments and
960 the @code{inline} keyword in ISO C99) are not disabled.
961
962 @xref{Standards,,Language Standards Supported by GCC}, for details of
963 these standard versions.
964
965 @item -aux-info @var{filename}
966 @opindex aux-info
967 Output to the given filename prototyped declarations for all functions
968 declared and/or defined in a translation unit, including those in header
969 files.  This option is silently ignored in any language other than C@.
970
971 Besides declarations, the file indicates, in comments, the origin of
972 each declaration (source file and line), whether the declaration was
973 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
974 @samp{O} for old, respectively, in the first character after the line
975 number and the colon), and whether it came from a declaration or a
976 definition (@samp{C} or @samp{F}, respectively, in the following
977 character).  In the case of function definitions, a K&R-style list of
978 arguments followed by their declarations is also provided, inside
979 comments, after the declaration.
980
981 @item -fno-asm
982 @opindex fno-asm
983 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
984 keyword, so that code can use these words as identifiers.  You can use
985 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
986 instead.  @option{-ansi} implies @option{-fno-asm}.
987
988 In C++, this switch only affects the @code{typeof} keyword, since
989 @code{asm} and @code{inline} are standard keywords.  You may want to
990 use the @option{-fno-gnu-keywords} flag instead, which has the same
991 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
992 switch only affects the @code{asm} and @code{typeof} keywords, since
993 @code{inline} is a standard keyword in ISO C99.
994
995 @item -fno-builtin
996 @opindex fno-builtin
997 @cindex built-in functions
998 Don't recognize built-in functions that do not begin with
999 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1000 functions provided by GCC}, for details of the functions affected,
1001 including those which are not built-in functions when @option{-ansi} or
1002 @option{-std} options for strict ISO C conformance are used because they
1003 do not have an ISO standard meaning.
1004
1005 GCC normally generates special code to handle certain built-in functions
1006 more efficiently; for instance, calls to @code{alloca} may become single
1007 instructions that adjust the stack directly, and calls to @code{memcpy}
1008 may become inline copy loops.  The resulting code is often both smaller
1009 and faster, but since the function calls no longer appear as such, you
1010 cannot set a breakpoint on those calls, nor can you change the behavior
1011 of the functions by linking with a different library.
1012
1013 In C++, @option{-fno-builtin} is always in effect.  The @option{-fbuiltin}
1014 option has no effect.  Therefore, in C++, the only way to get the
1015 optimization benefits of built-in functions is to call the function
1016 using the @samp{__builtin_} prefix.  The GNU C++ Standard Library uses
1017 built-in functions to implement many functions (like
1018 @code{std::strchr}), so that you automatically get efficient code.
1019
1020 @item -fhosted
1021 @opindex fhosted
1022 @cindex hosted environment
1023
1024 Assert that compilation takes place in a hosted environment.  This implies
1025 @option{-fbuiltin}.  A hosted environment is one in which the
1026 entire standard library is available, and in which @code{main} has a return
1027 type of @code{int}.  Examples are nearly everything except a kernel.
1028 This is equivalent to @option{-fno-freestanding}.
1029
1030 @item -ffreestanding
1031 @opindex ffreestanding
1032 @cindex hosted environment
1033
1034 Assert that compilation takes place in a freestanding environment.  This
1035 implies @option{-fno-builtin}.  A freestanding environment
1036 is one in which the standard library may not exist, and program startup may
1037 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1038 This is equivalent to @option{-fno-hosted}.
1039
1040 @xref{Standards,,Language Standards Supported by GCC}, for details of
1041 freestanding and hosted environments.
1042
1043 @item -trigraphs
1044 @opindex trigraphs
1045 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1046 options for strict ISO C conformance) implies @option{-trigraphs}.
1047
1048 @cindex traditional C language
1049 @cindex C language, traditional
1050 @item -traditional
1051 @opindex traditional
1052 Attempt to support some aspects of traditional C compilers.
1053 Specifically:
1054
1055 @itemize @bullet
1056 @item
1057 All @code{extern} declarations take effect globally even if they
1058 are written inside of a function definition.  This includes implicit
1059 declarations of functions.
1060
1061 @item
1062 The newer keywords @code{typeof}, @code{inline}, @code{signed}, @code{const}
1063 and @code{volatile} are not recognized.  (You can still use the
1064 alternative keywords such as @code{__typeof__}, @code{__inline__}, and
1065 so on.)
1066
1067 @item
1068 Comparisons between pointers and integers are always allowed.
1069
1070 @item
1071 Integer types @code{unsigned short} and @code{unsigned char} promote
1072 to @code{unsigned int}.
1073
1074 @item
1075 Out-of-range floating point literals are not an error.
1076
1077 @item
1078 Certain constructs which ISO regards as a single invalid preprocessing
1079 number, such as @samp{0xe-0xd}, are treated as expressions instead.
1080
1081 @item
1082 String ``constants'' are not necessarily constant; they are stored in
1083 writable space, and identical looking constants are allocated
1084 separately.  (This is the same as the effect of
1085 @option{-fwritable-strings}.)
1086
1087 @cindex @code{longjmp} and automatic variables
1088 @item
1089 All automatic variables not declared @code{register} are preserved by
1090 @code{longjmp}.  Ordinarily, GNU C follows ISO C: automatic variables
1091 not declared @code{volatile} may be clobbered.
1092
1093 @item
1094 @cindex @samp{\x}
1095 @cindex @samp{\a}
1096 @cindex escape sequences, traditional
1097 The character escape sequences @samp{\x} and @samp{\a} evaluate as the
1098 literal characters @samp{x} and @samp{a} respectively.  Without
1099 @w{@option{-traditional}}, @samp{\x} is a prefix for the hexadecimal
1100 representation of a character, and @samp{\a} produces a bell.
1101 @end itemize
1102
1103 You may wish to use @option{-fno-builtin} as well as @option{-traditional}
1104 if your program uses names that are normally GNU C built-in functions for
1105 other purposes of its own.
1106
1107 You cannot use @option{-traditional} if you include any header files that
1108 rely on ISO C features.  Some vendors are starting to ship systems with
1109 ISO C header files and you cannot use @option{-traditional} on such
1110 systems to compile files that include any system headers.
1111
1112 The @option{-traditional} option also enables @option{-traditional-cpp}.
1113
1114 @item -traditional-cpp
1115 @opindex traditional-cpp
1116 Attempt to support some aspects of traditional C preprocessors.
1117 See the GNU CPP manual for details.
1118
1119 @item -fcond-mismatch
1120 @opindex fcond-mismatch
1121 Allow conditional expressions with mismatched types in the second and
1122 third arguments.  The value of such an expression is void.  This option
1123 is not supported for C++.
1124
1125 @item -funsigned-char
1126 @opindex funsigned-char
1127 Let the type @code{char} be unsigned, like @code{unsigned char}.
1128
1129 Each kind of machine has a default for what @code{char} should
1130 be.  It is either like @code{unsigned char} by default or like
1131 @code{signed char} by default.
1132
1133 Ideally, a portable program should always use @code{signed char} or
1134 @code{unsigned char} when it depends on the signedness of an object.
1135 But many programs have been written to use plain @code{char} and
1136 expect it to be signed, or expect it to be unsigned, depending on the
1137 machines they were written for.  This option, and its inverse, let you
1138 make such a program work with the opposite default.
1139
1140 The type @code{char} is always a distinct type from each of
1141 @code{signed char} or @code{unsigned char}, even though its behavior
1142 is always just like one of those two.
1143
1144 @item -fsigned-char
1145 @opindex fsigned-char
1146 Let the type @code{char} be signed, like @code{signed char}.
1147
1148 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1149 the negative form of @option{-funsigned-char}.  Likewise, the option
1150 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1151
1152 @item -fsigned-bitfields
1153 @itemx -funsigned-bitfields
1154 @itemx -fno-signed-bitfields
1155 @itemx -fno-unsigned-bitfields
1156 @opindex fsigned-bitfields
1157 @opindex funsigned-bitfields
1158 @opindex fno-signed-bitfields
1159 @opindex fno-unsigned-bitfields
1160 These options control whether a bit-field is signed or unsigned, when the
1161 declaration does not use either @code{signed} or @code{unsigned}.  By
1162 default, such a bit-field is signed, because this is consistent: the
1163 basic integer types such as @code{int} are signed types.
1164
1165 However, when @option{-traditional} is used, bit-fields are all unsigned
1166 no matter what.
1167
1168 @item -fwritable-strings
1169 @opindex fwritable-strings
1170 Store string constants in the writable data segment and don't uniquize
1171 them.  This is for compatibility with old programs which assume they can
1172 write into string constants.  The option @option{-traditional} also has
1173 this effect.
1174
1175 Writing into string constants is a very bad idea; ``constants'' should
1176 be constant.
1177
1178 @item -fallow-single-precision
1179 @opindex fallow-single-precision
1180 Do not promote single precision math operations to double precision,
1181 even when compiling with @option{-traditional}.
1182
1183 Traditional K&R C promotes all floating point operations to double
1184 precision, regardless of the sizes of the operands.   On the
1185 architecture for which you are compiling, single precision may be faster
1186 than double precision.   If you must use @option{-traditional}, but want
1187 to use single precision operations when the operands are single
1188 precision, use this option.   This option has no effect when compiling
1189 with ISO or GNU C conventions (the default).
1190
1191 @item -fshort-wchar
1192 @opindex fshort-wchar
1193 Override the underlying type for @samp{wchar_t} to be @samp{short
1194 unsigned int} instead of the default for the target.  This option is
1195 useful for building programs to run under WINE@.
1196 @end table
1197
1198 @node C++ Dialect Options
1199 @section Options Controlling C++ Dialect
1200
1201 @cindex compiler options, C++
1202 @cindex C++ options, command line
1203 @cindex options, C++
1204 This section describes the command-line options that are only meaningful
1205 for C++ programs; but you can also use most of the GNU compiler options
1206 regardless of what language your program is in.  For example, you
1207 might compile a file @code{firstClass.C} like this:
1208
1209 @example
1210 g++ -g -frepo -O -c firstClass.C
1211 @end example
1212
1213 @noindent
1214 In this example, only @option{-frepo} is an option meant
1215 only for C++ programs; you can use the other options with any
1216 language supported by GCC@.
1217
1218 Here is a list of options that are @emph{only} for compiling C++ programs:
1219
1220 @table @gcctabopt
1221 @item -fno-access-control
1222 @opindex fno-access-control
1223 Turn off all access checking.  This switch is mainly useful for working
1224 around bugs in the access control code.
1225
1226 @item -fcheck-new
1227 @opindex fcheck-new
1228 Check that the pointer returned by @code{operator new} is non-null
1229 before attempting to modify the storage allocated.  The current Working
1230 Paper requires that @code{operator new} never return a null pointer, so
1231 this check is normally unnecessary.
1232
1233 An alternative to using this option is to specify that your
1234 @code{operator new} does not throw any exceptions; if you declare it
1235 @samp{throw()}, G++ will check the return value.  See also @samp{new
1236 (nothrow)}.
1237
1238 @item -fconserve-space
1239 @opindex fconserve-space
1240 Put uninitialized or runtime-initialized global variables into the
1241 common segment, as C does.  This saves space in the executable at the
1242 cost of not diagnosing duplicate definitions.  If you compile with this
1243 flag and your program mysteriously crashes after @code{main()} has
1244 completed, you may have an object that is being destroyed twice because
1245 two definitions were merged.
1246
1247 This option is no longer useful on most targets, now that support has
1248 been added for putting variables into BSS without making them common.
1249
1250 @item -fno-const-strings
1251 @opindex fno-const-strings
1252 Give string constants type @code{char *} instead of type @code{const
1253 char *}.  By default, G++ uses type @code{const char *} as required by
1254 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1255 actually modify the value of a string constant, unless you also use
1256 @option{-fwritable-strings}.
1257
1258 This option might be removed in a future release of G++.  For maximum
1259 portability, you should structure your code so that it works with
1260 string constants that have type @code{const char *}.
1261
1262 @item -fdollars-in-identifiers
1263 @opindex fdollars-in-identifiers
1264 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1265 @samp{$} with the option @option{-fno-dollars-in-identifiers}.  (GNU C allows
1266 @samp{$} by default on most target systems, but there are a few exceptions.)
1267 Traditional C allowed the character @samp{$} to form part of
1268 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1269
1270 @item -fno-elide-constructors
1271 @opindex fno-elide-constructors
1272 The C++ standard allows an implementation to omit creating a temporary
1273 which is only used to initialize another object of the same type.
1274 Specifying this option disables that optimization, and forces G++ to
1275 call the copy constructor in all cases.
1276
1277 @item -fno-enforce-eh-specs
1278 @opindex fno-enforce-eh-specs
1279 Don't check for violation of exception specifications at runtime.  This
1280 option violates the C++ standard, but may be useful for reducing code
1281 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1282 will still optimize based on the exception specifications.
1283
1284 @item -fexternal-templates
1285 @opindex fexternal-templates
1286
1287 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1288 template instantiation; template instances are emitted or not according
1289 to the location of the template definition.  @xref{Template
1290 Instantiation}, for more information.
1291
1292 This option is deprecated.
1293
1294 @item -falt-external-templates
1295 @opindex falt-external-templates
1296 Similar to @option{-fexternal-templates}, but template instances are
1297 emitted or not according to the place where they are first instantiated.
1298 @xref{Template Instantiation}, for more information.
1299
1300 This option is deprecated.
1301
1302 @item -ffor-scope
1303 @itemx -fno-for-scope
1304 @opindex ffor-scope
1305 @opindex fno-for-scope
1306 If @option{-ffor-scope} is specified, the scope of variables declared in
1307 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1308 as specified by the C++ standard.
1309 If @option{-fno-for-scope} is specified, the scope of variables declared in
1310 a @i{for-init-statement} extends to the end of the enclosing scope,
1311 as was the case in old versions of G++, and other (traditional)
1312 implementations of C++.
1313
1314 The default if neither flag is given to follow the standard,
1315 but to allow and give a warning for old-style code that would
1316 otherwise be invalid, or have different behavior.
1317
1318 @item -fno-gnu-keywords
1319 @opindex fno-gnu-keywords
1320 Do not recognize @code{typeof} as a keyword, so that code can use this
1321 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1322 @option{-ansi} implies @option{-fno-gnu-keywords}.
1323
1324 @item -fno-implicit-templates
1325 @opindex fno-implicit-templates
1326 Never emit code for non-inline templates which are instantiated
1327 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1328 @xref{Template Instantiation}, for more information.
1329
1330 @item -fno-implicit-inline-templates
1331 @opindex fno-implicit-inline-templates
1332 Don't emit code for implicit instantiations of inline templates, either.
1333 The default is to handle inlines differently so that compiles with and
1334 without optimization will need the same set of explicit instantiations.
1335
1336 @item -fno-implement-inlines
1337 @opindex fno-implement-inlines
1338 To save space, do not emit out-of-line copies of inline functions
1339 controlled by @samp{#pragma implementation}.  This will cause linker
1340 errors if these functions are not inlined everywhere they are called.
1341
1342 @item -fms-extensions
1343 @opindex fms-extensions
1344 Disable pedantic warnings about constructs used in MFC, such as implicit
1345 int and getting a pointer to member function via non-standard syntax.
1346
1347 @item -fno-nonansi-builtins
1348 @opindex fno-nonansi-builtins
1349 Disable built-in declarations of functions that are not mandated by
1350 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1351 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1352
1353 @item -fno-operator-names
1354 @opindex fno-operator-names
1355 Do not treat the operator name keywords @code{and}, @code{bitand},
1356 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1357 synonyms as keywords.
1358
1359 @item -fno-optional-diags
1360 @opindex fno-optional-diags
1361 Disable diagnostics that the standard says a compiler does not need to
1362 issue.  Currently, the only such diagnostic issued by G++ is the one for
1363 a name having multiple meanings within a class.
1364
1365 @item -fpermissive
1366 @opindex fpermissive
1367 Downgrade messages about nonconformant code from errors to warnings.  By
1368 default, G++ effectively sets @option{-pedantic-errors} without
1369 @option{-pedantic}; this option reverses that.  This behavior and this
1370 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1371
1372 @item -frepo
1373 @opindex frepo
1374 Enable automatic template instantiation at link time.  This option also
1375 implies @option{-fno-implicit-templates}.  @xref{Template
1376 Instantiation}, for more information.
1377
1378 @item -fno-rtti
1379 @opindex fno-rtti
1380 Disable generation of information about every class with virtual
1381 functions for use by the C++ runtime type identification features
1382 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1383 of the language, you can save some space by using this flag.  Note that
1384 exception handling uses the same information, but it will generate it as
1385 needed.
1386
1387 @item -fstats
1388 @opindex fstats
1389 Emit statistics about front-end processing at the end of the compilation.
1390 This information is generally only useful to the G++ development team.
1391
1392 @item -ftemplate-depth-@var{n}
1393 @opindex ftemplate-depth
1394 Set the maximum instantiation depth for template classes to @var{n}.
1395 A limit on the template instantiation depth is needed to detect
1396 endless recursions during template class instantiation.  ANSI/ISO C++
1397 conforming programs must not rely on a maximum depth greater than 17.
1398
1399 @item -fuse-cxa-atexit
1400 @opindex fuse-cxa-atexit
1401 Register destructors for objects with static storage duration with the
1402 @code{__cxa_atexit} function rather than the @code{atexit} function.
1403 This option is required for fully standards-compliant handling of static
1404 destructors, but will only work if your C library supports
1405 @code{__cxa_atexit}.
1406
1407 @item -fvtable-gc
1408 @opindex fvtable-gc
1409 Emit special relocations for vtables and virtual function references
1410 so that the linker can identify unused virtual functions and zero out
1411 vtable slots that refer to them.  This is most useful with
1412 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1413 also discard the functions themselves.
1414
1415 This optimization requires GNU as and GNU ld.  Not all systems support
1416 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1417
1418 @item -fno-weak
1419 @opindex fno-weak
1420 Do not use weak symbol support, even if it is provided by the linker.
1421 By default, G++ will use weak symbols if they are available.  This
1422 option exists only for testing, and should not be used by end-users;
1423 it will result in inferior code and has no benefits.  This option may
1424 be removed in a future release of G++.
1425
1426 @item -nostdinc++
1427 @opindex nostdinc++
1428 Do not search for header files in the standard directories specific to
1429 C++, but do still search the other standard directories.  (This option
1430 is used when building the C++ library.)
1431 @end table
1432
1433 In addition, these optimization, warning, and code generation options
1434 have meanings only for C++ programs:
1435
1436 @table @gcctabopt
1437 @item -fno-default-inline
1438 @opindex fno-default-inline
1439 Do not assume @samp{inline} for functions defined inside a class scope.
1440 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1441 functions will have linkage like inline functions; they just won't be
1442 inlined by default.
1443
1444 @item -Wctor-dtor-privacy @r{(C++ only)}
1445 @opindex Wctor-dtor-privacy
1446 Warn when a class seems unusable, because all the constructors or
1447 destructors in a class are private and the class has no friends or
1448 public static member functions.
1449
1450 @item -Wnon-virtual-dtor @r{(C++ only)}
1451 @opindex Wnon-virtual-dtor
1452 Warn when a class declares a non-virtual destructor that should probably
1453 be virtual, because it looks like the class will be used polymorphically.
1454
1455 @item -Wreorder @r{(C++ only)}
1456 @opindex Wreorder
1457 @cindex reordering, warning
1458 @cindex warning for reordering of member initializers
1459 Warn when the order of member initializers given in the code does not
1460 match the order in which they must be executed.  For instance:
1461
1462 @smallexample
1463 struct A @{
1464   int i;
1465   int j;
1466   A(): j (0), i (1) @{ @}
1467 @};
1468 @end smallexample
1469
1470 Here the compiler will warn that the member initializers for @samp{i}
1471 and @samp{j} will be rearranged to match the declaration order of the
1472 members.
1473 @end table
1474
1475 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1476
1477 @table @gcctabopt
1478 @item -Weffc++ @r{(C++ only)}
1479 @opindex Weffc++
1480 Warn about violations of various style guidelines from Scott Meyers'
1481 @cite{Effective C++} books.  If you use this option, you should be aware
1482 that the standard library headers do not obey all of these guidelines;
1483 you can use @samp{grep -v} to filter out those warnings.
1484
1485 @item -Wno-deprecated @r{(C++ only)}
1486 @opindex Wno-deprecated
1487 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1488
1489 @item -Wno-non-template-friend @r{(C++ only)}
1490 @opindex Wno-non-template-friend
1491 Disable warnings when non-templatized friend functions are declared
1492 within a template.  With the advent of explicit template specification
1493 support in G++, if the name of the friend is an unqualified-id (i.e.,
1494 @samp{friend foo(int)}), the C++ language specification demands that the
1495 friend declare or define an ordinary, nontemplate function.  (Section
1496 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1497 could be interpreted as a particular specialization of a templatized
1498 function.  Because this non-conforming behavior is no longer the default
1499 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1500 check existing code for potential trouble spots, and is on by default.
1501 This new compiler behavior can be turned off with
1502 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1503 but disables the helpful warning.
1504
1505 @item -Wold-style-cast @r{(C++ only)}
1506 @opindex Wold-style-cast
1507 Warn if an old-style (C-style) cast is used within a C++ program.  The
1508 new-style casts (@samp{static_cast}, @samp{reinterpret_cast}, and
1509 @samp{const_cast}) are less vulnerable to unintended effects, and much
1510 easier to grep for.
1511
1512 @item -Woverloaded-virtual @r{(C++ only)}
1513 @opindex Woverloaded-virtual
1514 @cindex overloaded virtual fn, warning
1515 @cindex warning for overloaded virtual fn
1516 Warn when a function declaration hides virtual functions from a
1517 base class.  For example, in:
1518
1519 @smallexample
1520 struct A @{
1521   virtual void f();
1522 @};
1523
1524 struct B: public A @{
1525   void f(int);
1526 @};
1527 @end smallexample
1528
1529 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1530 like this:
1531
1532 @smallexample
1533 B* b;
1534 b->f();
1535 @end smallexample
1536
1537 will fail to compile.
1538
1539 @item -Wno-pmf-conversions @r{(C++ only)}
1540 @opindex Wno-pmf-conversions
1541 Disable the diagnostic for converting a bound pointer to member function
1542 to a plain pointer.
1543
1544 @item -Wsign-promo @r{(C++ only)}
1545 @opindex Wsign-promo
1546 Warn when overload resolution chooses a promotion from unsigned or
1547 enumeral type to a signed type over a conversion to an unsigned type of
1548 the same size.  Previous versions of G++ would try to preserve
1549 unsignedness, but the standard mandates the current behavior.
1550
1551 @item -Wsynth @r{(C++ only)}
1552 @opindex Wsynth
1553 @cindex warning for synthesized methods
1554 @cindex synthesized methods, warning
1555 Warn when G++'s synthesis behavior does not match that of cfront.  For
1556 instance:
1557
1558 @smallexample
1559 struct A @{
1560   operator int ();
1561   A& operator = (int);
1562 @};
1563
1564 main ()
1565 @{
1566   A a,b;
1567   a = b;
1568 @}
1569 @end smallexample
1570
1571 In this example, G++ will synthesize a default @samp{A& operator =
1572 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1573 @end table
1574
1575 @node Objective-C Dialect Options
1576 @section Options Controlling Objective-C Dialect
1577
1578 @cindex compiler options, Objective-C
1579 @cindex Objective-C options, command line
1580 @cindex options, Objective-C
1581 This section describes the command-line options that are only meaningful
1582 for Objective-C programs; but you can also use most of the GNU compiler
1583 options regardless of what language your program is in.  For example,
1584 you might compile a file @code{some_class.m} like this:
1585
1586 @example
1587 gcc -g -fgnu-runtime -O -c some_class.m
1588 @end example
1589
1590 @noindent
1591 In this example, only @option{-fgnu-runtime} is an option meant only for
1592 Objective-C programs; you can use the other options with any language
1593 supported by GCC@.
1594
1595 Here is a list of options that are @emph{only} for compiling Objective-C
1596 programs:
1597
1598 @table @gcctabopt
1599 @item -fconstant-string-class=@var{class-name}
1600 @opindex fconstant-string-class
1601 Use @var{class-name} as the name of the class to instantiate for each
1602 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1603 class name is @code{NXConstantString}.
1604
1605 @item -fgnu-runtime
1606 @opindex fgnu-runtime
1607 Generate object code compatible with the standard GNU Objective-C
1608 runtime.  This is the default for most types of systems.
1609
1610 @item -fnext-runtime
1611 @opindex fnext-runtime
1612 Generate output compatible with the NeXT runtime.  This is the default
1613 for NeXT-based systems, including Darwin and Mac OS X@.
1614
1615 @item -gen-decls
1616 @opindex gen-decls
1617 Dump interface declarations for all classes seen in the source file to a
1618 file named @file{@var{sourcename}.decl}.
1619
1620 @item -Wno-protocol
1621 @opindex Wno-protocol
1622 Do not warn if methods required by a protocol are not implemented
1623 in the class adopting it.
1624
1625 @item -Wselector
1626 @opindex Wselector
1627 Warn if a selector has multiple methods of different types defined.
1628
1629 @c not documented because only avail via -Wp
1630 @c @item -print-objc-runtime-info
1631
1632 @end table
1633
1634 @node Language Independent Options
1635 @section Options to Control Diagnostic Messages Formatting
1636 @cindex options to control diagnostics formatting
1637 @cindex diagnostic messages
1638 @cindex message formatting
1639
1640 Traditionally, diagnostic messages have been formatted irrespective of
1641 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1642 below can be used to control the diagnostic messages formatting
1643 algorithm, e.g.@: how many characters per line, how often source location
1644 information should be reported.  Right now, only the C++ front end can
1645 honor these options.  However it is expected, in the near future, that
1646 the remaining front ends would be able to digest them correctly.
1647
1648 @table @gcctabopt
1649 @item -fmessage-length=@var{n}
1650 @opindex fmessage-length
1651 Try to format error messages so that they fit on lines of about @var{n}
1652 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1653 the front ends supported by GCC@.  If @var{n} is zero, then no
1654 line-wrapping will be done; each error message will appear on a single
1655 line.
1656
1657 @opindex fdiagnostics-show-location
1658 @item -fdiagnostics-show-location=once
1659 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1660 reporter to emit @emph{once} source location information; that is, in
1661 case the message is too long to fit on a single physical line and has to
1662 be wrapped, the source location won't be emitted (as prefix) again,
1663 over and over, in subsequent continuation lines.  This is the default
1664 behaviour.
1665
1666 @item -fdiagnostics-show-location=every-line
1667 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1668 messages reporter to emit the same source location information (as
1669 prefix) for physical lines that result from the process of breaking a
1670 a message which is too long to fit on a single line.
1671
1672 @end table
1673
1674 @node Warning Options
1675 @section Options to Request or Suppress Warnings
1676 @cindex options to control warnings
1677 @cindex warning messages
1678 @cindex messages, warning
1679 @cindex suppressing warnings
1680
1681 Warnings are diagnostic messages that report constructions which
1682 are not inherently erroneous but which are risky or suggest there
1683 may have been an error.
1684
1685 You can request many specific warnings with options beginning @samp{-W},
1686 for example @option{-Wimplicit} to request warnings on implicit
1687 declarations.  Each of these specific warning options also has a
1688 negative form beginning @samp{-Wno-} to turn off warnings;
1689 for example, @option{-Wno-implicit}.  This manual lists only one of the
1690 two forms, whichever is not the default.
1691
1692 These options control the amount and kinds of warnings produced by GCC:
1693
1694 @table @gcctabopt
1695 @cindex syntax checking
1696 @item -fsyntax-only
1697 @opindex fsyntax-only
1698 Check the code for syntax errors, but don't do anything beyond that.
1699
1700 @item -pedantic
1701 @opindex pedantic
1702 Issue all the warnings demanded by strict ISO C and ISO C++;
1703 reject all programs that use forbidden extensions, and some other
1704 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1705 version of the ISO C standard specified by any @option{-std} option used.
1706
1707 Valid ISO C and ISO C++ programs should compile properly with or without
1708 this option (though a rare few will require @option{-ansi} or a
1709 @option{-std} option specifying the required version of ISO C)@.  However,
1710 without this option, certain GNU extensions and traditional C and C++
1711 features are supported as well.  With this option, they are rejected.
1712
1713 @option{-pedantic} does not cause warning messages for use of the
1714 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1715 warnings are also disabled in the expression that follows
1716 @code{__extension__}.  However, only system header files should use
1717 these escape routes; application programs should avoid them.
1718 @xref{Alternate Keywords}.
1719
1720 Some users try to use @option{-pedantic} to check programs for strict ISO
1721 C conformance.  They soon find that it does not do quite what they want:
1722 it finds some non-ISO practices, but not all---only those for which
1723 ISO C @emph{requires} a diagnostic, and some others for which
1724 diagnostics have been added.
1725
1726 A feature to report any failure to conform to ISO C might be useful in
1727 some instances, but would require considerable additional work and would
1728 be quite different from @option{-pedantic}.  We don't have plans to
1729 support such a feature in the near future.
1730
1731 Where the standard specified with @option{-std} represents a GNU
1732 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1733 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1734 extended dialect is based.  Warnings from @option{-pedantic} are given
1735 where they are required by the base standard.  (It would not make sense
1736 for such warnings to be given only for features not in the specified GNU
1737 C dialect, since by definition the GNU dialects of C include all
1738 features the compiler supports with the given option, and there would be
1739 nothing to warn about.)
1740
1741 @item -pedantic-errors
1742 @opindex pedantic-errors
1743 Like @option{-pedantic}, except that errors are produced rather than
1744 warnings.
1745
1746 @item -w
1747 @opindex w
1748 Inhibit all warning messages.
1749
1750 @item -Wno-import
1751 @opindex Wno-import
1752 Inhibit warning messages about the use of @samp{#import}.
1753
1754 @item -Wchar-subscripts
1755 @opindex Wchar-subscripts
1756 Warn if an array subscript has type @code{char}.  This is a common cause
1757 of error, as programmers often forget that this type is signed on some
1758 machines.
1759
1760 @item -Wcomment
1761 @opindex Wcomment
1762 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1763 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1764
1765 @item -Wformat
1766 @opindex Wformat
1767 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1768 the arguments supplied have types appropriate to the format string
1769 specified, and that the conversions specified in the format string make
1770 sense.  This includes standard functions, and others specified by format
1771 attributes (@pxref{Function Attributes}), in the @code{printf},
1772 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1773 not in the C standard) families.
1774
1775 The formats are checked against the format features supported by GNU
1776 libc version 2.2.  These include all ISO C89 and C99 features, as well
1777 as features from the Single Unix Specification and some BSD and GNU
1778 extensions.  Other library implementations may not support all these
1779 features; GCC does not support warning about features that go beyond a
1780 particular library's limitations.  However, if @option{-pedantic} is used
1781 with @option{-Wformat}, warnings will be given about format features not
1782 in the selected standard version (but not for @code{strfmon} formats,
1783 since those are not in any version of the C standard).  @xref{C Dialect
1784 Options,,Options Controlling C Dialect}.
1785
1786 @option{-Wformat} is included in @option{-Wall}.  For more control over some
1787 aspects of format checking, the options @option{-Wno-format-y2k},
1788 @option{-Wno-format-extra-args}, @option{-Wformat-nonliteral},
1789 @option{-Wformat-security} and @option{-Wformat=2} are available, but are
1790 not included in @option{-Wall}.
1791
1792 @item -Wno-format-y2k
1793 @opindex Wno-format-y2k
1794 If @option{-Wformat} is specified, do not warn about @code{strftime}
1795 formats which may yield only a two-digit year.
1796
1797 @item -Wno-format-extra-args
1798 @opindex Wno-format-extra-args
1799 If @option{-Wformat} is specified, do not warn about excess arguments to a
1800 @code{printf} or @code{scanf} format function.  The C standard specifies
1801 that such arguments are ignored.
1802
1803 @item -Wformat-nonliteral
1804 @opindex Wformat-nonliteral
1805 If @option{-Wformat} is specified, also warn if the format string is not a
1806 string literal and so cannot be checked, unless the format function
1807 takes its format arguments as a @code{va_list}.
1808
1809 @item -Wformat-security
1810 @opindex Wformat-security
1811 If @option{-Wformat} is specified, also warn about uses of format
1812 functions that represent possible security problems.  At present, this
1813 warns about calls to @code{printf} and @code{scanf} functions where the
1814 format string is not a string literal and there are no format arguments,
1815 as in @code{printf (foo);}.  This may be a security hole if the format
1816 string came from untrusted input and contains @samp{%n}.  (This is
1817 currently a subset of what @option{-Wformat-nonliteral} warns about, but
1818 in future warnings may be added to @option{-Wformat-security} that are not
1819 included in @option{-Wformat-nonliteral}.)
1820
1821 @item -Wformat=2
1822 @opindex Wformat=2
1823 Enable @option{-Wformat} plus format checks not included in
1824 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
1825 -Wformat-nonliteral -Wformat-security}.
1826
1827 @item -Wimplicit-int
1828 @opindex Wimplicit-int
1829 Warn when a declaration does not specify a type.
1830
1831 @item -Wimplicit-function-declaration
1832 @itemx -Werror-implicit-function-declaration
1833 @opindex Wimplicit-function-declaration
1834 @opindex Werror-implicit-function-declaration
1835 Give a warning (or error) whenever a function is used before being
1836 declared.
1837
1838 @item -Wimplicit
1839 @opindex Wimplicit
1840 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
1841
1842 @item -Wmain
1843 @opindex Wmain
1844 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
1845 function with external linkage, returning int, taking either zero
1846 arguments, two, or three arguments of appropriate types.
1847
1848 @item -Wmissing-braces
1849 @opindex Wmissing-braces
1850 Warn if an aggregate or union initializer is not fully bracketed.  In
1851 the following example, the initializer for @samp{a} is not fully
1852 bracketed, but that for @samp{b} is fully bracketed.
1853
1854 @smallexample
1855 int a[2][2] = @{ 0, 1, 2, 3 @};
1856 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
1857 @end smallexample
1858
1859 @item -Wmultichar
1860 @opindex Wmultichar
1861 Warn if a multicharacter constant (@samp{'FOOF'}) is used.  Usually they
1862 indicate a typo in the user's code, as they have implementation-defined
1863 values, and should not be used in portable code.
1864
1865 @item -Wparentheses
1866 @opindex Wparentheses
1867 Warn if parentheses are omitted in certain contexts, such
1868 as when there is an assignment in a context where a truth value
1869 is expected, or when operators are nested whose precedence people
1870 often get confused about.
1871
1872 Also warn about constructions where there may be confusion to which
1873 @code{if} statement an @code{else} branch belongs.  Here is an example of
1874 such a case:
1875
1876 @smallexample
1877 @group
1878 @{
1879   if (a)
1880     if (b)
1881       foo ();
1882   else
1883     bar ();
1884 @}
1885 @end group
1886 @end smallexample
1887
1888 In C, every @code{else} branch belongs to the innermost possible @code{if}
1889 statement, which in this example is @code{if (b)}.  This is often not
1890 what the programmer expected, as illustrated in the above example by
1891 indentation the programmer chose.  When there is the potential for this
1892 confusion, GCC will issue a warning when this flag is specified.
1893 To eliminate the warning, add explicit braces around the innermost
1894 @code{if} statement so there is no way the @code{else} could belong to
1895 the enclosing @code{if}.  The resulting code would look like this:
1896
1897 @smallexample
1898 @group
1899 @{
1900   if (a)
1901     @{
1902       if (b)
1903         foo ();
1904       else
1905         bar ();
1906     @}
1907 @}
1908 @end group
1909 @end smallexample
1910
1911 @item -Wsequence-point
1912 @opindex Wsequence-point
1913 Warn about code that may have undefined semantics because of violations
1914 of sequence point rules in the C standard.
1915
1916 The C standard defines the order in which expressions in a C program are
1917 evaluated in terms of @dfn{sequence points}, which represent a partial
1918 ordering between the execution of parts of the program: those executed
1919 before the sequence point, and those executed after it.  These occur
1920 after the evaluation of a full expression (one which is not part of a
1921 larger expression), after the evaluation of the first operand of a
1922 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
1923 function is called (but after the evaluation of its arguments and the
1924 expression denoting the called function), and in certain other places.
1925 Other than as expressed by the sequence point rules, the order of
1926 evaluation of subexpressions of an expression is not specified.  All
1927 these rules describe only a partial order rather than a total order,
1928 since, for example, if two functions are called within one expression
1929 with no sequence point between them, the order in which the functions
1930 are called is not specified.  However, the standards committee have
1931 ruled that function calls do not overlap.
1932
1933 It is not specified when between sequence points modifications to the
1934 values of objects take effect.  Programs whose behavior depends on this
1935 have undefined behavior; the C standard specifies that ``Between the
1936 previous and next sequence point an object shall have its stored value
1937 modified at most once by the evaluation of an expression.  Furthermore,
1938 the prior value shall be read only to determine the value to be
1939 stored.''.  If a program breaks these rules, the results on any
1940 particular implementation are entirely unpredictable.
1941
1942 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
1943 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
1944 diagnosed by this option, and it may give an occasional false positive
1945 result, but in general it has been found fairly effective at detecting
1946 this sort of problem in programs.
1947
1948 The present implementation of this option only works for C programs.  A
1949 future implementation may also work for C++ programs.
1950
1951 The C standard is worded confusingly, therefore there is some debate
1952 over the precise meaning of the sequence point rules in subtle cases.
1953 Links to discussions of the problem, including proposed formal
1954 definitions, may be found on our readings page, at
1955 @w{@uref{http://gcc.gnu.org/readings.html}}.
1956
1957 @item -Wreturn-type
1958 @opindex Wreturn-type
1959 Warn whenever a function is defined with a return-type that defaults to
1960 @code{int}.  Also warn about any @code{return} statement with no
1961 return-value in a function whose return-type is not @code{void}.
1962
1963 For C++, a function without return type always produces a diagnostic
1964 message, even when @option{-Wno-return-type} is specified.  The only
1965 exceptions are @samp{main} and functions defined in system headers.
1966
1967 @item -Wswitch
1968 @opindex Wswitch
1969 Warn whenever a @code{switch} statement has an index of enumeral type
1970 and lacks a @code{case} for one or more of the named codes of that
1971 enumeration.  (The presence of a @code{default} label prevents this
1972 warning.)  @code{case} labels outside the enumeration range also
1973 provoke warnings when this option is used.
1974
1975 @item -Wtrigraphs
1976 @opindex Wtrigraphs
1977 Warn if any trigraphs are encountered that might change the meaning of
1978 the program (trigraphs within comments are not warned about).
1979
1980 @item -Wunused-function
1981 @opindex Wunused-function
1982 Warn whenever a static function is declared but not defined or a
1983 non\-inline static function is unused.
1984
1985 @item -Wunused-label
1986 @opindex Wunused-label
1987 Warn whenever a label is declared but not used.
1988
1989 To suppress this warning use the @samp{unused} attribute
1990 (@pxref{Variable Attributes}).
1991
1992 @item -Wunused-parameter
1993 @opindex Wunused-parameter
1994 Warn whenever a function parameter is unused aside from its declaration.
1995
1996 To suppress this warning use the @samp{unused} attribute
1997 (@pxref{Variable Attributes}).
1998
1999 @item -Wunused-variable
2000 @opindex Wunused-variable
2001 Warn whenever a local variable or non-constant static variable is unused
2002 aside from its declaration
2003
2004 To suppress this warning use the @samp{unused} attribute
2005 (@pxref{Variable Attributes}).
2006
2007 @item -Wunused-value
2008 @opindex Wunused-value
2009 Warn whenever a statement computes a result that is explicitly not used.
2010
2011 To suppress this warning cast the expression to @samp{void}.
2012
2013 @item -Wunused
2014 @opindex Wunused
2015 All all the above @option{-Wunused} options combined.
2016
2017 In order to get a warning about an unused function parameter, you must
2018 either specify @samp{-W -Wunused} or separately specify
2019 @option{-Wunused-parameter}.
2020
2021 @item -Wuninitialized
2022 @opindex Wuninitialized
2023 Warn if an automatic variable is used without first being initialized or
2024 if a variable may be clobbered by a @code{setjmp} call.
2025
2026 These warnings are possible only in optimizing compilation,
2027 because they require data flow information that is computed only
2028 when optimizing.  If you don't specify @option{-O}, you simply won't
2029 get these warnings.
2030
2031 These warnings occur only for variables that are candidates for
2032 register allocation.  Therefore, they do not occur for a variable that
2033 is declared @code{volatile}, or whose address is taken, or whose size
2034 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2035 structures, unions or arrays, even when they are in registers.
2036
2037 Note that there may be no warning about a variable that is used only
2038 to compute a value that itself is never used, because such
2039 computations may be deleted by data flow analysis before the warnings
2040 are printed.
2041
2042 These warnings are made optional because GCC is not smart
2043 enough to see all the reasons why the code might be correct
2044 despite appearing to have an error.  Here is one example of how
2045 this can happen:
2046
2047 @smallexample
2048 @group
2049 @{
2050   int x;
2051   switch (y)
2052     @{
2053     case 1: x = 1;
2054       break;
2055     case 2: x = 4;
2056       break;
2057     case 3: x = 5;
2058     @}
2059   foo (x);
2060 @}
2061 @end group
2062 @end smallexample
2063
2064 @noindent
2065 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2066 always initialized, but GCC doesn't know this.  Here is
2067 another common case:
2068
2069 @smallexample
2070 @{
2071   int save_y;
2072   if (change_y) save_y = y, y = new_y;
2073   @dots{}
2074   if (change_y) y = save_y;
2075 @}
2076 @end smallexample
2077
2078 @noindent
2079 This has no bug because @code{save_y} is used only if it is set.
2080
2081 @cindex @code{longjmp} warnings
2082 This option also warns when a non-volatile automatic variable might be
2083 changed by a call to @code{longjmp}.  These warnings as well are possible
2084 only in optimizing compilation.
2085
2086 The compiler sees only the calls to @code{setjmp}.  It cannot know
2087 where @code{longjmp} will be called; in fact, a signal handler could
2088 call it at any point in the code.  As a result, you may get a warning
2089 even when there is in fact no problem because @code{longjmp} cannot
2090 in fact be called at the place which would cause a problem.
2091
2092 Some spurious warnings can be avoided if you declare all the functions
2093 you use that never return as @code{noreturn}.  @xref{Function
2094 Attributes}.
2095
2096 @item -Wreorder @r{(C++ only)}
2097 @opindex Wreorder
2098 @cindex reordering, warning
2099 @cindex warning for reordering of member initializers
2100 Warn when the order of member initializers given in the code does not
2101 match the order in which they must be executed.  For instance:
2102
2103 @item -Wunknown-pragmas
2104 @opindex Wunknown-pragmas
2105 @cindex warning for unknown pragmas
2106 @cindex unknown pragmas, warning
2107 @cindex pragmas, warning of unknown
2108 Warn when a #pragma directive is encountered which is not understood by
2109 GCC@.  If this command line option is used, warnings will even be issued
2110 for unknown pragmas in system header files.  This is not the case if
2111 the warnings were only enabled by the @option{-Wall} command line option.
2112
2113 @item -Wall
2114 @opindex Wall
2115 All of the above @samp{-W} options combined.  This enables all the
2116 warnings about constructions that some users consider questionable, and
2117 that are easy to avoid (or modify to prevent the warning), even in
2118 conjunction with macros.
2119
2120 @item -Wsystem-headers
2121 @opindex Wsystem-headers
2122 @cindex warnings from system headers
2123 @cindex system headers, warnings from
2124 Print warning messages for constructs found in system header files.
2125 Warnings from system headers are normally suppressed, on the assumption
2126 that they usually do not indicate real problems and would only make the
2127 compiler output harder to read.  Using this command line option tells
2128 GCC to emit warnings from system headers as if they occurred in user
2129 code.  However, note that using @option{-Wall} in conjunction with this
2130 option will @emph{not} warn about unknown pragmas in system
2131 headers---for that, @option{-Wunknown-pragmas} must also be used.
2132 @end table
2133
2134 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2135 Some of them warn about constructions that users generally do not
2136 consider questionable, but which occasionally you might wish to check
2137 for; others warn about constructions that are necessary or hard to avoid
2138 in some cases, and there is no simple way to modify the code to suppress
2139 the warning.
2140
2141 @table @gcctabopt
2142 @item -W
2143 @opindex W
2144 Print extra warning messages for these events:
2145
2146 @itemize @bullet
2147 @item
2148 A function can return either with or without a value.  (Falling
2149 off the end of the function body is considered returning without
2150 a value.)  For example, this function would evoke such a
2151 warning:
2152
2153 @smallexample
2154 @group
2155 foo (a)
2156 @{
2157   if (a > 0)
2158     return a;
2159 @}
2160 @end group
2161 @end smallexample
2162
2163 @item
2164 An expression-statement or the left-hand side of a comma expression
2165 contains no side effects.
2166 To suppress the warning, cast the unused expression to void.
2167 For example, an expression such as @samp{x[i,j]} will cause a warning,
2168 but @samp{x[(void)i,j]} will not.
2169
2170 @item
2171 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
2172
2173 @item
2174 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2175 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2176 that of ordinary mathematical notation.
2177
2178 @item
2179 Storage-class specifiers like @code{static} are not the first things in
2180 a declaration.  According to the C Standard, this usage is obsolescent.
2181
2182 @item
2183 The return type of a function has a type qualifier such as @code{const}.
2184 Such a type qualifier has no effect, since the value returned by a
2185 function is not an lvalue.  (But don't warn about the GNU extension of
2186 @code{volatile void} return types.  That extension will be warned about
2187 if @option{-pedantic} is specified.)
2188
2189 @item
2190 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2191 arguments.
2192
2193 @item
2194 A comparison between signed and unsigned values could produce an
2195 incorrect result when the signed value is converted to unsigned.
2196 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2197
2198 @item
2199 An aggregate has a partly bracketed initializer.
2200 For example, the following code would evoke such a warning,
2201 because braces are missing around the initializer for @code{x.h}:
2202
2203 @smallexample
2204 struct s @{ int f, g; @};
2205 struct t @{ struct s h; int i; @};
2206 struct t x = @{ 1, 2, 3 @};
2207 @end smallexample
2208
2209 @item
2210 An aggregate has an initializer which does not initialize all members.
2211 For example, the following code would cause such a warning, because
2212 @code{x.h} would be implicitly initialized to zero:
2213
2214 @smallexample
2215 struct s @{ int f, g, h; @};
2216 struct s x = @{ 3, 4 @};
2217 @end smallexample
2218 @end itemize
2219
2220 @item -Wfloat-equal
2221 @opindex Wfloat-equal
2222 Warn if floating point values are used in equality comparisons.
2223
2224 The idea behind this is that sometimes it is convenient (for the
2225 programmer) to consider floating-point values as approximations to
2226 infinitely precise real numbers.  If you are doing this, then you need
2227 to compute (by analysing the code, or in some other way) the maximum or
2228 likely maximum error that the computation introduces, and allow for it
2229 when performing comparisons (and when producing output, but that's a
2230 different problem).  In particular, instead of testing for equality, you
2231 would check to see whether the two values have ranges that overlap; and
2232 this is done with the relational operators, so equality comparisons are
2233 probably mistaken.
2234
2235 @item -Wtraditional @r{(C only)}
2236 @opindex Wtraditional
2237 Warn about certain constructs that behave differently in traditional and
2238 ISO C@.  Also warn about ISO C constructs that have no traditional C
2239 equivalent, and/or problematic constructs which should be avoided.
2240
2241 @itemize @bullet
2242 @item
2243 Macro parameters that appear within string literals in the macro body.
2244 In traditional C macro replacement takes place within string literals,
2245 but does not in ISO C@.
2246
2247 @item
2248 In traditional C, some preprocessor directives did not exist.
2249 Traditional preprocessors would only consider a line to be a directive
2250 if the @samp{#} appeared in column 1 on the line.  Therefore
2251 @option{-Wtraditional} warns about directives that traditional C
2252 understands but would ignore because the @samp{#} does not appear as the
2253 first character on the line.  It also suggests you hide directives like
2254 @samp{#pragma} not understood by traditional C by indenting them.  Some
2255 traditional implementations would not recognise @samp{#elif}, so it
2256 suggests avoiding it altogether.
2257
2258 @item
2259 A function-like macro that appears without arguments.
2260
2261 @item
2262 The unary plus operator.
2263
2264 @item
2265 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2266 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2267 constants.)  Note, these suffixes appear in macros defined in the system
2268 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2269 Use of these macros in user code might normally lead to spurious
2270 warnings, however gcc's integrated preprocessor has enough context to
2271 avoid warning in these cases.
2272
2273 @item
2274 A function declared external in one block and then used after the end of
2275 the block.
2276
2277 @item
2278 A @code{switch} statement has an operand of type @code{long}.
2279
2280 @item
2281 A non-@code{static} function declaration follows a @code{static} one.
2282 This construct is not accepted by some traditional C compilers.
2283
2284 @item
2285 The ISO type of an integer constant has a different width or
2286 signedness from its traditional type.  This warning is only issued if
2287 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2288 typically represent bit patterns, are not warned about.
2289
2290 @item
2291 Usage of ISO string concatenation is detected.
2292
2293 @item
2294 Initialization of automatic aggregates.
2295
2296 @item
2297 Identifier conflicts with labels.  Traditional C lacks a separate
2298 namespace for labels.
2299
2300 @item
2301 Initialization of unions.  If the initializer is zero, the warning is
2302 omitted.  This is done under the assumption that the zero initializer in
2303 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2304 initializer warnings and relies on default initialization to zero in the
2305 traditional C case.
2306
2307 @item
2308 Conversions by prototypes between fixed/floating point values and vice
2309 versa.  The absence of these prototypes when compiling with traditional
2310 C would cause serious problems.  This is a subset of the possible
2311 conversion warnings, for the full set use @option{-Wconversion}.
2312 @end itemize
2313
2314 @item -Wundef
2315 @opindex Wundef
2316 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2317
2318 @item -Wshadow
2319 @opindex Wshadow
2320 Warn whenever a local variable shadows another local variable, parameter or
2321 global variable or whenever a built-in function is shadowed.
2322
2323 @item -Wlarger-than-@var{len}
2324 @opindex Wlarger-than
2325 Warn whenever an object of larger than @var{len} bytes is defined.
2326
2327 @item -Wpointer-arith
2328 @opindex Wpointer-arith
2329 Warn about anything that depends on the ``size of'' a function type or
2330 of @code{void}.  GNU C assigns these types a size of 1, for
2331 convenience in calculations with @code{void *} pointers and pointers
2332 to functions.
2333
2334 @item -Wbad-function-cast @r{(C only)}
2335 @opindex Wbad-function-cast
2336 Warn whenever a function call is cast to a non-matching type.
2337 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2338
2339 @item -Wcast-qual
2340 @opindex Wcast-qual
2341 Warn whenever a pointer is cast so as to remove a type qualifier from
2342 the target type.  For example, warn if a @code{const char *} is cast
2343 to an ordinary @code{char *}.
2344
2345 @item -Wcast-align
2346 @opindex Wcast-align
2347 Warn whenever a pointer is cast such that the required alignment of the
2348 target is increased.  For example, warn if a @code{char *} is cast to
2349 an @code{int *} on machines where integers can only be accessed at
2350 two- or four-byte boundaries.
2351
2352 @item -Wwrite-strings
2353 @opindex Wwrite-strings
2354 When compiling C, give string constants the type @code{const
2355 char[@var{length}]} so that
2356 copying the address of one into a non-@code{const} @code{char *}
2357 pointer will get a warning; when compiling C++, warn about the
2358 deprecated conversion from string constants to @code{char *}.
2359 These warnings will help you find at
2360 compile time code that can try to write into a string constant, but
2361 only if you have been very careful about using @code{const} in
2362 declarations and prototypes.  Otherwise, it will just be a nuisance;
2363 this is why we did not make @option{-Wall} request these warnings.
2364
2365 @item -Wconversion
2366 @opindex Wconversion
2367 Warn if a prototype causes a type conversion that is different from what
2368 would happen to the same argument in the absence of a prototype.  This
2369 includes conversions of fixed point to floating and vice versa, and
2370 conversions changing the width or signedness of a fixed point argument
2371 except when the same as the default promotion.
2372
2373 Also, warn if a negative integer constant expression is implicitly
2374 converted to an unsigned type.  For example, warn about the assignment
2375 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2376 casts like @code{(unsigned) -1}.
2377
2378 @item -Wsign-compare
2379 @opindex Wsign-compare
2380 @cindex warning for comparison of signed and unsigned values
2381 @cindex comparison of signed and unsigned values, warning
2382 @cindex signed and unsigned values, comparison warning
2383 Warn when a comparison between signed and unsigned values could produce
2384 an incorrect result when the signed value is converted to unsigned.
2385 This warning is also enabled by @option{-W}; to get the other warnings
2386 of @option{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2387
2388 @item -Waggregate-return
2389 @opindex Waggregate-return
2390 Warn if any functions that return structures or unions are defined or
2391 called.  (In languages where you can return an array, this also elicits
2392 a warning.)
2393
2394 @item -Wstrict-prototypes @r{(C only)}
2395 @opindex Wstrict-prototypes
2396 Warn if a function is declared or defined without specifying the
2397 argument types.  (An old-style function definition is permitted without
2398 a warning if preceded by a declaration which specifies the argument
2399 types.)
2400
2401 @item -Wmissing-prototypes @r{(C only)}
2402 @opindex Wmissing-prototypes
2403 Warn if a global function is defined without a previous prototype
2404 declaration.  This warning is issued even if the definition itself
2405 provides a prototype.  The aim is to detect global functions that fail
2406 to be declared in header files.
2407
2408 @item -Wmissing-declarations
2409 @opindex Wmissing-declarations
2410 Warn if a global function is defined without a previous declaration.
2411 Do so even if the definition itself provides a prototype.
2412 Use this option to detect global functions that are not declared in
2413 header files.
2414
2415 @item -Wmissing-noreturn
2416 @opindex Wmissing-noreturn
2417 Warn about functions which might be candidates for attribute @code{noreturn}.
2418 Note these are only possible candidates, not absolute ones.  Care should
2419 be taken to manually verify functions actually do not ever return before
2420 adding the @code{noreturn} attribute, otherwise subtle code generation
2421 bugs could be introduced.  You will not get a warning for @code{main} in
2422 hosted C environments.
2423
2424 @item -Wmissing-format-attribute
2425 @opindex Wmissing-format-attribute
2426 @opindex Wformat
2427 If @option{-Wformat} is enabled, also warn about functions which might be
2428 candidates for @code{format} attributes.  Note these are only possible
2429 candidates, not absolute ones.  GCC will guess that @code{format}
2430 attributes might be appropriate for any function that calls a function
2431 like @code{vprintf} or @code{vscanf}, but this might not always be the
2432 case, and some functions for which @code{format} attributes are
2433 appropriate may not be detected.  This option has no effect unless
2434 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2435
2436 @item -Wpacked
2437 @opindex Wpacked
2438 Warn if a structure is given the packed attribute, but the packed
2439 attribute has no effect on the layout or size of the structure.
2440 Such structures may be mis-aligned for little benefit.  For
2441 instance, in this code, the variable @code{f.x} in @code{struct bar}
2442 will be misaligned even though @code{struct bar} does not itself
2443 have the packed attribute:
2444
2445 @smallexample
2446 @group
2447 struct foo @{
2448   int x;
2449   char a, b, c, d;
2450 @} __attribute__((packed));
2451 struct bar @{
2452   char z;
2453   struct foo f;
2454 @};
2455 @end group
2456 @end smallexample
2457
2458 @item -Wpadded
2459 @opindex Wpadded
2460 Warn if padding is included in a structure, either to align an element
2461 of the structure or to align the whole structure.  Sometimes when this
2462 happens it is possible to rearrange the fields of the structure to
2463 reduce the padding and so make the structure smaller.
2464
2465 @item -Wredundant-decls
2466 @opindex Wredundant-decls
2467 Warn if anything is declared more than once in the same scope, even in
2468 cases where multiple declaration is valid and changes nothing.
2469
2470 @item -Wnested-externs @r{(C only)}
2471 @opindex Wnested-externs
2472 Warn if an @code{extern} declaration is encountered within a function.
2473
2474 @item -Wunreachable-code
2475 @opindex Wunreachable-code
2476 Warn if the compiler detects that code will never be executed.
2477
2478 This option is intended to warn when the compiler detects that at
2479 least a whole line of source code will never be executed, because
2480 some condition is never satisfied or because it is after a
2481 procedure that never returns.
2482
2483 It is possible for this option to produce a warning even though there
2484 are circumstances under which part of the affected line can be executed,
2485 so care should be taken when removing apparently-unreachable code.
2486
2487 For instance, when a function is inlined, a warning may mean that the
2488 line is unreachable in only one inlined copy of the function.
2489
2490 This option is not made part of @option{-Wall} because in a debugging
2491 version of a program there is often substantial code which checks
2492 correct functioning of the program and is, hopefully, unreachable
2493 because the program does work.  Another common use of unreachable
2494 code is to provide behaviour which is selectable at compile-time.
2495
2496 @item -Winline
2497 @opindex Winline
2498 Warn if a function can not be inlined and it was declared as inline.
2499
2500 @item -Wlong-long
2501 @opindex Wlong-long
2502 @opindex Wno-long-long
2503 Warn if @samp{long long} type is used.  This is default.  To inhibit
2504 the warning messages, use @option{-Wno-long-long}.  Flags
2505 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2506 only when @option{-pedantic} flag is used.
2507
2508 @item -Wdisabled-optimization
2509 @opindex Wdisabled-optimization
2510 Warn if a requested optimization pass is disabled.  This warning does
2511 not generally indicate that there is anything wrong with your code; it
2512 merely indicates that GCC's optimizers were unable to handle the code
2513 effectively.  Often, the problem is that your code is too big or too
2514 complex; GCC will refuse to optimize programs when the optimization
2515 itself is likely to take inordinate amounts of time.
2516
2517 @item -Werror
2518 @opindex Werror
2519 Make all warnings into errors.
2520 @end table
2521
2522 @node Debugging Options
2523 @section Options for Debugging Your Program or GCC
2524 @cindex options, debugging
2525 @cindex debugging information options
2526
2527 GCC has various special options that are used for debugging
2528 either your program or GCC:
2529
2530 @table @gcctabopt
2531 @item -g
2532 @opindex g
2533 Produce debugging information in the operating system's native format
2534 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2535 information.
2536
2537 On most systems that use stabs format, @option{-g} enables use of extra
2538 debugging information that only GDB can use; this extra information
2539 makes debugging work better in GDB but will probably make other debuggers
2540 crash or
2541 refuse to read the program.  If you want to control for certain whether
2542 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2543 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, or @option{-gdwarf-1}
2544 (see below).
2545
2546 Unlike most other C compilers, GCC allows you to use @option{-g} with
2547 @option{-O}.  The shortcuts taken by optimized code may occasionally
2548 produce surprising results: some variables you declared may not exist
2549 at all; flow of control may briefly move where you did not expect it;
2550 some statements may not be executed because they compute constant
2551 results or their values were already at hand; some statements may
2552 execute in different places because they were moved out of loops.
2553
2554 Nevertheless it proves possible to debug optimized output.  This makes
2555 it reasonable to use the optimizer for programs that might have bugs.
2556
2557 The following options are useful when GCC is generated with the
2558 capability for more than one debugging format.
2559
2560 @item -ggdb
2561 @opindex ggdb
2562 Produce debugging information for use by GDB@.  This means to use the
2563 most expressive format available (DWARF 2, stabs, or the native format
2564 if neither of those are supported), including GDB extensions if at all
2565 possible.
2566
2567 @item -gstabs
2568 @opindex gstabs
2569 Produce debugging information in stabs format (if that is supported),
2570 without GDB extensions.  This is the format used by DBX on most BSD
2571 systems.  On MIPS, Alpha and System V Release 4 systems this option
2572 produces stabs debugging output which is not understood by DBX or SDB@.
2573 On System V Release 4 systems this option requires the GNU assembler.
2574
2575 @item -gstabs+
2576 @opindex gstabs+
2577 Produce debugging information in stabs format (if that is supported),
2578 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2579 use of these extensions is likely to make other debuggers crash or
2580 refuse to read the program.
2581
2582 @item -gcoff
2583 @opindex gcoff
2584 Produce debugging information in COFF format (if that is supported).
2585 This is the format used by SDB on most System V systems prior to
2586 System V Release 4.
2587
2588 @item -gxcoff
2589 @opindex gxcoff
2590 Produce debugging information in XCOFF format (if that is supported).
2591 This is the format used by the DBX debugger on IBM RS/6000 systems.
2592
2593 @item -gxcoff+
2594 @opindex gxcoff+
2595 Produce debugging information in XCOFF format (if that is supported),
2596 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2597 use of these extensions is likely to make other debuggers crash or
2598 refuse to read the program, and may cause assemblers other than the GNU
2599 assembler (GAS) to fail with an error.
2600
2601 @item -gdwarf
2602 @opindex gdwarf
2603 Produce debugging information in DWARF version 1 format (if that is
2604 supported).  This is the format used by SDB on most System V Release 4
2605 systems.
2606
2607 @item -gdwarf+
2608 @opindex gdwarf+
2609 Produce debugging information in DWARF version 1 format (if that is
2610 supported), using GNU extensions understood only by the GNU debugger
2611 (GDB)@.  The use of these extensions is likely to make other debuggers
2612 crash or refuse to read the program.
2613
2614 @item -gdwarf-2
2615 @opindex gdwarf-2
2616 Produce debugging information in DWARF version 2 format (if that is
2617 supported).  This is the format used by DBX on IRIX 6.
2618
2619 @item -g@var{level}
2620 @itemx -ggdb@var{level}
2621 @itemx -gstabs@var{level}
2622 @itemx -gcoff@var{level}
2623 @itemx -gxcoff@var{level}
2624 @itemx -gdwarf@var{level}
2625 @itemx -gdwarf-2@var{level}
2626 Request debugging information and also use @var{level} to specify how
2627 much information.  The default level is 2.
2628
2629 Level 1 produces minimal information, enough for making backtraces in
2630 parts of the program that you don't plan to debug.  This includes
2631 descriptions of functions and external variables, but no information
2632 about local variables and no line numbers.
2633
2634 Level 3 includes extra information, such as all the macro definitions
2635 present in the program.  Some debuggers support macro expansion when
2636 you use @option{-g3}.
2637
2638 @cindex @code{prof}
2639 @item -p
2640 @opindex p
2641 Generate extra code to write profile information suitable for the
2642 analysis program @code{prof}.  You must use this option when compiling
2643 the source files you want data about, and you must also use it when
2644 linking.
2645
2646 @cindex @code{gprof}
2647 @item -pg
2648 @opindex pg
2649 Generate extra code to write profile information suitable for the
2650 analysis program @code{gprof}.  You must use this option when compiling
2651 the source files you want data about, and you must also use it when
2652 linking.
2653
2654 @cindex @code{tcov}
2655 @item -a
2656 @opindex a
2657 Generate extra code to write profile information for basic blocks, which will
2658 record the number of times each basic block is executed, the basic block start
2659 address, and the function name containing the basic block.  If @option{-g} is
2660 used, the line number and filename of the start of the basic block will also be
2661 recorded.  If not overridden by the machine description, the default action is
2662 to append to the text file @file{bb.out}.
2663
2664 This data could be analyzed by a program like @code{tcov}.  Note,
2665 however, that the format of the data is not what @code{tcov} expects.
2666 Eventually GNU @code{gprof} should be extended to process this data.
2667
2668 @item -Q
2669 @opindex Q
2670 Makes the compiler print out each function name as it is compiled, and
2671 print some statistics about each pass when it finishes.
2672
2673 @item -ftime-report
2674 @opindex ftime-report
2675 Makes the compiler print some statistics about the time consumed by each
2676 pass when it finishes.
2677
2678 @item -fmem-report
2679 @opindex fmem-report
2680 Makes the compiler print some statistics about permanent memory
2681 allocation when it finishes.
2682
2683 @item -ax
2684 @opindex ax
2685 Generate extra code to profile basic blocks.  Your executable will
2686 produce output that is a superset of that produced when @option{-a} is
2687 used.  Additional output is the source and target address of the basic
2688 blocks where a jump takes place, the number of times a jump is executed,
2689 and (optionally) the complete sequence of basic blocks being executed.
2690 The output is appended to file @file{bb.out}.
2691
2692 You can examine different profiling aspects without recompilation.  Your
2693 executable will read a list of function names from file @file{bb.in}.
2694 Profiling starts when a function on the list is entered and stops when
2695 that invocation is exited.  To exclude a function from profiling, prefix
2696 its name with @samp{-}.  If a function name is not unique, you can
2697 disambiguate it by writing it in the form
2698 @samp{/path/filename.d:functionname}.  Your executable will write the
2699 available paths and filenames in file @file{bb.out}.
2700
2701 Several function names have a special meaning:
2702 @table @code
2703 @item __bb_jumps__
2704 Write source, target and frequency of jumps to file @file{bb.out}.
2705 @item __bb_hidecall__
2706 Exclude function calls from frequency count.
2707 @item __bb_showret__
2708 Include function returns in frequency count.
2709 @item __bb_trace__
2710 Write the sequence of basic blocks executed to file @file{bbtrace.gz}.
2711 The file will be compressed using the program @samp{gzip}, which must
2712 exist in your @env{PATH}.  On systems without the @samp{popen}
2713 function, the file will be named @file{bbtrace} and will not be
2714 compressed.  @strong{Profiling for even a few seconds on these systems
2715 will produce a very large file.}  Note: @code{__bb_hidecall__} and
2716 @code{__bb_showret__} will not affect the sequence written to
2717 @file{bbtrace.gz}.
2718 @end table
2719
2720 Here's a short example using different profiling parameters
2721 in file @file{bb.in}.  Assume function @code{foo} consists of basic blocks
2722 1 and 2 and is called twice from block 3 of function @code{main}.  After
2723 the calls, block 3 transfers control to block 4 of @code{main}.
2724
2725 With @code{__bb_trace__} and @code{main} contained in file @file{bb.in},
2726 the following sequence of blocks is written to file @file{bbtrace.gz}:
2727 0 3 1 2 1 2 4.  The return from block 2 to block 3 is not shown, because
2728 the return is to a point inside the block and not to the top.  The
2729 block address 0 always indicates, that control is transferred
2730 to the trace from somewhere outside the observed functions.  With
2731 @samp{-foo} added to @file{bb.in}, the blocks of function
2732 @code{foo} are removed from the trace, so only 0 3 4 remains.
2733
2734 With @code{__bb_jumps__} and @code{main} contained in file @file{bb.in},
2735 jump frequencies will be written to file @file{bb.out}.  The
2736 frequencies are obtained by constructing a trace of blocks
2737 and incrementing a counter for every neighbouring pair of blocks
2738 in the trace.  The trace 0 3 1 2 1 2 4 displays the following
2739 frequencies:
2740
2741 @example
2742 Jump from block 0x0 to block 0x3 executed 1 time(s)
2743 Jump from block 0x3 to block 0x1 executed 1 time(s)
2744 Jump from block 0x1 to block 0x2 executed 2 time(s)
2745 Jump from block 0x2 to block 0x1 executed 1 time(s)
2746 Jump from block 0x2 to block 0x4 executed 1 time(s)
2747 @end example
2748
2749 With @code{__bb_hidecall__}, control transfer due to call instructions
2750 is removed from the trace, that is the trace is cut into three parts: 0
2751 3 4, 0 1 2 and 0 1 2.  With @code{__bb_showret__}, control transfer due
2752 to return instructions is added to the trace.  The trace becomes: 0 3 1
2753 2 3 1 2 3 4.  Note, that this trace is not the same, as the sequence
2754 written to @file{bbtrace.gz}.  It is solely used for counting jump
2755 frequencies.
2756
2757 @item -fprofile-arcs
2758 @opindex fprofile-arcs
2759 Instrument @dfn{arcs} during compilation to generate coverage data
2760 or for profile-directed block ordering.  During execution the program
2761 records how many times each branch is executed and how many times it is
2762 taken.  When the compiled program exits it saves this data to a file
2763 called @file{@var{sourcename}.da} for each source file.
2764
2765 For profile-directed block ordering, compile the program with
2766 @option{-fprofile-arcs} plus optimization and code generation options,
2767 generate the arc profile information by running the program on a
2768 selected workload, and then compile the program again with the same
2769 optimization and code generation options plus
2770 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2771 Control Optimization}).
2772
2773 The other use of @option{-fprofile-arcs} is for use with @code{gcov},
2774 when it is used with the @option{-ftest-coverage} option.  GCC
2775 supports two methods of determining code coverage: the options that
2776 support @code{gcov}, and options @option{-a} and @option{-ax}, which
2777 write information to text files.  The options that support @code{gcov}
2778 do not need to instrument every arc in the program, so a program compiled
2779 with them runs faster than a program compiled with @option{-a}, which
2780 adds instrumentation code to every basic block in the program.  The
2781 tradeoff: since @code{gcov} does not have execution counts for all
2782 branches, it must start with the execution counts for the instrumented
2783 branches, and then iterate over the program flow graph until the entire
2784 graph has been solved.  Hence, @code{gcov} runs a little more slowly than
2785 a program which uses information from @option{-a} and @option{-ax}.
2786
2787 With @option{-fprofile-arcs}, for each function of your program GCC
2788 creates a program flow graph, then finds a spanning tree for the graph.
2789 Only arcs that are not on the spanning tree have to be instrumented: the
2790 compiler adds code to count the number of times that these arcs are
2791 executed.  When an arc is the only exit or only entrance to a block, the
2792 instrumentation code can be added to the block; otherwise, a new basic
2793 block must be created to hold the instrumentation code.
2794
2795 This option makes it possible to estimate branch probabilities and to
2796 calculate basic block execution counts.  In general, basic block
2797 execution counts as provided by @option{-a} do not give enough
2798 information to estimate all branch probabilities.
2799
2800 @need 2000
2801 @item -ftest-coverage
2802 @opindex ftest-coverage
2803 Create data files for the @code{gcov} code-coverage utility
2804 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
2805 The data file names begin with the name of your source file:
2806
2807 @table @gcctabopt
2808 @item @var{sourcename}.bb
2809 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2810 associate basic block execution counts with line numbers.
2811
2812 @item @var{sourcename}.bbg
2813 A list of all arcs in the program flow graph.  This allows @code{gcov}
2814 to reconstruct the program flow graph, so that it can compute all basic
2815 block and arc execution counts from the information in the
2816 @code{@var{sourcename}.da} file.
2817 @end table
2818
2819 Use @option{-ftest-coverage} with @option{-fprofile-arcs}; the latter
2820 option adds instrumentation to the program, which then writes
2821 execution counts to another data file:
2822
2823 @table @gcctabopt
2824 @item @var{sourcename}.da
2825 Runtime arc execution counts, used in conjunction with the arc
2826 information in the file @code{@var{sourcename}.bbg}.
2827 @end table
2828
2829 Coverage data will map better to the source files if
2830 @option{-ftest-coverage} is used without optimization.
2831
2832 @item -d@var{letters}
2833 @opindex d
2834 Says to make debugging dumps during compilation at times specified by
2835 @var{letters}.  This is used for debugging the compiler.  The file names
2836 for most of the dumps are made by appending a pass number and a word to
2837 the source file name (e.g.  @file{foo.c.00.rtl} or @file{foo.c.01.sibling}).
2838 Here are the possible letters for use in @var{letters}, and their meanings:
2839
2840 @table @samp
2841 @item A
2842 @opindex dA
2843 Annotate the assembler output with miscellaneous debugging information.
2844 @item b
2845 @opindex db
2846 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
2847 @item B
2848 @opindex dB
2849 Dump after block reordering, to @file{@var{file}.28.bbro}.
2850 @item c
2851 @opindex dc
2852 Dump after instruction combination, to the file @file{@var{file}.16.combine}.
2853 @item C
2854 @opindex dC
2855 Dump after the first if conversion, to the file @file{@var{file}.17.ce}.
2856 @item d
2857 @opindex dd
2858 Dump after delayed branch scheduling, to @file{@var{file}.31.dbr}.
2859 @item D
2860 @opindex dD
2861 Dump all macro definitions, at the end of preprocessing, in addition to
2862 normal output.
2863 @item e
2864 @opindex de
2865 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
2866 @file{@var{file}.07.ussa}.
2867 @item E
2868 @opindex dE
2869 Dump after the second if conversion, to @file{@var{file}.26.ce2}.
2870 @item f
2871 @opindex df
2872 Dump after life analysis, to @file{@var{file}.15.life}.
2873 @item F
2874 @opindex dF
2875 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.09.addressof}.
2876 @item g
2877 @opindex dg
2878 Dump after global register allocation, to @file{@var{file}.21.greg}.
2879 @item h
2880 @opindex dh
2881 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
2882 @item o
2883 @opindex do
2884 Dump after post-reload optimizations, to @file{@var{file}.22.postreload}.
2885 @item G
2886 @opindex dG
2887 Dump after GCSE, to @file{@var{file}.10.gcse}.
2888 @item i
2889 @opindex di
2890 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
2891 @item j
2892 @opindex dj
2893 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
2894 @item k
2895 @opindex dk
2896 Dump after conversion from registers to stack, to @file{@var{file}.32.stack}.
2897 @item l
2898 @opindex dl
2899 Dump after local register allocation, to @file{@var{file}.20.lreg}.
2900 @item L
2901 @opindex dL
2902 Dump after loop optimization, to @file{@var{file}.11.loop}.
2903 @item M
2904 @opindex dM
2905 Dump after performing the machine dependent reorganisation pass, to
2906 @file{@var{file}.30.mach}.
2907 @item n
2908 @opindex dn
2909 Dump after register renumbering, to @file{@var{file}.25.rnreg}.
2910 @item N
2911 @opindex dN
2912 Dump after the register move pass, to @file{@var{file}.18.regmove}.
2913 @item r
2914 @opindex dr
2915 Dump after RTL generation, to @file{@var{file}.00.rtl}.
2916 @item R
2917 @opindex dR
2918 Dump after the second scheduling pass, to @file{@var{file}.27.sched2}.
2919 @item s
2920 @opindex ds
2921 Dump after CSE (including the jump optimization that sometimes follows
2922 CSE), to @file{@var{file}.08.cse}.
2923 @item S
2924 @opindex dS
2925 Dump after the first scheduling pass, to @file{@var{file}.19.sched}.
2926 @item t
2927 @opindex dt
2928 Dump after the second CSE pass (including the jump optimization that
2929 sometimes follows CSE), to @file{@var{file}.12.cse2}.
2930 @item w
2931 @opindex dw
2932 Dump after the second flow pass, to @file{@var{file}.23.flow2}.
2933 @item X
2934 @opindex dX
2935 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
2936 @item z
2937 @opindex dz
2938 Dump after the peephole pass, to @file{@var{file}.24.peephole2}.
2939 @item a
2940 @opindex da
2941 Produce all the dumps listed above.
2942 @item m
2943 @opindex dm
2944 Print statistics on memory usage, at the end of the run, to
2945 standard error.
2946 @item p
2947 @opindex dp
2948 Annotate the assembler output with a comment indicating which
2949 pattern and alternative was used.  The length of each instruction is
2950 also printed.
2951 @item P
2952 @opindex dP
2953 Dump the RTL in the assembler output as a comment before each instruction.
2954 Also turns on @option{-dp} annotation.
2955 @item v
2956 @opindex dv
2957 For each of the other indicated dump files (except for
2958 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
2959 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
2960 @item x
2961 @opindex dx
2962 Just generate RTL for a function instead of compiling it.  Usually used
2963 with @samp{r}.
2964 @item y
2965 @opindex dy
2966 Dump debugging information during parsing, to standard error.
2967 @end table
2968
2969 @item -fdump-unnumbered
2970 @opindex fdump-unnumbered
2971 When doing debugging dumps (see @option{-d} option above), suppress instruction
2972 numbers and line number note output.  This makes it more feasible to
2973 use diff on debugging dumps for compiler invocations with different
2974 options, in particular with and without @option{-g}.
2975
2976 @item -fdump-translation-unit @r{(C and C++ only)}
2977 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
2978 @opindex fdump-translation-unit
2979 Dump a representation of the tree structure for the entire translation
2980 unit to a file.  The file name is made by appending @file{.tu} to the
2981 source file name.  If the @samp{-@var{options}} form is used, @var{options}
2982 controls the details of the dump as described for the
2983 @option{-fdump-tree} options.
2984
2985 @item -fdump-class-hierarchy @r{(C++ only)}
2986 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
2987 @opindex fdump-class-hierarchy
2988 Dump a representation of each class's hierarchy and virtual function
2989 table layout to a file.  The file name is made by appending @file{.class}
2990 to the source file name.  If the @samp{-@var{options}} form is used,
2991 @var{options} controls the details of the dump as described for the
2992 @option{-fdump-tree} options.
2993
2994 @item -fdump-tree-@var{switch} @r{(C++ only)}
2995 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
2996 @opindex fdump-tree
2997 Control the dumping at various stages of processing the intermediate
2998 language tree to a file.  The file name is generated by appending a switch
2999 specific suffix to the source file name.  If the @samp{-@var{options}}
3000 form is used, @var{options} is a list of @samp{-} separated options that
3001 control the details of the dump. Not all options are applicable to all
3002 dumps, those which are not meaningful will be ignored. The following
3003 options are available
3004
3005 @table @samp
3006 @item address
3007 Print the address of each node.  Usually this is not meaningful as it
3008 changes according to the environment and source file. Its primary use
3009 is for tying up a dump file with a debug environment.
3010 @item slim
3011 Inhibit dumping of members of a scope or body of a function merely
3012 because that scope has been reached. Only dump such items when they
3013 are directly reachable by some other path.
3014 @item all
3015 Turn on all options.
3016 @end table
3017
3018 The following tree dumps are possible:
3019 @table @samp
3020 @item original
3021 Dump before any tree based optimization, to @file{@var{file}.original}.
3022 @item optimized
3023 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3024 @item inlined
3025 Dump after function inlining, to @file{@var{file}.inlined}.
3026 @end table
3027
3028 @item -fpretend-float
3029 @opindex fpretend-float
3030 When running a cross-compiler, pretend that the target machine uses the
3031 same floating point format as the host machine.  This causes incorrect
3032 output of the actual floating constants, but the actual instruction
3033 sequence will probably be the same as GCC would make when running on
3034 the target machine.
3035
3036 @item -save-temps
3037 @opindex save-temps
3038 Store the usual ``temporary'' intermediate files permanently; place them
3039 in the current directory and name them based on the source file.  Thus,
3040 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3041 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3042 preprocessed @file{foo.i} output file even though the compiler now
3043 normally uses an integrated preprocessor.
3044
3045 @item -time
3046 @opindex time
3047 Report the CPU time taken by each subprocess in the compilation
3048 sequence.  For C source files, this is the compiler proper and assembler
3049 (plus the linker if linking is done).  The output looks like this:
3050
3051 @smallexample
3052 # cc1 0.12 0.01
3053 # as 0.00 0.01
3054 @end smallexample
3055
3056 The first number on each line is the ``user time,'' that is time spent
3057 executing the program itself.  The second number is ``system time,''
3058 time spent executing operating system routines on behalf of the program.
3059 Both numbers are in seconds.
3060
3061 @item -print-file-name=@var{library}
3062 @opindex print-file-name
3063 Print the full absolute name of the library file @var{library} that
3064 would be used when linking---and don't do anything else.  With this
3065 option, GCC does not compile or link anything; it just prints the
3066 file name.
3067
3068 @item -print-multi-directory
3069 @opindex print-multi-directory
3070 Print the directory name corresponding to the multilib selected by any
3071 other switches present in the command line.  This directory is supposed
3072 to exist in @env{GCC_EXEC_PREFIX}.
3073
3074 @item -print-multi-lib
3075 @opindex print-multi-lib
3076 Print the mapping from multilib directory names to compiler switches
3077 that enable them.  The directory name is separated from the switches by
3078 @samp{;}, and each switch starts with an @samp{@@} instead of the
3079 @samp{-}, without spaces between multiple switches.  This is supposed to
3080 ease shell-processing.
3081
3082 @item -print-prog-name=@var{program}
3083 @opindex print-prog-name
3084 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3085
3086 @item -print-libgcc-file-name
3087 @opindex print-libgcc-file-name
3088 Same as @option{-print-file-name=libgcc.a}.
3089
3090 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3091 but you do want to link with @file{libgcc.a}.  You can do
3092
3093 @example
3094 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3095 @end example
3096
3097 @item -print-search-dirs
3098 @opindex print-search-dirs
3099 Print the name of the configured installation directory and a list of
3100 program and library directories gcc will search---and don't do anything else.
3101
3102 This is useful when gcc prints the error message
3103 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3104 To resolve this you either need to put @file{cpp0} and the other compiler
3105 components where gcc expects to find them, or you can set the environment
3106 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3107 Don't forget the trailing '/'.
3108 @xref{Environment Variables}.
3109
3110 @item -dumpmachine
3111 @opindex dumpmachine
3112 Print the compiler's target machine (for example,
3113 @samp{i686-pc-linux-gnu})---and don't do anything else.
3114
3115 @item -dumpversion
3116 @opindex dumpversion
3117 Print the compiler version (for example, @samp{3.0})---and don't do
3118 anything else.
3119
3120 @item -dumpspecs
3121 @opindex dumpspecs
3122 Print the compiler's built-in specs---and don't do anything else.  (This
3123 is used when GCC itself is being built.)  @xref{Spec Files}.
3124 @end table
3125
3126 @node Optimize Options
3127 @section Options That Control Optimization
3128 @cindex optimize options
3129 @cindex options, optimization
3130
3131 These options control various sorts of optimizations:
3132
3133 @table @gcctabopt
3134 @item -O
3135 @itemx -O1
3136 @opindex O
3137 @opindex O1
3138 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3139 more memory for a large function.
3140
3141 Without @option{-O}, the compiler's goal is to reduce the cost of
3142 compilation and to make debugging produce the expected results.
3143 Statements are independent: if you stop the program with a breakpoint
3144 between statements, you can then assign a new value to any variable or
3145 change the program counter to any other statement in the function and
3146 get exactly the results you would expect from the source code.
3147
3148 With @option{-O}, the compiler tries to reduce code size and execution
3149 time, without performing any optimizations that take a great deal of
3150 compilation time.
3151
3152 @item -O2
3153 @opindex O2
3154 Optimize even more.  GCC performs nearly all supported optimizations
3155 that do not involve a space-speed tradeoff.  The compiler does not
3156 perform loop unrolling or function inlining when you specify @option{-O2}.
3157 As compared to @option{-O}, this option increases both compilation time
3158 and the performance of the generated code.
3159
3160 @option{-O2} turns on all optional optimizations except for loop unrolling,
3161 function inlining, and register renaming.  It also turns on the
3162 @option{-fforce-mem} option on all machines and frame pointer elimination
3163 on machines where doing so does not interfere with debugging.
3164
3165 Please note the warning under @option{-fgcse} about
3166 invoking @option{-O2} on programs that use computed gotos.
3167
3168 @item -O3
3169 @opindex O3
3170 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3171 @option{-O2} and also turns on the @option{-finline-functions} and
3172 @option{-frename-registers} options.
3173
3174 @item -O0
3175 @opindex O0
3176 Do not optimize.
3177
3178 @item -Os
3179 @opindex Os
3180 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3181 do not typically increase code size.  It also performs further
3182 optimizations designed to reduce code size.
3183
3184 If you use multiple @option{-O} options, with or without level numbers,
3185 the last such option is the one that is effective.
3186 @end table
3187
3188 Options of the form @option{-f@var{flag}} specify machine-independent
3189 flags.  Most flags have both positive and negative forms; the negative
3190 form of @option{-ffoo} would be @option{-fno-foo}.  In the table below,
3191 only one of the forms is listed---the one which is not the default.
3192 You can figure out the other form by either removing @samp{no-} or
3193 adding it.
3194
3195 @table @gcctabopt
3196 @item -ffloat-store
3197 @opindex ffloat-store
3198 Do not store floating point variables in registers, and inhibit other
3199 options that might change whether a floating point value is taken from a
3200 register or memory.
3201
3202 @cindex floating point precision
3203 This option prevents undesirable excess precision on machines such as
3204 the 68000 where the floating registers (of the 68881) keep more
3205 precision than a @code{double} is supposed to have.  Similarly for the
3206 x86 architecture.  For most programs, the excess precision does only
3207 good, but a few programs rely on the precise definition of IEEE floating
3208 point.  Use @option{-ffloat-store} for such programs, after modifying
3209 them to store all pertinent intermediate computations into variables.
3210
3211 @item -fno-default-inline
3212 @opindex fno-default-inline
3213 Do not make member functions inline by default merely because they are
3214 defined inside the class scope (C++ only).  Otherwise, when you specify
3215 @w{@option{-O}}, member functions defined inside class scope are compiled
3216 inline by default; i.e., you don't need to add @samp{inline} in front of
3217 the member function name.
3218
3219 @item -fno-defer-pop
3220 @opindex fno-defer-pop
3221 Always pop the arguments to each function call as soon as that function
3222 returns.  For machines which must pop arguments after a function call,
3223 the compiler normally lets arguments accumulate on the stack for several
3224 function calls and pops them all at once.
3225
3226 @item -fforce-mem
3227 @opindex fforce-mem
3228 Force memory operands to be copied into registers before doing
3229 arithmetic on them.  This produces better code by making all memory
3230 references potential common subexpressions.  When they are not common
3231 subexpressions, instruction combination should eliminate the separate
3232 register-load.  The @option{-O2} option turns on this option.
3233
3234 @item -fforce-addr
3235 @opindex fforce-addr
3236 Force memory address constants to be copied into registers before
3237 doing arithmetic on them.  This may produce better code just as
3238 @option{-fforce-mem} may.
3239
3240 @item -fomit-frame-pointer
3241 @opindex fomit-frame-pointer
3242 Don't keep the frame pointer in a register for functions that
3243 don't need one.  This avoids the instructions to save, set up and
3244 restore frame pointers; it also makes an extra register available
3245 in many functions.  @strong{It also makes debugging impossible on
3246 some machines.}
3247
3248 @ifset INTERNALS
3249 On some machines, such as the VAX, this flag has no effect, because
3250 the standard calling sequence automatically handles the frame pointer
3251 and nothing is saved by pretending it doesn't exist.  The
3252 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3253 whether a target machine supports this flag.  @xref{Registers}.
3254 @end ifset
3255 @ifclear INTERNALS
3256 On some machines, such as the VAX, this flag has no effect, because
3257 the standard calling sequence automatically handles the frame pointer
3258 and nothing is saved by pretending it doesn't exist.  The
3259 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3260 whether a target machine supports this flag.  @xref{Registers,,Register
3261 Usage, gcc.info, Using and Porting GCC}.
3262 @end ifclear
3263
3264 @item -foptimize-sibling-calls
3265 @opindex foptimize-sibling-calls
3266 Optimize sibling and tail recursive calls.
3267
3268 @item -ftrapv
3269 @opindex ftrapv
3270 This option generates traps for signed overflow on addition, subtraction,
3271 multiplication operations.
3272
3273 @item -fno-inline
3274 @opindex fno-inline
3275 Don't pay attention to the @code{inline} keyword.  Normally this option
3276 is used to keep the compiler from expanding any functions inline.
3277 Note that if you are not optimizing, no functions can be expanded inline.
3278
3279 @item -finline-functions
3280 @opindex finline-functions
3281 Integrate all simple functions into their callers.  The compiler
3282 heuristically decides which functions are simple enough to be worth
3283 integrating in this way.
3284
3285 If all calls to a given function are integrated, and the function is
3286 declared @code{static}, then the function is normally not output as
3287 assembler code in its own right.
3288
3289 @item -finline-limit=@var{n}
3290 @opindex finline-limit
3291 By default, gcc limits the size of functions that can be inlined.  This flag
3292 allows the control of this limit for functions that are explicitly marked as
3293 inline (ie marked with the inline keyword or defined within the class
3294 definition in c++).  @var{n} is the size of functions that can be inlined in
3295 number of pseudo instructions (not counting parameter handling).  The default
3296 value of @var{n} is 600.
3297 Increasing this value can result in more inlined code at
3298 the cost of compilation time and memory consumption.  Decreasing usually makes
3299 the compilation faster and less code will be inlined (which presumably
3300 means slower programs).  This option is particularly useful for programs that
3301 use inlining heavily such as those based on recursive templates with C++.
3302
3303 @emph{Note:} pseudo instruction represents, in this particular context, an
3304 abstract measurement of function's size.  In no way, it represents a count
3305 of assembly instructions and as such its exact meaning might change from one
3306 release to an another.
3307
3308 @item -fkeep-inline-functions
3309 @opindex fkeep-inline-functions
3310 Even if all calls to a given function are integrated, and the function
3311 is declared @code{static}, nevertheless output a separate run-time
3312 callable version of the function.  This switch does not affect
3313 @code{extern inline} functions.
3314
3315 @item -fkeep-static-consts
3316 @opindex fkeep-static-consts
3317 Emit variables declared @code{static const} when optimization isn't turned
3318 on, even if the variables aren't referenced.
3319
3320 GCC enables this option by default.  If you want to force the compiler to
3321 check if the variable was referenced, regardless of whether or not
3322 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3323
3324 @item -fno-function-cse
3325 @opindex fno-function-cse
3326 Do not put function addresses in registers; make each instruction that
3327 calls a constant function contain the function's address explicitly.
3328
3329 This option results in less efficient code, but some strange hacks
3330 that alter the assembler output may be confused by the optimizations
3331 performed when this option is not used.
3332
3333 @item -ffast-math
3334 @opindex ffast-math
3335 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, and @*
3336 @option{-fno-trapping-math}.
3337
3338 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
3339
3340 This option should never be turned on by any @option{-O} option since
3341 it can result in incorrect output for programs which depend on
3342 an exact implementation of IEEE or ISO rules/specifications for
3343 math functions.
3344
3345 @item -fno-math-errno
3346 @opindex fno-math-errno
3347 Do not set ERRNO after calling math functions that are executed
3348 with a single instruction, e.g., sqrt.  A program that relies on
3349 IEEE exceptions for math error handling may want to use this flag
3350 for speed while maintaining IEEE arithmetic compatibility.
3351
3352 This option should never be turned on by any @option{-O} option since
3353 it can result in incorrect output for programs which depend on
3354 an exact implementation of IEEE or ISO rules/specifications for
3355 math functions.
3356
3357 The default is @option{-fmath-errno}.
3358
3359 @item -funsafe-math-optimizations
3360 @opindex funsafe-math-optimizations
3361 Allow optimizations for floating-point arithmetic that (a) assume
3362 that arguments and results are valid and (b) may violate IEEE or
3363 ANSI standards.  When used at link-time, it may include libraries
3364 or startup files that change the default FPU control word or other
3365 similar optimizations.
3366
3367 This option should never be turned on by any @option{-O} option since
3368 it can result in incorrect output for programs which depend on
3369 an exact implementation of IEEE or ISO rules/specifications for
3370 math functions.
3371
3372 The default is @option{-fno-unsafe-math-optimizations}.
3373
3374 @item -fno-trapping-math
3375 @opindex fno-trapping-math
3376 Compile code assuming that floating-point operations cannot generate
3377 user-visible traps.  Setting this option may allow faster code
3378 if one relies on ``non-stop'' IEEE arithmetic, for example.
3379
3380 This option should never be turned on by any @option{-O} option since
3381 it can result in incorrect output for programs which depend on
3382 an exact implementation of IEEE or ISO rules/specifications for
3383 math functions.
3384
3385 The default is @option{-ftrapping-math}.
3386 @end table
3387
3388 The following options control specific optimizations.  The @option{-O2}
3389 option turns on all of these optimizations except @option{-funroll-loops}
3390 and @option{-funroll-all-loops}.  On most machines, the @option{-O} option
3391 turns on the @option{-fthread-jumps} and @option{-fdelayed-branch} options,
3392 but specific machines may handle it differently.
3393
3394 You can use the following flags in the rare cases when ``fine-tuning''
3395 of optimizations to be performed is desired.
3396
3397 Not all of the optimizations performed by GCC have @option{-f} options
3398 to control them.
3399
3400 @table @gcctabopt
3401 @item -fstrength-reduce
3402 @opindex fstrength-reduce
3403 Perform the optimizations of loop strength reduction and
3404 elimination of iteration variables.
3405
3406 @item -fthread-jumps
3407 @opindex fthread-jumps
3408 Perform optimizations where we check to see if a jump branches to a
3409 location where another comparison subsumed by the first is found.  If
3410 so, the first branch is redirected to either the destination of the
3411 second branch or a point immediately following it, depending on whether
3412 the condition is known to be true or false.
3413
3414 @item -fcse-follow-jumps
3415 @opindex fcse-follow-jumps
3416 In common subexpression elimination, scan through jump instructions
3417 when the target of the jump is not reached by any other path.  For
3418 example, when CSE encounters an @code{if} statement with an
3419 @code{else} clause, CSE will follow the jump when the condition
3420 tested is false.
3421
3422 @item -fcse-skip-blocks
3423 @opindex fcse-skip-blocks
3424 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3425 follow jumps which conditionally skip over blocks.  When CSE
3426 encounters a simple @code{if} statement with no else clause,
3427 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3428 body of the @code{if}.
3429
3430 @item -frerun-cse-after-loop
3431 @opindex frerun-cse-after-loop
3432 Re-run common subexpression elimination after loop optimizations has been
3433 performed.
3434
3435 @item -frerun-loop-opt
3436 @opindex frerun-loop-opt
3437 Run the loop optimizer twice.
3438
3439 @item -fgcse
3440 @opindex fgcse
3441 Perform a global common subexpression elimination pass.
3442 This pass also performs global constant and copy propagation.
3443
3444 @emph{Note:} When compiling a program using computed gotos, a GCC
3445 extension, you may get better runtime performance if you disable
3446 the global common subexpression elmination pass by adding
3447 @option{-fno-gcse} to the command line.
3448
3449 @item -fgcse-lm
3450 @opindex fgcse-lm
3451 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3452 attempt to move loads which are only killed by stores into themselves.  This
3453 allows a loop containing a load/store sequence to be changed to a load outside
3454 the loop, and a copy/store within the loop.
3455
3456 @item -fgcse-sm
3457 @opindex fgcse-sm
3458 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3459 subexpression elimination.  This pass will attempt to move stores out of loops.
3460 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3461 can be changed to a load before the loop and a store after the loop.
3462
3463 @item -fdelete-null-pointer-checks
3464 @opindex fdelete-null-pointer-checks
3465 Use global dataflow analysis to identify and eliminate useless checks
3466 for null pointers.  The compiler assumes that dereferencing a null
3467 pointer would have halted the program.  If a pointer is checked after
3468 it has already been dereferenced, it cannot be null.
3469
3470 In some environments, this assumption is not true, and programs can
3471 safely dereference null pointers.  Use
3472 @option{-fno-delete-null-pointer-checks} to disable this optimization
3473 for programs which depend on that behavior.
3474
3475 @item -fexpensive-optimizations
3476 @opindex fexpensive-optimizations
3477 Perform a number of minor optimizations that are relatively expensive.
3478
3479 @item -foptimize-register-move
3480 @itemx -fregmove
3481 @opindex foptimize-register-move
3482 @opindex fregmove
3483 Attempt to reassign register numbers in move instructions and as
3484 operands of other simple instructions in order to maximize the amount of
3485 register tying.  This is especially helpful on machines with two-operand
3486 instructions.  GCC enables this optimization by default with @option{-O2}
3487 or higher.
3488
3489 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3490 optimization.
3491
3492 @item -fdelayed-branch
3493 @opindex fdelayed-branch
3494 If supported for the target machine, attempt to reorder instructions
3495 to exploit instruction slots available after delayed branch
3496 instructions.
3497
3498 @item -fschedule-insns
3499 @opindex fschedule-insns
3500 If supported for the target machine, attempt to reorder instructions to
3501 eliminate execution stalls due to required data being unavailable.  This
3502 helps machines that have slow floating point or memory load instructions
3503 by allowing other instructions to be issued until the result of the load
3504 or floating point instruction is required.
3505
3506 @item -fschedule-insns2
3507 @opindex fschedule-insns2
3508 Similar to @option{-fschedule-insns}, but requests an additional pass of
3509 instruction scheduling after register allocation has been done.  This is
3510 especially useful on machines with a relatively small number of
3511 registers and where memory load instructions take more than one cycle.
3512
3513 @item -ffunction-sections
3514 @itemx -fdata-sections
3515 @opindex ffunction-sections
3516 @opindex fdata-sections
3517 Place each function or data item into its own section in the output
3518 file if the target supports arbitrary sections.  The name of the
3519 function or the name of the data item determines the section's name
3520 in the output file.
3521
3522 Use these options on systems where the linker can perform optimizations
3523 to improve locality of reference in the instruction space.  HPPA
3524 processors running HP-UX and Sparc processors running Solaris 2 have
3525 linkers with such optimizations.  Other systems using the ELF object format
3526 as well as AIX may have these optimizations in the future.
3527
3528 Only use these options when there are significant benefits from doing
3529 so.  When you specify these options, the assembler and linker will
3530 create larger object and executable files and will also be slower.
3531 You will not be able to use @code{gprof} on all systems if you
3532 specify this option and you may have problems with debugging if
3533 you specify both this option and @option{-g}.
3534
3535 @item -fcaller-saves
3536 @opindex fcaller-saves
3537 Enable values to be allocated in registers that will be clobbered by
3538 function calls, by emitting extra instructions to save and restore the
3539 registers around such calls.  Such allocation is done only when it
3540 seems to result in better code than would otherwise be produced.
3541
3542 This option is always enabled by default on certain machines, usually
3543 those which have no call-preserved registers to use instead.
3544
3545 For all machines, optimization level 2 and higher enables this flag by
3546 default.
3547
3548 @item -funroll-loops
3549 @opindex funroll-loops
3550 Unroll loops whose number of iterations can be determined at compile
3551 time or upon entry to the loop.  @option{-funroll-loops} implies both
3552 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
3553 option makes code larger, and may or may not make it run faster.
3554
3555 @item -funroll-all-loops
3556 @opindex funroll-all-loops
3557 Unroll all loops, even if their number of iterations is uncertain when
3558 the loop is entered.  This usually makes programs run more slowly.
3559 @option{-funroll-all-loops} implies the same options as
3560 @option{-funroll-loops},
3561
3562
3563 @item -fmove-all-movables
3564 @opindex fmove-all-movables
3565 Forces all invariant computations in loops to be moved
3566 outside the loop.
3567
3568 @item -freduce-all-givs
3569 @opindex freduce-all-givs
3570 Forces all general-induction variables in loops to be
3571 strength-reduced.
3572
3573 @emph{Note:} When compiling programs written in Fortran,
3574 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3575 by default when you use the optimizer.
3576
3577 These options may generate better or worse code; results are highly
3578 dependent on the structure of loops within the source code.
3579
3580 These two options are intended to be removed someday, once
3581 they have helped determine the efficacy of various
3582 approaches to improving loop optimizations.
3583
3584 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3585 know how use of these options affects
3586 the performance of your production code.
3587 We're very interested in code that runs @emph{slower}
3588 when these options are @emph{enabled}.
3589
3590 @item -fno-peephole
3591 @itemx -fno-peephole2
3592 @opindex fno-peephole
3593 @opindex fno-peephole2
3594 Disable any machine-specific peephole optimizations.  The difference
3595 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3596 are implemented in the compiler; some targets use one, some use the
3597 other, a few use both.
3598
3599 @item -fbranch-probabilities
3600 @opindex fbranch-probabilities
3601 After running a program compiled with @option{-fprofile-arcs}
3602 (@pxref{Debugging Options,, Options for Debugging Your Program or
3603 @command{gcc}}), you can compile it a second time using
3604 @option{-fbranch-probabilities}, to improve optimizations based on
3605 the number of times each branch was taken.  When the program
3606 compiled with @option{-fprofile-arcs} exits it saves arc execution
3607 counts to a file called @file{@var{sourcename}.da} for each source
3608 file  The information in this data file is very dependent on the
3609 structure of the generated code, so you must use the same source code
3610 and the same optimization options for both compilations.
3611
3612 @ifset INTERNALS
3613 With @option{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
3614 note on the first instruction of each basic block, and a
3615 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3616 These can be used to improve optimization.  Currently, they are only
3617 used in one place: in @file{reorg.c}, instead of guessing which path a
3618 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3619 exactly determine which path is taken more often.
3620 @end ifset
3621
3622 @item -fno-guess-branch-probability
3623 @opindex fno-guess-branch-probability
3624 Do not guess branch probabilities using a randomized model.
3625
3626 Sometimes gcc will opt to use a randomized model to guess branch
3627 probabilities, when none are available from either profiling feedback
3628 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
3629 different runs of the compiler on the same program may produce different
3630 object code.
3631
3632 In a hard real-time system, people don't want different runs of the
3633 compiler to produce code that has different behavior; minimizing
3634 non-determinism is of paramount import.  This switch allows users to
3635 reduce non-determinism, possibly at the expense of inferior
3636 optimization.
3637
3638 @item -fstrict-aliasing
3639 @opindex fstrict-aliasing
3640 Allows the compiler to assume the strictest aliasing rules applicable to
3641 the language being compiled.  For C (and C++), this activates
3642 optimizations based on the type of expressions.  In particular, an
3643 object of one type is assumed never to reside at the same address as an
3644 object of a different type, unless the types are almost the same.  For
3645 example, an @code{unsigned int} can alias an @code{int}, but not a
3646 @code{void*} or a @code{double}.  A character type may alias any other
3647 type.
3648
3649 Pay special attention to code like this:
3650 @example
3651 union a_union @{
3652   int i;
3653   double d;
3654 @};
3655
3656 int f() @{
3657   a_union t;
3658   t.d = 3.0;
3659   return t.i;
3660 @}
3661 @end example
3662 The practice of reading from a different union member than the one most
3663 recently written to (called ``type-punning'') is common.  Even with
3664 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
3665 is accessed through the union type.  So, the code above will work as
3666 expected.  However, this code might not:
3667 @example
3668 int f() @{
3669   a_union t;
3670   int* ip;
3671   t.d = 3.0;
3672   ip = &t.i;
3673   return *ip;
3674 @}
3675 @end example
3676
3677 @ifset INTERNALS
3678 Every language that wishes to perform language-specific alias analysis
3679 should define a function that computes, given an @code{tree}
3680 node, an alias set for the node.  Nodes in different alias sets are not
3681 allowed to alias.  For an example, see the C front-end function
3682 @code{c_get_alias_set}.
3683 @end ifset
3684
3685 @item -falign-functions
3686 @itemx -falign-functions=@var{n}
3687 @opindex falign-functions
3688 Align the start of functions to the next power-of-two greater than
3689 @var{n}, skipping up to @var{n} bytes.  For instance,
3690 @option{-falign-functions=32} aligns functions to the next 32-byte
3691 boundary, but @option{-falign-functions=24} would align to the next
3692 32-byte boundary only if this can be done by skipping 23 bytes or less.
3693
3694 @option{-fno-align-functions} and @option{-falign-functions=1} are
3695 equivalent and mean that functions will not be aligned.
3696
3697 Some assemblers only support this flag when @var{n} is a power of two;
3698 in that case, it is rounded up.
3699
3700 If @var{n} is not specified, use a machine-dependent default.
3701
3702 @item -falign-labels
3703 @itemx -falign-labels=@var{n}
3704 @opindex falign-labels
3705 Align all branch targets to a power-of-two boundary, skipping up to
3706 @var{n} bytes like @option{-falign-functions}.  This option can easily
3707 make code slower, because it must insert dummy operations for when the
3708 branch target is reached in the usual flow of the code.
3709
3710 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
3711 are greater than this value, then their values are used instead.
3712
3713 If @var{n} is not specified, use a machine-dependent default which is
3714 very likely to be @samp{1}, meaning no alignment.
3715
3716 @item -falign-loops
3717 @itemx -falign-loops=@var{n}
3718 @opindex falign-loops
3719 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
3720 like @option{-falign-functions}.  The hope is that the loop will be
3721 executed many times, which will make up for any execution of the dummy
3722 operations.
3723
3724 If @var{n} is not specified, use a machine-dependent default.
3725
3726 @item -falign-jumps
3727 @itemx -falign-jumps=@var{n}
3728 @opindex falign-jumps
3729 Align branch targets to a power-of-two boundary, for branch targets
3730 where the targets can only be reached by jumping, skipping up to @var{n}
3731 bytes like @option{-falign-functions}.  In this case, no dummy operations
3732 need be executed.
3733
3734 If @var{n} is not specified, use a machine-dependent default.
3735
3736 @item -fssa
3737 @opindex fssa
3738 Perform optimizations in static single assignment form.  Each function's
3739 flow graph is translated into SSA form, optimizations are performed, and
3740 the flow graph is translated back from SSA form.  Users should not
3741 specify this option, since it is not yet ready for production use.
3742
3743 @item -fssa-ccp
3744 @opindex fssa-ccp
3745 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
3746 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
3747
3748 @item -fssa-dce
3749 @opindex fssa-dce
3750 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
3751 Like @option{-fssa}, this is an experimental feature.
3752
3753 @item -fsingle-precision-constant
3754 @opindex fsingle-precision-constant
3755 Treat floating point constant as single precision constant instead of
3756 implicitly converting it to double precision constant.
3757
3758 @item -frename-registers
3759 @opindex frename-registers
3760 Attempt to avoid false dependencies in scheduled code by making use
3761 of registers left over after register allocation.  This optimization
3762 will most benefit processors with lots of registers.  It can, however,
3763 make debugging impossible, since variables will no longer stay in
3764 a ``home register''.
3765
3766 @item --param @var{name}=@var{value}
3767 @opindex param
3768 In some places, GCC uses various constants to control the amount of
3769 optimization that is done.  For example, GCC will not inline functions
3770 that contain more that a certain number of instructions.  You can
3771 control some of these constants on the command-line using the
3772 @option{--param} option.
3773
3774 In each case, the @var{value} is a integer.  The allowable choices for
3775 @var{name} are given in the following table:
3776
3777 @table @gcctabopt
3778 @item max-delay-slot-insn-search
3779 The maximum number of instructions to consider when looking for an
3780 instruction to fill a delay slot.  If more than this arbitrary number of
3781 instructions is searched, the time savings from filling the delay slot
3782 will be minimal so stop searching.  Increasing values mean more
3783 aggressive optimization, making the compile time increase with probably
3784 small improvement in executable run time.
3785
3786 @item max-delay-slot-live-search
3787 When trying to fill delay slots, the maximum number of instructions to
3788 consider when searching for a block with valid live register
3789 information.  Increasing this arbitrarily chosen value means more
3790 aggressive optimization, increasing the compile time.  This parameter
3791 should be removed when the delay slot code is rewritten to maintain the
3792 control-flow graph.
3793
3794 @item max-gcse-memory
3795 The approximate maximum amount of memory that will be allocated in
3796 order to perform the global common subexpression elimination
3797 optimization.  If more memory than specified is required, the
3798 optimization will not be done.
3799
3800 @item max-gcse-passes
3801 The maximum number of passes of GCSE to run.
3802
3803 @item max-pending-list-length
3804 The maximum number of pending dependancies scheduling will allow
3805 before flushing the current state and starting over.  Large functions
3806 with few branches or calls can create excessively large lists which
3807 needlessly consume memory and resources.
3808
3809 @item max-inline-insns
3810 If an function contains more than this many instructions, it
3811 will not be inlined.  This option is precisely equivalent to
3812 @option{-finline-limit}.
3813
3814 @end table
3815 @end table
3816
3817 @node Preprocessor Options
3818 @section Options Controlling the Preprocessor
3819 @cindex preprocessor options
3820 @cindex options, preprocessor
3821
3822 These options control the C preprocessor, which is run on each C source
3823 file before actual compilation.
3824
3825 If you use the @option{-E} option, nothing is done except preprocessing.
3826 Some of these options make sense only together with @option{-E} because
3827 they cause the preprocessor output to be unsuitable for actual
3828 compilation.
3829
3830 @table @gcctabopt
3831 @item -include @var{file}
3832 @opindex include
3833 Process @var{file} as input before processing the regular input file.
3834 In effect, the contents of @var{file} are compiled first.  Any @option{-D}
3835 and @option{-U} options on the command line are always processed before
3836 @option{-include @var{file}}, regardless of the order in which they are
3837 written.  All the @option{-include} and @option{-imacros} options are
3838 processed in the order in which they are written.
3839
3840 @item -imacros @var{file}
3841 @opindex imacros
3842 Process @var{file} as input, discarding the resulting output, before
3843 processing the regular input file.  Because the output generated from
3844 @var{file} is discarded, the only effect of @option{-imacros @var{file}}
3845 is to make the macros defined in @var{file} available for use in the
3846 main input.  All the @option{-include} and @option{-imacros} options are
3847 processed in the order in which they are written.
3848
3849 @item -idirafter @var{dir}
3850 @opindex idirafter
3851 @cindex second include path
3852 Add the directory @var{dir} to the second include path.  The directories
3853 on the second include path are searched when a header file is not found
3854 in any of the directories in the main include path (the one that
3855 @option{-I} adds to).
3856
3857 @item -iprefix @var{prefix}
3858 @opindex iprefix
3859 Specify @var{prefix} as the prefix for subsequent @option{-iwithprefix}
3860 options.
3861
3862 @item -iwithprefix @var{dir}
3863 @opindex iwithprefix
3864 Add a directory to the second include path.  The directory's name is
3865 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
3866 specified previously with @option{-iprefix}.  If you have not specified a
3867 prefix yet, the directory containing the installed passes of the
3868 compiler is used as the default.
3869
3870 @item -iwithprefixbefore @var{dir}
3871 @opindex iwithprefixbefore
3872 Add a directory to the main include path.  The directory's name is made
3873 by concatenating @var{prefix} and @var{dir}, as in the case of
3874 @option{-iwithprefix}.
3875
3876 @item -isystem @var{dir}
3877 @opindex isystem
3878 Add a directory to the beginning of the second include path, marking it
3879 as a system directory, so that it gets the same special treatment as
3880 is applied to the standard system directories.
3881
3882 @item -nostdinc
3883 @opindex nostdinc
3884 Do not search the standard system directories for header files.  Only
3885 the directories you have specified with @option{-I} options (and the
3886 current directory, if appropriate) are searched.  @xref{Directory
3887 Options}, for information on @option{-I}.
3888
3889 By using both @option{-nostdinc} and @option{-I-}, you can limit the include-file
3890 search path to only those directories you specify explicitly.
3891
3892 @item -remap
3893 @opindex remap
3894 When searching for a header file in a directory, remap file names if a
3895 file named @file{header.gcc} exists in that directory.  This can be used
3896 to work around limitations of file systems with file name restrictions.
3897 The @file{header.gcc} file should contain a series of lines with two
3898 tokens on each line: the first token is the name to map, and the second
3899 token is the actual name to use.
3900
3901 @item -undef
3902 @opindex undef
3903 Do not predefine any nonstandard macros.  (Including architecture flags).
3904
3905 @item -E
3906 @opindex E
3907 Run only the C preprocessor.  Preprocess all the C source files
3908 specified and output the results to standard output or to the
3909 specified output file.
3910
3911 @item -C
3912 @opindex C
3913 Tell the preprocessor not to discard comments.  Used with the
3914 @option{-E} option.
3915
3916 @item -P
3917 @opindex P
3918 Tell the preprocessor not to generate @samp{#line} directives.
3919 Used with the @option{-E} option.
3920
3921 @cindex make
3922 @cindex dependencies, make
3923 @item -M
3924 @opindex M
3925 Instead of outputting the result of preprocessing, output a rule
3926 suitable for @code{make} describing the dependencies of the main source
3927 file.  The preprocessor outputs one @code{make} rule containing the
3928 object file name for that source file, a colon, and the names of all the
3929 included files.  Unless overridden explicitly, the object file name
3930 consists of the basename of the source file with any suffix replaced with
3931 object file suffix.  If there are many included files then the
3932 rule is split into several lines using @samp{\}-newline.
3933
3934 @option{-M} implies @option{-E}.
3935
3936 @item -MM
3937 @opindex MM
3938 Like @option{-M}, but mention only the files included with @samp{#include
3939 "@var{file}"}.  System header files included with @samp{#include
3940 <@var{file}>} are omitted.
3941
3942 @item -MD
3943 @opindex MD
3944 Like @option{-M} but the dependency information is written to a file
3945 rather than stdout.  @code{gcc} will use the same file name and
3946 directory as the object file, but with the suffix @file{.d} instead.
3947
3948 This is in addition to compiling the main file as specified---@option{-MD}
3949 does not inhibit ordinary compilation the way @option{-M} does,
3950 unless you also specify @option{-MG}.
3951
3952 With Mach, you can use the utility @code{md} to merge multiple
3953 dependency files into a single dependency file suitable for using with
3954 the @samp{make} command.
3955
3956 @item -MMD
3957 @opindex MMD
3958 Like @option{-MD} except mention only user header files, not system
3959 -header files.
3960
3961 @item -MF @var{file}
3962 @opindex MF
3963 When used with @option{-M} or @option{-MM}, specifies a file to write the
3964 dependencies to.  This allows the preprocessor to write the preprocessed
3965 file to stdout normally.  If no @option{-MF} switch is given, CPP sends
3966 the rules to stdout and suppresses normal preprocessed output.
3967
3968 Another way to specify output of a @code{make} rule is by setting
3969 the environment variable @env{DEPENDENCIES_OUTPUT} (@pxref{Environment
3970 Variables}).
3971
3972 @item -MG
3973 @opindex MG
3974 When used with @option{-M} or @option{-MM}, @option{-MG} says to treat missing
3975 header files as generated files and assume they live in the same
3976 directory as the source file.  It suppresses preprocessed output, as a
3977 missing header file is ordinarily an error.
3978
3979 This feature is used in automatic updating of makefiles.
3980
3981 @item -MP
3982 @opindex MP
3983 This option instructs CPP to add a phony target for each dependency
3984 other than the main file, causing each to depend on nothing.  These
3985 dummy rules work around errors @code{make} gives if you remove header
3986 files without updating the @code{Makefile} to match.
3987
3988 This is typical output:-
3989
3990 @smallexample
3991 /tmp/test.o: /tmp/test.c /tmp/test.h
3992
3993 /tmp/test.h:
3994 @end smallexample
3995
3996 @item -MQ @var{target}
3997 @item -MT @var{target}
3998 @opindex MQ
3999 @opindex MT
4000 By default CPP uses the main file name, including any path, and appends
4001 the object suffix, normally ``.o'', to it to obtain the name of the
4002 target for dependency generation.  With @option{-MT} you can specify a
4003 target yourself, overriding the default one.
4004
4005 If you want multiple targets, you can specify them as a single argument
4006 to @option{-MT}, or use multiple @option{-MT} options.
4007
4008 The targets you specify are output in the order they appear on the
4009 command line.  @option{-MQ} is identical to @option{-MT}, except that the
4010 target name is quoted for Make, but with @option{-MT} it isn't.  For
4011 example, @option{-MT '$(objpfx)foo.o'} gives
4012
4013 @smallexample
4014 $(objpfx)foo.o: /tmp/foo.c
4015 @end smallexample
4016
4017 but @option{-MQ '$(objpfx)foo.o'} gives
4018
4019 @smallexample
4020 $$(objpfx)foo.o: /tmp/foo.c
4021 @end smallexample
4022
4023 The default target is automatically quoted, as if it were given with
4024 @option{-MQ}.
4025
4026 @item -H
4027 @opindex H
4028 Print the name of each header file used, in addition to other normal
4029 activities.
4030
4031 @item -A@var{question}(@var{answer})
4032 @opindex A
4033 Assert the answer @var{answer} for @var{question}, in case it is tested
4034 with a preprocessing conditional such as @samp{#if
4035 #@var{question}(@var{answer})}.  @option{-A-} disables the standard
4036 assertions that normally describe the target machine.
4037
4038 @item -D@var{macro}
4039 @opindex D
4040 Define macro @var{macro} with the string @samp{1} as its definition.
4041
4042 @item -D@var{macro}=@var{defn}
4043 Define macro @var{macro} as @var{defn}.  All instances of @option{-D} on
4044 the command line are processed before any @option{-U} options.
4045
4046 Any @option{-D} and @option{-U} options on the command line are processed in
4047 order, and always before @option{-imacros @var{file}}, regardless of the
4048 order in which they are written.
4049
4050 @item -U@var{macro}
4051 @opindex U
4052 Undefine macro @var{macro}.  @option{-U} options are evaluated after all
4053 @option{-D} options, but before any @option{-include} and @option{-imacros}
4054 options.
4055
4056 Any @option{-D} and @option{-U} options on the command line are processed in
4057 order, and always before @option{-imacros @var{file}}, regardless of the
4058 order in which they are written.
4059
4060 @item -dM
4061 @opindex dM
4062 Tell the preprocessor to output only a list of the macro definitions
4063 that are in effect at the end of preprocessing.  Used with the @option{-E}
4064 option.
4065
4066 @item -dD
4067 @opindex dD
4068 Tell the preprocessing to pass all macro definitions into the output, in
4069 their proper sequence in the rest of the output.
4070
4071 @item -dN
4072 @opindex dN
4073 Like @option{-dD} except that the macro arguments and contents are omitted.
4074 Only @samp{#define @var{name}} is included in the output.
4075
4076 @item -dI
4077 @opindex dI
4078 Output @samp{#include} directives in addition to the result of
4079 preprocessing.
4080
4081 @item -fpreprocessed
4082 @opindex fpreprocessed
4083 Indicate to the preprocessor that the input file has already been
4084 preprocessed.  This suppresses things like macro expansion, trigraph
4085 conversion, escaped newline splicing, and processing of most directives.
4086 The preprocessor still recognizes and removes comments, so that you can
4087 pass a file preprocessed with @option{-C} to the compiler without
4088 problems.  In this mode the integrated preprocessor is little more than
4089 a tokenizer for the front ends.
4090
4091 @option{-fpreprocessed} is implicit if the input file has one of the
4092 extensions @samp{i}, @samp{ii} or @samp{mi}.  These are the extensions
4093 that GCC uses for preprocessed files created by @option{-save-temps}.
4094
4095 @item -trigraphs
4096 @opindex trigraphs
4097 Process ISO standard trigraph sequences.  These are three-character
4098 sequences, all starting with @samp{??}, that are defined by ISO C to
4099 stand for single characters.  For example, @samp{??/} stands for
4100 @samp{\}, so @samp{'??/n'} is a character constant for a newline.  By
4101 default, GCC ignores trigraphs, but in standard-conforming modes it
4102 converts them.  See the @option{-std} and @option{-ansi} options.
4103
4104 The nine trigraph sequences are
4105 @table @samp
4106 @item ??(
4107 @expansion{} @samp{[}
4108
4109 @item ??)
4110 @expansion{} @samp{]}
4111
4112 @item ??<
4113 @expansion{} @samp{@{}
4114
4115 @item ??>
4116 @expansion{} @samp{@}}
4117
4118 @item ??=
4119 @expansion{} @samp{#}
4120
4121 @item ??/
4122 @expansion{} @samp{\}
4123
4124 @item ??'
4125 @expansion{} @samp{^}
4126
4127 @item ??!
4128 @expansion{} @samp{|}
4129
4130 @item ??-
4131 @expansion{} @samp{~}
4132
4133 @end table
4134
4135 Trigraph support is not popular, so many compilers do not implement it
4136 properly.  Portable code should not rely on trigraphs being either
4137 converted or ignored.
4138
4139 @item -Wp,@var{option}
4140 @opindex Wp
4141 Pass @var{option} as an option to the preprocessor.  If @var{option}
4142 contains commas, it is split into multiple options at the commas.
4143 @end table
4144
4145 @node Assembler Options
4146 @section Passing Options to the Assembler
4147
4148 @c prevent bad page break with this line
4149 You can pass options to the assembler.
4150
4151 @table @gcctabopt
4152 @item -Wa,@var{option}
4153 @opindex Wa
4154 Pass @var{option} as an option to the assembler.  If @var{option}
4155 contains commas, it is split into multiple options at the commas.
4156 @end table
4157
4158 @node Link Options
4159 @section Options for Linking
4160 @cindex link options
4161 @cindex options, linking
4162
4163 These options come into play when the compiler links object files into
4164 an executable output file.  They are meaningless if the compiler is
4165 not doing a link step.
4166
4167 @table @gcctabopt
4168 @cindex file names
4169 @item @var{object-file-name}
4170 A file name that does not end in a special recognized suffix is
4171 considered to name an object file or library.  (Object files are
4172 distinguished from libraries by the linker according to the file
4173 contents.)  If linking is done, these object files are used as input
4174 to the linker.
4175
4176 @item -c
4177 @itemx -S
4178 @itemx -E
4179 @opindex c
4180 @opindex S
4181 @opindex E
4182 If any of these options is used, then the linker is not run, and
4183 object file names should not be used as arguments.  @xref{Overall
4184 Options}.
4185
4186 @cindex Libraries
4187 @item -l@var{library}
4188 @itemx -l @var{library}
4189 @opindex l
4190 Search the library named @var{library} when linking.  (The second
4191 alternative with the library as a separate argument is only for
4192 POSIX compliance and is not recommended.)
4193
4194 It makes a difference where in the command you write this option; the
4195 linker searches and processes libraries and object files in the order they
4196 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4197 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4198 to functions in @samp{z}, those functions may not be loaded.
4199
4200 The linker searches a standard list of directories for the library,
4201 which is actually a file named @file{lib@var{library}.a}.  The linker
4202 then uses this file as if it had been specified precisely by name.
4203
4204 The directories searched include several standard system directories
4205 plus any that you specify with @option{-L}.
4206
4207 Normally the files found this way are library files---archive files
4208 whose members are object files.  The linker handles an archive file by
4209 scanning through it for members which define symbols that have so far
4210 been referenced but not defined.  But if the file that is found is an
4211 ordinary object file, it is linked in the usual fashion.  The only
4212 difference between using an @option{-l} option and specifying a file name
4213 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4214 and searches several directories.
4215
4216 @item -lobjc
4217 @opindex lobjc
4218 You need this special case of the @option{-l} option in order to
4219 link an Objective-C program.
4220
4221 @item -nostartfiles
4222 @opindex nostartfiles
4223 Do not use the standard system startup files when linking.
4224 The standard system libraries are used normally, unless @option{-nostdlib}
4225 or @option{-nodefaultlibs} is used.
4226
4227 @item -nodefaultlibs
4228 @opindex nodefaultlibs
4229 Do not use the standard system libraries when linking.
4230 Only the libraries you specify will be passed to the linker.
4231 The standard startup files are used normally, unless @option{-nostartfiles}
4232 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4233 for System V (and ISO C) environments or to bcopy and bzero for
4234 BSD environments.  These entries are usually resolved by entries in
4235 libc.  These entry points should be supplied through some other
4236 mechanism when this option is specified.
4237
4238 @item -nostdlib
4239 @opindex nostdlib
4240 Do not use the standard system startup files or libraries when linking.
4241 No startup files and only the libraries you specify will be passed to
4242 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4243 for System V (and ISO C) environments or to bcopy and bzero for
4244 BSD environments.  These entries are usually resolved by entries in
4245 libc.  These entry points should be supplied through some other
4246 mechanism when this option is specified.
4247
4248 @cindex @option{-lgcc}, use with @option{-nostdlib}
4249 @cindex @option{-nostdlib} and unresolved references
4250 @cindex unresolved references and @option{-nostdlib}
4251 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4252 @cindex @option{-nodefaultlibs} and unresolved references
4253 @cindex unresolved references and @option{-nodefaultlibs}
4254 One of the standard libraries bypassed by @option{-nostdlib} and
4255 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4256 that GCC uses to overcome shortcomings of particular machines, or special
4257 needs for some languages.
4258 @ifset INTERNALS
4259 (@xref{Interface,,Interfacing to GCC Output}, for more discussion of
4260 @file{libgcc.a}.)
4261 @end ifset
4262 @ifclear INTERNALS
4263 (@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
4264 for more discussion of @file{libgcc.a}.)
4265 @end ifclear
4266 In most cases, you need @file{libgcc.a} even when you want to avoid
4267 other standard libraries.  In other words, when you specify @option{-nostdlib}
4268 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4269 This ensures that you have no unresolved references to internal GCC
4270 library subroutines.  (For example, @samp{__main}, used to ensure C++
4271 constructors will be called; @pxref{Collect2,,@command{collect2}}.)
4272
4273 @item -s
4274 @opindex s
4275 Remove all symbol table and relocation information from the executable.
4276
4277 @item -static
4278 @opindex static
4279 On systems that support dynamic linking, this prevents linking with the shared
4280 libraries.  On other systems, this option has no effect.
4281
4282 @item -shared
4283 @opindex shared
4284 Produce a shared object which can then be linked with other objects to
4285 form an executable.  Not all systems support this option.  For predictable
4286 results, you must also specify the same set of options that were used to
4287 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4288 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4289 needs to build supplementary stub code for constructors to work.  On
4290 multi-libbed systems, @samp{gcc -shared} must select the correct support
4291 libraries to link against.  Failing to supply the correct flags may lead
4292 to subtle defects.  Supplying them in cases where they are not necessary
4293 is innocuous.}
4294
4295 @item -shared-libgcc
4296 @itemx -static-libgcc
4297 @opindex shared-libgcc
4298 @opindex static-libgcc
4299 On systems that provide @file{libgcc} as a shared library, these options
4300 force the use of either the shared or static version respectively.
4301 If no shared version of @file{libgcc} was built when the compiler was
4302 configured, these options have no effect.
4303
4304 There are several situations in which an application should use the
4305 shared @file{libgcc} instead of the static version.  The most common
4306 of these is when the application wishes to throw and catch exceptions
4307 across different shared libraries.  In that case, each of the libraries
4308 as well as the application itself should use the shared @file{libgcc}.
4309
4310 Therefore, whenever you specify the @option{-shared} option, the GCC
4311 driver automatically adds @option{-shared-libgcc}, unless you explicitly
4312 specify @option{-static-libgcc}.  The G++ driver automatically adds
4313 @option{-shared-libgcc} when you build a main executable as well because
4314 for C++ programs that is typically the right thing to do.
4315 (Exception-handling will not work reliably otherwise.)
4316
4317 However, when linking a main executable written in C, you must
4318 explicitly say @option{-shared-libgcc} if you want to use the shared
4319 @file{libgcc}.
4320
4321 @item -symbolic
4322 @opindex symbolic
4323 Bind references to global symbols when building a shared object.  Warn
4324 about any unresolved references (unless overridden by the link editor
4325 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4326 this option.
4327
4328 @item -Xlinker @var{option}
4329 @opindex Xlinker
4330 Pass @var{option} as an option to the linker.  You can use this to
4331 supply system-specific linker options which GCC does not know how to
4332 recognize.
4333
4334 If you want to pass an option that takes an argument, you must use
4335 @option{-Xlinker} twice, once for the option and once for the argument.
4336 For example, to pass @option{-assert definitions}, you must write
4337 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4338 @option{-Xlinker "-assert definitions"}, because this passes the entire
4339 string as a single argument, which is not what the linker expects.
4340
4341 @item -Wl,@var{option}
4342 @opindex Wl
4343 Pass @var{option} as an option to the linker.  If @var{option} contains
4344 commas, it is split into multiple options at the commas.
4345
4346 @item -u @var{symbol}
4347 @opindex u
4348 Pretend the symbol @var{symbol} is undefined, to force linking of
4349 library modules to define it.  You can use @option{-u} multiple times with
4350 different symbols to force loading of additional library modules.
4351 @end table
4352
4353 @node Directory Options
4354 @section Options for Directory Search
4355 @cindex directory options
4356 @cindex options, directory search
4357 @cindex search path
4358
4359 These options specify directories to search for header files, for
4360 libraries and for parts of the compiler:
4361
4362 @table @gcctabopt
4363 @item -I@var{dir}
4364 @opindex I
4365 Add the directory @var{dir} to the head of the list of directories to be
4366 searched for header files.  This can be used to override a system header
4367 file, substituting your own version, since these directories are
4368 searched before the system header file directories.  However, you should
4369 not use this option to add directories that contain vendor-supplied
4370 system header files (use @option{-isystem} for that).  If you use more than
4371 one @option{-I} option, the directories are scanned in left-to-right
4372 order; the standard system directories come after.
4373
4374 If a standard system include directory, or a directory specified with
4375 @option{-isystem}, is also specified with @option{-I}, it will be
4376 searched only in the position requested by @option{-I}.  Also, it will
4377 not be considered a system include directory.  If that directory really
4378 does contain system headers, there is a good chance that they will
4379 break.  For instance, if GCC's installation procedure edited the headers
4380 in @file{/usr/include} to fix bugs, @samp{-I/usr/include} will cause the
4381 original, buggy headers to be found instead of the corrected ones.  GCC
4382 will issue a warning when a system include directory is hidden in this
4383 way.
4384
4385 @item -I-
4386 @opindex I-
4387 Any directories you specify with @option{-I} options before the @option{-I-}
4388 option are searched only for the case of @samp{#include "@var{file}"};
4389 they are not searched for @samp{#include <@var{file}>}.
4390
4391 If additional directories are specified with @option{-I} options after
4392 the @option{-I-}, these directories are searched for all @samp{#include}
4393 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4394 this way.)
4395
4396 In addition, the @option{-I-} option inhibits the use of the current
4397 directory (where the current input file came from) as the first search
4398 directory for @samp{#include "@var{file}"}.  There is no way to
4399 override this effect of @option{-I-}.  With @option{-I.} you can specify
4400 searching the directory which was current when the compiler was
4401 invoked.  That is not exactly the same as what the preprocessor does
4402 by default, but it is often satisfactory.
4403
4404 @option{-I-} does not inhibit the use of the standard system directories
4405 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4406 independent.
4407
4408 @item -L@var{dir}
4409 @opindex L
4410 Add directory @var{dir} to the list of directories to be searched
4411 for @option{-l}.
4412
4413 @item -B@var{prefix}
4414 @opindex B
4415 This option specifies where to find the executables, libraries,
4416 include files, and data files of the compiler itself.
4417
4418 The compiler driver program runs one or more of the subprograms
4419 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4420 @var{prefix} as a prefix for each program it tries to run, both with and
4421 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4422
4423 For each subprogram to be run, the compiler driver first tries the
4424 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4425 was not specified, the driver tries two standard prefixes, which are
4426 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4427 those results in a file name that is found, the unmodified program
4428 name is searched for using the directories specified in your
4429 @env{PATH} environment variable.
4430
4431 The compiler will check to see if the path provided by the @option{-B}
4432 refers to a directory, and if necessary it will add a directory
4433 separator character at the end of the path.
4434
4435 @option{-B} prefixes that effectively specify directory names also apply
4436 to libraries in the linker, because the compiler translates these
4437 options into @option{-L} options for the linker.  They also apply to
4438 includes files in the preprocessor, because the compiler translates these
4439 options into @option{-isystem} options for the preprocessor.  In this case,
4440 the compiler appends @samp{include} to the prefix.
4441
4442 The run-time support file @file{libgcc.a} can also be searched for using
4443 the @option{-B} prefix, if needed.  If it is not found there, the two
4444 standard prefixes above are tried, and that is all.  The file is left
4445 out of the link if it is not found by those means.
4446
4447 Another way to specify a prefix much like the @option{-B} prefix is to use
4448 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4449 Variables}.
4450
4451 As a special kludge, if the path provided by @option{-B} is
4452 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4453 9, then it will be replaced by @file{[dir/]include}.  This is to help
4454 with boot-strapping the compiler.
4455
4456 @item -specs=@var{file}
4457 @opindex specs
4458 Process @var{file} after the compiler reads in the standard @file{specs}
4459 file, in order to override the defaults that the @file{gcc} driver
4460 program uses when determining what switches to pass to @file{cc1},
4461 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4462 @option{-specs=@var{file}} can be specified on the command line, and they
4463 are processed in order, from left to right.
4464 @end table
4465
4466 @c man end
4467
4468 @node Spec Files
4469 @section Specifying subprocesses and the switches to pass to them
4470 @cindex Spec Files
4471 @command{gcc} is a driver program.  It performs its job by invoking a
4472 sequence of other programs to do the work of compiling, assembling and
4473 linking.  GCC interprets its command-line parameters and uses these to
4474 deduce which programs it should invoke, and which command-line options
4475 it ought to place on their command lines.  This behaviour is controlled
4476 by @dfn{spec strings}.  In most cases there is one spec string for each
4477 program that GCC can invoke, but a few programs have multiple spec
4478 strings to control their behaviour.  The spec strings built into GCC can
4479 be overridden by using the @option{-specs=} command-line switch to specify
4480 a spec file.
4481
4482 @dfn{Spec files} are plaintext files that are used to construct spec
4483 strings.  They consist of a sequence of directives separated by blank
4484 lines.  The type of directive is determined by the first non-whitespace
4485 character on the line and it can be one of the following:
4486
4487 @table @code
4488 @item %@var{command}
4489 Issues a @var{command} to the spec file processor.  The commands that can
4490 appear here are:
4491
4492 @table @code
4493 @item %include <@var{file}>
4494 @cindex %include
4495 Search for @var{file} and insert its text at the current point in the
4496 specs file.
4497
4498 @item %include_noerr <@var{file}>
4499 @cindex %include_noerr
4500 Just like @samp{%include}, but do not generate an error message if the include
4501 file cannot be found.
4502
4503 @item %rename @var{old_name} @var{new_name}
4504 @cindex %rename
4505 Rename the spec string @var{old_name} to @var{new_name}.
4506
4507 @end table
4508
4509 @item *[@var{spec_name}]:
4510 This tells the compiler to create, override or delete the named spec
4511 string.  All lines after this directive up to the next directive or
4512 blank line are considered to be the text for the spec string.  If this
4513 results in an empty string then the spec will be deleted.  (Or, if the
4514 spec did not exist, then nothing will happened.)  Otherwise, if the spec
4515 does not currently exist a new spec will be created.  If the spec does
4516 exist then its contents will be overridden by the text of this
4517 directive, unless the first character of that text is the @samp{+}
4518 character, in which case the text will be appended to the spec.
4519
4520 @item [@var{suffix}]:
4521 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
4522 and up to the next directive or blank line are considered to make up the
4523 spec string for the indicated suffix.  When the compiler encounters an
4524 input file with the named suffix, it will processes the spec string in
4525 order to work out how to compile that file.  For example:
4526
4527 @smallexample
4528 .ZZ:
4529 z-compile -input %i
4530 @end smallexample
4531
4532 This says that any input file whose name ends in @samp{.ZZ} should be
4533 passed to the program @samp{z-compile}, which should be invoked with the
4534 command-line switch @option{-input} and with the result of performing the
4535 @samp{%i} substitution.  (See below.)
4536
4537 As an alternative to providing a spec string, the text that follows a
4538 suffix directive can be one of the following:
4539
4540 @table @code
4541 @item @@@var{language}
4542 This says that the suffix is an alias for a known @var{language}.  This is
4543 similar to using the @option{-x} command-line switch to GCC to specify a
4544 language explicitly.  For example:
4545
4546 @smallexample
4547 .ZZ:
4548 @@c++
4549 @end smallexample
4550
4551 Says that .ZZ files are, in fact, C++ source files.
4552
4553 @item #@var{name}
4554 This causes an error messages saying:
4555
4556 @smallexample
4557 @var{name} compiler not installed on this system.
4558 @end smallexample
4559 @end table
4560
4561 GCC already has an extensive list of suffixes built into it.
4562 This directive will add an entry to the end of the list of suffixes, but
4563 since the list is searched from the end backwards, it is effectively
4564 possible to override earlier entries using this technique.
4565
4566 @end table
4567
4568 GCC has the following spec strings built into it.  Spec files can
4569 override these strings or create their own.  Note that individual
4570 targets can also add their own spec strings to this list.
4571
4572 @smallexample
4573 asm          Options to pass to the assembler
4574 asm_final    Options to pass to the assembler post-processor
4575 cpp          Options to pass to the C preprocessor
4576 cc1          Options to pass to the C compiler
4577 cc1plus      Options to pass to the C++ compiler
4578 endfile      Object files to include at the end of the link
4579 link         Options to pass to the linker
4580 lib          Libraries to include on the command line to the linker
4581 libgcc       Decides which GCC support library to pass to the linker
4582 linker       Sets the name of the linker
4583 predefines   Defines to be passed to the C preprocessor
4584 signed_char  Defines to pass to CPP to say whether @code{char} is signed
4585              by default
4586 startfile    Object files to include at the start of the link
4587 @end smallexample
4588
4589 Here is a small example of a spec file:
4590
4591 @smallexample
4592 %rename lib                 old_lib
4593
4594 *lib:
4595 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
4596 @end smallexample
4597
4598 This example renames the spec called @samp{lib} to @samp{old_lib} and
4599 then overrides the previous definition of @samp{lib} with a new one.
4600 The new definition adds in some extra command-line options before
4601 including the text of the old definition.
4602
4603 @dfn{Spec strings} are a list of command-line options to be passed to their
4604 corresponding program.  In addition, the spec strings can contain
4605 @samp{%}-prefixed sequences to substitute variable text or to
4606 conditionally insert text into the command line.  Using these constructs
4607 it is possible to generate quite complex command lines.
4608
4609 Here is a table of all defined @samp{%}-sequences for spec
4610 strings.  Note that spaces are not generated automatically around the
4611 results of expanding these sequences.  Therefore you can concatenate them
4612 together or combine them with constant text in a single argument.
4613
4614 @table @code
4615 @item %%
4616 Substitute one @samp{%} into the program name or argument.
4617
4618 @item %i
4619 Substitute the name of the input file being processed.
4620
4621 @item %b
4622 Substitute the basename of the input file being processed.
4623 This is the substring up to (and not including) the last period
4624 and not including the directory.
4625
4626 @item %B
4627 This is the same as @samp{%b}, but include the file suffix (text after
4628 the last period).
4629
4630 @item %d
4631 Marks the argument containing or following the @samp{%d} as a
4632 temporary file name, so that that file will be deleted if GCC exits
4633 successfully.  Unlike @samp{%g}, this contributes no text to the
4634 argument.
4635
4636 @item %g@var{suffix}
4637 Substitute a file name that has suffix @var{suffix} and is chosen
4638 once per compilation, and mark the argument in the same way as
4639 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
4640 name is now chosen in a way that is hard to predict even when previously
4641 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
4642 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
4643 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4644 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
4645 was simply substituted with a file name chosen once per compilation,
4646 without regard to any appended suffix (which was therefore treated
4647 just like ordinary text), making such attacks more likely to succeed.
4648
4649 @item %u@var{suffix}
4650 Like @samp{%g}, but generates a new temporary file name even if
4651 @samp{%u@var{suffix}} was already seen.
4652
4653 @item %U@var{suffix}
4654 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4655 new one if there is no such last file name.  In the absence of any
4656 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4657 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
4658 would involve the generation of two distinct file names, one
4659 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
4660 simply substituted with a file name chosen for the previous @samp{%u},
4661 without regard to any appended suffix.
4662
4663 @item %j@var{SUFFIX}
4664 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
4665 writable, and if save-temps is off; otherwise, substitute the name
4666 of a temporary file, just like @samp{%u}.  This temporary file is not
4667 meant for communication between processes, but rather as a junk
4668 disposal mechanism.
4669
4670 @item %.@var{SUFFIX}
4671 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4672 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
4673 terminated by the next space or %.
4674
4675 @item %w
4676 Marks the argument containing or following the @samp{%w} as the
4677 designated output file of this compilation.  This puts the argument
4678 into the sequence of arguments that @samp{%o} will substitute later.
4679
4680 @item %o
4681 Substitutes the names of all the output files, with spaces
4682 automatically placed around them.  You should write spaces
4683 around the @samp{%o} as well or the results are undefined.
4684 @samp{%o} is for use in the specs for running the linker.
4685 Input files whose names have no recognized suffix are not compiled
4686 at all, but they are included among the output files, so they will
4687 be linked.
4688
4689 @item %O
4690 Substitutes the suffix for object files.  Note that this is
4691 handled specially when it immediately follows @samp{%g, %u, or %U},
4692 because of the need for those to form complete file names.  The
4693 handling is such that @samp{%O} is treated exactly as if it had already
4694 been substituted, except that @samp{%g, %u, and %U} do not currently
4695 support additional @var{suffix} characters following @samp{%O} as they would
4696 following, for example, @samp{.o}.
4697
4698 @item %p
4699 Substitutes the standard macro predefinitions for the
4700 current target machine.  Use this when running @code{cpp}.
4701
4702 @item %P
4703 Like @samp{%p}, but puts @samp{__} before and after the name of each
4704 predefined macro, except for macros that start with @samp{__} or with
4705 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
4706 C@.
4707
4708 @item %I
4709 Substitute a @option{-iprefix} option made from @env{GCC_EXEC_PREFIX}.
4710
4711 @item %s
4712 Current argument is the name of a library or startup file of some sort.
4713 Search for that file in a standard list of directories and substitute
4714 the full name found.
4715
4716 @item %e@var{str}
4717 Print @var{str} as an error message.  @var{str} is terminated by a newline.
4718 Use this when inconsistent options are detected.
4719
4720 @item %|
4721 Output @samp{-} if the input for the current command is coming from a pipe.
4722
4723 @item %(@var{name})
4724 Substitute the contents of spec string @var{name} at this point.
4725
4726 @item %[@var{name}]
4727 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
4728
4729 @item %x@{@var{option}@}
4730 Accumulate an option for @samp{%X}.
4731
4732 @item %X
4733 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
4734 spec string.
4735
4736 @item %Y
4737 Output the accumulated assembler options specified by @option{-Wa}.
4738
4739 @item %Z
4740 Output the accumulated preprocessor options specified by @option{-Wp}.
4741
4742 @item %v1
4743 Substitute the major version number of GCC@.
4744 (For version 2.9.5, this is 2.)
4745
4746 @item %v2
4747 Substitute the minor version number of GCC@.
4748 (For version 2.9.5, this is 9.)
4749
4750 @item %v3
4751 Substitute the patch level number of GCC@.
4752 (For version 2.9.5, this is 5.)
4753
4754 @item %a
4755 Process the @code{asm} spec.  This is used to compute the
4756 switches to be passed to the assembler.
4757
4758 @item %A
4759 Process the @code{asm_final} spec.  This is a spec string for
4760 passing switches to an assembler post-processor, if such a program is
4761 needed.
4762
4763 @item %l
4764 Process the @code{link} spec.  This is the spec for computing the
4765 command line passed to the linker.  Typically it will make use of the
4766 @samp{%L %G %S %D and %E} sequences.
4767
4768 @item %D
4769 Dump out a @option{-L} option for each directory that GCC believes might
4770 contain startup files.  If the target supports multilibs then the
4771 current multilib directory will be prepended to each of these paths.
4772
4773 @item %M
4774 Output the multilib directory with directory separators replaced with
4775 @samp{_}.  If multilib directories are not set, or the multilib directory is
4776 @file{.} then this option emits nothing.
4777
4778 @item %L
4779 Process the @code{lib} spec.  This is a spec string for deciding which
4780 libraries should be included on the command line to the linker.
4781
4782 @item %G
4783 Process the @code{libgcc} spec.  This is a spec string for deciding
4784 which GCC support library should be included on the command line to the linker.
4785
4786 @item %S
4787 Process the @code{startfile} spec.  This is a spec for deciding which
4788 object files should be the first ones passed to the linker.  Typically
4789 this might be a file named @file{crt0.o}.
4790
4791 @item %E
4792 Process the @code{endfile} spec.  This is a spec string that specifies
4793 the last object files that will be passed to the linker.
4794
4795 @item %C
4796 Process the @code{cpp} spec.  This is used to construct the arguments
4797 to be passed to the C preprocessor.
4798
4799 @item %c
4800 Process the @code{signed_char} spec.  This is intended to be used
4801 to tell cpp whether a char is signed.  It typically has the definition:
4802 @smallexample
4803 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
4804 @end smallexample
4805
4806 @item %1
4807 Process the @code{cc1} spec.  This is used to construct the options to be
4808 passed to the actual C compiler (@samp{cc1}).
4809
4810 @item %2
4811 Process the @code{cc1plus} spec.  This is used to construct the options to be
4812 passed to the actual C++ compiler (@samp{cc1plus}).
4813
4814 @item %*
4815 Substitute the variable part of a matched option.  See below.
4816 Note that each comma in the substituted string is replaced by
4817 a single space.
4818
4819 @item %@{@code{S}@}
4820 Substitutes the @code{-S} switch, if that switch was given to GCC@.
4821 If that switch was not specified, this substitutes nothing.  Note that
4822 the leading dash is omitted when specifying this option, and it is
4823 automatically inserted if the substitution is performed.  Thus the spec
4824 string @samp{%@{foo@}} would match the command-line option @option{-foo}
4825 and would output the command line option @option{-foo}.
4826
4827 @item %W@{@code{S}@}
4828 Like %@{@code{S}@} but mark last argument supplied within as a file to be
4829 deleted on failure.
4830
4831 @item %@{@code{S}*@}
4832 Substitutes all the switches specified to GCC whose names start
4833 with @code{-S}, but which also take an argument.  This is used for
4834 switches like @option{-o}, @option{-D}, @option{-I}, etc.
4835 GCC considers @option{-o foo} as being
4836 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
4837 text, including the space.  Thus two arguments would be generated.
4838
4839 @item %@{^@code{S}*@}
4840 Like %@{@code{S}*@}, but don't put a blank between a switch and its
4841 argument.  Thus %@{^o*@} would only generate one argument, not two.
4842
4843 @item %@{@code{S}*&@code{T}*@}
4844 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4845 (the order of @code{S} and @code{T} in the spec is not significant).
4846 There can be any number of ampersand-separated variables; for each the
4847 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
4848
4849 @item %@{<@code{S}@}
4850 Remove all occurrences of @code{-S} from the command line.  Note---this
4851 command is position dependent.  @samp{%} commands in the spec string
4852 before this option will see @code{-S}, @samp{%} commands in the spec
4853 string after this option will not.
4854
4855 @item %@{@code{S}*:@code{X}@}
4856 Substitutes @code{X} if one or more switches whose names start with
4857 @code{-S} are specified to GCC@.  Note that the tail part of the
4858 @code{-S} option (i.e.@: the part matched by the @samp{*}) will be substituted
4859 for each occurrence of @samp{%*} within @code{X}.
4860
4861 @item %@{@code{S}:@code{X}@}
4862 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC@.
4863
4864 @item %@{!@code{S}:@code{X}@}
4865 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC@.
4866
4867 @item %@{|@code{S}:@code{X}@}
4868 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4869
4870 @item %@{|!@code{S}:@code{X}@}
4871 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4872
4873 @item %@{.@code{S}:@code{X}@}
4874 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4875
4876 @item %@{!.@code{S}:@code{X}@}
4877 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4878
4879 @item %@{@code{S}|@code{P}:@code{X}@}
4880 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.  This may be
4881 combined with @samp{!} and @samp{.} sequences as well, although they
4882 have a stronger binding than the @samp{|}.  For example a spec string
4883 like this:
4884
4885 @smallexample
4886 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4887 @end smallexample
4888
4889 will output the following command-line options from the following input
4890 command-line options:
4891
4892 @smallexample
4893 fred.c        -foo -baz
4894 jim.d         -bar -boggle
4895 -d fred.c     -foo -baz -boggle
4896 -d jim.d      -bar -baz -boggle
4897 @end smallexample
4898
4899 @end table
4900
4901 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4902 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4903 or spaces, or even newlines.  They are processed as usual, as described
4904 above.
4905
4906 The @option{-O}, @option{-f}, @option{-m}, and @option{-W}
4907 switches are handled specifically in these
4908 constructs.  If another value of @option{-O} or the negated form of a @option{-f}, @option{-m}, or
4909 @option{-W} switch is found later in the command line, the earlier switch
4910 value is ignored, except with @{@code{S}*@} where @code{S} is just one
4911 letter, which passes all matching options.
4912
4913 The character @samp{|} at the beginning of the predicate text is used to indicate
4914 that a command should be piped to the following command, but only if @option{-pipe}
4915 is specified.
4916
4917 It is built into GCC which switches take arguments and which do not.
4918 (You might think it would be useful to generalize this to allow each
4919 compiler's spec to say which switches take arguments.  But this cannot
4920 be done in a consistent fashion.  GCC cannot even decide which input
4921 files have been specified without knowing which switches take arguments,
4922 and it must know which input files to compile in order to tell which
4923 compilers to run).
4924
4925 GCC also knows implicitly that arguments starting in @option{-l} are to be
4926 treated as compiler output files, and passed to the linker in their
4927 proper position among the other output files.
4928
4929 @c man begin OPTIONS
4930
4931 @node Target Options
4932 @section Specifying Target Machine and Compiler Version
4933 @cindex target options
4934 @cindex cross compiling
4935 @cindex specifying machine version
4936 @cindex specifying compiler version and target machine
4937 @cindex compiler version, specifying
4938 @cindex target machine, specifying
4939
4940 By default, GCC compiles code for the same type of machine that you
4941 are using.  However, it can also be installed as a cross-compiler, to
4942 compile for some other type of machine.  In fact, several different
4943 configurations of GCC, for different target machines, can be
4944 installed side by side.  Then you specify which one to use with the
4945 @option{-b} option.
4946
4947 In addition, older and newer versions of GCC can be installed side
4948 by side.  One of them (probably the newest) will be the default, but
4949 you may sometimes wish to use another.
4950
4951 @table @gcctabopt
4952 @item -b @var{machine}
4953 @opindex b
4954 The argument @var{machine} specifies the target machine for compilation.
4955 This is useful when you have installed GCC as a cross-compiler.
4956
4957 The value to use for @var{machine} is the same as was specified as the
4958 machine type when configuring GCC as a cross-compiler.  For
4959 example, if a cross-compiler was configured with @samp{configure
4960 i386v}, meaning to compile for an 80386 running System V, then you
4961 would specify @option{-b i386v} to run that cross compiler.
4962
4963 When you do not specify @option{-b}, it normally means to compile for
4964 the same type of machine that you are using.
4965
4966 @item -V @var{version}
4967 @opindex V
4968 The argument @var{version} specifies which version of GCC to run.
4969 This is useful when multiple versions are installed.  For example,
4970 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
4971
4972 The default version, when you do not specify @option{-V}, is the last
4973 version of GCC that you installed.
4974 @end table
4975
4976 The @option{-b} and @option{-V} options actually work by controlling part of
4977 the file name used for the executable files and libraries used for
4978 compilation.  A given version of GCC, for a given target machine, is
4979 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.
4980
4981 Thus, sites can customize the effect of @option{-b} or @option{-V} either by
4982 changing the names of these directories or adding alternate names (or
4983 symbolic links).  If in directory @file{/usr/local/lib/gcc-lib/} the
4984 file @file{80386} is a link to the file @file{i386v}, then @option{-b
4985 80386} becomes an alias for @option{-b i386v}.
4986
4987 In one respect, the @option{-b} or @option{-V} do not completely change
4988 to a different compiler: the top-level driver program @command{gcc}
4989 that you originally invoked continues to run and invoke the other
4990 executables (preprocessor, compiler per se, assembler and linker)
4991 that do the real work.  However, since no real work is done in the
4992 driver program, it usually does not matter that the driver program
4993 in use is not the one for the specified target.  It is common for the
4994 interface to the other executables to change incompatibly between
4995 compiler versions, so unless the version specified is very close to that
4996 of the driver (for example, @option{-V 3.0} with a driver program from GCC
4997 version 3.0.1), use of @option{-V} may not work; for example, using
4998 @option{-V 2.95.2} will not work with a driver program from GCC 3.0.
4999
5000 The only way that the driver program depends on the target machine is
5001 in the parsing and handling of special machine-specific options.
5002 However, this is controlled by a file which is found, along with the
5003 other executables, in the directory for the specified version and
5004 target machine.  As a result, a single installed driver program adapts
5005 to any specified target machine, and sufficiently similar compiler
5006 versions.
5007
5008 The driver program executable does control one significant thing,
5009 however: the default version and target machine.  Therefore, you can
5010 install different instances of the driver program, compiled for
5011 different targets or versions, under different names.
5012
5013 For example, if the driver for version 2.0 is installed as @command{ogcc}
5014 and that for version 2.1 is installed as @command{gcc}, then the command
5015 @command{gcc} will use version 2.1 by default, while @command{ogcc} will use
5016 2.0 by default.  However, you can choose either version with either
5017 command with the @option{-V} option.
5018
5019 @node Submodel Options
5020 @section Hardware Models and Configurations
5021 @cindex submodel options
5022 @cindex specifying hardware config
5023 @cindex hardware models and configurations, specifying
5024 @cindex machine dependent options
5025
5026 Earlier we discussed the standard option @option{-b} which chooses among
5027 different installed compilers for completely different target
5028 machines, such as VAX vs.@: 68000 vs.@: 80386.
5029
5030 In addition, each of these target machine types can have its own
5031 special options, starting with @samp{-m}, to choose among various
5032 hardware models or configurations---for example, 68010 vs 68020,
5033 floating coprocessor or none.  A single installed version of the
5034 compiler can compile for any model or configuration, according to the
5035 options specified.
5036
5037 Some configurations of the compiler also support additional special
5038 options, usually for compatibility with other compilers on the same
5039 platform.
5040
5041 @ifset INTERNALS
5042 These options are defined by the macro @code{TARGET_SWITCHES} in the
5043 machine description.  The default for the options is also defined by
5044 that macro, which enables you to change the defaults.
5045 @end ifset
5046
5047 @menu
5048 * M680x0 Options::
5049 * M68hc1x Options::
5050 * VAX Options::
5051 * SPARC Options::
5052 * Convex Options::
5053 * AMD29K Options::
5054 * ARM Options::
5055 * MN10200 Options::
5056 * MN10300 Options::
5057 * M32R/D Options::
5058 * M88K Options::
5059 * RS/6000 and PowerPC Options::
5060 * RT Options::
5061 * MIPS Options::
5062 * i386 Options::
5063 * HPPA Options::
5064 * Intel 960 Options::
5065 * DEC Alpha Options::
5066 * Clipper Options::
5067 * H8/300 Options::
5068 * SH Options::
5069 * System V Options::
5070 * TMS320C3x/C4x Options::
5071 * V850 Options::
5072 * ARC Options::
5073 * NS32K Options::
5074 * AVR Options::
5075 * MCore Options::
5076 * IA-64 Options::
5077 * D30V Options::
5078 * S/390 and zSeries Options::
5079 @end menu
5080
5081 @node M680x0 Options
5082 @subsection M680x0 Options
5083 @cindex M680x0 options
5084
5085 These are the @samp{-m} options defined for the 68000 series.  The default
5086 values for these options depends on which style of 68000 was selected when
5087 the compiler was configured; the defaults for the most common choices are
5088 given below.
5089
5090 @table @gcctabopt
5091 @item -m68000
5092 @itemx -mc68000
5093 @opindex m68000
5094 @opindex mc68000
5095 Generate output for a 68000.  This is the default
5096 when the compiler is configured for 68000-based systems.
5097
5098 Use this option for microcontrollers with a 68000 or EC000 core,
5099 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5100
5101 @item -m68020
5102 @itemx -mc68020
5103 @opindex m68020
5104 @opindex mc68020
5105 Generate output for a 68020.  This is the default
5106 when the compiler is configured for 68020-based systems.
5107
5108 @item -m68881
5109 @opindex m68881
5110 Generate output containing 68881 instructions for floating point.
5111 This is the default for most 68020 systems unless @option{--nfp} was
5112 specified when the compiler was configured.
5113
5114 @item -m68030
5115 @opindex m68030
5116 Generate output for a 68030.  This is the default when the compiler is
5117 configured for 68030-based systems.
5118
5119 @item -m68040
5120 @opindex m68040
5121 Generate output for a 68040.  This is the default when the compiler is
5122 configured for 68040-based systems.
5123
5124 This option inhibits the use of 68881/68882 instructions that have to be
5125 emulated by software on the 68040.  Use this option if your 68040 does not
5126 have code to emulate those instructions.
5127
5128 @item -m68060
5129 @opindex m68060
5130 Generate output for a 68060.  This is the default when the compiler is
5131 configured for 68060-based systems.
5132
5133 This option inhibits the use of 68020 and 68881/68882 instructions that
5134 have to be emulated by software on the 68060.  Use this option if your 68060
5135 does not have code to emulate those instructions.
5136
5137 @item -mcpu32
5138 @opindex mcpu32
5139 Generate output for a CPU32.  This is the default
5140 when the compiler is configured for CPU32-based systems.
5141
5142 Use this option for microcontrollers with a
5143 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5144 68336, 68340, 68341, 68349 and 68360.
5145
5146 @item -m5200
5147 @opindex m5200
5148 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5149 when the compiler is configured for 520X-based systems.
5150
5151 Use this option for microcontroller with a 5200 core, including
5152 the MCF5202, MCF5203, MCF5204 and MCF5202.
5153
5154
5155 @item -m68020-40
5156 @opindex m68020-40
5157 Generate output for a 68040, without using any of the new instructions.
5158 This results in code which can run relatively efficiently on either a
5159 68020/68881 or a 68030 or a 68040.  The generated code does use the
5160 68881 instructions that are emulated on the 68040.
5161
5162 @item -m68020-60
5163 @opindex m68020-60
5164 Generate output for a 68060, without using any of the new instructions.
5165 This results in code which can run relatively efficiently on either a
5166 68020/68881 or a 68030 or a 68040.  The generated code does use the
5167 68881 instructions that are emulated on the 68060.
5168
5169 @item -mfpa
5170 @opindex mfpa
5171 Generate output containing Sun FPA instructions for floating point.
5172
5173 @item -msoft-float
5174 @opindex msoft-float
5175 Generate output containing library calls for floating point.
5176 @strong{Warning:} the requisite libraries are not available for all m68k
5177 targets.  Normally the facilities of the machine's usual C compiler are
5178 used, but this can't be done directly in cross-compilation.  You must
5179 make your own arrangements to provide suitable library functions for
5180 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5181 @samp{m68k-*-coff} do provide software floating point support.
5182
5183 @item -mshort
5184 @opindex mshort
5185 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5186
5187 @item -mnobitfield
5188 @opindex mnobitfield
5189 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5190 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5191
5192 @item -mbitfield
5193 @opindex mbitfield
5194 Do use the bit-field instructions.  The @option{-m68020} option implies
5195 @option{-mbitfield}.  This is the default if you use a configuration
5196 designed for a 68020.
5197
5198 @item -mrtd
5199 @opindex mrtd
5200 Use a different function-calling convention, in which functions
5201 that take a fixed number of arguments return with the @code{rtd}
5202 instruction, which pops their arguments while returning.  This
5203 saves one instruction in the caller since there is no need to pop
5204 the arguments there.
5205
5206 This calling convention is incompatible with the one normally
5207 used on Unix, so you cannot use it if you need to call libraries
5208 compiled with the Unix compiler.
5209
5210 Also, you must provide function prototypes for all functions that
5211 take variable numbers of arguments (including @code{printf});
5212 otherwise incorrect code will be generated for calls to those
5213 functions.
5214
5215 In addition, seriously incorrect code will result if you call a
5216 function with too many arguments.  (Normally, extra arguments are
5217 harmlessly ignored.)
5218
5219 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5220 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5221
5222 @item -malign-int
5223 @itemx -mno-align-int
5224 @opindex malign-int
5225 @opindex mno-align-int
5226 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5227 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5228 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5229 Aligning variables on 32-bit boundaries produces code that runs somewhat
5230 faster on processors with 32-bit busses at the expense of more memory.
5231
5232 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5233 align structures containing the above types  differently than
5234 most published application binary interface specifications for the m68k.
5235
5236 @item -mpcrel
5237 @opindex mpcrel
5238 Use the pc-relative addressing mode of the 68000 directly, instead of
5239 using a global offset table.  At present, this option implies @option{-fpic},
5240 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5241 not presently supported with @option{-mpcrel}, though this could be supported for
5242 68020 and higher processors.
5243
5244 @item -mno-strict-align
5245 @itemx -mstrict-align
5246 @opindex mno-strict-align
5247 @opindex mstrict-align
5248 Do not (do) assume that unaligned memory references will be handled by
5249 the system.
5250
5251 @end table
5252
5253 @node M68hc1x Options
5254 @subsection M68hc1x Options
5255 @cindex M68hc1x options
5256
5257 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5258 microcontrollers.  The default values for these options depends on
5259 which style of microcontroller was selected when the compiler was configured;
5260 the defaults for the most common choices are given below.
5261
5262 @table @gcctabopt
5263 @item -m6811
5264 @itemx -m68hc11
5265 @opindex m6811
5266 @opindex m68hc11
5267 Generate output for a 68HC11.  This is the default
5268 when the compiler is configured for 68HC11-based systems.
5269
5270 @item -m6812
5271 @itemx -m68hc12
5272 @opindex m6812
5273 @opindex m68hc12
5274 Generate output for a 68HC12.  This is the default
5275 when the compiler is configured for 68HC12-based systems.
5276
5277 @item -mauto-incdec
5278 @opindex mauto-incdec
5279 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5280 addressing modes.
5281
5282 @item -mshort
5283 @opindex mshort
5284 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5285
5286 @item -msoft-reg-count=@var{count}
5287 @opindex msoft-reg-count
5288 Specify the number of pseudo-soft registers which are used for the
5289 code generation.  The maximum number is 32.  Using more pseudo-soft
5290 register may or may not result in better code depending on the program.
5291 The default is 4 for 68HC11 and 2 for 68HC12.
5292
5293 @end table
5294
5295 @node VAX Options
5296 @subsection VAX Options
5297 @cindex VAX options
5298
5299 These @samp{-m} options are defined for the VAX:
5300
5301 @table @gcctabopt
5302 @item -munix
5303 @opindex munix
5304 Do not output certain jump instructions (@code{aobleq} and so on)
5305 that the Unix assembler for the VAX cannot handle across long
5306 ranges.
5307
5308 @item -mgnu
5309 @opindex mgnu
5310 Do output those jump instructions, on the assumption that you
5311 will assemble with the GNU assembler.
5312
5313 @item -mg
5314 @opindex mg
5315 Output code for g-format floating point numbers instead of d-format.
5316 @end table
5317
5318 @node SPARC Options
5319 @subsection SPARC Options
5320 @cindex SPARC options
5321
5322 These @samp{-m} switches are supported on the SPARC:
5323
5324 @table @gcctabopt
5325 @item -mno-app-regs
5326 @itemx -mapp-regs
5327 @opindex mno-app-regs
5328 @opindex mapp-regs
5329 Specify @option{-mapp-regs} to generate output using the global registers
5330 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5331 is the default.
5332
5333 To be fully SVR4 ABI compliant at the cost of some performance loss,
5334 specify @option{-mno-app-regs}.  You should compile libraries and system
5335 software with this option.
5336
5337 @item -mfpu
5338 @itemx -mhard-float
5339 @opindex mfpu
5340 @opindex mhard-float
5341 Generate output containing floating point instructions.  This is the
5342 default.
5343
5344 @item -mno-fpu
5345 @itemx -msoft-float
5346 @opindex mno-fpu
5347 @opindex msoft-float
5348 Generate output containing library calls for floating point.
5349 @strong{Warning:} the requisite libraries are not available for all SPARC
5350 targets.  Normally the facilities of the machine's usual C compiler are
5351 used, but this cannot be done directly in cross-compilation.  You must make
5352 your own arrangements to provide suitable library functions for
5353 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5354 @samp{sparclite-*-*} do provide software floating point support.
5355
5356 @option{-msoft-float} changes the calling convention in the output file;
5357 therefore, it is only useful if you compile @emph{all} of a program with
5358 this option.  In particular, you need to compile @file{libgcc.a}, the
5359 library that comes with GCC, with @option{-msoft-float} in order for
5360 this to work.
5361
5362 @item -mhard-quad-float
5363 @opindex mhard-quad-float
5364 Generate output containing quad-word (long double) floating point
5365 instructions.
5366
5367 @item -msoft-quad-float
5368 @opindex msoft-quad-float
5369 Generate output containing library calls for quad-word (long double)
5370 floating point instructions.  The functions called are those specified
5371 in the SPARC ABI@.  This is the default.
5372
5373 As of this writing, there are no sparc implementations that have hardware
5374 support for the quad-word floating point instructions.  They all invoke
5375 a trap handler for one of these instructions, and then the trap handler
5376 emulates the effect of the instruction.  Because of the trap handler overhead,
5377 this is much slower than calling the ABI library routines.  Thus the
5378 @option{-msoft-quad-float} option is the default.
5379
5380 @item -mno-epilogue
5381 @itemx -mepilogue
5382 @opindex mno-epilogue
5383 @opindex mepilogue
5384 With @option{-mepilogue} (the default), the compiler always emits code for
5385 function exit at the end of each function.  Any function exit in
5386 the middle of the function (such as a return statement in C) will
5387 generate a jump to the exit code at the end of the function.
5388
5389 With @option{-mno-epilogue}, the compiler tries to emit exit code inline
5390 at every function exit.
5391
5392 @item -mno-flat
5393 @itemx -mflat
5394 @opindex mno-flat
5395 @opindex mflat
5396 With @option{-mflat}, the compiler does not generate save/restore instructions
5397 and will use a ``flat'' or single register window calling convention.
5398 This model uses %i7 as the frame pointer and is compatible with the normal
5399 register window model.  Code from either may be intermixed.
5400 The local registers and the input registers (0--5) are still treated as
5401 ``call saved'' registers and will be saved on the stack as necessary.
5402
5403 With @option{-mno-flat} (the default), the compiler emits save/restore
5404 instructions (except for leaf functions) and is the normal mode of operation.
5405
5406 @item -mno-unaligned-doubles
5407 @itemx -munaligned-doubles
5408 @opindex mno-unaligned-doubles
5409 @opindex munaligned-doubles
5410 Assume that doubles have 8 byte alignment.  This is the default.
5411
5412 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5413 alignment only if they are contained in another type, or if they have an
5414 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5415 Specifying this option avoids some rare compatibility problems with code
5416 generated by other compilers.  It is not the default because it results
5417 in a performance loss, especially for floating point code.
5418
5419 @item -mno-faster-structs
5420 @itemx -mfaster-structs
5421 @opindex mno-faster-structs
5422 @opindex mfaster-structs
5423 With @option{-mfaster-structs}, the compiler assumes that structures
5424 should have 8 byte alignment.  This enables the use of pairs of
5425 @code{ldd} and @code{std} instructions for copies in structure
5426 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5427 However, the use of this changed alignment directly violates the Sparc
5428 ABI@.  Thus, it's intended only for use on targets where the developer
5429 acknowledges that their resulting code will not be directly in line with
5430 the rules of the ABI@.
5431
5432 @item -mv8
5433 @itemx -msparclite
5434 @opindex mv8
5435 @opindex msparclite
5436 These two options select variations on the SPARC architecture.
5437
5438 By default (unless specifically configured for the Fujitsu SPARClite),
5439 GCC generates code for the v7 variant of the SPARC architecture.
5440
5441 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5442 code is that the compiler emits the integer multiply and integer
5443 divide instructions which exist in SPARC v8 but not in SPARC v7.
5444
5445 @option{-msparclite} will give you SPARClite code.  This adds the integer
5446 multiply, integer divide step and scan (@code{ffs}) instructions which
5447 exist in SPARClite but not in SPARC v7.
5448
5449 These options are deprecated and will be deleted in a future GCC release.
5450 They have been replaced with @option{-mcpu=xxx}.
5451
5452 @item -mcypress
5453 @itemx -msupersparc
5454 @opindex mcypress
5455 @opindex msupersparc
5456 These two options select the processor for which the code is optimised.
5457
5458 With @option{-mcypress} (the default), the compiler optimizes code for the
5459 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
5460 This is also appropriate for the older SparcStation 1, 2, IPX etc.
5461
5462 With @option{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
5463 used in the SparcStation 10, 1000 and 2000 series.  This flag also enables use
5464 of the full SPARC v8 instruction set.
5465
5466 These options are deprecated and will be deleted in a future GCC release.
5467 They have been replaced with @option{-mcpu=xxx}.
5468
5469 @item -mcpu=@var{cpu_type}
5470 @opindex mcpu
5471 Set the instruction set, register set, and instruction scheduling parameters
5472 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5473 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5474 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5475 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
5476
5477 Default instruction scheduling parameters are used for values that select
5478 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
5479 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
5480
5481 Here is a list of each supported architecture and their supported
5482 implementations.
5483
5484 @smallexample
5485     v7:             cypress
5486     v8:             supersparc, hypersparc
5487     sparclite:      f930, f934, sparclite86x
5488     sparclet:       tsc701
5489     v9:             ultrasparc
5490 @end smallexample
5491
5492 @item -mtune=@var{cpu_type}
5493 @opindex mtune
5494 Set the instruction scheduling parameters for machine type
5495 @var{cpu_type}, but do not set the instruction set or register set that the
5496 option @option{-mcpu=@var{cpu_type}} would.
5497
5498 The same values for @option{-mcpu=@var{cpu_type}} can be used for
5499 @option{-mtune=@var{cpu_type}}, but the only useful values are those
5500 that select a particular cpu implementation.  Those are @samp{cypress},
5501 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
5502 @samp{sparclite86x}, @samp{tsc701}, and @samp{ultrasparc}.
5503
5504 @end table
5505
5506 These @samp{-m} switches are supported in addition to the above
5507 on the SPARCLET processor.
5508
5509 @table @gcctabopt
5510 @item -mlittle-endian
5511 @opindex mlittle-endian
5512 Generate code for a processor running in little-endian mode.
5513
5514 @item -mlive-g0
5515 @opindex mlive-g0
5516 Treat register @code{%g0} as a normal register.
5517 GCC will continue to clobber it as necessary but will not assume
5518 it always reads as 0.
5519
5520 @item -mbroken-saverestore
5521 @opindex mbroken-saverestore
5522 Generate code that does not use non-trivial forms of the @code{save} and
5523 @code{restore} instructions.  Early versions of the SPARCLET processor do
5524 not correctly handle @code{save} and @code{restore} instructions used with
5525 arguments.  They correctly handle them used without arguments.  A @code{save}
5526 instruction used without arguments increments the current window pointer
5527 but does not allocate a new stack frame.  It is assumed that the window
5528 overflow trap handler will properly handle this case as will interrupt
5529 handlers.
5530 @end table
5531
5532 These @samp{-m} switches are supported in addition to the above
5533 on SPARC V9 processors in 64-bit environments.
5534
5535 @table @gcctabopt
5536 @item -mlittle-endian
5537 @opindex mlittle-endian
5538 Generate code for a processor running in little-endian mode.
5539
5540 @item -m32
5541 @itemx -m64
5542 @opindex m32
5543 @opindex m64
5544 Generate code for a 32-bit or 64-bit environment.
5545 The 32-bit environment sets int, long and pointer to 32 bits.
5546 The 64-bit environment sets int to 32 bits and long and pointer
5547 to 64 bits.
5548
5549 @item -mcmodel=medlow
5550 @opindex mcmodel=medlow
5551 Generate code for the Medium/Low code model: the program must be linked
5552 in the low 32 bits of the address space.  Pointers are 64 bits.
5553 Programs can be statically or dynamically linked.
5554
5555 @item -mcmodel=medmid
5556 @opindex mcmodel=medmid
5557 Generate code for the Medium/Middle code model: the program must be linked
5558 in the low 44 bits of the address space, the text segment must be less than
5559 2G bytes, and data segment must be within 2G of the text segment.
5560 Pointers are 64 bits.
5561
5562 @item -mcmodel=medany
5563 @opindex mcmodel=medany
5564 Generate code for the Medium/Anywhere code model: the program may be linked
5565 anywhere in the address space, the text segment must be less than
5566 2G bytes, and data segment must be within 2G of the text segment.
5567 Pointers are 64 bits.
5568
5569 @item -mcmodel=embmedany
5570 @opindex mcmodel=embmedany
5571 Generate code for the Medium/Anywhere code model for embedded systems:
5572 assume a 32-bit text and a 32-bit data segment, both starting anywhere
5573 (determined at link time).  Register %g4 points to the base of the
5574 data segment.  Pointers are still 64 bits.
5575 Programs are statically linked, PIC is not supported.
5576
5577 @item -mstack-bias
5578 @itemx -mno-stack-bias
5579 @opindex mstack-bias
5580 @opindex mno-stack-bias
5581 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
5582 frame pointer if present, are offset by @minus{}2047 which must be added back
5583 when making stack frame references.
5584 Otherwise, assume no such offset is present.
5585 @end table
5586
5587 @node Convex Options
5588 @subsection Convex Options
5589 @cindex Convex options
5590
5591 These @samp{-m} options are defined for Convex:
5592
5593 @table @gcctabopt
5594 @item -mc1
5595 @opindex mc1
5596 Generate output for C1.  The code will run on any Convex machine.
5597 The preprocessor symbol @code{__convex__c1__} is defined.
5598
5599 @item -mc2
5600 @opindex mc2
5601 Generate output for C2.  Uses instructions not available on C1.
5602 Scheduling and other optimizations are chosen for max performance on C2.
5603 The preprocessor symbol @code{__convex_c2__} is defined.
5604
5605 @item -mc32
5606 @opindex mc32
5607 Generate output for C32xx.  Uses instructions not available on C1.
5608 Scheduling and other optimizations are chosen for max performance on C32.
5609 The preprocessor symbol @code{__convex_c32__} is defined.
5610
5611 @item -mc34
5612 @opindex mc34
5613 Generate output for C34xx.  Uses instructions not available on C1.
5614 Scheduling and other optimizations are chosen for max performance on C34.
5615 The preprocessor symbol @code{__convex_c34__} is defined.
5616
5617 @item -mc38
5618 @opindex mc38
5619 Generate output for C38xx.  Uses instructions not available on C1.
5620 Scheduling and other optimizations are chosen for max performance on C38.
5621 The preprocessor symbol @code{__convex_c38__} is defined.
5622
5623 @item -margcount
5624 @opindex margcount
5625 Generate code which puts an argument count in the word preceding each
5626 argument list.  This is compatible with regular CC, and a few programs
5627 may need the argument count word.  GDB and other source-level debuggers
5628 do not need it; this info is in the symbol table.
5629
5630 @item -mnoargcount
5631 @opindex mnoargcount
5632 Omit the argument count word.  This is the default.
5633
5634 @item -mvolatile-cache
5635 @opindex mvolatile-cache
5636 Allow volatile references to be cached.  This is the default.
5637
5638 @item -mvolatile-nocache
5639 @opindex mvolatile-nocache
5640 Volatile references bypass the data cache, going all the way to memory.
5641 This is only needed for multi-processor code that does not use standard
5642 synchronization instructions.  Making non-volatile references to volatile
5643 locations will not necessarily work.
5644
5645 @item -mlong32
5646 @opindex mlong32
5647 Type long is 32 bits, the same as type int.  This is the default.
5648
5649 @item -mlong64
5650 @opindex mlong64
5651 Type long is 64 bits, the same as type long long.  This option is useless,
5652 because no library support exists for it.
5653 @end table
5654
5655 @node AMD29K Options
5656 @subsection AMD29K Options
5657 @cindex AMD29K options
5658
5659 These @samp{-m} options are defined for the AMD Am29000:
5660
5661 @table @gcctabopt
5662 @item -mdw
5663 @opindex mdw
5664 @cindex DW bit (29k)
5665 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
5666 halfword operations are directly supported by the hardware.  This is the
5667 default.
5668
5669 @item -mndw
5670 @opindex mndw
5671 Generate code that assumes the @code{DW} bit is not set.
5672
5673 @item -mbw
5674 @opindex mbw
5675 @cindex byte writes (29k)
5676 Generate code that assumes the system supports byte and halfword write
5677 operations.  This is the default.
5678
5679 @item -mnbw
5680 @opindex mnbw
5681 Generate code that assumes the systems does not support byte and
5682 halfword write operations.  @option{-mnbw} implies @option{-mndw}.
5683
5684 @item -msmall
5685 @opindex msmall
5686 @cindex memory model (29k)
5687 Use a small memory model that assumes that all function addresses are
5688 either within a single 256 KB segment or at an absolute address of less
5689 than 256k.  This allows the @code{call} instruction to be used instead
5690 of a @code{const}, @code{consth}, @code{calli} sequence.
5691
5692 @item -mnormal
5693 @opindex mnormal
5694 Use the normal memory model: Generate @code{call} instructions only when
5695 calling functions in the same file and @code{calli} instructions
5696 otherwise.  This works if each file occupies less than 256 KB but allows
5697 the entire executable to be larger than 256 KB@.  This is the default.
5698
5699 @item -mlarge
5700 @opindex mlarge
5701 Always use @code{calli} instructions.  Specify this option if you expect
5702 a single file to compile into more than 256 KB of code.
5703
5704 @item -m29050
5705 @opindex m29050
5706 @cindex processor selection (29k)
5707 Generate code for the Am29050.
5708
5709 @item -m29000
5710 @opindex m29000
5711 Generate code for the Am29000.  This is the default.
5712
5713 @item -mkernel-registers
5714 @opindex mkernel-registers
5715 @cindex kernel and user registers (29k)
5716 Generate references to registers @code{gr64-gr95} instead of to
5717 registers @code{gr96-gr127}.  This option can be used when compiling
5718 kernel code that wants a set of global registers disjoint from that used
5719 by user-mode code.
5720
5721 Note that when this option is used, register names in @samp{-f} flags
5722 must use the normal, user-mode, names.
5723
5724 @item -muser-registers
5725 @opindex muser-registers
5726 Use the normal set of global registers, @code{gr96-gr127}.  This is the
5727 default.
5728
5729 @item -mstack-check
5730 @itemx -mno-stack-check
5731 @opindex mstack-check
5732 @opindex mno-stack-check
5733 @cindex stack checks (29k)
5734 Insert (or do not insert) a call to @code{__msp_check} after each stack
5735 adjustment.  This is often used for kernel code.
5736
5737 @item -mstorem-bug
5738 @itemx -mno-storem-bug
5739 @opindex mstorem-bug
5740 @opindex mno-storem-bug
5741 @cindex storem bug (29k)
5742 @option{-mstorem-bug} handles 29k processors which cannot handle the
5743 separation of a mtsrim insn and a storem instruction (most 29000 chips
5744 to date, but not the 29050).
5745
5746 @item -mno-reuse-arg-regs
5747 @itemx -mreuse-arg-regs
5748 @opindex mno-reuse-arg-regs
5749 @opindex mreuse-arg-regs
5750 @option{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5751 registers for copying out arguments.  This helps detect calling a function
5752 with fewer arguments than it was declared with.
5753
5754 @item -mno-impure-text
5755 @itemx -mimpure-text
5756 @opindex mno-impure-text
5757 @opindex mimpure-text
5758 @option{-mimpure-text}, used in addition to @option{-shared}, tells the compiler to
5759 not pass @option{-assert pure-text} to the linker when linking a shared object.
5760
5761 @item -msoft-float
5762 @opindex msoft-float
5763 Generate output containing library calls for floating point.
5764 @strong{Warning:} the requisite libraries are not part of GCC@.
5765 Normally the facilities of the machine's usual C compiler are used, but
5766 this can't be done directly in cross-compilation.  You must make your
5767 own arrangements to provide suitable library functions for
5768 cross-compilation.
5769
5770 @item -mno-multm
5771 @opindex mno-multm
5772 Do not generate multm or multmu instructions.  This is useful for some embedded
5773 systems which do not have trap handlers for these instructions.
5774 @end table
5775
5776 @node ARM Options
5777 @subsection ARM Options
5778 @cindex ARM options
5779
5780 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5781 architectures:
5782
5783 @table @gcctabopt
5784 @item -mapcs-frame
5785 @opindex mapcs-frame
5786 Generate a stack frame that is compliant with the ARM Procedure Call
5787 Standard for all functions, even if this is not strictly necessary for
5788 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
5789 with this option will cause the stack frames not to be generated for
5790 leaf functions.  The default is @option{-mno-apcs-frame}.
5791
5792 @item -mapcs
5793 @opindex mapcs
5794 This is a synonym for @option{-mapcs-frame}.
5795
5796 @item -mapcs-26
5797 @opindex mapcs-26
5798 Generate code for a processor running with a 26-bit program counter,
5799 and conforming to the function calling standards for the APCS 26-bit
5800 option.  This option replaces the @option{-m2} and @option{-m3} options
5801 of previous releases of the compiler.
5802
5803 @item -mapcs-32
5804 @opindex mapcs-32
5805 Generate code for a processor running with a 32-bit program counter,
5806 and conforming to the function calling standards for the APCS 32-bit
5807 option.  This option replaces the @option{-m6} option of previous releases
5808 of the compiler.
5809
5810 @ignore
5811 @c not currently implemented
5812 @item -mapcs-stack-check
5813 @opindex mapcs-stack-check
5814 Generate code to check the amount of stack space available upon entry to
5815 every function (that actually uses some stack space).  If there is
5816 insufficient space available then either the function
5817 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5818 called, depending upon the amount of stack space required.  The run time
5819 system is required to provide these functions.  The default is
5820 @option{-mno-apcs-stack-check}, since this produces smaller code.
5821
5822 @c not currently implemented
5823 @item -mapcs-float
5824 @opindex mapcs-float
5825 Pass floating point arguments using the float point registers.  This is
5826 one of the variants of the APCS@.  This option is recommended if the
5827 target hardware has a floating point unit or if a lot of floating point
5828 arithmetic is going to be performed by the code.  The default is
5829 @option{-mno-apcs-float}, since integer only code is slightly increased in
5830 size if @option{-mapcs-float} is used.
5831
5832 @c not currently implemented
5833 @item -mapcs-reentrant
5834 @opindex mapcs-reentrant
5835 Generate reentrant, position independent code.  The default is
5836 @option{-mno-apcs-reentrant}.
5837 @end ignore
5838
5839 @item -mthumb-interwork
5840 @opindex mthumb-interwork
5841 Generate code which supports calling between the ARM and Thumb
5842 instruction sets.  Without this option the two instruction sets cannot
5843 be reliably used inside one program.  The default is
5844 @option{-mno-thumb-interwork}, since slightly larger code is generated
5845 when @option{-mthumb-interwork} is specified.
5846
5847 @item -mno-sched-prolog
5848 @opindex mno-sched-prolog
5849 Prevent the reordering of instructions in the function prolog, or the
5850 merging of those instruction with the instructions in the function's
5851 body.  This means that all functions will start with a recognizable set
5852 of instructions (or in fact one of a choice from a small set of
5853 different function prologues), and this information can be used to
5854 locate the start if functions inside an executable piece of code.  The
5855 default is @option{-msched-prolog}.
5856
5857 @item -mhard-float
5858 @opindex mhard-float
5859 Generate output containing floating point instructions.  This is the
5860 default.
5861
5862 @item -msoft-float
5863 @opindex msoft-float
5864 Generate output containing library calls for floating point.
5865 @strong{Warning:} the requisite libraries are not available for all ARM
5866 targets.  Normally the facilities of the machine's usual C compiler are
5867 used, but this cannot be done directly in cross-compilation.  You must make
5868 your own arrangements to provide suitable library functions for
5869 cross-compilation.
5870
5871 @option{-msoft-float} changes the calling convention in the output file;
5872 therefore, it is only useful if you compile @emph{all} of a program with
5873 this option.  In particular, you need to compile @file{libgcc.a}, the
5874 library that comes with GCC, with @option{-msoft-float} in order for
5875 this to work.
5876
5877 @item -mlittle-endian
5878 @opindex mlittle-endian
5879 Generate code for a processor running in little-endian mode.  This is
5880 the default for all standard configurations.
5881
5882 @item -mbig-endian
5883 @opindex mbig-endian
5884 Generate code for a processor running in big-endian mode; the default is
5885 to compile code for a little-endian processor.
5886
5887 @item -mwords-little-endian
5888 @opindex mwords-little-endian
5889 This option only applies when generating code for big-endian processors.
5890 Generate code for a little-endian word order but a big-endian byte
5891 order.  That is, a byte order of the form @samp{32107654}.  Note: this
5892 option should only be used if you require compatibility with code for
5893 big-endian ARM processors generated by versions of the compiler prior to
5894 2.8.
5895
5896 @item -malignment-traps
5897 @opindex malignment-traps
5898 Generate code that will not trap if the MMU has alignment traps enabled.
5899 On ARM architectures prior to ARMv4, there were no instructions to
5900 access half-word objects stored in memory.  However, when reading from
5901 memory a feature of the ARM architecture allows a word load to be used,
5902 even if the address is unaligned, and the processor core will rotate the
5903 data as it is being loaded.  This option tells the compiler that such
5904 misaligned accesses will cause a MMU trap and that it should instead
5905 synthesise the access as a series of byte accesses.  The compiler can
5906 still use word accesses to load half-word data if it knows that the
5907 address is aligned to a word boundary.
5908
5909 This option is ignored when compiling for ARM architecture 4 or later,
5910 since these processors have instructions to directly access half-word
5911 objects in memory.
5912
5913 @item -mno-alignment-traps
5914 @opindex mno-alignment-traps
5915 Generate code that assumes that the MMU will not trap unaligned
5916 accesses.  This produces better code when the target instruction set
5917 does not have half-word memory operations (i.e.@: implementations prior to
5918 ARMv4).
5919
5920 Note that you cannot use this option to access unaligned word objects,
5921 since the processor will only fetch one 32-bit aligned object from
5922 memory.
5923
5924 The default setting for most targets is @option{-mno-alignment-traps}, since
5925 this produces better code when there are no half-word memory
5926 instructions available.
5927
5928 @item -mshort-load-bytes
5929 @itemx -mno-short-load-words
5930 @opindex mshort-load-bytes
5931 @opindex mno-short-load-words
5932 These are deprecated aliases for @option{-malignment-traps}.
5933
5934 @item -mno-short-load-bytes
5935 @itemx -mshort-load-words
5936 @opindex mno-short-load-bytes
5937 @opindex mshort-load-words
5938 This are deprecated aliases for @option{-mno-alignment-traps}.
5939
5940 @item -mbsd
5941 @opindex mbsd
5942 This option only applies to RISC iX@.  Emulate the native BSD-mode
5943 compiler.  This is the default if @option{-ansi} is not specified.
5944
5945 @item -mxopen
5946 @opindex mxopen
5947 This option only applies to RISC iX@.  Emulate the native X/Open-mode
5948 compiler.
5949
5950 @item -mno-symrename
5951 @opindex mno-symrename
5952 This option only applies to RISC iX@.  Do not run the assembler
5953 post-processor, @samp{symrename}, after code has been assembled.
5954 Normally it is necessary to modify some of the standard symbols in
5955 preparation for linking with the RISC iX C library; this option
5956 suppresses this pass.  The post-processor is never run when the
5957 compiler is built for cross-compilation.
5958
5959 @item -mcpu=@var{name}
5960 @opindex mcpu
5961 This specifies the name of the target ARM processor.  GCC uses this name
5962 to determine what kind of instructions it can emit when generating
5963 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
5964 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
5965 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
5966 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
5967 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
5968 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
5969 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
5970 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
5971 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
5972 @samp{arm1020t}, @samp{xscale}.
5973
5974 @itemx -mtune=@var{name}
5975 @opindex mtune
5976 This option is very similar to the @option{-mcpu=} option, except that
5977 instead of specifying the actual target processor type, and hence
5978 restricting which instructions can be used, it specifies that GCC should
5979 tune the performance of the code as if the target were of the type
5980 specified in this option, but still choosing the instructions that it
5981 will generate based on the cpu specified by a @option{-mcpu=} option.
5982 For some ARM implementations better performance can be obtained by using
5983 this option.
5984
5985 @item -march=@var{name}
5986 @opindex march
5987 This specifies the name of the target ARM architecture.  GCC uses this
5988 name to determine what kind of instructions it can emit when generating
5989 assembly code.  This option can be used in conjunction with or instead
5990 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
5991 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
5992 @samp{armv5}, @samp{armv5t}, @samp{armv5te}.
5993
5994 @item -mfpe=@var{number}
5995 @itemx -mfp=@var{number}
5996 @opindex mfpe
5997 @opindex mfp
5998 This specifies the version of the floating point emulation available on
5999 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6000 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6001
6002 @item -mstructure-size-boundary=@var{n}
6003 @opindex mstructure-size-boundary
6004 The size of all structures and unions will be rounded up to a multiple
6005 of the number of bits set by this option.  Permissible values are 8 and
6006 32.  The default value varies for different toolchains.  For the COFF
6007 targeted toolchain the default value is 8.  Specifying the larger number
6008 can produce faster, more efficient code, but can also increase the size
6009 of the program.  The two values are potentially incompatible.  Code
6010 compiled with one value cannot necessarily expect to work with code or
6011 libraries compiled with the other value, if they exchange information
6012 using structures or unions.
6013
6014 @item -mabort-on-noreturn
6015 @opindex mabort-on-noreturn
6016 Generate a call to the function @code{abort} at the end of a
6017 @code{noreturn} function.  It will be executed if the function tries to
6018 return.
6019
6020 @item -mlong-calls
6021 @itemx -mno-long-calls
6022 @opindex mlong-calls
6023 @opindex mno-long-calls
6024 Tells the compiler to perform function calls by first loading the
6025 address of the function into a register and then performing a subroutine
6026 call on this register.  This switch is needed if the target function
6027 will lie outside of the 64 megabyte addressing range of the offset based
6028 version of subroutine call instruction.
6029
6030 Even if this switch is enabled, not all function calls will be turned
6031 into long calls.  The heuristic is that static functions, functions
6032 which have the @samp{short-call} attribute, functions that are inside
6033 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6034 definitions have already been compiled within the current compilation
6035 unit, will not be turned into long calls.  The exception to this rule is
6036 that weak function definitions, functions with the @samp{long-call}
6037 attribute or the @samp{section} attribute, and functions that are within
6038 the scope of a @samp{#pragma long_calls} directive, will always be
6039 turned into long calls.
6040
6041 This feature is not enabled by default.  Specifying
6042 @option{-mno-long-calls} will restore the default behaviour, as will
6043 placing the function calls within the scope of a @samp{#pragma
6044 long_calls_off} directive.  Note these switches have no effect on how
6045 the compiler generates code to handle function calls via function
6046 pointers.
6047
6048 @item -mnop-fun-dllimport
6049 @opindex mnop-fun-dllimport
6050 Disable support for the @code{dllimport} attribute.
6051
6052 @item -msingle-pic-base
6053 @opindex msingle-pic-base
6054 Treat the register used for PIC addressing as read-only, rather than
6055 loading it in the prologue for each function.  The run-time system is
6056 responsible for initialising this register with an appropriate value
6057 before execution begins.
6058
6059 @item -mpic-register=@var{reg}
6060 @opindex mpic-register
6061 Specify the register to be used for PIC addressing.  The default is R10
6062 unless stack-checking is enabled, when R9 is used.
6063
6064 @item -mpoke-function-name
6065 @opindex mpoke-function-name
6066 Write the name of each function into the text section, directly
6067 preceding the function prologue.  The generated code is similar to this:
6068
6069 @smallexample
6070      t0
6071          .ascii "arm_poke_function_name", 0
6072          .align
6073      t1
6074          .word 0xff000000 + (t1 - t0)
6075      arm_poke_function_name
6076          mov     ip, sp
6077          stmfd   sp!, @{fp, ip, lr, pc@}
6078          sub     fp, ip, #4
6079 @end smallexample
6080
6081 When performing a stack backtrace, code can inspect the value of
6082 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6083 location @code{pc - 12} and the top 8 bits are set, then we know that
6084 there is a function name embedded immediately preceding this location
6085 and has length @code{((pc[-3]) & 0xff000000)}.
6086
6087 @item -mthumb
6088 @opindex mthumb
6089 Generate code for the 16-bit Thumb instruction set.  The default is to
6090 use the 32-bit ARM instruction set.
6091
6092 @item -mtpcs-frame
6093 @opindex mtpcs-frame
6094 Generate a stack frame that is compliant with the Thumb Procedure Call
6095 Standard for all non-leaf functions.  (A leaf function is one that does
6096 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6097
6098 @item -mtpcs-leaf-frame
6099 @opindex mtpcs-leaf-frame
6100 Generate a stack frame that is compliant with the Thumb Procedure Call
6101 Standard for all leaf functions.  (A leaf function is one that does
6102 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6103
6104 @item -mcallee-super-interworking
6105 @opindex mcallee-super-interworking
6106 Gives all externally visible functions in the file being compiled an ARM
6107 instruction set header which switches to Thumb mode before executing the
6108 rest of the function.  This allows these functions to be called from
6109 non-interworking code.
6110
6111 @item -mcaller-super-interworking
6112 @opindex mcaller-super-interworking
6113 Allows calls via function pointers (including virtual functions) to
6114 execute correctly regardless of whether the target code has been
6115 compiled for interworking or not.  There is a small overhead in the cost
6116 of executing a function pointer if this option is enabled.
6117
6118 @end table
6119
6120 @node MN10200 Options
6121 @subsection MN10200 Options
6122 @cindex MN10200 options
6123 These @option{-m} options are defined for Matsushita MN10200 architectures:
6124 @table @gcctabopt
6125
6126 @item -mrelax
6127 @opindex mrelax
6128 Indicate to the linker that it should perform a relaxation optimization pass
6129 to shorten branches, calls and absolute memory addresses.  This option only
6130 has an effect when used on the command line for the final link step.
6131
6132 This option makes symbolic debugging impossible.
6133 @end table
6134
6135 @node MN10300 Options
6136 @subsection MN10300 Options
6137 @cindex MN10300 options
6138 These @option{-m} options are defined for Matsushita MN10300 architectures:
6139
6140 @table @gcctabopt
6141 @item -mmult-bug
6142 @opindex mmult-bug
6143 Generate code to avoid bugs in the multiply instructions for the MN10300
6144 processors.  This is the default.
6145
6146 @item -mno-mult-bug
6147 @opindex mno-mult-bug
6148 Do not generate code to avoid bugs in the multiply instructions for the
6149 MN10300 processors.
6150
6151 @item -mam33
6152 @opindex mam33
6153 Generate code which uses features specific to the AM33 processor.
6154
6155 @item -mno-am33
6156 @opindex mno-am33
6157 Do not generate code which uses features specific to the AM33 processor.  This
6158 is the default.
6159
6160 @item -mno-crt0
6161 @opindex mno-crt0
6162 Do not link in the C run-time initialization object file.
6163
6164 @item -mrelax
6165 @opindex mrelax
6166 Indicate to the linker that it should perform a relaxation optimization pass
6167 to shorten branches, calls and absolute memory addresses.  This option only
6168 has an effect when used on the command line for the final link step.
6169
6170 This option makes symbolic debugging impossible.
6171 @end table
6172
6173
6174 @node M32R/D Options
6175 @subsection M32R/D Options
6176 @cindex M32R/D options
6177
6178 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6179
6180 @table @gcctabopt
6181 @item -mcode-model=small
6182 @opindex mcode-model=small
6183 Assume all objects live in the lower 16MB of memory (so that their addresses
6184 can be loaded with the @code{ld24} instruction), and assume all subroutines
6185 are reachable with the @code{bl} instruction.
6186 This is the default.
6187
6188 The addressability of a particular object can be set with the
6189 @code{model} attribute.
6190
6191 @item -mcode-model=medium
6192 @opindex mcode-model=medium
6193 Assume objects may be anywhere in the 32-bit address space (the compiler
6194 will generate @code{seth/add3} instructions to load their addresses), and
6195 assume all subroutines are reachable with the @code{bl} instruction.
6196
6197 @item -mcode-model=large
6198 @opindex mcode-model=large
6199 Assume objects may be anywhere in the 32-bit address space (the compiler
6200 will generate @code{seth/add3} instructions to load their addresses), and
6201 assume subroutines may not be reachable with the @code{bl} instruction
6202 (the compiler will generate the much slower @code{seth/add3/jl}
6203 instruction sequence).
6204
6205 @item -msdata=none
6206 @opindex msdata=none
6207 Disable use of the small data area.  Variables will be put into
6208 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6209 @code{section} attribute has been specified).
6210 This is the default.
6211
6212 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6213 Objects may be explicitly put in the small data area with the
6214 @code{section} attribute using one of these sections.
6215
6216 @item -msdata=sdata
6217 @opindex msdata=sdata
6218 Put small global and static data in the small data area, but do not
6219 generate special code to reference them.
6220
6221 @item -msdata=use
6222 @opindex msdata=use
6223 Put small global and static data in the small data area, and generate
6224 special instructions to reference them.
6225
6226 @item -G @var{num}
6227 @opindex G
6228 @cindex smaller data references
6229 Put global and static objects less than or equal to @var{num} bytes
6230 into the small data or bss sections instead of the normal data or bss
6231 sections.  The default value of @var{num} is 8.
6232 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6233 for this option to have any effect.
6234
6235 All modules should be compiled with the same @option{-G @var{num}} value.
6236 Compiling with different values of @var{num} may or may not work; if it
6237 doesn't the linker will give an error message---incorrect code will not be
6238 generated.
6239
6240 @end table
6241
6242 @node M88K Options
6243 @subsection M88K Options
6244 @cindex M88k options
6245
6246 These @samp{-m} options are defined for Motorola 88k architectures:
6247
6248 @table @gcctabopt
6249 @item -m88000
6250 @opindex m88000
6251 Generate code that works well on both the m88100 and the
6252 m88110.
6253
6254 @item -m88100
6255 @opindex m88100
6256 Generate code that works best for the m88100, but that also
6257 runs on the m88110.
6258
6259 @item -m88110
6260 @opindex m88110
6261 Generate code that works best for the m88110, and may not run
6262 on the m88100.
6263
6264 @item -mbig-pic
6265 @opindex mbig-pic
6266 Obsolete option to be removed from the next revision.
6267 Use @option{-fPIC}.
6268
6269 @item -midentify-revision
6270 @opindex midentify-revision
6271 @cindex identifying source, compiler (88k)
6272 Include an @code{ident} directive in the assembler output recording the
6273 source file name, compiler name and version, timestamp, and compilation
6274 flags used.
6275
6276 @item -mno-underscores
6277 @opindex mno-underscores
6278 @cindex underscores, avoiding (88k)
6279 In assembler output, emit symbol names without adding an underscore
6280 character at the beginning of each name.  The default is to use an
6281 underscore as prefix on each name.
6282
6283 @item -mocs-debug-info
6284 @itemx -mno-ocs-debug-info
6285 @opindex mocs-debug-info
6286 @opindex mno-ocs-debug-info
6287 @cindex OCS (88k)
6288 @cindex debugging, 88k OCS
6289 Include (or omit) additional debugging information (about registers used
6290 in each stack frame) as specified in the 88open Object Compatibility
6291 Standard, ``OCS''@.  This extra information allows debugging of code that
6292 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
6293 Delta 88 SVr3.2 is to include this information; other 88k configurations
6294 omit this information by default.
6295
6296 @item -mocs-frame-position
6297 @opindex mocs-frame-position
6298 @cindex register positions in frame (88k)
6299 When emitting COFF debugging information for automatic variables and
6300 parameters stored on the stack, use the offset from the canonical frame
6301 address, which is the stack pointer (register 31) on entry to the
6302 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
6303 @option{-mocs-frame-position}; other 88k configurations have the default
6304 @option{-mno-ocs-frame-position}.
6305
6306 @item -mno-ocs-frame-position
6307 @opindex mno-ocs-frame-position
6308 @cindex register positions in frame (88k)
6309 When emitting COFF debugging information for automatic variables and
6310 parameters stored on the stack, use the offset from the frame pointer
6311 register (register 30).  When this option is in effect, the frame
6312 pointer is not eliminated when debugging information is selected by the
6313 -g switch.
6314
6315 @item -moptimize-arg-area
6316 @opindex moptimize-arg-area
6317 @cindex arguments in frame (88k)
6318 Save space by reorganizing the stack frame.  This option generates code
6319 that does not agree with the 88open specifications, but uses less
6320 memory.
6321
6322 @itemx -mno-optimize-arg-area
6323 @opindex mno-optimize-arg-area
6324 Do not reorganize the stack frame to save space.  This is the default.
6325 The generated conforms to the specification, but uses more memory.
6326
6327 @item -mshort-data-@var{num}
6328 @opindex mshort-data
6329 @cindex smaller data references (88k)
6330 @cindex r0-relative references (88k)
6331 Generate smaller data references by making them relative to @code{r0},
6332 which allows loading a value using a single instruction (rather than the
6333 usual two).  You control which data references are affected by
6334 specifying @var{num} with this option.  For example, if you specify
6335 @option{-mshort-data-512}, then the data references affected are those
6336 involving displacements of less than 512 bytes.
6337 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6338 than 64k.
6339
6340 @item -mserialize-volatile
6341 @opindex mserialize-volatile
6342 @itemx -mno-serialize-volatile
6343 @opindex mno-serialize-volatile
6344 @cindex sequential consistency on 88k
6345 Do, or don't, generate code to guarantee sequential consistency
6346 of volatile memory references.  By default, consistency is
6347 guaranteed.
6348
6349 The order of memory references made by the MC88110 processor does
6350 not always match the order of the instructions requesting those
6351 references.  In particular, a load instruction may execute before
6352 a preceding store instruction.  Such reordering violates
6353 sequential consistency of volatile memory references, when there
6354 are multiple processors.   When consistency must be guaranteed,
6355 GCC generates special instructions, as needed, to force
6356 execution in the proper order.
6357
6358 The MC88100 processor does not reorder memory references and so
6359 always provides sequential consistency.  However, by default, GCC
6360 generates the special instructions to guarantee consistency
6361 even when you use @option{-m88100}, so that the code may be run on an
6362 MC88110 processor.  If you intend to run your code only on the
6363 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6364
6365 The extra code generated to guarantee consistency may affect the
6366 performance of your application.  If you know that you can safely
6367 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6368
6369 @item -msvr4
6370 @itemx -msvr3
6371 @opindex msvr4
6372 @opindex msvr3
6373 @cindex assembler syntax, 88k
6374 @cindex SVr4
6375 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6376 related to System V release 4 (SVr4).  This controls the following:
6377
6378 @enumerate
6379 @item
6380 Which variant of the assembler syntax to emit.
6381 @item
6382 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6383 that is used on System V release 4.
6384 @item
6385 @option{-msvr4} makes GCC issue additional declaration directives used in
6386 SVr4.
6387 @end enumerate
6388
6389 @option{-msvr4} is the default for the m88k-motorola-sysv4 and
6390 m88k-dg-dgux m88k configurations.  @option{-msvr3} is the default for all
6391 other m88k configurations.
6392
6393 @item -mversion-03.00
6394 @opindex mversion-03.00
6395 This option is obsolete, and is ignored.
6396 @c ??? which asm syntax better for GAS?  option there too?
6397
6398 @item -mno-check-zero-division
6399 @itemx -mcheck-zero-division
6400 @opindex mno-check-zero-division
6401 @opindex mcheck-zero-division
6402 @cindex zero division on 88k
6403 Do, or don't, generate code to guarantee that integer division by
6404 zero will be detected.  By default, detection is guaranteed.
6405
6406 Some models of the MC88100 processor fail to trap upon integer
6407 division by zero under certain conditions.  By default, when
6408 compiling code that might be run on such a processor, GCC
6409 generates code that explicitly checks for zero-valued divisors
6410 and traps with exception number 503 when one is detected.  Use of
6411 @option{-mno-check-zero-division} suppresses such checking for code
6412 generated to run on an MC88100 processor.
6413
6414 GCC assumes that the MC88110 processor correctly detects all instances
6415 of integer division by zero.  When @option{-m88110} is specified, no
6416 explicit checks for zero-valued divisors are generated, and both
6417 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6418 ignored.
6419
6420 @item -muse-div-instruction
6421 @opindex muse-div-instruction
6422 @cindex divide instruction, 88k
6423 Use the div instruction for signed integer division on the
6424 MC88100 processor.  By default, the div instruction is not used.
6425
6426 On the MC88100 processor the signed integer division instruction
6427 div) traps to the operating system on a negative operand.  The
6428 operating system transparently completes the operation, but at a
6429 large cost in execution time.  By default, when compiling code
6430 that might be run on an MC88100 processor, GCC emulates signed
6431 integer division using the unsigned integer division instruction
6432 divu), thereby avoiding the large penalty of a trap to the
6433 operating system.  Such emulation has its own, smaller, execution
6434 cost in both time and space.  To the extent that your code's
6435 important signed integer division operations are performed on two
6436 nonnegative operands, it may be desirable to use the div
6437 instruction directly.
6438
6439 On the MC88110 processor the div instruction (also known as the
6440 divs instruction) processes negative operands without trapping to
6441 the operating system.  When @option{-m88110} is specified,
6442 @option{-muse-div-instruction} is ignored, and the div instruction is used
6443 for signed integer division.
6444
6445 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6446 particular, the behavior of such a division with and without
6447 @option{-muse-div-instruction} may differ.
6448
6449 @item -mtrap-large-shift
6450 @itemx -mhandle-large-shift
6451 @opindex mtrap-large-shift
6452 @opindex mhandle-large-shift
6453 @cindex bit shift overflow (88k)
6454 @cindex large bit shifts (88k)
6455 Include code to detect bit-shifts of more than 31 bits; respectively,
6456 trap such shifts or emit code to handle them properly.  By default GCC
6457 makes no special provision for large bit shifts.
6458
6459 @item -mwarn-passed-structs
6460 @opindex mwarn-passed-structs
6461 @cindex structure passing (88k)
6462 Warn when a function passes a struct as an argument or result.
6463 Structure-passing conventions have changed during the evolution of the C
6464 language, and are often the source of portability problems.  By default,
6465 GCC issues no such warning.
6466 @end table
6467
6468 @c break page here to avoid unsightly interparagraph stretch.
6469 @c -zw, 2001-8-17
6470 @page
6471
6472 @node RS/6000 and PowerPC Options
6473 @subsection IBM RS/6000 and PowerPC Options
6474 @cindex RS/6000 and PowerPC Options
6475 @cindex IBM RS/6000 and PowerPC Options
6476
6477 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6478 @table @gcctabopt
6479 @item -mpower
6480 @itemx -mno-power
6481 @itemx -mpower2
6482 @itemx -mno-power2
6483 @itemx -mpowerpc
6484 @itemx -mno-powerpc
6485 @itemx -mpowerpc-gpopt
6486 @itemx -mno-powerpc-gpopt
6487 @itemx -mpowerpc-gfxopt
6488 @itemx -mno-powerpc-gfxopt
6489 @itemx -mpowerpc64
6490 @itemx -mno-powerpc64
6491 @opindex mpower
6492 @opindex mno-power
6493 @opindex mpower2
6494 @opindex mno-power2
6495 @opindex mpowerpc
6496 @opindex mno-powerpc
6497 @opindex mpowerpc-gpopt
6498 @opindex mno-powerpc-gpopt
6499 @opindex mpowerpc-gfxopt
6500 @opindex mno-powerpc-gfxopt
6501 @opindex mpowerpc64
6502 @opindex mno-powerpc64
6503 GCC supports two related instruction set architectures for the
6504 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6505 instructions supported by the @samp{rios} chip set used in the original
6506 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6507 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6508 the IBM 4xx microprocessors.
6509
6510 Neither architecture is a subset of the other.  However there is a
6511 large common subset of instructions supported by both.  An MQ
6512 register is included in processors supporting the POWER architecture.
6513
6514 You use these options to specify which instructions are available on the
6515 processor you are using.  The default value of these options is
6516 determined when configuring GCC@.  Specifying the
6517 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6518 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6519 rather than the options listed above.
6520
6521 The @option{-mpower} option allows GCC to generate instructions that
6522 are found only in the POWER architecture and to use the MQ register.
6523 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6524 to generate instructions that are present in the POWER2 architecture but
6525 not the original POWER architecture.
6526
6527 The @option{-mpowerpc} option allows GCC to generate instructions that
6528 are found only in the 32-bit subset of the PowerPC architecture.
6529 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6530 GCC to use the optional PowerPC architecture instructions in the
6531 General Purpose group, including floating-point square root.  Specifying
6532 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6533 use the optional PowerPC architecture instructions in the Graphics
6534 group, including floating-point select.
6535
6536 The @option{-mpowerpc64} option allows GCC to generate the additional
6537 64-bit instructions that are found in the full PowerPC64 architecture
6538 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6539 @option{-mno-powerpc64}.
6540
6541 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6542 will use only the instructions in the common subset of both
6543 architectures plus some special AIX common-mode calls, and will not use
6544 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6545 permits GCC to use any instruction from either architecture and to
6546 allow use of the MQ register; specify this for the Motorola MPC601.
6547
6548 @item -mnew-mnemonics
6549 @itemx -mold-mnemonics
6550 @opindex mnew-mnemonics
6551 @opindex mold-mnemonics
6552 Select which mnemonics to use in the generated assembler code.  With
6553 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6554 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6555 assembler mnemonics defined for the POWER architecture.  Instructions
6556 defined in only one architecture have only one mnemonic; GCC uses that
6557 mnemonic irrespective of which of these options is specified.
6558
6559 GCC defaults to the mnemonics appropriate for the architecture in
6560 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6561 value of these option.  Unless you are building a cross-compiler, you
6562 should normally not specify either @option{-mnew-mnemonics} or
6563 @option{-mold-mnemonics}, but should instead accept the default.
6564
6565 @item -mcpu=@var{cpu_type}
6566 @opindex mcpu
6567 Set architecture type, register usage, choice of mnemonics, and
6568 instruction scheduling parameters for machine type @var{cpu_type}.
6569 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6570 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6571 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6572 @samp{630}, @samp{740}, @samp{750}, @samp{power}, @samp{power2},
6573 @samp{powerpc}, @samp{403}, @samp{505}, @samp{801}, @samp{821},
6574 @samp{823}, and @samp{860} and @samp{common}.
6575
6576 @option{-mcpu=common} selects a completely generic processor.  Code
6577 generated under this option will run on any POWER or PowerPC processor.
6578 GCC will use only the instructions in the common subset of both
6579 architectures, and will not use the MQ register.  GCC assumes a generic
6580 processor model for scheduling purposes.
6581
6582 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6583 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6584 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6585 types, with an appropriate, generic processor model assumed for
6586 scheduling purposes.
6587
6588 The other options specify a specific processor.  Code generated under
6589 those options will run best on that processor, and may not run at all on
6590 others.
6591
6592 The @option{-mcpu} options automatically enable or disable other
6593 @option{-m} options as follows:
6594
6595 @table @samp
6596 @item common
6597 @option{-mno-power}, @option{-mno-powerc}
6598
6599 @item power
6600 @itemx power2
6601 @itemx rios1
6602 @itemx rios2
6603 @itemx rsc
6604 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6605
6606 @item powerpc
6607 @itemx rs64a
6608 @itemx 602
6609 @itemx 603
6610 @itemx 603e
6611 @itemx 604
6612 @itemx 620
6613 @itemx 630
6614 @itemx 740
6615 @itemx 750
6616 @itemx 505
6617 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6618
6619 @item 601
6620 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6621
6622 @item 403
6623 @itemx 821
6624 @itemx 860
6625 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6626 @end table
6627
6628 @item -mtune=@var{cpu_type}
6629 @opindex mtune
6630 Set the instruction scheduling parameters for machine type
6631 @var{cpu_type}, but do not set the architecture type, register usage, or
6632 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6633 values for @var{cpu_type} are used for @option{-mtune} as for
6634 @option{-mcpu}.  If both are specified, the code generated will use the
6635 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6636 scheduling parameters set by @option{-mtune}.
6637
6638 @item -mfull-toc
6639 @itemx -mno-fp-in-toc
6640 @itemx -mno-sum-in-toc
6641 @itemx -mminimal-toc
6642 @opindex mfull-toc
6643 @opindex mno-fp-in-toc
6644 @opindex mno-sum-in-toc
6645 @opindex mminimal-toc
6646 Modify generation of the TOC (Table Of Contents), which is created for
6647 every executable file.  The @option{-mfull-toc} option is selected by
6648 default.  In that case, GCC will allocate at least one TOC entry for
6649 each unique non-automatic variable reference in your program.  GCC
6650 will also place floating-point constants in the TOC@.  However, only
6651 16,384 entries are available in the TOC@.
6652
6653 If you receive a linker error message that saying you have overflowed
6654 the available TOC space, you can reduce the amount of TOC space used
6655 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
6656 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
6657 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
6658 generate code to calculate the sum of an address and a constant at
6659 run-time instead of putting that sum into the TOC@.  You may specify one
6660 or both of these options.  Each causes GCC to produce very slightly
6661 slower and larger code at the expense of conserving TOC space.
6662
6663 If you still run out of space in the TOC even when you specify both of
6664 these options, specify @option{-mminimal-toc} instead.  This option causes
6665 GCC to make only one TOC entry for every file.  When you specify this
6666 option, GCC will produce code that is slower and larger but which
6667 uses extremely little TOC space.  You may wish to use this option
6668 only on files that contain less frequently executed code.
6669
6670 @item -maix64
6671 @itemx -maix32
6672 @opindex maix64
6673 @opindex maix32
6674 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6675 @code{long} type, and the infrastructure needed to support them.
6676 Specifying @option{-maix64} implies @option{-mpowerpc64} and
6677 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
6678 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
6679
6680 @item -mxl-call
6681 @itemx -mno-xl-call
6682 @opindex mxl-call
6683 @opindex mno-xl-call
6684 On AIX, pass floating-point arguments to prototyped functions beyond the
6685 register save area (RSA) on the stack in addition to argument FPRs.  The
6686 AIX calling convention was extended but not initially documented to
6687 handle an obscure K&R C case of calling a function that takes the
6688 address of its arguments with fewer arguments than declared.  AIX XL
6689 compilers access floating point arguments which do not fit in the
6690 RSA from the stack when a subroutine is compiled without
6691 optimization.  Because always storing floating-point arguments on the
6692 stack is inefficient and rarely needed, this option is not enabled by
6693 default and only is necessary when calling subroutines compiled by AIX
6694 XL compilers without optimization.
6695
6696 @item -mthreads
6697 @opindex mthreads
6698 Support @dfn{AIX Threads}.  Link an application written to use
6699 @dfn{pthreads} with special libraries and startup code to enable the
6700 application to run.
6701
6702 @item -mpe
6703 @opindex mpe
6704 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
6705 application written to use message passing with special startup code to
6706 enable the application to run.  The system must have PE installed in the
6707 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6708 must be overridden with the @option{-specs=} option to specify the
6709 appropriate directory location.  The Parallel Environment does not
6710 support threads, so the @option{-mpe} option and the @option{-mthreads}
6711 option are incompatible.
6712
6713 @item -msoft-float
6714 @itemx -mhard-float
6715 @opindex msoft-float
6716 @opindex mhard-float
6717 Generate code that does not use (uses) the floating-point register set.
6718 Software floating point emulation is provided if you use the
6719 @option{-msoft-float} option, and pass the option to GCC when linking.
6720
6721 @item -mmultiple
6722 @itemx -mno-multiple
6723 @opindex mmultiple
6724 @opindex mno-multiple
6725 Generate code that uses (does not use) the load multiple word
6726 instructions and the store multiple word instructions.  These
6727 instructions are generated by default on POWER systems, and not
6728 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
6729 endian PowerPC systems, since those instructions do not work when the
6730 processor is in little endian mode.  The exceptions are PPC740 and
6731 PPC750 which permit the instructions usage in little endian mode.
6732
6733 @item -mstring
6734 @itemx -mno-string
6735 @opindex mstring
6736 @opindex mno-string
6737 Generate code that uses (does not use) the load string instructions
6738 and the store string word instructions to save multiple registers and
6739 do small block moves.  These instructions are generated by default on
6740 POWER systems, and not generated on PowerPC systems.  Do not use
6741 @option{-mstring} on little endian PowerPC systems, since those
6742 instructions do not work when the processor is in little endian mode.
6743 The exceptions are PPC740 and PPC750 which permit the instructions
6744 usage in little endian mode.
6745
6746 @item -mupdate
6747 @itemx -mno-update
6748 @opindex mupdate
6749 @opindex mno-update
6750 Generate code that uses (does not use) the load or store instructions
6751 that update the base register to the address of the calculated memory
6752 location.  These instructions are generated by default.  If you use
6753 @option{-mno-update}, there is a small window between the time that the
6754 stack pointer is updated and the address of the previous frame is
6755 stored, which means code that walks the stack frame across interrupts or
6756 signals may get corrupted data.
6757
6758 @item -mfused-madd
6759 @itemx -mno-fused-madd
6760 @opindex mfused-madd
6761 @opindex mno-fused-madd
6762 Generate code that uses (does not use) the floating point multiply and
6763 accumulate instructions.  These instructions are generated by default if
6764 hardware floating is used.
6765
6766 @item -mno-bit-align
6767 @itemx -mbit-align
6768 @opindex mno-bit-align
6769 @opindex mbit-align
6770 On System V.4 and embedded PowerPC systems do not (do) force structures
6771 and unions that contain bit-fields to be aligned to the base type of the
6772 bit-field.
6773
6774 For example, by default a structure containing nothing but 8
6775 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
6776 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
6777 the structure would be aligned to a 1 byte boundary and be one byte in
6778 size.
6779
6780 @item -mno-strict-align
6781 @itemx -mstrict-align
6782 @opindex mno-strict-align
6783 @opindex mstrict-align
6784 On System V.4 and embedded PowerPC systems do not (do) assume that
6785 unaligned memory references will be handled by the system.
6786
6787 @item -mrelocatable
6788 @itemx -mno-relocatable
6789 @opindex mrelocatable
6790 @opindex mno-relocatable
6791 On embedded PowerPC systems generate code that allows (does not allow)
6792 the program to be relocated to a different address at runtime.  If you
6793 use @option{-mrelocatable} on any module, all objects linked together must
6794 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
6795
6796 @item -mrelocatable-lib
6797 @itemx -mno-relocatable-lib
6798 @opindex mrelocatable-lib
6799 @opindex mno-relocatable-lib
6800 On embedded PowerPC systems generate code that allows (does not allow)
6801 the program to be relocated to a different address at runtime.  Modules
6802 compiled with @option{-mrelocatable-lib} can be linked with either modules
6803 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
6804 with modules compiled with the @option{-mrelocatable} options.
6805
6806 @item -mno-toc
6807 @itemx -mtoc
6808 @opindex mno-toc
6809 @opindex mtoc
6810 On System V.4 and embedded PowerPC systems do not (do) assume that
6811 register 2 contains a pointer to a global area pointing to the addresses
6812 used in the program.
6813
6814 @item -mlittle
6815 @itemx -mlittle-endian
6816 @opindex mlittle
6817 @opindex mlittle-endian
6818 On System V.4 and embedded PowerPC systems compile code for the
6819 processor in little endian mode.  The @option{-mlittle-endian} option is
6820 the same as @option{-mlittle}.
6821
6822 @item -mbig
6823 @itemx -mbig-endian
6824 @opindex mbig
6825 @opindex mbig-endian
6826 On System V.4 and embedded PowerPC systems compile code for the
6827 processor in big endian mode.  The @option{-mbig-endian} option is
6828 the same as @option{-mbig}.
6829
6830 @item -mcall-sysv
6831 @opindex mcall-sysv
6832 On System V.4 and embedded PowerPC systems compile code using calling
6833 conventions that adheres to the March 1995 draft of the System V
6834 Application Binary Interface, PowerPC processor supplement.  This is the
6835 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6836
6837 @item -mcall-sysv-eabi
6838 @opindex mcall-sysv-eabi
6839 Specify both @option{-mcall-sysv} and @option{-meabi} options.
6840
6841 @item -mcall-sysv-noeabi
6842 @opindex mcall-sysv-noeabi
6843 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
6844
6845 @item -mcall-aix
6846 @opindex mcall-aix
6847 On System V.4 and embedded PowerPC systems compile code using calling
6848 conventions that are similar to those used on AIX@.  This is the
6849 default if you configured GCC using @samp{powerpc-*-eabiaix}.
6850
6851 @item -mcall-solaris
6852 @opindex mcall-solaris
6853 On System V.4 and embedded PowerPC systems compile code for the Solaris
6854 operating system.
6855
6856 @item -mcall-linux
6857 @opindex mcall-linux
6858 On System V.4 and embedded PowerPC systems compile code for the
6859 Linux-based GNU system.
6860
6861 @item -mcall-netbsd
6862 @opindex mcall-netbsd
6863 On System V.4 and embedded PowerPC systems compile code for the
6864 NetBSD operating system.
6865
6866 @item -mprototype
6867 @itemx -mno-prototype
6868 @opindex mprototype
6869 @opindex mno-prototype
6870 On System V.4 and embedded PowerPC systems assume that all calls to
6871 variable argument functions are properly prototyped.  Otherwise, the
6872 compiler must insert an instruction before every non prototyped call to
6873 set or clear bit 6 of the condition code register (@var{CR}) to
6874 indicate whether floating point values were passed in the floating point
6875 registers in case the function takes a variable arguments.  With
6876 @option{-mprototype}, only calls to prototyped variable argument functions
6877 will set or clear the bit.
6878
6879 @item -msim
6880 @opindex msim
6881 On embedded PowerPC systems, assume that the startup module is called
6882 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6883 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
6884 configurations.
6885
6886 @item -mmvme
6887 @opindex mmvme
6888 On embedded PowerPC systems, assume that the startup module is called
6889 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6890 @file{libc.a}.
6891
6892 @item -mads
6893 @opindex mads
6894 On embedded PowerPC systems, assume that the startup module is called
6895 @file{crt0.o} and the standard C libraries are @file{libads.a} and
6896 @file{libc.a}.
6897
6898 @item -myellowknife
6899 @opindex myellowknife
6900 On embedded PowerPC systems, assume that the startup module is called
6901 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
6902 @file{libc.a}.
6903
6904 @item -mvxworks
6905 @opindex mvxworks
6906 On System V.4 and embedded PowerPC systems, specify that you are
6907 compiling for a VxWorks system.
6908
6909 @item -memb
6910 @opindex memb
6911 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
6912 header to indicate that @samp{eabi} extended relocations are used.
6913
6914 @item -meabi
6915 @itemx -mno-eabi
6916 @opindex meabi
6917 @opindex mno-eabi
6918 On System V.4 and embedded PowerPC systems do (do not) adhere to the
6919 Embedded Applications Binary Interface (eabi) which is a set of
6920 modifications to the System V.4 specifications.  Selecting @option{-meabi}
6921 means that the stack is aligned to an 8 byte boundary, a function
6922 @code{__eabi} is called to from @code{main} to set up the eabi
6923 environment, and the @option{-msdata} option can use both @code{r2} and
6924 @code{r13} to point to two separate small data areas.  Selecting
6925 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
6926 do not call an initialization function from @code{main}, and the
6927 @option{-msdata} option will only use @code{r13} to point to a single
6928 small data area.  The @option{-meabi} option is on by default if you
6929 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
6930
6931 @item -msdata=eabi
6932 @opindex msdata=eabi
6933 On System V.4 and embedded PowerPC systems, put small initialized
6934 @code{const} global and static data in the @samp{.sdata2} section, which
6935 is pointed to by register @code{r2}.  Put small initialized
6936 non-@code{const} global and static data in the @samp{.sdata} section,
6937 which is pointed to by register @code{r13}.  Put small uninitialized
6938 global and static data in the @samp{.sbss} section, which is adjacent to
6939 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
6940 incompatible with the @option{-mrelocatable} option.  The
6941 @option{-msdata=eabi} option also sets the @option{-memb} option.
6942
6943 @item -msdata=sysv
6944 @opindex msdata=sysv
6945 On System V.4 and embedded PowerPC systems, put small global and static
6946 data in the @samp{.sdata} section, which is pointed to by register
6947 @code{r13}.  Put small uninitialized global and static data in the
6948 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
6949 The @option{-msdata=sysv} option is incompatible with the
6950 @option{-mrelocatable} option.
6951
6952 @item -msdata=default
6953 @itemx -msdata
6954 @opindex msdata=default
6955 @opindex msdata
6956 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
6957 compile code the same as @option{-msdata=eabi}, otherwise compile code the
6958 same as @option{-msdata=sysv}.
6959
6960 @item -msdata-data
6961 @opindex msdata-data
6962 On System V.4 and embedded PowerPC systems, put small global and static
6963 data in the @samp{.sdata} section.  Put small uninitialized global and
6964 static data in the @samp{.sbss} section.  Do not use register @code{r13}
6965 to address small data however.  This is the default behavior unless
6966 other @option{-msdata} options are used.
6967
6968 @item -msdata=none
6969 @itemx -mno-sdata
6970 @opindex msdata=none
6971 @opindex mno-sdata
6972 On embedded PowerPC systems, put all initialized global and static data
6973 in the @samp{.data} section, and all uninitialized data in the
6974 @samp{.bss} section.
6975
6976 @item -G @var{num}
6977 @opindex G
6978 @cindex smaller data references (PowerPC)
6979 @cindex .sdata/.sdata2 references (PowerPC)
6980 On embedded PowerPC systems, put global and static items less than or
6981 equal to @var{num} bytes into the small data or bss sections instead of
6982 the normal data or bss section.  By default, @var{num} is 8.  The
6983 @option{-G @var{num}} switch is also passed to the linker.
6984 All modules should be compiled with the same @option{-G @var{num}} value.
6985
6986 @item -mregnames
6987 @itemx -mno-regnames
6988 @opindex mregnames
6989 @opindex mno-regnames
6990 On System V.4 and embedded PowerPC systems do (do not) emit register
6991 names in the assembly language output using symbolic forms.
6992
6993 @end table
6994
6995 @node RT Options
6996 @subsection IBM RT Options
6997 @cindex RT options
6998 @cindex IBM RT options
6999
7000 These @samp{-m} options are defined for the IBM RT PC:
7001
7002 @table @gcctabopt
7003 @item -min-line-mul
7004 @opindex min-line-mul
7005 Use an in-line code sequence for integer multiplies.  This is the
7006 default.
7007
7008 @item -mcall-lib-mul
7009 @opindex mcall-lib-mul
7010 Call @code{lmul$$} for integer multiples.
7011
7012 @item -mfull-fp-blocks
7013 @opindex mfull-fp-blocks
7014 Generate full-size floating point data blocks, including the minimum
7015 amount of scratch space recommended by IBM@.  This is the default.
7016
7017 @item -mminimum-fp-blocks
7018 @opindex mminimum-fp-blocks
7019 Do not include extra scratch space in floating point data blocks.  This
7020 results in smaller code, but slower execution, since scratch space must
7021 be allocated dynamically.
7022
7023 @cindex @file{varargs.h} and RT PC
7024 @cindex @file{stdarg.h} and RT PC
7025 @item -mfp-arg-in-fpregs
7026 @opindex mfp-arg-in-fpregs
7027 Use a calling sequence incompatible with the IBM calling convention in
7028 which floating point arguments are passed in floating point registers.
7029 Note that @code{varargs.h} and @code{stdarg.h} will not work with
7030 floating point operands if this option is specified.
7031
7032 @item -mfp-arg-in-gregs
7033 @opindex mfp-arg-in-gregs
7034 Use the normal calling convention for floating point arguments.  This is
7035 the default.
7036
7037 @item -mhc-struct-return
7038 @opindex mhc-struct-return
7039 Return structures of more than one word in memory, rather than in a
7040 register.  This provides compatibility with the MetaWare HighC (hc)
7041 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7042 with the Portable C Compiler (pcc).
7043
7044 @item -mnohc-struct-return
7045 @opindex mnohc-struct-return
7046 Return some structures of more than one word in registers, when
7047 convenient.  This is the default.  For compatibility with the
7048 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7049 option @option{-mhc-struct-return}.
7050 @end table
7051
7052 @node MIPS Options
7053 @subsection MIPS Options
7054 @cindex MIPS options
7055
7056 These @samp{-m} options are defined for the MIPS family of computers:
7057
7058 @table @gcctabopt
7059
7060 @item -march=@var{cpu-type}
7061 @opindex march
7062 Assume the defaults for the machine type @var{cpu-type} when generating
7063 instructions.  The choices for @var{cpu-type} are  @samp{r2000}, @samp{r3000},
7064 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
7065 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
7066 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
7067 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
7068 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.
7069
7070 @item -mtune=@var{cpu-type}
7071 @opindex mtune
7072 Assume the defaults for the machine type @var{cpu-type} when scheduling
7073 instructions.  The choices for @var{cpu-type} are @samp{r2000}, @samp{r3000},
7074 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
7075 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
7076 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
7077 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
7078 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.  While picking a specific
7079 @var{cpu-type} will schedule things appropriately for that particular
7080 chip, the compiler will not generate any code that does not meet level 1
7081 of the MIPS ISA (instruction set architecture) without a @option{-mipsX}
7082 or @option{-mabi} switch being used.
7083
7084 @item -mcpu=@var{cpu-type}
7085 @opindex mcpu
7086 This is identical to specifying both @option{-march} and @option{-mtune}.
7087
7088 @item -mips1
7089 @opindex mips1
7090 Issue instructions from level 1 of the MIPS ISA@.  This is the default.
7091 @samp{r3000} is the default @var{cpu-type} at this ISA level.
7092
7093 @item -mips2
7094 @opindex mips2
7095 Issue instructions from level 2 of the MIPS ISA (branch likely, square
7096 root instructions).  @samp{r6000} is the default @var{cpu-type} at this
7097 ISA level.
7098
7099 @item -mips3
7100 @opindex mips3
7101 Issue instructions from level 3 of the MIPS ISA (64-bit instructions).
7102 @samp{r4000} is the default @var{cpu-type} at this ISA level.
7103
7104 @item -mips4
7105 @opindex mips4
7106 Issue instructions from level 4 of the MIPS ISA (conditional move,
7107 prefetch, enhanced FPU instructions).  @samp{r8000} is the default
7108 @var{cpu-type} at this ISA level.
7109
7110 @item -mfp32
7111 @opindex mfp32
7112 Assume that 32 32-bit floating point registers are available.  This is
7113 the default.
7114
7115 @item -mfp64
7116 @opindex mfp64
7117 Assume that 32 64-bit floating point registers are available.  This is
7118 the default when the @option{-mips3} option is used.
7119
7120 @item -mfused-madd
7121 @itemx -mno-fused-madd
7122 @opindex mfused-madd
7123 @opindex mno-fused-madd
7124 Generate code that uses (does not use) the floating point multiply and
7125 accumulate instructions, when they are available.  These instructions
7126 are generated by default if they are available, but this may be
7127 undesirable if the extra precision causes problems or on certain chips
7128 in the mode where denormals are rounded to zero where denormals
7129 generated by multiply and accumulate instructions cause exceptions
7130 anyway.
7131
7132 @item -mgp32
7133 @opindex mgp32
7134 Assume that 32 32-bit general purpose registers are available.  This is
7135 the default.
7136
7137 @item -mgp64
7138 @opindex mgp64
7139 Assume that 32 64-bit general purpose registers are available.  This is
7140 the default when the @option{-mips3} option is used.
7141
7142 @item -mint64
7143 @opindex mint64
7144 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7145 explanation of the default, and the width of pointers.
7146
7147 @item -mlong64
7148 @opindex mlong64
7149 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7150 explanation of the default, and the width of pointers.
7151
7152 @item -mlong32
7153 @opindex mlong32
7154 Force long, int, and pointer types to be 32 bits wide.
7155
7156 If none of @option{-mlong32}, @option{-mlong64}, or @option{-mint64} are set,
7157 the size of ints, longs, and pointers depends on the ABI and ISA chosen.
7158 For @option{-mabi=32}, and @option{-mabi=n32}, ints and longs are 32 bits
7159 wide.  For @option{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
7160 For @option{-mabi=eabi} and either @option{-mips1} or @option{-mips2}, ints
7161 and longs are 32 bits wide.  For @option{-mabi=eabi} and higher ISAs, ints
7162 are 32 bits, and longs are 64 bits wide.  The width of pointer types is
7163 the smaller of the width of longs or the width of general purpose
7164 registers (which in turn depends on the ISA)@.
7165
7166 @item -mabi=32
7167 @itemx -mabi=o64
7168 @itemx -mabi=n32
7169 @itemx -mabi=64
7170 @itemx -mabi=eabi
7171 @opindex mabi=32
7172 @opindex mabi=o64
7173 @opindex mabi=n32
7174 @opindex mabi=64
7175 @opindex mabi=eabi
7176 Generate code for the indicated ABI@.  The default instruction level is
7177 @option{-mips1} for @samp{32}, @option{-mips3} for @samp{n32}, and
7178 @option{-mips4} otherwise.  Conversely, with @option{-mips1} or
7179 @option{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
7180 is @samp{64}.
7181
7182 @item -mmips-as
7183 @opindex mmips-as
7184 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7185 add normal debug information.  This is the default for all
7186 platforms except for the OSF/1 reference platform, using the OSF/rose
7187 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7188 switches are used, the @file{mips-tfile} program will encapsulate the
7189 stabs within MIPS ECOFF@.
7190
7191 @item -mgas
7192 @opindex mgas
7193 Generate code for the GNU assembler.  This is the default on the OSF/1
7194 reference platform, using the OSF/rose object format.  Also, this is
7195 the default if the configure option @option{--with-gnu-as} is used.
7196
7197 @item -msplit-addresses
7198 @itemx -mno-split-addresses
7199 @opindex msplit-addresses
7200 @opindex mno-split-addresses
7201 Generate code to load the high and low parts of address constants separately.
7202 This allows GCC to optimize away redundant loads of the high order
7203 bits of addresses.  This optimization requires GNU as and GNU ld.
7204 This optimization is enabled by default for some embedded targets where
7205 GNU as and GNU ld are standard.
7206
7207 @item -mrnames
7208 @itemx -mno-rnames
7209 @opindex mrnames
7210 @opindex mno-rnames
7211 The @option{-mrnames} switch says to output code using the MIPS software
7212 names for the registers, instead of the hardware names (ie, @var{a0}
7213 instead of @var{$4}).  The only known assembler that supports this option
7214 is the Algorithmics assembler.
7215
7216 @item -mgpopt
7217 @itemx -mno-gpopt
7218 @opindex mgpopt
7219 @opindex mno-gpopt
7220 The @option{-mgpopt} switch says to write all of the data declarations
7221 before the instructions in the text section, this allows the MIPS
7222 assembler to generate one word memory references instead of using two
7223 words for short global or static data items.  This is on by default if
7224 optimization is selected.
7225
7226 @item -mstats
7227 @itemx -mno-stats
7228 @opindex mstats
7229 @opindex mno-stats
7230 For each non-inline function processed, the @option{-mstats} switch
7231 causes the compiler to emit one line to the standard error file to
7232 print statistics about the program (number of registers saved, stack
7233 size, etc.).
7234
7235 @item -mmemcpy
7236 @itemx -mno-memcpy
7237 @opindex mmemcpy
7238 @opindex mno-memcpy
7239 The @option{-mmemcpy} switch makes all block moves call the appropriate
7240 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7241 generating inline code.
7242
7243 @item -mmips-tfile
7244 @itemx -mno-mips-tfile
7245 @opindex mmips-tfile
7246 @opindex mno-mips-tfile
7247 The @option{-mno-mips-tfile} switch causes the compiler not
7248 postprocess the object file with the @file{mips-tfile} program,
7249 after the MIPS assembler has generated it to add debug support.  If
7250 @file{mips-tfile} is not run, then no local variables will be
7251 available to the debugger.  In addition, @file{stage2} and
7252 @file{stage3} objects will have the temporary file names passed to the
7253 assembler embedded in the object file, which means the objects will
7254 not compare the same.  The @option{-mno-mips-tfile} switch should only
7255 be used when there are bugs in the @file{mips-tfile} program that
7256 prevents compilation.
7257
7258 @item -msoft-float
7259 @opindex msoft-float
7260 Generate output containing library calls for floating point.
7261 @strong{Warning:} the requisite libraries are not part of GCC@.
7262 Normally the facilities of the machine's usual C compiler are used, but
7263 this can't be done directly in cross-compilation.  You must make your
7264 own arrangements to provide suitable library functions for
7265 cross-compilation.
7266
7267 @item -mhard-float
7268 @opindex mhard-float
7269 Generate output containing floating point instructions.  This is the
7270 default if you use the unmodified sources.
7271
7272 @item -mabicalls
7273 @itemx -mno-abicalls
7274 @opindex mabicalls
7275 @opindex mno-abicalls
7276 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7277 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7278 position independent code.
7279
7280 @item -mlong-calls
7281 @itemx -mno-long-calls
7282 @opindex mlong-calls
7283 @opindex mno-long-calls
7284 Do all calls with the @samp{JALR} instruction, which requires
7285 loading up a function's address into a register before the call.
7286 You need to use this switch, if you call outside of the current
7287 512 megabyte segment to functions that are not through pointers.
7288
7289 @item -mhalf-pic
7290 @itemx -mno-half-pic
7291 @opindex mhalf-pic
7292 @opindex mno-half-pic
7293 Put pointers to extern references into the data section and load them
7294 up, rather than put the references in the text section.
7295
7296 @item -membedded-pic
7297 @itemx -mno-embedded-pic
7298 @opindex membedded-pic
7299 @opindex mno-embedded-pic
7300 Generate PIC code suitable for some embedded systems.  All calls are
7301 made using PC relative address, and all data is addressed using the $gp
7302 register.  No more than 65536 bytes of global data may be used.  This
7303 requires GNU as and GNU ld which do most of the work.  This currently
7304 only works on targets which use ECOFF; it does not work with ELF@.
7305
7306 @item -membedded-data
7307 @itemx -mno-embedded-data
7308 @opindex membedded-data
7309 @opindex mno-embedded-data
7310 Allocate variables to the read-only data section first if possible, then
7311 next in the small data section if possible, otherwise in data.  This gives
7312 slightly slower code than the default, but reduces the amount of RAM required
7313 when executing, and thus may be preferred for some embedded systems.
7314
7315 @item -muninit-const-in-rodata
7316 @itemx -mno-uninit-const-in-rodata
7317 @opindex muninit-const-in-rodata
7318 @opindex mno-uninit-const-in-rodata
7319 When used together with @option{-membedded-data}, it will always store uninitialized
7320 const variables in the read-only data section.
7321
7322 @item -msingle-float
7323 @itemx -mdouble-float
7324 @opindex msingle-float
7325 @opindex mdouble-float
7326 The @option{-msingle-float} switch tells gcc to assume that the floating
7327 point coprocessor only supports single precision operations, as on the
7328 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7329 double precision operations.  This is the default.
7330
7331 @item -mmad
7332 @itemx -mno-mad
7333 @opindex mmad
7334 @opindex mno-mad
7335 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7336 as on the @samp{r4650} chip.
7337
7338 @item -m4650
7339 @opindex m4650
7340 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7341 @option{-mcpu=r4650}.
7342
7343 @item -mips16
7344 @itemx -mno-mips16
7345 @opindex mips16
7346 @opindex mno-mips16
7347 Enable 16-bit instructions.
7348
7349 @item -mentry
7350 @opindex mentry
7351 Use the entry and exit pseudo ops.  This option can only be used with
7352 @option{-mips16}.
7353
7354 @item -EL
7355 @opindex EL
7356 Compile code for the processor in little endian mode.
7357 The requisite libraries are assumed to exist.
7358
7359 @item -EB
7360 @opindex EB
7361 Compile code for the processor in big endian mode.
7362 The requisite libraries are assumed to exist.
7363
7364 @item -G @var{num}
7365 @opindex G
7366 @cindex smaller data references (MIPS)
7367 @cindex gp-relative references (MIPS)
7368 Put global and static items less than or equal to @var{num} bytes into
7369 the small data or bss sections instead of the normal data or bss
7370 section.  This allows the assembler to emit one word memory reference
7371 instructions based on the global pointer (@var{gp} or @var{$28}),
7372 instead of the normal two words used.  By default, @var{num} is 8 when
7373 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
7374 @option{-G @var{num}} switch is also passed to the assembler and linker.
7375 All modules should be compiled with the same @option{-G @var{num}}
7376 value.
7377
7378 @item -nocpp
7379 @opindex nocpp
7380 Tell the MIPS assembler to not run its preprocessor over user
7381 assembler files (with a @samp{.s} suffix) when assembling them.
7382
7383 @item -mfix7000
7384 @opindex mfix7000
7385 Pass an option to gas which will cause nops to be inserted if
7386 the read of the destination register of an mfhi or mflo instruction
7387 occurs in the following two instructions.
7388
7389 @item -no-crt0
7390 @opindex no-crt0
7391 Do not include the default crt0.
7392 @end table
7393
7394 @ifset INTERNALS
7395 These options are defined by the macro
7396 @code{TARGET_SWITCHES} in the machine description.  The default for the
7397 options is also defined by that macro, which enables you to change the
7398 defaults.
7399 @end ifset
7400
7401 @node i386 Options
7402 @subsection Intel 386 Options
7403 @cindex i386 Options
7404 @cindex Intel 386 Options
7405
7406 These @samp{-m} options are defined for the i386 family of computers:
7407
7408 @table @gcctabopt
7409 @item -mcpu=@var{cpu-type}
7410 @opindex mcpu
7411 Assume the defaults for the machine type @var{cpu-type} when scheduling
7412 instructions.  The choices for @var{cpu-type} are @samp{i386},
7413 @samp{i486}, @samp{i586}, @samp{i686}, @samp{pentium},
7414 @samp{pentiumpro}, @samp{pentium4}, @samp{k6}, and @samp{athlon}
7415
7416 While picking a specific @var{cpu-type} will schedule things appropriately
7417 for that particular chip, the compiler will not generate any code that
7418 does not run on the i386 without the @option{-march=@var{cpu-type}} option
7419 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
7420 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
7421 AMD chips as opposed to the Intel ones.
7422
7423 @item -march=@var{cpu-type}
7424 @opindex march
7425 Generate instructions for the machine type @var{cpu-type}.  The choices
7426 for @var{cpu-type} are the same as for @option{-mcpu}.  Moreover,
7427 specifying @option{-march=@var{cpu-type}} implies @option{-mcpu=@var{cpu-type}}.
7428
7429 @item -m386
7430 @itemx -m486
7431 @itemx -mpentium
7432 @itemx -mpentiumpro
7433 @opindex m386
7434 @opindex m486
7435 @opindex mpentium
7436 @opindex mpentiumpro
7437 These options are synonyms for @option{-mcpu=i386}, @option{-mcpu=i486},
7438 @option{-mcpu=pentium}, and @option{-mcpu=pentiumpro} respectively.
7439 These synonyms are deprecated.
7440
7441 @item -mintel-syntax
7442 @opindex mintel-syntax
7443 Emit assembly using Intel syntax opcodes instead of AT&T syntax.
7444
7445 @item -mieee-fp
7446 @itemx -mno-ieee-fp
7447 @opindex mieee-fp
7448 @opindex mno-ieee-fp
7449 Control whether or not the compiler uses IEEE floating point
7450 comparisons.  These handle correctly the case where the result of a
7451 comparison is unordered.
7452
7453 @item -msoft-float
7454 @opindex msoft-float
7455 Generate output containing library calls for floating point.
7456 @strong{Warning:} the requisite libraries are not part of GCC@.
7457 Normally the facilities of the machine's usual C compiler are used, but
7458 this can't be done directly in cross-compilation.  You must make your
7459 own arrangements to provide suitable library functions for
7460 cross-compilation.
7461
7462 On machines where a function returns floating point results in the 80387
7463 register stack, some floating point opcodes may be emitted even if
7464 @option{-msoft-float} is used.
7465
7466 @item -mno-fp-ret-in-387
7467 @opindex mno-fp-ret-in-387
7468 Do not use the FPU registers for return values of functions.
7469
7470 The usual calling convention has functions return values of types
7471 @code{float} and @code{double} in an FPU register, even if there
7472 is no FPU@.  The idea is that the operating system should emulate
7473 an FPU@.
7474
7475 The option @option{-mno-fp-ret-in-387} causes such values to be returned
7476 in ordinary CPU registers instead.
7477
7478 @item -mno-fancy-math-387
7479 @opindex mno-fancy-math-387
7480 Some 387 emulators do not support the @code{sin}, @code{cos} and
7481 @code{sqrt} instructions for the 387.  Specify this option to avoid
7482 generating those instructions.  This option is the default on FreeBSD@.
7483 As of revision 2.6.1, these instructions are not generated unless you
7484 also use the @option{-funsafe-math-optimizations} switch.
7485
7486 @item -malign-double
7487 @itemx -mno-align-double
7488 @opindex malign-double
7489 @opindex mno-align-double
7490 Control whether GCC aligns @code{double}, @code{long double}, and
7491 @code{long long} variables on a two word boundary or a one word
7492 boundary.  Aligning @code{double} variables on a two word boundary will
7493 produce code that runs somewhat faster on a @samp{Pentium} at the
7494 expense of more memory.
7495
7496 @item -m128bit-long-double
7497 @opindex m128bit-long-double
7498 Control the size of @code{long double} type. i386 application binary interface
7499 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
7500 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
7501 impossible to reach with 12 byte long doubles in the array accesses.
7502
7503 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
7504 structures and arrays containing @code{long double} will change their size as
7505 well as function calling convention for function taking @code{long double}
7506 will be modified.
7507
7508 @item -m96bit-long-double
7509 @opindex m96bit-long-double
7510 Set the size of @code{long double} to 96 bits as required by the i386
7511 application binary interface.  This is the default.
7512
7513 @item -msvr3-shlib
7514 @itemx -mno-svr3-shlib
7515 @opindex msvr3-shlib
7516 @opindex mno-svr3-shlib
7517 Control whether GCC places uninitialized local variables into the
7518 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
7519 into @code{bss}.  These options are meaningful only on System V Release 3.
7520
7521 @item -mrtd
7522 @opindex mrtd
7523 Use a different function-calling convention, in which functions that
7524 take a fixed number of arguments return with the @code{ret} @var{num}
7525 instruction, which pops their arguments while returning.  This saves one
7526 instruction in the caller since there is no need to pop the arguments
7527 there.
7528
7529 You can specify that an individual function is called with this calling
7530 sequence with the function attribute @samp{stdcall}.  You can also
7531 override the @option{-mrtd} option by using the function attribute
7532 @samp{cdecl}.  @xref{Function Attributes}.
7533
7534 @strong{Warning:} this calling convention is incompatible with the one
7535 normally used on Unix, so you cannot use it if you need to call
7536 libraries compiled with the Unix compiler.
7537
7538 Also, you must provide function prototypes for all functions that
7539 take variable numbers of arguments (including @code{printf});
7540 otherwise incorrect code will be generated for calls to those
7541 functions.
7542
7543 In addition, seriously incorrect code will result if you call a
7544 function with too many arguments.  (Normally, extra arguments are
7545 harmlessly ignored.)
7546
7547 @item -mregparm=@var{num}
7548 @opindex mregparm
7549 Control how many registers are used to pass integer arguments.  By
7550 default, no registers are used to pass arguments, and at most 3
7551 registers can be used.  You can control this behavior for a specific
7552 function by using the function attribute @samp{regparm}.
7553 @xref{Function Attributes}.
7554
7555 @strong{Warning:} if you use this switch, and
7556 @var{num} is nonzero, then you must build all modules with the same
7557 value, including any libraries.  This includes the system libraries and
7558 startup modules.
7559
7560 @item -mpreferred-stack-boundary=@var{num}
7561 @opindex mpreferred-stack-boundary
7562 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
7563 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
7564 the default is 4 (16 bytes or 128 bits).
7565
7566 The stack is required to be aligned on a 4 byte boundary.  On Pentium
7567 and PentiumPro, @code{double} and @code{long double} values should be
7568 aligned to an 8 byte boundary (see @option{-malign-double}) or suffer
7569 significant run time performance penalties.  On Pentium III, the
7570 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
7571 penalties if it is not 16 byte aligned.
7572
7573 To ensure proper alignment of this values on the stack, the stack boundary
7574 must be as aligned as that required by any value stored on the stack.
7575 Further, every function must be generated such that it keeps the stack
7576 aligned.  Thus calling a function compiled with a higher preferred
7577 stack boundary from a function compiled with a lower preferred stack
7578 boundary will most likely misalign the stack.  It is recommended that
7579 libraries that use callbacks always use the default setting.
7580
7581 This extra alignment does consume extra stack space.  Code that is sensitive
7582 to stack space usage, such as embedded systems and operating system kernels,
7583 may want to reduce the preferred alignment to
7584 @option{-mpreferred-stack-boundary=2}.
7585
7586 @item -mpush-args
7587 @itemx -mno-push-args
7588 @opindex mpush-args
7589 @opindex mno-push-args
7590 Use PUSH operations to store outgoing parameters.  This method is shorter
7591 and usually equally fast as method using SUB/MOV operations and is enabled
7592 by default.  In some cases disabling it may improve performance because of
7593 improved scheduling and reduced dependencies.
7594
7595 @item -maccumulate-outgoing-args
7596 @opindex maccumulate-outgoing-args
7597 If enabled, the maximum amount of space required for outgoing arguments will be
7598 computed in the function prologue.  This is faster on most modern CPUs
7599 because of reduced dependencies, improved scheduling and reduced stack usage
7600 when preferred stack boundary is not equal to 2.  The drawback is a notable
7601 increase in code size.  This switch implies @option{-mno-push-args}.
7602
7603 @item -mthreads
7604 @opindex mthreads
7605 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
7606 on thread-safe exception handling must compile and link all code with the
7607 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
7608 @option{-D_MT}; when linking, it links in a special thread helper library
7609 @option{-lmingwthrd} which cleans up per thread exception handling data.
7610
7611 @item -mno-align-stringops
7612 @opindex mno-align-stringops
7613 Do not align destination of inlined string operations.  This switch reduces
7614 code size and improves performance in case the destination is already aligned,
7615 but gcc don't know about it.
7616
7617 @item -minline-all-stringops
7618 @opindex minline-all-stringops
7619 By default GCC inlines string operations only when destination is known to be
7620 aligned at least to 4 byte boundary.  This enables more inlining, increase code
7621 size, but may improve performance of code that depends on fast memcpy, strlen
7622 and memset for short lengths.
7623
7624 @item -momit-leaf-frame-pointer
7625 @opindex momit-leaf-frame-pointer
7626 Don't keep the frame pointer in a register for leaf functions.  This
7627 avoids the instructions to save, set up and restore frame pointers and
7628 makes an extra register available in leaf functions.  The option
7629 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7630 which might make debugging harder.
7631 @end table
7632
7633 @node HPPA Options
7634 @subsection HPPA Options
7635 @cindex HPPA Options
7636
7637 These @samp{-m} options are defined for the HPPA family of computers:
7638
7639 @table @gcctabopt
7640 @item -march=@var{architecture-type}
7641 @opindex march
7642 Generate code for the specified architecture.  The choices for
7643 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
7644 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
7645 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
7646 architecture option for your machine.  Code compiled for lower numbered
7647 architectures will run on higher numbered architectures, but not the
7648 other way around.
7649
7650 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
7651 next release of binutils (current is 2.9.1) will probably contain PA 2.0
7652 support.
7653
7654 @item -mpa-risc-1-0
7655 @itemx -mpa-risc-1-1
7656 @itemx -mpa-risc-2-0
7657 @opindex mpa-risc-1-0
7658 @opindex mpa-risc-1-1
7659 @opindex mpa-risc-2-0
7660 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
7661
7662 @item -mbig-switch
7663 @opindex mbig-switch
7664 Generate code suitable for big switch tables.  Use this option only if
7665 the assembler/linker complain about out of range branches within a switch
7666 table.
7667
7668 @item -mjump-in-delay
7669 @opindex mjump-in-delay
7670 Fill delay slots of function calls with unconditional jump instructions
7671 by modifying the return pointer for the function call to be the target
7672 of the conditional jump.
7673
7674 @item -mdisable-fpregs
7675 @opindex mdisable-fpregs
7676 Prevent floating point registers from being used in any manner.  This is
7677 necessary for compiling kernels which perform lazy context switching of
7678 floating point registers.  If you use this option and attempt to perform
7679 floating point operations, the compiler will abort.
7680
7681 @item -mdisable-indexing
7682 @opindex mdisable-indexing
7683 Prevent the compiler from using indexing address modes.  This avoids some
7684 rather obscure problems when compiling MIG generated code under MACH@.
7685
7686 @item -mno-space-regs
7687 @opindex mno-space-regs
7688 Generate code that assumes the target has no space registers.  This allows
7689 GCC to generate faster indirect calls and use unscaled index address modes.
7690
7691 Such code is suitable for level 0 PA systems and kernels.
7692
7693 @item -mfast-indirect-calls
7694 @opindex mfast-indirect-calls
7695 Generate code that assumes calls never cross space boundaries.  This
7696 allows GCC to emit code which performs faster indirect calls.
7697
7698 This option will not work in the presence of shared libraries or nested
7699 functions.
7700
7701 @item -mlong-load-store
7702 @opindex mlong-load-store
7703 Generate 3-instruction load and store sequences as sometimes required by
7704 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
7705 the HP compilers.
7706
7707 @item -mportable-runtime
7708 @opindex mportable-runtime
7709 Use the portable calling conventions proposed by HP for ELF systems.
7710
7711 @item -mgas
7712 @opindex mgas
7713 Enable the use of assembler directives only GAS understands.
7714
7715 @item -mschedule=@var{cpu-type}
7716 @opindex mschedule
7717 Schedule code according to the constraints for the machine type
7718 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
7719 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}.  Refer to
7720 @file{/usr/lib/sched.models} on an HP-UX system to determine the
7721 proper scheduling option for your machine.
7722
7723 @item -mlinker-opt
7724 @opindex mlinker-opt
7725 Enable the optimization pass in the HPUX linker.  Note this makes symbolic
7726 debugging impossible.  It also triggers a bug in the HPUX 8 and HPUX 9 linkers
7727 in which they give bogus error messages when linking some programs.
7728
7729 @item -msoft-float
7730 @opindex msoft-float
7731 Generate output containing library calls for floating point.
7732 @strong{Warning:} the requisite libraries are not available for all HPPA
7733 targets.  Normally the facilities of the machine's usual C compiler are
7734 used, but this cannot be done directly in cross-compilation.  You must make
7735 your own arrangements to provide suitable library functions for
7736 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
7737 does provide software floating point support.
7738
7739 @option{-msoft-float} changes the calling convention in the output file;
7740 therefore, it is only useful if you compile @emph{all} of a program with
7741 this option.  In particular, you need to compile @file{libgcc.a}, the
7742 library that comes with GCC, with @option{-msoft-float} in order for
7743 this to work.
7744 @end table
7745
7746 @node Intel 960 Options
7747 @subsection Intel 960 Options
7748
7749 These @samp{-m} options are defined for the Intel 960 implementations:
7750
7751 @table @gcctabopt
7752 @item -m@var{cpu-type}
7753 @opindex mka
7754 @opindex mkb
7755 @opindex mmc
7756 @opindex mca
7757 @opindex mcf
7758 @opindex msa
7759 @opindex msb
7760 Assume the defaults for the machine type @var{cpu-type} for some of
7761 the other options, including instruction scheduling, floating point
7762 support, and addressing modes.  The choices for @var{cpu-type} are
7763 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
7764 @samp{sa}, and @samp{sb}.
7765 The default is
7766 @samp{kb}.
7767
7768 @item -mnumerics
7769 @itemx -msoft-float
7770 @opindex mnumerics
7771 @opindex msoft-float
7772 The @option{-mnumerics} option indicates that the processor does support
7773 floating-point instructions.  The @option{-msoft-float} option indicates
7774 that floating-point support should not be assumed.
7775
7776 @item -mleaf-procedures
7777 @itemx -mno-leaf-procedures
7778 @opindex mleaf-procedures
7779 @opindex mno-leaf-procedures
7780 Do (or do not) attempt to alter leaf procedures to be callable with the
7781 @code{bal} instruction as well as @code{call}.  This will result in more
7782 efficient code for explicit calls when the @code{bal} instruction can be
7783 substituted by the assembler or linker, but less efficient code in other
7784 cases, such as calls via function pointers, or using a linker that doesn't
7785 support this optimization.
7786
7787 @item -mtail-call
7788 @itemx -mno-tail-call
7789 @opindex mtail-call
7790 @opindex mno-tail-call
7791 Do (or do not) make additional attempts (beyond those of the
7792 machine-independent portions of the compiler) to optimize tail-recursive
7793 calls into branches.  You may not want to do this because the detection of
7794 cases where this is not valid is not totally complete.  The default is
7795 @option{-mno-tail-call}.
7796
7797 @item -mcomplex-addr
7798 @itemx -mno-complex-addr
7799 @opindex mcomplex-addr
7800 @opindex mno-complex-addr
7801 Assume (or do not assume) that the use of a complex addressing mode is a
7802 win on this implementation of the i960.  Complex addressing modes may not
7803 be worthwhile on the K-series, but they definitely are on the C-series.
7804 The default is currently @option{-mcomplex-addr} for all processors except
7805 the CB and CC@.
7806
7807 @item -mcode-align
7808 @itemx -mno-code-align
7809 @opindex mcode-align
7810 @opindex mno-code-align
7811 Align code to 8-byte boundaries for faster fetching (or don't bother).
7812 Currently turned on by default for C-series implementations only.
7813
7814 @ignore
7815 @item -mclean-linkage
7816 @itemx -mno-clean-linkage
7817 @opindex mclean-linkage
7818 @opindex mno-clean-linkage
7819 These options are not fully implemented.
7820 @end ignore
7821
7822 @item -mic-compat
7823 @itemx -mic2.0-compat
7824 @itemx -mic3.0-compat
7825 @opindex mic-compat
7826 @opindex mic2.0-compat
7827 @opindex mic3.0-compat
7828 Enable compatibility with iC960 v2.0 or v3.0.
7829
7830 @item -masm-compat
7831 @itemx -mintel-asm
7832 @opindex masm-compat
7833 @opindex mintel-asm
7834 Enable compatibility with the iC960 assembler.
7835
7836 @item -mstrict-align
7837 @itemx -mno-strict-align
7838 @opindex mstrict-align
7839 @opindex mno-strict-align
7840 Do not permit (do permit) unaligned accesses.
7841
7842 @item -mold-align
7843 @opindex mold-align
7844 Enable structure-alignment compatibility with Intel's gcc release version
7845 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
7846
7847 @item -mlong-double-64
7848 @opindex mlong-double-64
7849 Implement type @samp{long double} as 64-bit floating point numbers.
7850 Without the option @samp{long double} is implemented by 80-bit
7851 floating point numbers.  The only reason we have it because there is
7852 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
7853 is only useful for people using soft-float targets.  Otherwise, we
7854 should recommend against use of it.
7855
7856 @end table
7857
7858 @node DEC Alpha Options
7859 @subsection DEC Alpha Options
7860
7861 These @samp{-m} options are defined for the DEC Alpha implementations:
7862
7863 @table @gcctabopt
7864 @item -mno-soft-float
7865 @itemx -msoft-float
7866 @opindex mno-soft-float
7867 @opindex msoft-float
7868 Use (do not use) the hardware floating-point instructions for
7869 floating-point operations.  When @option{-msoft-float} is specified,
7870 functions in @file{libgcc.a} will be used to perform floating-point
7871 operations.  Unless they are replaced by routines that emulate the
7872 floating-point operations, or compiled in such a way as to call such
7873 emulations routines, these routines will issue floating-point
7874 operations.   If you are compiling for an Alpha without floating-point
7875 operations, you must ensure that the library is built so as not to call
7876 them.
7877
7878 Note that Alpha implementations without floating-point operations are
7879 required to have floating-point registers.
7880
7881 @item -mfp-reg
7882 @itemx -mno-fp-regs
7883 @opindex mfp-reg
7884 @opindex mno-fp-regs
7885 Generate code that uses (does not use) the floating-point register set.
7886 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7887 register set is not used, floating point operands are passed in integer
7888 registers as if they were integers and floating-point results are passed
7889 in $0 instead of $f0.  This is a non-standard calling sequence, so any
7890 function with a floating-point argument or return value called by code
7891 compiled with @option{-mno-fp-regs} must also be compiled with that
7892 option.
7893
7894 A typical use of this option is building a kernel that does not use,
7895 and hence need not save and restore, any floating-point registers.
7896
7897 @item -mieee
7898 @opindex mieee
7899 The Alpha architecture implements floating-point hardware optimized for
7900 maximum performance.  It is mostly compliant with the IEEE floating
7901 point standard.  However, for full compliance, software assistance is
7902 required.  This option generates code fully IEEE compliant code
7903 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7904 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7905 defined during compilation.  The resulting code is less efficient but is
7906 able to correctly support denormalized numbers and exceptional IEEE
7907 values such as not-a-number and plus/minus infinity.  Other Alpha
7908 compilers call this option @option{-ieee_with_no_inexact}.
7909
7910 @item -mieee-with-inexact
7911 @opindex mieee-with-inexact
7912 This is like @option{-mieee} except the generated code also maintains
7913 the IEEE @var{inexact-flag}.  Turning on this option causes the
7914 generated code to implement fully-compliant IEEE math.  In addition to
7915 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7916 macro.  On some Alpha implementations the resulting code may execute
7917 significantly slower than the code generated by default.  Since there is
7918 very little code that depends on the @var{inexact-flag}, you should
7919 normally not specify this option.  Other Alpha compilers call this
7920 option @option{-ieee_with_inexact}.
7921
7922 @item -mfp-trap-mode=@var{trap-mode}
7923 @opindex mfp-trap-mode
7924 This option controls what floating-point related traps are enabled.
7925 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7926 The trap mode can be set to one of four values:
7927
7928 @table @samp
7929 @item n
7930 This is the default (normal) setting.  The only traps that are enabled
7931 are the ones that cannot be disabled in software (e.g., division by zero
7932 trap).
7933
7934 @item u
7935 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7936 as well.
7937
7938 @item su
7939 Like @samp{su}, but the instructions are marked to be safe for software
7940 completion (see Alpha architecture manual for details).
7941
7942 @item sui
7943 Like @samp{su}, but inexact traps are enabled as well.
7944 @end table
7945
7946 @item -mfp-rounding-mode=@var{rounding-mode}
7947 @opindex mfp-rounding-mode
7948 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7949 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7950 of:
7951
7952 @table @samp
7953 @item n
7954 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7955 the nearest machine number or towards the even machine number in case
7956 of a tie.
7957
7958 @item m
7959 Round towards minus infinity.
7960
7961 @item c
7962 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7963
7964 @item d
7965 Dynamic rounding mode.  A field in the floating point control register
7966 (@var{fpcr}, see Alpha architecture reference manual) controls the
7967 rounding mode in effect.  The C library initializes this register for
7968 rounding towards plus infinity.  Thus, unless your program modifies the
7969 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7970 @end table
7971
7972 @item -mtrap-precision=@var{trap-precision}
7973 @opindex mtrap-precision
7974 In the Alpha architecture, floating point traps are imprecise.  This
7975 means without software assistance it is impossible to recover from a
7976 floating trap and program execution normally needs to be terminated.
7977 GCC can generate code that can assist operating system trap handlers
7978 in determining the exact location that caused a floating point trap.
7979 Depending on the requirements of an application, different levels of
7980 precisions can be selected:
7981
7982 @table @samp
7983 @item p
7984 Program precision.  This option is the default and means a trap handler
7985 can only identify which program caused a floating point exception.
7986
7987 @item f
7988 Function precision.  The trap handler can determine the function that
7989 caused a floating point exception.
7990
7991 @item i
7992 Instruction precision.  The trap handler can determine the exact
7993 instruction that caused a floating point exception.
7994 @end table
7995
7996 Other Alpha compilers provide the equivalent options called
7997 @option{-scope_safe} and @option{-resumption_safe}.
7998
7999 @item -mieee-conformant
8000 @opindex mieee-conformant
8001 This option marks the generated code as IEEE conformant.  You must not
8002 use this option unless you also specify @option{-mtrap-precision=i} and either
8003 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8004 is to emit the line @samp{.eflag 48} in the function prologue of the
8005 generated assembly file.  Under DEC Unix, this has the effect that
8006 IEEE-conformant math library routines will be linked in.
8007
8008 @item -mbuild-constants
8009 @opindex mbuild-constants
8010 Normally GCC examines a 32- or 64-bit integer constant to
8011 see if it can construct it from smaller constants in two or three
8012 instructions.  If it cannot, it will output the constant as a literal and
8013 generate code to load it from the data segment at runtime.
8014
8015 Use this option to require GCC to construct @emph{all} integer constants
8016 using code, even if it takes more instructions (the maximum is six).
8017
8018 You would typically use this option to build a shared library dynamic
8019 loader.  Itself a shared library, it must relocate itself in memory
8020 before it can find the variables and constants in its own data segment.
8021
8022 @item -malpha-as
8023 @itemx -mgas
8024 @opindex malpha-as
8025 @opindex mgas
8026 Select whether to generate code to be assembled by the vendor-supplied
8027 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8028
8029 @item -mbwx
8030 @itemx -mno-bwx
8031 @itemx -mcix
8032 @itemx -mno-cix
8033 @itemx -mmax
8034 @itemx -mno-max
8035 @opindex mbwx
8036 @opindex mno-bwx
8037 @opindex mcix
8038 @opindex mno-cix
8039 @opindex mmax
8040 @opindex mno-max
8041 Indicate whether GCC should generate code to use the optional BWX,
8042 CIX, and MAX instruction sets.  The default is to use the instruction sets
8043 supported by the CPU type specified via @option{-mcpu=} option or that
8044 of the CPU on which GCC was built if none was specified.
8045
8046 @item -mcpu=@var{cpu_type}
8047 @opindex mcpu
8048 Set the instruction set, register set, and instruction scheduling
8049 parameters for machine type @var{cpu_type}.  You can specify either the
8050 @samp{EV} style name or the corresponding chip number.  GCC
8051 supports scheduling parameters for the EV4 and EV5 family of processors
8052 and will choose the default values for the instruction set from
8053 the processor you specify.  If you do not specify a processor type,
8054 GCC will default to the processor on which the compiler was built.
8055
8056 Supported values for @var{cpu_type} are
8057
8058 @table @samp
8059 @item ev4
8060 @itemx 21064
8061 Schedules as an EV4 and has no instruction set extensions.
8062
8063 @item ev5
8064 @itemx 21164
8065 Schedules as an EV5 and has no instruction set extensions.
8066
8067 @item ev56
8068 @itemx 21164a
8069 Schedules as an EV5 and supports the BWX extension.
8070
8071 @item pca56
8072 @itemx 21164pc
8073 @itemx 21164PC
8074 Schedules as an EV5 and supports the BWX and MAX extensions.
8075
8076 @item ev6
8077 @itemx 21264
8078 Schedules as an EV5 (until Digital releases the scheduling parameters
8079 for the EV6) and supports the BWX, CIX, and MAX extensions.
8080 @end table
8081
8082 @item -mmemory-latency=@var{time}
8083 @opindex mmemory-latency
8084 Sets the latency the scheduler should assume for typical memory
8085 references as seen by the application.  This number is highly
8086 dependent on the memory access patterns used by the application
8087 and the size of the external cache on the machine.
8088
8089 Valid options for @var{time} are
8090
8091 @table @samp
8092 @item @var{number}
8093 A decimal number representing clock cycles.
8094
8095 @item L1
8096 @itemx L2
8097 @itemx L3
8098 @itemx main
8099 The compiler contains estimates of the number of clock cycles for
8100 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8101 (also called Dcache, Scache, and Bcache), as well as to main memory.
8102 Note that L3 is only valid for EV5.
8103
8104 @end table
8105 @end table
8106
8107 @node Clipper Options
8108 @subsection Clipper Options
8109
8110 These @samp{-m} options are defined for the Clipper implementations:
8111
8112 @table @gcctabopt
8113 @item -mc300
8114 @opindex mc300
8115 Produce code for a C300 Clipper processor.  This is the default.
8116
8117 @item -mc400
8118 @opindex mc400
8119 Produce code for a C400 Clipper processor, i.e.@: use floating point
8120 registers f8--f15.
8121 @end table
8122
8123 @node H8/300 Options
8124 @subsection H8/300 Options
8125
8126 These @samp{-m} options are defined for the H8/300 implementations:
8127
8128 @table @gcctabopt
8129 @item -mrelax
8130 @opindex mrelax
8131 Shorten some address references at link time, when possible; uses the
8132 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8133 ld.info, Using ld}, for a fuller description.
8134
8135 @item -mh
8136 @opindex mh
8137 Generate code for the H8/300H@.
8138
8139 @item -ms
8140 @opindex ms
8141 Generate code for the H8/S@.
8142
8143 @item -ms2600
8144 @opindex ms2600
8145 Generate code for the H8/S2600.  This switch must be used with @option{-ms}.
8146
8147 @item -mint32
8148 @opindex mint32
8149 Make @code{int} data 32 bits by default.
8150
8151 @item -malign-300
8152 @opindex malign-300
8153 On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
8154 The default for the H8/300H and H8/S is to align longs and floats on 4
8155 byte boundaries.
8156 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8157 This option has no effect on the H8/300.
8158 @end table
8159
8160 @node SH Options
8161 @subsection SH Options
8162
8163 These @samp{-m} options are defined for the SH implementations:
8164
8165 @table @gcctabopt
8166 @item -m1
8167 @opindex m1
8168 Generate code for the SH1.
8169
8170 @item -m2
8171 @opindex m2
8172 Generate code for the SH2.
8173
8174 @item -m3
8175 @opindex m3
8176 Generate code for the SH3.
8177
8178 @item -m3e
8179 @opindex m3e
8180 Generate code for the SH3e.
8181
8182 @item -m4-nofpu
8183 @opindex m4-nofpu
8184 Generate code for the SH4 without a floating-point unit.
8185
8186 @item -m4-single-only
8187 @opindex m4-single-only
8188 Generate code for the SH4 with a floating-point unit that only
8189 supports single-precision arithmetic.
8190
8191 @item -m4-single
8192 @opindex m4-single
8193 Generate code for the SH4 assuming the floating-point unit is in
8194 single-precision mode by default.
8195
8196 @item -m4
8197 @opindex m4
8198 Generate code for the SH4.
8199
8200 @item -mb
8201 @opindex mb
8202 Compile code for the processor in big endian mode.
8203
8204 @item -ml
8205 @opindex ml
8206 Compile code for the processor in little endian mode.
8207
8208 @item -mdalign
8209 @opindex mdalign
8210 Align doubles at 64-bit boundaries.  Note that this changes the calling
8211 conventions, and thus some functions from the standard C library will
8212 not work unless you recompile it first with @option{-mdalign}.
8213
8214 @item -mrelax
8215 @opindex mrelax
8216 Shorten some address references at link time, when possible; uses the
8217 linker option @option{-relax}.
8218
8219 @item -mbigtable
8220 @opindex mbigtable
8221 Use 32-bit offsets in @code{switch} tables.  The default is to use
8222 16-bit offsets.
8223
8224 @item -mfmovd
8225 @opindex mfmovd
8226 Enable the use of the instruction @code{fmovd}.
8227
8228 @item -mhitachi
8229 @opindex mhitachi
8230 Comply with the calling conventions defined by Hitachi.
8231
8232 @item -mnomacsave
8233 @opindex mnomacsave
8234 Mark the @code{MAC} register as call-clobbered, even if
8235 @option{-mhitachi} is given.
8236
8237 @item -mieee
8238 @opindex mieee
8239 Increase IEEE-compliance of floating-point code.
8240
8241 @item -misize
8242 @opindex misize
8243 Dump instruction size and location in the assembly code.
8244
8245 @item -mpadstruct
8246 @opindex mpadstruct
8247 This option is deprecated.  It pads structures to multiple of 4 bytes,
8248 which is incompatible with the SH ABI@.
8249
8250 @item -mspace
8251 @opindex mspace
8252 Optimize for space instead of speed.  Implied by @option{-Os}.
8253
8254 @item -mprefergot
8255 @opindex mprefergot
8256 When generating position-independent code, emit function calls using
8257 the Global Offset Table instead of the Procedure Linkage Table.
8258
8259 @item -musermode
8260 @opindex musermode
8261 Generate a library function call to invalidate instruction cache
8262 entries, after fixing up a trampoline.  This library function call
8263 doesn't assume it can write to the whole memory address space.  This
8264 is the default when the target is @code{sh-*-linux*}.
8265 @end table
8266
8267 @node System V Options
8268 @subsection Options for System V
8269
8270 These additional options are available on System V Release 4 for
8271 compatibility with other compilers on those systems:
8272
8273 @table @gcctabopt
8274 @item -G
8275 @opindex G
8276 Create a shared object.
8277 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
8278
8279 @item -Qy
8280 @opindex Qy
8281 Identify the versions of each tool used by the compiler, in a
8282 @code{.ident} assembler directive in the output.
8283
8284 @item -Qn
8285 @opindex Qn
8286 Refrain from adding @code{.ident} directives to the output file (this is
8287 the default).
8288
8289 @item -YP,@var{dirs}
8290 @opindex YP
8291 Search the directories @var{dirs}, and no others, for libraries
8292 specified with @option{-l}.
8293
8294 @item -Ym,@var{dir}
8295 @opindex Ym
8296 Look in the directory @var{dir} to find the M4 preprocessor.
8297 The assembler uses this option.
8298 @c This is supposed to go with a -Yd for predefined M4 macro files, but
8299 @c the generic assembler that comes with Solaris takes just -Ym.
8300 @end table
8301
8302 @node TMS320C3x/C4x Options
8303 @subsection TMS320C3x/C4x Options
8304 @cindex TMS320C3x/C4x Options
8305
8306 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
8307
8308 @table @gcctabopt
8309
8310 @item -mcpu=@var{cpu_type}
8311 @opindex mcpu
8312 Set the instruction set, register set, and instruction scheduling
8313 parameters for machine type @var{cpu_type}.  Supported values for
8314 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
8315 @samp{c44}.  The default is @samp{c40} to generate code for the
8316 TMS320C40.
8317
8318 @item -mbig-memory
8319 @item -mbig
8320 @itemx -msmall-memory
8321 @itemx -msmall
8322 @opindex mbig-memory
8323 @opindex mbig
8324 @opindex msmall-memory
8325 @opindex msmall
8326 Generates code for the big or small memory model.  The small memory
8327 model assumed that all data fits into one 64K word page.  At run-time
8328 the data page (DP) register must be set to point to the 64K page
8329 containing the .bss and .data program sections.  The big memory model is
8330 the default and requires reloading of the DP register for every direct
8331 memory access.
8332
8333 @item -mbk
8334 @itemx -mno-bk
8335 @opindex mbk
8336 @opindex mno-bk
8337 Allow (disallow) allocation of general integer operands into the block
8338 count register BK@.
8339
8340 @item -mdb
8341 @itemx -mno-db
8342 @opindex mdb
8343 @opindex mno-db
8344 Enable (disable) generation of code using decrement and branch,
8345 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
8346 on the safe side, this is disabled for the C3x, since the maximum
8347 iteration count on the C3x is @math{2^23 + 1} (but who iterates loops more than
8348 @math{2^23} times on the C3x?).  Note that GCC will try to reverse a loop so
8349 that it can utilise the decrement and branch instruction, but will give
8350 up if there is more than one memory reference in the loop.  Thus a loop
8351 where the loop counter is decremented can generate slightly more
8352 efficient code, in cases where the RPTB instruction cannot be utilised.
8353
8354 @item -mdp-isr-reload
8355 @itemx -mparanoid
8356 @opindex mdp-isr-reload
8357 @opindex mparanoid
8358 Force the DP register to be saved on entry to an interrupt service
8359 routine (ISR), reloaded to point to the data section, and restored on
8360 exit from the ISR@.  This should not be required unless someone has
8361 violated the small memory model by modifying the DP register, say within
8362 an object library.
8363
8364 @item -mmpyi
8365 @itemx -mno-mpyi
8366 @opindex mmpyi
8367 @opindex mno-mpyi
8368 For the C3x use the 24-bit MPYI instruction for integer multiplies
8369 instead of a library call to guarantee 32-bit results.  Note that if one
8370 of the operands is a constant, then the multiplication will be performed
8371 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
8372 then squaring operations are performed inline instead of a library call.
8373
8374 @item -mfast-fix
8375 @itemx -mno-fast-fix
8376 @opindex mfast-fix
8377 @opindex mno-fast-fix
8378 The C3x/C4x FIX instruction to convert a floating point value to an
8379 integer value chooses the nearest integer less than or equal to the
8380 floating point value rather than to the nearest integer.  Thus if the
8381 floating point number is negative, the result will be incorrectly
8382 truncated an additional code is necessary to detect and correct this
8383 case.  This option can be used to disable generation of the additional
8384 code required to correct the result.
8385
8386 @item -mrptb
8387 @itemx -mno-rptb
8388 @opindex mrptb
8389 @opindex mno-rptb
8390 Enable (disable) generation of repeat block sequences using the RPTB
8391 instruction for zero overhead looping.  The RPTB construct is only used
8392 for innermost loops that do not call functions or jump across the loop
8393 boundaries.  There is no advantage having nested RPTB loops due to the
8394 overhead required to save and restore the RC, RS, and RE registers.
8395 This is enabled by default with @option{-O2}.
8396
8397 @item -mrpts=@var{count}
8398 @itemx -mno-rpts
8399 @opindex mrpts
8400 @opindex mno-rpts
8401 Enable (disable) the use of the single instruction repeat instruction
8402 RPTS@.  If a repeat block contains a single instruction, and the loop
8403 count can be guaranteed to be less than the value @var{count}, GCC will
8404 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
8405 then a RPTS will be emitted even if the loop count cannot be determined
8406 at compile time.  Note that the repeated instruction following RPTS does
8407 not have to be reloaded from memory each iteration, thus freeing up the
8408 CPU buses for operands.  However, since interrupts are blocked by this
8409 instruction, it is disabled by default.
8410
8411 @item -mloop-unsigned
8412 @itemx -mno-loop-unsigned
8413 @opindex mloop-unsigned
8414 @opindex mno-loop-unsigned
8415 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
8416 is @math{2^31 + 1} since these instructions test if the iteration count is
8417 negative to terminate the loop.  If the iteration count is unsigned
8418 there is a possibility than the @math{2^31 + 1} maximum iteration count may be
8419 exceeded.  This switch allows an unsigned iteration count.
8420
8421 @item -mti
8422 @opindex mti
8423 Try to emit an assembler syntax that the TI assembler (asm30) is happy
8424 with.  This also enforces compatibility with the API employed by the TI
8425 C3x C compiler.  For example, long doubles are passed as structures
8426 rather than in floating point registers.
8427
8428 @item -mregparm
8429 @itemx -mmemparm
8430 @opindex mregparm
8431 @opindex mmemparm
8432 Generate code that uses registers (stack) for passing arguments to functions.
8433 By default, arguments are passed in registers where possible rather
8434 than by pushing arguments on to the stack.
8435
8436 @item -mparallel-insns
8437 @itemx -mno-parallel-insns
8438 @opindex mparallel-insns
8439 @opindex mno-parallel-insns
8440 Allow the generation of parallel instructions.  This is enabled by
8441 default with @option{-O2}.
8442
8443 @item -mparallel-mpy
8444 @itemx -mno-parallel-mpy
8445 @opindex mparallel-mpy
8446 @opindex mno-parallel-mpy
8447 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
8448 provided @option{-mparallel-insns} is also specified.  These instructions have
8449 tight register constraints which can pessimize the code generation
8450 of large functions.
8451
8452 @end table
8453
8454 @node V850 Options
8455 @subsection V850 Options
8456 @cindex V850 Options
8457
8458 These @samp{-m} options are defined for V850 implementations:
8459
8460 @table @gcctabopt
8461 @item -mlong-calls
8462 @itemx -mno-long-calls
8463 @opindex mlong-calls
8464 @opindex mno-long-calls
8465 Treat all calls as being far away (near).  If calls are assumed to be
8466 far away, the compiler will always load the functions address up into a
8467 register, and call indirect through the pointer.
8468
8469 @item -mno-ep
8470 @itemx -mep
8471 @opindex mno-ep
8472 @opindex mep
8473 Do not optimize (do optimize) basic blocks that use the same index
8474 pointer 4 or more times to copy pointer into the @code{ep} register, and
8475 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
8476 option is on by default if you optimize.
8477
8478 @item -mno-prolog-function
8479 @itemx -mprolog-function
8480 @opindex mno-prolog-function
8481 @opindex mprolog-function
8482 Do not use (do use) external functions to save and restore registers at
8483 the prolog and epilog of a function.  The external functions are slower,
8484 but use less code space if more than one function saves the same number
8485 of registers.  The @option{-mprolog-function} option is on by default if
8486 you optimize.
8487
8488 @item -mspace
8489 @opindex mspace
8490 Try to make the code as small as possible.  At present, this just turns
8491 on the @option{-mep} and @option{-mprolog-function} options.
8492
8493 @item -mtda=@var{n}
8494 @opindex mtda
8495 Put static or global variables whose size is @var{n} bytes or less into
8496 the tiny data area that register @code{ep} points to.  The tiny data
8497 area can hold up to 256 bytes in total (128 bytes for byte references).
8498
8499 @item -msda=@var{n}
8500 @opindex msda
8501 Put static or global variables whose size is @var{n} bytes or less into
8502 the small data area that register @code{gp} points to.  The small data
8503 area can hold up to 64 kilobytes.
8504
8505 @item -mzda=@var{n}
8506 @opindex mzda
8507 Put static or global variables whose size is @var{n} bytes or less into
8508 the first 32 kilobytes of memory.
8509
8510 @item -mv850
8511 @opindex mv850
8512 Specify that the target processor is the V850.
8513
8514 @item -mbig-switch
8515 @opindex mbig-switch
8516 Generate code suitable for big switch tables.  Use this option only if
8517 the assembler/linker complain about out of range branches within a switch
8518 table.
8519 @end table
8520
8521 @node ARC Options
8522 @subsection ARC Options
8523 @cindex ARC Options
8524
8525 These options are defined for ARC implementations:
8526
8527 @table @gcctabopt
8528 @item -EL
8529 @opindex EL
8530 Compile code for little endian mode.  This is the default.
8531
8532 @item -EB
8533 @opindex EB
8534 Compile code for big endian mode.
8535
8536 @item -mmangle-cpu
8537 @opindex mmangle-cpu
8538 Prepend the name of the cpu to all public symbol names.
8539 In multiple-processor systems, there are many ARC variants with different
8540 instruction and register set characteristics.  This flag prevents code
8541 compiled for one cpu to be linked with code compiled for another.
8542 No facility exists for handling variants that are ``almost identical''.
8543 This is an all or nothing option.
8544
8545 @item -mcpu=@var{cpu}
8546 @opindex mcpu
8547 Compile code for ARC variant @var{cpu}.
8548 Which variants are supported depend on the configuration.
8549 All variants support @option{-mcpu=base}, this is the default.
8550
8551 @item -mtext=@var{text-section}
8552 @itemx -mdata=@var{data-section}
8553 @itemx -mrodata=@var{readonly-data-section}
8554 @opindex mtext
8555 @opindex mdata
8556 @opindex mrodata
8557 Put functions, data, and readonly data in @var{text-section},
8558 @var{data-section}, and @var{readonly-data-section} respectively
8559 by default.  This can be overridden with the @code{section} attribute.
8560 @xref{Variable Attributes}.
8561
8562 @end table
8563
8564 @node NS32K Options
8565 @subsection NS32K Options
8566 @cindex NS32K options
8567
8568 These are the @samp{-m} options defined for the 32000 series.  The default
8569 values for these options depends on which style of 32000 was selected when
8570 the compiler was configured; the defaults for the most common choices are
8571 given below.
8572
8573 @table @gcctabopt
8574 @item -m32032
8575 @itemx -m32032
8576 @opindex m32032
8577 @opindex m32032
8578 Generate output for a 32032.  This is the default
8579 when the compiler is configured for 32032 and 32016 based systems.
8580
8581 @item -m32332
8582 @itemx -m32332
8583 @opindex m32332
8584 @opindex m32332
8585 Generate output for a 32332.  This is the default
8586 when the compiler is configured for 32332-based systems.
8587
8588 @item -m32532
8589 @itemx -m32532
8590 @opindex m32532
8591 @opindex m32532
8592 Generate output for a 32532.  This is the default
8593 when the compiler is configured for 32532-based systems.
8594
8595 @item -m32081
8596 @opindex m32081
8597 Generate output containing 32081 instructions for floating point.
8598 This is the default for all systems.
8599
8600 @item -m32381
8601 @opindex m32381
8602 Generate output containing 32381 instructions for floating point.  This
8603 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
8604 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
8605
8606 @item -mmulti-add
8607 @opindex mmulti-add
8608 Try and generate multiply-add floating point instructions @code{polyF}
8609 and @code{dotF}.  This option is only available if the @option{-m32381}
8610 option is in effect.  Using these instructions requires changes to to
8611 register allocation which generally has a negative impact on
8612 performance.  This option should only be enabled when compiling code
8613 particularly likely to make heavy use of multiply-add instructions.
8614
8615 @item -mnomulti-add
8616 @opindex mnomulti-add
8617 Do not try and generate multiply-add floating point instructions
8618 @code{polyF} and @code{dotF}.  This is the default on all platforms.
8619
8620 @item -msoft-float
8621 @opindex msoft-float
8622 Generate output containing library calls for floating point.
8623 @strong{Warning:} the requisite libraries may not be available.
8624
8625 @item -mnobitfield
8626 @opindex mnobitfield
8627 Do not use the bit-field instructions.  On some machines it is faster to
8628 use shifting and masking operations.  This is the default for the pc532.
8629
8630 @item -mbitfield
8631 @opindex mbitfield
8632 Do use the bit-field instructions.  This is the default for all platforms
8633 except the pc532.
8634
8635 @item -mrtd
8636 @opindex mrtd
8637 Use a different function-calling convention, in which functions
8638 that take a fixed number of arguments return pop their
8639 arguments on return with the @code{ret} instruction.
8640
8641 This calling convention is incompatible with the one normally
8642 used on Unix, so you cannot use it if you need to call libraries
8643 compiled with the Unix compiler.
8644
8645 Also, you must provide function prototypes for all functions that
8646 take variable numbers of arguments (including @code{printf});
8647 otherwise incorrect code will be generated for calls to those
8648 functions.
8649
8650 In addition, seriously incorrect code will result if you call a
8651 function with too many arguments.  (Normally, extra arguments are
8652 harmlessly ignored.)
8653
8654 This option takes its name from the 680x0 @code{rtd} instruction.
8655
8656
8657 @item -mregparam
8658 @opindex mregparam
8659 Use a different function-calling convention where the first two arguments
8660 are passed in registers.
8661
8662 This calling convention is incompatible with the one normally
8663 used on Unix, so you cannot use it if you need to call libraries
8664 compiled with the Unix compiler.
8665
8666 @item -mnoregparam
8667 @opindex mnoregparam
8668 Do not pass any arguments in registers.  This is the default for all
8669 targets.
8670
8671 @item -msb
8672 @opindex msb
8673 It is OK to use the sb as an index register which is always loaded with
8674 zero.  This is the default for the pc532-netbsd target.
8675
8676 @item -mnosb
8677 @opindex mnosb
8678 The sb register is not available for use or has not been initialized to
8679 zero by the run time system.  This is the default for all targets except
8680 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
8681 @option{-fpic} is set.
8682
8683 @item -mhimem
8684 @opindex mhimem
8685 Many ns32000 series addressing modes use displacements of up to 512MB@.
8686 If an address is above 512MB then displacements from zero can not be used.
8687 This option causes code to be generated which can be loaded above 512MB@.
8688 This may be useful for operating systems or ROM code.
8689
8690 @item -mnohimem
8691 @opindex mnohimem
8692 Assume code will be loaded in the first 512MB of virtual address space.
8693 This is the default for all platforms.
8694
8695
8696 @end table
8697
8698 @node AVR Options
8699 @subsection AVR Options
8700 @cindex AVR Options
8701
8702 These options are defined for AVR implementations:
8703
8704 @table @gcctabopt
8705 @item -mmcu=@var{mcu}
8706 @opindex mmcu
8707 Specify ATMEL AVR instruction set or MCU type.
8708
8709 Instruction set avr1 is for the minimal AVR core, not supported by the C
8710 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
8711 attiny11, attiny12, attiny15, attiny28).
8712
8713 Instruction set avr2 (default) is for the classic AVR core with up to
8714 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
8715 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
8716 at90c8534, at90s8535).
8717
8718 Instruction set avr3 is for the classic AVR core with up to 128K program
8719 memory space (MCU types: atmega103, atmega603).
8720
8721 Instruction set avr4 is for the enhanced AVR core with up to 8K program
8722 memory space (MCU types: atmega83, atmega85).
8723
8724 Instruction set avr5 is for the enhanced AVR core with up to 128K program
8725 memory space (MCU types: atmega161, atmega163, atmega32, at94k).
8726
8727 @item -msize
8728 @opindex msize
8729 Output instruction sizes to the asm file.
8730
8731 @item -minit-stack=@var{N}
8732 @opindex minit-stack
8733 Specify the initial stack address, which may be a symbol or numeric value,
8734 @samp{__stack} is the default.
8735
8736 @item -mno-interrupts
8737 @opindex mno-interrupts
8738 Generated code is not compatible with hardware interrupts.
8739 Code size will be smaller.
8740
8741 @item -mcall-prologues
8742 @opindex mcall-prologues
8743 Functions prologues/epilogues expanded as call to appropriate
8744 subroutines.  Code size will be smaller.
8745
8746 @item -mno-tablejump
8747 @opindex mno-tablejump
8748 Do not generate tablejump insns which sometimes increase code size.
8749
8750 @item -mtiny-stack
8751 @opindex mtiny-stack
8752 Change only the low 8 bits of the stack pointer.
8753 @end table
8754
8755 @node MCore Options
8756 @subsection MCore Options
8757 @cindex MCore options
8758
8759 These are the @samp{-m} options defined for the Motorola M*Core
8760 processors.
8761
8762 @table @gcctabopt
8763
8764 @item -mhardlit
8765 @itemx -mhardlit
8766 @itemx -mno-hardlit
8767 @opindex mhardlit
8768 @opindex mhardlit
8769 @opindex mno-hardlit
8770 Inline constants into the code stream if it can be done in two
8771 instructions or less.
8772
8773 @item -mdiv
8774 @itemx -mdiv
8775 @itemx -mno-div
8776 @opindex mdiv
8777 @opindex mdiv
8778 @opindex mno-div
8779 Use the divide instruction.  (Enabled by default).
8780
8781 @item -mrelax-immediate
8782 @itemx -mrelax-immediate
8783 @itemx -mno-relax-immediate
8784 @opindex mrelax-immediate
8785 @opindex mrelax-immediate
8786 @opindex mno-relax-immediate
8787 Allow arbitrary sized immediates in bit operations.
8788
8789 @item -mwide-bitfields
8790 @itemx -mwide-bitfields
8791 @itemx -mno-wide-bitfields
8792 @opindex mwide-bitfields
8793 @opindex mwide-bitfields
8794 @opindex mno-wide-bitfields
8795 Always treat bit-fields as int-sized.
8796
8797 @item -m4byte-functions
8798 @itemx -m4byte-functions
8799 @itemx -mno-4byte-functions
8800 @opindex m4byte-functions
8801 @opindex m4byte-functions
8802 @opindex mno-4byte-functions
8803 Force all functions to be aligned to a four byte boundary.
8804
8805 @item -mcallgraph-data
8806 @itemx -mcallgraph-data
8807 @itemx -mno-callgraph-data
8808 @opindex mcallgraph-data
8809 @opindex mcallgraph-data
8810 @opindex mno-callgraph-data
8811 Emit callgraph information.
8812
8813 @item -mslow-bytes
8814 @itemx -mslow-bytes
8815 @itemx -mno-slow-bytes
8816 @opindex mslow-bytes
8817 @opindex mslow-bytes
8818 @opindex mno-slow-bytes
8819 Prefer word access when reading byte quantities.
8820
8821 @item -mlittle-endian
8822 @itemx -mlittle-endian
8823 @itemx -mbig-endian
8824 @opindex mlittle-endian
8825 @opindex mlittle-endian
8826 @opindex mbig-endian
8827 Generate code for a little endian target.
8828
8829 @item -m210
8830 @itemx -m210
8831 @itemx -m340
8832 @opindex m210
8833 @opindex m210
8834 @opindex m340
8835 Generate code for the 210 processor.
8836 @end table
8837
8838 @node IA-64 Options
8839 @subsection IA-64 Options
8840 @cindex IA-64 Options
8841
8842 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8843
8844 @table @gcctabopt
8845 @item -mbig-endian
8846 @opindex mbig-endian
8847 Generate code for a big endian target.  This is the default for HPUX@.
8848
8849 @item -mlittle-endian
8850 @opindex mlittle-endian
8851 Generate code for a little endian target.  This is the default for AIX5
8852 and Linux.
8853
8854 @item -mgnu-as
8855 @itemx -mno-gnu-as
8856 @opindex mgnu-as
8857 @opindex mno-gnu-as
8858 Generate (or don't) code for the GNU assembler.  This is the default.
8859 @c Also, this is the default if the configure option @option{--with-gnu-as}
8860 @c is used.
8861
8862 @item -mgnu-ld
8863 @itemx -mno-gnu-ld
8864 @opindex mgnu-ld
8865 @opindex mno-gnu-ld
8866 Generate (or don't) code for the GNU linker.  This is the default.
8867 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8868 @c is used.
8869
8870 @item -mno-pic
8871 @opindex mno-pic
8872 Generate code that does not use a global pointer register.  The result
8873 is not position independent code, and violates the IA-64 ABI@.
8874
8875 @item -mvolatile-asm-stop
8876 @itemx -mno-volatile-asm-stop
8877 @opindex mvolatile-asm-stop
8878 @opindex mno-volatile-asm-stop
8879 Generate (or don't) a stop bit immediately before and after volatile asm
8880 statements.
8881
8882 @item -mb-step
8883 @opindex mb-step
8884 Generate code that works around Itanium B step errata.
8885
8886 @item -mregister-names
8887 @itemx -mno-register-names
8888 @opindex mregister-names
8889 @opindex mno-register-names
8890 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8891 the stacked registers.  This may make assembler output more readable.
8892
8893 @item -mno-sdata
8894 @itemx -msdata
8895 @opindex mno-sdata
8896 @opindex msdata
8897 Disable (or enable) optimizations that use the small data section.  This may
8898 be useful for working around optimizer bugs.
8899
8900 @item -mconstant-gp
8901 @opindex mconstant-gp
8902 Generate code that uses a single constant global pointer value.  This is
8903 useful when compiling kernel code.
8904
8905 @item -mauto-pic
8906 @opindex mauto-pic
8907 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8908 This is useful when compiling firmware code.
8909
8910 @item -minline-divide-min-latency
8911 @opindex minline-divide-min-latency
8912 Generate code for inline divides using the minimum latency algorithm.
8913
8914 @item -minline-divide-max-throughput
8915 @opindex minline-divide-max-throughput
8916 Generate code for inline divides using the maximum throughput algorithm.
8917
8918 @item -mno-dwarf2-asm
8919 @itemx -mdwarf2-asm
8920 @opindex mno-dwarf2-asm
8921 @opindex mdwarf2-asm
8922 Don't (or do) generate assembler code for the DWARF2 line number debugging
8923 info.  This may be useful when not using the GNU assembler.
8924
8925 @item -mfixed-range=@var{register-range}
8926 @opindex mfixed-range
8927 Generate code treating the given register range as fixed registers.
8928 A fixed register is one that the register allocator can not use.  This is
8929 useful when compiling kernel code.  A register range is specified as
8930 two registers separated by a dash.  Multiple register ranges can be
8931 specified separated by a comma.
8932 @end table
8933
8934 @node D30V Options
8935 @subsection D30V Options
8936 @cindex D30V Options
8937
8938 These @samp{-m} options are defined for D30V implementations:
8939
8940 @table @gcctabopt
8941 @item -mextmem
8942 @opindex mextmem
8943 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
8944 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
8945 memory, which starts at location @code{0x80000000}.
8946
8947 @item -mextmemory
8948 @opindex mextmemory
8949 Same as the @option{-mextmem} switch.
8950
8951 @item -monchip
8952 @opindex monchip
8953 Link the @samp{.text} section into onchip text memory, which starts at
8954 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
8955 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
8956 into onchip data memory, which starts at location @code{0x20000000}.
8957
8958 @item -mno-asm-optimize
8959 @itemx -masm-optimize
8960 @opindex mno-asm-optimize
8961 @opindex masm-optimize
8962 Disable (enable) passing @option{-O} to the assembler when optimizing.
8963 The assembler uses the @option{-O} option to automatically parallelize
8964 adjacent short instructions where possible.
8965
8966 @item -mbranch-cost=@var{n}
8967 @opindex mbranch-cost
8968 Increase the internal costs of branches to @var{n}.  Higher costs means
8969 that the compiler will issue more instructions to avoid doing a branch.
8970 The default is 2.
8971
8972 @item -mcond-exec=@var{n}
8973 @opindex mcond-exec
8974 Specify the maximum number of conditionally executed instructions that
8975 replace a branch.  The default is 4.
8976 @end table
8977
8978 @node S/390 and zSeries Options
8979 @subsection S/390 and zSeries Options
8980 @cindex S/390 and zSeries Options
8981
8982 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
8983
8984 @table @gcctabopt
8985 @item -mhard-float
8986 @itemx -msoft-float
8987 @opindex mhard-float
8988 @opindex msoft-float
8989 Use (do not use) the hardware floating-point instructions and registers
8990 for floating-point operations.  When @option{-msoft-float} is specified,
8991 functions in @file{libgcc.a} will be used to perform floating-point
8992 operations.  When @option{-mhard-float} is specified, the compiler
8993 generates IEEE floating-point instructions.  This is the default.
8994
8995 @item -mbackchain
8996 @itemx -mno-backchain
8997 @opindex mbackchain
8998 @opindex mno-backchain
8999 Generate (or do not generate) code which maintains an explicit 
9000 backchain within the stack frame that points to the caller's frame.
9001 This is currently needed to allow debugging.  The default is to
9002 generate the backchain.
9003
9004 @item -msmall-exec
9005 @itemx -mno-small-exec
9006 @opindex msmall-exec
9007 @opindex mno-small-exec
9008 Generate (or do not generate) code using the @code{bras} instruction 
9009 to do subroutine calls. 
9010 This only works reliably if the total executable size does not
9011 exceed 64k.  The default is to use the @code{basr} instruction instead,
9012 which does not have this limitation.
9013
9014 @item -m64
9015 @itemx -m31
9016 @opindex m64
9017 @opindex m31
9018 When @option{-m31} is specified, generate code compliant to the
9019 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9020 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9021 particular to generate 64-bit instructions.  For the @samp{s390}
9022 targets, the default is @option{-m31}, while the @samp{s390x} 
9023 targets default to @option{-m64}.
9024
9025 @item -mmvcle
9026 @itemx -mno-mvcle
9027 @opindex mmvcle
9028 @opindex mno-mvcle
9029 Generate (or do not generate) code using the @code{mvcle} instruction 
9030 to perform block moves.  When @option{-mno-mvcle} is specifed,
9031 use a @code{mvc} loop instead.  This is the default.
9032
9033 @item -mdebug
9034 @itemx -mno-debug
9035 @opindex mdebug
9036 @opindex mno-debug
9037 Print (or do not print) additional debug information when compiling.
9038 The default is to not print debug information.
9039
9040 @end table
9041
9042
9043 @node Code Gen Options
9044 @section Options for Code Generation Conventions
9045 @cindex code generation conventions
9046 @cindex options, code generation
9047 @cindex run-time options
9048
9049 These machine-independent options control the interface conventions
9050 used in code generation.
9051
9052 Most of them have both positive and negative forms; the negative form
9053 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
9054 one of the forms is listed---the one which is not the default.  You
9055 can figure out the other form by either removing @samp{no-} or adding
9056 it.
9057
9058 @table @gcctabopt
9059 @item -fexceptions
9060 @opindex fexceptions
9061 Enable exception handling.  Generates extra code needed to propagate
9062 exceptions.  For some targets, this implies GCC will generate frame
9063 unwind information for all functions, which can produce significant data
9064 size overhead, although it does not affect execution.  If you do not
9065 specify this option, GCC will enable it by default for languages like
9066 C++ which normally require exception handling, and disable it for
9067 languages like C that do not normally require it.  However, you may need
9068 to enable this option when compiling C code that needs to interoperate
9069 properly with exception handlers written in C++.  You may also wish to
9070 disable this option if you are compiling older C++ programs that don't
9071 use exception handling.
9072
9073 @item -fnon-call-exceptions
9074 @opindex fnon-call-exceptions
9075 Generate code that allows trapping instructions to throw exceptions.
9076 Note that this requires platform-specific runtime support that does
9077 not exist everywhere.  Moreover, it only allows @emph{trapping}
9078 instructions to throw exceptions, i.e.@: memory references or floating
9079 point instructions.  It does not allow exceptions to be thrown from
9080 arbitrary signal handlers such as @code{SIGALRM}.
9081
9082 @item -funwind-tables
9083 @opindex funwind-tables
9084 Similar to @option{-fexceptions}, except that it will just generate any needed
9085 static data, but will not affect the generated code in any other way.
9086 You will normally not enable this option; instead, a language processor
9087 that needs this handling would enable it on your behalf.
9088
9089 @item -fpcc-struct-return
9090 @opindex fpcc-struct-return
9091 Return ``short'' @code{struct} and @code{union} values in memory like
9092 longer ones, rather than in registers.  This convention is less
9093 efficient, but it has the advantage of allowing intercallability between
9094 GCC-compiled files and files compiled with other compilers.
9095
9096 The precise convention for returning structures in memory depends
9097 on the target configuration macros.
9098
9099 Short structures and unions are those whose size and alignment match
9100 that of some integer type.
9101
9102 @item -freg-struct-return
9103 @opindex freg-struct-return
9104 Return @code{struct} and @code{union} values in registers when possible.
9105 This is more efficient for small structures than
9106 @option{-fpcc-struct-return}.
9107
9108 If you specify neither @option{-fpcc-struct-return} nor
9109 @option{-freg-struct-return}, GCC defaults to whichever convention is
9110 standard for the target.  If there is no standard convention, GCC
9111 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
9112 the principal compiler.  In those cases, we can choose the standard, and
9113 we chose the more efficient register return alternative.
9114
9115 @item -fshort-enums
9116 @opindex fshort-enums
9117 Allocate to an @code{enum} type only as many bytes as it needs for the
9118 declared range of possible values.  Specifically, the @code{enum} type
9119 will be equivalent to the smallest integer type which has enough room.
9120
9121 @item -fshort-double
9122 @opindex fshort-double
9123 Use the same size for @code{double} as for @code{float}.
9124
9125 @item -fshared-data
9126 @opindex fshared-data
9127 Requests that the data and non-@code{const} variables of this
9128 compilation be shared data rather than private data.  The distinction
9129 makes sense only on certain operating systems, where shared data is
9130 shared between processes running the same program, while private data
9131 exists in one copy per process.
9132
9133 @item -fno-common
9134 @opindex fno-common
9135 In C, allocate even uninitialized global variables in the data section of the
9136 object file, rather than generating them as common blocks.  This has the
9137 effect that if the same variable is declared (without @code{extern}) in
9138 two different compilations, you will get an error when you link them.
9139 The only reason this might be useful is if you wish to verify that the
9140 program will work on other systems which always work this way.
9141
9142 @item -fno-ident
9143 @opindex fno-ident
9144 Ignore the @samp{#ident} directive.
9145
9146 @item -fno-gnu-linker
9147 @opindex fno-gnu-linker
9148 Do not output global initializations (such as C++ constructors and
9149 destructors) in the form used by the GNU linker (on systems where the GNU
9150 linker is the standard method of handling them).  Use this option when
9151 you want to use a non-GNU linker, which also requires using the
9152 @command{collect2} program to make sure the system linker includes
9153 constructors and destructors.  (@command{collect2} is included in the GCC
9154 distribution.)  For systems which @emph{must} use @command{collect2}, the
9155 compiler driver @command{gcc} is configured to do this automatically.
9156
9157 @item -finhibit-size-directive
9158 @opindex finhibit-size-directive
9159 Don't output a @code{.size} assembler directive, or anything else that
9160 would cause trouble if the function is split in the middle, and the
9161 two halves are placed at locations far apart in memory.  This option is
9162 used when compiling @file{crtstuff.c}; you should not need to use it
9163 for anything else.
9164
9165 @item -fverbose-asm
9166 @opindex fverbose-asm
9167 Put extra commentary information in the generated assembly code to
9168 make it more readable.  This option is generally only of use to those
9169 who actually need to read the generated assembly code (perhaps while
9170 debugging the compiler itself).
9171
9172 @option{-fno-verbose-asm}, the default, causes the
9173 extra information to be omitted and is useful when comparing two assembler
9174 files.
9175
9176 @item -fvolatile
9177 @opindex fvolatile
9178 Consider all memory references through pointers to be volatile.
9179
9180 @item -fvolatile-global
9181 @opindex fvolatile-global
9182 Consider all memory references to extern and global data items to
9183 be volatile.  GCC does not consider static data items to be volatile
9184 because of this switch.
9185
9186 @item -fvolatile-static
9187 @opindex fvolatile-static
9188 Consider all memory references to static data to be volatile.
9189
9190 @item -fpic
9191 @opindex fpic
9192 @cindex global offset table
9193 @cindex PIC
9194 Generate position-independent code (PIC) suitable for use in a shared
9195 library, if supported for the target machine.  Such code accesses all
9196 constant addresses through a global offset table (GOT)@.  The dynamic
9197 loader resolves the GOT entries when the program starts (the dynamic
9198 loader is not part of GCC; it is part of the operating system).  If
9199 the GOT size for the linked executable exceeds a machine-specific
9200 maximum size, you get an error message from the linker indicating that
9201 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
9202 instead.  (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
9203 on the m68k and RS/6000.  The 386 has no such limit.)
9204
9205 Position-independent code requires special support, and therefore works
9206 only on certain machines.  For the 386, GCC supports PIC for System V
9207 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
9208 position-independent.
9209
9210 @item -fPIC
9211 @opindex fPIC
9212 If supported for the target machine, emit position-independent code,
9213 suitable for dynamic linking and avoiding any limit on the size of the
9214 global offset table.  This option makes a difference on the m68k, m88k,
9215 and the Sparc.
9216
9217 Position-independent code requires special support, and therefore works
9218 only on certain machines.
9219
9220 @item -ffixed-@var{reg}
9221 @opindex ffixed
9222 Treat the register named @var{reg} as a fixed register; generated code
9223 should never refer to it (except perhaps as a stack pointer, frame
9224 pointer or in some other fixed role).
9225
9226 @var{reg} must be the name of a register.  The register names accepted
9227 are machine-specific and are defined in the @code{REGISTER_NAMES}
9228 macro in the machine description macro file.
9229
9230 This flag does not have a negative form, because it specifies a
9231 three-way choice.
9232
9233 @item -fcall-used-@var{reg}
9234 @opindex fcall-used
9235 Treat the register named @var{reg} as an allocable register that is
9236 clobbered by function calls.  It may be allocated for temporaries or
9237 variables that do not live across a call.  Functions compiled this way
9238 will not save and restore the register @var{reg}.
9239
9240 It is an error to used this flag with the frame pointer or stack pointer.
9241 Use of this flag for other registers that have fixed pervasive roles in
9242 the machine's execution model will produce disastrous results.
9243
9244 This flag does not have a negative form, because it specifies a
9245 three-way choice.
9246
9247 @item -fcall-saved-@var{reg}
9248 @opindex fcall-saved
9249 Treat the register named @var{reg} as an allocable register saved by
9250 functions.  It may be allocated even for temporaries or variables that
9251 live across a call.  Functions compiled this way will save and restore
9252 the register @var{reg} if they use it.
9253
9254 It is an error to used this flag with the frame pointer or stack pointer.
9255 Use of this flag for other registers that have fixed pervasive roles in
9256 the machine's execution model will produce disastrous results.
9257
9258 A different sort of disaster will result from the use of this flag for
9259 a register in which function values may be returned.
9260
9261 This flag does not have a negative form, because it specifies a
9262 three-way choice.
9263
9264 @item -fpack-struct
9265 @opindex fpack-struct
9266 Pack all structure members together without holes.  Usually you would
9267 not want to use this option, since it makes the code suboptimal, and
9268 the offsets of structure members won't agree with system libraries.
9269
9270 @item -fcheck-memory-usage
9271 @opindex fcheck-memory-usage
9272 Generate extra code to check each memory access.  GCC will generate
9273 code that is suitable for a detector of bad memory accesses such as
9274 @file{Checker}.
9275
9276 Normally, you should compile all, or none, of your code with this option.
9277
9278 If you do mix code compiled with and without this option,
9279 you must ensure that all code that has side effects
9280 and that is called by code compiled with this option
9281 is, itself, compiled with this option.
9282 If you do not, you might get erroneous messages from the detector.
9283
9284 If you use functions from a library that have side-effects (such as
9285 @code{read}), you might not be able to recompile the library and
9286 specify this option.  In that case, you can enable the
9287 @option{-fprefix-function-name} option, which requests GCC to encapsulate
9288 your code and make other functions look as if they were compiled with
9289 @option{-fcheck-memory-usage}.  This is done by calling ``stubs'',
9290 which are provided by the detector.  If you cannot find or build
9291 stubs for every function you call, you might have to specify
9292 @option{-fcheck-memory-usage} without @option{-fprefix-function-name}.
9293
9294 If you specify this option, you can not use the @code{asm} or
9295 @code{__asm__} keywords in functions with memory checking enabled.  GCC
9296 cannot understand what the @code{asm} statement may do, and therefore
9297 cannot generate the appropriate code, so it will reject it.  However, if
9298 you specify the function attribute @code{no_check_memory_usage}
9299 (@pxref{Function Attributes}), GCC will disable memory checking within a
9300 function; you may use @code{asm} statements inside such functions.  You
9301 may have an inline expansion of a non-checked function within a checked
9302 function; in that case GCC will not generate checks for the inlined
9303 function's memory accesses.
9304
9305 If you move your @code{asm} statements to non-checked inline functions
9306 and they do access memory, you can add calls to the support code in your
9307 inline function, to indicate any reads, writes, or copies being done.
9308 These calls would be similar to those done in the stubs described above.
9309
9310 @item -fprefix-function-name
9311 @opindex fprefix-function-name
9312 Request GCC to add a prefix to the symbols generated for function names.
9313 GCC adds a prefix to the names of functions defined as well as
9314 functions called.  Code compiled with this option and code compiled
9315 without the option can't be linked together, unless stubs are used.
9316
9317 If you compile the following code with @option{-fprefix-function-name}
9318 @example
9319 extern void bar (int);
9320 void
9321 foo (int a)
9322 @{
9323   return bar (a + 5);
9324 @}
9325 @end example
9326
9327 @noindent
9328 GCC will compile the code as if it was written:
9329 @example
9330 extern void prefix_bar (int);
9331 void
9332 prefix_foo (int a)
9333 @{
9334   return prefix_bar (a + 5);
9335 @}
9336 @end example
9337 This option is designed to be used with @option{-fcheck-memory-usage}.
9338
9339 @item -finstrument-functions
9340 @opindex finstrument-functions
9341 Generate instrumentation calls for entry and exit to functions.  Just
9342 after function entry and just before function exit, the following
9343 profiling functions will be called with the address of the current
9344 function and its call site.  (On some platforms,
9345 @code{__builtin_return_address} does not work beyond the current
9346 function, so the call site information may not be available to the
9347 profiling functions otherwise.)
9348
9349 @example
9350 void __cyg_profile_func_enter (void *this_fn,
9351                                void *call_site);
9352 void __cyg_profile_func_exit  (void *this_fn,
9353                                void *call_site);
9354 @end example
9355
9356 The first argument is the address of the start of the current function,
9357 which may be looked up exactly in the symbol table.
9358
9359 This instrumentation is also done for functions expanded inline in other
9360 functions.  The profiling calls will indicate where, conceptually, the
9361 inline function is entered and exited.  This means that addressable
9362 versions of such functions must be available.  If all your uses of a
9363 function are expanded inline, this may mean an additional expansion of
9364 code size.  If you use @samp{extern inline} in your C code, an
9365 addressable version of such functions must be provided.  (This is
9366 normally the case anyways, but if you get lucky and the optimizer always
9367 expands the functions inline, you might have gotten away without
9368 providing static copies.)
9369
9370 A function may be given the attribute @code{no_instrument_function}, in
9371 which case this instrumentation will not be done.  This can be used, for
9372 example, for the profiling functions listed above, high-priority
9373 interrupt routines, and any functions from which the profiling functions
9374 cannot safely be called (perhaps signal handlers, if the profiling
9375 routines generate output or allocate memory).
9376
9377 @item -fstack-check
9378 @opindex fstack-check
9379 Generate code to verify that you do not go beyond the boundary of the
9380 stack.  You should specify this flag if you are running in an
9381 environment with multiple threads, but only rarely need to specify it in
9382 a single-threaded environment since stack overflow is automatically
9383 detected on nearly all systems if there is only one stack.
9384
9385 Note that this switch does not actually cause checking to be done; the
9386 operating system must do that.  The switch causes generation of code
9387 to ensure that the operating system sees the stack being extended.
9388
9389 @item -fstack-limit-register=@var{reg}
9390 @itemx -fstack-limit-symbol=@var{sym}
9391 @itemx -fno-stack-limit
9392 @opindex fstack-limit-register
9393 @opindex fstack-limit-symbol
9394 @opindex fno-stack-limit
9395 Generate code to ensure that the stack does not grow beyond a certain value,
9396 either the value of a register or the address of a symbol.  If the stack
9397 would grow beyond the value, a signal is raised.  For most targets,
9398 the signal is raised before the stack overruns the boundary, so
9399 it is possible to catch the signal without taking special precautions.
9400
9401 For instance, if the stack starts at absolute address @samp{0x80000000}
9402 and grows downwards, you can use the flags
9403 @option{-fstack-limit-symbol=__stack_limit} and
9404 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
9405 of 128KB@.  Note that this may only work with the GNU linker.
9406
9407 @cindex aliasing of parameters
9408 @cindex parameters, aliased
9409 @item -fargument-alias
9410 @itemx -fargument-noalias
9411 @itemx -fargument-noalias-global
9412 @opindex fargument-alias
9413 @opindex fargument-noalias
9414 @opindex fargument-noalias-global
9415 Specify the possible relationships among parameters and between
9416 parameters and global data.
9417
9418 @option{-fargument-alias} specifies that arguments (parameters) may
9419 alias each other and may alias global storage.@*
9420 @option{-fargument-noalias} specifies that arguments do not alias
9421 each other, but may alias global storage.@*
9422 @option{-fargument-noalias-global} specifies that arguments do not
9423 alias each other and do not alias global storage.
9424
9425 Each language will automatically use whatever option is required by
9426 the language standard.  You should not need to use these options yourself.
9427
9428 @item -fleading-underscore
9429 @opindex fleading-underscore
9430 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
9431 change the way C symbols are represented in the object file.  One use
9432 is to help link with legacy assembly code.
9433
9434 Be warned that you should know what you are doing when invoking this
9435 option, and that not all targets provide complete support for it.
9436 @end table
9437
9438 @c man end
9439
9440 @node Environment Variables
9441 @section Environment Variables Affecting GCC
9442 @cindex environment variables
9443
9444 @c man begin ENVIRONMENT
9445
9446 This section describes several environment variables that affect how GCC
9447 operates.  Some of them work by specifying directories or prefixes to use
9448 when searching for various kinds of files.  Some are used to specify other
9449 aspects of the compilation environment.
9450
9451 @ifclear INTERNALS
9452 Note that you can also specify places to search using options such as
9453 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
9454 take precedence over places specified using environment variables, which
9455 in turn take precedence over those specified by the configuration of GCC@.
9456
9457 @end ifclear
9458 @ifset INTERNALS
9459 Note that you can also specify places to search using options such as
9460 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
9461 take precedence over places specified using environment variables, which
9462 in turn take precedence over those specified by the configuration of GCC@.
9463 @xref{Driver}.
9464 @end ifset
9465
9466 @table @env
9467 @item LANG
9468 @itemx LC_CTYPE
9469 @c @itemx LC_COLLATE
9470 @itemx LC_MESSAGES
9471 @c @itemx LC_MONETARY
9472 @c @itemx LC_NUMERIC
9473 @c @itemx LC_TIME
9474 @itemx LC_ALL
9475 @findex LANG
9476 @findex LC_CTYPE
9477 @c @findex LC_COLLATE
9478 @findex LC_MESSAGES
9479 @c @findex LC_MONETARY
9480 @c @findex LC_NUMERIC
9481 @c @findex LC_TIME
9482 @findex LC_ALL
9483 @cindex locale
9484 These environment variables control the way that GCC uses
9485 localization information that allow GCC to work with different
9486 national conventions.  GCC inspects the locale categories
9487 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
9488 so.  These locale categories can be set to any value supported by your
9489 installation.  A typical value is @samp{en_UK} for English in the United
9490 Kingdom.
9491
9492 The @env{LC_CTYPE} environment variable specifies character
9493 classification.  GCC uses it to determine the character boundaries in
9494 a string; this is needed for some multibyte encodings that contain quote
9495 and escape characters that would otherwise be interpreted as a string
9496 end or escape.
9497
9498 The @env{LC_MESSAGES} environment variable specifies the language to
9499 use in diagnostic messages.
9500
9501 If the @env{LC_ALL} environment variable is set, it overrides the value
9502 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
9503 and @env{LC_MESSAGES} default to the value of the @env{LANG}
9504 environment variable.  If none of these variables are set, GCC
9505 defaults to traditional C English behavior.
9506
9507 @item TMPDIR
9508 @findex TMPDIR
9509 If @env{TMPDIR} is set, it specifies the directory to use for temporary
9510 files.  GCC uses temporary files to hold the output of one stage of
9511 compilation which is to be used as input to the next stage: for example,
9512 the output of the preprocessor, which is the input to the compiler
9513 proper.
9514
9515 @item GCC_EXEC_PREFIX
9516 @findex GCC_EXEC_PREFIX
9517 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
9518 names of the subprograms executed by the compiler.  No slash is added
9519 when this prefix is combined with the name of a subprogram, but you can
9520 specify a prefix that ends with a slash if you wish.
9521
9522 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
9523 an appropriate prefix to use based on the pathname it was invoked with.
9524
9525 If GCC cannot find the subprogram using the specified prefix, it
9526 tries looking in the usual places for the subprogram.
9527
9528 The default value of @env{GCC_EXEC_PREFIX} is
9529 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
9530 of @code{prefix} when you ran the @file{configure} script.
9531
9532 Other prefixes specified with @option{-B} take precedence over this prefix.
9533
9534 This prefix is also used for finding files such as @file{crt0.o} that are
9535 used for linking.
9536
9537 In addition, the prefix is used in an unusual way in finding the
9538 directories to search for header files.  For each of the standard
9539 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
9540 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
9541 replacing that beginning with the specified prefix to produce an
9542 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
9543 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
9544 These alternate directories are searched first; the standard directories
9545 come next.
9546
9547 @item COMPILER_PATH
9548 @findex COMPILER_PATH
9549 The value of @env{COMPILER_PATH} is a colon-separated list of
9550 directories, much like @env{PATH}.  GCC tries the directories thus
9551 specified when searching for subprograms, if it can't find the
9552 subprograms using @env{GCC_EXEC_PREFIX}.
9553
9554 @item LIBRARY_PATH
9555 @findex LIBRARY_PATH
9556 The value of @env{LIBRARY_PATH} is a colon-separated list of
9557 directories, much like @env{PATH}.  When configured as a native compiler,
9558 GCC tries the directories thus specified when searching for special
9559 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
9560 using GCC also uses these directories when searching for ordinary
9561 libraries for the @option{-l} option (but directories specified with
9562 @option{-L} come first).
9563
9564 @item C_INCLUDE_PATH
9565 @itemx CPLUS_INCLUDE_PATH
9566 @itemx OBJC_INCLUDE_PATH
9567 @findex C_INCLUDE_PATH
9568 @findex CPLUS_INCLUDE_PATH
9569 @findex OBJC_INCLUDE_PATH
9570 @c @itemx OBJCPLUS_INCLUDE_PATH
9571 These environment variables pertain to particular languages.  Each
9572 variable's value is a colon-separated list of directories, much like
9573 @env{PATH}.  When GCC searches for header files, it tries the
9574 directories listed in the variable for the language you are using, after
9575 the directories specified with @option{-I} but before the standard header
9576 file directories.
9577
9578 @item DEPENDENCIES_OUTPUT
9579 @findex DEPENDENCIES_OUTPUT
9580 @cindex dependencies for make as output
9581 If this variable is set, its value specifies how to output dependencies
9582 for Make based on the header files processed by the compiler.  This
9583 output looks much like the output from the @option{-M} option
9584 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
9585 in addition to the usual results of compilation.
9586
9587 The value of @env{DEPENDENCIES_OUTPUT} can be just a file name, in
9588 which case the Make rules are written to that file, guessing the target
9589 name from the source file name.  Or the value can have the form
9590 @samp{@var{file} @var{target}}, in which case the rules are written to
9591 file @var{file} using @var{target} as the target name.
9592
9593 @item LANG
9594 @findex LANG
9595 @cindex locale definition
9596 This variable is used to pass locale information to the compiler.  One way in
9597 which this information is used is to determine the character set to be used
9598 when character literals, string literals and comments are parsed in C and C++.
9599 When the compiler is configured to allow multibyte characters,
9600 the following values for @env{LANG} are recognized:
9601
9602 @table @samp
9603 @item C-JIS
9604 Recognize JIS characters.
9605 @item C-SJIS
9606 Recognize SJIS characters.
9607 @item C-EUCJP
9608 Recognize EUCJP characters.
9609 @end table
9610
9611 If @env{LANG} is not defined, or if it has some other value, then the
9612 compiler will use mblen and mbtowc as defined by the default locale to
9613 recognize and translate multibyte characters.
9614 @end table
9615
9616 @c man end
9617
9618 @node Running Protoize
9619 @section Running Protoize
9620
9621 The program @code{protoize} is an optional part of GCC@.  You can use
9622 it to add prototypes to a program, thus converting the program to ISO
9623 C in one respect.  The companion program @code{unprotoize} does the
9624 reverse: it removes argument types from any prototypes that are found.
9625
9626 When you run these programs, you must specify a set of source files as
9627 command line arguments.  The conversion programs start out by compiling
9628 these files to see what functions they define.  The information gathered
9629 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
9630
9631 After scanning comes actual conversion.  The specified files are all
9632 eligible to be converted; any files they include (whether sources or
9633 just headers) are eligible as well.
9634
9635 But not all the eligible files are converted.  By default,
9636 @code{protoize} and @code{unprotoize} convert only source and header
9637 files in the current directory.  You can specify additional directories
9638 whose files should be converted with the @option{-d @var{directory}}
9639 option.  You can also specify particular files to exclude with the
9640 @option{-x @var{file}} option.  A file is converted if it is eligible, its
9641 directory name matches one of the specified directory names, and its
9642 name within the directory has not been excluded.
9643
9644 Basic conversion with @code{protoize} consists of rewriting most
9645 function definitions and function declarations to specify the types of
9646 the arguments.  The only ones not rewritten are those for varargs
9647 functions.
9648
9649 @code{protoize} optionally inserts prototype declarations at the
9650 beginning of the source file, to make them available for any calls that
9651 precede the function's definition.  Or it can insert prototype
9652 declarations with block scope in the blocks where undeclared functions
9653 are called.
9654
9655 Basic conversion with @code{unprotoize} consists of rewriting most
9656 function declarations to remove any argument types, and rewriting
9657 function definitions to the old-style pre-ISO form.
9658
9659 Both conversion programs print a warning for any function declaration or
9660 definition that they can't convert.  You can suppress these warnings
9661 with @option{-q}.
9662
9663 The output from @code{protoize} or @code{unprotoize} replaces the
9664 original source file.  The original file is renamed to a name ending
9665 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
9666 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
9667 for DOS) file already exists, then the source file is simply discarded.
9668
9669 @code{protoize} and @code{unprotoize} both depend on GCC itself to
9670 scan the program and collect information about the functions it uses.
9671 So neither of these programs will work until GCC is installed.
9672
9673 Here is a table of the options you can use with @code{protoize} and
9674 @code{unprotoize}.  Each option works with both programs unless
9675 otherwise stated.
9676
9677 @table @code
9678 @item -B @var{directory}
9679 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
9680 usual directory (normally @file{/usr/local/lib}).  This file contains
9681 prototype information about standard system functions.  This option
9682 applies only to @code{protoize}.
9683
9684 @item -c @var{compilation-options}
9685 Use  @var{compilation-options} as the options when running @code{gcc} to
9686 produce the @samp{.X} files.  The special option @option{-aux-info} is
9687 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
9688
9689 Note that the compilation options must be given as a single argument to
9690 @code{protoize} or @code{unprotoize}.  If you want to specify several
9691 @code{gcc} options, you must quote the entire set of compilation options
9692 to make them a single word in the shell.
9693
9694 There are certain @code{gcc} arguments that you cannot use, because they
9695 would produce the wrong kind of output.  These include @option{-g},
9696 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
9697 the @var{compilation-options}, they are ignored.
9698
9699 @item -C
9700 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
9701 systems) instead of @samp{.c}.  This is convenient if you are converting
9702 a C program to C++.  This option applies only to @code{protoize}.
9703
9704 @item -g
9705 Add explicit global declarations.  This means inserting explicit
9706 declarations at the beginning of each source file for each function
9707 that is called in the file and was not declared.  These declarations
9708 precede the first function definition that contains a call to an
9709 undeclared function.  This option applies only to @code{protoize}.
9710
9711 @item -i @var{string}
9712 Indent old-style parameter declarations with the string @var{string}.
9713 This option applies only to @code{protoize}.
9714
9715 @code{unprotoize} converts prototyped function definitions to old-style
9716 function definitions, where the arguments are declared between the
9717 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
9718 uses five spaces as the indentation.  If you want to indent with just
9719 one space instead, use @option{-i " "}.
9720
9721 @item -k
9722 Keep the @samp{.X} files.  Normally, they are deleted after conversion
9723 is finished.
9724
9725 @item -l
9726 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
9727 a prototype declaration for each function in each block which calls the
9728 function without any declaration.  This option applies only to
9729 @code{protoize}.
9730
9731 @item -n
9732 Make no real changes.  This mode just prints information about the conversions
9733 that would have been done without @option{-n}.
9734
9735 @item -N
9736 Make no @samp{.save} files.  The original files are simply deleted.
9737 Use this option with caution.
9738
9739 @item -p @var{program}
9740 Use the program @var{program} as the compiler.  Normally, the name
9741 @file{gcc} is used.
9742
9743 @item -q
9744 Work quietly.  Most warnings are suppressed.
9745
9746 @item -v
9747 Print the version number, just like @option{-v} for @code{gcc}.
9748 @end table
9749
9750 If you need special compiler options to compile one of your program's
9751 source files, then you should generate that file's @samp{.X} file
9752 specially, by running @code{gcc} on that source file with the
9753 appropriate options and the option @option{-aux-info}.  Then run
9754 @code{protoize} on the entire set of files.  @code{protoize} will use
9755 the existing @samp{.X} file because it is newer than the source file.
9756 For example:
9757
9758 @example
9759 gcc -Dfoo=bar file1.c -aux-info file1.X
9760 protoize *.c
9761 @end example
9762
9763 @noindent
9764 You need to include the special files along with the rest in the
9765 @code{protoize} command, even though their @samp{.X} files already
9766 exist, because otherwise they won't get converted.
9767
9768 @xref{Protoize Caveats}, for more information on how to use
9769 @code{protoize} successfully.