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