* doc/invoke.texi: Minor spelling and grammar fixes.
[platform/upstream/gcc.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002 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, 2002 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.1 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
68 @c man begin DESCRIPTION
69
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75
76 Other options are passed on to one stage of processing.  Some options
77 control the preprocessor and others the compiler itself.  Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
80
81 @cindex C compilation options
82 Most of the command line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly.  If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
87
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
91
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands.  Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
97 -r}}.
98
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments.  For the most part, the order
102 you use doesn't matter.  Order does matter when you use several options
103 of the same kind; for example, if you specify @option{-L} more than once,
104 the directories are searched in the order specified.
105
106 Many options have long names starting with @samp{-f} or with
107 @samp{-W}---for example, @option{-fforce-mem},
108 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
109 these have both positive and negative forms; the negative form of
110 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
111 only one of these two forms, whichever one is not the default.
112
113 @c man end
114
115 @xref{Option Index}, for an index to GCC's options.
116
117 @menu
118 * Option Summary::      Brief list of all options, without explanations.
119 * Overall Options::     Controlling the kind of output:
120                         an executable, object files, assembler files,
121                         or preprocessed source.
122 * Invoking G++::        Compiling C++ programs.
123 * C Dialect Options::   Controlling the variant of C language compiled.
124 * C++ Dialect Options:: Variations on C++.
125 * Objective-C Dialect Options:: Variations on Objective-C.
126 * Language Independent Options:: Controlling how diagnostics should be
127                         formatted.
128 * Warning Options::     How picky should the compiler be?
129 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
130 * Optimize Options::    How much optimization?
131 * Preprocessor Options:: Controlling header files and macro definitions.
132                          Also, getting dependency information for Make.
133 * Assembler Options::   Passing options to the assembler.
134 * Link Options::        Specifying libraries and so on.
135 * Directory Options::   Where to find header files and libraries.
136                         Where to find the compiler executable files.
137 * Spec Files::          How to pass switches to sub-processes.
138 * Target Options::      Running a cross-compiler, or an old version of GCC.
139 * Submodel Options::    Specifying minor hardware or convention variations,
140                         such as 68010 vs 68020.
141 * Code Gen Options::    Specifying conventions for function calls, data layout
142                         and register usage.
143 * Environment Variables:: Env vars that affect GCC.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{
159 -c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  -x @var{language} @gol
160 -v  -###  --help  --target-help  --version}
161
162 @item C Language Options
163 @xref{C Dialect Options,,Options Controlling C Dialect}.
164 @gccoptlist{
165 -ansi  -std=@var{standard}  -aux-info @var{filename} @gol
166 -fno-asm  -fno-builtin -fno-builtin-@var{function} @gol
167 -fhosted  -ffreestanding  -fms-extensions @gol
168 -trigraphs  -traditional  -traditional-cpp @gol
169 -fallow-single-precision  -fcond-mismatch @gol
170 -fsigned-bitfields  -fsigned-char @gol
171 -funsigned-bitfields  -funsigned-char @gol
172 -fwritable-strings}
173
174 @item C++ Language Options
175 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
176 @gccoptlist{
177 -fabi-version=@var{n} -fno-access-control  -fcheck-new @gol
178 -fconserve-space -fno-const-strings  -fdollars-in-identifiers @gol
179 -fno-elide-constructors @gol
180 -fno-enforce-eh-specs  -fexternal-templates @gol
181 -falt-external-templates @gol
182 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
183 -fno-implicit-templates @gol
184 -fno-implicit-inline-templates @gol
185 -fno-implement-inlines  -fms-extensions @gol
186 -fno-nonansi-builtins  -fno-operator-names @gol
187 -fno-optional-diags  -fpermissive @gol
188 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
189 -fuse-cxa-atexit  -fvtable-gc  -fno-weak  -nostdinc++ @gol
190 -fno-default-inline -Wabi -Wctor-dtor-privacy @gol
191 -Wnon-virtual-dtor  -Wreorder @gol
192 -Weffc++  -Wno-deprecated @gol
193 -Wno-non-template-friend  -Wold-style-cast @gol
194 -Woverloaded-virtual  -Wno-pmf-conversions @gol
195 -Wsign-promo  -Wsynth}
196
197 @item Objective-C Language Options
198 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
199 @gccoptlist{
200 -fconstant-string-class=@var{class-name} @gol
201 -fgnu-runtime  -fnext-runtime  -gen-decls @gol
202 -Wno-protocol  -Wselector -Wundeclared-selector}
203
204 @item Language Independent Options
205 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
206 @gccoptlist{
207 -fmessage-length=@var{n}  @gol
208 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
209
210 @item Warning Options
211 @xref{Warning Options,,Options to Request or Suppress Warnings}.
212 @gccoptlist{
213 -fsyntax-only  -pedantic  -pedantic-errors @gol
214 -w  -W  -Wall -Waggregate-return @gol
215 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
216 -Wconversion  -Wno-deprecated-declarations @gol
217 -Wdisabled-optimization  -Wno-div-by-zero  -Werror @gol
218 -Wfloat-equal  -Wformat  -Wformat=2 @gol
219 -Wformat-nonliteral  -Wformat-security @gol
220 -Wimplicit  -Wimplicit-int  @gol
221 -Wimplicit-function-declaration @gol
222 -Werror-implicit-function-declaration @gol
223 -Wimport  -Winline -Wno-endif-labels @gol
224 -Wlarger-than-@var{len}  -Wlong-long @gol
225 -Wmain  -Wmissing-braces @gol
226 -Wmissing-format-attribute  -Wmissing-noreturn @gol
227 -Wno-multichar  -Wno-format-extra-args  -Wno-format-y2k @gol
228 -Wno-import  -Wnonnull  -Wpacked  -Wpadded @gol
229 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
230 -Wreturn-type  -Wsequence-point  -Wshadow @gol
231 -Wsign-compare  -Wstrict-aliasing @gol
232 -Wswitch  -Wswitch-default -Wswitch-enum @gol
233 -Wsystem-headers -Wtrigraphs  -Wundef  -Wuninitialized @gol
234 -Wunknown-pragmas  -Wunreachable-code @gol
235 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
236 -Wunused-value  -Wunused-variable  -Wwrite-strings}
237
238 @item C-only Warning Options
239 @gccoptlist{
240 -Wbad-function-cast  -Wmissing-declarations @gol
241 -Wmissing-prototypes  -Wnested-externs @gol
242 -Wstrict-prototypes  -Wtraditional}
243
244 @item Debugging Options
245 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
246 @gccoptlist{
247 -d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
248 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
249 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
250 -fdump-tree-original@r{[}-@var{n}@r{]} -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
251 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
252 -feliminate-dwarf2-dups  -fmem-report @gol
253 -fprofile-arcs  -fsched-verbose=@var{n} @gol
254 -ftest-coverage  -ftime-report @gol
255 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
256 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
257 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
258 -print-multi-directory  -print-multi-lib @gol
259 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
260 -save-temps  -time}
261
262 @item Optimization Options
263 @xref{Optimize Options,,Options that Control Optimization}.
264 @gccoptlist{
265 -falign-functions=@var{n}  -falign-jumps=@var{n} @gol
266 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
267 -fbounds-check @gol
268 -fbranch-probabilities  -fcaller-saves -fcprop-registers @gol
269 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
270 -fdelayed-branch  -fdelete-null-pointer-checks @gol
271 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
272 -fforce-addr  -fforce-mem  -ffunction-sections @gol
273 -fgcse  -fgcse-lm  -fgcse-sm -floop-optimize -fcrossjumping @gol
274 -fif-conversion -fif-conversion2 @gol
275 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
276 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
277 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
278 -fno-default-inline  -fno-defer-pop @gol
279 -fno-function-cse  -fno-guess-branch-probability @gol
280 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
281 -funsafe-math-optimizations -ffinite-math-only @gol
282 -fno-trapping-math -fno-zero-initialized-in-bss @gol
283 -fomit-frame-pointer  -foptimize-register-move @gol
284 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
285 -freduce-all-givs -fregmove  -frename-registers @gol
286 -freorder-blocks -freorder-functions @gol
287 -frerun-cse-after-loop  -frerun-loop-opt @gol
288 -fschedule-insns  -fschedule-insns2 @gol
289 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
290 -fsched-spec-load-dangerous  -fsignaling-nans @gol
291 -fsingle-precision-constant  -fssa -fssa-ccp -fssa-dce @gol
292 -fstrength-reduce  -fstrict-aliasing  -ftracer -fthread-jumps @gol
293 -ftrapv -funroll-all-loops  -funroll-loops  @gol
294 --param @var{name}=@var{value}
295 -O  -O0  -O1  -O2  -O3  -Os}
296
297 @item Preprocessor Options
298 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
299 @gccoptlist{
300 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
301 -C  -dD  -dI  -dM  -dN @gol
302 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
303 -idirafter @var{dir} @gol
304 -include @var{file}  -imacros @var{file} @gol
305 -iprefix @var{file}  -iwithprefix @var{dir} @gol
306 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
307 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
308 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} -Xpreprocessor @var{option}}
309
310 @item Assembler Option
311 @xref{Assembler Options,,Passing Options to the Assembler}.
312 @gccoptlist{
313 -Wa,@var{option} -Xassembler @var{option}}
314
315 @item Linker Options
316 @xref{Link Options,,Options for Linking}.
317 @gccoptlist{
318 @var{object-file-name}  -l@var{library} @gol
319 -nostartfiles  -nodefaultlibs  -nostdlib @gol
320 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
321 -Wl,@var{option}  -Xlinker @var{option} @gol
322 -u @var{symbol}}
323
324 @item Directory Options
325 @xref{Directory Options,,Options for Directory Search}.
326 @gccoptlist{
327 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
328
329 @item Target Options
330 @c I wrote this xref this way to avoid overfull hbox. -- rms
331 @xref{Target Options}.
332 @gccoptlist{
333 -V @var{version} -b @var{machine}}
334
335 @item Machine Dependent Options
336 @xref{Submodel Options,,Hardware Models and Configurations}.
337
338 @emph{M680x0 Options}
339 @gccoptlist{
340 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
341 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
342 -mfpa  -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
343 -malign-int  -mstrict-align}
344
345 @emph{M68hc1x Options}
346 @gccoptlist{
347 -m6811  -m6812  -m68hc11  -m68hc12 @gol
348 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
349 -msoft-reg-count=@var{count}}
350
351 @emph{VAX Options}
352 @gccoptlist{
353 -mg  -mgnu  -munix}
354
355 @emph{SPARC Options}
356 @gccoptlist{
357 -mcpu=@var{cpu-type} @gol
358 -mtune=@var{cpu-type} @gol
359 -mcmodel=@var{code-model} @gol
360 -m32  -m64 @gol
361 -mapp-regs  -mbroken-saverestore  -mcypress @gol
362 -mfaster-structs  -mflat @gol
363 -mfpu  -mhard-float  -mhard-quad-float @gol
364 -mimpure-text  -mlive-g0  -mno-app-regs @gol
365 -mno-faster-structs  -mno-flat  -mno-fpu @gol
366 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
367 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
368 -msupersparc  -munaligned-doubles  -mv8}
369
370 @emph{Convex Options}
371 @gccoptlist{
372 -mc1  -mc2  -mc32  -mc34  -mc38 @gol
373 -margcount  -mnoargcount @gol
374 -mlong32  -mlong64 @gol
375 -mvolatile-cache  -mvolatile-nocache}
376
377 @emph{AMD29K Options}
378 @gccoptlist{
379 -m29000  -m29050  -mbw  -mnbw  -mdw  -mndw @gol
380 -mlarge  -mnormal  -msmall @gol
381 -mkernel-registers  -mno-reuse-arg-regs @gol
382 -mno-stack-check  -mno-storem-bug @gol
383 -mreuse-arg-regs  -msoft-float  -mstack-check @gol
384 -mstorem-bug  -muser-registers}
385
386 @emph{ARM Options}
387 @gccoptlist{
388 -mapcs-frame  -mno-apcs-frame @gol
389 -mapcs-26  -mapcs-32 @gol
390 -mapcs-stack-check  -mno-apcs-stack-check @gol
391 -mapcs-float  -mno-apcs-float @gol
392 -mapcs-reentrant  -mno-apcs-reentrant @gol
393 -msched-prolog  -mno-sched-prolog @gol
394 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
395 -malignment-traps  -mno-alignment-traps @gol
396 -msoft-float  -mhard-float  -mfpe @gol
397 -mthumb-interwork  -mno-thumb-interwork @gol
398 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
399 -mstructure-size-boundary=@var{n} @gol
400 -mbsd -mxopen  -mno-symrename @gol
401 -mabort-on-noreturn @gol
402 -mlong-calls  -mno-long-calls @gol
403 -msingle-pic-base  -mno-single-pic-base @gol
404 -mpic-register=@var{reg} @gol
405 -mnop-fun-dllimport @gol
406 -mpoke-function-name @gol
407 -mthumb  -marm @gol
408 -mtpcs-frame  -mtpcs-leaf-frame @gol
409 -mcaller-super-interworking  -mcallee-super-interworking }
410
411 @emph{MN10200 Options}
412 @gccoptlist{
413 -mrelax}
414
415 @emph{MN10300 Options}
416 @gccoptlist{
417 -mmult-bug  -mno-mult-bug @gol
418 -mam33  -mno-am33 @gol
419 -mno-crt0  -mrelax}
420
421 @emph{M32R/D Options}
422 @gccoptlist{
423 -m32rx -m32r -mcode-model=@var{model-type}  -msdata=@var{sdata-type} @gol
424 -G @var{num}}
425
426 @emph{M88K Options}
427 @gccoptlist{
428 -m88000  -m88100  -m88110  -mbig-pic @gol
429 -mcheck-zero-division  -mhandle-large-shift @gol
430 -midentify-revision  -mno-check-zero-division @gol
431 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
432 -mno-optimize-arg-area  -mno-serialize-volatile @gol
433 -mno-underscores  -mocs-debug-info @gol
434 -mocs-frame-position  -moptimize-arg-area @gol
435 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
436 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
437 -mversion-03.00  -mwarn-passed-structs}
438
439 @emph{RS/6000 and PowerPC Options}
440 @gccoptlist{
441 -mcpu=@var{cpu-type} @gol
442 -mtune=@var{cpu-type} @gol
443 -mpower  -mno-power  -mpower2  -mno-power2 @gol
444 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
445 -maltivec -mno-altivec @gol
446 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
447 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
448 -mnew-mnemonics  -mold-mnemonics @gol
449 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
450 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
451 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
452 -mstring  -mno-string  -mupdate  -mno-update @gol
453 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
454 -mstrict-align  -mno-strict-align  -mrelocatable @gol
455 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
456 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
457 -mcall-aix -mcall-sysv -mcall-netbsd @gol
458 -maix-struct-return -msvr4-struct-return @gol
459 -mabi=altivec -mabi=no-altivec @gol
460 -mabi=spe -mabi=no-spe @gol
461 -misel=yes -misel=no @gol
462 -mprototype  -mno-prototype @gol
463 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
464 -msdata=@var{opt}  -mvxworks -mwindiss -G @var{num} -pthread}
465
466 @emph{Darwin Options}
467 @gccoptlist{
468 -all_load -allowable_client -arch -arch_errors_fatal @gol
469 -arch_only -bind_at_load -bundle -bundle_loader @gol
470 -client_name -compatibility_version -current_version @gol
471 -dependency-file -dylib_file -dylinker_install_name @gol
472 -dynamic -dynamiclib -exported_symbols_list @gol
473 -filelist -flat_namespace -force_cpusubtype_ALL @gol
474 -force_flat_namespace -headerpad_max_install_names @gol
475 -image_base -init -install_name -keep_private_externs @gol
476 -multi_module -multiply_defined -multiply_defined_unused @gol
477 -noall_load -nomultidefs -noprebind -noseglinkedit @gol
478 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
479 -private_bundle -read_only_relocs -sectalign @gol
480 -sectobjectsymbols -whyload -seg1addr @gol
481 -sectcreate -sectobjectsymbols -sectorder @gol
482 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
483 -segprot -segs_read_only_addr -segs_read_write_addr @gol
484 -single_module -static -sub_library -sub_umbrella @gol
485 -twolevel_namespace -umbrella -undefined @gol
486 -unexported_symbols_list -weak_reference_mismatches -whatsloaded}
487
488 @emph{RT Options}
489 @gccoptlist{
490 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
491 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
492 -mminimum-fp-blocks  -mnohc-struct-return}
493
494 @emph{MIPS Options}
495 @gccoptlist{
496 -mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
497 -mcpu=@var{cpu-type} -membedded-data  -muninit-const-in-rodata @gol
498 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
499 -mgas  -mgp32  -mgp64 @gol
500 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
501 -mips2  -mips3  -mips4  -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
502 -mmips-as  -mmips-tfile  -mno-abicalls @gol
503 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
504 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
505 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
506 -mrnames  -msoft-float @gol
507 -m4650  -msingle-float  -mmad @gol
508 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
509 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi @gol
510 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
511 -mbranch-likely -mno-branch-likely}
512
513 @emph{i386 and x86-64 Options}
514 @gccoptlist{
515 -mcpu=@var{cpu-type}  -march=@var{cpu-type} -mfpmath=@var{unit} @gol
516 -masm=@var{dialect}  -mno-fancy-math-387 @gol
517 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
518 -mno-wide-multiply  -mrtd  -malign-double @gol
519 -mpreferred-stack-boundary=@var{num} @gol
520 -mmmx  -msse -msse2 -m3dnow @gol
521 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
522 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
523 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
524 -mno-red-zone@gol
525 -mcmodel=@var{code-model} @gol
526 -m32 -m64}
527
528 @emph{HPPA Options}
529 @gccoptlist{
530 -march=@var{architecture-type} @gol
531 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
532 -mfast-indirect-calls  -mgas  -mgnu-ld -mhp-ld @gol
533 -mjump-in-delay -mlinker-opt -mlong-calls @gol
534 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
535 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
536 -mno-jump-in-delay  -mno-long-load-store @gol
537 -mno-portable-runtime  -mno-soft-float @gol
538 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
539 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
540 -mschedule=@var{cpu-type}  -mspace-regs -msio -mwsio}
541
542 @emph{Intel 960 Options}
543 @gccoptlist{
544 -m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
545 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
546 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
547 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
548 -mno-complex-addr  -mno-leaf-procedures @gol
549 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
550 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
551 -mtail-call}
552
553 @emph{DEC Alpha Options}
554 @gccoptlist{
555 -mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
556 -mieee  -mieee-with-inexact  -mieee-conformant @gol
557 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
558 -mtrap-precision=@var{mode}  -mbuild-constants @gol
559 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
560 -mbwx  -mmax  -mfix  -mcix @gol
561 -mfloat-vax  -mfloat-ieee @gol
562 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
563 -mmemory-latency=@var{time}}
564
565 @emph{DEC Alpha/VMS Options}
566 @gccoptlist{
567 -mvms-return-codes}
568
569 @emph{Clipper Options}
570 @gccoptlist{
571 -mc300  -mc400}
572
573 @emph{H8/300 Options}
574 @gccoptlist{
575 -mrelax  -mh  -ms  -mn  -mint32  -malign-300}
576
577 @emph{SH Options}
578 @gccoptlist{
579 -m1  -m2  -m3  -m3e @gol
580 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
581 -m5-64media -m5-64media-nofpu @gol
582 -m5-32media -m5-32media-nofpu @gol
583 -m5-compact -m5-compact-nofpu @gol
584 -mb  -ml  -mdalign  -mrelax @gol
585 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
586 -mieee  -misize  -mpadstruct  -mspace @gol
587 -mprefergot  -musermode}
588
589 @emph{System V Options}
590 @gccoptlist{
591 -Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
592
593 @emph{ARC Options}
594 @gccoptlist{
595 -EB  -EL @gol
596 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
597 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
598
599 @emph{TMS320C3x/C4x Options}
600 @gccoptlist{
601 -mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
602 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
603 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
604 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
605
606 @emph{V850 Options}
607 @gccoptlist{
608 -mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
609 -mprolog-function  -mno-prolog-function  -mspace @gol
610 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
611 -mapp-regs -mno-app-regs @gol
612 -mdisable-callt -mno-disable-callt @gol
613 -mv850e @gol
614 -mv850  -mbig-switch}
615
616 @emph{NS32K Options}
617 @gccoptlist{
618 -m32032  -m32332  -m32532  -m32081  -m32381 @gol
619 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
620 -mregparam  -mnoregparam  -msb  -mnosb @gol
621 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
622
623 @emph{AVR Options}
624 @gccoptlist{
625 -mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
626 -mcall-prologues  -mno-tablejump  -mtiny-stack}
627
628 @emph{MCore Options}
629 @gccoptlist{
630 -mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
631 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
632 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
633 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
634 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
635
636 @emph{MMIX Options}
637 @gccoptlist{
638 -mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
639 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
640 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
641 -mno-base-addresses -msingle-exit -mno-single-exit}
642
643 @emph{IA-64 Options}
644 @gccoptlist{
645 -mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
646 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
647 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
648 -minline-float-divide-max-throughput -minline-int-divide-min-latency @gol
649 -minline-int-divide-max-throughput -mno-dwarf2-asm @gol
650 -mfixed-range=@var{register-range}}
651
652 @emph{D30V Options}
653 @gccoptlist{
654 -mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
655 -masm-optimize -mbranch-cost=@var{n} -mcond-exec=@var{n}}
656
657 @emph{S/390 and zSeries Options}
658 @gccoptlist{
659 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
660 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
661 -m64 -m31 -mdebug -mno-debug}
662
663 @emph{CRIS Options}
664 @gccoptlist{
665 -mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
666 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
667 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
668 -mstack-align -mdata-align -mconst-align @gol
669 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
670 -melf -maout -melinux -mlinux -sim -sim2}
671
672 @emph{PDP-11 Options}
673 @gccoptlist{
674 -mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
675 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
676 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
677 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
678 -mbranch-expensive  -mbranch-cheap @gol
679 -msplit  -mno-split  -munix-asm  -mdec-asm}
680
681 @emph{Xstormy16 Options}
682 @gccoptlist{
683 -msim}
684
685 @emph{Xtensa Options}
686 @gccoptlist{
687 -mbig-endian -mlittle-endian @gol
688 -mdensity -mno-density @gol
689 -mmac16 -mno-mac16 @gol
690 -mmul16 -mno-mul16 @gol
691 -mmul32 -mno-mul32 @gol
692 -mnsa -mno-nsa @gol
693 -mminmax -mno-minmax @gol
694 -msext -mno-sext @gol
695 -mbooleans -mno-booleans @gol
696 -mhard-float -msoft-float @gol
697 -mfused-madd -mno-fused-madd @gol
698 -mserialize-volatile -mno-serialize-volatile @gol
699 -mtext-section-literals -mno-text-section-literals @gol
700 -mtarget-align -mno-target-align @gol
701 -mlongcalls -mno-longcalls}
702
703 @emph{FRV Options}
704 @gccoptlist{
705 -mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 -mhard-float -msoft-float @gol
706 -malloc-cc -mfixed-cc -mdword -mno-dword -mdouble -mno-double @gol
707 -mmedia -mno-media -mmuladd -mno-muladd -mlibrary-pic -macc-4 @gol
708 -macc-8 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
709 -mscc -mno-scc -mcond-exec -mno-cond-exec -mvliw-branch -mno-vliw-branch @gol
710 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
711 -mno-nested-cond-exec -mtomcat-stats @gol
712 -mcpu=@var{cpu}}
713
714
715
716 @item Code Generation Options
717 @xref{Code Gen Options,,Options for Code Generation Conventions}.
718 @gccoptlist{
719 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
720 -ffixed-@var{reg} -fexceptions @gol
721 -fnon-call-exceptions  -funwind-tables @gol
722 -fasynchronous-unwind-tables @gol
723 -finhibit-size-directive  -finstrument-functions @gol
724 -fno-common  -fno-ident  -fno-gnu-linker @gol
725 -fpcc-struct-return  -fpic  -fPIC @gol
726 -freg-struct-return  -fshared-data  -fshort-enums @gol
727 -fshort-double  -fshort-wchar -fvolatile @gol
728 -fvolatile-global  -fvolatile-static @gol
729 -fverbose-asm  -fpack-struct  -fstack-check @gol
730 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
731 -fargument-alias  -fargument-noalias @gol
732 -fargument-noalias-global  -fleading-underscore @gol
733 -ftls-model=@var{model}}
734 @end table
735
736 @menu
737 * Overall Options::     Controlling the kind of output:
738                         an executable, object files, assembler files,
739                         or preprocessed source.
740 * C Dialect Options::   Controlling the variant of C language compiled.
741 * C++ Dialect Options:: Variations on C++.
742 * Objective-C Dialect Options:: Variations on Objective-C.
743 * Language Independent Options:: Controlling how diagnostics should be
744                         formatted.
745 * Warning Options::     How picky should the compiler be?
746 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
747 * Optimize Options::    How much optimization?
748 * Preprocessor Options:: Controlling header files and macro definitions.
749                          Also, getting dependency information for Make.
750 * Assembler Options::   Passing options to the assembler.
751 * Link Options::        Specifying libraries and so on.
752 * Directory Options::   Where to find header files and libraries.
753                         Where to find the compiler executable files.
754 * Spec Files::          How to pass switches to sub-processes.
755 * Target Options::      Running a cross-compiler, or an old version of GCC.
756 @end menu
757
758 @node Overall Options
759 @section Options Controlling the Kind of Output
760
761 Compilation can involve up to four stages: preprocessing, compilation
762 proper, assembly and linking, always in that order.  The first three
763 stages apply to an individual source file, and end by producing an
764 object file; linking combines all the object files (those newly
765 compiled, and those specified as input) into an executable file.
766
767 @cindex file name suffix
768 For any given input file, the file name suffix determines what kind of
769 compilation is done:
770
771 @table @gcctabopt
772 @item @var{file}.c
773 C source code which must be preprocessed.
774
775 @item @var{file}.i
776 C source code which should not be preprocessed.
777
778 @item @var{file}.ii
779 C++ source code which should not be preprocessed.
780
781 @item @var{file}.m
782 Objective-C source code.  Note that you must link with the library
783 @file{libobjc.a} to make an Objective-C program work.
784
785 @item @var{file}.mi
786 Objective-C source code which should not be preprocessed.
787
788 @item @var{file}.h
789 C header file (not to be compiled or linked).
790
791 @item @var{file}.cc
792 @itemx @var{file}.cp
793 @itemx @var{file}.cxx
794 @itemx @var{file}.cpp
795 @itemx @var{file}.c++
796 @itemx @var{file}.C
797 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
798 the last two letters must both be literally @samp{x}.  Likewise,
799 @samp{.C} refers to a literal capital C@.
800
801 @item @var{file}.f
802 @itemx @var{file}.for
803 @itemx @var{file}.FOR
804 Fortran source code which should not be preprocessed.
805
806 @item @var{file}.F
807 @itemx @var{file}.fpp
808 @itemx @var{file}.FPP
809 Fortran source code which must be preprocessed (with the traditional
810 preprocessor).
811
812 @item @var{file}.r
813 Fortran source code which must be preprocessed with a RATFOR
814 preprocessor (not included with GCC)@.
815
816 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
817 Using and Porting GNU Fortran}, for more details of the handling of
818 Fortran input files.
819
820 @c FIXME: Descriptions of Java file types.
821 @c @var{file}.java
822 @c @var{file}.class
823 @c @var{file}.zip
824 @c @var{file}.jar
825
826 @item @var{file}.ads
827 Ada source code file which contains a library unit declaration (a
828 declaration of a package, subprogram, or generic, or a generic
829 instantiation), or a library unit renaming declaration (a package,
830 generic, or subprogram renaming declaration).  Such files are also
831 called @dfn{specs}.
832
833 @itemx @var{file}.adb
834 Ada source code file containing a library unit body (a subprogram or
835 package body).  Such files are also called @dfn{bodies}.
836
837 @c GCC also knows about some suffixes for languages not yet included:
838 @c Pascal:
839 @c @var{file}.p
840 @c @var{file}.pas
841
842 @item @var{file}.s
843 Assembler code.
844
845 @item @var{file}.S
846 Assembler code which must be preprocessed.
847
848 @item @var{other}
849 An object file to be fed straight into linking.
850 Any file name with no recognized suffix is treated this way.
851 @end table
852
853 @opindex x
854 You can specify the input language explicitly with the @option{-x} option:
855
856 @table @gcctabopt
857 @item -x @var{language}
858 Specify explicitly the @var{language} for the following input files
859 (rather than letting the compiler choose a default based on the file
860 name suffix).  This option applies to all following input files until
861 the next @option{-x} option.  Possible values for @var{language} are:
862 @example
863 c  c-header  cpp-output
864 c++  c++-cpp-output
865 objective-c  objc-cpp-output
866 assembler  assembler-with-cpp
867 ada
868 f77  f77-cpp-input  ratfor
869 java
870 treelang
871 @end example
872
873 @item -x none
874 Turn off any specification of a language, so that subsequent files are
875 handled according to their file name suffixes (as they are if @option{-x}
876 has not been used at all).
877
878 @item -pass-exit-codes
879 @opindex pass-exit-codes
880 Normally the @command{gcc} program will exit with the code of 1 if any
881 phase of the compiler returns a non-success return code.  If you specify
882 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
883 numerically highest error produced by any phase that returned an error
884 indication.
885 @end table
886
887 If you only want some of the stages of compilation, you can use
888 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
889 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
890 @command{gcc} is to stop.  Note that some combinations (for example,
891 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
892
893 @table @gcctabopt
894 @item -c
895 @opindex c
896 Compile or assemble the source files, but do not link.  The linking
897 stage simply is not done.  The ultimate output is in the form of an
898 object file for each source file.
899
900 By default, the object file name for a source file is made by replacing
901 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
902
903 Unrecognized input files, not requiring compilation or assembly, are
904 ignored.
905
906 @item -S
907 @opindex S
908 Stop after the stage of compilation proper; do not assemble.  The output
909 is in the form of an assembler code file for each non-assembler input
910 file specified.
911
912 By default, the assembler file name for a source file is made by
913 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
914
915 Input files that don't require compilation are ignored.
916
917 @item -E
918 @opindex E
919 Stop after the preprocessing stage; do not run the compiler proper.  The
920 output is in the form of preprocessed source code, which is sent to the
921 standard output.
922
923 Input files which don't require preprocessing are ignored.
924
925 @cindex output file option
926 @item -o @var{file}
927 @opindex o
928 Place output in file @var{file}.  This applies regardless to whatever
929 sort of output is being produced, whether it be an executable file,
930 an object file, an assembler file or preprocessed C code.
931
932 Since only one output file can be specified, it does not make sense to
933 use @option{-o} when compiling more than one input file, unless you are
934 producing an executable file as output.
935
936 If @option{-o} is not specified, the default is to put an executable file
937 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
938 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
939 all preprocessed C source on standard output.
940
941 @item -v
942 @opindex v
943 Print (on standard error output) the commands executed to run the stages
944 of compilation.  Also print the version number of the compiler driver
945 program and of the preprocessor and the compiler proper.
946
947 @item -###
948 @opindex ###
949 Like @option{-v} except the commands are not executed and all command
950 arguments are quoted.  This is useful for shell scripts to capture the
951 driver-generated command lines.
952
953 @item -pipe
954 @opindex pipe
955 Use pipes rather than temporary files for communication between the
956 various stages of compilation.  This fails to work on some systems where
957 the assembler is unable to read from a pipe; but the GNU assembler has
958 no trouble.
959
960 @item --help
961 @opindex help
962 Print (on the standard output) a description of the command line options
963 understood by @command{gcc}.  If the @option{-v} option is also specified
964 then @option{--help} will also be passed on to the various processes
965 invoked by @command{gcc}, so that they can display the command line options
966 they accept.  If the @option{-W} option is also specified then command
967 line options which have no documentation associated with them will also
968 be displayed.
969
970 @item --target-help
971 @opindex target-help
972 Print (on the standard output) a description of target specific command
973 line options for each tool.
974
975 @item --version
976 @opindex version
977 Display the version number and copyrights of the invoked GCC.
978 @end table
979
980 @node Invoking G++
981 @section Compiling C++ Programs
982
983 @cindex suffixes for C++ source
984 @cindex C++ source file suffixes
985 C++ source files conventionally use one of the suffixes @samp{.C},
986 @samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
987 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
988 files with these names and compiles them as C++ programs even if you
989 call the compiler the same way as for compiling C programs (usually with
990 the name @command{gcc}).
991
992 @findex g++
993 @findex c++
994 However, C++ programs often require class libraries as well as a
995 compiler that understands the C++ language---and under some
996 circumstances, you might want to compile programs from standard input,
997 or otherwise without a suffix that flags them as C++ programs.
998 @command{g++} is a program that calls GCC with the default language
999 set to C++, and automatically specifies linking against the C++
1000 library.  On many systems, @command{g++} is also
1001 installed with the name @command{c++}.
1002
1003 @cindex invoking @command{g++}
1004 When you compile C++ programs, you may specify many of the same
1005 command-line options that you use for compiling programs in any
1006 language; or command-line options meaningful for C and related
1007 languages; or options that are meaningful only for C++ programs.
1008 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1009 explanations of options for languages related to C@.
1010 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1011 explanations of options that are meaningful only for C++ programs.
1012
1013 @node C Dialect Options
1014 @section Options Controlling C Dialect
1015 @cindex dialect options
1016 @cindex language dialect options
1017 @cindex options, dialect
1018
1019 The following options control the dialect of C (or languages derived
1020 from C, such as C++ and Objective-C) that the compiler accepts:
1021
1022 @table @gcctabopt
1023 @cindex ANSI support
1024 @cindex ISO support
1025 @item -ansi
1026 @opindex ansi
1027 In C mode, support all ISO C90 programs.  In C++ mode,
1028 remove GNU extensions that conflict with ISO C++.
1029
1030 This turns off certain features of GCC that are incompatible with ISO
1031 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1032 such as the @code{asm} and @code{typeof} keywords, and
1033 predefined macros such as @code{unix} and @code{vax} that identify the
1034 type of system you are using.  It also enables the undesirable and
1035 rarely used ISO trigraph feature.  For the C compiler,
1036 it disables recognition of C++ style @samp{//} comments as well as
1037 the @code{inline} keyword.
1038
1039 The alternate keywords @code{__asm__}, @code{__extension__},
1040 @code{__inline__} and @code{__typeof__} continue to work despite
1041 @option{-ansi}.  You would not want to use them in an ISO C program, of
1042 course, but it is useful to put them in header files that might be included
1043 in compilations done with @option{-ansi}.  Alternate predefined macros
1044 such as @code{__unix__} and @code{__vax__} are also available, with or
1045 without @option{-ansi}.
1046
1047 The @option{-ansi} option does not cause non-ISO programs to be
1048 rejected gratuitously.  For that, @option{-pedantic} is required in
1049 addition to @option{-ansi}.  @xref{Warning Options}.
1050
1051 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1052 option is used.  Some header files may notice this macro and refrain
1053 from declaring certain functions or defining certain macros that the
1054 ISO standard doesn't call for; this is to avoid interfering with any
1055 programs that might use these names for other things.
1056
1057 Functions which would normally be built in but do not have semantics
1058 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1059 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1060 built-in functions provided by GCC}, for details of the functions
1061 affected.
1062
1063 @item -std=
1064 @opindex std
1065 Determine the language standard.  This option is currently only
1066 supported when compiling C or C++.  A value for this option must be
1067 provided; possible values are
1068
1069 @table @samp
1070 @item c89
1071 @itemx iso9899:1990
1072 ISO C90 (same as @option{-ansi}).
1073
1074 @item iso9899:199409
1075 ISO C90 as modified in amendment 1.
1076
1077 @item c99
1078 @itemx c9x
1079 @itemx iso9899:1999
1080 @itemx iso9899:199x
1081 ISO C99.  Note that this standard is not yet fully supported; see
1082 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1083 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1084
1085 @item gnu89
1086 Default, ISO C90 plus GNU extensions (including some C99 features).
1087
1088 @item gnu99
1089 @item gnu9x
1090 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1091 this will become the default.  The name @samp{gnu9x} is deprecated.
1092
1093 @item c++98
1094 The 1998 ISO C++ standard plus amendments.
1095
1096 @item gnu++98
1097 The same as @option{-std=c++98} plus GNU extensions.  This is the
1098 default for C++ code.
1099 @end table
1100
1101 Even when this option is not specified, you can still use some of the
1102 features of newer standards in so far as they do not conflict with
1103 previous C standards.  For example, you may use @code{__restrict__} even
1104 when @option{-std=c99} is not specified.
1105
1106 The @option{-std} options specifying some version of ISO C have the same
1107 effects as @option{-ansi}, except that features that were not in ISO C90
1108 but are in the specified version (for example, @samp{//} comments and
1109 the @code{inline} keyword in ISO C99) are not disabled.
1110
1111 @xref{Standards,,Language Standards Supported by GCC}, for details of
1112 these standard versions.
1113
1114 @item -aux-info @var{filename}
1115 @opindex aux-info
1116 Output to the given filename prototyped declarations for all functions
1117 declared and/or defined in a translation unit, including those in header
1118 files.  This option is silently ignored in any language other than C@.
1119
1120 Besides declarations, the file indicates, in comments, the origin of
1121 each declaration (source file and line), whether the declaration was
1122 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1123 @samp{O} for old, respectively, in the first character after the line
1124 number and the colon), and whether it came from a declaration or a
1125 definition (@samp{C} or @samp{F}, respectively, in the following
1126 character).  In the case of function definitions, a K&R-style list of
1127 arguments followed by their declarations is also provided, inside
1128 comments, after the declaration.
1129
1130 @item -fno-asm
1131 @opindex fno-asm
1132 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1133 keyword, so that code can use these words as identifiers.  You can use
1134 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1135 instead.  @option{-ansi} implies @option{-fno-asm}.
1136
1137 In C++, this switch only affects the @code{typeof} keyword, since
1138 @code{asm} and @code{inline} are standard keywords.  You may want to
1139 use the @option{-fno-gnu-keywords} flag instead, which has the same
1140 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1141 switch only affects the @code{asm} and @code{typeof} keywords, since
1142 @code{inline} is a standard keyword in ISO C99.
1143
1144 @item -fno-builtin
1145 @itemx -fno-builtin-@var{function}
1146 @opindex fno-builtin
1147 @cindex built-in functions
1148 Don't recognize built-in functions that do not begin with
1149 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1150 functions provided by GCC}, for details of the functions affected,
1151 including those which are not built-in functions when @option{-ansi} or
1152 @option{-std} options for strict ISO C conformance are used because they
1153 do not have an ISO standard meaning.
1154
1155 GCC normally generates special code to handle certain built-in functions
1156 more efficiently; for instance, calls to @code{alloca} may become single
1157 instructions that adjust the stack directly, and calls to @code{memcpy}
1158 may become inline copy loops.  The resulting code is often both smaller
1159 and faster, but since the function calls no longer appear as such, you
1160 cannot set a breakpoint on those calls, nor can you change the behavior
1161 of the functions by linking with a different library.
1162
1163 With the @option{-fno-builtin-@var{function}} option
1164 only the built-in function @var{function} is
1165 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1166 function is named this is not built-in in this version of GCC, this
1167 option is ignored.  There is no corresponding
1168 @option{-fbuiltin-@var{function}} option; if you wish to enable
1169 built-in functions selectively when using @option{-fno-builtin} or
1170 @option{-ffreestanding}, you may define macros such as:
1171
1172 @smallexample
1173 #define abs(n)          __builtin_abs ((n))
1174 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1175 @end smallexample
1176
1177 @item -fhosted
1178 @opindex fhosted
1179 @cindex hosted environment
1180
1181 Assert that compilation takes place in a hosted environment.  This implies
1182 @option{-fbuiltin}.  A hosted environment is one in which the
1183 entire standard library is available, and in which @code{main} has a return
1184 type of @code{int}.  Examples are nearly everything except a kernel.
1185 This is equivalent to @option{-fno-freestanding}.
1186
1187 @item -ffreestanding
1188 @opindex ffreestanding
1189 @cindex hosted environment
1190
1191 Assert that compilation takes place in a freestanding environment.  This
1192 implies @option{-fno-builtin}.  A freestanding environment
1193 is one in which the standard library may not exist, and program startup may
1194 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1195 This is equivalent to @option{-fno-hosted}.
1196
1197 @xref{Standards,,Language Standards Supported by GCC}, for details of
1198 freestanding and hosted environments.
1199
1200 @item -fms-extensions
1201 @opindex fms-extensions
1202 Accept some non-standard constructs used in Microsoft header files.
1203
1204 @item -trigraphs
1205 @opindex trigraphs
1206 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1207 options for strict ISO C conformance) implies @option{-trigraphs}.
1208
1209 @cindex traditional C language
1210 @cindex C language, traditional
1211 @item -traditional
1212 @itemx -traditional-cpp
1213 @opindex traditional-cpp
1214 @opindex traditional
1215 Formerly, these options caused GCC to attempt to emulate a pre-standard
1216 C compiler.  They are now only supported with the @option{-E} switch.
1217 The preprocessor continues to support a pre-standard mode.  See the GNU
1218 CPP manual for details.
1219
1220 @item -fcond-mismatch
1221 @opindex fcond-mismatch
1222 Allow conditional expressions with mismatched types in the second and
1223 third arguments.  The value of such an expression is void.  This option
1224 is not supported for C++.
1225
1226 @item -funsigned-char
1227 @opindex funsigned-char
1228 Let the type @code{char} be unsigned, like @code{unsigned char}.
1229
1230 Each kind of machine has a default for what @code{char} should
1231 be.  It is either like @code{unsigned char} by default or like
1232 @code{signed char} by default.
1233
1234 Ideally, a portable program should always use @code{signed char} or
1235 @code{unsigned char} when it depends on the signedness of an object.
1236 But many programs have been written to use plain @code{char} and
1237 expect it to be signed, or expect it to be unsigned, depending on the
1238 machines they were written for.  This option, and its inverse, let you
1239 make such a program work with the opposite default.
1240
1241 The type @code{char} is always a distinct type from each of
1242 @code{signed char} or @code{unsigned char}, even though its behavior
1243 is always just like one of those two.
1244
1245 @item -fsigned-char
1246 @opindex fsigned-char
1247 Let the type @code{char} be signed, like @code{signed char}.
1248
1249 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1250 the negative form of @option{-funsigned-char}.  Likewise, the option
1251 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1252
1253 @item -fsigned-bitfields
1254 @itemx -funsigned-bitfields
1255 @itemx -fno-signed-bitfields
1256 @itemx -fno-unsigned-bitfields
1257 @opindex fsigned-bitfields
1258 @opindex funsigned-bitfields
1259 @opindex fno-signed-bitfields
1260 @opindex fno-unsigned-bitfields
1261 These options control whether a bit-field is signed or unsigned, when the
1262 declaration does not use either @code{signed} or @code{unsigned}.  By
1263 default, such a bit-field is signed, because this is consistent: the
1264 basic integer types such as @code{int} are signed types.
1265
1266 @item -fwritable-strings
1267 @opindex fwritable-strings
1268 Store string constants in the writable data segment and don't uniquize
1269 them.  This is for compatibility with old programs which assume they can
1270 write into string constants.
1271
1272 Writing into string constants is a very bad idea; ``constants'' should
1273 be constant.
1274 @end table
1275
1276 @node C++ Dialect Options
1277 @section Options Controlling C++ Dialect
1278
1279 @cindex compiler options, C++
1280 @cindex C++ options, command line
1281 @cindex options, C++
1282 This section describes the command-line options that are only meaningful
1283 for C++ programs; but you can also use most of the GNU compiler options
1284 regardless of what language your program is in.  For example, you
1285 might compile a file @code{firstClass.C} like this:
1286
1287 @example
1288 g++ -g -frepo -O -c firstClass.C
1289 @end example
1290
1291 @noindent
1292 In this example, only @option{-frepo} is an option meant
1293 only for C++ programs; you can use the other options with any
1294 language supported by GCC@.
1295
1296 Here is a list of options that are @emph{only} for compiling C++ programs:
1297
1298 @table @gcctabopt
1299
1300 @item -fabi-version=@var{n}
1301 @opindex fabi-version
1302 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1303 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1304 version that conforms most closely to the C++ ABI specification.
1305 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1306 fixed.
1307
1308 The default is version 1.
1309
1310 @item -fno-access-control
1311 @opindex fno-access-control
1312 Turn off all access checking.  This switch is mainly useful for working
1313 around bugs in the access control code.
1314
1315 @item -fcheck-new
1316 @opindex fcheck-new
1317 Check that the pointer returned by @code{operator new} is non-null
1318 before attempting to modify the storage allocated.  The current Working
1319 Paper requires that @code{operator new} never return a null pointer, so
1320 this check is normally unnecessary.
1321
1322 An alternative to using this option is to specify that your
1323 @code{operator new} does not throw any exceptions; if you declare it
1324 @samp{throw()}, G++ will check the return value.  See also @samp{new
1325 (nothrow)}.
1326
1327 @item -fconserve-space
1328 @opindex fconserve-space
1329 Put uninitialized or runtime-initialized global variables into the
1330 common segment, as C does.  This saves space in the executable at the
1331 cost of not diagnosing duplicate definitions.  If you compile with this
1332 flag and your program mysteriously crashes after @code{main()} has
1333 completed, you may have an object that is being destroyed twice because
1334 two definitions were merged.
1335
1336 This option is no longer useful on most targets, now that support has
1337 been added for putting variables into BSS without making them common.
1338
1339 @item -fno-const-strings
1340 @opindex fno-const-strings
1341 Give string constants type @code{char *} instead of type @code{const
1342 char *}.  By default, G++ uses type @code{const char *} as required by
1343 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1344 actually modify the value of a string constant, unless you also use
1345 @option{-fwritable-strings}.
1346
1347 This option might be removed in a future release of G++.  For maximum
1348 portability, you should structure your code so that it works with
1349 string constants that have type @code{const char *}.
1350
1351 @item -fdollars-in-identifiers
1352 @opindex fdollars-in-identifiers
1353 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1354 @samp{$} with the option @option{-fno-dollars-in-identifiers}.  (GNU C allows
1355 @samp{$} by default on most target systems, but there are a few exceptions.)
1356 Traditional C allowed the character @samp{$} to form part of
1357 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1358
1359 @item -fno-elide-constructors
1360 @opindex fno-elide-constructors
1361 The C++ standard allows an implementation to omit creating a temporary
1362 which is only used to initialize another object of the same type.
1363 Specifying this option disables that optimization, and forces G++ to
1364 call the copy constructor in all cases.
1365
1366 @item -fno-enforce-eh-specs
1367 @opindex fno-enforce-eh-specs
1368 Don't check for violation of exception specifications at runtime.  This
1369 option violates the C++ standard, but may be useful for reducing code
1370 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1371 will still optimize based on the exception specifications.
1372
1373 @item -fexternal-templates
1374 @opindex fexternal-templates
1375
1376 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1377 template instantiation; template instances are emitted or not according
1378 to the location of the template definition.  @xref{Template
1379 Instantiation}, for more information.
1380
1381 This option is deprecated.
1382
1383 @item -falt-external-templates
1384 @opindex falt-external-templates
1385 Similar to @option{-fexternal-templates}, but template instances are
1386 emitted or not according to the place where they are first instantiated.
1387 @xref{Template Instantiation}, for more information.
1388
1389 This option is deprecated.
1390
1391 @item -ffor-scope
1392 @itemx -fno-for-scope
1393 @opindex ffor-scope
1394 @opindex fno-for-scope
1395 If @option{-ffor-scope} is specified, the scope of variables declared in
1396 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1397 as specified by the C++ standard.
1398 If @option{-fno-for-scope} is specified, the scope of variables declared in
1399 a @i{for-init-statement} extends to the end of the enclosing scope,
1400 as was the case in old versions of G++, and other (traditional)
1401 implementations of C++.
1402
1403 The default if neither flag is given to follow the standard,
1404 but to allow and give a warning for old-style code that would
1405 otherwise be invalid, or have different behavior.
1406
1407 @item -fno-gnu-keywords
1408 @opindex fno-gnu-keywords
1409 Do not recognize @code{typeof} as a keyword, so that code can use this
1410 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1411 @option{-ansi} implies @option{-fno-gnu-keywords}.
1412
1413 @item -fno-implicit-templates
1414 @opindex fno-implicit-templates
1415 Never emit code for non-inline templates which are instantiated
1416 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1417 @xref{Template Instantiation}, for more information.
1418
1419 @item -fno-implicit-inline-templates
1420 @opindex fno-implicit-inline-templates
1421 Don't emit code for implicit instantiations of inline templates, either.
1422 The default is to handle inlines differently so that compiles with and
1423 without optimization will need the same set of explicit instantiations.
1424
1425 @item -fno-implement-inlines
1426 @opindex fno-implement-inlines
1427 To save space, do not emit out-of-line copies of inline functions
1428 controlled by @samp{#pragma implementation}.  This will cause linker
1429 errors if these functions are not inlined everywhere they are called.
1430
1431 @item -fms-extensions
1432 @opindex fms-extensions
1433 Disable pedantic warnings about constructs used in MFC, such as implicit
1434 int and getting a pointer to member function via non-standard syntax.
1435
1436 @item -fno-nonansi-builtins
1437 @opindex fno-nonansi-builtins
1438 Disable built-in declarations of functions that are not mandated by
1439 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1440 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1441
1442 @item -fno-operator-names
1443 @opindex fno-operator-names
1444 Do not treat the operator name keywords @code{and}, @code{bitand},
1445 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1446 synonyms as keywords.
1447
1448 @item -fno-optional-diags
1449 @opindex fno-optional-diags
1450 Disable diagnostics that the standard says a compiler does not need to
1451 issue.  Currently, the only such diagnostic issued by G++ is the one for
1452 a name having multiple meanings within a class.
1453
1454 @item -fpermissive
1455 @opindex fpermissive
1456 Downgrade messages about nonconformant code from errors to warnings.  By
1457 default, G++ effectively sets @option{-pedantic-errors} without
1458 @option{-pedantic}; this option reverses that.  This behavior and this
1459 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1460
1461 @item -frepo
1462 @opindex frepo
1463 Enable automatic template instantiation at link time.  This option also
1464 implies @option{-fno-implicit-templates}.  @xref{Template
1465 Instantiation}, for more information.
1466
1467 @item -fno-rtti
1468 @opindex fno-rtti
1469 Disable generation of information about every class with virtual
1470 functions for use by the C++ runtime type identification features
1471 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1472 of the language, you can save some space by using this flag.  Note that
1473 exception handling uses the same information, but it will generate it as
1474 needed.
1475
1476 @item -fstats
1477 @opindex fstats
1478 Emit statistics about front-end processing at the end of the compilation.
1479 This information is generally only useful to the G++ development team.
1480
1481 @item -ftemplate-depth-@var{n}
1482 @opindex ftemplate-depth
1483 Set the maximum instantiation depth for template classes to @var{n}.
1484 A limit on the template instantiation depth is needed to detect
1485 endless recursions during template class instantiation.  ANSI/ISO C++
1486 conforming programs must not rely on a maximum depth greater than 17.
1487
1488 @item -fuse-cxa-atexit
1489 @opindex fuse-cxa-atexit
1490 Register destructors for objects with static storage duration with the
1491 @code{__cxa_atexit} function rather than the @code{atexit} function.
1492 This option is required for fully standards-compliant handling of static
1493 destructors, but will only work if your C library supports
1494 @code{__cxa_atexit}.
1495
1496 @item -fvtable-gc
1497 @opindex fvtable-gc
1498 Emit special relocations for vtables and virtual function references
1499 so that the linker can identify unused virtual functions and zero out
1500 vtable slots that refer to them.  This is most useful with
1501 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1502 also discard the functions themselves.
1503
1504 This optimization requires GNU as and GNU ld.  Not all systems support
1505 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1506
1507 @item -fno-weak
1508 @opindex fno-weak
1509 Do not use weak symbol support, even if it is provided by the linker.
1510 By default, G++ will use weak symbols if they are available.  This
1511 option exists only for testing, and should not be used by end-users;
1512 it will result in inferior code and has no benefits.  This option may
1513 be removed in a future release of G++.
1514
1515 @item -nostdinc++
1516 @opindex nostdinc++
1517 Do not search for header files in the standard directories specific to
1518 C++, but do still search the other standard directories.  (This option
1519 is used when building the C++ library.)
1520 @end table
1521
1522 In addition, these optimization, warning, and code generation options
1523 have meanings only for C++ programs:
1524
1525 @table @gcctabopt
1526 @item -fno-default-inline
1527 @opindex fno-default-inline
1528 Do not assume @samp{inline} for functions defined inside a class scope.
1529 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1530 functions will have linkage like inline functions; they just won't be
1531 inlined by default.
1532
1533 @item -Wabi @r{(C++ only)}
1534 @opindex Wabi
1535 Warn when G++ generates code that is probably not compatible with the
1536 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1537 all such cases, there are probably some cases that are not warned about, 
1538 even though G++ is generating incompatible code.  There may also be
1539 cases where warnings are emitted even though the code that is generated
1540 will be compatible.
1541
1542 You should rewrite your code to avoid these warnings if you are
1543 concerned about the fact that code generated by G++ may not be binary
1544 compatible with code generated by other compilers.
1545
1546 The known incompatibilities at this point include:
1547
1548 @itemize @bullet
1549
1550 @item
1551 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1552 pack data into the same byte as a base class.  For example:
1553
1554 @smallexample
1555 struct A @{ virtual void f(); int f1 : 1; @};
1556 struct B : public A @{ int f2 : 1; @};
1557 @end smallexample
1558
1559 @noindent
1560 In this case, G++ will place @code{B::f2} into the same byte
1561 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1562 by explicitly padding @code{A} so that its size is a multiple of the
1563 byte size on your platform; that will cause G++ and other compilers to
1564 layout @code{B} identically.
1565
1566 @item
1567 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1568 tail padding when laying out virtual bases.  For example:
1569
1570 @smallexample
1571 struct A @{ virtual void f(); char c1; @};
1572 struct B @{ B(); char c2; @};
1573 struct C : public A, public virtual B @{@};
1574 @end smallexample
1575
1576 @noindent
1577 In this case, G++ will not place @code{B} into the tail-padding for
1578 @code{A}; other compilers will.  You can avoid this problem by
1579 explicitly padding @code{A} so that its size is a multiple of its
1580 alignment (ignoring virtual base classes); that will cause G++ and other
1581 compilers to layout @code{C} identically.
1582
1583 @item
1584 Incorrect handling of bit-fields with declared widths greater than that
1585 of their underlying types, when the bit-fields appear in a union.  For
1586 example:
1587
1588 @smallexample
1589 union U @{ int i : 4096; @};
1590 @end smallexample
1591
1592 @noindent
1593 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1594 union too small by the number of bits in an @code{int}.
1595
1596 @item
1597 Empty classes can be placed at incorrect offsets.  For example:
1598  
1599 @smallexample
1600 struct A @{@};
1601
1602 struct B @{
1603   A a;
1604   virtual void f ();
1605 @};
1606
1607 struct C : public B, public A @{@};
1608 @end smallexample
1609
1610 @noindent
1611 G++ will place the @code{A} base class of @code{C} at a non-zero offset;
1612 it should be placed at offset zero.  G++ mistakenly believes that the
1613 @code{A} data member of @code{B} is already at offset zero.
1614
1615 @item
1616 Names of template functions whose types involve @code{typename} or
1617 template template parameters can be mangled incorrectly.
1618
1619 @smallexample
1620 template <typename Q>
1621 void f(typename Q::X) @{@}
1622
1623 template <template <typename> class Q>
1624 void f(typename Q<int>::X) @{@}
1625 @end smallexample
1626
1627 @noindent
1628 Instantiations of these templates may be mangled incorrectly.
1629
1630 @end itemize
1631
1632 @item -Wctor-dtor-privacy @r{(C++ only)}
1633 @opindex Wctor-dtor-privacy
1634 Warn when a class seems unusable, because all the constructors or
1635 destructors in a class are private and the class has no friends or
1636 public static member functions.  This warning is enabled by default.
1637
1638 @item -Wnon-virtual-dtor @r{(C++ only)}
1639 @opindex Wnon-virtual-dtor
1640 Warn when a class declares a non-virtual destructor that should probably
1641 be virtual, because it looks like the class will be used polymorphically.
1642 This warning is enabled by @option{-Wall}.
1643
1644 @item -Wreorder @r{(C++ only)}
1645 @opindex Wreorder
1646 @cindex reordering, warning
1647 @cindex warning for reordering of member initializers
1648 Warn when the order of member initializers given in the code does not
1649 match the order in which they must be executed.  For instance:
1650
1651 @smallexample
1652 struct A @{
1653   int i;
1654   int j;
1655   A(): j (0), i (1) @{ @}
1656 @};
1657 @end smallexample
1658
1659 Here the compiler will warn that the member initializers for @samp{i}
1660 and @samp{j} will be rearranged to match the declaration order of the
1661 members.  This warning is enabled by @option{-Wall}.
1662 @end table
1663
1664 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1665
1666 @table @gcctabopt
1667 @item -Weffc++ @r{(C++ only)}
1668 @opindex Weffc++
1669 Warn about violations of the following style guidelines from Scott Meyers'
1670 @cite{Effective C++} book:
1671
1672 @itemize @bullet
1673 @item
1674 Item 11:  Define a copy constructor and an assignment operator for classes
1675 with dynamically allocated memory.
1676
1677 @item
1678 Item 12:  Prefer initialization to assignment in constructors.
1679
1680 @item
1681 Item 14:  Make destructors virtual in base classes.
1682
1683 @item
1684 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1685
1686 @item
1687 Item 23:  Don't try to return a reference when you must return an object.
1688
1689 @end itemize
1690
1691 and about violations of the following style guidelines from Scott Meyers'
1692 @cite{More Effective C++} book:
1693
1694 @itemize @bullet
1695 @item
1696 Item 6:  Distinguish between prefix and postfix forms of increment and
1697 decrement operators.
1698
1699 @item
1700 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1701
1702 @end itemize
1703
1704 If you use this option, you should be aware that the standard library
1705 headers do not obey all of these guidelines; you can use @samp{grep -v}
1706 to filter out those warnings.
1707
1708 @item -Wno-deprecated @r{(C++ only)}
1709 @opindex Wno-deprecated
1710 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1711
1712 @item -Wno-non-template-friend @r{(C++ only)}
1713 @opindex Wno-non-template-friend
1714 Disable warnings when non-templatized friend functions are declared
1715 within a template.  With the advent of explicit template specification
1716 support in G++, if the name of the friend is an unqualified-id (i.e.,
1717 @samp{friend foo(int)}), the C++ language specification demands that the
1718 friend declare or define an ordinary, nontemplate function.  (Section
1719 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1720 could be interpreted as a particular specialization of a templatized
1721 function.  Because this non-conforming behavior is no longer the default
1722 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1723 check existing code for potential trouble spots, and is on by default.
1724 This new compiler behavior can be turned off with
1725 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1726 but disables the helpful warning.
1727
1728 @item -Wold-style-cast @r{(C++ only)}
1729 @opindex Wold-style-cast
1730 Warn if an old-style (C-style) cast to a non-void type is used within
1731 a C++ program.  The new-style casts (@samp{static_cast},
1732 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1733 unintended effects, and much easier to grep for.
1734
1735 @item -Woverloaded-virtual @r{(C++ only)}
1736 @opindex Woverloaded-virtual
1737 @cindex overloaded virtual fn, warning
1738 @cindex warning for overloaded virtual fn
1739 Warn when a function declaration hides virtual functions from a
1740 base class.  For example, in:
1741
1742 @smallexample
1743 struct A @{
1744   virtual void f();
1745 @};
1746
1747 struct B: public A @{
1748   void f(int);
1749 @};
1750 @end smallexample
1751
1752 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1753 like this:
1754
1755 @smallexample
1756 B* b;
1757 b->f();
1758 @end smallexample
1759
1760 will fail to compile.
1761
1762 @item -Wno-pmf-conversions @r{(C++ only)}
1763 @opindex Wno-pmf-conversions
1764 Disable the diagnostic for converting a bound pointer to member function
1765 to a plain pointer.
1766
1767 @item -Wsign-promo @r{(C++ only)}
1768 @opindex Wsign-promo
1769 Warn when overload resolution chooses a promotion from unsigned or
1770 enumeral type to a signed type over a conversion to an unsigned type of
1771 the same size.  Previous versions of G++ would try to preserve
1772 unsignedness, but the standard mandates the current behavior.
1773
1774 @item -Wsynth @r{(C++ only)}
1775 @opindex Wsynth
1776 @cindex warning for synthesized methods
1777 @cindex synthesized methods, warning
1778 Warn when G++'s synthesis behavior does not match that of cfront.  For
1779 instance:
1780
1781 @smallexample
1782 struct A @{
1783   operator int ();
1784   A& operator = (int);
1785 @};
1786
1787 main ()
1788 @{
1789   A a,b;
1790   a = b;
1791 @}
1792 @end smallexample
1793
1794 In this example, G++ will synthesize a default @samp{A& operator =
1795 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1796 @end table
1797
1798 @node Objective-C Dialect Options
1799 @section Options Controlling Objective-C Dialect
1800
1801 @cindex compiler options, Objective-C
1802 @cindex Objective-C options, command line
1803 @cindex options, Objective-C
1804 This section describes the command-line options that are only meaningful
1805 for Objective-C programs; but you can also use most of the GNU compiler
1806 options regardless of what language your program is in.  For example,
1807 you might compile a file @code{some_class.m} like this:
1808
1809 @example
1810 gcc -g -fgnu-runtime -O -c some_class.m
1811 @end example
1812
1813 @noindent
1814 In this example, only @option{-fgnu-runtime} is an option meant only for
1815 Objective-C programs; you can use the other options with any language
1816 supported by GCC@.
1817
1818 Here is a list of options that are @emph{only} for compiling Objective-C
1819 programs:
1820
1821 @table @gcctabopt
1822 @item -fconstant-string-class=@var{class-name}
1823 @opindex fconstant-string-class
1824 Use @var{class-name} as the name of the class to instantiate for each
1825 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1826 class name is @code{NXConstantString}.
1827
1828 @item -fgnu-runtime
1829 @opindex fgnu-runtime
1830 Generate object code compatible with the standard GNU Objective-C
1831 runtime.  This is the default for most types of systems.
1832
1833 @item -fnext-runtime
1834 @opindex fnext-runtime
1835 Generate output compatible with the NeXT runtime.  This is the default
1836 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1837 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1838 used.
1839
1840 @item -gen-decls
1841 @opindex gen-decls
1842 Dump interface declarations for all classes seen in the source file to a
1843 file named @file{@var{sourcename}.decl}.
1844
1845 @item -Wno-protocol
1846 @opindex Wno-protocol
1847 If a class is declared to implement a protocol, a warning is issued for
1848 every method in the protocol that is not implemented by the class.  The
1849 default behavior is to issue a warning for every method not explicitly
1850 implemented in the class, even if a method implementation is inherited
1851 from the superclass.  If you use the @code{-Wno-protocol} option, then
1852 methods inherited from the superclass are considered to be implemented,
1853 and no warning is issued for them.
1854
1855 @item -Wselector
1856 @opindex Wselector
1857 Warn if multiple methods of different types for the same selector are
1858 found during compilation.  The check is performed on the list of methods
1859 in the final stage of compilation.  Additionally, a check is performed
1860 that for each selector appearing in a @code{@@selector(@dots{})}
1861 expression, a corresponding method with that selector has been found
1862 during compilation.  Because these checks scan the method table only at
1863 the end of compilation, these warnings are not produced if the final
1864 stage of compilation is not reached, for example because an error is
1865 found during compilation, or because the @code{-fsyntax-only} option is
1866 being used.
1867
1868 @item -Wundeclared-selector
1869 @opindex Wundeclared-selector
1870 Warn if a @code{@@selector(@dots{})} expression referring to an
1871 undeclared selector is found.  A selector is considered undeclared if no
1872 method with that name has been declared (explicitly, in an
1873 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1874 an @code{@@implementation} section) before the
1875 @code{@@selector(@dots{})} expression.  This option always performs its
1876 checks as soon as a @code{@@selector(@dots{})} expression is found
1877 (while @code{-Wselector} only performs its checks in the final stage of
1878 compilation), and so additionally enforces the coding style convention
1879 that methods and selectors must be declared before being used.
1880
1881 @c not documented because only avail via -Wp
1882 @c @item -print-objc-runtime-info
1883
1884 @end table
1885
1886 @node Language Independent Options
1887 @section Options to Control Diagnostic Messages Formatting
1888 @cindex options to control diagnostics formatting
1889 @cindex diagnostic messages
1890 @cindex message formatting
1891
1892 Traditionally, diagnostic messages have been formatted irrespective of
1893 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1894 below can be used to control the diagnostic messages formatting
1895 algorithm, e.g.@: how many characters per line, how often source location
1896 information should be reported.  Right now, only the C++ front end can
1897 honor these options.  However it is expected, in the near future, that
1898 the remaining front ends would be able to digest them correctly.
1899
1900 @table @gcctabopt
1901 @item -fmessage-length=@var{n}
1902 @opindex fmessage-length
1903 Try to format error messages so that they fit on lines of about @var{n}
1904 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1905 the front ends supported by GCC@.  If @var{n} is zero, then no
1906 line-wrapping will be done; each error message will appear on a single
1907 line.
1908
1909 @opindex fdiagnostics-show-location
1910 @item -fdiagnostics-show-location=once
1911 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1912 reporter to emit @emph{once} source location information; that is, in
1913 case the message is too long to fit on a single physical line and has to
1914 be wrapped, the source location won't be emitted (as prefix) again,
1915 over and over, in subsequent continuation lines.  This is the default
1916 behavior.
1917
1918 @item -fdiagnostics-show-location=every-line
1919 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1920 messages reporter to emit the same source location information (as
1921 prefix) for physical lines that result from the process of breaking
1922 a message which is too long to fit on a single line.
1923
1924 @end table
1925
1926 @node Warning Options
1927 @section Options to Request or Suppress Warnings
1928 @cindex options to control warnings
1929 @cindex warning messages
1930 @cindex messages, warning
1931 @cindex suppressing warnings
1932
1933 Warnings are diagnostic messages that report constructions which
1934 are not inherently erroneous but which are risky or suggest there
1935 may have been an error.
1936
1937 You can request many specific warnings with options beginning @samp{-W},
1938 for example @option{-Wimplicit} to request warnings on implicit
1939 declarations.  Each of these specific warning options also has a
1940 negative form beginning @samp{-Wno-} to turn off warnings;
1941 for example, @option{-Wno-implicit}.  This manual lists only one of the
1942 two forms, whichever is not the default.
1943
1944 The following options control the amount and kinds of warnings produced
1945 by GCC; for further, language-specific options also refer to
1946 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1947
1948 @table @gcctabopt
1949 @cindex syntax checking
1950 @item -fsyntax-only
1951 @opindex fsyntax-only
1952 Check the code for syntax errors, but don't do anything beyond that.
1953
1954 @item -pedantic
1955 @opindex pedantic
1956 Issue all the warnings demanded by strict ISO C and ISO C++;
1957 reject all programs that use forbidden extensions, and some other
1958 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1959 version of the ISO C standard specified by any @option{-std} option used.
1960
1961 Valid ISO C and ISO C++ programs should compile properly with or without
1962 this option (though a rare few will require @option{-ansi} or a
1963 @option{-std} option specifying the required version of ISO C)@.  However,
1964 without this option, certain GNU extensions and traditional C and C++
1965 features are supported as well.  With this option, they are rejected.
1966
1967 @option{-pedantic} does not cause warning messages for use of the
1968 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1969 warnings are also disabled in the expression that follows
1970 @code{__extension__}.  However, only system header files should use
1971 these escape routes; application programs should avoid them.
1972 @xref{Alternate Keywords}.
1973
1974 Some users try to use @option{-pedantic} to check programs for strict ISO
1975 C conformance.  They soon find that it does not do quite what they want:
1976 it finds some non-ISO practices, but not all---only those for which
1977 ISO C @emph{requires} a diagnostic, and some others for which
1978 diagnostics have been added.
1979
1980 A feature to report any failure to conform to ISO C might be useful in
1981 some instances, but would require considerable additional work and would
1982 be quite different from @option{-pedantic}.  We don't have plans to
1983 support such a feature in the near future.
1984
1985 Where the standard specified with @option{-std} represents a GNU
1986 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1987 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1988 extended dialect is based.  Warnings from @option{-pedantic} are given
1989 where they are required by the base standard.  (It would not make sense
1990 for such warnings to be given only for features not in the specified GNU
1991 C dialect, since by definition the GNU dialects of C include all
1992 features the compiler supports with the given option, and there would be
1993 nothing to warn about.)
1994
1995 @item -pedantic-errors
1996 @opindex pedantic-errors
1997 Like @option{-pedantic}, except that errors are produced rather than
1998 warnings.
1999
2000 @item -w
2001 @opindex w
2002 Inhibit all warning messages.
2003
2004 @item -Wno-import
2005 @opindex Wno-import
2006 Inhibit warning messages about the use of @samp{#import}.
2007
2008 @item -Wchar-subscripts
2009 @opindex Wchar-subscripts
2010 Warn if an array subscript has type @code{char}.  This is a common cause
2011 of error, as programmers often forget that this type is signed on some
2012 machines.
2013
2014 @item -Wcomment
2015 @opindex Wcomment
2016 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2017 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2018
2019 @item -Wformat
2020 @opindex Wformat
2021 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2022 the arguments supplied have types appropriate to the format string
2023 specified, and that the conversions specified in the format string make
2024 sense.  This includes standard functions, and others specified by format
2025 attributes (@pxref{Function Attributes}), in the @code{printf},
2026 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2027 not in the C standard) families.
2028
2029 The formats are checked against the format features supported by GNU
2030 libc version 2.2.  These include all ISO C90 and C99 features, as well
2031 as features from the Single Unix Specification and some BSD and GNU
2032 extensions.  Other library implementations may not support all these
2033 features; GCC does not support warning about features that go beyond a
2034 particular library's limitations.  However, if @option{-pedantic} is used
2035 with @option{-Wformat}, warnings will be given about format features not
2036 in the selected standard version (but not for @code{strfmon} formats,
2037 since those are not in any version of the C standard).  @xref{C Dialect
2038 Options,,Options Controlling C Dialect}.
2039
2040 Since @option{-Wformat} also checks for null format arguments for
2041 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2042
2043 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2044 aspects of format checking, the options @option{-Wno-format-y2k},
2045 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2046 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2047 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2048
2049 @item -Wno-format-y2k
2050 @opindex Wno-format-y2k
2051 If @option{-Wformat} is specified, do not warn about @code{strftime}
2052 formats which may yield only a two-digit year.
2053
2054 @item -Wno-format-extra-args
2055 @opindex Wno-format-extra-args
2056 If @option{-Wformat} is specified, do not warn about excess arguments to a
2057 @code{printf} or @code{scanf} format function.  The C standard specifies
2058 that such arguments are ignored.
2059
2060 Where the unused arguments lie between used arguments that are
2061 specified with @samp{$} operand number specifications, normally
2062 warnings are still given, since the implementation could not know what
2063 type to pass to @code{va_arg} to skip the unused arguments.  However,
2064 in the case of @code{scanf} formats, this option will suppress the
2065 warning if the unused arguments are all pointers, since the Single
2066 Unix Specification says that such unused arguments are allowed.
2067
2068 @item -Wno-format-zero-length
2069 @opindex Wno-format-zero-length
2070 If @option{-Wformat} is specified, do not warn about zero-length formats.
2071 The C standard specifies that zero-length formats are allowed.
2072
2073 @item -Wformat-nonliteral
2074 @opindex Wformat-nonliteral
2075 If @option{-Wformat} is specified, also warn if the format string is not a
2076 string literal and so cannot be checked, unless the format function
2077 takes its format arguments as a @code{va_list}.
2078
2079 @item -Wformat-security
2080 @opindex Wformat-security
2081 If @option{-Wformat} is specified, also warn about uses of format
2082 functions that represent possible security problems.  At present, this
2083 warns about calls to @code{printf} and @code{scanf} functions where the
2084 format string is not a string literal and there are no format arguments,
2085 as in @code{printf (foo);}.  This may be a security hole if the format
2086 string came from untrusted input and contains @samp{%n}.  (This is
2087 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2088 in future warnings may be added to @option{-Wformat-security} that are not
2089 included in @option{-Wformat-nonliteral}.)
2090
2091 @item -Wformat=2
2092 @opindex Wformat=2
2093 Enable @option{-Wformat} plus format checks not included in
2094 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2095 -Wformat-nonliteral -Wformat-security}.
2096
2097 @item -Wnonnull
2098 @opindex Wnonnull
2099 Enable warning about passing a null pointer for arguments marked as
2100 requiring a non-null value by the @code{nonnull} function attribute.
2101
2102 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2103 can be disabled with the @option{-Wno-nonnull} option.
2104
2105 @item -Wimplicit-int
2106 @opindex Wimplicit-int
2107 Warn when a declaration does not specify a type.
2108
2109 @item -Wimplicit-function-declaration
2110 @itemx -Werror-implicit-function-declaration
2111 @opindex Wimplicit-function-declaration
2112 @opindex Werror-implicit-function-declaration
2113 Give a warning (or error) whenever a function is used before being
2114 declared.
2115
2116 @item -Wimplicit
2117 @opindex Wimplicit
2118 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2119
2120 @item -Wmain
2121 @opindex Wmain
2122 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2123 function with external linkage, returning int, taking either zero
2124 arguments, two, or three arguments of appropriate types.
2125
2126 @item -Wmissing-braces
2127 @opindex Wmissing-braces
2128 Warn if an aggregate or union initializer is not fully bracketed.  In
2129 the following example, the initializer for @samp{a} is not fully
2130 bracketed, but that for @samp{b} is fully bracketed.
2131
2132 @smallexample
2133 int a[2][2] = @{ 0, 1, 2, 3 @};
2134 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2135 @end smallexample
2136
2137 @item -Wparentheses
2138 @opindex Wparentheses
2139 Warn if parentheses are omitted in certain contexts, such
2140 as when there is an assignment in a context where a truth value
2141 is expected, or when operators are nested whose precedence people
2142 often get confused about.
2143
2144 Also warn about constructions where there may be confusion to which
2145 @code{if} statement an @code{else} branch belongs.  Here is an example of
2146 such a case:
2147
2148 @smallexample
2149 @group
2150 @{
2151   if (a)
2152     if (b)
2153       foo ();
2154   else
2155     bar ();
2156 @}
2157 @end group
2158 @end smallexample
2159
2160 In C, every @code{else} branch belongs to the innermost possible @code{if}
2161 statement, which in this example is @code{if (b)}.  This is often not
2162 what the programmer expected, as illustrated in the above example by
2163 indentation the programmer chose.  When there is the potential for this
2164 confusion, GCC will issue a warning when this flag is specified.
2165 To eliminate the warning, add explicit braces around the innermost
2166 @code{if} statement so there is no way the @code{else} could belong to
2167 the enclosing @code{if}.  The resulting code would look like this:
2168
2169 @smallexample
2170 @group
2171 @{
2172   if (a)
2173     @{
2174       if (b)
2175         foo ();
2176       else
2177         bar ();
2178     @}
2179 @}
2180 @end group
2181 @end smallexample
2182
2183 @item -Wsequence-point
2184 @opindex Wsequence-point
2185 Warn about code that may have undefined semantics because of violations
2186 of sequence point rules in the C standard.
2187
2188 The C standard defines the order in which expressions in a C program are
2189 evaluated in terms of @dfn{sequence points}, which represent a partial
2190 ordering between the execution of parts of the program: those executed
2191 before the sequence point, and those executed after it.  These occur
2192 after the evaluation of a full expression (one which is not part of a
2193 larger expression), after the evaluation of the first operand of a
2194 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2195 function is called (but after the evaluation of its arguments and the
2196 expression denoting the called function), and in certain other places.
2197 Other than as expressed by the sequence point rules, the order of
2198 evaluation of subexpressions of an expression is not specified.  All
2199 these rules describe only a partial order rather than a total order,
2200 since, for example, if two functions are called within one expression
2201 with no sequence point between them, the order in which the functions
2202 are called is not specified.  However, the standards committee have
2203 ruled that function calls do not overlap.
2204
2205 It is not specified when between sequence points modifications to the
2206 values of objects take effect.  Programs whose behavior depends on this
2207 have undefined behavior; the C standard specifies that ``Between the
2208 previous and next sequence point an object shall have its stored value
2209 modified at most once by the evaluation of an expression.  Furthermore,
2210 the prior value shall be read only to determine the value to be
2211 stored.''.  If a program breaks these rules, the results on any
2212 particular implementation are entirely unpredictable.
2213
2214 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2215 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2216 diagnosed by this option, and it may give an occasional false positive
2217 result, but in general it has been found fairly effective at detecting
2218 this sort of problem in programs.
2219
2220 The present implementation of this option only works for C programs.  A
2221 future implementation may also work for C++ programs.
2222
2223 The C standard is worded confusingly, therefore there is some debate
2224 over the precise meaning of the sequence point rules in subtle cases.
2225 Links to discussions of the problem, including proposed formal
2226 definitions, may be found on our readings page, at
2227 @w{@uref{http://gcc.gnu.org/readings.html}}.
2228
2229 @item -Wreturn-type
2230 @opindex Wreturn-type
2231 Warn whenever a function is defined with a return-type that defaults to
2232 @code{int}.  Also warn about any @code{return} statement with no
2233 return-value in a function whose return-type is not @code{void}.
2234
2235 For C++, a function without return type always produces a diagnostic
2236 message, even when @option{-Wno-return-type} is specified.  The only
2237 exceptions are @samp{main} and functions defined in system headers.
2238
2239 @item -Wswitch
2240 @opindex Wswitch
2241 Warn whenever a @code{switch} statement has an index of enumeral type
2242 and lacks a @code{case} for one or more of the named codes of that
2243 enumeration.  (The presence of a @code{default} label prevents this
2244 warning.)  @code{case} labels outside the enumeration range also
2245 provoke warnings when this option is used.
2246
2247 @item -Wswitch-default
2248 @opindex Wswitch-switch
2249 Warn whenever a @code{switch} statement does not have a @code{default}
2250 case.
2251
2252 @item -Wswitch-enum
2253 @opindex Wswitch-enum
2254 Warn whenever a @code{switch} statement has an index of enumeral type
2255 and lacks a @code{case} for one or more of the named codes of that
2256 enumeration.  @code{case} labels outside the enumeration range also
2257 provoke warnings when this option is used.
2258
2259 @item -Wtrigraphs
2260 @opindex Wtrigraphs
2261 Warn if any trigraphs are encountered that might change the meaning of
2262 the program (trigraphs within comments are not warned about).
2263
2264 @item -Wunused-function
2265 @opindex Wunused-function
2266 Warn whenever a static function is declared but not defined or a
2267 non\-inline static function is unused.
2268
2269 @item -Wunused-label
2270 @opindex Wunused-label
2271 Warn whenever a label is declared but not used.
2272
2273 To suppress this warning use the @samp{unused} attribute
2274 (@pxref{Variable Attributes}).
2275
2276 @item -Wunused-parameter
2277 @opindex Wunused-parameter
2278 Warn whenever a function parameter is unused aside from its declaration.
2279
2280 To suppress this warning use the @samp{unused} attribute
2281 (@pxref{Variable Attributes}).
2282
2283 @item -Wunused-variable
2284 @opindex Wunused-variable
2285 Warn whenever a local variable or non-constant static variable is unused
2286 aside from its declaration
2287
2288 To suppress this warning use the @samp{unused} attribute
2289 (@pxref{Variable Attributes}).
2290
2291 @item -Wunused-value
2292 @opindex Wunused-value
2293 Warn whenever a statement computes a result that is explicitly not used.
2294
2295 To suppress this warning cast the expression to @samp{void}.
2296
2297 @item -Wunused
2298 @opindex Wunused
2299 All the above @option{-Wunused} options combined.
2300
2301 In order to get a warning about an unused function parameter, you must
2302 either specify @samp{-W -Wunused} or separately specify
2303 @option{-Wunused-parameter}.
2304
2305 @item -Wuninitialized
2306 @opindex Wuninitialized
2307 Warn if an automatic variable is used without first being initialized or
2308 if a variable may be clobbered by a @code{setjmp} call.
2309
2310 These warnings are possible only in optimizing compilation,
2311 because they require data flow information that is computed only
2312 when optimizing.  If you don't specify @option{-O}, you simply won't
2313 get these warnings.
2314
2315 These warnings occur only for variables that are candidates for
2316 register allocation.  Therefore, they do not occur for a variable that
2317 is declared @code{volatile}, or whose address is taken, or whose size
2318 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2319 structures, unions or arrays, even when they are in registers.
2320
2321 Note that there may be no warning about a variable that is used only
2322 to compute a value that itself is never used, because such
2323 computations may be deleted by data flow analysis before the warnings
2324 are printed.
2325
2326 These warnings are made optional because GCC is not smart
2327 enough to see all the reasons why the code might be correct
2328 despite appearing to have an error.  Here is one example of how
2329 this can happen:
2330
2331 @smallexample
2332 @group
2333 @{
2334   int x;
2335   switch (y)
2336     @{
2337     case 1: x = 1;
2338       break;
2339     case 2: x = 4;
2340       break;
2341     case 3: x = 5;
2342     @}
2343   foo (x);
2344 @}
2345 @end group
2346 @end smallexample
2347
2348 @noindent
2349 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2350 always initialized, but GCC doesn't know this.  Here is
2351 another common case:
2352
2353 @smallexample
2354 @{
2355   int save_y;
2356   if (change_y) save_y = y, y = new_y;
2357   @dots{}
2358   if (change_y) y = save_y;
2359 @}
2360 @end smallexample
2361
2362 @noindent
2363 This has no bug because @code{save_y} is used only if it is set.
2364
2365 @cindex @code{longjmp} warnings
2366 This option also warns when a non-volatile automatic variable might be
2367 changed by a call to @code{longjmp}.  These warnings as well are possible
2368 only in optimizing compilation.
2369
2370 The compiler sees only the calls to @code{setjmp}.  It cannot know
2371 where @code{longjmp} will be called; in fact, a signal handler could
2372 call it at any point in the code.  As a result, you may get a warning
2373 even when there is in fact no problem because @code{longjmp} cannot
2374 in fact be called at the place which would cause a problem.
2375
2376 Some spurious warnings can be avoided if you declare all the functions
2377 you use that never return as @code{noreturn}.  @xref{Function
2378 Attributes}.
2379
2380 @item -Wunknown-pragmas
2381 @opindex Wunknown-pragmas
2382 @cindex warning for unknown pragmas
2383 @cindex unknown pragmas, warning
2384 @cindex pragmas, warning of unknown
2385 Warn when a #pragma directive is encountered which is not understood by
2386 GCC@.  If this command line option is used, warnings will even be issued
2387 for unknown pragmas in system header files.  This is not the case if
2388 the warnings were only enabled by the @option{-Wall} command line option.
2389
2390 @item -Wstrict-aliasing
2391 @opindex Wstrict-aliasing
2392 This option is only active when @option{-fstrict-aliasing} is active.
2393 It warns about code which might break the strict aliasing rules that the
2394 compiler is using for optimization. The warning does not catch all
2395 cases, but does attempt to catch the more common pitfalls. It is
2396 included in @option{-Wall}.
2397
2398 @item -Wall
2399 @opindex Wall
2400 All of the above @samp{-W} options combined.  This enables all the
2401 warnings about constructions that some users consider questionable, and
2402 that are easy to avoid (or modify to prevent the warning), even in
2403 conjunction with macros.  This also enables some language-specific
2404 warnings described in @ref{C++ Dialect Options} and
2405 @ref{Objective-C Dialect Options}.
2406 @end table
2407
2408 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2409 Some of them warn about constructions that users generally do not
2410 consider questionable, but which occasionally you might wish to check
2411 for; others warn about constructions that are necessary or hard to avoid
2412 in some cases, and there is no simple way to modify the code to suppress
2413 the warning.
2414
2415 @table @gcctabopt
2416 @item -W
2417 @opindex W
2418 Print extra warning messages for these events:
2419
2420 @itemize @bullet
2421 @item
2422 A function can return either with or without a value.  (Falling
2423 off the end of the function body is considered returning without
2424 a value.)  For example, this function would evoke such a
2425 warning:
2426
2427 @smallexample
2428 @group
2429 foo (a)
2430 @{
2431   if (a > 0)
2432     return a;
2433 @}
2434 @end group
2435 @end smallexample
2436
2437 @item
2438 An expression-statement or the left-hand side of a comma expression
2439 contains no side effects.
2440 To suppress the warning, cast the unused expression to void.
2441 For example, an expression such as @samp{x[i,j]} will cause a warning,
2442 but @samp{x[(void)i,j]} will not.
2443
2444 @item
2445 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
2446
2447 @item
2448 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2449 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2450 that of ordinary mathematical notation.
2451
2452 @item
2453 Storage-class specifiers like @code{static} are not the first things in
2454 a declaration.  According to the C Standard, this usage is obsolescent.
2455
2456 @item
2457 The return type of a function has a type qualifier such as @code{const}.
2458 Such a type qualifier has no effect, since the value returned by a
2459 function is not an lvalue.  (But don't warn about the GNU extension of
2460 @code{volatile void} return types.  That extension will be warned about
2461 if @option{-pedantic} is specified.)
2462
2463 @item
2464 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2465 arguments.
2466
2467 @item
2468 A comparison between signed and unsigned values could produce an
2469 incorrect result when the signed value is converted to unsigned.
2470 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2471
2472 @item
2473 An aggregate has a partly bracketed initializer.
2474 For example, the following code would evoke such a warning,
2475 because braces are missing around the initializer for @code{x.h}:
2476
2477 @smallexample
2478 struct s @{ int f, g; @};
2479 struct t @{ struct s h; int i; @};
2480 struct t x = @{ 1, 2, 3 @};
2481 @end smallexample
2482
2483 @item
2484 An aggregate has an initializer which does not initialize all members.
2485 For example, the following code would cause such a warning, because
2486 @code{x.h} would be implicitly initialized to zero:
2487
2488 @smallexample
2489 struct s @{ int f, g, h; @};
2490 struct s x = @{ 3, 4 @};
2491 @end smallexample
2492 @end itemize
2493
2494 @item -Wno-div-by-zero
2495 @opindex Wno-div-by-zero
2496 @opindex Wdiv-by-zero
2497 Do not warn about compile-time integer division by zero.  Floating point
2498 division by zero is not warned about, as it can be a legitimate way of
2499 obtaining infinities and NaNs.
2500
2501 @item -Wsystem-headers
2502 @opindex Wsystem-headers
2503 @cindex warnings from system headers
2504 @cindex system headers, warnings from
2505 Print warning messages for constructs found in system header files.
2506 Warnings from system headers are normally suppressed, on the assumption
2507 that they usually do not indicate real problems and would only make the
2508 compiler output harder to read.  Using this command line option tells
2509 GCC to emit warnings from system headers as if they occurred in user
2510 code.  However, note that using @option{-Wall} in conjunction with this
2511 option will @emph{not} warn about unknown pragmas in system
2512 headers---for that, @option{-Wunknown-pragmas} must also be used.
2513
2514 @item -Wfloat-equal
2515 @opindex Wfloat-equal
2516 Warn if floating point values are used in equality comparisons.
2517
2518 The idea behind this is that sometimes it is convenient (for the
2519 programmer) to consider floating-point values as approximations to
2520 infinitely precise real numbers.  If you are doing this, then you need
2521 to compute (by analysing the code, or in some other way) the maximum or
2522 likely maximum error that the computation introduces, and allow for it
2523 when performing comparisons (and when producing output, but that's a
2524 different problem).  In particular, instead of testing for equality, you
2525 would check to see whether the two values have ranges that overlap; and
2526 this is done with the relational operators, so equality comparisons are
2527 probably mistaken.
2528
2529 @item -Wtraditional @r{(C only)}
2530 @opindex Wtraditional
2531 Warn about certain constructs that behave differently in traditional and
2532 ISO C@.  Also warn about ISO C constructs that have no traditional C
2533 equivalent, and/or problematic constructs which should be avoided.
2534
2535 @itemize @bullet
2536 @item
2537 Macro parameters that appear within string literals in the macro body.
2538 In traditional C macro replacement takes place within string literals,
2539 but does not in ISO C@.
2540
2541 @item
2542 In traditional C, some preprocessor directives did not exist.
2543 Traditional preprocessors would only consider a line to be a directive
2544 if the @samp{#} appeared in column 1 on the line.  Therefore
2545 @option{-Wtraditional} warns about directives that traditional C
2546 understands but would ignore because the @samp{#} does not appear as the
2547 first character on the line.  It also suggests you hide directives like
2548 @samp{#pragma} not understood by traditional C by indenting them.  Some
2549 traditional implementations would not recognize @samp{#elif}, so it
2550 suggests avoiding it altogether.
2551
2552 @item
2553 A function-like macro that appears without arguments.
2554
2555 @item
2556 The unary plus operator.
2557
2558 @item
2559 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2560 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2561 constants.)  Note, these suffixes appear in macros defined in the system
2562 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2563 Use of these macros in user code might normally lead to spurious
2564 warnings, however gcc's integrated preprocessor has enough context to
2565 avoid warning in these cases.
2566
2567 @item
2568 A function declared external in one block and then used after the end of
2569 the block.
2570
2571 @item
2572 A @code{switch} statement has an operand of type @code{long}.
2573
2574 @item
2575 A non-@code{static} function declaration follows a @code{static} one.
2576 This construct is not accepted by some traditional C compilers.
2577
2578 @item
2579 The ISO type of an integer constant has a different width or
2580 signedness from its traditional type.  This warning is only issued if
2581 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2582 typically represent bit patterns, are not warned about.
2583
2584 @item
2585 Usage of ISO string concatenation is detected.
2586
2587 @item
2588 Initialization of automatic aggregates.
2589
2590 @item
2591 Identifier conflicts with labels.  Traditional C lacks a separate
2592 namespace for labels.
2593
2594 @item
2595 Initialization of unions.  If the initializer is zero, the warning is
2596 omitted.  This is done under the assumption that the zero initializer in
2597 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2598 initializer warnings and relies on default initialization to zero in the
2599 traditional C case.
2600
2601 @item
2602 Conversions by prototypes between fixed/floating point values and vice
2603 versa.  The absence of these prototypes when compiling with traditional
2604 C would cause serious problems.  This is a subset of the possible
2605 conversion warnings, for the full set use @option{-Wconversion}.
2606
2607 @item
2608 Use of ISO C style function definitions.  This warning intentionally is
2609 @emph{not} issued for prototype declarations or variadic functions
2610 because these ISO C features will appear in your code when using
2611 libiberty's traditional C compatibility macros, @code{PARAMS} and
2612 @code{VPARAMS}.  This warning is also bypassed for nested functions
2613 because that feature is already a gcc extension and thus not relevant to
2614 traditional C compatibility.
2615 @end itemize
2616
2617 @item -Wundef
2618 @opindex Wundef
2619 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2620
2621 @item -Wendif-labels
2622 @opindex Wendif-labels
2623 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2624
2625 @item -Wshadow
2626 @opindex Wshadow
2627 Warn whenever a local variable shadows another local variable, parameter or
2628 global variable or whenever a built-in function is shadowed.
2629
2630 @item -Wlarger-than-@var{len}
2631 @opindex Wlarger-than
2632 Warn whenever an object of larger than @var{len} bytes is defined.
2633
2634 @item -Wpointer-arith
2635 @opindex Wpointer-arith
2636 Warn about anything that depends on the ``size of'' a function type or
2637 of @code{void}.  GNU C assigns these types a size of 1, for
2638 convenience in calculations with @code{void *} pointers and pointers
2639 to functions.
2640
2641 @item -Wbad-function-cast @r{(C only)}
2642 @opindex Wbad-function-cast
2643 Warn whenever a function call is cast to a non-matching type.
2644 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2645
2646 @item -Wcast-qual
2647 @opindex Wcast-qual
2648 Warn whenever a pointer is cast so as to remove a type qualifier from
2649 the target type.  For example, warn if a @code{const char *} is cast
2650 to an ordinary @code{char *}.
2651
2652 @item -Wcast-align
2653 @opindex Wcast-align
2654 Warn whenever a pointer is cast such that the required alignment of the
2655 target is increased.  For example, warn if a @code{char *} is cast to
2656 an @code{int *} on machines where integers can only be accessed at
2657 two- or four-byte boundaries.
2658
2659 @item -Wwrite-strings
2660 @opindex Wwrite-strings
2661 When compiling C, give string constants the type @code{const
2662 char[@var{length}]} so that
2663 copying the address of one into a non-@code{const} @code{char *}
2664 pointer will get a warning; when compiling C++, warn about the
2665 deprecated conversion from string constants to @code{char *}.
2666 These warnings will help you find at
2667 compile time code that can try to write into a string constant, but
2668 only if you have been very careful about using @code{const} in
2669 declarations and prototypes.  Otherwise, it will just be a nuisance;
2670 this is why we did not make @option{-Wall} request these warnings.
2671
2672 @item -Wconversion
2673 @opindex Wconversion
2674 Warn if a prototype causes a type conversion that is different from what
2675 would happen to the same argument in the absence of a prototype.  This
2676 includes conversions of fixed point to floating and vice versa, and
2677 conversions changing the width or signedness of a fixed point argument
2678 except when the same as the default promotion.
2679
2680 Also, warn if a negative integer constant expression is implicitly
2681 converted to an unsigned type.  For example, warn about the assignment
2682 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2683 casts like @code{(unsigned) -1}.
2684
2685 @item -Wsign-compare
2686 @opindex Wsign-compare
2687 @cindex warning for comparison of signed and unsigned values
2688 @cindex comparison of signed and unsigned values, warning
2689 @cindex signed and unsigned values, comparison warning
2690 Warn when a comparison between signed and unsigned values could produce
2691 an incorrect result when the signed value is converted to unsigned.
2692 This warning is also enabled by @option{-W}; to get the other warnings
2693 of @option{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2694
2695 @item -Waggregate-return
2696 @opindex Waggregate-return
2697 Warn if any functions that return structures or unions are defined or
2698 called.  (In languages where you can return an array, this also elicits
2699 a warning.)
2700
2701 @item -Wstrict-prototypes @r{(C only)}
2702 @opindex Wstrict-prototypes
2703 Warn if a function is declared or defined without specifying the
2704 argument types.  (An old-style function definition is permitted without
2705 a warning if preceded by a declaration which specifies the argument
2706 types.)
2707
2708 @item -Wmissing-prototypes @r{(C only)}
2709 @opindex Wmissing-prototypes
2710 Warn if a global function is defined without a previous prototype
2711 declaration.  This warning is issued even if the definition itself
2712 provides a prototype.  The aim is to detect global functions that fail
2713 to be declared in header files.
2714
2715 @item -Wmissing-declarations
2716 @opindex Wmissing-declarations
2717 Warn if a global function is defined without a previous declaration.
2718 Do so even if the definition itself provides a prototype.
2719 Use this option to detect global functions that are not declared in
2720 header files.
2721
2722 @item -Wmissing-noreturn
2723 @opindex Wmissing-noreturn
2724 Warn about functions which might be candidates for attribute @code{noreturn}.
2725 Note these are only possible candidates, not absolute ones.  Care should
2726 be taken to manually verify functions actually do not ever return before
2727 adding the @code{noreturn} attribute, otherwise subtle code generation
2728 bugs could be introduced.  You will not get a warning for @code{main} in
2729 hosted C environments.
2730
2731 @item -Wmissing-format-attribute
2732 @opindex Wmissing-format-attribute
2733 @opindex Wformat
2734 If @option{-Wformat} is enabled, also warn about functions which might be
2735 candidates for @code{format} attributes.  Note these are only possible
2736 candidates, not absolute ones.  GCC will guess that @code{format}
2737 attributes might be appropriate for any function that calls a function
2738 like @code{vprintf} or @code{vscanf}, but this might not always be the
2739 case, and some functions for which @code{format} attributes are
2740 appropriate may not be detected.  This option has no effect unless
2741 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2742
2743 @item -Wno-multichar
2744 @opindex Wno-multichar
2745 @opindex Wmultichar
2746 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2747 Usually they indicate a typo in the user's code, as they have
2748 implementation-defined values, and should not be used in portable code.
2749
2750 @item -Wno-deprecated-declarations
2751 @opindex Wno-deprecated-declarations
2752 Do not warn about uses of functions, variables, and types marked as
2753 deprecated by using the @code{deprecated} attribute.
2754 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2755 @pxref{Type Attributes}.)
2756
2757 @item -Wpacked
2758 @opindex Wpacked
2759 Warn if a structure is given the packed attribute, but the packed
2760 attribute has no effect on the layout or size of the structure.
2761 Such structures may be mis-aligned for little benefit.  For
2762 instance, in this code, the variable @code{f.x} in @code{struct bar}
2763 will be misaligned even though @code{struct bar} does not itself
2764 have the packed attribute:
2765
2766 @smallexample
2767 @group
2768 struct foo @{
2769   int x;
2770   char a, b, c, d;
2771 @} __attribute__((packed));
2772 struct bar @{
2773   char z;
2774   struct foo f;
2775 @};
2776 @end group
2777 @end smallexample
2778
2779 @item -Wpadded
2780 @opindex Wpadded
2781 Warn if padding is included in a structure, either to align an element
2782 of the structure or to align the whole structure.  Sometimes when this
2783 happens it is possible to rearrange the fields of the structure to
2784 reduce the padding and so make the structure smaller.
2785
2786 @item -Wredundant-decls
2787 @opindex Wredundant-decls
2788 Warn if anything is declared more than once in the same scope, even in
2789 cases where multiple declaration is valid and changes nothing.
2790
2791 @item -Wnested-externs @r{(C only)}
2792 @opindex Wnested-externs
2793 Warn if an @code{extern} declaration is encountered within a function.
2794
2795 @item -Wunreachable-code
2796 @opindex Wunreachable-code
2797 Warn if the compiler detects that code will never be executed.
2798
2799 This option is intended to warn when the compiler detects that at
2800 least a whole line of source code will never be executed, because
2801 some condition is never satisfied or because it is after a
2802 procedure that never returns.
2803
2804 It is possible for this option to produce a warning even though there
2805 are circumstances under which part of the affected line can be executed,
2806 so care should be taken when removing apparently-unreachable code.
2807
2808 For instance, when a function is inlined, a warning may mean that the
2809 line is unreachable in only one inlined copy of the function.
2810
2811 This option is not made part of @option{-Wall} because in a debugging
2812 version of a program there is often substantial code which checks
2813 correct functioning of the program and is, hopefully, unreachable
2814 because the program does work.  Another common use of unreachable
2815 code is to provide behavior which is selectable at compile-time.
2816
2817 @item -Winline
2818 @opindex Winline
2819 Warn if a function can not be inlined and it was declared as inline.
2820
2821 @item -Wlong-long
2822 @opindex Wlong-long
2823 @opindex Wno-long-long
2824 Warn if @samp{long long} type is used.  This is default.  To inhibit
2825 the warning messages, use @option{-Wno-long-long}.  Flags
2826 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2827 only when @option{-pedantic} flag is used.
2828
2829 @item -Wdisabled-optimization
2830 @opindex Wdisabled-optimization
2831 Warn if a requested optimization pass is disabled.  This warning does
2832 not generally indicate that there is anything wrong with your code; it
2833 merely indicates that GCC's optimizers were unable to handle the code
2834 effectively.  Often, the problem is that your code is too big or too
2835 complex; GCC will refuse to optimize programs when the optimization
2836 itself is likely to take inordinate amounts of time.
2837
2838 @item -Werror
2839 @opindex Werror
2840 Make all warnings into errors.
2841 @end table
2842
2843 @node Debugging Options
2844 @section Options for Debugging Your Program or GCC
2845 @cindex options, debugging
2846 @cindex debugging information options
2847
2848 GCC has various special options that are used for debugging
2849 either your program or GCC:
2850
2851 @table @gcctabopt
2852 @item -g
2853 @opindex g
2854 Produce debugging information in the operating system's native format
2855 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2856 information.
2857
2858 On most systems that use stabs format, @option{-g} enables use of extra
2859 debugging information that only GDB can use; this extra information
2860 makes debugging work better in GDB but will probably make other debuggers
2861 crash or
2862 refuse to read the program.  If you want to control for certain whether
2863 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2864 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2865 or @option{-gvms} (see below).
2866
2867 Unlike most other C compilers, GCC allows you to use @option{-g} with
2868 @option{-O}.  The shortcuts taken by optimized code may occasionally
2869 produce surprising results: some variables you declared may not exist
2870 at all; flow of control may briefly move where you did not expect it;
2871 some statements may not be executed because they compute constant
2872 results or their values were already at hand; some statements may
2873 execute in different places because they were moved out of loops.
2874
2875 Nevertheless it proves possible to debug optimized output.  This makes
2876 it reasonable to use the optimizer for programs that might have bugs.
2877
2878 The following options are useful when GCC is generated with the
2879 capability for more than one debugging format.
2880
2881 @item -ggdb
2882 @opindex ggdb
2883 Produce debugging information for use by GDB@.  This means to use the
2884 most expressive format available (DWARF 2, stabs, or the native format
2885 if neither of those are supported), including GDB extensions if at all
2886 possible.
2887
2888 @item -gstabs
2889 @opindex gstabs
2890 Produce debugging information in stabs format (if that is supported),
2891 without GDB extensions.  This is the format used by DBX on most BSD
2892 systems.  On MIPS, Alpha and System V Release 4 systems this option
2893 produces stabs debugging output which is not understood by DBX or SDB@.
2894 On System V Release 4 systems this option requires the GNU assembler.
2895
2896 @item -gstabs+
2897 @opindex gstabs+
2898 Produce debugging information in stabs format (if that is supported),
2899 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2900 use of these extensions is likely to make other debuggers crash or
2901 refuse to read the program.
2902
2903 @item -gcoff
2904 @opindex gcoff
2905 Produce debugging information in COFF format (if that is supported).
2906 This is the format used by SDB on most System V systems prior to
2907 System V Release 4.
2908
2909 @item -gxcoff
2910 @opindex gxcoff
2911 Produce debugging information in XCOFF format (if that is supported).
2912 This is the format used by the DBX debugger on IBM RS/6000 systems.
2913
2914 @item -gxcoff+
2915 @opindex gxcoff+
2916 Produce debugging information in XCOFF format (if that is supported),
2917 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2918 use of these extensions is likely to make other debuggers crash or
2919 refuse to read the program, and may cause assemblers other than the GNU
2920 assembler (GAS) to fail with an error.
2921
2922 @item -gdwarf
2923 @opindex gdwarf
2924 Produce debugging information in DWARF version 1 format (if that is
2925 supported).  This is the format used by SDB on most System V Release 4
2926 systems.
2927
2928 This option is deprecated.
2929
2930 @item -gdwarf+
2931 @opindex gdwarf+
2932 Produce debugging information in DWARF version 1 format (if that is
2933 supported), using GNU extensions understood only by the GNU debugger
2934 (GDB)@.  The use of these extensions is likely to make other debuggers
2935 crash or refuse to read the program.
2936
2937 This option is deprecated.
2938
2939 @item -gdwarf-2
2940 @opindex gdwarf-2
2941 Produce debugging information in DWARF version 2 format (if that is
2942 supported).  This is the format used by DBX on IRIX 6.
2943
2944 @item -gvms
2945 @opindex gvms
2946 Produce debugging information in VMS debug format (if that is
2947 supported).  This is the format used by DEBUG on VMS systems.
2948
2949 @item -g@var{level}
2950 @itemx -ggdb@var{level}
2951 @itemx -gstabs@var{level}
2952 @itemx -gcoff@var{level}
2953 @itemx -gxcoff@var{level}
2954 @itemx -gvms@var{level}
2955 Request debugging information and also use @var{level} to specify how
2956 much information.  The default level is 2.
2957
2958 Level 1 produces minimal information, enough for making backtraces in
2959 parts of the program that you don't plan to debug.  This includes
2960 descriptions of functions and external variables, but no information
2961 about local variables and no line numbers.
2962
2963 Level 3 includes extra information, such as all the macro definitions
2964 present in the program.  Some debuggers support macro expansion when
2965 you use @option{-g3}.
2966
2967 Note that in order to avoid confusion between DWARF1 debug level 2,
2968 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2969 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2970 option to change the debug level for DWARF1 or DWARF2.
2971
2972 @item -feliminate-dwarf2-dups
2973 @opindex feliminate-dwarf2-dups
2974 Compress DWARF2 debugging information by eliminating duplicated
2975 information about each symbol.  This option only makes sense when
2976 generating DWARF2 debugging information with @option{-gdwarf-2}.
2977
2978 @cindex @code{prof}
2979 @item -p
2980 @opindex p
2981 Generate extra code to write profile information suitable for the
2982 analysis program @code{prof}.  You must use this option when compiling
2983 the source files you want data about, and you must also use it when
2984 linking.
2985
2986 @cindex @code{gprof}
2987 @item -pg
2988 @opindex pg
2989 Generate extra code to write profile information suitable for the
2990 analysis program @code{gprof}.  You must use this option when compiling
2991 the source files you want data about, and you must also use it when
2992 linking.
2993
2994 @item -Q
2995 @opindex Q
2996 Makes the compiler print out each function name as it is compiled, and
2997 print some statistics about each pass when it finishes.
2998
2999 @item -ftime-report
3000 @opindex ftime-report
3001 Makes the compiler print some statistics about the time consumed by each
3002 pass when it finishes.
3003
3004 @item -fmem-report
3005 @opindex fmem-report
3006 Makes the compiler print some statistics about permanent memory
3007 allocation when it finishes.
3008
3009 @item -fprofile-arcs
3010 @opindex fprofile-arcs
3011 Instrument @dfn{arcs} during compilation to generate coverage data or
3012 for profile-directed block ordering.  During execution the program
3013 records how many times each branch is executed and how many times it is
3014 taken.  When the compiled program exits it saves this data to a file
3015 called @file{@var{auxname}.da} for each source file.  @var{auxname} is
3016 generated from the name of the output file, if explicitly specified and
3017 it is not the final executable, otherwise it is the basename of the
3018 source file. In both cases any suffix is removed (e.g.  @file{foo.da}
3019 for input file @file{dir/foo.c}, or @file{dir/foo.da} for output file
3020 specified as @option{-o dir/foo.o}).
3021
3022 For profile-directed block ordering, compile the program with
3023 @option{-fprofile-arcs} plus optimization and code generation options,
3024 generate the arc profile information by running the program on a
3025 selected workload, and then compile the program again with the same
3026 optimization and code generation options plus
3027 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3028 Control Optimization}).
3029
3030 The other use of @option{-fprofile-arcs} is for use with @code{gcov},
3031 when it is used with the @option{-ftest-coverage} option.
3032
3033 With @option{-fprofile-arcs}, for each function of your program GCC
3034 creates a program flow graph, then finds a spanning tree for the graph.
3035 Only arcs that are not on the spanning tree have to be instrumented: the
3036 compiler adds code to count the number of times that these arcs are
3037 executed.  When an arc is the only exit or only entrance to a block, the
3038 instrumentation code can be added to the block; otherwise, a new basic
3039 block must be created to hold the instrumentation code.
3040
3041 @need 2000
3042 @item -ftest-coverage
3043 @opindex ftest-coverage
3044 Create data files for the @code{gcov} code-coverage utility
3045 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).  See
3046 @option{-fprofile-arcs} option above for a description of @var{auxname}.
3047
3048 @table @gcctabopt
3049 @item @var{auxname}.bb
3050 A mapping from basic blocks to line numbers, which @code{gcov} uses to
3051 associate basic block execution counts with line numbers.
3052
3053 @item @var{auxname}.bbg
3054 A list of all arcs in the program flow graph.  This allows @code{gcov}
3055 to reconstruct the program flow graph, so that it can compute all basic
3056 block and arc execution counts from the information in the
3057 @file{@var{auxname}.da} file.
3058 @end table
3059
3060 Use @option{-ftest-coverage} with @option{-fprofile-arcs}; the latter
3061 option adds instrumentation to the program, which then writes
3062 execution counts to another data file:
3063
3064 @table @gcctabopt
3065 @item @var{auxname}.da
3066 Runtime arc execution counts, used in conjunction with the arc
3067 information in the file @file{@var{auxname}.bbg}.
3068 @end table
3069
3070 Coverage data will map better to the source files if
3071 @option{-ftest-coverage} is used without optimization.
3072
3073 @item -d@var{letters}
3074 @opindex d
3075 Says to make debugging dumps during compilation at times specified by
3076 @var{letters}.  This is used for debugging the compiler.  The file names
3077 for most of the dumps are made by appending a pass number and a word to
3078 the @var{dumpname}. @var{dumpname} is generated from the name of the
3079 output file, if explicitly specified and it is not an executable,
3080 otherwise it is the basename of the source file. In both cases any
3081 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3082 Here are the possible letters for use in @var{letters}, and their
3083 meanings:
3084
3085 @table @samp
3086 @item A
3087 @opindex dA
3088 Annotate the assembler output with miscellaneous debugging information.
3089 @item b
3090 @opindex db
3091 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
3092 @item B
3093 @opindex dB
3094 Dump after block reordering, to @file{@var{file}.32.bbro}.
3095 @item c
3096 @opindex dc
3097 Dump after instruction combination, to the file @file{@var{file}.19.combine}.
3098 @item C
3099 @opindex dC
3100 Dump after the first if conversion, to the file @file{@var{file}.15.ce1}.
3101 @item d
3102 @opindex dd
3103 Dump after delayed branch scheduling, to @file{@var{file}.34.dbr}.
3104 @item D
3105 @opindex dD
3106 Dump all macro definitions, at the end of preprocessing, in addition to
3107 normal output.
3108 @item e
3109 @opindex de
3110 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3111 @file{@var{file}.07.ussa}.
3112 @item E
3113 @opindex dE
3114 Dump after the second if conversion, to @file{@var{file}.29.ce3}.
3115 @item f
3116 @opindex df
3117 Dump after life analysis, to @file{@var{file}.18.life}.
3118 @item F
3119 @opindex dF
3120 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3121 @item g
3122 @opindex dg
3123 Dump after global register allocation, to @file{@var{file}.24.greg}.
3124 @item h
3125 @opindex dh
3126 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3127 @item k
3128 @opindex dk
3129 Dump after reg-to-stack conversion, to @file{@var{file}.31.stack}.
3130 @item o
3131 @opindex do
3132 Dump after post-reload optimizations, to @file{@var{file}.25.postreload}.
3133 @item G
3134 @opindex dG
3135 Dump after GCSE, to @file{@var{file}.11.gcse}.
3136 @item i
3137 @opindex di
3138 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3139 @item j
3140 @opindex dj
3141 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3142 @item k
3143 @opindex dk
3144 Dump after conversion from registers to stack, to @file{@var{file}.31.stack}.
3145 @item l
3146 @opindex dl
3147 Dump after local register allocation, to @file{@var{file}.23.lreg}.
3148 @item L
3149 @opindex dL
3150 Dump after loop optimization, to @file{@var{file}.12.loop}.
3151 @item M
3152 @opindex dM
3153 Dump after performing the machine dependent reorganisation pass, to
3154 @file{@var{file}.33.mach}.
3155 @item n
3156 @opindex dn
3157 Dump after register renumbering, to @file{@var{file}.28.rnreg}.
3158 @item N
3159 @opindex dN
3160 Dump after the register move pass, to @file{@var{file}.21.regmove}.
3161 @item r
3162 @opindex dr
3163 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3164 @item R
3165 @opindex dR
3166 Dump after the second scheduling pass, to @file{@var{file}.30.sched2}.
3167 @item s
3168 @opindex ds
3169 Dump after CSE (including the jump optimization that sometimes follows
3170 CSE), to @file{@var{file}.09.cse}.
3171 @item S
3172 @opindex dS
3173 Dump after the first scheduling pass, to @file{@var{file}.22.sched}.
3174 @item t
3175 @opindex dt
3176 Dump after the second CSE pass (including the jump optimization that
3177 sometimes follows CSE), to @file{@var{file}.17.cse2}.
3178 @item u
3179 @opindex du
3180 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3181 @item w
3182 @opindex dw
3183 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3184 @item X
3185 @opindex dX
3186 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3187 @item z
3188 @opindex dz
3189 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3190 @item a
3191 @opindex da
3192 Produce all the dumps listed above.
3193 @item m
3194 @opindex dm
3195 Print statistics on memory usage, at the end of the run, to
3196 standard error.
3197 @item p
3198 @opindex dp
3199 Annotate the assembler output with a comment indicating which
3200 pattern and alternative was used.  The length of each instruction is
3201 also printed.
3202 @item P
3203 @opindex dP
3204 Dump the RTL in the assembler output as a comment before each instruction.
3205 Also turns on @option{-dp} annotation.
3206 @item v
3207 @opindex dv
3208 For each of the other indicated dump files (except for
3209 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3210 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3211 @item x
3212 @opindex dx
3213 Just generate RTL for a function instead of compiling it.  Usually used
3214 with @samp{r}.
3215 @item y
3216 @opindex dy
3217 Dump debugging information during parsing, to standard error.
3218 @end table
3219
3220 @item -fdump-unnumbered
3221 @opindex fdump-unnumbered
3222 When doing debugging dumps (see @option{-d} option above), suppress instruction
3223 numbers and line number note output.  This makes it more feasible to
3224 use diff on debugging dumps for compiler invocations with different
3225 options, in particular with and without @option{-g}.
3226
3227 @item -fdump-translation-unit @r{(C and C++ only)}
3228 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3229 @opindex fdump-translation-unit
3230 Dump a representation of the tree structure for the entire translation
3231 unit to a file.  The file name is made by appending @file{.tu} to the
3232 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3233 controls the details of the dump as described for the
3234 @option{-fdump-tree} options.
3235
3236 @item -fdump-class-hierarchy @r{(C++ only)}
3237 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3238 @opindex fdump-class-hierarchy
3239 Dump a representation of each class's hierarchy and virtual function
3240 table layout to a file.  The file name is made by appending @file{.class}
3241 to the source file name.  If the @samp{-@var{options}} form is used,
3242 @var{options} controls the details of the dump as described for the
3243 @option{-fdump-tree} options.
3244
3245 @item -fdump-tree-@var{switch} @r{(C++ only)}
3246 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3247 @opindex fdump-tree
3248 Control the dumping at various stages of processing the intermediate
3249 language tree to a file.  The file name is generated by appending a switch
3250 specific suffix to the source file name.  If the @samp{-@var{options}}
3251 form is used, @var{options} is a list of @samp{-} separated options that
3252 control the details of the dump. Not all options are applicable to all
3253 dumps, those which are not meaningful will be ignored. The following
3254 options are available
3255
3256 @table @samp
3257 @item address
3258 Print the address of each node.  Usually this is not meaningful as it
3259 changes according to the environment and source file. Its primary use
3260 is for tying up a dump file with a debug environment.
3261 @item slim
3262 Inhibit dumping of members of a scope or body of a function merely
3263 because that scope has been reached. Only dump such items when they
3264 are directly reachable by some other path.
3265 @item all
3266 Turn on all options.
3267 @end table
3268
3269 The following tree dumps are possible:
3270 @table @samp
3271 @item original
3272 Dump before any tree based optimization, to @file{@var{file}.original}.
3273 @item optimized
3274 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3275 @item inlined
3276 Dump after function inlining, to @file{@var{file}.inlined}.
3277 @end table
3278
3279 @item -fsched-verbose=@var{n}
3280 @opindex fsched-verbose
3281 On targets that use instruction scheduling, this option controls the
3282 amount of debugging output the scheduler prints.  This information is
3283 written to standard error, unless @option{-dS} or @option{-dR} is
3284 specified, in which case it is output to the usual dump
3285 listing file, @file{.sched} or @file{.sched2} respectively.  However
3286 for @var{n} greater than nine, the output is always printed to standard
3287 error.
3288
3289 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3290 same information as @option{-dRS}.  For @var{n} greater than one, it
3291 also output basic block probabilities, detailed ready list information
3292 and unit/insn info.  For @var{n} greater than two, it includes RTL
3293 at abort point, control-flow and regions info.  And for @var{n} over
3294 four, @option{-fsched-verbose} also includes dependence info.
3295
3296 @item -save-temps
3297 @opindex save-temps
3298 Store the usual ``temporary'' intermediate files permanently; place them
3299 in the current directory and name them based on the source file.  Thus,
3300 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3301 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3302 preprocessed @file{foo.i} output file even though the compiler now
3303 normally uses an integrated preprocessor.
3304
3305 @item -time
3306 @opindex time
3307 Report the CPU time taken by each subprocess in the compilation
3308 sequence.  For C source files, this is the compiler proper and assembler
3309 (plus the linker if linking is done).  The output looks like this:
3310
3311 @smallexample
3312 # cc1 0.12 0.01
3313 # as 0.00 0.01
3314 @end smallexample
3315
3316 The first number on each line is the ``user time,'' that is time spent
3317 executing the program itself.  The second number is ``system time,''
3318 time spent executing operating system routines on behalf of the program.
3319 Both numbers are in seconds.
3320
3321 @item -print-file-name=@var{library}
3322 @opindex print-file-name
3323 Print the full absolute name of the library file @var{library} that
3324 would be used when linking---and don't do anything else.  With this
3325 option, GCC does not compile or link anything; it just prints the
3326 file name.
3327
3328 @item -print-multi-directory
3329 @opindex print-multi-directory
3330 Print the directory name corresponding to the multilib selected by any
3331 other switches present in the command line.  This directory is supposed
3332 to exist in @env{GCC_EXEC_PREFIX}.
3333
3334 @item -print-multi-lib
3335 @opindex print-multi-lib
3336 Print the mapping from multilib directory names to compiler switches
3337 that enable them.  The directory name is separated from the switches by
3338 @samp{;}, and each switch starts with an @samp{@@} instead of the
3339 @samp{-}, without spaces between multiple switches.  This is supposed to
3340 ease shell-processing.
3341
3342 @item -print-prog-name=@var{program}
3343 @opindex print-prog-name
3344 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3345
3346 @item -print-libgcc-file-name
3347 @opindex print-libgcc-file-name
3348 Same as @option{-print-file-name=libgcc.a}.
3349
3350 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3351 but you do want to link with @file{libgcc.a}.  You can do
3352
3353 @example
3354 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3355 @end example
3356
3357 @item -print-search-dirs
3358 @opindex print-search-dirs
3359 Print the name of the configured installation directory and a list of
3360 program and library directories gcc will search---and don't do anything else.
3361
3362 This is useful when gcc prints the error message
3363 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3364 To resolve this you either need to put @file{cpp0} and the other compiler
3365 components where gcc expects to find them, or you can set the environment
3366 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3367 Don't forget the trailing '/'.
3368 @xref{Environment Variables}.
3369
3370 @item -dumpmachine
3371 @opindex dumpmachine
3372 Print the compiler's target machine (for example,
3373 @samp{i686-pc-linux-gnu})---and don't do anything else.
3374
3375 @item -dumpversion
3376 @opindex dumpversion
3377 Print the compiler version (for example, @samp{3.0})---and don't do
3378 anything else.
3379
3380 @item -dumpspecs
3381 @opindex dumpspecs
3382 Print the compiler's built-in specs---and don't do anything else.  (This
3383 is used when GCC itself is being built.)  @xref{Spec Files}.
3384 @end table
3385
3386 @node Optimize Options
3387 @section Options That Control Optimization
3388 @cindex optimize options
3389 @cindex options, optimization
3390
3391 These options control various sorts of optimizations:
3392
3393 @table @gcctabopt
3394 @item -O
3395 @itemx -O1
3396 @opindex O
3397 @opindex O1
3398 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3399 more memory for a large function.
3400
3401 Without @option{-O}, the compiler's goal is to reduce the cost of
3402 compilation and to make debugging produce the expected results.
3403 Statements are independent: if you stop the program with a breakpoint
3404 between statements, you can then assign a new value to any variable or
3405 change the program counter to any other statement in the function and
3406 get exactly the results you would expect from the source code.
3407
3408 With @option{-O}, the compiler tries to reduce code size and execution
3409 time, without performing any optimizations that take a great deal of
3410 compilation time.
3411
3412 @item -O2
3413 @opindex O2
3414 Optimize even more.  GCC performs nearly all supported optimizations
3415 that do not involve a space-speed tradeoff.  The compiler does not
3416 perform loop unrolling or function inlining when you specify @option{-O2}.
3417 As compared to @option{-O}, this option increases both compilation time
3418 and the performance of the generated code.
3419
3420 @option{-O2} turns on all optional optimizations except for loop
3421 unrolling, function inlining, and register renaming.  It also turns on
3422 the @option{-fforce-mem} and @option{-fstrict-aliasing} option on all
3423 machines and frame pointer elimination on machines where doing so does
3424 not interfere with debugging.
3425
3426 Please note the warning under @option{-fgcse} about
3427 invoking @option{-O2} on programs that use computed gotos.
3428
3429 @item -O3
3430 @opindex O3
3431 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3432 @option{-O2} and also turns on the @option{-finline-functions} and
3433 @option{-frename-registers} options.
3434
3435 @item -O0
3436 @opindex O0
3437 Do not optimize.
3438
3439 @item -Os
3440 @opindex Os
3441 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3442 do not typically increase code size.  It also performs further
3443 optimizations designed to reduce code size.
3444
3445 If you use multiple @option{-O} options, with or without level numbers,
3446 the last such option is the one that is effective.
3447 @end table
3448
3449 Options of the form @option{-f@var{flag}} specify machine-independent
3450 flags.  Most flags have both positive and negative forms; the negative
3451 form of @option{-ffoo} would be @option{-fno-foo}.  In the table below,
3452 only one of the forms is listed---the one which is not the default.
3453 You can figure out the other form by either removing @samp{no-} or
3454 adding it.
3455
3456 @table @gcctabopt
3457 @item -ffloat-store
3458 @opindex ffloat-store
3459 Do not store floating point variables in registers, and inhibit other
3460 options that might change whether a floating point value is taken from a
3461 register or memory.
3462
3463 @cindex floating point precision
3464 This option prevents undesirable excess precision on machines such as
3465 the 68000 where the floating registers (of the 68881) keep more
3466 precision than a @code{double} is supposed to have.  Similarly for the
3467 x86 architecture.  For most programs, the excess precision does only
3468 good, but a few programs rely on the precise definition of IEEE floating
3469 point.  Use @option{-ffloat-store} for such programs, after modifying
3470 them to store all pertinent intermediate computations into variables.
3471
3472 @item -fno-default-inline
3473 @opindex fno-default-inline
3474 Do not make member functions inline by default merely because they are
3475 defined inside the class scope (C++ only).  Otherwise, when you specify
3476 @w{@option{-O}}, member functions defined inside class scope are compiled
3477 inline by default; i.e., you don't need to add @samp{inline} in front of
3478 the member function name.
3479
3480 @item -fno-defer-pop
3481 @opindex fno-defer-pop
3482 Always pop the arguments to each function call as soon as that function
3483 returns.  For machines which must pop arguments after a function call,
3484 the compiler normally lets arguments accumulate on the stack for several
3485 function calls and pops them all at once.
3486
3487 @item -fforce-mem
3488 @opindex fforce-mem
3489 Force memory operands to be copied into registers before doing
3490 arithmetic on them.  This produces better code by making all memory
3491 references potential common subexpressions.  When they are not common
3492 subexpressions, instruction combination should eliminate the separate
3493 register-load.  The @option{-O2} option turns on this option.
3494
3495 @item -fforce-addr
3496 @opindex fforce-addr
3497 Force memory address constants to be copied into registers before
3498 doing arithmetic on them.  This may produce better code just as
3499 @option{-fforce-mem} may.
3500
3501 @item -fomit-frame-pointer
3502 @opindex fomit-frame-pointer
3503 Don't keep the frame pointer in a register for functions that
3504 don't need one.  This avoids the instructions to save, set up and
3505 restore frame pointers; it also makes an extra register available
3506 in many functions.  @strong{It also makes debugging impossible on
3507 some machines.}
3508
3509 On some machines, such as the VAX, this flag has no effect, because
3510 the standard calling sequence automatically handles the frame pointer
3511 and nothing is saved by pretending it doesn't exist.  The
3512 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3513 whether a target machine supports this flag.  @xref{Registers,,Register
3514 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3515
3516 @item -foptimize-sibling-calls
3517 @opindex foptimize-sibling-calls
3518 Optimize sibling and tail recursive calls.
3519
3520 @item -ftrapv
3521 @opindex ftrapv
3522 This option generates traps for signed overflow on addition, subtraction,
3523 multiplication operations.
3524
3525 @item -fno-inline
3526 @opindex fno-inline
3527 Don't pay attention to the @code{inline} keyword.  Normally this option
3528 is used to keep the compiler from expanding any functions inline.
3529 Note that if you are not optimizing, no functions can be expanded inline.
3530
3531 @item -finline-functions
3532 @opindex finline-functions
3533 Integrate all simple functions into their callers.  The compiler
3534 heuristically decides which functions are simple enough to be worth
3535 integrating in this way.
3536
3537 If all calls to a given function are integrated, and the function is
3538 declared @code{static}, then the function is normally not output as
3539 assembler code in its own right.
3540
3541 @item -finline-limit=@var{n}
3542 @opindex finline-limit
3543 By default, gcc limits the size of functions that can be inlined.  This flag
3544 allows the control of this limit for functions that are explicitly marked as
3545 inline (i.e., marked with the inline keyword or defined within the class
3546 definition in c++).  @var{n} is the size of functions that can be inlined in
3547 number of pseudo instructions (not counting parameter handling).  The default
3548 value of @var{n} is 600.
3549 Increasing this value can result in more inlined code at
3550 the cost of compilation time and memory consumption.  Decreasing usually makes
3551 the compilation faster and less code will be inlined (which presumably
3552 means slower programs).  This option is particularly useful for programs that
3553 use inlining heavily such as those based on recursive templates with C++.
3554
3555 @emph{Note:} pseudo instruction represents, in this particular context, an
3556 abstract measurement of function's size.  In no way, it represents a count
3557 of assembly instructions and as such its exact meaning might change from one
3558 release to an another.
3559
3560 @item -fkeep-inline-functions
3561 @opindex fkeep-inline-functions
3562 Even if all calls to a given function are integrated, and the function
3563 is declared @code{static}, nevertheless output a separate run-time
3564 callable version of the function.  This switch does not affect
3565 @code{extern inline} functions.
3566
3567 @item -fkeep-static-consts
3568 @opindex fkeep-static-consts
3569 Emit variables declared @code{static const} when optimization isn't turned
3570 on, even if the variables aren't referenced.
3571
3572 GCC enables this option by default.  If you want to force the compiler to
3573 check if the variable was referenced, regardless of whether or not
3574 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3575
3576 @item -fmerge-constants
3577 Attempt to merge identical constants (string constants and floating point
3578 constants) across compilation units.
3579
3580 This option is the default for optimized compilation if the assembler and
3581 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3582 behavior.
3583
3584 @item -fmerge-all-constants
3585 Attempt to merge identical constants and identical variables.
3586
3587 This option implies @option{-fmerge-constants}.  In addition to
3588 @option{-fmerge-constants} this considers e.g. even constant initialized
3589 arrays or initialized constant variables with integral or floating point
3590 types.  Languages like C or C++ require each non-automatic variable to
3591 have distinct location, so using this option will result in non-conforming
3592 behavior.
3593
3594 @item -fnew-ra
3595 @opindex fnew-ra
3596 Use a graph coloring register allocator.  Currently this option is meant
3597 for testing, so we are interested to hear about miscompilations with
3598 @option{-fnew-ra}.
3599
3600 @item -fno-branch-count-reg
3601 @opindex fno-branch-count-reg
3602 Do not use ``decrement and branch'' instructions on a count register,
3603 but instead generate a sequence of instructions that decrement a
3604 register, compare it against zero, then branch based upon the result.
3605 This option is only meaningful on architectures that support such
3606 instructions, which include x86, PowerPC, IA-64 and S/390.
3607
3608 @item -fno-function-cse
3609 @opindex fno-function-cse
3610 Do not put function addresses in registers; make each instruction that
3611 calls a constant function contain the function's address explicitly.
3612
3613 This option results in less efficient code, but some strange hacks
3614 that alter the assembler output may be confused by the optimizations
3615 performed when this option is not used.
3616
3617 @item -ffast-math
3618 @opindex ffast-math
3619 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
3620 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
3621 @option{-fno-signaling-nans}.
3622
3623 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
3624
3625 This option should never be turned on by any @option{-O} option since
3626 it can result in incorrect output for programs which depend on
3627 an exact implementation of IEEE or ISO rules/specifications for
3628 math functions.
3629
3630 @item -fno-math-errno
3631 @opindex fno-math-errno
3632 Do not set ERRNO after calling math functions that are executed
3633 with a single instruction, e.g., sqrt.  A program that relies on
3634 IEEE exceptions for math error handling may want to use this flag
3635 for speed while maintaining IEEE arithmetic compatibility.
3636
3637 This option should never be turned on by any @option{-O} option since
3638 it can result in incorrect output for programs which depend on
3639 an exact implementation of IEEE or ISO rules/specifications for
3640 math functions.
3641
3642 The default is @option{-fmath-errno}.
3643
3644 @item -funsafe-math-optimizations
3645 @opindex funsafe-math-optimizations
3646 Allow optimizations for floating-point arithmetic that (a) assume
3647 that arguments and results are valid and (b) may violate IEEE or
3648 ANSI standards.  When used at link-time, it may include libraries
3649 or startup files that change the default FPU control word or other
3650 similar optimizations.
3651
3652 This option should never be turned on by any @option{-O} option since
3653 it can result in incorrect output for programs which depend on
3654 an exact implementation of IEEE or ISO rules/specifications for
3655 math functions.
3656
3657 The default is @option{-fno-unsafe-math-optimizations}.
3658
3659 @item -ffinite-math-only
3660 @opindex ffinite-math-only
3661 Allow optimizations for floating-point arithmetic that assume
3662 that arguments and results are not NaNs or +-Infs.
3663
3664 This option should never be turned on by any @option{-O} option since
3665 it can result in incorrect output for programs which depend on
3666 an exact implementation of IEEE or ISO rules/specifications.
3667
3668 The default is @option{-fno-finite-math-only}.
3669
3670 @item -fno-trapping-math
3671 @opindex fno-trapping-math
3672 Compile code assuming that floating-point operations cannot generate
3673 user-visible traps.  These traps include division by zero, overflow,
3674 underflow, inexact result and invalid operation.  This option implies
3675 @option{-fno-signaling-nans}.  Setting this option may allow faster
3676 code if one relies on ``non-stop'' IEEE arithmetic, for example.
3677
3678 This option should never be turned on by any @option{-O} option since
3679 it can result in incorrect output for programs which depend on
3680 an exact implementation of IEEE or ISO rules/specifications for
3681 math functions.
3682
3683 The default is @option{-ftrapping-math}.
3684
3685 @item -fsignaling-nans
3686 @opindex fsignaling-nans
3687 Compile code assuming that IEEE signaling NaNs may generate user-visible
3688 traps during floating-point operations.  Setting this option disables
3689 optimizations that may change the number of exceptions visible with
3690 signaling NaNs.  This option implies @option{-ftrapping-math}.
3691
3692 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
3693 be defined.
3694
3695 The default is @option{-fno-signaling-nans}.
3696
3697 This option is experimental and does not currently guarantee to
3698 disable all GCC optimizations that affect signaling NaN behavior.
3699
3700 @item -fno-zero-initialized-in-bss
3701 @opindex fno-zero-initialized-in-bss
3702 If the target supports a BSS section, GCC by default puts variables that
3703 are initialized to zero into BSS@.  This can save space in the resulting
3704 code.
3705
3706 This option turns off this behavior because some programs explicitly
3707 rely on variables going to the data section.  E.g., so that the
3708 resulting executable can find the beginning of that section and/or make
3709 assumptions based on that.
3710
3711 The default is @option{-fzero-initialized-in-bss}.
3712
3713 @item -fbounds-check
3714 @opindex fbounds-check
3715 For front-ends that support it, generate additional code to check that
3716 indices used to access arrays are within the declared range.  This is
3717 currently only supported by the Java and Fortran 77 front-ends, where
3718 this option defaults to true and false respectively.
3719
3720 @end table
3721
3722 The following options control specific optimizations.  The @option{-O2}
3723 option turns on all of these optimizations except @option{-funroll-loops}
3724 and @option{-funroll-all-loops}.  On most machines, the @option{-O} option
3725 turns on the @option{-fthread-jumps} and @option{-fdelayed-branch} options,
3726 but specific machines may handle it differently.
3727
3728 You can use the following flags in the rare cases when ``fine-tuning''
3729 of optimizations to be performed is desired.
3730
3731 Not all of the optimizations performed by GCC have @option{-f} options
3732 to control them.
3733
3734 @table @gcctabopt
3735 @item -fstrength-reduce
3736 @opindex fstrength-reduce
3737 Perform the optimizations of loop strength reduction and
3738 elimination of iteration variables.
3739
3740 @item -fthread-jumps
3741 @opindex fthread-jumps
3742 Perform optimizations where we check to see if a jump branches to a
3743 location where another comparison subsumed by the first is found.  If
3744 so, the first branch is redirected to either the destination of the
3745 second branch or a point immediately following it, depending on whether
3746 the condition is known to be true or false.
3747
3748 @item -fcse-follow-jumps
3749 @opindex fcse-follow-jumps
3750 In common subexpression elimination, scan through jump instructions
3751 when the target of the jump is not reached by any other path.  For
3752 example, when CSE encounters an @code{if} statement with an
3753 @code{else} clause, CSE will follow the jump when the condition
3754 tested is false.
3755
3756 @item -fcse-skip-blocks
3757 @opindex fcse-skip-blocks
3758 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3759 follow jumps which conditionally skip over blocks.  When CSE
3760 encounters a simple @code{if} statement with no else clause,
3761 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3762 body of the @code{if}.
3763
3764 @item -frerun-cse-after-loop
3765 @opindex frerun-cse-after-loop
3766 Re-run common subexpression elimination after loop optimizations has been
3767 performed.
3768
3769 @item -frerun-loop-opt
3770 @opindex frerun-loop-opt
3771 Run the loop optimizer twice.
3772
3773 @item -fgcse
3774 @opindex fgcse
3775 Perform a global common subexpression elimination pass.
3776 This pass also performs global constant and copy propagation.
3777
3778 @emph{Note:} When compiling a program using computed gotos, a GCC
3779 extension, you may get better runtime performance if you disable
3780 the global common subexpression elimination pass by adding
3781 @option{-fno-gcse} to the command line.
3782
3783 @item -fgcse-lm
3784 @opindex fgcse-lm
3785 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3786 attempt to move loads which are only killed by stores into themselves.  This
3787 allows a loop containing a load/store sequence to be changed to a load outside
3788 the loop, and a copy/store within the loop.
3789
3790 @item -fgcse-sm
3791 @opindex fgcse-sm
3792 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3793 subexpression elimination.  This pass will attempt to move stores out of loops.
3794 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3795 can be changed to a load before the loop and a store after the loop.
3796
3797 @item -floop-optimize
3798 @opindex floop-optimize
3799 Perform loop optimizations: move constant expressions out of loops, simplify
3800 exit test conditions and optionally do strength-reduction and loop unrolling as
3801 well.
3802
3803 @item -fcrossjumping
3804 @opindex crossjumping
3805 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3806 resulting code may or may not perform better than without cross-jumping.
3807
3808 @item -fif-conversion
3809 @opindex if-conversion
3810 Attempt to transform conditional jumps into branch-less equivalents.  This
3811 include use of conditional moves, min, max, set flags and abs instructions, and
3812 some tricks doable by standard arithmetics.  The use of conditional execution
3813 on chips where it is available is controlled by @code{if-conversion2}.
3814
3815 @item -fif-conversion2
3816 @opindex if-conversion2
3817 Use conditional execution (where available) to transform conditional jumps into
3818 branch-less equivalents.
3819
3820 @item -fdelete-null-pointer-checks
3821 @opindex fdelete-null-pointer-checks
3822 Use global dataflow analysis to identify and eliminate useless checks
3823 for null pointers.  The compiler assumes that dereferencing a null
3824 pointer would have halted the program.  If a pointer is checked after
3825 it has already been dereferenced, it cannot be null.
3826
3827 In some environments, this assumption is not true, and programs can
3828 safely dereference null pointers.  Use
3829 @option{-fno-delete-null-pointer-checks} to disable this optimization
3830 for programs which depend on that behavior.
3831
3832 @item -fexpensive-optimizations
3833 @opindex fexpensive-optimizations
3834 Perform a number of minor optimizations that are relatively expensive.
3835
3836 @item -foptimize-register-move
3837 @itemx -fregmove
3838 @opindex foptimize-register-move
3839 @opindex fregmove
3840 Attempt to reassign register numbers in move instructions and as
3841 operands of other simple instructions in order to maximize the amount of
3842 register tying.  This is especially helpful on machines with two-operand
3843 instructions.  GCC enables this optimization by default with @option{-O2}
3844 or higher.
3845
3846 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3847 optimization.
3848
3849 @item -fdelayed-branch
3850 @opindex fdelayed-branch
3851 If supported for the target machine, attempt to reorder instructions
3852 to exploit instruction slots available after delayed branch
3853 instructions.
3854
3855 @item -fschedule-insns
3856 @opindex fschedule-insns
3857 If supported for the target machine, attempt to reorder instructions to
3858 eliminate execution stalls due to required data being unavailable.  This
3859 helps machines that have slow floating point or memory load instructions
3860 by allowing other instructions to be issued until the result of the load
3861 or floating point instruction is required.
3862
3863 @item -fschedule-insns2
3864 @opindex fschedule-insns2
3865 Similar to @option{-fschedule-insns}, but requests an additional pass of
3866 instruction scheduling after register allocation has been done.  This is
3867 especially useful on machines with a relatively small number of
3868 registers and where memory load instructions take more than one cycle.
3869
3870 @item -fno-sched-interblock
3871 @opindex fno-sched-interblock
3872 Don't schedule instructions across basic blocks.  This is normally
3873 enabled by default when scheduling before register allocation, i.e.@:
3874 with @option{-fschedule-insns} or at @option{-O2} or higher.
3875
3876 @item -fno-sched-spec
3877 @opindex fno-sched-spec
3878 Don't allow speculative motion of non-load instructions.  This is normally
3879 enabled by default when scheduling before register allocation, i.e.@:
3880 with @option{-fschedule-insns} or at @option{-O2} or higher.
3881
3882 @item -fsched-spec-load
3883 @opindex fsched-spec-load
3884 Allow speculative motion of some load instructions.  This only makes
3885 sense when scheduling before register allocation, i.e.@: with
3886 @option{-fschedule-insns} or at @option{-O2} or higher.
3887
3888 @item -fsched-spec-load-dangerous
3889 @opindex fsched-spec-load-dangerous
3890 Allow speculative motion of more load instructions.  This only makes
3891 sense when scheduling before register allocation, i.e.@: with
3892 @option{-fschedule-insns} or at @option{-O2} or higher.
3893
3894 @item -ffunction-sections
3895 @itemx -fdata-sections
3896 @opindex ffunction-sections
3897 @opindex fdata-sections
3898 Place each function or data item into its own section in the output
3899 file if the target supports arbitrary sections.  The name of the
3900 function or the name of the data item determines the section's name
3901 in the output file.
3902
3903 Use these options on systems where the linker can perform optimizations
3904 to improve locality of reference in the instruction space.  HPPA
3905 processors running HP-UX and SPARC processors running Solaris 2 have
3906 linkers with such optimizations.  Other systems using the ELF object format
3907 as well as AIX may have these optimizations in the future.
3908
3909 Only use these options when there are significant benefits from doing
3910 so.  When you specify these options, the assembler and linker will
3911 create larger object and executable files and will also be slower.
3912 You will not be able to use @code{gprof} on all systems if you
3913 specify this option and you may have problems with debugging if
3914 you specify both this option and @option{-g}.
3915
3916 @item -fcaller-saves
3917 @opindex fcaller-saves
3918 Enable values to be allocated in registers that will be clobbered by
3919 function calls, by emitting extra instructions to save and restore the
3920 registers around such calls.  Such allocation is done only when it
3921 seems to result in better code than would otherwise be produced.
3922
3923 This option is always enabled by default on certain machines, usually
3924 those which have no call-preserved registers to use instead.
3925
3926 For all machines, optimization level 2 and higher enables this flag by
3927 default.
3928
3929 @item -ftracer
3930 @opindex ftracer
3931 Perform tail duplication to enlarge superblock size. This transformation
3932 simplifies the control flow of the function allowing other optimizations to do
3933 better job.
3934
3935 @item -funroll-loops
3936 @opindex funroll-loops
3937 Unroll loops whose number of iterations can be determined at compile
3938 time or upon entry to the loop.  @option{-funroll-loops} implies both
3939 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
3940 option makes code larger, and may or may not make it run faster.
3941
3942 @item -funroll-all-loops
3943 @opindex funroll-all-loops
3944 Unroll all loops, even if their number of iterations is uncertain when
3945 the loop is entered.  This usually makes programs run more slowly.
3946 @option{-funroll-all-loops} implies the same options as
3947 @option{-funroll-loops},
3948
3949 @item -fprefetch-loop-arrays
3950 @opindex fprefetch-loop-arrays
3951 If supported by the target machine, generate instructions to prefetch
3952 memory to improve the performance of loops that access large arrays.
3953
3954 @item -fmove-all-movables
3955 @opindex fmove-all-movables
3956 Forces all invariant computations in loops to be moved
3957 outside the loop.
3958
3959 @item -freduce-all-givs
3960 @opindex freduce-all-givs
3961 Forces all general-induction variables in loops to be
3962 strength-reduced.
3963
3964 @emph{Note:} When compiling programs written in Fortran,
3965 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3966 by default when you use the optimizer.
3967
3968 These options may generate better or worse code; results are highly
3969 dependent on the structure of loops within the source code.
3970
3971 These two options are intended to be removed someday, once
3972 they have helped determine the efficacy of various
3973 approaches to improving loop optimizations.
3974
3975 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3976 know how use of these options affects
3977 the performance of your production code.
3978 We're very interested in code that runs @emph{slower}
3979 when these options are @emph{enabled}.
3980
3981 @item -fno-peephole
3982 @itemx -fno-peephole2
3983 @opindex fno-peephole
3984 @opindex fno-peephole2
3985 Disable any machine-specific peephole optimizations.  The difference
3986 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3987 are implemented in the compiler; some targets use one, some use the
3988 other, a few use both.
3989
3990 @item -fbranch-probabilities
3991 @opindex fbranch-probabilities
3992 After running a program compiled with @option{-fprofile-arcs}
3993 (@pxref{Debugging Options,, Options for Debugging Your Program or
3994 @command{gcc}}), you can compile it a second time using
3995 @option{-fbranch-probabilities}, to improve optimizations based on
3996 the number of times each branch was taken.  When the program
3997 compiled with @option{-fprofile-arcs} exits it saves arc execution
3998 counts to a file called @file{@var{sourcename}.da} for each source
3999 file  The information in this data file is very dependent on the
4000 structure of the generated code, so you must use the same source code
4001 and the same optimization options for both compilations.
4002
4003 With @option{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
4004 note on the first instruction of each basic block, and a
4005 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4006 These can be used to improve optimization.  Currently, they are only
4007 used in one place: in @file{reorg.c}, instead of guessing which path a
4008 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4009 exactly determine which path is taken more often.
4010
4011 @item -fno-guess-branch-probability
4012 @opindex fno-guess-branch-probability
4013 Do not guess branch probabilities using a randomized model.
4014
4015 Sometimes gcc will opt to use a randomized model to guess branch
4016 probabilities, when none are available from either profiling feedback
4017 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4018 different runs of the compiler on the same program may produce different
4019 object code.
4020
4021 In a hard real-time system, people don't want different runs of the
4022 compiler to produce code that has different behavior; minimizing
4023 non-determinism is of paramount import.  This switch allows users to
4024 reduce non-determinism, possibly at the expense of inferior
4025 optimization.
4026
4027 @item -freorder-blocks
4028 @opindex freorder-blocks
4029 Reorder basic blocks in the compiled function in order to reduce number of
4030 taken branches and improve code locality.
4031
4032 @item -freorder-functions
4033 @opindex freorder-functions
4034 Reorder basic blocks in the compiled function in order to reduce number of
4035 taken branches and improve code locality. This is implemented by using special
4036 subsections @code{text.hot} for most frequently executed functions and
4037 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4038 the linker so object file format must support named sections and linker must
4039 place them in a reasonable way.
4040
4041 Also profile feedback must be available in to make this option effective.  See
4042 @option{-fprofile-arcs} for details.
4043
4044 @item -fstrict-aliasing
4045 @opindex fstrict-aliasing
4046 Allows the compiler to assume the strictest aliasing rules applicable to
4047 the language being compiled.  For C (and C++), this activates
4048 optimizations based on the type of expressions.  In particular, an
4049 object of one type is assumed never to reside at the same address as an
4050 object of a different type, unless the types are almost the same.  For
4051 example, an @code{unsigned int} can alias an @code{int}, but not a
4052 @code{void*} or a @code{double}.  A character type may alias any other
4053 type.
4054
4055 Pay special attention to code like this:
4056 @example
4057 union a_union @{
4058   int i;
4059   double d;
4060 @};
4061
4062 int f() @{
4063   a_union t;
4064   t.d = 3.0;
4065   return t.i;
4066 @}
4067 @end example
4068 The practice of reading from a different union member than the one most
4069 recently written to (called ``type-punning'') is common.  Even with
4070 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4071 is accessed through the union type.  So, the code above will work as
4072 expected.  However, this code might not:
4073 @example
4074 int f() @{
4075   a_union t;
4076   int* ip;
4077   t.d = 3.0;
4078   ip = &t.i;
4079   return *ip;
4080 @}
4081 @end example
4082
4083 Every language that wishes to perform language-specific alias analysis
4084 should define a function that computes, given an @code{tree}
4085 node, an alias set for the node.  Nodes in different alias sets are not
4086 allowed to alias.  For an example, see the C front-end function
4087 @code{c_get_alias_set}.
4088
4089 For all machines, optimization level 2 and higher enables this flag by
4090 default.
4091
4092 @item -falign-functions
4093 @itemx -falign-functions=@var{n}
4094 @opindex falign-functions
4095 Align the start of functions to the next power-of-two greater than
4096 @var{n}, skipping up to @var{n} bytes.  For instance,
4097 @option{-falign-functions=32} aligns functions to the next 32-byte
4098 boundary, but @option{-falign-functions=24} would align to the next
4099 32-byte boundary only if this can be done by skipping 23 bytes or less.
4100
4101 @option{-fno-align-functions} and @option{-falign-functions=1} are
4102 equivalent and mean that functions will not be aligned.
4103
4104 Some assemblers only support this flag when @var{n} is a power of two;
4105 in that case, it is rounded up.
4106
4107 If @var{n} is not specified, use a machine-dependent default.
4108
4109 @item -falign-labels
4110 @itemx -falign-labels=@var{n}
4111 @opindex falign-labels
4112 Align all branch targets to a power-of-two boundary, skipping up to
4113 @var{n} bytes like @option{-falign-functions}.  This option can easily
4114 make code slower, because it must insert dummy operations for when the
4115 branch target is reached in the usual flow of the code.
4116
4117 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4118 are greater than this value, then their values are used instead.
4119
4120 If @var{n} is not specified, use a machine-dependent default which is
4121 very likely to be @samp{1}, meaning no alignment.
4122
4123 @item -falign-loops
4124 @itemx -falign-loops=@var{n}
4125 @opindex falign-loops
4126 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4127 like @option{-falign-functions}.  The hope is that the loop will be
4128 executed many times, which will make up for any execution of the dummy
4129 operations.
4130
4131 If @var{n} is not specified, use a machine-dependent default.
4132
4133 @item -falign-jumps
4134 @itemx -falign-jumps=@var{n}
4135 @opindex falign-jumps
4136 Align branch targets to a power-of-two boundary, for branch targets
4137 where the targets can only be reached by jumping, skipping up to @var{n}
4138 bytes like @option{-falign-functions}.  In this case, no dummy operations
4139 need be executed.
4140
4141 If @var{n} is not specified, use a machine-dependent default.
4142
4143 @item -fssa
4144 @opindex fssa
4145 Perform optimizations in static single assignment form.  Each function's
4146 flow graph is translated into SSA form, optimizations are performed, and
4147 the flow graph is translated back from SSA form.  Users should not
4148 specify this option, since it is not yet ready for production use.
4149
4150 @item -fssa-ccp
4151 @opindex fssa-ccp
4152 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4153 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4154
4155 @item -fssa-dce
4156 @opindex fssa-dce
4157 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4158 Like @option{-fssa}, this is an experimental feature.
4159
4160 @item -fsingle-precision-constant
4161 @opindex fsingle-precision-constant
4162 Treat floating point constant as single precision constant instead of
4163 implicitly converting it to double precision constant.
4164
4165 @item -frename-registers
4166 @opindex frename-registers
4167 Attempt to avoid false dependencies in scheduled code by making use
4168 of registers left over after register allocation.  This optimization
4169 will most benefit processors with lots of registers.  It can, however,
4170 make debugging impossible, since variables will no longer stay in
4171 a ``home register''.
4172
4173 @item -fno-cprop-registers
4174 @opindex fno-cprop-registers
4175 After register allocation and post-register allocation instruction splitting,
4176 we perform a copy-propagation pass to try to reduce scheduling dependencies
4177 and occasionally eliminate the copy.
4178
4179 @item --param @var{name}=@var{value}
4180 @opindex param
4181 In some places, GCC uses various constants to control the amount of
4182 optimization that is done.  For example, GCC will not inline functions
4183 that contain more that a certain number of instructions.  You can
4184 control some of these constants on the command-line using the
4185 @option{--param} option.
4186
4187 In each case, the @var{value} is an integer.  The allowable choices for
4188 @var{name} are given in the following table:
4189
4190 @table @gcctabopt
4191 @item max-delay-slot-insn-search
4192 The maximum number of instructions to consider when looking for an
4193 instruction to fill a delay slot.  If more than this arbitrary number of
4194 instructions is searched, the time savings from filling the delay slot
4195 will be minimal so stop searching.  Increasing values mean more
4196 aggressive optimization, making the compile time increase with probably
4197 small improvement in executable run time.
4198
4199 @item max-delay-slot-live-search
4200 When trying to fill delay slots, the maximum number of instructions to
4201 consider when searching for a block with valid live register
4202 information.  Increasing this arbitrarily chosen value means more
4203 aggressive optimization, increasing the compile time.  This parameter
4204 should be removed when the delay slot code is rewritten to maintain the
4205 control-flow graph.
4206
4207 @item max-gcse-memory
4208 The approximate maximum amount of memory that will be allocated in
4209 order to perform the global common subexpression elimination
4210 optimization.  If more memory than specified is required, the
4211 optimization will not be done.
4212
4213 @item max-gcse-passes
4214 The maximum number of passes of GCSE to run.
4215
4216 @item max-pending-list-length
4217 The maximum number of pending dependencies scheduling will allow
4218 before flushing the current state and starting over.  Large functions
4219 with few branches or calls can create excessively large lists which
4220 needlessly consume memory and resources.
4221
4222 @item max-inline-insns
4223 If an function contains more than this many instructions, it
4224 will not be inlined.  This option is precisely equivalent to
4225 @option{-finline-limit}.
4226
4227 @item max-unrolled-insns
4228 The maximum number of instructions that a loop should have if that loop
4229 is unrolled, and if the loop is unrolled, it determines how many times
4230 the loop code is unrolled.
4231
4232 @item hot-bb-count-fraction
4233 Select fraction of the maximal count of repetitions of basic block in program
4234 given basic block needs to have to be considered hot.
4235
4236 @item hot-bb-frequency-fraction
4237 Select fraction of the maximal frequency of executions of basic block in
4238 function given basic block needs to have to be considered hot
4239
4240 @item tracer-dynamic-coverage
4241 @itemx tracer-dynamic-coverage-feedback
4242
4243 This value is used to limit superblock formation once the given percentage of
4244 executed instructions is covered.  This limits unnecessary code size
4245 expansion.
4246
4247 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4248 feedback is available.  The real profiles (as opposed to statically estimated
4249 ones) are much less balanced allowing the threshold to be larger value.
4250
4251 @item tracer-max-code-growth
4252 Stop tail duplication once code growth has reached given percentage.  This is
4253 rather hokey argument, as most of the duplicates will be eliminated later in
4254 cross jumping, so it may be set to much higher values than is the desired code
4255 growth.
4256
4257 @item tracer-min-branch-ratio
4258
4259 Stop reverse growth when the reverse probability of best edge is less than this
4260 threshold (in percent).
4261
4262 @item tracer-min-branch-ratio
4263 @itemx tracer-min-branch-ratio-feedback
4264
4265 Stop forward growth if the best edge do have probability lower than this
4266 threshold.
4267
4268 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4269 compilation for profile feedback and one for compilation without.  The value
4270 for compilation with profile feedback needs to be more conservative (higher) in
4271 order to make tracer effective.
4272
4273 @item ggc-min-expand
4274
4275 GCC uses a garbage collector to manage its own memory allocation.  This
4276 parameter specifies the minimum percentage by which the garbage
4277 collector's heap should be allowed to expand between collections.
4278 Tuning this may improve compilation speed; it has no effect on code
4279 generation.
4280
4281 The default is 30%.  Setting this parameter and
4282 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4283 every opportunity.  This is extremely slow, but can be useful for
4284 debugging.
4285
4286 @item ggc-min-heapsize
4287
4288 Minimum size of the garbage collector's heap before it begins bothering
4289 to collect garbage.  The first collection occurs after the heap expands
4290 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4291 tuning this may improve compilation speed, and has no effect on code
4292 generation.
4293
4294 The default is 4096 (four megabytes).  Setting this parameter very large
4295 effectively disables garbage collection.  Setting this parameter and
4296 @option{ggc-min-expand} to zero causes a full collection to occur at
4297 every opportunity.  
4298
4299 @end table
4300 @end table
4301
4302 @node Preprocessor Options
4303 @section Options Controlling the Preprocessor
4304 @cindex preprocessor options
4305 @cindex options, preprocessor
4306
4307 These options control the C preprocessor, which is run on each C source
4308 file before actual compilation.
4309
4310 If you use the @option{-E} option, nothing is done except preprocessing.
4311 Some of these options make sense only together with @option{-E} because
4312 they cause the preprocessor output to be unsuitable for actual
4313 compilation.
4314
4315 @table @gcctabopt
4316 @opindex Wp
4317 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4318 and pass @var{option} directly through to the preprocessor.  If
4319 @var{option} contains commas, it is split into multiple options at the
4320 commas.  However, many options are modified, translated or interpreted
4321 by the compiler driver before being passed to the preprocessor, and
4322 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4323 interface is undocumented and subject to change, so whenever possible
4324 you should avoid using @option{-Wp} and let the driver handle the
4325 options instead.
4326
4327 @item -Xpreprocessor @var{option}
4328 @opindex preprocessor
4329 Pass @var{option} as an option to the preprocessor.  You can use this to
4330 supply system-specific preprocessor options which GCC does not know how to
4331 recognize.
4332
4333 If you want to pass an option that takes an argument, you must use
4334 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4335 @end table
4336
4337 @include cppopts.texi
4338
4339 @node Assembler Options
4340 @section Passing Options to the Assembler
4341
4342 @c prevent bad page break with this line
4343 You can pass options to the assembler.
4344
4345 @table @gcctabopt
4346 @item -Wa,@var{option}
4347 @opindex Wa
4348 Pass @var{option} as an option to the assembler.  If @var{option}
4349 contains commas, it is split into multiple options at the commas.
4350
4351 @item -Xassembler @var{option}
4352 @opindex Xassembler
4353 Pass @var{option} as an option to the assembler.  You can use this to
4354 supply system-specific assembler options which GCC does not know how to
4355 recognize.
4356
4357 If you want to pass an option that takes an argument, you must use
4358 @option{-Xassembler} twice, once for the option and once for the argument.
4359
4360 @end table
4361
4362 @node Link Options
4363 @section Options for Linking
4364 @cindex link options
4365 @cindex options, linking
4366
4367 These options come into play when the compiler links object files into
4368 an executable output file.  They are meaningless if the compiler is
4369 not doing a link step.
4370
4371 @table @gcctabopt
4372 @cindex file names
4373 @item @var{object-file-name}
4374 A file name that does not end in a special recognized suffix is
4375 considered to name an object file or library.  (Object files are
4376 distinguished from libraries by the linker according to the file
4377 contents.)  If linking is done, these object files are used as input
4378 to the linker.
4379
4380 @item -c
4381 @itemx -S
4382 @itemx -E
4383 @opindex c
4384 @opindex S
4385 @opindex E
4386 If any of these options is used, then the linker is not run, and
4387 object file names should not be used as arguments.  @xref{Overall
4388 Options}.
4389
4390 @cindex Libraries
4391 @item -l@var{library}
4392 @itemx -l @var{library}
4393 @opindex l
4394 Search the library named @var{library} when linking.  (The second
4395 alternative with the library as a separate argument is only for
4396 POSIX compliance and is not recommended.)
4397
4398 It makes a difference where in the command you write this option; the
4399 linker searches and processes libraries and object files in the order they
4400 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4401 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4402 to functions in @samp{z}, those functions may not be loaded.
4403
4404 The linker searches a standard list of directories for the library,
4405 which is actually a file named @file{lib@var{library}.a}.  The linker
4406 then uses this file as if it had been specified precisely by name.
4407
4408 The directories searched include several standard system directories
4409 plus any that you specify with @option{-L}.
4410
4411 Normally the files found this way are library files---archive files
4412 whose members are object files.  The linker handles an archive file by
4413 scanning through it for members which define symbols that have so far
4414 been referenced but not defined.  But if the file that is found is an
4415 ordinary object file, it is linked in the usual fashion.  The only
4416 difference between using an @option{-l} option and specifying a file name
4417 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4418 and searches several directories.
4419
4420 @item -lobjc
4421 @opindex lobjc
4422 You need this special case of the @option{-l} option in order to
4423 link an Objective-C program.
4424
4425 @item -nostartfiles
4426 @opindex nostartfiles
4427 Do not use the standard system startup files when linking.
4428 The standard system libraries are used normally, unless @option{-nostdlib}
4429 or @option{-nodefaultlibs} is used.
4430
4431 @item -nodefaultlibs
4432 @opindex nodefaultlibs
4433 Do not use the standard system libraries when linking.
4434 Only the libraries you specify will be passed to the linker.
4435 The standard startup files are used normally, unless @option{-nostartfiles}
4436 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4437 for System V (and ISO C) environments or to bcopy and bzero for
4438 BSD environments.  These entries are usually resolved by entries in
4439 libc.  These entry points should be supplied through some other
4440 mechanism when this option is specified.
4441
4442 @item -nostdlib
4443 @opindex nostdlib
4444 Do not use the standard system startup files or libraries when linking.
4445 No startup files and only the libraries you specify will be passed to
4446 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4447 for System V (and ISO C) environments or to bcopy and bzero for
4448 BSD environments.  These entries are usually resolved by entries in
4449 libc.  These entry points should be supplied through some other
4450 mechanism when this option is specified.
4451
4452 @cindex @option{-lgcc}, use with @option{-nostdlib}
4453 @cindex @option{-nostdlib} and unresolved references
4454 @cindex unresolved references and @option{-nostdlib}
4455 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4456 @cindex @option{-nodefaultlibs} and unresolved references
4457 @cindex unresolved references and @option{-nodefaultlibs}
4458 One of the standard libraries bypassed by @option{-nostdlib} and
4459 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4460 that GCC uses to overcome shortcomings of particular machines, or special
4461 needs for some languages.
4462 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4463 Collection (GCC) Internals},
4464 for more discussion of @file{libgcc.a}.)
4465 In most cases, you need @file{libgcc.a} even when you want to avoid
4466 other standard libraries.  In other words, when you specify @option{-nostdlib}
4467 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4468 This ensures that you have no unresolved references to internal GCC
4469 library subroutines.  (For example, @samp{__main}, used to ensure C++
4470 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4471 GNU Compiler Collection (GCC) Internals}.)
4472
4473 @item -s
4474 @opindex s
4475 Remove all symbol table and relocation information from the executable.
4476
4477 @item -static
4478 @opindex static
4479 On systems that support dynamic linking, this prevents linking with the shared
4480 libraries.  On other systems, this option has no effect.
4481
4482 @item -shared
4483 @opindex shared
4484 Produce a shared object which can then be linked with other objects to
4485 form an executable.  Not all systems support this option.  For predictable
4486 results, you must also specify the same set of options that were used to
4487 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4488 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4489 needs to build supplementary stub code for constructors to work.  On
4490 multi-libbed systems, @samp{gcc -shared} must select the correct support
4491 libraries to link against.  Failing to supply the correct flags may lead
4492 to subtle defects.  Supplying them in cases where they are not necessary
4493 is innocuous.}
4494
4495 @item -shared-libgcc
4496 @itemx -static-libgcc
4497 @opindex shared-libgcc
4498 @opindex static-libgcc
4499 On systems that provide @file{libgcc} as a shared library, these options
4500 force the use of either the shared or static version respectively.
4501 If no shared version of @file{libgcc} was built when the compiler was
4502 configured, these options have no effect.
4503
4504 There are several situations in which an application should use the
4505 shared @file{libgcc} instead of the static version.  The most common
4506 of these is when the application wishes to throw and catch exceptions
4507 across different shared libraries.  In that case, each of the libraries
4508 as well as the application itself should use the shared @file{libgcc}.
4509
4510 Therefore, the G++ and GCJ drivers automatically add
4511 @option{-shared-libgcc} whenever you build a shared library or a main
4512 executable, because C++ and Java programs typically use exceptions, so
4513 this is the right thing to do.
4514
4515 If, instead, you use the GCC driver to create shared libraries, you may
4516 find that they will not always be linked with the shared @file{libgcc}.
4517 If GCC finds, at its configuration time, that you have a GNU linker that
4518 does not support option @option{--eh-frame-hdr}, it will link the shared
4519 version of @file{libgcc} into shared libraries by default.  Otherwise,
4520 it will take advantage of the linker and optimize away the linking with
4521 the shared version of @file{libgcc}, linking with the static version of
4522 libgcc by default.  This allows exceptions to propagate through such
4523 shared libraries, without incurring relocation costs at library load
4524 time.
4525
4526 However, if a library or main executable is supposed to throw or catch
4527 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4528 for the languages used in the program, or using the option
4529 @option{-shared-libgcc}, such that it is linked with the shared
4530 @file{libgcc}.
4531
4532 @item -symbolic
4533 @opindex symbolic
4534 Bind references to global symbols when building a shared object.  Warn
4535 about any unresolved references (unless overridden by the link editor
4536 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4537 this option.
4538
4539 @item -Xlinker @var{option}
4540 @opindex Xlinker
4541 Pass @var{option} as an option to the linker.  You can use this to
4542 supply system-specific linker options which GCC does not know how to
4543 recognize.
4544
4545 If you want to pass an option that takes an argument, you must use
4546 @option{-Xlinker} twice, once for the option and once for the argument.
4547 For example, to pass @option{-assert definitions}, you must write
4548 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4549 @option{-Xlinker "-assert definitions"}, because this passes the entire
4550 string as a single argument, which is not what the linker expects.
4551
4552 @item -Wl,@var{option}
4553 @opindex Wl
4554 Pass @var{option} as an option to the linker.  If @var{option} contains
4555 commas, it is split into multiple options at the commas.
4556
4557 @item -u @var{symbol}
4558 @opindex u
4559 Pretend the symbol @var{symbol} is undefined, to force linking of
4560 library modules to define it.  You can use @option{-u} multiple times with
4561 different symbols to force loading of additional library modules.
4562 @end table
4563
4564 @node Directory Options
4565 @section Options for Directory Search
4566 @cindex directory options
4567 @cindex options, directory search
4568 @cindex search path
4569
4570 These options specify directories to search for header files, for
4571 libraries and for parts of the compiler:
4572
4573 @table @gcctabopt
4574 @item -I@var{dir}
4575 @opindex I
4576 Add the directory @var{dir} to the head of the list of directories to be
4577 searched for header files.  This can be used to override a system header
4578 file, substituting your own version, since these directories are
4579 searched before the system header file directories.  However, you should
4580 not use this option to add directories that contain vendor-supplied
4581 system header files (use @option{-isystem} for that).  If you use more than
4582 one @option{-I} option, the directories are scanned in left-to-right
4583 order; the standard system directories come after.
4584
4585 If a standard system include directory, or a directory specified with
4586 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4587 option will be ignored.  The directory will still be searched but as a
4588 system directory at its normal position in the system include chain.
4589 This is to ensure that GCC's procedure to fix buggy system headers and
4590 the ordering for the include_next directive are not inadvertently changed.
4591 If you really need to change the search order for system directories,
4592 use the @option{-nostdinc} and/or @option{-isystem} options.
4593
4594 @item -I-
4595 @opindex I-
4596 Any directories you specify with @option{-I} options before the @option{-I-}
4597 option are searched only for the case of @samp{#include "@var{file}"};
4598 they are not searched for @samp{#include <@var{file}>}.
4599
4600 If additional directories are specified with @option{-I} options after
4601 the @option{-I-}, these directories are searched for all @samp{#include}
4602 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4603 this way.)
4604
4605 In addition, the @option{-I-} option inhibits the use of the current
4606 directory (where the current input file came from) as the first search
4607 directory for @samp{#include "@var{file}"}.  There is no way to
4608 override this effect of @option{-I-}.  With @option{-I.} you can specify
4609 searching the directory which was current when the compiler was
4610 invoked.  That is not exactly the same as what the preprocessor does
4611 by default, but it is often satisfactory.
4612
4613 @option{-I-} does not inhibit the use of the standard system directories
4614 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4615 independent.
4616
4617 @item -L@var{dir}
4618 @opindex L
4619 Add directory @var{dir} to the list of directories to be searched
4620 for @option{-l}.
4621
4622 @item -B@var{prefix}
4623 @opindex B
4624 This option specifies where to find the executables, libraries,
4625 include files, and data files of the compiler itself.
4626
4627 The compiler driver program runs one or more of the subprograms
4628 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4629 @var{prefix} as a prefix for each program it tries to run, both with and
4630 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4631
4632 For each subprogram to be run, the compiler driver first tries the
4633 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4634 was not specified, the driver tries two standard prefixes, which are
4635 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4636 those results in a file name that is found, the unmodified program
4637 name is searched for using the directories specified in your
4638 @env{PATH} environment variable.
4639
4640 The compiler will check to see if the path provided by the @option{-B}
4641 refers to a directory, and if necessary it will add a directory
4642 separator character at the end of the path.
4643
4644 @option{-B} prefixes that effectively specify directory names also apply
4645 to libraries in the linker, because the compiler translates these
4646 options into @option{-L} options for the linker.  They also apply to
4647 includes files in the preprocessor, because the compiler translates these
4648 options into @option{-isystem} options for the preprocessor.  In this case,
4649 the compiler appends @samp{include} to the prefix.
4650
4651 The run-time support file @file{libgcc.a} can also be searched for using
4652 the @option{-B} prefix, if needed.  If it is not found there, the two
4653 standard prefixes above are tried, and that is all.  The file is left
4654 out of the link if it is not found by those means.
4655
4656 Another way to specify a prefix much like the @option{-B} prefix is to use
4657 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4658 Variables}.
4659
4660 As a special kludge, if the path provided by @option{-B} is
4661 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4662 9, then it will be replaced by @file{[dir/]include}.  This is to help
4663 with boot-strapping the compiler.
4664
4665 @item -specs=@var{file}
4666 @opindex specs
4667 Process @var{file} after the compiler reads in the standard @file{specs}
4668 file, in order to override the defaults that the @file{gcc} driver
4669 program uses when determining what switches to pass to @file{cc1},
4670 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4671 @option{-specs=@var{file}} can be specified on the command line, and they
4672 are processed in order, from left to right.
4673 @end table
4674
4675 @c man end
4676
4677 @node Spec Files
4678 @section Specifying subprocesses and the switches to pass to them
4679 @cindex Spec Files
4680 @command{gcc} is a driver program.  It performs its job by invoking a
4681 sequence of other programs to do the work of compiling, assembling and
4682 linking.  GCC interprets its command-line parameters and uses these to
4683 deduce which programs it should invoke, and which command-line options
4684 it ought to place on their command lines.  This behavior is controlled
4685 by @dfn{spec strings}.  In most cases there is one spec string for each
4686 program that GCC can invoke, but a few programs have multiple spec
4687 strings to control their behavior.  The spec strings built into GCC can
4688 be overridden by using the @option{-specs=} command-line switch to specify
4689 a spec file.
4690
4691 @dfn{Spec files} are plaintext files that are used to construct spec
4692 strings.  They consist of a sequence of directives separated by blank
4693 lines.  The type of directive is determined by the first non-whitespace
4694 character on the line and it can be one of the following:
4695
4696 @table @code
4697 @item %@var{command}
4698 Issues a @var{command} to the spec file processor.  The commands that can
4699 appear here are:
4700
4701 @table @code
4702 @item %include <@var{file}>
4703 @cindex %include
4704 Search for @var{file} and insert its text at the current point in the
4705 specs file.
4706
4707 @item %include_noerr <@var{file}>
4708 @cindex %include_noerr
4709 Just like @samp{%include}, but do not generate an error message if the include
4710 file cannot be found.
4711
4712 @item %rename @var{old_name} @var{new_name}
4713 @cindex %rename
4714 Rename the spec string @var{old_name} to @var{new_name}.
4715
4716 @end table
4717
4718 @item *[@var{spec_name}]:
4719 This tells the compiler to create, override or delete the named spec
4720 string.  All lines after this directive up to the next directive or
4721 blank line are considered to be the text for the spec string.  If this
4722 results in an empty string then the spec will be deleted.  (Or, if the
4723 spec did not exist, then nothing will happened.)  Otherwise, if the spec
4724 does not currently exist a new spec will be created.  If the spec does
4725 exist then its contents will be overridden by the text of this
4726 directive, unless the first character of that text is the @samp{+}
4727 character, in which case the text will be appended to the spec.
4728
4729 @item [@var{suffix}]:
4730 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
4731 and up to the next directive or blank line are considered to make up the
4732 spec string for the indicated suffix.  When the compiler encounters an
4733 input file with the named suffix, it will processes the spec string in
4734 order to work out how to compile that file.  For example:
4735
4736 @smallexample
4737 .ZZ:
4738 z-compile -input %i
4739 @end smallexample
4740
4741 This says that any input file whose name ends in @samp{.ZZ} should be
4742 passed to the program @samp{z-compile}, which should be invoked with the
4743 command-line switch @option{-input} and with the result of performing the
4744 @samp{%i} substitution.  (See below.)
4745
4746 As an alternative to providing a spec string, the text that follows a
4747 suffix directive can be one of the following:
4748
4749 @table @code
4750 @item @@@var{language}
4751 This says that the suffix is an alias for a known @var{language}.  This is
4752 similar to using the @option{-x} command-line switch to GCC to specify a
4753 language explicitly.  For example:
4754
4755 @smallexample
4756 .ZZ:
4757 @@c++
4758 @end smallexample
4759
4760 Says that .ZZ files are, in fact, C++ source files.
4761
4762 @item #@var{name}
4763 This causes an error messages saying:
4764
4765 @smallexample
4766 @var{name} compiler not installed on this system.
4767 @end smallexample
4768 @end table
4769
4770 GCC already has an extensive list of suffixes built into it.
4771 This directive will add an entry to the end of the list of suffixes, but
4772 since the list is searched from the end backwards, it is effectively
4773 possible to override earlier entries using this technique.
4774
4775 @end table
4776
4777 GCC has the following spec strings built into it.  Spec files can
4778 override these strings or create their own.  Note that individual
4779 targets can also add their own spec strings to this list.
4780
4781 @smallexample
4782 asm          Options to pass to the assembler
4783 asm_final    Options to pass to the assembler post-processor
4784 cpp          Options to pass to the C preprocessor
4785 cc1          Options to pass to the C compiler
4786 cc1plus      Options to pass to the C++ compiler
4787 endfile      Object files to include at the end of the link
4788 link         Options to pass to the linker
4789 lib          Libraries to include on the command line to the linker
4790 libgcc       Decides which GCC support library to pass to the linker
4791 linker       Sets the name of the linker
4792 predefines   Defines to be passed to the C preprocessor
4793 signed_char  Defines to pass to CPP to say whether @code{char} is signed
4794              by default
4795 startfile    Object files to include at the start of the link
4796 @end smallexample
4797
4798 Here is a small example of a spec file:
4799
4800 @smallexample
4801 %rename lib                 old_lib
4802
4803 *lib:
4804 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
4805 @end smallexample
4806
4807 This example renames the spec called @samp{lib} to @samp{old_lib} and
4808 then overrides the previous definition of @samp{lib} with a new one.
4809 The new definition adds in some extra command-line options before
4810 including the text of the old definition.
4811
4812 @dfn{Spec strings} are a list of command-line options to be passed to their
4813 corresponding program.  In addition, the spec strings can contain
4814 @samp{%}-prefixed sequences to substitute variable text or to
4815 conditionally insert text into the command line.  Using these constructs
4816 it is possible to generate quite complex command lines.
4817
4818 Here is a table of all defined @samp{%}-sequences for spec
4819 strings.  Note that spaces are not generated automatically around the
4820 results of expanding these sequences.  Therefore you can concatenate them
4821 together or combine them with constant text in a single argument.
4822
4823 @table @code
4824 @item %%
4825 Substitute one @samp{%} into the program name or argument.
4826
4827 @item %i
4828 Substitute the name of the input file being processed.
4829
4830 @item %b
4831 Substitute the basename of the input file being processed.
4832 This is the substring up to (and not including) the last period
4833 and not including the directory.
4834
4835 @item %B
4836 This is the same as @samp{%b}, but include the file suffix (text after
4837 the last period).
4838
4839 @item %d
4840 Marks the argument containing or following the @samp{%d} as a
4841 temporary file name, so that that file will be deleted if GCC exits
4842 successfully.  Unlike @samp{%g}, this contributes no text to the
4843 argument.
4844
4845 @item %g@var{suffix}
4846 Substitute a file name that has suffix @var{suffix} and is chosen
4847 once per compilation, and mark the argument in the same way as
4848 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
4849 name is now chosen in a way that is hard to predict even when previously
4850 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
4851 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
4852 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4853 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
4854 was simply substituted with a file name chosen once per compilation,
4855 without regard to any appended suffix (which was therefore treated
4856 just like ordinary text), making such attacks more likely to succeed.
4857
4858 @item %u@var{suffix}
4859 Like @samp{%g}, but generates a new temporary file name even if
4860 @samp{%u@var{suffix}} was already seen.
4861
4862 @item %U@var{suffix}
4863 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4864 new one if there is no such last file name.  In the absence of any
4865 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4866 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
4867 would involve the generation of two distinct file names, one
4868 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
4869 simply substituted with a file name chosen for the previous @samp{%u},
4870 without regard to any appended suffix.
4871
4872 @item %j@var{suffix}
4873 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
4874 writable, and if save-temps is off; otherwise, substitute the name
4875 of a temporary file, just like @samp{%u}.  This temporary file is not
4876 meant for communication between processes, but rather as a junk
4877 disposal mechanism.
4878
4879 @item %|@var{suffix}
4880 @itemx %m@var{suffix}
4881 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
4882 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
4883 all.  These are the two most common ways to instruct a program that it
4884 should read from standard input or write to standard output.  If you
4885 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
4886 construct: see for example @file{f/lang-specs.h}.
4887
4888 @item %.@var{SUFFIX}
4889 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4890 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
4891 terminated by the next space or %.
4892
4893 @item %w
4894 Marks the argument containing or following the @samp{%w} as the
4895 designated output file of this compilation.  This puts the argument
4896 into the sequence of arguments that @samp{%o} will substitute later.
4897
4898 @item %o
4899 Substitutes the names of all the output files, with spaces
4900 automatically placed around them.  You should write spaces
4901 around the @samp{%o} as well or the results are undefined.
4902 @samp{%o} is for use in the specs for running the linker.
4903 Input files whose names have no recognized suffix are not compiled
4904 at all, but they are included among the output files, so they will
4905 be linked.
4906
4907 @item %O
4908 Substitutes the suffix for object files.  Note that this is
4909 handled specially when it immediately follows @samp{%g, %u, or %U},
4910 because of the need for those to form complete file names.  The
4911 handling is such that @samp{%O} is treated exactly as if it had already
4912 been substituted, except that @samp{%g, %u, and %U} do not currently
4913 support additional @var{suffix} characters following @samp{%O} as they would
4914 following, for example, @samp{.o}.
4915
4916 @item %p
4917 Substitutes the standard macro predefinitions for the
4918 current target machine.  Use this when running @code{cpp}.
4919
4920 @item %P
4921 Like @samp{%p}, but puts @samp{__} before and after the name of each
4922 predefined macro, except for macros that start with @samp{__} or with
4923 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
4924 C@.
4925
4926 @item %I
4927 Substitute a @option{-iprefix} option made from @env{GCC_EXEC_PREFIX}.
4928
4929 @item %s
4930 Current argument is the name of a library or startup file of some sort.
4931 Search for that file in a standard list of directories and substitute
4932 the full name found.
4933
4934 @item %e@var{str}
4935 Print @var{str} as an error message.  @var{str} is terminated by a newline.
4936 Use this when inconsistent options are detected.
4937
4938 @item %(@var{name})
4939 Substitute the contents of spec string @var{name} at this point.
4940
4941 @item %[@var{name}]
4942 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
4943
4944 @item %x@{@var{option}@}
4945 Accumulate an option for @samp{%X}.
4946
4947 @item %X
4948 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
4949 spec string.
4950
4951 @item %Y
4952 Output the accumulated assembler options specified by @option{-Wa}.
4953
4954 @item %Z
4955 Output the accumulated preprocessor options specified by @option{-Wp}.
4956
4957 @item %v1
4958 Substitute the major version number of GCC@.
4959 (For version 2.9.5, this is 2.)
4960
4961 @item %v2
4962 Substitute the minor version number of GCC@.
4963 (For version 2.9.5, this is 9.)
4964
4965 @item %v3
4966 Substitute the patch level number of GCC@.
4967 (For version 2.9.5, this is 5.)
4968
4969 @item %a
4970 Process the @code{asm} spec.  This is used to compute the
4971 switches to be passed to the assembler.
4972
4973 @item %A
4974 Process the @code{asm_final} spec.  This is a spec string for
4975 passing switches to an assembler post-processor, if such a program is
4976 needed.
4977
4978 @item %l
4979 Process the @code{link} spec.  This is the spec for computing the
4980 command line passed to the linker.  Typically it will make use of the
4981 @samp{%L %G %S %D and %E} sequences.
4982
4983 @item %D
4984 Dump out a @option{-L} option for each directory that GCC believes might
4985 contain startup files.  If the target supports multilibs then the
4986 current multilib directory will be prepended to each of these paths.
4987
4988 @item %M
4989 Output the multilib directory with directory separators replaced with
4990 @samp{_}.  If multilib directories are not set, or the multilib directory is
4991 @file{.} then this option emits nothing.
4992
4993 @item %L
4994 Process the @code{lib} spec.  This is a spec string for deciding which
4995 libraries should be included on the command line to the linker.
4996
4997 @item %G
4998 Process the @code{libgcc} spec.  This is a spec string for deciding
4999 which GCC support library should be included on the command line to the linker.
5000
5001 @item %S
5002 Process the @code{startfile} spec.  This is a spec for deciding which
5003 object files should be the first ones passed to the linker.  Typically
5004 this might be a file named @file{crt0.o}.
5005
5006 @item %E
5007 Process the @code{endfile} spec.  This is a spec string that specifies
5008 the last object files that will be passed to the linker.
5009
5010 @item %C
5011 Process the @code{cpp} spec.  This is used to construct the arguments
5012 to be passed to the C preprocessor.
5013
5014 @item %c
5015 Process the @code{signed_char} spec.  This is intended to be used
5016 to tell cpp whether a char is signed.  It typically has the definition:
5017 @smallexample
5018 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5019 @end smallexample
5020
5021 @item %1
5022 Process the @code{cc1} spec.  This is used to construct the options to be
5023 passed to the actual C compiler (@samp{cc1}).
5024
5025 @item %2
5026 Process the @code{cc1plus} spec.  This is used to construct the options to be
5027 passed to the actual C++ compiler (@samp{cc1plus}).
5028
5029 @item %*
5030 Substitute the variable part of a matched option.  See below.
5031 Note that each comma in the substituted string is replaced by
5032 a single space.
5033
5034 @item %<@code{S}
5035 Remove all occurrences of @code{-S} from the command line.  Note---this
5036 command is position dependent.  @samp{%} commands in the spec string
5037 before this one will see @code{-S}, @samp{%} commands in the spec string
5038 after this one will not.
5039
5040 @item %:@var{function}(@var{args})
5041 Call the named function @var{function}, passing it @var{args}.
5042 @var{args} is first processed as a nested spec string, then split
5043 into an argument vector in the usual fashion.  The function returns
5044 a string which is processed as if it had appeared literally as part
5045 of the current spec.
5046
5047 The following built-in spec functions are provided:
5048
5049 @table @code
5050 @item @code{if-exists}
5051 The @code{if-exists} spec function takes one argument, an absolute
5052 pathname to a file.  If the file exists, @code{if-exists} returns the
5053 pathname.  Here is a small example of its usage:
5054
5055 @smallexample
5056 *startfile:
5057 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5058 @end smallexample
5059
5060 @item @code{if-exists-else}
5061 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5062 spec function, except that it takes two arguments.  The first argument is
5063 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5064 returns the pathname.  If it does not exist, it returns the second argument.
5065 This way, @code{if-exists-else} can be used to select one file or another,
5066 based on the existence of the first.  Here is a small example of its usage:
5067
5068 @smallexample 
5069 *startfile:
5070 crt0%O%s %:if-exists(crti%O%s) %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5071 @end smallexample
5072 @end table 
5073
5074 @item %@{@code{S}@}
5075 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5076 If that switch was not specified, this substitutes nothing.  Note that
5077 the leading dash is omitted when specifying this option, and it is
5078 automatically inserted if the substitution is performed.  Thus the spec
5079 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5080 and would output the command line option @option{-foo}.
5081
5082 @item %W@{@code{S}@}
5083 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5084 deleted on failure.
5085
5086 @item %@{@code{S}*@}
5087 Substitutes all the switches specified to GCC whose names start
5088 with @code{-S}, but which also take an argument.  This is used for
5089 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5090 GCC considers @option{-o foo} as being
5091 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5092 text, including the space.  Thus two arguments would be generated.
5093
5094 @item %@{@code{S}*&@code{T}*@}
5095 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5096 (the order of @code{S} and @code{T} in the spec is not significant).
5097 There can be any number of ampersand-separated variables; for each the
5098 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5099
5100 @item %@{@code{S}:@code{X}@}
5101 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5102
5103 @item %@{!@code{S}:@code{X}@}
5104 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5105
5106 @item %@{@code{S}*:@code{X}@}
5107 Substitutes @code{X} if one or more switches whose names start with
5108 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5109 once, no matter how many such switches appeared.  However, if @code{%*}
5110 appears somewhere in @code{X}, then @code{X} will be substituted once
5111 for each matching switch, with the @code{%*} replaced by the part of
5112 that switch that matched the @code{*}.
5113
5114 @item %@{.@code{S}:@code{X}@}
5115 Substitutes @code{X}, if processing a file with suffix @code{S}.
5116
5117 @item %@{!.@code{S}:@code{X}@}
5118 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5119
5120 @item %@{@code{S}|@code{P}:@code{X}@}
5121 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5122 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5123 although they have a stronger binding than the @samp{|}.  If @code{%*}
5124 appears in @code{X}, all of the alternatives must be starred, and only
5125 the first matching alternative is substituted.
5126
5127 For example, a spec string like this:
5128
5129 @smallexample
5130 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5131 @end smallexample
5132
5133 will output the following command-line options from the following input
5134 command-line options:
5135
5136 @smallexample
5137 fred.c        -foo -baz
5138 jim.d         -bar -boggle
5139 -d fred.c     -foo -baz -boggle
5140 -d jim.d      -bar -baz -boggle
5141 @end smallexample
5142
5143 @item %@{S:X; T:Y; :D@}
5144
5145 If @code{S} was given to GCC, substitues @code{X}; else if @code{T} was
5146 given to GCC, substitues @code{Y}; else substitutes @code{D}.  There can
5147 be as many clauses as you need.  This may be combined with @code{.}, 
5148 @code{!}, @code{|}, and @code{*} as needed.
5149
5150
5151 @end table
5152
5153 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5154 construct may contain other nested @samp{%} constructs or spaces, or
5155 even newlines.  They are processed as usual, as described above.
5156 Trailing white space in @code{X} is ignored.  White space may also
5157 appear anywhere on the left side of the colon in these constructs,
5158 except between @code{.} or @code{*} and the corresponding word.
5159
5160 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5161 handled specifically in these constructs.  If another value of
5162 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5163 @option{-W} switch is found later in the command line, the earlier
5164 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5165 just one letter, which passes all matching options.
5166
5167 The character @samp{|} at the beginning of the predicate text is used to
5168 indicate that a command should be piped to the following command, but
5169 only if @option{-pipe} is specified.
5170
5171 It is built into GCC which switches take arguments and which do not.
5172 (You might think it would be useful to generalize this to allow each
5173 compiler's spec to say which switches take arguments.  But this cannot
5174 be done in a consistent fashion.  GCC cannot even decide which input
5175 files have been specified without knowing which switches take arguments,
5176 and it must know which input files to compile in order to tell which
5177 compilers to run).
5178
5179 GCC also knows implicitly that arguments starting in @option{-l} are to be
5180 treated as compiler output files, and passed to the linker in their
5181 proper position among the other output files.
5182
5183 @c man begin OPTIONS
5184
5185 @node Target Options
5186 @section Specifying Target Machine and Compiler Version
5187 @cindex target options
5188 @cindex cross compiling
5189 @cindex specifying machine version
5190 @cindex specifying compiler version and target machine
5191 @cindex compiler version, specifying
5192 @cindex target machine, specifying
5193
5194 The usual way to run GCC is to run the executable called @file{gcc}, or
5195 @file{<machine>-gcc} when cross-compiling, or
5196 @file{<machine>-gcc-<version>} to run a version other than the one that
5197 was installed last.  Sometimes this is inconvenient, so GCC provides
5198 options that will switch to another cross-compiler or version.
5199
5200 @table @gcctabopt
5201 @item -b @var{machine}
5202 @opindex b
5203 The argument @var{machine} specifies the target machine for compilation.
5204
5205 The value to use for @var{machine} is the same as was specified as the
5206 machine type when configuring GCC as a cross-compiler.  For
5207 example, if a cross-compiler was configured with @samp{configure
5208 i386v}, meaning to compile for an 80386 running System V, then you
5209 would specify @option{-b i386v} to run that cross compiler.
5210
5211 @item -V @var{version}
5212 @opindex V
5213 The argument @var{version} specifies which version of GCC to run.
5214 This is useful when multiple versions are installed.  For example,
5215 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5216 @end table
5217
5218 The @option{-V} and @option{-b} options work by running the
5219 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5220 use them if you can just run that directly.
5221
5222 @node Submodel Options
5223 @section Hardware Models and Configurations
5224 @cindex submodel options
5225 @cindex specifying hardware config
5226 @cindex hardware models and configurations, specifying
5227 @cindex machine dependent options
5228
5229 Earlier we discussed the standard option @option{-b} which chooses among
5230 different installed compilers for completely different target
5231 machines, such as VAX vs.@: 68000 vs.@: 80386.
5232
5233 In addition, each of these target machine types can have its own
5234 special options, starting with @samp{-m}, to choose among various
5235 hardware models or configurations---for example, 68010 vs 68020,
5236 floating coprocessor or none.  A single installed version of the
5237 compiler can compile for any model or configuration, according to the
5238 options specified.
5239
5240 Some configurations of the compiler also support additional special
5241 options, usually for compatibility with other compilers on the same
5242 platform.
5243
5244 These options are defined by the macro @code{TARGET_SWITCHES} in the
5245 machine description.  The default for the options is also defined by
5246 that macro, which enables you to change the defaults.
5247
5248 @menu
5249 * M680x0 Options::
5250 * M68hc1x Options::
5251 * VAX Options::
5252 * SPARC Options::
5253 * Convex Options::
5254 * AMD29K Options::
5255 * ARM Options::
5256 * MN10200 Options::
5257 * MN10300 Options::
5258 * M32R/D Options::
5259 * M88K Options::
5260 * RS/6000 and PowerPC Options::
5261 * Darwin Options::
5262 * RT Options::
5263 * MIPS Options::
5264 * i386 and x86-64 Options::
5265 * HPPA Options::
5266 * Intel 960 Options::
5267 * DEC Alpha Options::
5268 * DEC Alpha/VMS Options::
5269 * Clipper Options::
5270 * H8/300 Options::
5271 * SH Options::
5272 * System V Options::
5273 * TMS320C3x/C4x Options::
5274 * V850 Options::
5275 * ARC Options::
5276 * NS32K Options::
5277 * AVR Options::
5278 * MCore Options::
5279 * IA-64 Options::
5280 * D30V Options::
5281 * S/390 and zSeries Options::
5282 * CRIS Options::
5283 * MMIX Options::
5284 * PDP-11 Options::
5285 * Xstormy16 Options::
5286 * Xtensa Options::
5287 * FRV Options::
5288 @end menu
5289
5290 @node M680x0 Options
5291 @subsection M680x0 Options
5292 @cindex M680x0 options
5293
5294 These are the @samp{-m} options defined for the 68000 series.  The default
5295 values for these options depends on which style of 68000 was selected when
5296 the compiler was configured; the defaults for the most common choices are
5297 given below.
5298
5299 @table @gcctabopt
5300 @item -m68000
5301 @itemx -mc68000
5302 @opindex m68000
5303 @opindex mc68000
5304 Generate output for a 68000.  This is the default
5305 when the compiler is configured for 68000-based systems.
5306
5307 Use this option for microcontrollers with a 68000 or EC000 core,
5308 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5309
5310 @item -m68020
5311 @itemx -mc68020
5312 @opindex m68020
5313 @opindex mc68020
5314 Generate output for a 68020.  This is the default
5315 when the compiler is configured for 68020-based systems.
5316
5317 @item -m68881
5318 @opindex m68881
5319 Generate output containing 68881 instructions for floating point.
5320 This is the default for most 68020 systems unless @option{--nfp} was
5321 specified when the compiler was configured.
5322
5323 @item -m68030
5324 @opindex m68030
5325 Generate output for a 68030.  This is the default when the compiler is
5326 configured for 68030-based systems.
5327
5328 @item -m68040
5329 @opindex m68040
5330 Generate output for a 68040.  This is the default when the compiler is
5331 configured for 68040-based systems.
5332
5333 This option inhibits the use of 68881/68882 instructions that have to be
5334 emulated by software on the 68040.  Use this option if your 68040 does not
5335 have code to emulate those instructions.
5336
5337 @item -m68060
5338 @opindex m68060
5339 Generate output for a 68060.  This is the default when the compiler is
5340 configured for 68060-based systems.
5341
5342 This option inhibits the use of 68020 and 68881/68882 instructions that
5343 have to be emulated by software on the 68060.  Use this option if your 68060
5344 does not have code to emulate those instructions.
5345
5346 @item -mcpu32
5347 @opindex mcpu32
5348 Generate output for a CPU32.  This is the default
5349 when the compiler is configured for CPU32-based systems.
5350
5351 Use this option for microcontrollers with a
5352 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5353 68336, 68340, 68341, 68349 and 68360.
5354
5355 @item -m5200
5356 @opindex m5200
5357 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5358 when the compiler is configured for 520X-based systems.
5359
5360 Use this option for microcontroller with a 5200 core, including
5361 the MCF5202, MCF5203, MCF5204 and MCF5202.
5362
5363
5364 @item -m68020-40
5365 @opindex m68020-40
5366 Generate output for a 68040, without using any of the new instructions.
5367 This results in code which can run relatively efficiently on either a
5368 68020/68881 or a 68030 or a 68040.  The generated code does use the
5369 68881 instructions that are emulated on the 68040.
5370
5371 @item -m68020-60
5372 @opindex m68020-60
5373 Generate output for a 68060, without using any of the new instructions.
5374 This results in code which can run relatively efficiently on either a
5375 68020/68881 or a 68030 or a 68040.  The generated code does use the
5376 68881 instructions that are emulated on the 68060.
5377
5378 @item -mfpa
5379 @opindex mfpa
5380 Generate output containing Sun FPA instructions for floating point.
5381
5382 @item -msoft-float
5383 @opindex msoft-float
5384 Generate output containing library calls for floating point.
5385 @strong{Warning:} the requisite libraries are not available for all m68k
5386 targets.  Normally the facilities of the machine's usual C compiler are
5387 used, but this can't be done directly in cross-compilation.  You must
5388 make your own arrangements to provide suitable library functions for
5389 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5390 @samp{m68k-*-coff} do provide software floating point support.
5391
5392 @item -mshort
5393 @opindex mshort
5394 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5395
5396 @item -mnobitfield
5397 @opindex mnobitfield
5398 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5399 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5400
5401 @item -mbitfield
5402 @opindex mbitfield
5403 Do use the bit-field instructions.  The @option{-m68020} option implies
5404 @option{-mbitfield}.  This is the default if you use a configuration
5405 designed for a 68020.
5406
5407 @item -mrtd
5408 @opindex mrtd
5409 Use a different function-calling convention, in which functions
5410 that take a fixed number of arguments return with the @code{rtd}
5411 instruction, which pops their arguments while returning.  This
5412 saves one instruction in the caller since there is no need to pop
5413 the arguments there.
5414
5415 This calling convention is incompatible with the one normally
5416 used on Unix, so you cannot use it if you need to call libraries
5417 compiled with the Unix compiler.
5418
5419 Also, you must provide function prototypes for all functions that
5420 take variable numbers of arguments (including @code{printf});
5421 otherwise incorrect code will be generated for calls to those
5422 functions.
5423
5424 In addition, seriously incorrect code will result if you call a
5425 function with too many arguments.  (Normally, extra arguments are
5426 harmlessly ignored.)
5427
5428 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5429 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5430
5431 @item -malign-int
5432 @itemx -mno-align-int
5433 @opindex malign-int
5434 @opindex mno-align-int
5435 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5436 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5437 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5438 Aligning variables on 32-bit boundaries produces code that runs somewhat
5439 faster on processors with 32-bit busses at the expense of more memory.
5440
5441 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5442 align structures containing the above types  differently than
5443 most published application binary interface specifications for the m68k.
5444
5445 @item -mpcrel
5446 @opindex mpcrel
5447 Use the pc-relative addressing mode of the 68000 directly, instead of
5448 using a global offset table.  At present, this option implies @option{-fpic},
5449 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5450 not presently supported with @option{-mpcrel}, though this could be supported for
5451 68020 and higher processors.
5452
5453 @item -mno-strict-align
5454 @itemx -mstrict-align
5455 @opindex mno-strict-align
5456 @opindex mstrict-align
5457 Do not (do) assume that unaligned memory references will be handled by
5458 the system.
5459
5460 @end table
5461
5462 @node M68hc1x Options
5463 @subsection M68hc1x Options
5464 @cindex M68hc1x options
5465
5466 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5467 microcontrollers.  The default values for these options depends on
5468 which style of microcontroller was selected when the compiler was configured;
5469 the defaults for the most common choices are given below.
5470
5471 @table @gcctabopt
5472 @item -m6811
5473 @itemx -m68hc11
5474 @opindex m6811
5475 @opindex m68hc11
5476 Generate output for a 68HC11.  This is the default
5477 when the compiler is configured for 68HC11-based systems.
5478
5479 @item -m6812
5480 @itemx -m68hc12
5481 @opindex m6812
5482 @opindex m68hc12
5483 Generate output for a 68HC12.  This is the default
5484 when the compiler is configured for 68HC12-based systems.
5485
5486 @item -mauto-incdec
5487 @opindex mauto-incdec
5488 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5489 addressing modes.
5490
5491 @item -minmax
5492 @itemx -nominmax
5493 @opindex minmax
5494 @opindex mnominmax
5495 Enable the use of 68HC12 min and max instructions.
5496
5497 @item -mlong-calls
5498 @itemx -mno-long-calls
5499 @opindex mlong-calls
5500 @opindex mno-long-calls
5501 Treat all calls as being far away (near).  If calls are assumed to be
5502 far away, the compiler will use the @code{call} instruction to
5503 call a function and the @code{rtc} instruction for returning.
5504
5505 @item -mshort
5506 @opindex mshort
5507 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5508
5509 @item -msoft-reg-count=@var{count}
5510 @opindex msoft-reg-count
5511 Specify the number of pseudo-soft registers which are used for the
5512 code generation.  The maximum number is 32.  Using more pseudo-soft
5513 register may or may not result in better code depending on the program.
5514 The default is 4 for 68HC11 and 2 for 68HC12.
5515
5516 @end table
5517
5518 @node VAX Options
5519 @subsection VAX Options
5520 @cindex VAX options
5521
5522 These @samp{-m} options are defined for the VAX:
5523
5524 @table @gcctabopt
5525 @item -munix
5526 @opindex munix
5527 Do not output certain jump instructions (@code{aobleq} and so on)
5528 that the Unix assembler for the VAX cannot handle across long
5529 ranges.
5530
5531 @item -mgnu
5532 @opindex mgnu
5533 Do output those jump instructions, on the assumption that you
5534 will assemble with the GNU assembler.
5535
5536 @item -mg
5537 @opindex mg
5538 Output code for g-format floating point numbers instead of d-format.
5539 @end table
5540
5541 @node SPARC Options
5542 @subsection SPARC Options
5543 @cindex SPARC options
5544
5545 These @samp{-m} switches are supported on the SPARC:
5546
5547 @table @gcctabopt
5548 @item -mno-app-regs
5549 @itemx -mapp-regs
5550 @opindex mno-app-regs
5551 @opindex mapp-regs
5552 Specify @option{-mapp-regs} to generate output using the global registers
5553 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5554 is the default.
5555
5556 To be fully SVR4 ABI compliant at the cost of some performance loss,
5557 specify @option{-mno-app-regs}.  You should compile libraries and system
5558 software with this option.
5559
5560 @item -mfpu
5561 @itemx -mhard-float
5562 @opindex mfpu
5563 @opindex mhard-float
5564 Generate output containing floating point instructions.  This is the
5565 default.
5566
5567 @item -mno-fpu
5568 @itemx -msoft-float
5569 @opindex mno-fpu
5570 @opindex msoft-float
5571 Generate output containing library calls for floating point.
5572 @strong{Warning:} the requisite libraries are not available for all SPARC
5573 targets.  Normally the facilities of the machine's usual C compiler are
5574 used, but this cannot be done directly in cross-compilation.  You must make
5575 your own arrangements to provide suitable library functions for
5576 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5577 @samp{sparclite-*-*} do provide software floating point support.
5578
5579 @option{-msoft-float} changes the calling convention in the output file;
5580 therefore, it is only useful if you compile @emph{all} of a program with
5581 this option.  In particular, you need to compile @file{libgcc.a}, the
5582 library that comes with GCC, with @option{-msoft-float} in order for
5583 this to work.
5584
5585 @item -mhard-quad-float
5586 @opindex mhard-quad-float
5587 Generate output containing quad-word (long double) floating point
5588 instructions.
5589
5590 @item -msoft-quad-float
5591 @opindex msoft-quad-float
5592 Generate output containing library calls for quad-word (long double)
5593 floating point instructions.  The functions called are those specified
5594 in the SPARC ABI@.  This is the default.
5595
5596 As of this writing, there are no sparc implementations that have hardware
5597 support for the quad-word floating point instructions.  They all invoke
5598 a trap handler for one of these instructions, and then the trap handler
5599 emulates the effect of the instruction.  Because of the trap handler overhead,
5600 this is much slower than calling the ABI library routines.  Thus the
5601 @option{-msoft-quad-float} option is the default.
5602
5603 @item -mno-flat
5604 @itemx -mflat
5605 @opindex mno-flat
5606 @opindex mflat
5607 With @option{-mflat}, the compiler does not generate save/restore instructions
5608 and will use a ``flat'' or single register window calling convention.
5609 This model uses %i7 as the frame pointer and is compatible with the normal
5610 register window model.  Code from either may be intermixed.
5611 The local registers and the input registers (0--5) are still treated as
5612 ``call saved'' registers and will be saved on the stack as necessary.
5613
5614 With @option{-mno-flat} (the default), the compiler emits save/restore
5615 instructions (except for leaf functions) and is the normal mode of operation.
5616
5617 @item -mno-unaligned-doubles
5618 @itemx -munaligned-doubles
5619 @opindex mno-unaligned-doubles
5620 @opindex munaligned-doubles
5621 Assume that doubles have 8 byte alignment.  This is the default.
5622
5623 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5624 alignment only if they are contained in another type, or if they have an
5625 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5626 Specifying this option avoids some rare compatibility problems with code
5627 generated by other compilers.  It is not the default because it results
5628 in a performance loss, especially for floating point code.
5629
5630 @item -mno-faster-structs
5631 @itemx -mfaster-structs
5632 @opindex mno-faster-structs
5633 @opindex mfaster-structs
5634 With @option{-mfaster-structs}, the compiler assumes that structures
5635 should have 8 byte alignment.  This enables the use of pairs of
5636 @code{ldd} and @code{std} instructions for copies in structure
5637 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5638 However, the use of this changed alignment directly violates the SPARC
5639 ABI@.  Thus, it's intended only for use on targets where the developer
5640 acknowledges that their resulting code will not be directly in line with
5641 the rules of the ABI@.
5642
5643 @item -mv8
5644 @itemx -msparclite
5645 @opindex mv8
5646 @opindex msparclite
5647 These two options select variations on the SPARC architecture.
5648
5649 By default (unless specifically configured for the Fujitsu SPARClite),
5650 GCC generates code for the v7 variant of the SPARC architecture.
5651
5652 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5653 code is that the compiler emits the integer multiply and integer
5654 divide instructions which exist in SPARC v8 but not in SPARC v7.
5655
5656 @option{-msparclite} will give you SPARClite code.  This adds the integer
5657 multiply, integer divide step and scan (@code{ffs}) instructions which
5658 exist in SPARClite but not in SPARC v7.
5659
5660 These options are deprecated and will be deleted in a future GCC release.
5661 They have been replaced with @option{-mcpu=xxx}.
5662
5663 @item -mcypress
5664 @itemx -msupersparc
5665 @opindex mcypress
5666 @opindex msupersparc
5667 These two options select the processor for which the code is optimized.
5668
5669 With @option{-mcypress} (the default), the compiler optimizes code for the
5670 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
5671 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
5672
5673 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
5674 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
5675 of the full SPARC v8 instruction set.
5676
5677 These options are deprecated and will be deleted in a future GCC release.
5678 They have been replaced with @option{-mcpu=xxx}.
5679
5680 @item -mcpu=@var{cpu_type}
5681 @opindex mcpu
5682 Set the instruction set, register set, and instruction scheduling parameters
5683 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5684 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5685 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5686 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
5687 @samp{ultrasparc3}.
5688
5689 Default instruction scheduling parameters are used for values that select
5690 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
5691 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
5692
5693 Here is a list of each supported architecture and their supported
5694 implementations.
5695
5696 @smallexample
5697     v7:             cypress
5698     v8:             supersparc, hypersparc
5699     sparclite:      f930, f934, sparclite86x
5700     sparclet:       tsc701
5701     v9:             ultrasparc, ultrasparc3
5702 @end smallexample
5703
5704 @item -mtune=@var{cpu_type}
5705 @opindex mtune
5706 Set the instruction scheduling parameters for machine type
5707 @var{cpu_type}, but do not set the instruction set or register set that the
5708 option @option{-mcpu=@var{cpu_type}} would.
5709
5710 The same values for @option{-mcpu=@var{cpu_type}} can be used for
5711 @option{-mtune=@var{cpu_type}}, but the only useful values are those
5712 that select a particular cpu implementation.  Those are @samp{cypress},
5713 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
5714 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
5715 @samp{ultrasparc3}.
5716
5717 @end table
5718
5719 These @samp{-m} switches are supported in addition to the above
5720 on the SPARCLET processor.
5721
5722 @table @gcctabopt
5723 @item -mlittle-endian
5724 @opindex mlittle-endian
5725 Generate code for a processor running in little-endian mode.
5726
5727 @item -mlive-g0
5728 @opindex mlive-g0
5729 Treat register @code{%g0} as a normal register.
5730 GCC will continue to clobber it as necessary but will not assume
5731 it always reads as 0.
5732
5733 @item -mbroken-saverestore
5734 @opindex mbroken-saverestore
5735 Generate code that does not use non-trivial forms of the @code{save} and
5736 @code{restore} instructions.  Early versions of the SPARCLET processor do
5737 not correctly handle @code{save} and @code{restore} instructions used with
5738 arguments.  They correctly handle them used without arguments.  A @code{save}
5739 instruction used without arguments increments the current window pointer
5740 but does not allocate a new stack frame.  It is assumed that the window
5741 overflow trap handler will properly handle this case as will interrupt
5742 handlers.
5743 @end table
5744
5745 These @samp{-m} switches are supported in addition to the above
5746 on SPARC V9 processors in 64-bit environments.
5747
5748 @table @gcctabopt
5749 @item -mlittle-endian
5750 @opindex mlittle-endian
5751 Generate code for a processor running in little-endian mode.
5752
5753 @item -m32
5754 @itemx -m64
5755 @opindex m32
5756 @opindex m64
5757 Generate code for a 32-bit or 64-bit environment.
5758 The 32-bit environment sets int, long and pointer to 32 bits.
5759 The 64-bit environment sets int to 32 bits and long and pointer
5760 to 64 bits.
5761
5762 @item -mcmodel=medlow
5763 @opindex mcmodel=medlow
5764 Generate code for the Medium/Low code model: the program must be linked
5765 in the low 32 bits of the address space.  Pointers are 64 bits.
5766 Programs can be statically or dynamically linked.
5767
5768 @item -mcmodel=medmid
5769 @opindex mcmodel=medmid
5770 Generate code for the Medium/Middle code model: the program must be linked
5771 in the low 44 bits of the address space, the text segment must be less than
5772 2G bytes, and data segment must be within 2G of the text segment.
5773 Pointers are 64 bits.
5774
5775 @item -mcmodel=medany
5776 @opindex mcmodel=medany
5777 Generate code for the Medium/Anywhere code model: the program may be linked
5778 anywhere in the address space, the text segment must be less than
5779 2G bytes, and data segment must be within 2G of the text segment.
5780 Pointers are 64 bits.
5781
5782 @item -mcmodel=embmedany
5783 @opindex mcmodel=embmedany
5784 Generate code for the Medium/Anywhere code model for embedded systems:
5785 assume a 32-bit text and a 32-bit data segment, both starting anywhere
5786 (determined at link time).  Register %g4 points to the base of the
5787 data segment.  Pointers are still 64 bits.
5788 Programs are statically linked, PIC is not supported.
5789
5790 @item -mstack-bias
5791 @itemx -mno-stack-bias
5792 @opindex mstack-bias
5793 @opindex mno-stack-bias
5794 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
5795 frame pointer if present, are offset by @minus{}2047 which must be added back
5796 when making stack frame references.
5797 Otherwise, assume no such offset is present.
5798 @end table
5799
5800 @node Convex Options
5801 @subsection Convex Options
5802 @cindex Convex options
5803
5804 These @samp{-m} options are defined for Convex:
5805
5806 @table @gcctabopt
5807 @item -mc1
5808 @opindex mc1
5809 Generate output for C1.  The code will run on any Convex machine.
5810 The preprocessor symbol @code{__convex__c1__} is defined.
5811
5812 @item -mc2
5813 @opindex mc2
5814 Generate output for C2.  Uses instructions not available on C1.
5815 Scheduling and other optimizations are chosen for max performance on C2.
5816 The preprocessor symbol @code{__convex_c2__} is defined.
5817
5818 @item -mc32
5819 @opindex mc32
5820 Generate output for C32xx.  Uses instructions not available on C1.
5821 Scheduling and other optimizations are chosen for max performance on C32.
5822 The preprocessor symbol @code{__convex_c32__} is defined.
5823
5824 @item -mc34
5825 @opindex mc34
5826 Generate output for C34xx.  Uses instructions not available on C1.
5827 Scheduling and other optimizations are chosen for max performance on C34.
5828 The preprocessor symbol @code{__convex_c34__} is defined.
5829
5830 @item -mc38
5831 @opindex mc38
5832 Generate output for C38xx.  Uses instructions not available on C1.
5833 Scheduling and other optimizations are chosen for max performance on C38.
5834 The preprocessor symbol @code{__convex_c38__} is defined.
5835
5836 @item -margcount
5837 @opindex margcount
5838 Generate code which puts an argument count in the word preceding each
5839 argument list.  This is compatible with regular CC, and a few programs
5840 may need the argument count word.  GDB and other source-level debuggers
5841 do not need it; this info is in the symbol table.
5842
5843 @item -mnoargcount
5844 @opindex mnoargcount
5845 Omit the argument count word.  This is the default.
5846
5847 @item -mvolatile-cache
5848 @opindex mvolatile-cache
5849 Allow volatile references to be cached.  This is the default.
5850
5851 @item -mvolatile-nocache
5852 @opindex mvolatile-nocache
5853 Volatile references bypass the data cache, going all the way to memory.
5854 This is only needed for multi-processor code that does not use standard
5855 synchronization instructions.  Making non-volatile references to volatile
5856 locations will not necessarily work.
5857
5858 @item -mlong32
5859 @opindex mlong32
5860 Type long is 32 bits, the same as type int.  This is the default.
5861
5862 @item -mlong64
5863 @opindex mlong64
5864 Type long is 64 bits, the same as type long long.  This option is useless,
5865 because no library support exists for it.
5866 @end table
5867
5868 @node AMD29K Options
5869 @subsection AMD29K Options
5870 @cindex AMD29K options
5871
5872 These @samp{-m} options are defined for the AMD Am29000:
5873
5874 @table @gcctabopt
5875 @item -mdw
5876 @opindex mdw
5877 @cindex DW bit (29k)
5878 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
5879 halfword operations are directly supported by the hardware.  This is the
5880 default.
5881
5882 @item -mndw
5883 @opindex mndw
5884 Generate code that assumes the @code{DW} bit is not set.
5885
5886 @item -mbw
5887 @opindex mbw
5888 @cindex byte writes (29k)
5889 Generate code that assumes the system supports byte and halfword write
5890 operations.  This is the default.
5891
5892 @item -mnbw
5893 @opindex mnbw
5894 Generate code that assumes the systems does not support byte and
5895 halfword write operations.  @option{-mnbw} implies @option{-mndw}.
5896
5897 @item -msmall
5898 @opindex msmall
5899 @cindex memory model (29k)
5900 Use a small memory model that assumes that all function addresses are
5901 either within a single 256 KB segment or at an absolute address of less
5902 than 256k.  This allows the @code{call} instruction to be used instead
5903 of a @code{const}, @code{consth}, @code{calli} sequence.
5904
5905 @item -mnormal
5906 @opindex mnormal
5907 Use the normal memory model: Generate @code{call} instructions only when
5908 calling functions in the same file and @code{calli} instructions
5909 otherwise.  This works if each file occupies less than 256 KB but allows
5910 the entire executable to be larger than 256 KB@.  This is the default.
5911
5912 @item -mlarge
5913 @opindex mlarge
5914 Always use @code{calli} instructions.  Specify this option if you expect
5915 a single file to compile into more than 256 KB of code.
5916
5917 @item -m29050
5918 @opindex m29050
5919 @cindex processor selection (29k)
5920 Generate code for the Am29050.
5921
5922 @item -m29000
5923 @opindex m29000
5924 Generate code for the Am29000.  This is the default.
5925
5926 @item -mkernel-registers
5927 @opindex mkernel-registers
5928 @cindex kernel and user registers (29k)
5929 Generate references to registers @code{gr64-gr95} instead of to
5930 registers @code{gr96-gr127}.  This option can be used when compiling
5931 kernel code that wants a set of global registers disjoint from that used
5932 by user-mode code.
5933
5934 Note that when this option is used, register names in @samp{-f} flags
5935 must use the normal, user-mode, names.
5936
5937 @item -muser-registers
5938 @opindex muser-registers
5939 Use the normal set of global registers, @code{gr96-gr127}.  This is the
5940 default.
5941
5942 @item -mstack-check
5943 @itemx -mno-stack-check
5944 @opindex mstack-check
5945 @opindex mno-stack-check
5946 @cindex stack checks (29k)
5947 Insert (or do not insert) a call to @code{__msp_check} after each stack
5948 adjustment.  This is often used for kernel code.
5949
5950 @item -mstorem-bug
5951 @itemx -mno-storem-bug
5952 @opindex mstorem-bug
5953 @opindex mno-storem-bug
5954 @cindex storem bug (29k)
5955 @option{-mstorem-bug} handles 29k processors which cannot handle the
5956 separation of a mtsrim insn and a storem instruction (most 29000 chips
5957 to date, but not the 29050).
5958
5959 @item -mno-reuse-arg-regs
5960 @itemx -mreuse-arg-regs
5961 @opindex mno-reuse-arg-regs
5962 @opindex mreuse-arg-regs
5963 @option{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5964 registers for copying out arguments.  This helps detect calling a function
5965 with fewer arguments than it was declared with.
5966
5967 @item -mno-impure-text
5968 @itemx -mimpure-text
5969 @opindex mno-impure-text
5970 @opindex mimpure-text
5971 @option{-mimpure-text}, used in addition to @option{-shared}, tells the compiler to
5972 not pass @option{-assert pure-text} to the linker when linking a shared object.
5973
5974 @item -msoft-float
5975 @opindex msoft-float
5976 Generate output containing library calls for floating point.
5977 @strong{Warning:} the requisite libraries are not part of GCC@.
5978 Normally the facilities of the machine's usual C compiler are used, but
5979 this can't be done directly in cross-compilation.  You must make your
5980 own arrangements to provide suitable library functions for
5981 cross-compilation.
5982
5983 @item -mno-multm
5984 @opindex mno-multm
5985 Do not generate multm or multmu instructions.  This is useful for some embedded
5986 systems which do not have trap handlers for these instructions.
5987 @end table
5988
5989 @node ARM Options
5990 @subsection ARM Options
5991 @cindex ARM options
5992
5993 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5994 architectures:
5995
5996 @table @gcctabopt
5997 @item -mapcs-frame
5998 @opindex mapcs-frame
5999 Generate a stack frame that is compliant with the ARM Procedure Call
6000 Standard for all functions, even if this is not strictly necessary for
6001 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6002 with this option will cause the stack frames not to be generated for
6003 leaf functions.  The default is @option{-mno-apcs-frame}.
6004
6005 @item -mapcs
6006 @opindex mapcs
6007 This is a synonym for @option{-mapcs-frame}.
6008
6009 @item -mapcs-26
6010 @opindex mapcs-26
6011 Generate code for a processor running with a 26-bit program counter,
6012 and conforming to the function calling standards for the APCS 26-bit
6013 option.  This option replaces the @option{-m2} and @option{-m3} options
6014 of previous releases of the compiler.
6015
6016 @item -mapcs-32
6017 @opindex mapcs-32
6018 Generate code for a processor running with a 32-bit program counter,
6019 and conforming to the function calling standards for the APCS 32-bit
6020 option.  This option replaces the @option{-m6} option of previous releases
6021 of the compiler.
6022
6023 @ignore
6024 @c not currently implemented
6025 @item -mapcs-stack-check
6026 @opindex mapcs-stack-check
6027 Generate code to check the amount of stack space available upon entry to
6028 every function (that actually uses some stack space).  If there is
6029 insufficient space available then either the function
6030 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6031 called, depending upon the amount of stack space required.  The run time
6032 system is required to provide these functions.  The default is
6033 @option{-mno-apcs-stack-check}, since this produces smaller code.
6034
6035 @c not currently implemented
6036 @item -mapcs-float
6037 @opindex mapcs-float
6038 Pass floating point arguments using the float point registers.  This is
6039 one of the variants of the APCS@.  This option is recommended if the
6040 target hardware has a floating point unit or if a lot of floating point
6041 arithmetic is going to be performed by the code.  The default is
6042 @option{-mno-apcs-float}, since integer only code is slightly increased in
6043 size if @option{-mapcs-float} is used.
6044
6045 @c not currently implemented
6046 @item -mapcs-reentrant
6047 @opindex mapcs-reentrant
6048 Generate reentrant, position independent code.  The default is
6049 @option{-mno-apcs-reentrant}.
6050 @end ignore
6051
6052 @item -mthumb-interwork
6053 @opindex mthumb-interwork
6054 Generate code which supports calling between the ARM and Thumb
6055 instruction sets.  Without this option the two instruction sets cannot
6056 be reliably used inside one program.  The default is
6057 @option{-mno-thumb-interwork}, since slightly larger code is generated
6058 when @option{-mthumb-interwork} is specified.
6059
6060 @item -mno-sched-prolog
6061 @opindex mno-sched-prolog
6062 Prevent the reordering of instructions in the function prolog, or the
6063 merging of those instruction with the instructions in the function's
6064 body.  This means that all functions will start with a recognizable set
6065 of instructions (or in fact one of a choice from a small set of
6066 different function prologues), and this information can be used to
6067 locate the start if functions inside an executable piece of code.  The
6068 default is @option{-msched-prolog}.
6069
6070 @item -mhard-float
6071 @opindex mhard-float
6072 Generate output containing floating point instructions.  This is the
6073 default.
6074
6075 @item -msoft-float
6076 @opindex msoft-float
6077 Generate output containing library calls for floating point.
6078 @strong{Warning:} the requisite libraries are not available for all ARM
6079 targets.  Normally the facilities of the machine's usual C compiler are
6080 used, but this cannot be done directly in cross-compilation.  You must make
6081 your own arrangements to provide suitable library functions for
6082 cross-compilation.
6083
6084 @option{-msoft-float} changes the calling convention in the output file;
6085 therefore, it is only useful if you compile @emph{all} of a program with
6086 this option.  In particular, you need to compile @file{libgcc.a}, the
6087 library that comes with GCC, with @option{-msoft-float} in order for
6088 this to work.
6089
6090 @item -mlittle-endian
6091 @opindex mlittle-endian
6092 Generate code for a processor running in little-endian mode.  This is
6093 the default for all standard configurations.
6094
6095 @item -mbig-endian
6096 @opindex mbig-endian
6097 Generate code for a processor running in big-endian mode; the default is
6098 to compile code for a little-endian processor.
6099
6100 @item -mwords-little-endian
6101 @opindex mwords-little-endian
6102 This option only applies when generating code for big-endian processors.
6103 Generate code for a little-endian word order but a big-endian byte
6104 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6105 option should only be used if you require compatibility with code for
6106 big-endian ARM processors generated by versions of the compiler prior to
6107 2.8.
6108
6109 @item -malignment-traps
6110 @opindex malignment-traps
6111 Generate code that will not trap if the MMU has alignment traps enabled.
6112 On ARM architectures prior to ARMv4, there were no instructions to
6113 access half-word objects stored in memory.  However, when reading from
6114 memory a feature of the ARM architecture allows a word load to be used,
6115 even if the address is unaligned, and the processor core will rotate the
6116 data as it is being loaded.  This option tells the compiler that such
6117 misaligned accesses will cause a MMU trap and that it should instead
6118 synthesize the access as a series of byte accesses.  The compiler can
6119 still use word accesses to load half-word data if it knows that the
6120 address is aligned to a word boundary.
6121
6122 This option is ignored when compiling for ARM architecture 4 or later,
6123 since these processors have instructions to directly access half-word
6124 objects in memory.
6125
6126 @item -mno-alignment-traps
6127 @opindex mno-alignment-traps
6128 Generate code that assumes that the MMU will not trap unaligned
6129 accesses.  This produces better code when the target instruction set
6130 does not have half-word memory operations (i.e.@: implementations prior to
6131 ARMv4).
6132
6133 Note that you cannot use this option to access unaligned word objects,
6134 since the processor will only fetch one 32-bit aligned object from
6135 memory.
6136
6137 The default setting for most targets is @option{-mno-alignment-traps}, since
6138 this produces better code when there are no half-word memory
6139 instructions available.
6140
6141 @item -mshort-load-bytes
6142 @itemx -mno-short-load-words
6143 @opindex mshort-load-bytes
6144 @opindex mno-short-load-words
6145 These are deprecated aliases for @option{-malignment-traps}.
6146
6147 @item -mno-short-load-bytes
6148 @itemx -mshort-load-words
6149 @opindex mno-short-load-bytes
6150 @opindex mshort-load-words
6151 This are deprecated aliases for @option{-mno-alignment-traps}.
6152
6153 @item -mbsd
6154 @opindex mbsd
6155 This option only applies to RISC iX@.  Emulate the native BSD-mode
6156 compiler.  This is the default if @option{-ansi} is not specified.
6157
6158 @item -mxopen
6159 @opindex mxopen
6160 This option only applies to RISC iX@.  Emulate the native X/Open-mode
6161 compiler.
6162
6163 @item -mno-symrename
6164 @opindex mno-symrename
6165 This option only applies to RISC iX@.  Do not run the assembler
6166 post-processor, @samp{symrename}, after code has been assembled.
6167 Normally it is necessary to modify some of the standard symbols in
6168 preparation for linking with the RISC iX C library; this option
6169 suppresses this pass.  The post-processor is never run when the
6170 compiler is built for cross-compilation.
6171
6172 @item -mcpu=@var{name}
6173 @opindex mcpu
6174 This specifies the name of the target ARM processor.  GCC uses this name
6175 to determine what kind of instructions it can emit when generating
6176 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6177 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6178 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6179 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6180 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6181 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6182 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6183 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6184 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6185 @samp{arm1020t}, @samp{xscale}.
6186
6187 @itemx -mtune=@var{name}
6188 @opindex mtune
6189 This option is very similar to the @option{-mcpu=} option, except that
6190 instead of specifying the actual target processor type, and hence
6191 restricting which instructions can be used, it specifies that GCC should
6192 tune the performance of the code as if the target were of the type
6193 specified in this option, but still choosing the instructions that it
6194 will generate based on the cpu specified by a @option{-mcpu=} option.
6195 For some ARM implementations better performance can be obtained by using
6196 this option.
6197
6198 @item -march=@var{name}
6199 @opindex march
6200 This specifies the name of the target ARM architecture.  GCC uses this
6201 name to determine what kind of instructions it can emit when generating
6202 assembly code.  This option can be used in conjunction with or instead
6203 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6204 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6205 @samp{armv5}, @samp{armv5t}, @samp{armv5te}.
6206
6207 @item -mfpe=@var{number}
6208 @itemx -mfp=@var{number}
6209 @opindex mfpe
6210 @opindex mfp
6211 This specifies the version of the floating point emulation available on
6212 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6213 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6214
6215 @item -mstructure-size-boundary=@var{n}
6216 @opindex mstructure-size-boundary
6217 The size of all structures and unions will be rounded up to a multiple
6218 of the number of bits set by this option.  Permissible values are 8 and
6219 32.  The default value varies for different toolchains.  For the COFF
6220 targeted toolchain the default value is 8.  Specifying the larger number
6221 can produce faster, more efficient code, but can also increase the size
6222 of the program.  The two values are potentially incompatible.  Code
6223 compiled with one value cannot necessarily expect to work with code or
6224 libraries compiled with the other value, if they exchange information
6225 using structures or unions.
6226
6227 @item -mabort-on-noreturn
6228 @opindex mabort-on-noreturn
6229 Generate a call to the function @code{abort} at the end of a
6230 @code{noreturn} function.  It will be executed if the function tries to
6231 return.
6232
6233 @item -mlong-calls
6234 @itemx -mno-long-calls
6235 @opindex mlong-calls
6236 @opindex mno-long-calls
6237 Tells the compiler to perform function calls by first loading the
6238 address of the function into a register and then performing a subroutine
6239 call on this register.  This switch is needed if the target function
6240 will lie outside of the 64 megabyte addressing range of the offset based
6241 version of subroutine call instruction.
6242
6243 Even if this switch is enabled, not all function calls will be turned
6244 into long calls.  The heuristic is that static functions, functions
6245 which have the @samp{short-call} attribute, functions that are inside
6246 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6247 definitions have already been compiled within the current compilation
6248 unit, will not be turned into long calls.  The exception to this rule is
6249 that weak function definitions, functions with the @samp{long-call}
6250 attribute or the @samp{section} attribute, and functions that are within
6251 the scope of a @samp{#pragma long_calls} directive, will always be
6252 turned into long calls.
6253
6254 This feature is not enabled by default.  Specifying
6255 @option{-mno-long-calls} will restore the default behavior, as will
6256 placing the function calls within the scope of a @samp{#pragma
6257 long_calls_off} directive.  Note these switches have no effect on how
6258 the compiler generates code to handle function calls via function
6259 pointers.
6260
6261 @item -mnop-fun-dllimport
6262 @opindex mnop-fun-dllimport
6263 Disable support for the @code{dllimport} attribute.
6264
6265 @item -msingle-pic-base
6266 @opindex msingle-pic-base
6267 Treat the register used for PIC addressing as read-only, rather than
6268 loading it in the prologue for each function.  The run-time system is
6269 responsible for initializing this register with an appropriate value
6270 before execution begins.
6271
6272 @item -mpic-register=@var{reg}
6273 @opindex mpic-register
6274 Specify the register to be used for PIC addressing.  The default is R10
6275 unless stack-checking is enabled, when R9 is used.
6276
6277 @item -mpoke-function-name
6278 @opindex mpoke-function-name
6279 Write the name of each function into the text section, directly
6280 preceding the function prologue.  The generated code is similar to this:
6281
6282 @smallexample
6283      t0
6284          .ascii "arm_poke_function_name", 0
6285          .align
6286      t1
6287          .word 0xff000000 + (t1 - t0)
6288      arm_poke_function_name
6289          mov     ip, sp
6290          stmfd   sp!, @{fp, ip, lr, pc@}
6291          sub     fp, ip, #4
6292 @end smallexample
6293
6294 When performing a stack backtrace, code can inspect the value of
6295 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6296 location @code{pc - 12} and the top 8 bits are set, then we know that
6297 there is a function name embedded immediately preceding this location
6298 and has length @code{((pc[-3]) & 0xff000000)}.
6299
6300 @item -mthumb
6301 @opindex mthumb
6302 Generate code for the 16-bit Thumb instruction set.  The default is to
6303 use the 32-bit ARM instruction set.
6304
6305 @item -mtpcs-frame
6306 @opindex mtpcs-frame
6307 Generate a stack frame that is compliant with the Thumb Procedure Call
6308 Standard for all non-leaf functions.  (A leaf function is one that does
6309 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6310
6311 @item -mtpcs-leaf-frame
6312 @opindex mtpcs-leaf-frame
6313 Generate a stack frame that is compliant with the Thumb Procedure Call
6314 Standard for all leaf functions.  (A leaf function is one that does
6315 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6316
6317 @item -mcallee-super-interworking
6318 @opindex mcallee-super-interworking
6319 Gives all externally visible functions in the file being compiled an ARM
6320 instruction set header which switches to Thumb mode before executing the
6321 rest of the function.  This allows these functions to be called from
6322 non-interworking code.
6323
6324 @item -mcaller-super-interworking
6325 @opindex mcaller-super-interworking
6326 Allows calls via function pointers (including virtual functions) to
6327 execute correctly regardless of whether the target code has been
6328 compiled for interworking or not.  There is a small overhead in the cost
6329 of executing a function pointer if this option is enabled.
6330
6331 @end table
6332
6333 @node MN10200 Options
6334 @subsection MN10200 Options
6335 @cindex MN10200 options
6336 These @option{-m} options are defined for Matsushita MN10200 architectures:
6337 @table @gcctabopt
6338
6339 @item -mrelax
6340 @opindex mrelax
6341 Indicate to the linker that it should perform a relaxation optimization pass
6342 to shorten branches, calls and absolute memory addresses.  This option only
6343 has an effect when used on the command line for the final link step.
6344
6345 This option makes symbolic debugging impossible.
6346 @end table
6347
6348 @node MN10300 Options
6349 @subsection MN10300 Options
6350 @cindex MN10300 options
6351 These @option{-m} options are defined for Matsushita MN10300 architectures:
6352
6353 @table @gcctabopt
6354 @item -mmult-bug
6355 @opindex mmult-bug
6356 Generate code to avoid bugs in the multiply instructions for the MN10300
6357 processors.  This is the default.
6358
6359 @item -mno-mult-bug
6360 @opindex mno-mult-bug
6361 Do not generate code to avoid bugs in the multiply instructions for the
6362 MN10300 processors.
6363
6364 @item -mam33
6365 @opindex mam33
6366 Generate code which uses features specific to the AM33 processor.
6367
6368 @item -mno-am33
6369 @opindex mno-am33
6370 Do not generate code which uses features specific to the AM33 processor.  This
6371 is the default.
6372
6373 @item -mno-crt0
6374 @opindex mno-crt0
6375 Do not link in the C run-time initialization object file.
6376
6377 @item -mrelax
6378 @opindex mrelax
6379 Indicate to the linker that it should perform a relaxation optimization pass
6380 to shorten branches, calls and absolute memory addresses.  This option only
6381 has an effect when used on the command line for the final link step.
6382
6383 This option makes symbolic debugging impossible.
6384 @end table
6385
6386
6387 @node M32R/D Options
6388 @subsection M32R/D Options
6389 @cindex M32R/D options
6390
6391 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6392
6393 @table @gcctabopt
6394 @item -m32rx
6395 @opindex m32rx
6396 Generate code for the M32R/X@.
6397
6398 @item -m32r
6399 @opindex m32r
6400 Generate code for the M32R@.  This is the default.
6401
6402 @item -mcode-model=small
6403 @opindex mcode-model=small
6404 Assume all objects live in the lower 16MB of memory (so that their addresses
6405 can be loaded with the @code{ld24} instruction), and assume all subroutines
6406 are reachable with the @code{bl} instruction.
6407 This is the default.
6408
6409 The addressability of a particular object can be set with the
6410 @code{model} attribute.
6411
6412 @item -mcode-model=medium
6413 @opindex mcode-model=medium
6414 Assume objects may be anywhere in the 32-bit address space (the compiler
6415 will generate @code{seth/add3} instructions to load their addresses), and
6416 assume all subroutines are reachable with the @code{bl} instruction.
6417
6418 @item -mcode-model=large
6419 @opindex mcode-model=large
6420 Assume objects may be anywhere in the 32-bit address space (the compiler
6421 will generate @code{seth/add3} instructions to load their addresses), and
6422 assume subroutines may not be reachable with the @code{bl} instruction
6423 (the compiler will generate the much slower @code{seth/add3/jl}
6424 instruction sequence).
6425
6426 @item -msdata=none
6427 @opindex msdata=none
6428 Disable use of the small data area.  Variables will be put into
6429 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6430 @code{section} attribute has been specified).
6431 This is the default.
6432
6433 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6434 Objects may be explicitly put in the small data area with the
6435 @code{section} attribute using one of these sections.
6436
6437 @item -msdata=sdata
6438 @opindex msdata=sdata
6439 Put small global and static data in the small data area, but do not
6440 generate special code to reference them.
6441
6442 @item -msdata=use
6443 @opindex msdata=use
6444 Put small global and static data in the small data area, and generate
6445 special instructions to reference them.
6446
6447 @item -G @var{num}
6448 @opindex G
6449 @cindex smaller data references
6450 Put global and static objects less than or equal to @var{num} bytes
6451 into the small data or bss sections instead of the normal data or bss
6452 sections.  The default value of @var{num} is 8.
6453 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6454 for this option to have any effect.
6455
6456 All modules should be compiled with the same @option{-G @var{num}} value.
6457 Compiling with different values of @var{num} may or may not work; if it
6458 doesn't the linker will give an error message---incorrect code will not be
6459 generated.
6460
6461 @end table
6462
6463 @node M88K Options
6464 @subsection M88K Options
6465 @cindex M88k options
6466
6467 These @samp{-m} options are defined for Motorola 88k architectures:
6468
6469 @table @gcctabopt
6470 @item -m88000
6471 @opindex m88000
6472 Generate code that works well on both the m88100 and the
6473 m88110.
6474
6475 @item -m88100
6476 @opindex m88100
6477 Generate code that works best for the m88100, but that also
6478 runs on the m88110.
6479
6480 @item -m88110
6481 @opindex m88110
6482 Generate code that works best for the m88110, and may not run
6483 on the m88100.
6484
6485 @item -mbig-pic
6486 @opindex mbig-pic
6487 Obsolete option to be removed from the next revision.
6488 Use @option{-fPIC}.
6489
6490 @item -midentify-revision
6491 @opindex midentify-revision
6492 @cindex identifying source, compiler (88k)
6493 Include an @code{ident} directive in the assembler output recording the
6494 source file name, compiler name and version, timestamp, and compilation
6495 flags used.
6496
6497 @item -mno-underscores
6498 @opindex mno-underscores
6499 @cindex underscores, avoiding (88k)
6500 In assembler output, emit symbol names without adding an underscore
6501 character at the beginning of each name.  The default is to use an
6502 underscore as prefix on each name.
6503
6504 @item -mocs-debug-info
6505 @itemx -mno-ocs-debug-info
6506 @opindex mocs-debug-info
6507 @opindex mno-ocs-debug-info
6508 @cindex OCS (88k)
6509 @cindex debugging, 88k OCS
6510 Include (or omit) additional debugging information (about registers used
6511 in each stack frame) as specified in the 88open Object Compatibility
6512 Standard, ``OCS''@.  This extra information allows debugging of code that
6513 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
6514 Delta 88 SVr3.2 is to include this information; other 88k configurations
6515 omit this information by default.
6516
6517 @item -mocs-frame-position
6518 @opindex mocs-frame-position
6519 @cindex register positions in frame (88k)
6520 When emitting COFF debugging information for automatic variables and
6521 parameters stored on the stack, use the offset from the canonical frame
6522 address, which is the stack pointer (register 31) on entry to the
6523 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
6524 @option{-mocs-frame-position}; other 88k configurations have the default
6525 @option{-mno-ocs-frame-position}.
6526
6527 @item -mno-ocs-frame-position
6528 @opindex mno-ocs-frame-position
6529 @cindex register positions in frame (88k)
6530 When emitting COFF debugging information for automatic variables and
6531 parameters stored on the stack, use the offset from the frame pointer
6532 register (register 30).  When this option is in effect, the frame
6533 pointer is not eliminated when debugging information is selected by the
6534 -g switch.
6535
6536 @item -moptimize-arg-area
6537 @opindex moptimize-arg-area
6538 @cindex arguments in frame (88k)
6539 Save space by reorganizing the stack frame.  This option generates code
6540 that does not agree with the 88open specifications, but uses less
6541 memory.
6542
6543 @itemx -mno-optimize-arg-area
6544 @opindex mno-optimize-arg-area
6545 Do not reorganize the stack frame to save space.  This is the default.
6546 The generated conforms to the specification, but uses more memory.
6547
6548 @item -mshort-data-@var{num}
6549 @opindex mshort-data
6550 @cindex smaller data references (88k)
6551 @cindex r0-relative references (88k)
6552 Generate smaller data references by making them relative to @code{r0},
6553 which allows loading a value using a single instruction (rather than the
6554 usual two).  You control which data references are affected by
6555 specifying @var{num} with this option.  For example, if you specify
6556 @option{-mshort-data-512}, then the data references affected are those
6557 involving displacements of less than 512 bytes.
6558 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6559 than 64k.
6560
6561 @item -mserialize-volatile
6562 @opindex mserialize-volatile
6563 @itemx -mno-serialize-volatile
6564 @opindex mno-serialize-volatile
6565 @cindex sequential consistency on 88k
6566 Do, or don't, generate code to guarantee sequential consistency
6567 of volatile memory references.  By default, consistency is
6568 guaranteed.
6569
6570 The order of memory references made by the MC88110 processor does
6571 not always match the order of the instructions requesting those
6572 references.  In particular, a load instruction may execute before
6573 a preceding store instruction.  Such reordering violates
6574 sequential consistency of volatile memory references, when there
6575 are multiple processors.   When consistency must be guaranteed,
6576 GCC generates special instructions, as needed, to force
6577 execution in the proper order.
6578
6579 The MC88100 processor does not reorder memory references and so
6580 always provides sequential consistency.  However, by default, GCC
6581 generates the special instructions to guarantee consistency
6582 even when you use @option{-m88100}, so that the code may be run on an
6583 MC88110 processor.  If you intend to run your code only on the
6584 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6585
6586 The extra code generated to guarantee consistency may affect the
6587 performance of your application.  If you know that you can safely
6588 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6589
6590 @item -msvr4
6591 @itemx -msvr3
6592 @opindex msvr4
6593 @opindex msvr3
6594 @cindex assembler syntax, 88k
6595 @cindex SVr4
6596 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6597 related to System V release 4 (SVr4).  This controls the following:
6598
6599 @enumerate
6600 @item
6601 Which variant of the assembler syntax to emit.
6602 @item
6603 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6604 that is used on System V release 4.
6605 @item
6606 @option{-msvr4} makes GCC issue additional declaration directives used in
6607 SVr4.
6608 @end enumerate
6609
6610 @option{-msvr4} is the default for the m88k-motorola-sysv4 and
6611 m88k-dg-dgux m88k configurations.  @option{-msvr3} is the default for all
6612 other m88k configurations.
6613
6614 @item -mversion-03.00
6615 @opindex mversion-03.00
6616 This option is obsolete, and is ignored.
6617 @c ??? which asm syntax better for GAS?  option there too?
6618
6619 @item -mno-check-zero-division
6620 @itemx -mcheck-zero-division
6621 @opindex mno-check-zero-division
6622 @opindex mcheck-zero-division
6623 @cindex zero division on 88k
6624 Do, or don't, generate code to guarantee that integer division by
6625 zero will be detected.  By default, detection is guaranteed.
6626
6627 Some models of the MC88100 processor fail to trap upon integer
6628 division by zero under certain conditions.  By default, when
6629 compiling code that might be run on such a processor, GCC
6630 generates code that explicitly checks for zero-valued divisors
6631 and traps with exception number 503 when one is detected.  Use of
6632 @option{-mno-check-zero-division} suppresses such checking for code
6633 generated to run on an MC88100 processor.
6634
6635 GCC assumes that the MC88110 processor correctly detects all instances
6636 of integer division by zero.  When @option{-m88110} is specified, no
6637 explicit checks for zero-valued divisors are generated, and both
6638 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6639 ignored.
6640
6641 @item -muse-div-instruction
6642 @opindex muse-div-instruction
6643 @cindex divide instruction, 88k
6644 Use the div instruction for signed integer division on the
6645 MC88100 processor.  By default, the div instruction is not used.
6646
6647 On the MC88100 processor the signed integer division instruction
6648 div) traps to the operating system on a negative operand.  The
6649 operating system transparently completes the operation, but at a
6650 large cost in execution time.  By default, when compiling code
6651 that might be run on an MC88100 processor, GCC emulates signed
6652 integer division using the unsigned integer division instruction
6653 divu), thereby avoiding the large penalty of a trap to the
6654 operating system.  Such emulation has its own, smaller, execution
6655 cost in both time and space.  To the extent that your code's
6656 important signed integer division operations are performed on two
6657 nonnegative operands, it may be desirable to use the div
6658 instruction directly.
6659
6660 On the MC88110 processor the div instruction (also known as the
6661 divs instruction) processes negative operands without trapping to
6662 the operating system.  When @option{-m88110} is specified,
6663 @option{-muse-div-instruction} is ignored, and the div instruction is used
6664 for signed integer division.
6665
6666 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6667 particular, the behavior of such a division with and without
6668 @option{-muse-div-instruction} may differ.
6669
6670 @item -mtrap-large-shift
6671 @itemx -mhandle-large-shift
6672 @opindex mtrap-large-shift
6673 @opindex mhandle-large-shift
6674 @cindex bit shift overflow (88k)
6675 @cindex large bit shifts (88k)
6676 Include code to detect bit-shifts of more than 31 bits; respectively,
6677 trap such shifts or emit code to handle them properly.  By default GCC
6678 makes no special provision for large bit shifts.
6679
6680 @item -mwarn-passed-structs
6681 @opindex mwarn-passed-structs
6682 @cindex structure passing (88k)
6683 Warn when a function passes a struct as an argument or result.
6684 Structure-passing conventions have changed during the evolution of the C
6685 language, and are often the source of portability problems.  By default,
6686 GCC issues no such warning.
6687 @end table
6688
6689 @c break page here to avoid unsightly interparagraph stretch.
6690 @c -zw, 2001-8-17
6691 @page
6692
6693 @node RS/6000 and PowerPC Options
6694 @subsection IBM RS/6000 and PowerPC Options
6695 @cindex RS/6000 and PowerPC Options
6696 @cindex IBM RS/6000 and PowerPC Options
6697
6698 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6699 @table @gcctabopt
6700 @item -mpower
6701 @itemx -mno-power
6702 @itemx -mpower2
6703 @itemx -mno-power2
6704 @itemx -mpowerpc
6705 @itemx -mno-powerpc
6706 @itemx -mpowerpc-gpopt
6707 @itemx -mno-powerpc-gpopt
6708 @itemx -mpowerpc-gfxopt
6709 @itemx -mno-powerpc-gfxopt
6710 @itemx -mpowerpc64
6711 @itemx -mno-powerpc64
6712 @opindex mpower
6713 @opindex mno-power
6714 @opindex mpower2
6715 @opindex mno-power2
6716 @opindex mpowerpc
6717 @opindex mno-powerpc
6718 @opindex mpowerpc-gpopt
6719 @opindex mno-powerpc-gpopt
6720 @opindex mpowerpc-gfxopt
6721 @opindex mno-powerpc-gfxopt
6722 @opindex mpowerpc64
6723 @opindex mno-powerpc64
6724 GCC supports two related instruction set architectures for the
6725 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6726 instructions supported by the @samp{rios} chip set used in the original
6727 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6728 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6729 the IBM 4xx microprocessors.
6730
6731 Neither architecture is a subset of the other.  However there is a
6732 large common subset of instructions supported by both.  An MQ
6733 register is included in processors supporting the POWER architecture.
6734
6735 You use these options to specify which instructions are available on the
6736 processor you are using.  The default value of these options is
6737 determined when configuring GCC@.  Specifying the
6738 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6739 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6740 rather than the options listed above.
6741
6742 The @option{-mpower} option allows GCC to generate instructions that
6743 are found only in the POWER architecture and to use the MQ register.
6744 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6745 to generate instructions that are present in the POWER2 architecture but
6746 not the original POWER architecture.
6747
6748 The @option{-mpowerpc} option allows GCC to generate instructions that
6749 are found only in the 32-bit subset of the PowerPC architecture.
6750 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6751 GCC to use the optional PowerPC architecture instructions in the
6752 General Purpose group, including floating-point square root.  Specifying
6753 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6754 use the optional PowerPC architecture instructions in the Graphics
6755 group, including floating-point select.
6756
6757 The @option{-mpowerpc64} option allows GCC to generate the additional
6758 64-bit instructions that are found in the full PowerPC64 architecture
6759 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6760 @option{-mno-powerpc64}.
6761
6762 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6763 will use only the instructions in the common subset of both
6764 architectures plus some special AIX common-mode calls, and will not use
6765 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6766 permits GCC to use any instruction from either architecture and to
6767 allow use of the MQ register; specify this for the Motorola MPC601.
6768
6769 @item -mnew-mnemonics
6770 @itemx -mold-mnemonics
6771 @opindex mnew-mnemonics
6772 @opindex mold-mnemonics
6773 Select which mnemonics to use in the generated assembler code.  With
6774 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6775 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6776 assembler mnemonics defined for the POWER architecture.  Instructions
6777 defined in only one architecture have only one mnemonic; GCC uses that
6778 mnemonic irrespective of which of these options is specified.
6779
6780 GCC defaults to the mnemonics appropriate for the architecture in
6781 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6782 value of these option.  Unless you are building a cross-compiler, you
6783 should normally not specify either @option{-mnew-mnemonics} or
6784 @option{-mold-mnemonics}, but should instead accept the default.
6785
6786 @item -mcpu=@var{cpu_type}
6787 @opindex mcpu
6788 Set architecture type, register usage, choice of mnemonics, and
6789 instruction scheduling parameters for machine type @var{cpu_type}.
6790 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6791 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6792 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6793 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6794 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6795 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6796
6797 @option{-mcpu=common} selects a completely generic processor.  Code
6798 generated under this option will run on any POWER or PowerPC processor.
6799 GCC will use only the instructions in the common subset of both
6800 architectures, and will not use the MQ register.  GCC assumes a generic
6801 processor model for scheduling purposes.
6802
6803 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6804 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6805 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6806 types, with an appropriate, generic processor model assumed for
6807 scheduling purposes.
6808
6809 The other options specify a specific processor.  Code generated under
6810 those options will run best on that processor, and may not run at all on
6811 others.
6812
6813 The @option{-mcpu} options automatically enable or disable other
6814 @option{-m} options as follows:
6815
6816 @table @samp
6817 @item common
6818 @option{-mno-power}, @option{-mno-powerpc}
6819
6820 @item power
6821 @itemx power2
6822 @itemx rios1
6823 @itemx rios2
6824 @itemx rsc
6825 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6826
6827 @item powerpc
6828 @itemx rs64a
6829 @itemx 602
6830 @itemx 603
6831 @itemx 603e
6832 @itemx 604
6833 @itemx 620
6834 @itemx 630
6835 @itemx 740
6836 @itemx 7400
6837 @itemx 7450
6838 @itemx 750
6839 @itemx 505
6840 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6841
6842 @item 601
6843 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6844
6845 @item 403
6846 @itemx 821
6847 @itemx 860
6848 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6849 @end table
6850
6851 @item -mtune=@var{cpu_type}
6852 @opindex mtune
6853 Set the instruction scheduling parameters for machine type
6854 @var{cpu_type}, but do not set the architecture type, register usage, or
6855 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6856 values for @var{cpu_type} are used for @option{-mtune} as for
6857 @option{-mcpu}.  If both are specified, the code generated will use the
6858 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6859 scheduling parameters set by @option{-mtune}.
6860
6861 @item -maltivec
6862 @itemx -mno-altivec
6863 @opindex maltivec
6864 @opindex mno-altivec
6865 These switches enable or disable the use of built-in functions that
6866 allow access to the AltiVec instruction set.  You may also need to set
6867 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6868 enhancements.
6869
6870 @item -mabi=spe
6871 @opindex mabi=spe
6872 Extend the current ABI with SPE ABI extensions.  This does not change
6873 the default ABI, instead it adds the SPE ABI extensions to the current
6874 ABI@.
6875
6876 @item -mabi=no-spe
6877 @opindex mabi=no-spe
6878 Disable Booke SPE ABI extensions for the current ABI.
6879
6880 @item -misel=@var{yes/no}
6881 @itemx -misel
6882 @opindex misel
6883 This switch enables or disables the generation of ISEL instructions.
6884
6885 @item -mfull-toc
6886 @itemx -mno-fp-in-toc
6887 @itemx -mno-sum-in-toc
6888 @itemx -mminimal-toc
6889 @opindex mfull-toc
6890 @opindex mno-fp-in-toc
6891 @opindex mno-sum-in-toc
6892 @opindex mminimal-toc
6893 Modify generation of the TOC (Table Of Contents), which is created for
6894 every executable file.  The @option{-mfull-toc} option is selected by
6895 default.  In that case, GCC will allocate at least one TOC entry for
6896 each unique non-automatic variable reference in your program.  GCC
6897 will also place floating-point constants in the TOC@.  However, only
6898 16,384 entries are available in the TOC@.
6899
6900 If you receive a linker error message that saying you have overflowed
6901 the available TOC space, you can reduce the amount of TOC space used
6902 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
6903 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
6904 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
6905 generate code to calculate the sum of an address and a constant at
6906 run-time instead of putting that sum into the TOC@.  You may specify one
6907 or both of these options.  Each causes GCC to produce very slightly
6908 slower and larger code at the expense of conserving TOC space.
6909
6910 If you still run out of space in the TOC even when you specify both of
6911 these options, specify @option{-mminimal-toc} instead.  This option causes
6912 GCC to make only one TOC entry for every file.  When you specify this
6913 option, GCC will produce code that is slower and larger but which
6914 uses extremely little TOC space.  You may wish to use this option
6915 only on files that contain less frequently executed code.
6916
6917 @item -maix64
6918 @itemx -maix32
6919 @opindex maix64
6920 @opindex maix32
6921 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6922 @code{long} type, and the infrastructure needed to support them.
6923 Specifying @option{-maix64} implies @option{-mpowerpc64} and
6924 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
6925 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
6926
6927 @item -mxl-call
6928 @itemx -mno-xl-call
6929 @opindex mxl-call
6930 @opindex mno-xl-call
6931 On AIX, pass floating-point arguments to prototyped functions beyond the
6932 register save area (RSA) on the stack in addition to argument FPRs.  The
6933 AIX calling convention was extended but not initially documented to
6934 handle an obscure K&R C case of calling a function that takes the
6935 address of its arguments with fewer arguments than declared.  AIX XL
6936 compilers access floating point arguments which do not fit in the
6937 RSA from the stack when a subroutine is compiled without
6938 optimization.  Because always storing floating-point arguments on the
6939 stack is inefficient and rarely needed, this option is not enabled by
6940 default and only is necessary when calling subroutines compiled by AIX
6941 XL compilers without optimization.
6942
6943 @item -mpe
6944 @opindex mpe
6945 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
6946 application written to use message passing with special startup code to
6947 enable the application to run.  The system must have PE installed in the
6948 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6949 must be overridden with the @option{-specs=} option to specify the
6950 appropriate directory location.  The Parallel Environment does not
6951 support threads, so the @option{-mpe} option and the @option{-pthread}
6952 option are incompatible.
6953
6954 @item -msoft-float
6955 @itemx -mhard-float
6956 @opindex msoft-float
6957 @opindex mhard-float
6958 Generate code that does not use (uses) the floating-point register set.
6959 Software floating point emulation is provided if you use the
6960 @option{-msoft-float} option, and pass the option to GCC when linking.
6961
6962 @item -mmultiple
6963 @itemx -mno-multiple
6964 @opindex mmultiple
6965 @opindex mno-multiple
6966 Generate code that uses (does not use) the load multiple word
6967 instructions and the store multiple word instructions.  These
6968 instructions are generated by default on POWER systems, and not
6969 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
6970 endian PowerPC systems, since those instructions do not work when the
6971 processor is in little endian mode.  The exceptions are PPC740 and
6972 PPC750 which permit the instructions usage in little endian mode.
6973
6974 @item -mstring
6975 @itemx -mno-string
6976 @opindex mstring
6977 @opindex mno-string
6978 Generate code that uses (does not use) the load string instructions
6979 and the store string word instructions to save multiple registers and
6980 do small block moves.  These instructions are generated by default on
6981 POWER systems, and not generated on PowerPC systems.  Do not use
6982 @option{-mstring} on little endian PowerPC systems, since those
6983 instructions do not work when the processor is in little endian mode.
6984 The exceptions are PPC740 and PPC750 which permit the instructions
6985 usage in little endian mode.
6986
6987 @item -mupdate
6988 @itemx -mno-update
6989 @opindex mupdate
6990 @opindex mno-update
6991 Generate code that uses (does not use) the load or store instructions
6992 that update the base register to the address of the calculated memory
6993 location.  These instructions are generated by default.  If you use
6994 @option{-mno-update}, there is a small window between the time that the
6995 stack pointer is updated and the address of the previous frame is
6996 stored, which means code that walks the stack frame across interrupts or
6997 signals may get corrupted data.
6998
6999 @item -mfused-madd
7000 @itemx -mno-fused-madd
7001 @opindex mfused-madd
7002 @opindex mno-fused-madd
7003 Generate code that uses (does not use) the floating point multiply and
7004 accumulate instructions.  These instructions are generated by default if
7005 hardware floating is used.
7006
7007 @item -mno-bit-align
7008 @itemx -mbit-align
7009 @opindex mno-bit-align
7010 @opindex mbit-align
7011 On System V.4 and embedded PowerPC systems do not (do) force structures
7012 and unions that contain bit-fields to be aligned to the base type of the
7013 bit-field.
7014
7015 For example, by default a structure containing nothing but 8
7016 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7017 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7018 the structure would be aligned to a 1 byte boundary and be one byte in
7019 size.
7020
7021 @item -mno-strict-align
7022 @itemx -mstrict-align
7023 @opindex mno-strict-align
7024 @opindex mstrict-align
7025 On System V.4 and embedded PowerPC systems do not (do) assume that
7026 unaligned memory references will be handled by the system.
7027
7028 @item -mrelocatable
7029 @itemx -mno-relocatable
7030 @opindex mrelocatable
7031 @opindex mno-relocatable
7032 On embedded PowerPC systems generate code that allows (does not allow)
7033 the program to be relocated to a different address at runtime.  If you
7034 use @option{-mrelocatable} on any module, all objects linked together must
7035 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7036
7037 @item -mrelocatable-lib
7038 @itemx -mno-relocatable-lib
7039 @opindex mrelocatable-lib
7040 @opindex mno-relocatable-lib
7041 On embedded PowerPC systems generate code that allows (does not allow)
7042 the program to be relocated to a different address at runtime.  Modules
7043 compiled with @option{-mrelocatable-lib} can be linked with either modules
7044 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7045 with modules compiled with the @option{-mrelocatable} options.
7046
7047 @item -mno-toc
7048 @itemx -mtoc
7049 @opindex mno-toc
7050 @opindex mtoc
7051 On System V.4 and embedded PowerPC systems do not (do) assume that
7052 register 2 contains a pointer to a global area pointing to the addresses
7053 used in the program.
7054
7055 @item -mlittle
7056 @itemx -mlittle-endian
7057 @opindex mlittle
7058 @opindex mlittle-endian
7059 On System V.4 and embedded PowerPC systems compile code for the
7060 processor in little endian mode.  The @option{-mlittle-endian} option is
7061 the same as @option{-mlittle}.
7062
7063 @item -mbig
7064 @itemx -mbig-endian
7065 @opindex mbig
7066 @opindex mbig-endian
7067 On System V.4 and embedded PowerPC systems compile code for the
7068 processor in big endian mode.  The @option{-mbig-endian} option is
7069 the same as @option{-mbig}.
7070
7071 @item -mcall-sysv
7072 @opindex mcall-sysv
7073 On System V.4 and embedded PowerPC systems compile code using calling
7074 conventions that adheres to the March 1995 draft of the System V
7075 Application Binary Interface, PowerPC processor supplement.  This is the
7076 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7077
7078 @item -mcall-sysv-eabi
7079 @opindex mcall-sysv-eabi
7080 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7081
7082 @item -mcall-sysv-noeabi
7083 @opindex mcall-sysv-noeabi
7084 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7085
7086 @item -mcall-aix
7087 @opindex mcall-aix
7088 On System V.4 and embedded PowerPC systems compile code using calling
7089 conventions that are similar to those used on AIX@.  This is the
7090 default if you configured GCC using @samp{powerpc-*-eabiaix}.
7091
7092 @item -mcall-solaris
7093 @opindex mcall-solaris
7094 On System V.4 and embedded PowerPC systems compile code for the Solaris
7095 operating system.
7096
7097 @item -mcall-linux
7098 @opindex mcall-linux
7099 On System V.4 and embedded PowerPC systems compile code for the
7100 Linux-based GNU system.
7101
7102 @item -mcall-gnu
7103 @opindex mcall-gnu
7104 On System V.4 and embedded PowerPC systems compile code for the
7105 Hurd-based GNU system.
7106
7107 @item -mcall-netbsd
7108 @opindex mcall-netbsd
7109 On System V.4 and embedded PowerPC systems compile code for the
7110 NetBSD operating system.
7111
7112 @item -maix-struct-return
7113 @opindex maix-struct-return
7114 Return all structures in memory (as specified by the AIX ABI)@.
7115
7116 @item -msvr4-struct-return
7117 @opindex msvr4-struct-return
7118 Return structures smaller than 8 bytes in registers (as specified by the
7119 SVR4 ABI)@.
7120
7121 @item -mabi=altivec
7122 @opindex mabi=altivec
7123 Extend the current ABI with AltiVec ABI extensions.  This does not
7124 change the default ABI, instead it adds the AltiVec ABI extensions to
7125 the current ABI@.
7126
7127 @item -mabi=no-altivec
7128 @opindex mabi=no-altivec
7129 Disable AltiVec ABI extensions for the current ABI.
7130
7131 @item -mprototype
7132 @itemx -mno-prototype
7133 @opindex mprototype
7134 @opindex mno-prototype
7135 On System V.4 and embedded PowerPC systems assume that all calls to
7136 variable argument functions are properly prototyped.  Otherwise, the
7137 compiler must insert an instruction before every non prototyped call to
7138 set or clear bit 6 of the condition code register (@var{CR}) to
7139 indicate whether floating point values were passed in the floating point
7140 registers in case the function takes a variable arguments.  With
7141 @option{-mprototype}, only calls to prototyped variable argument functions
7142 will set or clear the bit.
7143
7144 @item -msim
7145 @opindex msim
7146 On embedded PowerPC systems, assume that the startup module is called
7147 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7148 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7149 configurations.
7150
7151 @item -mmvme
7152 @opindex mmvme
7153 On embedded PowerPC systems, assume that the startup module is called
7154 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7155 @file{libc.a}.
7156
7157 @item -mads
7158 @opindex mads
7159 On embedded PowerPC systems, assume that the startup module is called
7160 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7161 @file{libc.a}.
7162
7163 @item -myellowknife
7164 @opindex myellowknife
7165 On embedded PowerPC systems, assume that the startup module is called
7166 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7167 @file{libc.a}.
7168
7169 @item -mvxworks
7170 @opindex mvxworks
7171 On System V.4 and embedded PowerPC systems, specify that you are
7172 compiling for a VxWorks system.
7173
7174 @item -mwindiss
7175 @opindex mwindiss
7176 Specify that you are compiling for the WindISS simulation environment.
7177
7178 @item -memb
7179 @opindex memb
7180 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7181 header to indicate that @samp{eabi} extended relocations are used.
7182
7183 @item -meabi
7184 @itemx -mno-eabi
7185 @opindex meabi
7186 @opindex mno-eabi
7187 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7188 Embedded Applications Binary Interface (eabi) which is a set of
7189 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7190 means that the stack is aligned to an 8 byte boundary, a function
7191 @code{__eabi} is called to from @code{main} to set up the eabi
7192 environment, and the @option{-msdata} option can use both @code{r2} and
7193 @code{r13} to point to two separate small data areas.  Selecting
7194 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7195 do not call an initialization function from @code{main}, and the
7196 @option{-msdata} option will only use @code{r13} to point to a single
7197 small data area.  The @option{-meabi} option is on by default if you
7198 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7199
7200 @item -msdata=eabi
7201 @opindex msdata=eabi
7202 On System V.4 and embedded PowerPC systems, put small initialized
7203 @code{const} global and static data in the @samp{.sdata2} section, which
7204 is pointed to by register @code{r2}.  Put small initialized
7205 non-@code{const} global and static data in the @samp{.sdata} section,
7206 which is pointed to by register @code{r13}.  Put small uninitialized
7207 global and static data in the @samp{.sbss} section, which is adjacent to
7208 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7209 incompatible with the @option{-mrelocatable} option.  The
7210 @option{-msdata=eabi} option also sets the @option{-memb} option.
7211
7212 @item -msdata=sysv
7213 @opindex msdata=sysv
7214 On System V.4 and embedded PowerPC systems, put small global and static
7215 data in the @samp{.sdata} section, which is pointed to by register
7216 @code{r13}.  Put small uninitialized global and static data in the
7217 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7218 The @option{-msdata=sysv} option is incompatible with the
7219 @option{-mrelocatable} option.
7220
7221 @item -msdata=default
7222 @itemx -msdata
7223 @opindex msdata=default
7224 @opindex msdata
7225 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7226 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7227 same as @option{-msdata=sysv}.
7228
7229 @item -msdata-data
7230 @opindex msdata-data
7231 On System V.4 and embedded PowerPC systems, put small global and static
7232 data in the @samp{.sdata} section.  Put small uninitialized global and
7233 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7234 to address small data however.  This is the default behavior unless
7235 other @option{-msdata} options are used.
7236
7237 @item -msdata=none
7238 @itemx -mno-sdata
7239 @opindex msdata=none
7240 @opindex mno-sdata
7241 On embedded PowerPC systems, put all initialized global and static data
7242 in the @samp{.data} section, and all uninitialized data in the
7243 @samp{.bss} section.
7244
7245 @item -G @var{num}
7246 @opindex G
7247 @cindex smaller data references (PowerPC)
7248 @cindex .sdata/.sdata2 references (PowerPC)
7249 On embedded PowerPC systems, put global and static items less than or
7250 equal to @var{num} bytes into the small data or bss sections instead of
7251 the normal data or bss section.  By default, @var{num} is 8.  The
7252 @option{-G @var{num}} switch is also passed to the linker.
7253 All modules should be compiled with the same @option{-G @var{num}} value.
7254
7255 @item -mregnames
7256 @itemx -mno-regnames
7257 @opindex mregnames
7258 @opindex mno-regnames
7259 On System V.4 and embedded PowerPC systems do (do not) emit register
7260 names in the assembly language output using symbolic forms.
7261
7262 @item -mlongcall
7263 @itemx -mno-longcall
7264 @opindex mlongcall
7265 @opindex mno-longcall
7266 Default to making all function calls via pointers, so that functions
7267 which reside further than 64 megabytes (67,108,864 bytes) from the
7268 current location can be called.  This setting can be overridden by the
7269 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7270
7271 Some linkers are capable of detecting out-of-range calls and generating
7272 glue code on the fly.  On these systems, long calls are unnecessary and
7273 generate slower code.  As of this writing, the AIX linker can do this,
7274 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7275 to the GNU linker for 32-bit PowerPC systems as well.
7276
7277 In the future, we may cause GCC to ignore all longcall specifications
7278 when the linker is known to generate glue.
7279
7280 @item -pthread
7281 @opindex pthread
7282 Adds support for multithreading with the @dfn{pthreads} library.
7283 This option sets flags for both the preprocessor and linker.
7284
7285 @end table
7286
7287 @node Darwin Options
7288 @subsection Darwin Options
7289 @cindex Darwin options
7290 @table @gcctabopt
7291 @item -all_load    
7292 @opindex all_load   
7293 Loads all members of static archive libraries.
7294 See man ld(1) for more information.
7295
7296 @item -arch_errors_fatal
7297 @opindex arch_errors_fatal
7298 Cause the errors having to do with files that have the wrong architecture
7299 to be fatal.
7300
7301 @item -bind_at_load
7302 @opindex bind_at_load
7303 Causes the output file to be marked such that the dynamic linker will
7304 bind all undefined references when the file is loaded or launched.
7305
7306 @item -bundle     
7307 @opindex bundle
7308 Produce a Mach-o bundle format file.
7309 See man ld(1) for more information.
7310
7311 @item -bundle_loader @var{executable}
7312 @opindex bundle_loader
7313 This specifies the @var{executable} that will be loading the build
7314 output file being linked. See man ld(1) for more information.
7315
7316 @item -allowable_client  @var{client_name}
7317 @item -arch_only
7318
7319 @item -client_name       
7320 @item -compatibility_version
7321 @item -current_version    
7322 @item -dependency-file
7323 @item -dylib_file    
7324 @item -dylinker_install_name
7325 @item -dynamic
7326 @item -dynamiclib   
7327 @item -exported_symbols_list  
7328 @item -filelist
7329 @item -flat_namespace   
7330 @item -force_cpusubtype_ALL
7331 @item -force_flat_namespace   
7332 @item -headerpad_max_install_names
7333 @item -image_base  
7334 @item -init
7335 @item -install_name
7336 @item -keep_private_externs
7337 @item -multi_module
7338 @item -multiply_defined      
7339 @item -multiply_defined_unused      
7340 @item -noall_load  
7341 @item -nomultidefs
7342 @item -noprebind     
7343 @item -noseglinkedit
7344 @item -pagezero_size    
7345 @item -prebind
7346 @item -prebind_all_twolevel_modules
7347 @item -private_bundle
7348 @item -read_only_relocs
7349 @item -sectalign  
7350 @item -sectobjectsymbols    
7351 @item -whyload
7352 @item -seg1addr 
7353 @item -sectcreate
7354 @item -sectobjectsymbols
7355 @item -sectorder
7356 @item -seg_addr_table
7357 @item -seg_addr_table_filename
7358 @item -seglinkedit
7359 @item -segprot   
7360 @item -segs_read_only_addr
7361 @item -segs_read_write_addr
7362 @item -single_module   
7363 @item -static
7364 @item -sub_library
7365 @item -sub_umbrella 
7366 @item -twolevel_namespace
7367 @item -umbrella
7368 @item -undefined
7369 @item -unexported_symbols_list
7370 @item -weak_reference_mismatches
7371 @item -whatsloaded  
7372
7373 @opindex allowable_client
7374 @opindex arch_only    
7375 @opindex client_name
7376 @opindex compatibility_version
7377 @opindex current_version
7378 @opindex dependency-file
7379 @opindex dylib_file
7380 @opindex dylinker_install_name
7381 @opindex dynamic
7382 @opindex dynamiclib
7383 @opindex exported_symbols_list
7384 @opindex filelist  
7385 @opindex flat_namespace    
7386 @opindex force_cpusubtype_ALL
7387 @opindex force_flat_namespace
7388 @opindex headerpad_max_install_names
7389 @opindex image_base
7390 @opindex init     
7391 @opindex install_name
7392 @opindex keep_private_externs
7393 @opindex multi_module   
7394 @opindex multiply_defined
7395 @opindex multiply_defined_unused   
7396 @opindex noall_load  
7397 @opindex nomultidefs   
7398 @opindex noprebind
7399 @opindex noseglinkedit      
7400 @opindex pagezero_size
7401 @opindex prebind
7402 @opindex prebind_all_twolevel_modules
7403 @opindex private_bundle 
7404 @opindex read_only_relocs
7405 @opindex sectalign   
7406 @opindex sectobjectsymbols    
7407 @opindex whyload  
7408 @opindex seg1addr
7409 @opindex sectcreate       
7410 @opindex sectobjectsymbols 
7411 @opindex sectorder     
7412 @opindex seg_addr_table
7413 @opindex seg_addr_table_filename
7414 @opindex seglinkedit
7415 @opindex segprot
7416 @opindex segs_read_only_addr
7417 @opindex segs_read_write_addr
7418 @opindex single_module
7419 @opindex static
7420 @opindex sub_library
7421 @opindex sub_umbrella
7422 @opindex twolevel_namespace
7423 @opindex umbrella
7424 @opindex undefined
7425 @opindex unexported_symbols_list
7426 @opindex weak_reference_mismatches
7427 @opindex whatsloaded
7428
7429 This options are available for Darwin linker. Darwin linker man page
7430 describes them in detail.
7431 @end table
7432
7433
7434 @node RT Options
7435 @subsection IBM RT Options
7436 @cindex RT options
7437 @cindex IBM RT options
7438
7439 These @samp{-m} options are defined for the IBM RT PC:
7440
7441 @table @gcctabopt
7442 @item -min-line-mul
7443 @opindex min-line-mul
7444 Use an in-line code sequence for integer multiplies.  This is the
7445 default.
7446
7447 @item -mcall-lib-mul
7448 @opindex mcall-lib-mul
7449 Call @code{lmul$$} for integer multiples.
7450
7451 @item -mfull-fp-blocks
7452 @opindex mfull-fp-blocks
7453 Generate full-size floating point data blocks, including the minimum
7454 amount of scratch space recommended by IBM@.  This is the default.
7455
7456 @item -mminimum-fp-blocks
7457 @opindex mminimum-fp-blocks
7458 Do not include extra scratch space in floating point data blocks.  This
7459 results in smaller code, but slower execution, since scratch space must
7460 be allocated dynamically.
7461
7462 @cindex @file{stdarg.h} and RT PC
7463 @item -mfp-arg-in-fpregs
7464 @opindex mfp-arg-in-fpregs
7465 Use a calling sequence incompatible with the IBM calling convention in
7466 which floating point arguments are passed in floating point registers.
7467 Note that @code{stdarg.h} will not work with floating point operands
7468 if this option is specified.
7469
7470 @item -mfp-arg-in-gregs
7471 @opindex mfp-arg-in-gregs
7472 Use the normal calling convention for floating point arguments.  This is
7473 the default.
7474
7475 @item -mhc-struct-return
7476 @opindex mhc-struct-return
7477 Return structures of more than one word in memory, rather than in a
7478 register.  This provides compatibility with the MetaWare HighC (hc)
7479 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7480 with the Portable C Compiler (pcc).
7481
7482 @item -mnohc-struct-return
7483 @opindex mnohc-struct-return
7484 Return some structures of more than one word in registers, when
7485 convenient.  This is the default.  For compatibility with the
7486 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7487 option @option{-mhc-struct-return}.
7488 @end table
7489
7490 @node MIPS Options
7491 @subsection MIPS Options
7492 @cindex MIPS options
7493
7494 These @samp{-m} options are defined for the MIPS family of computers:
7495
7496 @table @gcctabopt
7497
7498 @item -march=@var{arch}
7499 @opindex march
7500 Generate code that will run on @var{arch}, which can be the name of a
7501 generic MIPS ISA, or the name of a particular processor.  The ISA names
7502 are: @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4}, @samp{mips32}
7503 and @samp{mips64}.  The processor names are: @samp{r2000},
7504 @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{vr4100}, @samp{vr4300},
7505 @samp{r4400}, @samp{r4600}, @samp{r4650}, @samp{vr5000}, @samp{r6000},
7506 @samp{r8000}, @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7507 @samp{orion}, and @samp{sb1}.  The special value @samp{from-abi} selects the
7508 most compatible architecture for the selected ABI (that is,
7509 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7510
7511 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7512 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7513 @samp{vr} may be written @samp{r}.
7514
7515 GCC defines two macros based on the value of this option.  The first
7516 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7517 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7518 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7519 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7520 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7521
7522 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7523 above.  In other words, it will have the full prefix and will not
7524 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7525 the macro names the resolved architecture (either @samp{"mips1"} or
7526 @samp{"mips3"}).  It names the default architecture when no
7527 @option{-march} option is given.
7528
7529 @item -mtune=@var{arch}
7530 @opindex mtune
7531 Optimize for @var{arch}.  Among other things, this option controls
7532 the way instructions are scheduled, and the perceived cost of arithmetic
7533 operations.  The list of @var{arch} values is the same as for
7534 @option{-march}.
7535
7536 When this option is not used, GCC will optimize for the processor
7537 specified by @option{-march}.  By using @option{-march} and
7538 @option{-mtune} together, it is possible to generate code that will
7539 run on a family of processors, but optimize the code for one
7540 particular member of that family.
7541
7542 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7543 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7544 @samp{-march} ones described above.
7545
7546 @item -mips1
7547 @opindex mips1
7548 Equivalent to @samp{-march=mips1}.
7549
7550 @item -mips2
7551 @opindex mips2
7552 Equivalent to @samp{-march=mips2}.
7553
7554 @item -mips3
7555 @opindex mips3
7556 Equivalent to @samp{-march=mips3}.
7557
7558 @item -mips4
7559 @opindex mips4
7560 Equivalent to @samp{-march=mips4}.
7561
7562 @item -mips32
7563 @opindex mips32
7564 Equivalent to @samp{-march=mips32}.
7565
7566 @item -mips64
7567 @opindex mips64
7568 Equivalent to @samp{-march=mips64}.
7569
7570 @item -mfused-madd
7571 @itemx -mno-fused-madd
7572 @opindex mfused-madd
7573 @opindex mno-fused-madd
7574 Generate code that uses (does not use) the floating point multiply and
7575 accumulate instructions, when they are available.  These instructions
7576 are generated by default if they are available, but this may be
7577 undesirable if the extra precision causes problems or on certain chips
7578 in the mode where denormals are rounded to zero where denormals
7579 generated by multiply and accumulate instructions cause exceptions
7580 anyway.
7581
7582 @item -mfp32
7583 @opindex mfp32
7584 Assume that floating point registers are 32 bits wide.
7585
7586 @item -mfp64
7587 @opindex mfp64
7588 Assume that floating point registers are 64 bits wide.
7589
7590 @item -mgp32
7591 @opindex mgp32
7592 Assume that general purpose registers are 32 bits wide.
7593
7594 @item -mgp64
7595 @opindex mgp64
7596 Assume that general purpose registers are 64 bits wide.
7597
7598 @item -mint64
7599 @opindex mint64
7600 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7601 explanation of the default, and the width of pointers.
7602
7603 @item -mlong64
7604 @opindex mlong64
7605 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7606 explanation of the default, and the width of pointers.
7607
7608 @item -mlong32
7609 @opindex mlong32
7610 Force long, int, and pointer types to be 32 bits wide.
7611
7612 The default size of ints, longs and pointers depends on the ABI@.  All
7613 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7614 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7615 are the same size as longs, or the same size as integer registers,
7616 whichever is smaller.
7617
7618 @item -mabi=32
7619 @itemx -mabi=o64
7620 @itemx -mabi=n32
7621 @itemx -mabi=64
7622 @itemx -mabi=eabi
7623 @itemx -mabi=meabi
7624 @opindex mabi=32
7625 @opindex mabi=o64
7626 @opindex mabi=n32
7627 @opindex mabi=64
7628 @opindex mabi=eabi
7629 @opindex mabi=meabi
7630 Generate code for the given ABI@.
7631
7632 Note that there are two embedded ABIs: @option{-mabi=eabi}
7633 selects the one defined by Cygnus while @option{-meabi=meabi}
7634 selects the one defined by MIPS@.  Both these ABIs have
7635 32-bit and 64-bit variants.  Normally, GCC will generate
7636 64-bit code when you select a 64-bit architecture, but you
7637 can use @option{-mgp32} to get 32-bit code instead.
7638
7639 @item -mmips-as
7640 @opindex mmips-as
7641 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7642 add normal debug information.  This is the default for all
7643 platforms except for the OSF/1 reference platform, using the OSF/rose
7644 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7645 switches are used, the @file{mips-tfile} program will encapsulate the
7646 stabs within MIPS ECOFF@.
7647
7648 @item -mgas
7649 @opindex mgas
7650 Generate code for the GNU assembler.  This is the default on the OSF/1
7651 reference platform, using the OSF/rose object format.  Also, this is
7652 the default if the configure option @option{--with-gnu-as} is used.
7653
7654 @item -msplit-addresses
7655 @itemx -mno-split-addresses
7656 @opindex msplit-addresses
7657 @opindex mno-split-addresses
7658 Generate code to load the high and low parts of address constants separately.
7659 This allows GCC to optimize away redundant loads of the high order
7660 bits of addresses.  This optimization requires GNU as and GNU ld.
7661 This optimization is enabled by default for some embedded targets where
7662 GNU as and GNU ld are standard.
7663
7664 @item -mrnames
7665 @itemx -mno-rnames
7666 @opindex mrnames
7667 @opindex mno-rnames
7668 The @option{-mrnames} switch says to output code using the MIPS software
7669 names for the registers, instead of the hardware names (ie, @var{a0}
7670 instead of @var{$4}).  The only known assembler that supports this option
7671 is the Algorithmics assembler.
7672
7673 @item -mgpopt
7674 @itemx -mno-gpopt
7675 @opindex mgpopt
7676 @opindex mno-gpopt
7677 The @option{-mgpopt} switch says to write all of the data declarations
7678 before the instructions in the text section, this allows the MIPS
7679 assembler to generate one word memory references instead of using two
7680 words for short global or static data items.  This is on by default if
7681 optimization is selected.
7682
7683 @item -mstats
7684 @itemx -mno-stats
7685 @opindex mstats
7686 @opindex mno-stats
7687 For each non-inline function processed, the @option{-mstats} switch
7688 causes the compiler to emit one line to the standard error file to
7689 print statistics about the program (number of registers saved, stack
7690 size, etc.).
7691
7692 @item -mmemcpy
7693 @itemx -mno-memcpy
7694 @opindex mmemcpy
7695 @opindex mno-memcpy
7696 The @option{-mmemcpy} switch makes all block moves call the appropriate
7697 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7698 generating inline code.
7699
7700 @item -mmips-tfile
7701 @itemx -mno-mips-tfile
7702 @opindex mmips-tfile
7703 @opindex mno-mips-tfile
7704 The @option{-mno-mips-tfile} switch causes the compiler not
7705 postprocess the object file with the @file{mips-tfile} program,
7706 after the MIPS assembler has generated it to add debug support.  If
7707 @file{mips-tfile} is not run, then no local variables will be
7708 available to the debugger.  In addition, @file{stage2} and
7709 @file{stage3} objects will have the temporary file names passed to the
7710 assembler embedded in the object file, which means the objects will
7711 not compare the same.  The @option{-mno-mips-tfile} switch should only
7712 be used when there are bugs in the @file{mips-tfile} program that
7713 prevents compilation.
7714
7715 @item -msoft-float
7716 @opindex msoft-float
7717 Generate output containing library calls for floating point.
7718 @strong{Warning:} the requisite libraries are not part of GCC@.
7719 Normally the facilities of the machine's usual C compiler are used, but
7720 this can't be done directly in cross-compilation.  You must make your
7721 own arrangements to provide suitable library functions for
7722 cross-compilation.
7723
7724 @item -mhard-float
7725 @opindex mhard-float
7726 Generate output containing floating point instructions.  This is the
7727 default if you use the unmodified sources.
7728
7729 @item -mabicalls
7730 @itemx -mno-abicalls
7731 @opindex mabicalls
7732 @opindex mno-abicalls
7733 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7734 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7735 position independent code.
7736
7737 @item -mlong-calls
7738 @itemx -mno-long-calls
7739 @opindex mlong-calls
7740 @opindex mno-long-calls
7741 Do all calls with the @samp{JALR} instruction, which requires
7742 loading up a function's address into a register before the call.
7743 You need to use this switch, if you call outside of the current
7744 512 megabyte segment to functions that are not through pointers.
7745
7746 @item -mhalf-pic
7747 @itemx -mno-half-pic
7748 @opindex mhalf-pic
7749 @opindex mno-half-pic
7750 Put pointers to extern references into the data section and load them
7751 up, rather than put the references in the text section.
7752
7753 @item -membedded-pic
7754 @itemx -mno-embedded-pic
7755 @opindex membedded-pic
7756 @opindex mno-embedded-pic
7757 Generate PIC code suitable for some embedded systems.  All calls are
7758 made using PC relative address, and all data is addressed using the $gp
7759 register.  No more than 65536 bytes of global data may be used.  This
7760 requires GNU as and GNU ld which do most of the work.  This currently
7761 only works on targets which use ECOFF; it does not work with ELF@.
7762
7763 @item -membedded-data
7764 @itemx -mno-embedded-data
7765 @opindex membedded-data
7766 @opindex mno-embedded-data
7767 Allocate variables to the read-only data section first if possible, then
7768 next in the small data section if possible, otherwise in data.  This gives
7769 slightly slower code than the default, but reduces the amount of RAM required
7770 when executing, and thus may be preferred for some embedded systems.
7771
7772 @item -muninit-const-in-rodata
7773 @itemx -mno-uninit-const-in-rodata
7774 @opindex muninit-const-in-rodata
7775 @opindex mno-uninit-const-in-rodata
7776 When used together with @option{-membedded-data}, it will always store uninitialized
7777 const variables in the read-only data section.
7778
7779 @item -msingle-float
7780 @itemx -mdouble-float
7781 @opindex msingle-float
7782 @opindex mdouble-float
7783 The @option{-msingle-float} switch tells gcc to assume that the floating
7784 point coprocessor only supports single precision operations, as on the
7785 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7786 double precision operations.  This is the default.
7787
7788 @item -mmad
7789 @itemx -mno-mad
7790 @opindex mmad
7791 @opindex mno-mad
7792 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7793 as on the @samp{r4650} chip.
7794
7795 @item -m4650
7796 @opindex m4650
7797 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7798 @option{-mcpu=r4650}.
7799
7800 @item -mips16
7801 @itemx -mno-mips16
7802 @opindex mips16
7803 @opindex mno-mips16
7804 Enable 16-bit instructions.
7805
7806 @item -mentry
7807 @opindex mentry
7808 Use the entry and exit pseudo ops.  This option can only be used with
7809 @option{-mips16}.
7810
7811 @item -EL
7812 @opindex EL
7813 Compile code for the processor in little endian mode.
7814 The requisite libraries are assumed to exist.
7815
7816 @item -EB
7817 @opindex EB
7818 Compile code for the processor in big endian mode.
7819 The requisite libraries are assumed to exist.
7820
7821 @item -G @var{num}
7822 @opindex G
7823 @cindex smaller data references (MIPS)
7824 @cindex gp-relative references (MIPS)
7825 Put global and static items less than or equal to @var{num} bytes into
7826 the small data or bss sections instead of the normal data or bss
7827 section.  This allows the assembler to emit one word memory reference
7828 instructions based on the global pointer (@var{gp} or @var{$28}),
7829 instead of the normal two words used.  By default, @var{num} is 8 when
7830 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
7831 @option{-G @var{num}} switch is also passed to the assembler and linker.
7832 All modules should be compiled with the same @option{-G @var{num}}
7833 value.
7834
7835 @item -nocpp
7836 @opindex nocpp
7837 Tell the MIPS assembler to not run its preprocessor over user
7838 assembler files (with a @samp{.s} suffix) when assembling them.
7839
7840 @item -mfix7000
7841 @opindex mfix7000
7842 Pass an option to gas which will cause nops to be inserted if
7843 the read of the destination register of an mfhi or mflo instruction
7844 occurs in the following two instructions.
7845
7846 @item -no-crt0
7847 @opindex no-crt0
7848 Do not include the default crt0.
7849
7850 @item -mflush-func=@var{func}
7851 @itemx -mno-flush-func
7852 @opindex mflush-func
7853 Specifies the function to call to flush the I and D caches, or to not
7854 call any such function.  If called, the function must take the same
7855 arguments as the common @code{_flush_func()}, that is, the address of the
7856 memory range for which the cache is being flushed, the size of the
7857 memory range, and the number 3 (to flush both caches).  The default
7858 depends on the target gcc was configured for, but commonly is either
7859 @samp{_flush_func} or @samp{__cpu_flush}.
7860
7861 @item -mbranch-likely
7862 @itemx -mno-branch-likely
7863 @opindex mbranch-likely
7864 @opindex mno-branch-likely
7865 Enable or disable use of Branch Likely instructions, regardless of the
7866 default for the selected architecture.  By default, Branch Likely
7867 instructions may be generated if they are supported by the selected
7868 architecture.  An exception is for the MIPS32 and MIPS64 architectures
7869 and processors which implement those architectures; for those, Branch
7870 Likely instructions will not be generated by default because the MIPS32
7871 and MIPS64 architectures specifically deprecate their use.
7872 @end table
7873
7874 @node i386 and x86-64 Options
7875 @subsection Intel 386 and AMD x86-64 Options
7876 @cindex i386 Options
7877 @cindex x86-64 Options
7878 @cindex Intel 386 Options
7879 @cindex AMD x86-64 Options
7880
7881 These @samp{-m} options are defined for the i386 and x86-64 family of
7882 computers:
7883
7884 @table @gcctabopt
7885 @item -mcpu=@var{cpu-type}
7886 @opindex mcpu
7887 Tune to @var{cpu-type} everything applicable about the generated code, except
7888 for the ABI and the set of available instructions.  The choices for
7889 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
7890 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
7891 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
7892 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
7893 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8} and @samp{c3}.
7894
7895 While picking a specific @var{cpu-type} will schedule things appropriately
7896 for that particular chip, the compiler will not generate any code that
7897 does not run on the i386 without the @option{-march=@var{cpu-type}} option
7898 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
7899 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
7900 AMD chips as opposed to the Intel ones.
7901
7902 @item -march=@var{cpu-type}
7903 @opindex march
7904 Generate instructions for the machine type @var{cpu-type}.  The choices
7905 for @var{cpu-type} are the same as for @option{-mcpu}.  Moreover,
7906 specifying @option{-march=@var{cpu-type}} implies @option{-mcpu=@var{cpu-type}}.
7907
7908 @item -m386
7909 @itemx -m486
7910 @itemx -mpentium
7911 @itemx -mpentiumpro
7912 @opindex m386
7913 @opindex m486
7914 @opindex mpentium
7915 @opindex mpentiumpro
7916 These options are synonyms for @option{-mcpu=i386}, @option{-mcpu=i486},
7917 @option{-mcpu=pentium}, and @option{-mcpu=pentiumpro} respectively.
7918 These synonyms are deprecated.
7919
7920 @item -mfpmath=@var{unit}
7921 @opindex march
7922 generate floating point arithmetics for selected unit @var{unit}.  the choices
7923 for @var{unit} are:
7924
7925 @table @samp
7926 @item 387
7927 Use the standard 387 floating point coprocessor present majority of chips and
7928 emulated otherwise.  Code compiled with this option will run almost everywhere.
7929 The temporary results are computed in 80bit precision instead of precision
7930 specified by the type resulting in slightly different results compared to most
7931 of other chips. See @option{-ffloat-store} for more detailed description.
7932
7933 This is the default choice for i386 compiler.
7934
7935 @item sse
7936 Use scalar floating point instructions present in the SSE instruction set.
7937 This instruction set is supported by Pentium3 and newer chips, in the AMD line
7938 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
7939 instruction set supports only single precision arithmetics, thus the double and
7940 extended precision arithmetics is still done using 387.  Later version, present
7941 only in Pentium4 and the future AMD x86-64 chips supports double precision
7942 arithmetics too.
7943
7944 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
7945 @option{-msse2} switches to enable SSE extensions and make this option
7946 effective.  For x86-64 compiler, these extensions are enabled by default.
7947
7948 The resulting code should be considerably faster in majority of cases and avoid
7949 the numerical instability problems of 387 code, but may break some existing
7950 code that expects temporaries to be 80bit.
7951
7952 This is the default choice for x86-64 compiler.
7953
7954 @item sse,387
7955 Attempt to utilize both instruction sets at once.  This effectively double the
7956 amount of available registers and on chips with separate execution units for
7957 387 and SSE the execution resources too.  Use this option with care, as it is
7958 still experimental, because gcc register allocator does not model separate
7959 functional units well resulting in instable performance.
7960 @end table
7961
7962 @item -masm=@var{dialect}
7963 @opindex masm=@var{dialect}
7964 Output asm instructions using selected @var{dialect}. Supported choices are
7965 @samp{intel} or @samp{att} (the default one).
7966
7967 @item -mieee-fp
7968 @itemx -mno-ieee-fp
7969 @opindex mieee-fp
7970 @opindex mno-ieee-fp
7971 Control whether or not the compiler uses IEEE floating point
7972 comparisons.  These handle correctly the case where the result of a
7973 comparison is unordered.
7974
7975 @item -msoft-float
7976 @opindex msoft-float
7977 Generate output containing library calls for floating point.
7978 @strong{Warning:} the requisite libraries are not part of GCC@.
7979 Normally the facilities of the machine's usual C compiler are used, but
7980 this can't be done directly in cross-compilation.  You must make your
7981 own arrangements to provide suitable library functions for
7982 cross-compilation.
7983
7984 On machines where a function returns floating point results in the 80387
7985 register stack, some floating point opcodes may be emitted even if
7986 @option{-msoft-float} is used.
7987
7988 @item -mno-fp-ret-in-387
7989 @opindex mno-fp-ret-in-387
7990 Do not use the FPU registers for return values of functions.
7991
7992 The usual calling convention has functions return values of types
7993 @code{float} and @code{double} in an FPU register, even if there
7994 is no FPU@.  The idea is that the operating system should emulate
7995 an FPU@.
7996
7997 The option @option{-mno-fp-ret-in-387} causes such values to be returned
7998 in ordinary CPU registers instead.
7999
8000 @item -mno-fancy-math-387
8001 @opindex mno-fancy-math-387
8002 Some 387 emulators do not support the @code{sin}, @code{cos} and
8003 @code{sqrt} instructions for the 387.  Specify this option to avoid
8004 generating those instructions.  This option is the default on FreeBSD,
8005 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8006 indicates that the target cpu will always have an FPU and so the
8007 instruction will not need emulation.  As of revision 2.6.1, these
8008 instructions are not generated unless you also use the
8009 @option{-funsafe-math-optimizations} switch.
8010
8011 @item -malign-double
8012 @itemx -mno-align-double
8013 @opindex malign-double
8014 @opindex mno-align-double
8015 Control whether GCC aligns @code{double}, @code{long double}, and
8016 @code{long long} variables on a two word boundary or a one word
8017 boundary.  Aligning @code{double} variables on a two word boundary will
8018 produce code that runs somewhat faster on a @samp{Pentium} at the
8019 expense of more memory.
8020
8021 @strong{Warning:} if you use the @samp{-malign-double} switch,
8022 structures containing the above types will be aligned differently than
8023 the published application binary interface specifications for the 386.
8024
8025 @item -m128bit-long-double
8026 @opindex m128bit-long-double
8027 Control the size of @code{long double} type. i386 application binary interface
8028 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
8029 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
8030 impossible to reach with 12 byte long doubles in the array accesses.
8031
8032 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
8033 structures and arrays containing @code{long double} will change their size as
8034 well as function calling convention for function taking @code{long double}
8035 will be modified.
8036
8037 @item -m96bit-long-double
8038 @opindex m96bit-long-double
8039 Set the size of @code{long double} to 96 bits as required by the i386
8040 application binary interface.  This is the default.
8041
8042 @item -msvr3-shlib
8043 @itemx -mno-svr3-shlib
8044 @opindex msvr3-shlib
8045 @opindex mno-svr3-shlib
8046 Control whether GCC places uninitialized local variables into the
8047 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8048 into @code{bss}.  These options are meaningful only on System V Release 3.
8049
8050 @item -mrtd
8051 @opindex mrtd
8052 Use a different function-calling convention, in which functions that
8053 take a fixed number of arguments return with the @code{ret} @var{num}
8054 instruction, which pops their arguments while returning.  This saves one
8055 instruction in the caller since there is no need to pop the arguments
8056 there.
8057
8058 You can specify that an individual function is called with this calling
8059 sequence with the function attribute @samp{stdcall}.  You can also
8060 override the @option{-mrtd} option by using the function attribute
8061 @samp{cdecl}.  @xref{Function Attributes}.
8062
8063 @strong{Warning:} this calling convention is incompatible with the one
8064 normally used on Unix, so you cannot use it if you need to call
8065 libraries compiled with the Unix compiler.
8066
8067 Also, you must provide function prototypes for all functions that
8068 take variable numbers of arguments (including @code{printf});
8069 otherwise incorrect code will be generated for calls to those
8070 functions.
8071
8072 In addition, seriously incorrect code will result if you call a
8073 function with too many arguments.  (Normally, extra arguments are
8074 harmlessly ignored.)
8075
8076 @item -mregparm=@var{num}
8077 @opindex mregparm
8078 Control how many registers are used to pass integer arguments.  By
8079 default, no registers are used to pass arguments, and at most 3
8080 registers can be used.  You can control this behavior for a specific
8081 function by using the function attribute @samp{regparm}.
8082 @xref{Function Attributes}.
8083
8084 @strong{Warning:} if you use this switch, and
8085 @var{num} is nonzero, then you must build all modules with the same
8086 value, including any libraries.  This includes the system libraries and
8087 startup modules.
8088
8089 @item -mpreferred-stack-boundary=@var{num}
8090 @opindex mpreferred-stack-boundary
8091 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8092 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8093 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8094 size (@option{-Os}), in which case the default is the minimum correct
8095 alignment (4 bytes for x86, and 8 bytes for x86-64).
8096
8097 On Pentium and PentiumPro, @code{double} and @code{long double} values
8098 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8099 suffer significant run time performance penalties.  On Pentium III, the
8100 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8101 penalties if it is not 16 byte aligned.
8102
8103 To ensure proper alignment of this values on the stack, the stack boundary
8104 must be as aligned as that required by any value stored on the stack.
8105 Further, every function must be generated such that it keeps the stack
8106 aligned.  Thus calling a function compiled with a higher preferred
8107 stack boundary from a function compiled with a lower preferred stack
8108 boundary will most likely misalign the stack.  It is recommended that
8109 libraries that use callbacks always use the default setting.
8110
8111 This extra alignment does consume extra stack space, and generally
8112 increases code size.  Code that is sensitive to stack space usage, such
8113 as embedded systems and operating system kernels, may want to reduce the
8114 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8115
8116 @item -mmmx
8117 @itemx -mno-mmx
8118 @item -msse
8119 @itemx -mno-sse
8120 @item -msse2
8121 @itemx -mno-sse2
8122 @item -m3dnow
8123 @itemx -mno-3dnow
8124 @opindex mmmx
8125 @opindex mno-mmx
8126 @opindex msse
8127 @opindex mno-sse
8128 @opindex m3dnow
8129 @opindex mno-3dnow
8130 These switches enable or disable the use of built-in functions that allow
8131 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8132
8133 @xref{X86 Built-in Functions}, for details of the functions enabled
8134 and disabled by these switches.
8135
8136 To have SSE/SSE2 instructions generated automatically from floating-point
8137 code, see @option{-mfpmath=sse}.
8138
8139 @item -mpush-args
8140 @itemx -mno-push-args
8141 @opindex mpush-args
8142 @opindex mno-push-args
8143 Use PUSH operations to store outgoing parameters.  This method is shorter
8144 and usually equally fast as method using SUB/MOV operations and is enabled
8145 by default.  In some cases disabling it may improve performance because of
8146 improved scheduling and reduced dependencies.
8147
8148 @item -maccumulate-outgoing-args
8149 @opindex maccumulate-outgoing-args
8150 If enabled, the maximum amount of space required for outgoing arguments will be
8151 computed in the function prologue.  This is faster on most modern CPUs
8152 because of reduced dependencies, improved scheduling and reduced stack usage
8153 when preferred stack boundary is not equal to 2.  The drawback is a notable
8154 increase in code size.  This switch implies @option{-mno-push-args}.
8155
8156 @item -mthreads
8157 @opindex mthreads
8158 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8159 on thread-safe exception handling must compile and link all code with the
8160 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8161 @option{-D_MT}; when linking, it links in a special thread helper library
8162 @option{-lmingwthrd} which cleans up per thread exception handling data.
8163
8164 @item -mno-align-stringops
8165 @opindex mno-align-stringops
8166 Do not align destination of inlined string operations.  This switch reduces
8167 code size and improves performance in case the destination is already aligned,
8168 but gcc don't know about it.
8169
8170 @item -minline-all-stringops
8171 @opindex minline-all-stringops
8172 By default GCC inlines string operations only when destination is known to be
8173 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8174 size, but may improve performance of code that depends on fast memcpy, strlen
8175 and memset for short lengths.
8176
8177 @item -momit-leaf-frame-pointer
8178 @opindex momit-leaf-frame-pointer
8179 Don't keep the frame pointer in a register for leaf functions.  This
8180 avoids the instructions to save, set up and restore frame pointers and
8181 makes an extra register available in leaf functions.  The option
8182 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8183 which might make debugging harder.
8184 @end table
8185
8186 These @samp{-m} switches are supported in addition to the above
8187 on AMD x86-64 processors in 64-bit environments.
8188
8189 @table @gcctabopt
8190 @item -m32
8191 @itemx -m64
8192 @opindex m32
8193 @opindex m64
8194 Generate code for a 32-bit or 64-bit environment.
8195 The 32-bit environment sets int, long and pointer to 32 bits and
8196 generates code that runs on any i386 system.
8197 The 64-bit environment sets int to 32 bits and long and pointer
8198 to 64 bits and generates code for AMD's x86-64 architecture.
8199
8200 @item -mno-red-zone
8201 @opindex no-red-zone
8202 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8203 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8204 stack pointer that will not be modified by signal or interrupt handlers
8205 and therefore can be used for temporary data without adjusting the stack
8206 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8207
8208 @item -mcmodel=small
8209 @opindex mcmodel=small
8210 Generate code for the small code model: the program and its symbols must
8211 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8212 Programs can be statically or dynamically linked.  This is the default
8213 code model.
8214
8215 @item -mcmodel=kernel
8216 @opindex mcmodel=kernel
8217 Generate code for the kernel code model.  The kernel runs in the
8218 negative 2 GB of the address space.
8219 This model has to be used for Linux kernel code.
8220
8221 @item -mcmodel=medium
8222 @opindex mcmodel=medium
8223 Generate code for the medium model: The program is linked in the lower 2
8224 GB of the address space but symbols can be located anywhere in the
8225 address space.  Programs can be statically or dynamically linked, but
8226 building of shared libraries are not supported with the medium model.
8227
8228 @item -mcmodel=large
8229 @opindex mcmodel=large
8230 Generate code for the large model: This model makes no assumptions
8231 about addresses and sizes of sections.  Currently GCC does not implement
8232 this model.
8233 @end table
8234
8235 @node HPPA Options
8236 @subsection HPPA Options
8237 @cindex HPPA Options
8238
8239 These @samp{-m} options are defined for the HPPA family of computers:
8240
8241 @table @gcctabopt
8242 @item -march=@var{architecture-type}
8243 @opindex march
8244 Generate code for the specified architecture.  The choices for
8245 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8246 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8247 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8248 architecture option for your machine.  Code compiled for lower numbered
8249 architectures will run on higher numbered architectures, but not the
8250 other way around.
8251
8252 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8253 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8254 support.
8255
8256 @item -mpa-risc-1-0
8257 @itemx -mpa-risc-1-1
8258 @itemx -mpa-risc-2-0
8259 @opindex mpa-risc-1-0
8260 @opindex mpa-risc-1-1
8261 @opindex mpa-risc-2-0
8262 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8263
8264 @item -mbig-switch
8265 @opindex mbig-switch
8266 Generate code suitable for big switch tables.  Use this option only if
8267 the assembler/linker complain about out of range branches within a switch
8268 table.
8269
8270 @item -mjump-in-delay
8271 @opindex mjump-in-delay
8272 Fill delay slots of function calls with unconditional jump instructions
8273 by modifying the return pointer for the function call to be the target
8274 of the conditional jump.
8275
8276 @item -mdisable-fpregs
8277 @opindex mdisable-fpregs
8278 Prevent floating point registers from being used in any manner.  This is
8279 necessary for compiling kernels which perform lazy context switching of
8280 floating point registers.  If you use this option and attempt to perform
8281 floating point operations, the compiler will abort.
8282
8283 @item -mdisable-indexing
8284 @opindex mdisable-indexing
8285 Prevent the compiler from using indexing address modes.  This avoids some
8286 rather obscure problems when compiling MIG generated code under MACH@.
8287
8288 @item -mno-space-regs
8289 @opindex mno-space-regs
8290 Generate code that assumes the target has no space registers.  This allows
8291 GCC to generate faster indirect calls and use unscaled index address modes.
8292
8293 Such code is suitable for level 0 PA systems and kernels.
8294
8295 @item -mfast-indirect-calls
8296 @opindex mfast-indirect-calls
8297 Generate code that assumes calls never cross space boundaries.  This
8298 allows GCC to emit code which performs faster indirect calls.
8299
8300 This option will not work in the presence of shared libraries or nested
8301 functions.
8302
8303 @item -mlong-load-store
8304 @opindex mlong-load-store
8305 Generate 3-instruction load and store sequences as sometimes required by
8306 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8307 the HP compilers.
8308
8309 @item -mportable-runtime
8310 @opindex mportable-runtime
8311 Use the portable calling conventions proposed by HP for ELF systems.
8312
8313 @item -mgas
8314 @opindex mgas
8315 Enable the use of assembler directives only GAS understands.
8316
8317 @item -mschedule=@var{cpu-type}
8318 @opindex mschedule
8319 Schedule code according to the constraints for the machine type
8320 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8321 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8322 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8323 proper scheduling option for your machine.  The default scheduling is
8324 @samp{8000}.
8325
8326 @item -mlinker-opt
8327 @opindex mlinker-opt
8328 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8329 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8330 linkers in which they give bogus error messages when linking some programs.
8331
8332 @item -msoft-float
8333 @opindex msoft-float
8334 Generate output containing library calls for floating point.
8335 @strong{Warning:} the requisite libraries are not available for all HPPA
8336 targets.  Normally the facilities of the machine's usual C compiler are
8337 used, but this cannot be done directly in cross-compilation.  You must make
8338 your own arrangements to provide suitable library functions for
8339 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8340 does provide software floating point support.
8341
8342 @option{-msoft-float} changes the calling convention in the output file;
8343 therefore, it is only useful if you compile @emph{all} of a program with
8344 this option.  In particular, you need to compile @file{libgcc.a}, the
8345 library that comes with GCC, with @option{-msoft-float} in order for
8346 this to work.
8347
8348 @item -msio
8349 @opindex msio
8350 Generate the predefine, @code{_SIO}, for server IO.  The default is
8351 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8352 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8353 options are available under HP-UX and HI-UX.
8354
8355 @item -mgnu-ld
8356 @opindex gnu-ld
8357 Use GNU ld specific options.  This passes @option{-shared} to ld when
8358 building a shared library.  It is the default when GCC is configured,
8359 explicitly or implicitly, with the GNU linker.  This option does not
8360 have any affect on which ld is called, it only changes what parameters
8361 are passed to that ld.  The ld that is called is determined by the
8362 @option{--with-ld} configure option, gcc's program search path, and
8363 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8364 using @samp{which `gcc -print-prog-name=ld`}.
8365
8366 @item -mhp-ld
8367 @opindex hp-ld
8368 Use HP ld specific options.  This passes @option{-b} to ld when building
8369 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8370 links.  It is the default when GCC is configured, explicitly or
8371 implicitly, with the HP linker.  This option does not have any affect on
8372 which ld is called, it only changes what parameters are passed to that
8373 ld.  The ld that is called is determined by the @option{--with-ld}
8374 configure option, gcc's program search path, and finally by the user's
8375 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8376 `gcc -print-prog-name=ld`}.
8377
8378 @item -mlong-calls
8379 @opindex mno-long-calls
8380 Generate code that uses long call sequences.  This ensures that a call
8381 is always able to reach linker generated stubs.  The default is to generate
8382 long calls only when the distance from the call site to the beginning
8383 of the function or translation unit, as the case may be, exceeds a
8384 predefined limit set by the branch type being used.  The limits for
8385 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8386 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8387 240,000 bytes.
8388
8389 Distances are measured from the beginning of functions when using the
8390 @option{-ffunction-sections} option, or when using the @option{-mgas}
8391 and @option{-mno-portable-runtime} options together under HP-UX with
8392 the SOM linker.
8393
8394 It is normally not desirable to use this option as it will degrade
8395 performance.  However, it may be useful in large applications,
8396 particularly when partial linking is used to build the application.
8397
8398 The types of long calls used depends on the capabilities of the
8399 assembler and linker, and the type of code being generated.  The
8400 impact on systems that support long absolute calls, and long pic
8401 symbol-difference or pc-relative calls should be relatively small.
8402 However, an indirect call is used on 32-bit ELF systems in pic code
8403 and it is quite long.
8404
8405 @end table
8406
8407 @node Intel 960 Options
8408 @subsection Intel 960 Options
8409
8410 These @samp{-m} options are defined for the Intel 960 implementations:
8411
8412 @table @gcctabopt
8413 @item -m@var{cpu-type}
8414 @opindex mka
8415 @opindex mkb
8416 @opindex mmc
8417 @opindex mca
8418 @opindex mcf
8419 @opindex msa
8420 @opindex msb
8421 Assume the defaults for the machine type @var{cpu-type} for some of
8422 the other options, including instruction scheduling, floating point
8423 support, and addressing modes.  The choices for @var{cpu-type} are
8424 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8425 @samp{sa}, and @samp{sb}.
8426 The default is
8427 @samp{kb}.
8428
8429 @item -mnumerics
8430 @itemx -msoft-float
8431 @opindex mnumerics
8432 @opindex msoft-float
8433 The @option{-mnumerics} option indicates that the processor does support
8434 floating-point instructions.  The @option{-msoft-float} option indicates
8435 that floating-point support should not be assumed.
8436
8437 @item -mleaf-procedures
8438 @itemx -mno-leaf-procedures
8439 @opindex mleaf-procedures
8440 @opindex mno-leaf-procedures
8441 Do (or do not) attempt to alter leaf procedures to be callable with the
8442 @code{bal} instruction as well as @code{call}.  This will result in more
8443 efficient code for explicit calls when the @code{bal} instruction can be
8444 substituted by the assembler or linker, but less efficient code in other
8445 cases, such as calls via function pointers, or using a linker that doesn't
8446 support this optimization.
8447
8448 @item -mtail-call
8449 @itemx -mno-tail-call
8450 @opindex mtail-call
8451 @opindex mno-tail-call
8452 Do (or do not) make additional attempts (beyond those of the
8453 machine-independent portions of the compiler) to optimize tail-recursive
8454 calls into branches.  You may not want to do this because the detection of
8455 cases where this is not valid is not totally complete.  The default is
8456 @option{-mno-tail-call}.
8457
8458 @item -mcomplex-addr
8459 @itemx -mno-complex-addr
8460 @opindex mcomplex-addr
8461 @opindex mno-complex-addr
8462 Assume (or do not assume) that the use of a complex addressing mode is a
8463 win on this implementation of the i960.  Complex addressing modes may not
8464 be worthwhile on the K-series, but they definitely are on the C-series.
8465 The default is currently @option{-mcomplex-addr} for all processors except
8466 the CB and CC@.
8467
8468 @item -mcode-align
8469 @itemx -mno-code-align
8470 @opindex mcode-align
8471 @opindex mno-code-align
8472 Align code to 8-byte boundaries for faster fetching (or don't bother).
8473 Currently turned on by default for C-series implementations only.
8474
8475 @ignore
8476 @item -mclean-linkage
8477 @itemx -mno-clean-linkage
8478 @opindex mclean-linkage
8479 @opindex mno-clean-linkage
8480 These options are not fully implemented.
8481 @end ignore
8482
8483 @item -mic-compat
8484 @itemx -mic2.0-compat
8485 @itemx -mic3.0-compat
8486 @opindex mic-compat
8487 @opindex mic2.0-compat
8488 @opindex mic3.0-compat
8489 Enable compatibility with iC960 v2.0 or v3.0.
8490
8491 @item -masm-compat
8492 @itemx -mintel-asm
8493 @opindex masm-compat
8494 @opindex mintel-asm
8495 Enable compatibility with the iC960 assembler.
8496
8497 @item -mstrict-align
8498 @itemx -mno-strict-align
8499 @opindex mstrict-align
8500 @opindex mno-strict-align
8501 Do not permit (do permit) unaligned accesses.
8502
8503 @item -mold-align
8504 @opindex mold-align
8505 Enable structure-alignment compatibility with Intel's gcc release version
8506 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8507
8508 @item -mlong-double-64
8509 @opindex mlong-double-64
8510 Implement type @samp{long double} as 64-bit floating point numbers.
8511 Without the option @samp{long double} is implemented by 80-bit
8512 floating point numbers.  The only reason we have it because there is
8513 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8514 is only useful for people using soft-float targets.  Otherwise, we
8515 should recommend against use of it.
8516
8517 @end table
8518
8519 @node DEC Alpha Options
8520 @subsection DEC Alpha Options
8521
8522 These @samp{-m} options are defined for the DEC Alpha implementations:
8523
8524 @table @gcctabopt
8525 @item -mno-soft-float
8526 @itemx -msoft-float
8527 @opindex mno-soft-float
8528 @opindex msoft-float
8529 Use (do not use) the hardware floating-point instructions for
8530 floating-point operations.  When @option{-msoft-float} is specified,
8531 functions in @file{libgcc.a} will be used to perform floating-point
8532 operations.  Unless they are replaced by routines that emulate the
8533 floating-point operations, or compiled in such a way as to call such
8534 emulations routines, these routines will issue floating-point
8535 operations.   If you are compiling for an Alpha without floating-point
8536 operations, you must ensure that the library is built so as not to call
8537 them.
8538
8539 Note that Alpha implementations without floating-point operations are
8540 required to have floating-point registers.
8541
8542 @item -mfp-reg
8543 @itemx -mno-fp-regs
8544 @opindex mfp-reg
8545 @opindex mno-fp-regs
8546 Generate code that uses (does not use) the floating-point register set.
8547 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8548 register set is not used, floating point operands are passed in integer
8549 registers as if they were integers and floating-point results are passed
8550 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8551 so any function with a floating-point argument or return value called by code
8552 compiled with @option{-mno-fp-regs} must also be compiled with that
8553 option.
8554
8555 A typical use of this option is building a kernel that does not use,
8556 and hence need not save and restore, any floating-point registers.
8557
8558 @item -mieee
8559 @opindex mieee
8560 The Alpha architecture implements floating-point hardware optimized for
8561 maximum performance.  It is mostly compliant with the IEEE floating
8562 point standard.  However, for full compliance, software assistance is
8563 required.  This option generates code fully IEEE compliant code
8564 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8565 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8566 defined during compilation.  The resulting code is less efficient but is
8567 able to correctly support denormalized numbers and exceptional IEEE
8568 values such as not-a-number and plus/minus infinity.  Other Alpha
8569 compilers call this option @option{-ieee_with_no_inexact}.
8570
8571 @item -mieee-with-inexact
8572 @opindex mieee-with-inexact
8573 This is like @option{-mieee} except the generated code also maintains
8574 the IEEE @var{inexact-flag}.  Turning on this option causes the
8575 generated code to implement fully-compliant IEEE math.  In addition to
8576 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8577 macro.  On some Alpha implementations the resulting code may execute
8578 significantly slower than the code generated by default.  Since there is
8579 very little code that depends on the @var{inexact-flag}, you should
8580 normally not specify this option.  Other Alpha compilers call this
8581 option @option{-ieee_with_inexact}.
8582
8583 @item -mfp-trap-mode=@var{trap-mode}
8584 @opindex mfp-trap-mode
8585 This option controls what floating-point related traps are enabled.
8586 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8587 The trap mode can be set to one of four values:
8588
8589 @table @samp
8590 @item n
8591 This is the default (normal) setting.  The only traps that are enabled
8592 are the ones that cannot be disabled in software (e.g., division by zero
8593 trap).
8594
8595 @item u
8596 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8597 as well.
8598
8599 @item su
8600 Like @samp{su}, but the instructions are marked to be safe for software
8601 completion (see Alpha architecture manual for details).
8602
8603 @item sui
8604 Like @samp{su}, but inexact traps are enabled as well.
8605 @end table
8606
8607 @item -mfp-rounding-mode=@var{rounding-mode}
8608 @opindex mfp-rounding-mode
8609 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8610 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8611 of:
8612
8613 @table @samp
8614 @item n
8615 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8616 the nearest machine number or towards the even machine number in case
8617 of a tie.
8618
8619 @item m
8620 Round towards minus infinity.
8621
8622 @item c
8623 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8624
8625 @item d
8626 Dynamic rounding mode.  A field in the floating point control register
8627 (@var{fpcr}, see Alpha architecture reference manual) controls the
8628 rounding mode in effect.  The C library initializes this register for
8629 rounding towards plus infinity.  Thus, unless your program modifies the
8630 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8631 @end table
8632
8633 @item -mtrap-precision=@var{trap-precision}
8634 @opindex mtrap-precision
8635 In the Alpha architecture, floating point traps are imprecise.  This
8636 means without software assistance it is impossible to recover from a
8637 floating trap and program execution normally needs to be terminated.
8638 GCC can generate code that can assist operating system trap handlers
8639 in determining the exact location that caused a floating point trap.
8640 Depending on the requirements of an application, different levels of
8641 precisions can be selected:
8642
8643 @table @samp
8644 @item p
8645 Program precision.  This option is the default and means a trap handler
8646 can only identify which program caused a floating point exception.
8647
8648 @item f
8649 Function precision.  The trap handler can determine the function that
8650 caused a floating point exception.
8651
8652 @item i
8653 Instruction precision.  The trap handler can determine the exact
8654 instruction that caused a floating point exception.
8655 @end table
8656
8657 Other Alpha compilers provide the equivalent options called
8658 @option{-scope_safe} and @option{-resumption_safe}.
8659
8660 @item -mieee-conformant
8661 @opindex mieee-conformant
8662 This option marks the generated code as IEEE conformant.  You must not
8663 use this option unless you also specify @option{-mtrap-precision=i} and either
8664 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8665 is to emit the line @samp{.eflag 48} in the function prologue of the
8666 generated assembly file.  Under DEC Unix, this has the effect that
8667 IEEE-conformant math library routines will be linked in.
8668
8669 @item -mbuild-constants
8670 @opindex mbuild-constants
8671 Normally GCC examines a 32- or 64-bit integer constant to
8672 see if it can construct it from smaller constants in two or three
8673 instructions.  If it cannot, it will output the constant as a literal and
8674 generate code to load it from the data segment at runtime.
8675
8676 Use this option to require GCC to construct @emph{all} integer constants
8677 using code, even if it takes more instructions (the maximum is six).
8678
8679 You would typically use this option to build a shared library dynamic
8680 loader.  Itself a shared library, it must relocate itself in memory
8681 before it can find the variables and constants in its own data segment.
8682
8683 @item -malpha-as
8684 @itemx -mgas
8685 @opindex malpha-as
8686 @opindex mgas
8687 Select whether to generate code to be assembled by the vendor-supplied
8688 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8689
8690 @item -mbwx
8691 @itemx -mno-bwx
8692 @itemx -mcix
8693 @itemx -mno-cix
8694 @itemx -mfix
8695 @itemx -mno-fix
8696 @itemx -mmax
8697 @itemx -mno-max
8698 @opindex mbwx
8699 @opindex mno-bwx
8700 @opindex mcix
8701 @opindex mno-cix
8702 @opindex mfix
8703 @opindex mno-fix
8704 @opindex mmax
8705 @opindex mno-max
8706 Indicate whether GCC should generate code to use the optional BWX,
8707 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8708 sets supported by the CPU type specified via @option{-mcpu=} option or that
8709 of the CPU on which GCC was built if none was specified.
8710
8711 @item -mfloat-vax
8712 @itemx -mfloat-ieee
8713 @opindex mfloat-vax
8714 @opindex mfloat-ieee
8715 Generate code that uses (does not use) VAX F and G floating point
8716 arithmetic instead of IEEE single and double precision.
8717
8718 @item -mexplicit-relocs
8719 @itemx -mno-explicit-relocs
8720 @opindex mexplicit-relocs
8721 @opindex mno-explicit-relocs
8722 Older Alpha assemblers provided no way to generate symbol relocations
8723 except via assembler macros.  Use of these macros does not allow
8724 optimal instruction scheduling.  GNU binutils as of version 2.12
8725 supports a new syntax that allows the compiler to explicitly mark
8726 which relocations should apply to which instructions.  This option
8727 is mostly useful for debugging, as GCC detects the capabilities of
8728 the assembler when it is built and sets the default accordingly.
8729
8730 @item -msmall-data
8731 @itemx -mlarge-data
8732 @opindex msmall-data
8733 @opindex mlarge-data
8734 When @option{-mexplicit-relocs} is in effect, static data is
8735 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8736 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8737 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8738 16-bit relocations off of the @code{$gp} register.  This limits the
8739 size of the small data area to 64KB, but allows the variables to be
8740 directly accessed via a single instruction.
8741
8742 The default is @option{-mlarge-data}.  With this option the data area
8743 is limited to just below 2GB.  Programs that require more than 2GB of
8744 data must use @code{malloc} or @code{mmap} to allocate the data in the
8745 heap instead of in the program's data segment.
8746
8747 When generating code for shared libraries, @option{-fpic} implies
8748 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8749
8750 @item -mcpu=@var{cpu_type}
8751 @opindex mcpu
8752 Set the instruction set and instruction scheduling parameters for
8753 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8754 style name or the corresponding chip number.  GCC supports scheduling
8755 parameters for the EV4, EV5 and EV6 family of processors and will
8756 choose the default values for the instruction set from the processor
8757 you specify.  If you do not specify a processor type, GCC will default
8758 to the processor on which the compiler was built.
8759
8760 Supported values for @var{cpu_type} are
8761
8762 @table @samp
8763 @item ev4
8764 @item ev45
8765 @itemx 21064
8766 Schedules as an EV4 and has no instruction set extensions.
8767
8768 @item ev5
8769 @itemx 21164
8770 Schedules as an EV5 and has no instruction set extensions.
8771
8772 @item ev56
8773 @itemx 21164a
8774 Schedules as an EV5 and supports the BWX extension.
8775
8776 @item pca56
8777 @itemx 21164pc
8778 @itemx 21164PC
8779 Schedules as an EV5 and supports the BWX and MAX extensions.
8780
8781 @item ev6
8782 @itemx 21264
8783 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8784
8785 @item ev67
8786 @item 21264a
8787 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8788 @end table
8789
8790 @item -mtune=@var{cpu_type}
8791 @opindex mtune
8792 Set only the instruction scheduling parameters for machine type
8793 @var{cpu_type}.  The instruction set is not changed.
8794
8795 @item -mmemory-latency=@var{time}
8796 @opindex mmemory-latency
8797 Sets the latency the scheduler should assume for typical memory
8798 references as seen by the application.  This number is highly
8799 dependent on the memory access patterns used by the application
8800 and the size of the external cache on the machine.
8801
8802 Valid options for @var{time} are
8803
8804 @table @samp
8805 @item @var{number}
8806 A decimal number representing clock cycles.
8807
8808 @item L1
8809 @itemx L2
8810 @itemx L3
8811 @itemx main
8812 The compiler contains estimates of the number of clock cycles for
8813 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8814 (also called Dcache, Scache, and Bcache), as well as to main memory.
8815 Note that L3 is only valid for EV5.
8816
8817 @end table
8818 @end table
8819
8820 @node DEC Alpha/VMS Options
8821 @subsection DEC Alpha/VMS Options
8822
8823 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8824
8825 @table @gcctabopt
8826 @item -mvms-return-codes
8827 @opindex mvms-return-codes
8828 Return VMS condition codes from main.  The default is to return POSIX
8829 style condition (e.g.@ error) codes.
8830 @end table
8831
8832 @node Clipper Options
8833 @subsection Clipper Options
8834
8835 These @samp{-m} options are defined for the Clipper implementations:
8836
8837 @table @gcctabopt
8838 @item -mc300
8839 @opindex mc300
8840 Produce code for a C300 Clipper processor.  This is the default.
8841
8842 @item -mc400
8843 @opindex mc400
8844 Produce code for a C400 Clipper processor, i.e.@: use floating point
8845 registers f8--f15.
8846 @end table
8847
8848 @node H8/300 Options
8849 @subsection H8/300 Options
8850
8851 These @samp{-m} options are defined for the H8/300 implementations:
8852
8853 @table @gcctabopt
8854 @item -mrelax
8855 @opindex mrelax
8856 Shorten some address references at link time, when possible; uses the
8857 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8858 ld.info, Using ld}, for a fuller description.
8859
8860 @item -mh
8861 @opindex mh
8862 Generate code for the H8/300H@.
8863
8864 @item -ms
8865 @opindex ms
8866 Generate code for the H8S@.
8867
8868 @item -mn
8869 @opindex mn
8870 Generate code for the H8S and H8/300H in the normal mode.  This switch
8871 must be used either with -mh or -ms.
8872
8873 @item -ms2600
8874 @opindex ms2600
8875 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8876
8877 @item -mint32
8878 @opindex mint32
8879 Make @code{int} data 32 bits by default.
8880
8881 @item -malign-300
8882 @opindex malign-300
8883 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8884 The default for the H8/300H and H8S is to align longs and floats on 4
8885 byte boundaries.
8886 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8887 This option has no effect on the H8/300.
8888 @end table
8889
8890 @node SH Options
8891 @subsection SH Options
8892
8893 These @samp{-m} options are defined for the SH implementations:
8894
8895 @table @gcctabopt
8896 @item -m1
8897 @opindex m1
8898 Generate code for the SH1.
8899
8900 @item -m2
8901 @opindex m2
8902 Generate code for the SH2.
8903
8904 @item -m3
8905 @opindex m3
8906 Generate code for the SH3.
8907
8908 @item -m3e
8909 @opindex m3e
8910 Generate code for the SH3e.
8911
8912 @item -m4-nofpu
8913 @opindex m4-nofpu
8914 Generate code for the SH4 without a floating-point unit.
8915
8916 @item -m4-single-only
8917 @opindex m4-single-only
8918 Generate code for the SH4 with a floating-point unit that only
8919 supports single-precision arithmetic.
8920
8921 @item -m4-single
8922 @opindex m4-single
8923 Generate code for the SH4 assuming the floating-point unit is in
8924 single-precision mode by default.
8925
8926 @item -m4
8927 @opindex m4
8928 Generate code for the SH4.
8929
8930 @item -mb
8931 @opindex mb
8932 Compile code for the processor in big endian mode.
8933
8934 @item -ml
8935 @opindex ml
8936 Compile code for the processor in little endian mode.
8937
8938 @item -mdalign
8939 @opindex mdalign
8940 Align doubles at 64-bit boundaries.  Note that this changes the calling
8941 conventions, and thus some functions from the standard C library will
8942 not work unless you recompile it first with @option{-mdalign}.
8943
8944 @item -mrelax
8945 @opindex mrelax
8946 Shorten some address references at link time, when possible; uses the
8947 linker option @option{-relax}.
8948
8949 @item -mbigtable
8950 @opindex mbigtable
8951 Use 32-bit offsets in @code{switch} tables.  The default is to use
8952 16-bit offsets.
8953
8954 @item -mfmovd
8955 @opindex mfmovd
8956 Enable the use of the instruction @code{fmovd}.
8957
8958 @item -mhitachi
8959 @opindex mhitachi
8960 Comply with the calling conventions defined by Hitachi.
8961
8962 @item -mnomacsave
8963 @opindex mnomacsave
8964 Mark the @code{MAC} register as call-clobbered, even if
8965 @option{-mhitachi} is given.
8966
8967 @item -mieee
8968 @opindex mieee
8969 Increase IEEE-compliance of floating-point code.
8970
8971 @item -misize
8972 @opindex misize
8973 Dump instruction size and location in the assembly code.
8974
8975 @item -mpadstruct
8976 @opindex mpadstruct
8977 This option is deprecated.  It pads structures to multiple of 4 bytes,
8978 which is incompatible with the SH ABI@.
8979
8980 @item -mspace
8981 @opindex mspace
8982 Optimize for space instead of speed.  Implied by @option{-Os}.
8983
8984 @item -mprefergot
8985 @opindex mprefergot
8986 When generating position-independent code, emit function calls using
8987 the Global Offset Table instead of the Procedure Linkage Table.
8988
8989 @item -musermode
8990 @opindex musermode
8991 Generate a library function call to invalidate instruction cache
8992 entries, after fixing up a trampoline.  This library function call
8993 doesn't assume it can write to the whole memory address space.  This
8994 is the default when the target is @code{sh-*-linux*}.
8995 @end table
8996
8997 @node System V Options
8998 @subsection Options for System V
8999
9000 These additional options are available on System V Release 4 for
9001 compatibility with other compilers on those systems:
9002
9003 @table @gcctabopt
9004 @item -G
9005 @opindex G
9006 Create a shared object.
9007 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9008
9009 @item -Qy
9010 @opindex Qy
9011 Identify the versions of each tool used by the compiler, in a
9012 @code{.ident} assembler directive in the output.
9013
9014 @item -Qn
9015 @opindex Qn
9016 Refrain from adding @code{.ident} directives to the output file (this is
9017 the default).
9018
9019 @item -YP,@var{dirs}
9020 @opindex YP
9021 Search the directories @var{dirs}, and no others, for libraries
9022 specified with @option{-l}.
9023
9024 @item -Ym,@var{dir}
9025 @opindex Ym
9026 Look in the directory @var{dir} to find the M4 preprocessor.
9027 The assembler uses this option.
9028 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9029 @c the generic assembler that comes with Solaris takes just -Ym.
9030 @end table
9031
9032 @node TMS320C3x/C4x Options
9033 @subsection TMS320C3x/C4x Options
9034 @cindex TMS320C3x/C4x Options
9035
9036 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9037
9038 @table @gcctabopt
9039
9040 @item -mcpu=@var{cpu_type}
9041 @opindex mcpu
9042 Set the instruction set, register set, and instruction scheduling
9043 parameters for machine type @var{cpu_type}.  Supported values for
9044 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9045 @samp{c44}.  The default is @samp{c40} to generate code for the
9046 TMS320C40.
9047
9048 @item -mbig-memory
9049 @item -mbig
9050 @itemx -msmall-memory
9051 @itemx -msmall
9052 @opindex mbig-memory
9053 @opindex mbig
9054 @opindex msmall-memory
9055 @opindex msmall
9056 Generates code for the big or small memory model.  The small memory
9057 model assumed that all data fits into one 64K word page.  At run-time
9058 the data page (DP) register must be set to point to the 64K page
9059 containing the .bss and .data program sections.  The big memory model is
9060 the default and requires reloading of the DP register for every direct
9061 memory access.
9062
9063 @item -mbk
9064 @itemx -mno-bk
9065 @opindex mbk
9066 @opindex mno-bk
9067 Allow (disallow) allocation of general integer operands into the block
9068 count register BK@.
9069
9070 @item -mdb
9071 @itemx -mno-db
9072 @opindex mdb
9073 @opindex mno-db
9074 Enable (disable) generation of code using decrement and branch,
9075 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9076 on the safe side, this is disabled for the C3x, since the maximum
9077 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9078 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9079 that it can utilize the decrement and branch instruction, but will give
9080 up if there is more than one memory reference in the loop.  Thus a loop
9081 where the loop counter is decremented can generate slightly more
9082 efficient code, in cases where the RPTB instruction cannot be utilized.
9083
9084 @item -mdp-isr-reload
9085 @itemx -mparanoid
9086 @opindex mdp-isr-reload
9087 @opindex mparanoid
9088 Force the DP register to be saved on entry to an interrupt service
9089 routine (ISR), reloaded to point to the data section, and restored on
9090 exit from the ISR@.  This should not be required unless someone has
9091 violated the small memory model by modifying the DP register, say within
9092 an object library.
9093
9094 @item -mmpyi
9095 @itemx -mno-mpyi
9096 @opindex mmpyi
9097 @opindex mno-mpyi
9098 For the C3x use the 24-bit MPYI instruction for integer multiplies
9099 instead of a library call to guarantee 32-bit results.  Note that if one
9100 of the operands is a constant, then the multiplication will be performed
9101 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9102 then squaring operations are performed inline instead of a library call.
9103
9104 @item -mfast-fix
9105 @itemx -mno-fast-fix
9106 @opindex mfast-fix
9107 @opindex mno-fast-fix
9108 The C3x/C4x FIX instruction to convert a floating point value to an
9109 integer value chooses the nearest integer less than or equal to the
9110 floating point value rather than to the nearest integer.  Thus if the
9111 floating point number is negative, the result will be incorrectly
9112 truncated an additional code is necessary to detect and correct this
9113 case.  This option can be used to disable generation of the additional
9114 code required to correct the result.
9115
9116 @item -mrptb
9117 @itemx -mno-rptb
9118 @opindex mrptb
9119 @opindex mno-rptb
9120 Enable (disable) generation of repeat block sequences using the RPTB
9121 instruction for zero overhead looping.  The RPTB construct is only used
9122 for innermost loops that do not call functions or jump across the loop
9123 boundaries.  There is no advantage having nested RPTB loops due to the
9124 overhead required to save and restore the RC, RS, and RE registers.
9125 This is enabled by default with @option{-O2}.
9126
9127 @item -mrpts=@var{count}
9128 @itemx -mno-rpts
9129 @opindex mrpts
9130 @opindex mno-rpts
9131 Enable (disable) the use of the single instruction repeat instruction
9132 RPTS@.  If a repeat block contains a single instruction, and the loop
9133 count can be guaranteed to be less than the value @var{count}, GCC will
9134 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9135 then a RPTS will be emitted even if the loop count cannot be determined
9136 at compile time.  Note that the repeated instruction following RPTS does
9137 not have to be reloaded from memory each iteration, thus freeing up the
9138 CPU buses for operands.  However, since interrupts are blocked by this
9139 instruction, it is disabled by default.
9140
9141 @item -mloop-unsigned
9142 @itemx -mno-loop-unsigned
9143 @opindex mloop-unsigned
9144 @opindex mno-loop-unsigned
9145 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9146 is @math{2^{31} + 1} since these instructions test if the iteration count is
9147 negative to terminate the loop.  If the iteration count is unsigned
9148 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9149 exceeded.  This switch allows an unsigned iteration count.
9150
9151 @item -mti
9152 @opindex mti
9153 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9154 with.  This also enforces compatibility with the API employed by the TI
9155 C3x C compiler.  For example, long doubles are passed as structures
9156 rather than in floating point registers.
9157
9158 @item -mregparm
9159 @itemx -mmemparm
9160 @opindex mregparm
9161 @opindex mmemparm
9162 Generate code that uses registers (stack) for passing arguments to functions.
9163 By default, arguments are passed in registers where possible rather
9164 than by pushing arguments on to the stack.
9165
9166 @item -mparallel-insns
9167 @itemx -mno-parallel-insns
9168 @opindex mparallel-insns
9169 @opindex mno-parallel-insns
9170 Allow the generation of parallel instructions.  This is enabled by
9171 default with @option{-O2}.
9172
9173 @item -mparallel-mpy
9174 @itemx -mno-parallel-mpy
9175 @opindex mparallel-mpy
9176 @opindex mno-parallel-mpy
9177 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9178 provided @option{-mparallel-insns} is also specified.  These instructions have
9179 tight register constraints which can pessimize the code generation
9180 of large functions.
9181
9182 @end table
9183
9184 @node V850 Options
9185 @subsection V850 Options
9186 @cindex V850 Options
9187
9188 These @samp{-m} options are defined for V850 implementations:
9189
9190 @table @gcctabopt
9191 @item -mlong-calls
9192 @itemx -mno-long-calls
9193 @opindex mlong-calls
9194 @opindex mno-long-calls
9195 Treat all calls as being far away (near).  If calls are assumed to be
9196 far away, the compiler will always load the functions address up into a
9197 register, and call indirect through the pointer.
9198
9199 @item -mno-ep
9200 @itemx -mep
9201 @opindex mno-ep
9202 @opindex mep
9203 Do not optimize (do optimize) basic blocks that use the same index
9204 pointer 4 or more times to copy pointer into the @code{ep} register, and
9205 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9206 option is on by default if you optimize.
9207
9208 @item -mno-prolog-function
9209 @itemx -mprolog-function
9210 @opindex mno-prolog-function
9211 @opindex mprolog-function
9212 Do not use (do use) external functions to save and restore registers at
9213 the prolog and epilog of a function.  The external functions are slower,
9214 but use less code space if more than one function saves the same number
9215 of registers.  The @option{-mprolog-function} option is on by default if
9216 you optimize.
9217
9218 @item -mspace
9219 @opindex mspace
9220 Try to make the code as small as possible.  At present, this just turns
9221 on the @option{-mep} and @option{-mprolog-function} options.
9222
9223 @item -mtda=@var{n}
9224 @opindex mtda
9225 Put static or global variables whose size is @var{n} bytes or less into
9226 the tiny data area that register @code{ep} points to.  The tiny data
9227 area can hold up to 256 bytes in total (128 bytes for byte references).
9228
9229 @item -msda=@var{n}
9230 @opindex msda
9231 Put static or global variables whose size is @var{n} bytes or less into
9232 the small data area that register @code{gp} points to.  The small data
9233 area can hold up to 64 kilobytes.
9234
9235 @item -mzda=@var{n}
9236 @opindex mzda
9237 Put static or global variables whose size is @var{n} bytes or less into
9238 the first 32 kilobytes of memory.
9239
9240 @item -mv850
9241 @opindex mv850
9242 Specify that the target processor is the V850.
9243
9244 @item -mbig-switch
9245 @opindex mbig-switch
9246 Generate code suitable for big switch tables.  Use this option only if
9247 the assembler/linker complain about out of range branches within a switch
9248 table.
9249
9250 @item -mapp-regs
9251 @opindex -mapp-regs
9252 This option will cause r2 and r5 to be used in the code generated by
9253 the compiler.  This setting is the default.
9254
9255 @item -mno-app-regs
9256 @opindex -mno-app-regs
9257 This option will cause r2 and r5 to be treated as fixed registers.
9258   
9259 @item -mv850e
9260 @opindex -mv850e
9261 Specify that the target processor is the V850E.  The preprocessor
9262 constant @samp{__v850e__} will be defined if this option is used.
9263
9264 If neither @option{-mv850} nor @option{-mv850e} are defined
9265 then a default target processor will be chosen and the relevant
9266 @samp{__v850*__} preprocessor constant will be defined.
9267
9268 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9269 defined, regardless of which processor variant is the target.
9270
9271 @item -mdisable-callt
9272 @opindex -mdisable-callt
9273 This option will suppress generation of the CALLT instruction for the
9274 v850e flavors of the v850 architecture.  The default is
9275 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9276
9277 @end table
9278
9279 @node ARC Options
9280 @subsection ARC Options
9281 @cindex ARC Options
9282
9283 These options are defined for ARC implementations:
9284
9285 @table @gcctabopt
9286 @item -EL
9287 @opindex EL
9288 Compile code for little endian mode.  This is the default.
9289
9290 @item -EB
9291 @opindex EB
9292 Compile code for big endian mode.
9293
9294 @item -mmangle-cpu
9295 @opindex mmangle-cpu
9296 Prepend the name of the cpu to all public symbol names.
9297 In multiple-processor systems, there are many ARC variants with different
9298 instruction and register set characteristics.  This flag prevents code
9299 compiled for one cpu to be linked with code compiled for another.
9300 No facility exists for handling variants that are ``almost identical''.
9301 This is an all or nothing option.
9302
9303 @item -mcpu=@var{cpu}
9304 @opindex mcpu
9305 Compile code for ARC variant @var{cpu}.
9306 Which variants are supported depend on the configuration.
9307 All variants support @option{-mcpu=base}, this is the default.
9308
9309 @item -mtext=@var{text-section}
9310 @itemx -mdata=@var{data-section}
9311 @itemx -mrodata=@var{readonly-data-section}
9312 @opindex mtext
9313 @opindex mdata
9314 @opindex mrodata
9315 Put functions, data, and readonly data in @var{text-section},
9316 @var{data-section}, and @var{readonly-data-section} respectively
9317 by default.  This can be overridden with the @code{section} attribute.
9318 @xref{Variable Attributes}.
9319
9320 @end table
9321
9322 @node NS32K Options
9323 @subsection NS32K Options
9324 @cindex NS32K options
9325
9326 These are the @samp{-m} options defined for the 32000 series.  The default
9327 values for these options depends on which style of 32000 was selected when
9328 the compiler was configured; the defaults for the most common choices are
9329 given below.
9330
9331 @table @gcctabopt
9332 @item -m32032
9333 @itemx -m32032
9334 @opindex m32032
9335 @opindex m32032
9336 Generate output for a 32032.  This is the default
9337 when the compiler is configured for 32032 and 32016 based systems.
9338
9339 @item -m32332
9340 @itemx -m32332
9341 @opindex m32332
9342 @opindex m32332
9343 Generate output for a 32332.  This is the default
9344 when the compiler is configured for 32332-based systems.
9345
9346 @item -m32532
9347 @itemx -m32532
9348 @opindex m32532
9349 @opindex m32532
9350 Generate output for a 32532.  This is the default
9351 when the compiler is configured for 32532-based systems.
9352
9353 @item -m32081
9354 @opindex m32081
9355 Generate output containing 32081 instructions for floating point.
9356 This is the default for all systems.
9357
9358 @item -m32381
9359 @opindex m32381
9360 Generate output containing 32381 instructions for floating point.  This
9361 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9362 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9363
9364 @item -mmulti-add
9365 @opindex mmulti-add
9366 Try and generate multiply-add floating point instructions @code{polyF}
9367 and @code{dotF}.  This option is only available if the @option{-m32381}
9368 option is in effect.  Using these instructions requires changes to
9369 register allocation which generally has a negative impact on
9370 performance.  This option should only be enabled when compiling code
9371 particularly likely to make heavy use of multiply-add instructions.
9372
9373 @item -mnomulti-add
9374 @opindex mnomulti-add
9375 Do not try and generate multiply-add floating point instructions
9376 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9377
9378 @item -msoft-float
9379 @opindex msoft-float
9380 Generate output containing library calls for floating point.
9381 @strong{Warning:} the requisite libraries may not be available.
9382
9383 @item -mieee-compare
9384 @itemx -mno-ieee-compare
9385 @opindex mieee-compare
9386 @opindex mno-ieee-compare
9387 Control whether or not the compiler uses IEEE floating point
9388 comparisons.  These handle correctly the case where the result of a
9389 comparison is unordered.
9390 @strong{Warning:} the requisite kernel support may not be available.
9391
9392 @item -mnobitfield
9393 @opindex mnobitfield
9394 Do not use the bit-field instructions.  On some machines it is faster to
9395 use shifting and masking operations.  This is the default for the pc532.
9396
9397 @item -mbitfield
9398 @opindex mbitfield
9399 Do use the bit-field instructions.  This is the default for all platforms
9400 except the pc532.
9401
9402 @item -mrtd
9403 @opindex mrtd
9404 Use a different function-calling convention, in which functions
9405 that take a fixed number of arguments return pop their
9406 arguments on return with the @code{ret} instruction.
9407
9408 This calling convention is incompatible with the one normally
9409 used on Unix, so you cannot use it if you need to call libraries
9410 compiled with the Unix compiler.
9411
9412 Also, you must provide function prototypes for all functions that
9413 take variable numbers of arguments (including @code{printf});
9414 otherwise incorrect code will be generated for calls to those
9415 functions.
9416
9417 In addition, seriously incorrect code will result if you call a
9418 function with too many arguments.  (Normally, extra arguments are
9419 harmlessly ignored.)
9420
9421 This option takes its name from the 680x0 @code{rtd} instruction.
9422
9423
9424 @item -mregparam
9425 @opindex mregparam
9426 Use a different function-calling convention where the first two arguments
9427 are passed in registers.
9428
9429 This calling convention is incompatible with the one normally
9430 used on Unix, so you cannot use it if you need to call libraries
9431 compiled with the Unix compiler.
9432
9433 @item -mnoregparam
9434 @opindex mnoregparam
9435 Do not pass any arguments in registers.  This is the default for all
9436 targets.
9437
9438 @item -msb
9439 @opindex msb
9440 It is OK to use the sb as an index register which is always loaded with
9441 zero.  This is the default for the pc532-netbsd target.
9442
9443 @item -mnosb
9444 @opindex mnosb
9445 The sb register is not available for use or has not been initialized to
9446 zero by the run time system.  This is the default for all targets except
9447 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9448 @option{-fpic} is set.
9449
9450 @item -mhimem
9451 @opindex mhimem
9452 Many ns32000 series addressing modes use displacements of up to 512MB@.
9453 If an address is above 512MB then displacements from zero can not be used.
9454 This option causes code to be generated which can be loaded above 512MB@.
9455 This may be useful for operating systems or ROM code.
9456
9457 @item -mnohimem
9458 @opindex mnohimem
9459 Assume code will be loaded in the first 512MB of virtual address space.
9460 This is the default for all platforms.
9461
9462
9463 @end table
9464
9465 @node AVR Options
9466 @subsection AVR Options
9467 @cindex AVR Options
9468
9469 These options are defined for AVR implementations:
9470
9471 @table @gcctabopt
9472 @item -mmcu=@var{mcu}
9473 @opindex mmcu
9474 Specify ATMEL AVR instruction set or MCU type.
9475
9476 Instruction set avr1 is for the minimal AVR core, not supported by the C
9477 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9478 attiny11, attiny12, attiny15, attiny28).
9479
9480 Instruction set avr2 (default) is for the classic AVR core with up to
9481 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9482 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9483 at90c8534, at90s8535).
9484
9485 Instruction set avr3 is for the classic AVR core with up to 128K program
9486 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9487
9488 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9489 memory space (MCU types: atmega8, atmega83, atmega85).
9490
9491 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9492 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9493 atmega64, atmega128, at43usb355, at94k).
9494
9495 @item -msize
9496 @opindex msize
9497 Output instruction sizes to the asm file.
9498
9499 @item -minit-stack=@var{N}
9500 @opindex minit-stack
9501 Specify the initial stack address, which may be a symbol or numeric value,
9502 @samp{__stack} is the default.
9503
9504 @item -mno-interrupts
9505 @opindex mno-interrupts
9506 Generated code is not compatible with hardware interrupts.
9507 Code size will be smaller.
9508
9509 @item -mcall-prologues
9510 @opindex mcall-prologues
9511 Functions prologues/epilogues expanded as call to appropriate
9512 subroutines.  Code size will be smaller.
9513
9514 @item -mno-tablejump
9515 @opindex mno-tablejump
9516 Do not generate tablejump insns which sometimes increase code size.
9517
9518 @item -mtiny-stack
9519 @opindex mtiny-stack
9520 Change only the low 8 bits of the stack pointer.
9521 @end table
9522
9523 @node MCore Options
9524 @subsection MCore Options
9525 @cindex MCore options
9526
9527 These are the @samp{-m} options defined for the Motorola M*Core
9528 processors.
9529
9530 @table @gcctabopt
9531
9532 @item -mhardlit
9533 @itemx -mhardlit
9534 @itemx -mno-hardlit
9535 @opindex mhardlit
9536 @opindex mhardlit
9537 @opindex mno-hardlit
9538 Inline constants into the code stream if it can be done in two
9539 instructions or less.
9540
9541 @item -mdiv
9542 @itemx -mdiv
9543 @itemx -mno-div
9544 @opindex mdiv
9545 @opindex mdiv
9546 @opindex mno-div
9547 Use the divide instruction.  (Enabled by default).
9548
9549 @item -mrelax-immediate
9550 @itemx -mrelax-immediate
9551 @itemx -mno-relax-immediate
9552 @opindex mrelax-immediate
9553 @opindex mrelax-immediate
9554 @opindex mno-relax-immediate
9555 Allow arbitrary sized immediates in bit operations.
9556
9557 @item -mwide-bitfields
9558 @itemx -mwide-bitfields
9559 @itemx -mno-wide-bitfields
9560 @opindex mwide-bitfields
9561 @opindex mwide-bitfields
9562 @opindex mno-wide-bitfields
9563 Always treat bit-fields as int-sized.
9564
9565 @item -m4byte-functions
9566 @itemx -m4byte-functions
9567 @itemx -mno-4byte-functions
9568 @opindex m4byte-functions
9569 @opindex m4byte-functions
9570 @opindex mno-4byte-functions
9571 Force all functions to be aligned to a four byte boundary.
9572
9573 @item -mcallgraph-data
9574 @itemx -mcallgraph-data
9575 @itemx -mno-callgraph-data
9576 @opindex mcallgraph-data
9577 @opindex mcallgraph-data
9578 @opindex mno-callgraph-data
9579 Emit callgraph information.
9580
9581 @item -mslow-bytes
9582 @itemx -mslow-bytes
9583 @itemx -mno-slow-bytes
9584 @opindex mslow-bytes
9585 @opindex mslow-bytes
9586 @opindex mno-slow-bytes
9587 Prefer word access when reading byte quantities.
9588
9589 @item -mlittle-endian
9590 @itemx -mlittle-endian
9591 @itemx -mbig-endian
9592 @opindex mlittle-endian
9593 @opindex mlittle-endian
9594 @opindex mbig-endian
9595 Generate code for a little endian target.
9596
9597 @item -m210
9598 @itemx -m210
9599 @itemx -m340
9600 @opindex m210
9601 @opindex m210
9602 @opindex m340
9603 Generate code for the 210 processor.
9604 @end table
9605
9606 @node IA-64 Options
9607 @subsection IA-64 Options
9608 @cindex IA-64 Options
9609
9610 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9611
9612 @table @gcctabopt
9613 @item -mbig-endian
9614 @opindex mbig-endian
9615 Generate code for a big endian target.  This is the default for HP-UX@.
9616
9617 @item -mlittle-endian
9618 @opindex mlittle-endian
9619 Generate code for a little endian target.  This is the default for AIX5
9620 and Linux.
9621
9622 @item -mgnu-as
9623 @itemx -mno-gnu-as
9624 @opindex mgnu-as
9625 @opindex mno-gnu-as
9626 Generate (or don't) code for the GNU assembler.  This is the default.
9627 @c Also, this is the default if the configure option @option{--with-gnu-as}
9628 @c is used.
9629
9630 @item -mgnu-ld
9631 @itemx -mno-gnu-ld
9632 @opindex mgnu-ld
9633 @opindex mno-gnu-ld
9634 Generate (or don't) code for the GNU linker.  This is the default.
9635 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9636 @c is used.
9637
9638 @item -mno-pic
9639 @opindex mno-pic
9640 Generate code that does not use a global pointer register.  The result
9641 is not position independent code, and violates the IA-64 ABI@.
9642
9643 @item -mvolatile-asm-stop
9644 @itemx -mno-volatile-asm-stop
9645 @opindex mvolatile-asm-stop
9646 @opindex mno-volatile-asm-stop
9647 Generate (or don't) a stop bit immediately before and after volatile asm
9648 statements.
9649
9650 @item -mb-step
9651 @opindex mb-step
9652 Generate code that works around Itanium B step errata.
9653
9654 @item -mregister-names
9655 @itemx -mno-register-names
9656 @opindex mregister-names
9657 @opindex mno-register-names
9658 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9659 the stacked registers.  This may make assembler output more readable.
9660
9661 @item -mno-sdata
9662 @itemx -msdata
9663 @opindex mno-sdata
9664 @opindex msdata
9665 Disable (or enable) optimizations that use the small data section.  This may
9666 be useful for working around optimizer bugs.
9667
9668 @item -mconstant-gp
9669 @opindex mconstant-gp
9670 Generate code that uses a single constant global pointer value.  This is
9671 useful when compiling kernel code.
9672
9673 @item -mauto-pic
9674 @opindex mauto-pic
9675 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9676 This is useful when compiling firmware code.
9677
9678 @item -minline-float-divide-min-latency
9679 @opindex minline-float-divide-min-latency
9680 Generate code for inline divides of floating point values
9681 using the minimum latency algorithm.
9682
9683 @item -minline-float-divide-max-throughput
9684 @opindex minline-float-divide-max-throughput
9685 Generate code for inline divides of floating point values
9686 using the maximum throughput algorithm.
9687
9688 @item -minline-int-divide-min-latency
9689 @opindex minline-int-divide-min-latency
9690 Generate code for inline divides of integer values
9691 using the minimum latency algorithm.
9692
9693 @item -minline-int-divide-max-throughput
9694 @opindex minline-int-divide-max-throughput
9695 Generate code for inline divides of integer values
9696 using the maximum throughput algorithm.
9697
9698 @item -mno-dwarf2-asm
9699 @itemx -mdwarf2-asm
9700 @opindex mno-dwarf2-asm
9701 @opindex mdwarf2-asm
9702 Don't (or do) generate assembler code for the DWARF2 line number debugging
9703 info.  This may be useful when not using the GNU assembler.
9704
9705 @item -mfixed-range=@var{register-range}
9706 @opindex mfixed-range
9707 Generate code treating the given register range as fixed registers.
9708 A fixed register is one that the register allocator can not use.  This is
9709 useful when compiling kernel code.  A register range is specified as
9710 two registers separated by a dash.  Multiple register ranges can be
9711 specified separated by a comma.
9712 @end table
9713
9714 @node D30V Options
9715 @subsection D30V Options
9716 @cindex D30V Options
9717
9718 These @samp{-m} options are defined for D30V implementations:
9719
9720 @table @gcctabopt
9721 @item -mextmem
9722 @opindex mextmem
9723 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9724 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9725 memory, which starts at location @code{0x80000000}.
9726
9727 @item -mextmemory
9728 @opindex mextmemory
9729 Same as the @option{-mextmem} switch.
9730
9731 @item -monchip
9732 @opindex monchip
9733 Link the @samp{.text} section into onchip text memory, which starts at
9734 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9735 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9736 into onchip data memory, which starts at location @code{0x20000000}.
9737
9738 @item -mno-asm-optimize
9739 @itemx -masm-optimize
9740 @opindex mno-asm-optimize
9741 @opindex masm-optimize
9742 Disable (enable) passing @option{-O} to the assembler when optimizing.
9743 The assembler uses the @option{-O} option to automatically parallelize
9744 adjacent short instructions where possible.
9745
9746 @item -mbranch-cost=@var{n}
9747 @opindex mbranch-cost
9748 Increase the internal costs of branches to @var{n}.  Higher costs means
9749 that the compiler will issue more instructions to avoid doing a branch.
9750 The default is 2.
9751
9752 @item -mcond-exec=@var{n}
9753 @opindex mcond-exec
9754 Specify the maximum number of conditionally executed instructions that
9755 replace a branch.  The default is 4.
9756 @end table
9757
9758 @node S/390 and zSeries Options
9759 @subsection S/390 and zSeries Options
9760 @cindex S/390 and zSeries Options
9761
9762 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9763
9764 @table @gcctabopt
9765 @item -mhard-float
9766 @itemx -msoft-float
9767 @opindex mhard-float
9768 @opindex msoft-float
9769 Use (do not use) the hardware floating-point instructions and registers
9770 for floating-point operations.  When @option{-msoft-float} is specified,
9771 functions in @file{libgcc.a} will be used to perform floating-point
9772 operations.  When @option{-mhard-float} is specified, the compiler
9773 generates IEEE floating-point instructions.  This is the default.
9774
9775 @item -mbackchain
9776 @itemx -mno-backchain
9777 @opindex mbackchain
9778 @opindex mno-backchain
9779 Generate (or do not generate) code which maintains an explicit
9780 backchain within the stack frame that points to the caller's frame.
9781 This is currently needed to allow debugging.  The default is to
9782 generate the backchain.
9783
9784 @item -msmall-exec
9785 @itemx -mno-small-exec
9786 @opindex msmall-exec
9787 @opindex mno-small-exec
9788 Generate (or do not generate) code using the @code{bras} instruction
9789 to do subroutine calls.
9790 This only works reliably if the total executable size does not
9791 exceed 64k.  The default is to use the @code{basr} instruction instead,
9792 which does not have this limitation.
9793
9794 @item -m64
9795 @itemx -m31
9796 @opindex m64
9797 @opindex m31
9798 When @option{-m31} is specified, generate code compliant to the
9799 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9800 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9801 particular to generate 64-bit instructions.  For the @samp{s390}
9802 targets, the default is @option{-m31}, while the @samp{s390x}
9803 targets default to @option{-m64}.
9804
9805 @item -mmvcle
9806 @itemx -mno-mvcle
9807 @opindex mmvcle
9808 @opindex mno-mvcle
9809 Generate (or do not generate) code using the @code{mvcle} instruction
9810 to perform block moves.  When @option{-mno-mvcle} is specified,
9811 use a @code{mvc} loop instead.  This is the default.
9812
9813 @item -mdebug
9814 @itemx -mno-debug
9815 @opindex mdebug
9816 @opindex mno-debug
9817 Print (or do not print) additional debug information when compiling.
9818 The default is to not print debug information.
9819
9820 @end table
9821
9822 @node CRIS Options
9823 @subsection CRIS Options
9824 @cindex CRIS Options
9825
9826 These options are defined specifically for the CRIS ports.
9827
9828 @table @gcctabopt
9829 @item -march=@var{architecture-type}
9830 @itemx -mcpu=@var{architecture-type}
9831 @opindex march
9832 @opindex mcpu
9833 Generate code for the specified architecture.  The choices for
9834 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9835 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
9836 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9837 @samp{v10}.
9838
9839 @item -mtune=@var{architecture-type}
9840 @opindex mtune
9841 Tune to @var{architecture-type} everything applicable about the generated
9842 code, except for the ABI and the set of available instructions.  The
9843 choices for @var{architecture-type} are the same as for
9844 @option{-march=@var{architecture-type}}.
9845
9846 @item -mmax-stack-frame=@var{n}
9847 @opindex mmax-stack-frame
9848 Warn when the stack frame of a function exceeds @var{n} bytes.
9849
9850 @item -melinux-stacksize=@var{n}
9851 @opindex melinux-stacksize
9852 Only available with the @samp{cris-axis-aout} target.  Arranges for
9853 indications in the program to the kernel loader that the stack of the
9854 program should be set to @var{n} bytes.
9855
9856 @item -metrax4
9857 @itemx -metrax100
9858 @opindex metrax4
9859 @opindex metrax100
9860 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9861 @option{-march=v3} and @option{-march=v8} respectively.
9862
9863 @item -mpdebug
9864 @opindex mpdebug
9865 Enable CRIS-specific verbose debug-related information in the assembly
9866 code.  This option also has the effect to turn off the @samp{#NO_APP}
9867 formatted-code indicator to the assembler at the beginning of the
9868 assembly file.
9869
9870 @item -mcc-init
9871 @opindex mcc-init
9872 Do not use condition-code results from previous instruction; always emit
9873 compare and test instructions before use of condition codes.
9874
9875 @item -mno-side-effects
9876 @opindex mno-side-effects
9877 Do not emit instructions with side-effects in addressing modes other than
9878 post-increment.
9879
9880 @item -mstack-align
9881 @itemx -mno-stack-align
9882 @itemx -mdata-align
9883 @itemx -mno-data-align
9884 @itemx -mconst-align
9885 @itemx -mno-const-align
9886 @opindex mstack-align
9887 @opindex mno-stack-align
9888 @opindex mdata-align
9889 @opindex mno-data-align
9890 @opindex mconst-align
9891 @opindex mno-const-align
9892 These options (no-options) arranges (eliminate arrangements) for the
9893 stack-frame, individual data and constants to be aligned for the maximum
9894 single data access size for the chosen CPU model.  The default is to
9895 arrange for 32-bit alignment.  ABI details such as structure layout are
9896 not affected by these options.
9897
9898 @item -m32-bit
9899 @itemx -m16-bit
9900 @itemx -m8-bit
9901 @opindex m32-bit
9902 @opindex m16-bit
9903 @opindex m8-bit
9904 Similar to the stack- data- and const-align options above, these options
9905 arrange for stack-frame, writable data and constants to all be 32-bit,
9906 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9907
9908 @item -mno-prologue-epilogue
9909 @itemx -mprologue-epilogue
9910 @opindex mno-prologue-epilogue
9911 @opindex mprologue-epilogue
9912 With @option{-mno-prologue-epilogue}, the normal function prologue and
9913 epilogue that sets up the stack-frame are omitted and no return
9914 instructions or return sequences are generated in the code.  Use this
9915 option only together with visual inspection of the compiled code: no
9916 warnings or errors are generated when call-saved registers must be saved,
9917 or storage for local variable needs to be allocated.
9918
9919 @item -mno-gotplt
9920 @itemx -mgotplt
9921 @opindex mno-gotplt
9922 @opindex mgotplt
9923 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9924 instruction sequences that load addresses for functions from the PLT part
9925 of the GOT rather than (traditional on other architectures) calls to the
9926 PLT.  The default is @option{-mgotplt}.
9927
9928 @item -maout
9929 @opindex maout
9930 Legacy no-op option only recognized with the cris-axis-aout target.
9931
9932 @item -melf
9933 @opindex melf
9934 Legacy no-op option only recognized with the cris-axis-elf and
9935 cris-axis-linux-gnu targets.
9936
9937 @item -melinux
9938 @opindex melinux
9939 Only recognized with the cris-axis-aout target, where it selects a
9940 GNU/linux-like multilib, include files and instruction set for
9941 @option{-march=v8}.
9942
9943 @item -mlinux
9944 @opindex mlinux
9945 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9946
9947 @item -sim
9948 @opindex sim
9949 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9950 to link with input-output functions from a simulator library.  Code,
9951 initialized data and zero-initialized data are allocated consecutively.
9952
9953 @item -sim2
9954 @opindex sim2
9955 Like @option{-sim}, but pass linker options to locate initialized data at
9956 0x40000000 and zero-initialized data at 0x80000000.
9957 @end table
9958
9959 @node MMIX Options
9960 @subsection MMIX Options
9961 @cindex MMIX Options
9962
9963 These options are defined for the MMIX:
9964
9965 @table @gcctabopt
9966 @item -mlibfuncs
9967 @itemx -mno-libfuncs
9968 @opindex mlibfuncs
9969 @opindex mno-libfuncs
9970 Specify that intrinsic library functions are being compiled, passing all
9971 values in registers, no matter the size.
9972
9973 @item -mepsilon
9974 @itemx -mno-epsilon
9975 @opindex mepsilon
9976 @opindex mno-epsilon
9977 Generate floating-point comparison instructions that compare with respect
9978 to the @code{rE} epsilon register.
9979
9980 @item -mabi=mmixware
9981 @itemx -mabi=gnu
9982 @opindex mabi-mmixware
9983 @opindex mabi=gnu
9984 Generate code that passes function parameters and return values that (in
9985 the called function) are seen as registers @code{$0} and up, as opposed to
9986 the GNU ABI which uses global registers @code{$231} and up.
9987
9988 @item -mzero-extend
9989 @itemx -mno-zero-extend
9990 @opindex mzero-extend
9991 @opindex mno-zero-extend
9992 When reading data from memory in sizes shorter than 64 bits, use (do not
9993 use) zero-extending load instructions by default, rather than
9994 sign-extending ones.
9995
9996 @item -mknuthdiv
9997 @itemx -mno-knuthdiv
9998 @opindex mknuthdiv
9999 @opindex mno-knuthdiv
10000 Make the result of a division yielding a remainder have the same sign as
10001 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10002 remainder follows the sign of the dividend.  Both methods are
10003 arithmetically valid, the latter being almost exclusively used.
10004
10005 @item -mtoplevel-symbols
10006 @itemx -mno-toplevel-symbols
10007 @opindex mtoplevel-symbols
10008 @opindex mno-toplevel-symbols
10009 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10010 code can be used with the @code{PREFIX} assembly directive.
10011
10012 @item -melf
10013 @opindex melf
10014 Generate an executable in the ELF format, rather than the default
10015 @samp{mmo} format used by the @command{mmix} simulator.
10016
10017 @item -mbranch-predict
10018 @itemx -mno-branch-predict
10019 @opindex mbranch-predict
10020 @opindex mno-branch-predict
10021 Use (do not use) the probable-branch instructions, when static branch
10022 prediction indicates a probable branch.
10023
10024 @item -mbase-addresses
10025 @itemx -mno-base-addresses
10026 @opindex mbase-addresses
10027 @opindex mno-base-addresses
10028 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10029 base address automatically generates a request (handled by the assembler
10030 and the linker) for a constant to be set up in a global register.  The
10031 register is used for one or more base address requests within the range 0
10032 to 255 from the value held in the register.  The generally leads to short
10033 and fast code, but the number of different data items that can be
10034 addressed is limited.  This means that a program that uses lots of static
10035 data may require @option{-mno-base-addresses}.
10036
10037 @item -msingle-exit
10038 @itemx -mno-single-exit
10039 @opindex msingle-exit
10040 @opindex mno-single-exit
10041 Force (do not force) generated code to have a single exit point in each
10042 function.
10043 @end table
10044
10045 @node PDP-11 Options
10046 @subsection PDP-11 Options
10047 @cindex PDP-11 Options
10048
10049 These options are defined for the PDP-11:
10050
10051 @table @gcctabopt
10052 @item -mfpu
10053 @opindex mfpu
10054 Use hardware FPP floating point.  This is the default.  (FIS floating
10055 point on the PDP-11/40 is not supported.)
10056
10057 @item -msoft-float
10058 @opindex msoft-float
10059 Do not use hardware floating point.
10060
10061 @item -mac0
10062 @opindex mac0
10063 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10064
10065 @item -mno-ac0
10066 @opindex mno-ac0
10067 Return floating-point results in memory.  This is the default.
10068
10069 @item -m40
10070 @opindex m40
10071 Generate code for a PDP-11/40.
10072
10073 @item -m45
10074 @opindex m45
10075 Generate code for a PDP-11/45.  This is the default.
10076
10077 @item -m10
10078 @opindex m10
10079 Generate code for a PDP-11/10.
10080
10081 @item -mbcopy-builtin
10082 @opindex bcopy-builtin
10083 Use inline @code{movstrhi} patterns for copying memory.  This is the
10084 default.
10085
10086 @item -mbcopy
10087 @opindex mbcopy
10088 Do not use inline @code{movstrhi} patterns for copying memory.
10089
10090 @item -mint16
10091 @itemx -mno-int32
10092 @opindex mint16
10093 @opindex mno-int32
10094 Use 16-bit @code{int}.  This is the default.
10095
10096 @item -mint32
10097 @itemx -mno-int16
10098 @opindex mint32
10099 @opindex mno-int16
10100 Use 32-bit @code{int}.
10101
10102 @item -mfloat64
10103 @itemx -mno-float32
10104 @opindex mfloat64
10105 @opindex mno-float32
10106 Use 64-bit @code{float}.  This is the default.
10107
10108 @item -mfloat32
10109 @item -mno-float64
10110 @opindex mfloat32
10111 @opindex mno-float64
10112 Use 32-bit @code{float}.
10113
10114 @item -mabshi
10115 @opindex mabshi
10116 Use @code{abshi2} pattern.  This is the default.
10117
10118 @item -mno-abshi
10119 @opindex mno-abshi
10120 Do not use @code{abshi2} pattern.
10121
10122 @item -mbranch-expensive
10123 @opindex mbranch-expensive
10124 Pretend that branches are expensive.  This is for experimenting with
10125 code generation only.
10126
10127 @item -mbranch-cheap
10128 @opindex mbranch-cheap
10129 Do not pretend that branches are expensive.  This is the default.
10130
10131 @item -msplit
10132 @opindex msplit
10133 Generate code for a system with split I&D.
10134
10135 @item -mno-split
10136 @opindex mno-split
10137 Generate code for a system without split I&D.  This is the default.
10138
10139 @item -munix-asm
10140 @opindex munix-asm
10141 Use Unix assembler syntax.  This is the default when configured for
10142 @samp{pdp11-*-bsd}.
10143
10144 @item -mdec-asm
10145 @opindex mdec-asm
10146 Use DEC assembler syntax.  This is the default when configured for any
10147 PDP-11 target other than @samp{pdp11-*-bsd}.
10148 @end table
10149
10150 @node Xstormy16 Options
10151 @subsection Xstormy16 Options
10152 @cindex Xstormy16 Options
10153
10154 These options are defined for Xstormy16:
10155
10156 @table @gcctabopt
10157 @item -msim
10158 @opindex msim
10159 Choose startup files and linker script suitable for the simulator.
10160 @end table
10161
10162 @node FRV Options
10163 @subsection FRV Options
10164 @cindex FRV Options
10165
10166 @table @gcctabopt
10167 @item -mgpr-32
10168 @opindex mgpr-32
10169
10170 Only use the first 32 general purpose registers.
10171
10172 @item -mgpr-64
10173 @opindex mgpr-64
10174
10175 Use all 64 general purpose registers.
10176
10177 @item -mfpr-32
10178 @opindex mfpr-32
10179
10180 Use only the first 32 floating point registers.
10181
10182 @item -mfpr-64
10183 @opindex mfpr-64
10184
10185 Use all 64 floating point registers
10186
10187 @item -mhard-float
10188 @opindex mhard-float
10189
10190 Use hardware instructions for floating point operations.
10191
10192 @item -msoft-float
10193 @opindex msoft-float
10194
10195 Use library routines for floating point operations.
10196
10197 @item -malloc-cc
10198 @opindex malloc-cc
10199
10200 Dynamically allocate condition code registers.
10201
10202 @item -mfixed-cc
10203 @opindex mfixed-cc
10204
10205 Do not try to dynamically allocate condition code registers, only
10206 use @code{icc0} and @code{fcc0}.
10207
10208 @item -mdword
10209 @opindex mdword
10210
10211 Change ABI to use double word insns.
10212
10213 @item -mno-dword
10214 @opindex mno-dword
10215
10216 Do not use double word instructions.
10217
10218 @item -mdouble
10219 @opindex mdouble
10220
10221 Use floating point double instructions.
10222
10223 @item -mno-double
10224 @opindex mno-double
10225
10226 Do not use floating point double instructions.
10227
10228 @item -mmedia
10229 @opindex mmedia
10230
10231 Use media instructions.
10232
10233 @item -mno-media
10234 @opindex mno-media
10235
10236 Do not use media instructions.
10237
10238 @item -mmuladd
10239 @opindex mmuladd
10240
10241 Use multiply and add/subtract instructions.
10242
10243 @item -mno-muladd
10244 @opindex mno-muladd
10245
10246 Do not use multiply and add/subtract instructions.
10247
10248 @item -mlibrary-pic
10249 @opindex mlibrary-pic
10250
10251 Enable PIC support for building libraries
10252
10253 @item -macc-4
10254 @opindex macc-4
10255
10256 Use only the first four media accumulator registers.
10257
10258 @item -macc-8
10259 @opindex macc-8
10260
10261 Use all eight media accumulator registers.
10262
10263 @item -mpack
10264 @opindex mpack
10265
10266 Pack VLIW instructions.
10267
10268 @item -mno-pack
10269 @opindex mno-pack
10270
10271 Do not pack VLIW instructions.
10272
10273 @item -mno-eflags
10274 @opindex mno-eflags
10275
10276 Do not mark ABI switches in e_flags.
10277
10278 @item -mcond-move
10279 @opindex mcond-move
10280
10281 Enable the use of conditional-move instructions (default).
10282
10283 This switch is mainly for debugging the compiler and will likely be removed
10284 in a future version.
10285
10286 @item -mno-cond-move
10287 @opindex mno-cond-move
10288
10289 Disable the use of conditional-move instructions.
10290
10291 This switch is mainly for debugging the compiler and will likely be removed
10292 in a future version.
10293
10294 @item -mscc
10295 @opindex mscc
10296
10297 Enable the use of conditional set instructions (default).
10298
10299 This switch is mainly for debugging the compiler and will likely be removed
10300 in a future version.
10301
10302 @item -mno-scc
10303 @opindex mno-scc
10304
10305 Disable the use of conditional set instructions.
10306
10307 This switch is mainly for debugging the compiler and will likely be removed
10308 in a future version.
10309
10310 @item -mcond-exec
10311 @opindex mcond-exec
10312
10313 Enable the use of conditional execution (default).
10314
10315 This switch is mainly for debugging the compiler and will likely be removed
10316 in a future version.
10317
10318 @item -mno-cond-exec
10319 @opindex mno-cond-exec
10320
10321 Disable the use of conditional execution.
10322
10323 This switch is mainly for debugging the compiler and will likely be removed
10324 in a future version.
10325
10326 @item -mvliw-branch
10327 @opindex mvliw-branch
10328
10329 Run a pass to pack branches into VLIW instructions (default).
10330
10331 This switch is mainly for debugging the compiler and will likely be removed
10332 in a future version.
10333
10334 @item -mno-vliw-branch
10335 @opindex mno-vliw-branch
10336
10337 Do not run a pass to pack branches into VLIW instructions.
10338
10339 This switch is mainly for debugging the compiler and will likely be removed
10340 in a future version.
10341
10342 @item -mmulti-cond-exec
10343 @opindex mmulti-cond-exec
10344
10345 Enable optimization of @code{&&} and @code{||} in conditional execution
10346 (default).
10347
10348 This switch is mainly for debugging the compiler and will likely be removed
10349 in a future version.
10350
10351 @item -mno-multi-cond-exec
10352 @opindex mno-multi-cond-exec
10353
10354 Disable optimization of @code{&&} and @code{||} in conditional execution.
10355
10356 This switch is mainly for debugging the compiler and will likely be removed
10357 in a future version.
10358
10359 @item -mnested-cond-exec
10360 @opindex mnested-cond-exec
10361
10362 Enable nested conditional execution optimizations (default).
10363
10364 This switch is mainly for debugging the compiler and will likely be removed
10365 in a future version.
10366
10367 @item -mno-nested-cond-exec
10368 @opindex mno-nested-cond-exec
10369
10370 Disable nested conditional execution optimizations.
10371
10372 This switch is mainly for debugging the compiler and will likely be removed
10373 in a future version.
10374
10375 @item -mtomcat-stats
10376 @opindex mtomcat-stats
10377
10378 Cause gas to print out tomcat statistics.
10379
10380 @item -mcpu=@var{cpu}
10381 @opindex mcpu
10382
10383 Select the processor type for which to generate code.  Possible values are
10384 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10385 @samp{frv}.
10386
10387 @end table
10388
10389 @node Xtensa Options
10390 @subsection Xtensa Options
10391 @cindex Xtensa Options
10392
10393 The Xtensa architecture is designed to support many different
10394 configurations.  The compiler's default options can be set to match a
10395 particular Xtensa configuration by copying a configuration file into the
10396 GCC sources when building GCC@.  The options below may be used to
10397 override the default options.
10398
10399 @table @gcctabopt
10400 @item -mbig-endian
10401 @itemx -mlittle-endian
10402 @opindex mbig-endian
10403 @opindex mlittle-endian
10404 Specify big-endian or little-endian byte ordering for the target Xtensa
10405 processor.
10406
10407 @item -mdensity
10408 @itemx -mno-density
10409 @opindex mdensity
10410 @opindex mno-density
10411 Enable or disable use of the optional Xtensa code density instructions.
10412
10413 @item -mmac16
10414 @itemx -mno-mac16
10415 @opindex mmac16
10416 @opindex mno-mac16
10417 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10418 will generate MAC16 instructions from standard C code, with the
10419 limitation that it will use neither the MR register file nor any
10420 instruction that operates on the MR registers.  When this option is
10421 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10422 combination of core instructions and library calls, depending on whether
10423 any other multiplier options are enabled.
10424
10425 @item -mmul16
10426 @itemx -mno-mul16
10427 @opindex mmul16
10428 @opindex mno-mul16
10429 Enable or disable use of the 16-bit integer multiplier option.  When
10430 enabled, the compiler will generate 16-bit multiply instructions for
10431 multiplications of 16 bits or smaller in standard C code.  When this
10432 option is disabled, the compiler will either use 32-bit multiply or
10433 MAC16 instructions if they are available or generate library calls to
10434 perform the multiply operations using shifts and adds.
10435
10436 @item -mmul32
10437 @itemx -mno-mul32
10438 @opindex mmul32
10439 @opindex mno-mul32
10440 Enable or disable use of the 32-bit integer multiplier option.  When
10441 enabled, the compiler will generate 32-bit multiply instructions for
10442 multiplications of 32 bits or smaller in standard C code.  When this
10443 option is disabled, the compiler will generate library calls to perform
10444 the multiply operations using either shifts and adds or 16-bit multiply
10445 instructions if they are available.
10446
10447 @item -mnsa
10448 @itemx -mno-nsa
10449 @opindex mnsa
10450 @opindex mno-nsa
10451 Enable or disable use of the optional normalization shift amount
10452 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10453
10454 @item -mminmax
10455 @itemx -mno-minmax
10456 @opindex mminmax
10457 @opindex mno-minmax
10458 Enable or disable use of the optional minimum and maximum value
10459 instructions.
10460
10461 @item -msext
10462 @itemx -mno-sext
10463 @opindex msext
10464 @opindex mno-sext
10465 Enable or disable use of the optional sign extend (@code{SEXT})
10466 instruction.
10467
10468 @item -mbooleans
10469 @itemx -mno-booleans
10470 @opindex mbooleans
10471 @opindex mno-booleans
10472 Enable or disable support for the boolean register file used by Xtensa
10473 coprocessors.  This is not typically useful by itself but may be
10474 required for other options that make use of the boolean registers (e.g.,
10475 the floating-point option).
10476
10477 @item -mhard-float
10478 @itemx -msoft-float
10479 @opindex mhard-float
10480 @opindex msoft-float
10481 Enable or disable use of the floating-point option.  When enabled, GCC
10482 generates floating-point instructions for 32-bit @code{float}
10483 operations.  When this option is disabled, GCC generates library calls
10484 to emulate 32-bit floating-point operations using integer instructions.
10485 Regardless of this option, 64-bit @code{double} operations are always
10486 emulated with calls to library functions.
10487
10488 @item -mfused-madd
10489 @itemx -mno-fused-madd
10490 @opindex mfused-madd
10491 @opindex mno-fused-madd
10492 Enable or disable use of fused multiply/add and multiply/subtract
10493 instructions in the floating-point option.  This has no effect if the
10494 floating-point option is not also enabled.  Disabling fused multiply/add
10495 and multiply/subtract instructions forces the compiler to use separate
10496 instructions for the multiply and add/subtract operations.  This may be
10497 desirable in some cases where strict IEEE 754-compliant results are
10498 required: the fused multiply add/subtract instructions do not round the
10499 intermediate result, thereby producing results with @emph{more} bits of
10500 precision than specified by the IEEE standard.  Disabling fused multiply
10501 add/subtract instructions also ensures that the program output is not
10502 sensitive to the compiler's ability to combine multiply and add/subtract
10503 operations.
10504
10505 @item -mserialize-volatile
10506 @itemx -mno-serialize-volatile
10507 @opindex mserialize-volatile
10508 @opindex mno-serialize-volatile
10509 When this option is enabled, GCC inserts @code{MEMW} instructions before
10510 @code{volatile} memory references to guarantee sequential consistency.
10511 The default is @option{-mserialize-volatile}.  Use
10512 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
10513
10514 @item -mtext-section-literals
10515 @itemx -mno-text-section-literals
10516 @opindex mtext-section-literals
10517 @opindex mno-text-section-literals
10518 Control the treatment of literal pools.  The default is
10519 @option{-mno-text-section-literals}, which places literals in a separate
10520 section in the output file.  This allows the literal pool to be placed
10521 in a data RAM/ROM, and it also allows the linker to combine literal
10522 pools from separate object files to remove redundant literals and
10523 improve code size.  With @option{-mtext-section-literals}, the literals
10524 are interspersed in the text section in order to keep them as close as
10525 possible to their references.  This may be necessary for large assembly
10526 files.
10527
10528 @item -mtarget-align
10529 @itemx -mno-target-align
10530 @opindex mtarget-align
10531 @opindex mno-target-align
10532 When this option is enabled, GCC instructs the assembler to
10533 automatically align instructions to reduce branch penalties at the
10534 expense of some code density.  The assembler attempts to widen density
10535 instructions to align branch targets and the instructions following call
10536 instructions.  If there are not enough preceding safe density
10537 instructions to align a target, no widening will be performed.  The
10538 default is @option{-mtarget-align}.  These options do not affect the
10539 treatment of auto-aligned instructions like @code{LOOP}, which the
10540 assembler will always align, either by widening density instructions or
10541 by inserting no-op instructions.
10542
10543 @item -mlongcalls
10544 @itemx -mno-longcalls
10545 @opindex mlongcalls
10546 @opindex mno-longcalls
10547 When this option is enabled, GCC instructs the assembler to translate
10548 direct calls to indirect calls unless it can determine that the target
10549 of a direct call is in the range allowed by the call instruction.  This
10550 translation typically occurs for calls to functions in other source
10551 files.  Specifically, the assembler translates a direct @code{CALL}
10552 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10553 The default is @option{-mno-longcalls}.  This option should be used in
10554 programs where the call target can potentially be out of range.  This
10555 option is implemented in the assembler, not the compiler, so the
10556 assembly code generated by GCC will still show direct call
10557 instructions---look at the disassembled object code to see the actual
10558 instructions.  Note that the assembler will use an indirect call for
10559 every cross-file call, not just those that really will be out of range.
10560 @end table
10561
10562 @node Code Gen Options
10563 @section Options for Code Generation Conventions
10564 @cindex code generation conventions
10565 @cindex options, code generation
10566 @cindex run-time options
10567
10568 These machine-independent options control the interface conventions
10569 used in code generation.
10570
10571 Most of them have both positive and negative forms; the negative form
10572 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10573 one of the forms is listed---the one which is not the default.  You
10574 can figure out the other form by either removing @samp{no-} or adding
10575 it.
10576
10577 @table @gcctabopt
10578 @item -fexceptions
10579 @opindex fexceptions
10580 Enable exception handling.  Generates extra code needed to propagate
10581 exceptions.  For some targets, this implies GCC will generate frame
10582 unwind information for all functions, which can produce significant data
10583 size overhead, although it does not affect execution.  If you do not
10584 specify this option, GCC will enable it by default for languages like
10585 C++ which normally require exception handling, and disable it for
10586 languages like C that do not normally require it.  However, you may need
10587 to enable this option when compiling C code that needs to interoperate
10588 properly with exception handlers written in C++.  You may also wish to
10589 disable this option if you are compiling older C++ programs that don't
10590 use exception handling.
10591
10592 @item -fnon-call-exceptions
10593 @opindex fnon-call-exceptions
10594 Generate code that allows trapping instructions to throw exceptions.
10595 Note that this requires platform-specific runtime support that does
10596 not exist everywhere.  Moreover, it only allows @emph{trapping}
10597 instructions to throw exceptions, i.e.@: memory references or floating
10598 point instructions.  It does not allow exceptions to be thrown from
10599 arbitrary signal handlers such as @code{SIGALRM}.
10600
10601 @item -funwind-tables
10602 @opindex funwind-tables
10603 Similar to @option{-fexceptions}, except that it will just generate any needed
10604 static data, but will not affect the generated code in any other way.
10605 You will normally not enable this option; instead, a language processor
10606 that needs this handling would enable it on your behalf.
10607
10608 @item -fasynchronous-unwind-tables
10609 @opindex funwind-tables
10610 Generate unwind table in dwarf2 format, if supported by target machine.  The
10611 table is exact at each instruction boundary, so it can be used for stack
10612 unwinding from asynchronous events (such as debugger or garbage collector).
10613
10614 @item -fpcc-struct-return
10615 @opindex fpcc-struct-return
10616 Return ``short'' @code{struct} and @code{union} values in memory like
10617 longer ones, rather than in registers.  This convention is less
10618 efficient, but it has the advantage of allowing intercallability between
10619 GCC-compiled files and files compiled with other compilers, particularly
10620 the Portable C Compiler (pcc).
10621
10622 The precise convention for returning structures in memory depends
10623 on the target configuration macros.
10624
10625 Short structures and unions are those whose size and alignment match
10626 that of some integer type.
10627
10628 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10629 switch is not binary compatible with code compiled with the
10630 @option{-freg-struct-return} switch.
10631 Use it to conform to a non-default application binary interface.
10632
10633 @item -freg-struct-return
10634 @opindex freg-struct-return
10635 Return @code{struct} and @code{union} values in registers when possible.
10636 This is more efficient for small structures than
10637 @option{-fpcc-struct-return}.
10638
10639 If you specify neither @option{-fpcc-struct-return} nor
10640 @option{-freg-struct-return}, GCC defaults to whichever convention is
10641 standard for the target.  If there is no standard convention, GCC
10642 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10643 the principal compiler.  In those cases, we can choose the standard, and
10644 we chose the more efficient register return alternative.
10645
10646 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10647 switch is not binary compatible with code compiled with the
10648 @option{-fpcc-struct-return} switch.
10649 Use it to conform to a non-default application binary interface.
10650
10651 @item -fshort-enums
10652 @opindex fshort-enums
10653 Allocate to an @code{enum} type only as many bytes as it needs for the
10654 declared range of possible values.  Specifically, the @code{enum} type
10655 will be equivalent to the smallest integer type which has enough room.
10656
10657 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10658 code that is not binary compatible with code generated without that switch.
10659 Use it to conform to a non-default application binary interface.
10660
10661 @item -fshort-double
10662 @opindex fshort-double
10663 Use the same size for @code{double} as for @code{float}.
10664
10665 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10666 code that is not binary compatible with code generated without that switch.
10667 Use it to conform to a non-default application binary interface.
10668
10669 @item -fshort-wchar
10670 @opindex fshort-wchar
10671 Override the underlying type for @samp{wchar_t} to be @samp{short
10672 unsigned int} instead of the default for the target.  This option is
10673 useful for building programs to run under WINE@.
10674
10675 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10676 code that is not binary compatible with code generated without that switch.
10677 Use it to conform to a non-default application binary interface.
10678
10679 @item -fshared-data
10680 @opindex fshared-data
10681 Requests that the data and non-@code{const} variables of this
10682 compilation be shared data rather than private data.  The distinction
10683 makes sense only on certain operating systems, where shared data is
10684 shared between processes running the same program, while private data
10685 exists in one copy per process.
10686
10687 @item -fno-common
10688 @opindex fno-common
10689 In C, allocate even uninitialized global variables in the data section of the
10690 object file, rather than generating them as common blocks.  This has the
10691 effect that if the same variable is declared (without @code{extern}) in
10692 two different compilations, you will get an error when you link them.
10693 The only reason this might be useful is if you wish to verify that the
10694 program will work on other systems which always work this way.
10695
10696 @item -fno-ident
10697 @opindex fno-ident
10698 Ignore the @samp{#ident} directive.
10699
10700 @item -fno-gnu-linker
10701 @opindex fno-gnu-linker
10702 Do not output global initializations (such as C++ constructors and
10703 destructors) in the form used by the GNU linker (on systems where the GNU
10704 linker is the standard method of handling them).  Use this option when
10705 you want to use a non-GNU linker, which also requires using the
10706 @command{collect2} program to make sure the system linker includes
10707 constructors and destructors.  (@command{collect2} is included in the GCC
10708 distribution.)  For systems which @emph{must} use @command{collect2}, the
10709 compiler driver @command{gcc} is configured to do this automatically.
10710
10711 @item -finhibit-size-directive
10712 @opindex finhibit-size-directive
10713 Don't output a @code{.size} assembler directive, or anything else that
10714 would cause trouble if the function is split in the middle, and the
10715 two halves are placed at locations far apart in memory.  This option is
10716 used when compiling @file{crtstuff.c}; you should not need to use it
10717 for anything else.
10718
10719 @item -fverbose-asm
10720 @opindex fverbose-asm
10721 Put extra commentary information in the generated assembly code to
10722 make it more readable.  This option is generally only of use to those
10723 who actually need to read the generated assembly code (perhaps while
10724 debugging the compiler itself).
10725
10726 @option{-fno-verbose-asm}, the default, causes the
10727 extra information to be omitted and is useful when comparing two assembler
10728 files.
10729
10730 @item -fvolatile
10731 @opindex fvolatile
10732 Consider all memory references through pointers to be volatile.
10733
10734 @item -fvolatile-global
10735 @opindex fvolatile-global
10736 Consider all memory references to extern and global data items to
10737 be volatile.  GCC does not consider static data items to be volatile
10738 because of this switch.
10739
10740 @item -fvolatile-static
10741 @opindex fvolatile-static
10742 Consider all memory references to static data to be volatile.
10743
10744 @item -fpic
10745 @opindex fpic
10746 @cindex global offset table
10747 @cindex PIC
10748 Generate position-independent code (PIC) suitable for use in a shared
10749 library, if supported for the target machine.  Such code accesses all
10750 constant addresses through a global offset table (GOT)@.  The dynamic
10751 loader resolves the GOT entries when the program starts (the dynamic
10752 loader is not part of GCC; it is part of the operating system).  If
10753 the GOT size for the linked executable exceeds a machine-specific
10754 maximum size, you get an error message from the linker indicating that
10755 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10756 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
10757 on the m68k and RS/6000.  The 386 has no such limit.)
10758
10759 Position-independent code requires special support, and therefore works
10760 only on certain machines.  For the 386, GCC supports PIC for System V
10761 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
10762 position-independent.
10763
10764 @item -fPIC
10765 @opindex fPIC
10766 If supported for the target machine, emit position-independent code,
10767 suitable for dynamic linking and avoiding any limit on the size of the
10768 global offset table.  This option makes a difference on the m68k, m88k,
10769 and the SPARC.
10770
10771 Position-independent code requires special support, and therefore works
10772 only on certain machines.
10773
10774 @item -ffixed-@var{reg}
10775 @opindex ffixed
10776 Treat the register named @var{reg} as a fixed register; generated code
10777 should never refer to it (except perhaps as a stack pointer, frame
10778 pointer or in some other fixed role).
10779
10780 @var{reg} must be the name of a register.  The register names accepted
10781 are machine-specific and are defined in the @code{REGISTER_NAMES}
10782 macro in the machine description macro file.
10783
10784 This flag does not have a negative form, because it specifies a
10785 three-way choice.
10786
10787 @item -fcall-used-@var{reg}
10788 @opindex fcall-used
10789 Treat the register named @var{reg} as an allocable register that is
10790 clobbered by function calls.  It may be allocated for temporaries or
10791 variables that do not live across a call.  Functions compiled this way
10792 will not save and restore the register @var{reg}.
10793
10794 It is an error to used this flag with the frame pointer or stack pointer.
10795 Use of this flag for other registers that have fixed pervasive roles in
10796 the machine's execution model will produce disastrous results.
10797
10798 This flag does not have a negative form, because it specifies a
10799 three-way choice.
10800
10801 @item -fcall-saved-@var{reg}
10802 @opindex fcall-saved
10803 Treat the register named @var{reg} as an allocable register saved by
10804 functions.  It may be allocated even for temporaries or variables that
10805 live across a call.  Functions compiled this way will save and restore
10806 the register @var{reg} if they use it.
10807
10808 It is an error to used this flag with the frame pointer or stack pointer.
10809 Use of this flag for other registers that have fixed pervasive roles in
10810 the machine's execution model will produce disastrous results.
10811
10812 A different sort of disaster will result from the use of this flag for
10813 a register in which function values may be returned.
10814
10815 This flag does not have a negative form, because it specifies a
10816 three-way choice.
10817
10818 @item -fpack-struct
10819 @opindex fpack-struct
10820 Pack all structure members together without holes.
10821
10822 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
10823 code that is not binary compatible with code generated without that switch.
10824 Additionally, it makes the code suboptimal.
10825 Use it to conform to a non-default application binary interface.
10826
10827 @item -finstrument-functions
10828 @opindex finstrument-functions
10829 Generate instrumentation calls for entry and exit to functions.  Just
10830 after function entry and just before function exit, the following
10831 profiling functions will be called with the address of the current
10832 function and its call site.  (On some platforms,
10833 @code{__builtin_return_address} does not work beyond the current
10834 function, so the call site information may not be available to the
10835 profiling functions otherwise.)
10836
10837 @example
10838 void __cyg_profile_func_enter (void *this_fn,
10839                                void *call_site);
10840 void __cyg_profile_func_exit  (void *this_fn,
10841                                void *call_site);
10842 @end example
10843
10844 The first argument is the address of the start of the current function,
10845 which may be looked up exactly in the symbol table.
10846
10847 This instrumentation is also done for functions expanded inline in other
10848 functions.  The profiling calls will indicate where, conceptually, the
10849 inline function is entered and exited.  This means that addressable
10850 versions of such functions must be available.  If all your uses of a
10851 function are expanded inline, this may mean an additional expansion of
10852 code size.  If you use @samp{extern inline} in your C code, an
10853 addressable version of such functions must be provided.  (This is
10854 normally the case anyways, but if you get lucky and the optimizer always
10855 expands the functions inline, you might have gotten away without
10856 providing static copies.)
10857
10858 A function may be given the attribute @code{no_instrument_function}, in
10859 which case this instrumentation will not be done.  This can be used, for
10860 example, for the profiling functions listed above, high-priority
10861 interrupt routines, and any functions from which the profiling functions
10862 cannot safely be called (perhaps signal handlers, if the profiling
10863 routines generate output or allocate memory).
10864
10865 @item -fstack-check
10866 @opindex fstack-check
10867 Generate code to verify that you do not go beyond the boundary of the
10868 stack.  You should specify this flag if you are running in an
10869 environment with multiple threads, but only rarely need to specify it in
10870 a single-threaded environment since stack overflow is automatically
10871 detected on nearly all systems if there is only one stack.
10872
10873 Note that this switch does not actually cause checking to be done; the
10874 operating system must do that.  The switch causes generation of code
10875 to ensure that the operating system sees the stack being extended.
10876
10877 @item -fstack-limit-register=@var{reg}
10878 @itemx -fstack-limit-symbol=@var{sym}
10879 @itemx -fno-stack-limit
10880 @opindex fstack-limit-register
10881 @opindex fstack-limit-symbol
10882 @opindex fno-stack-limit
10883 Generate code to ensure that the stack does not grow beyond a certain value,
10884 either the value of a register or the address of a symbol.  If the stack
10885 would grow beyond the value, a signal is raised.  For most targets,
10886 the signal is raised before the stack overruns the boundary, so
10887 it is possible to catch the signal without taking special precautions.
10888
10889 For instance, if the stack starts at absolute address @samp{0x80000000}
10890 and grows downwards, you can use the flags
10891 @option{-fstack-limit-symbol=__stack_limit} and
10892 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
10893 of 128KB@.  Note that this may only work with the GNU linker.
10894
10895 @cindex aliasing of parameters
10896 @cindex parameters, aliased
10897 @item -fargument-alias
10898 @itemx -fargument-noalias
10899 @itemx -fargument-noalias-global
10900 @opindex fargument-alias
10901 @opindex fargument-noalias
10902 @opindex fargument-noalias-global
10903 Specify the possible relationships among parameters and between
10904 parameters and global data.
10905
10906 @option{-fargument-alias} specifies that arguments (parameters) may
10907 alias each other and may alias global storage.@*
10908 @option{-fargument-noalias} specifies that arguments do not alias
10909 each other, but may alias global storage.@*
10910 @option{-fargument-noalias-global} specifies that arguments do not
10911 alias each other and do not alias global storage.
10912
10913 Each language will automatically use whatever option is required by
10914 the language standard.  You should not need to use these options yourself.
10915
10916 @item -fleading-underscore
10917 @opindex fleading-underscore
10918 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
10919 change the way C symbols are represented in the object file.  One use
10920 is to help link with legacy assembly code.
10921
10922 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
10923 generate code that is not binary compatible with code generated without that
10924 switch.  Use it to conform to a non-default application binary interface.
10925 Not all targets provide complete support for this switch.
10926
10927 @item -ftls-model=@var{model}
10928 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
10929 The @var{model} argument should be one of @code{global-dynamic},
10930 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
10931
10932 The default without @option{-fpic} is @code{initial-exec}; with
10933 @option{-fpic} the default is @code{global-dynamic}.
10934 @end table
10935
10936 @c man end
10937
10938 @node Environment Variables
10939 @section Environment Variables Affecting GCC
10940 @cindex environment variables
10941
10942 @c man begin ENVIRONMENT
10943
10944 This section describes several environment variables that affect how GCC
10945 operates.  Some of them work by specifying directories or prefixes to use
10946 when searching for various kinds of files.  Some are used to specify other
10947 aspects of the compilation environment.
10948
10949 Note that you can also specify places to search using options such as
10950 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
10951 take precedence over places specified using environment variables, which
10952 in turn take precedence over those specified by the configuration of GCC@.
10953 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
10954 GNU Compiler Collection (GCC) Internals}.
10955
10956 @table @env
10957 @item LANG
10958 @itemx LC_CTYPE
10959 @c @itemx LC_COLLATE
10960 @itemx LC_MESSAGES
10961 @c @itemx LC_MONETARY
10962 @c @itemx LC_NUMERIC
10963 @c @itemx LC_TIME
10964 @itemx LC_ALL
10965 @findex LANG
10966 @findex LC_CTYPE
10967 @c @findex LC_COLLATE
10968 @findex LC_MESSAGES
10969 @c @findex LC_MONETARY
10970 @c @findex LC_NUMERIC
10971 @c @findex LC_TIME
10972 @findex LC_ALL
10973 @cindex locale
10974 These environment variables control the way that GCC uses
10975 localization information that allow GCC to work with different
10976 national conventions.  GCC inspects the locale categories
10977 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
10978 so.  These locale categories can be set to any value supported by your
10979 installation.  A typical value is @samp{en_UK} for English in the United
10980 Kingdom.
10981
10982 The @env{LC_CTYPE} environment variable specifies character
10983 classification.  GCC uses it to determine the character boundaries in
10984 a string; this is needed for some multibyte encodings that contain quote
10985 and escape characters that would otherwise be interpreted as a string
10986 end or escape.
10987
10988 The @env{LC_MESSAGES} environment variable specifies the language to
10989 use in diagnostic messages.
10990
10991 If the @env{LC_ALL} environment variable is set, it overrides the value
10992 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
10993 and @env{LC_MESSAGES} default to the value of the @env{LANG}
10994 environment variable.  If none of these variables are set, GCC
10995 defaults to traditional C English behavior.
10996
10997 @item TMPDIR
10998 @findex TMPDIR
10999 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11000 files.  GCC uses temporary files to hold the output of one stage of
11001 compilation which is to be used as input to the next stage: for example,
11002 the output of the preprocessor, which is the input to the compiler
11003 proper.
11004
11005 @item GCC_EXEC_PREFIX
11006 @findex GCC_EXEC_PREFIX
11007 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11008 names of the subprograms executed by the compiler.  No slash is added
11009 when this prefix is combined with the name of a subprogram, but you can
11010 specify a prefix that ends with a slash if you wish.
11011
11012 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11013 an appropriate prefix to use based on the pathname it was invoked with.
11014
11015 If GCC cannot find the subprogram using the specified prefix, it
11016 tries looking in the usual places for the subprogram.
11017
11018 The default value of @env{GCC_EXEC_PREFIX} is
11019 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11020 of @code{prefix} when you ran the @file{configure} script.
11021
11022 Other prefixes specified with @option{-B} take precedence over this prefix.
11023
11024 This prefix is also used for finding files such as @file{crt0.o} that are
11025 used for linking.
11026
11027 In addition, the prefix is used in an unusual way in finding the
11028 directories to search for header files.  For each of the standard
11029 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11030 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11031 replacing that beginning with the specified prefix to produce an
11032 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11033 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11034 These alternate directories are searched first; the standard directories
11035 come next.
11036
11037 @item COMPILER_PATH
11038 @findex COMPILER_PATH
11039 The value of @env{COMPILER_PATH} is a colon-separated list of
11040 directories, much like @env{PATH}.  GCC tries the directories thus
11041 specified when searching for subprograms, if it can't find the
11042 subprograms using @env{GCC_EXEC_PREFIX}.
11043
11044 @item LIBRARY_PATH
11045 @findex LIBRARY_PATH
11046 The value of @env{LIBRARY_PATH} is a colon-separated list of
11047 directories, much like @env{PATH}.  When configured as a native compiler,
11048 GCC tries the directories thus specified when searching for special
11049 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11050 using GCC also uses these directories when searching for ordinary
11051 libraries for the @option{-l} option (but directories specified with
11052 @option{-L} come first).
11053
11054 @item LANG
11055 @findex LANG
11056 @cindex locale definition
11057 This variable is used to pass locale information to the compiler.  One way in
11058 which this information is used is to determine the character set to be used
11059 when character literals, string literals and comments are parsed in C and C++.
11060 When the compiler is configured to allow multibyte characters,
11061 the following values for @env{LANG} are recognized:
11062
11063 @table @samp
11064 @item C-JIS
11065 Recognize JIS characters.
11066 @item C-SJIS
11067 Recognize SJIS characters.
11068 @item C-EUCJP
11069 Recognize EUCJP characters.
11070 @end table
11071
11072 If @env{LANG} is not defined, or if it has some other value, then the
11073 compiler will use mblen and mbtowc as defined by the default locale to
11074 recognize and translate multibyte characters.
11075 @end table
11076
11077 @noindent
11078 Some additional environments variables affect the behavior of the
11079 preprocessor.
11080
11081 @include cppenv.texi
11082
11083 @c man end
11084
11085 @node Running Protoize
11086 @section Running Protoize
11087
11088 The program @code{protoize} is an optional part of GCC@.  You can use
11089 it to add prototypes to a program, thus converting the program to ISO
11090 C in one respect.  The companion program @code{unprotoize} does the
11091 reverse: it removes argument types from any prototypes that are found.
11092
11093 When you run these programs, you must specify a set of source files as
11094 command line arguments.  The conversion programs start out by compiling
11095 these files to see what functions they define.  The information gathered
11096 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11097
11098 After scanning comes actual conversion.  The specified files are all
11099 eligible to be converted; any files they include (whether sources or
11100 just headers) are eligible as well.
11101
11102 But not all the eligible files are converted.  By default,
11103 @code{protoize} and @code{unprotoize} convert only source and header
11104 files in the current directory.  You can specify additional directories
11105 whose files should be converted with the @option{-d @var{directory}}
11106 option.  You can also specify particular files to exclude with the
11107 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11108 directory name matches one of the specified directory names, and its
11109 name within the directory has not been excluded.
11110
11111 Basic conversion with @code{protoize} consists of rewriting most
11112 function definitions and function declarations to specify the types of
11113 the arguments.  The only ones not rewritten are those for varargs
11114 functions.
11115
11116 @code{protoize} optionally inserts prototype declarations at the
11117 beginning of the source file, to make them available for any calls that
11118 precede the function's definition.  Or it can insert prototype
11119 declarations with block scope in the blocks where undeclared functions
11120 are called.
11121
11122 Basic conversion with @code{unprotoize} consists of rewriting most
11123 function declarations to remove any argument types, and rewriting
11124 function definitions to the old-style pre-ISO form.
11125
11126 Both conversion programs print a warning for any function declaration or
11127 definition that they can't convert.  You can suppress these warnings
11128 with @option{-q}.
11129
11130 The output from @code{protoize} or @code{unprotoize} replaces the
11131 original source file.  The original file is renamed to a name ending
11132 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11133 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11134 for DOS) file already exists, then the source file is simply discarded.
11135
11136 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11137 scan the program and collect information about the functions it uses.
11138 So neither of these programs will work until GCC is installed.
11139
11140 Here is a table of the options you can use with @code{protoize} and
11141 @code{unprotoize}.  Each option works with both programs unless
11142 otherwise stated.
11143
11144 @table @code
11145 @item -B @var{directory}
11146 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11147 usual directory (normally @file{/usr/local/lib}).  This file contains
11148 prototype information about standard system functions.  This option
11149 applies only to @code{protoize}.
11150
11151 @item -c @var{compilation-options}
11152 Use  @var{compilation-options} as the options when running @code{gcc} to
11153 produce the @samp{.X} files.  The special option @option{-aux-info} is
11154 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
11155
11156 Note that the compilation options must be given as a single argument to
11157 @code{protoize} or @code{unprotoize}.  If you want to specify several
11158 @code{gcc} options, you must quote the entire set of compilation options
11159 to make them a single word in the shell.
11160
11161 There are certain @code{gcc} arguments that you cannot use, because they
11162 would produce the wrong kind of output.  These include @option{-g},
11163 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11164 the @var{compilation-options}, they are ignored.
11165
11166 @item -C
11167 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11168 systems) instead of @samp{.c}.  This is convenient if you are converting
11169 a C program to C++.  This option applies only to @code{protoize}.
11170
11171 @item -g
11172 Add explicit global declarations.  This means inserting explicit
11173 declarations at the beginning of each source file for each function
11174 that is called in the file and was not declared.  These declarations
11175 precede the first function definition that contains a call to an
11176 undeclared function.  This option applies only to @code{protoize}.
11177
11178 @item -i @var{string}
11179 Indent old-style parameter declarations with the string @var{string}.
11180 This option applies only to @code{protoize}.
11181
11182 @code{unprotoize} converts prototyped function definitions to old-style
11183 function definitions, where the arguments are declared between the
11184 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11185 uses five spaces as the indentation.  If you want to indent with just
11186 one space instead, use @option{-i " "}.
11187
11188 @item -k
11189 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11190 is finished.
11191
11192 @item -l
11193 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11194 a prototype declaration for each function in each block which calls the
11195 function without any declaration.  This option applies only to
11196 @code{protoize}.
11197
11198 @item -n
11199 Make no real changes.  This mode just prints information about the conversions
11200 that would have been done without @option{-n}.
11201
11202 @item -N
11203 Make no @samp{.save} files.  The original files are simply deleted.
11204 Use this option with caution.
11205
11206 @item -p @var{program}
11207 Use the program @var{program} as the compiler.  Normally, the name
11208 @file{gcc} is used.
11209
11210 @item -q
11211 Work quietly.  Most warnings are suppressed.
11212
11213 @item -v
11214 Print the version number, just like @option{-v} for @code{gcc}.
11215 @end table
11216
11217 If you need special compiler options to compile one of your program's
11218 source files, then you should generate that file's @samp{.X} file
11219 specially, by running @code{gcc} on that source file with the
11220 appropriate options and the option @option{-aux-info}.  Then run
11221 @code{protoize} on the entire set of files.  @code{protoize} will use
11222 the existing @samp{.X} file because it is newer than the source file.
11223 For example:
11224
11225 @example
11226 gcc -Dfoo=bar file1.c -aux-info file1.X
11227 protoize *.c
11228 @end example
11229
11230 @noindent
11231 You need to include the special files along with the rest in the
11232 @code{protoize} command, even though their @samp{.X} files already
11233 exist, because otherwise they won't get converted.
11234
11235 @xref{Protoize Caveats}, for more information on how to use
11236 @code{protoize} successfully.