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