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.
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
26 @c Set file name and title for the man page.
28 @settitle GNU project C and C++ compiler
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}.
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}.
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.
52 See the Info entry for @file{gcc}, or
53 @w{@uref{http://gcc.gnu.org/thanks.html}}, for contributors to 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
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.
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
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
136 * Environment Variables:: Env vars that affect GCC.
137 * Running Protoize:: Automatically adding or removing function prototypes.
143 @section Option Summary
145 Here is a summary of all the options, grouped by type. Explanations are
146 in the following sections.
149 @item Overall Options
150 @xref{Overall Options,,Options Controlling the Kind of Output}.
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}.
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}.
169 -fno-access-control -fcheck-new -fconserve-space @gol
170 -fdollars-in-identifiers -fno-elide-constructors @gol
171 -fno-enforce-eh-specs -fexternal-templates @gol
172 -falt-external-templates @gol
173 -ffor-scope -fno-for-scope -fno-gnu-keywords -fhonor-std @gol
174 -fhuge-objects -fno-implicit-templates @gol
175 -fno-implicit-inline-templates @gol
176 -fno-implement-inlines -fms-extensions @gol
177 -fno-operator-names @gol
178 -fno-optional-diags -fpermissive @gol
179 -frepo -fno-rtti -ftemplate-depth-@var{n} @gol
180 -fuse-cxa-atexit -fvtable-thunks -nostdinc++ @gol
181 -fno-default-inline -Wctor-dtor-privacy @gol
182 -Wnon-virtual-dtor -Wreorder @gol
183 -Weffc++ -Wno-deprecated @gol
184 -Wno-non-template-friend -Wold-style-cast @gol
185 -Woverloaded-virtual -Wno-pmf-conversions @gol
186 -Wsign-promo -Wsynth}
188 @item Objective-C Language Options
189 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
191 -fconstant-string-class=@var{class name} @gol
192 -fgnu-runtime -fnext-runtime -gen-decls
193 -Wno-protocol -Wselector}
195 @item Language Independent Options
196 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
198 -fmessage-length=@var{n} @gol
199 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
201 @item Warning Options
202 @xref{Warning Options,,Options to Request or Suppress Warnings}.
204 -fsyntax-only -pedantic -pedantic-errors @gol
205 -w -W -Wall -Waggregate-return @gol
206 -Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment @gol
207 -Wconversion -Wdisabled-optimization -Werror @gol
208 -Wfloat-equal -Wformat -Wformat=2 @gol
209 -Wformat-nonliteral -Wformat-security @gol
210 -Wid-clash-@var{len} -Wimplicit -Wimplicit-int @gol
211 -Wimplicit-function-declaration @gol
212 -Werror-implicit-function-declaration @gol
213 -Wimport -Winline @gol
214 -Wlarger-than-@var{len} -Wlong-long @gol
215 -Wmain -Wmissing-braces -Wmissing-declarations @gol
216 -Wmissing-format-attribute -Wmissing-noreturn @gol
217 -Wmultichar -Wno-format-extra-args -Wno-format-y2k @gol
218 -Wno-import -Wpacked -Wpadded @gol
219 -Wparentheses -Wpointer-arith -Wredundant-decls @gol
220 -Wreturn-type -Wsequence-point -Wshadow @gol
221 -Wsign-compare -Wswitch -Wsystem-headers @gol
222 -Wtrigraphs -Wundef -Wuninitialized @gol
223 -Wunknown-pragmas -Wunreachable-code @gol
224 -Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
225 -Wunused-value -Wunused-variable -Wwrite-strings}
227 @item C-only Warning Options
229 -Wbad-function-cast -Wmissing-prototypes -Wnested-externs @gol
230 -Wstrict-prototypes -Wtraditional}
232 @item Debugging Options
233 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
235 -a -ax -d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
236 -fdump-unnumbered -fdump-translation-unit=@var{file} @gol
237 -fdump-class-layout=@var{file} -fmem-report -fpretend-float @gol
238 -fprofile-arcs -ftest-coverage -ftime-report @gol
239 -g -g@var{level} -gcoff -gdwarf -gdwarf-1 -gdwarf-1+ -gdwarf-2 @gol
240 -ggdb -gstabs -gstabs+ -gxcoff -gxcoff+ @gol
241 -p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
242 -print-prog-name=@var{program} -print-search-dirs -Q @gol
245 @item Optimization Options
246 @xref{Optimize Options,,Options that Control Optimization}.
248 -falign-functions=@var{n} -falign-jumps=@var{n} @gol
249 -falign-labels=@var{n} -falign-loops=@var{n} @gol
250 -fbranch-probabilities -fcaller-saves @gol
251 -fcse-follow-jumps -fcse-skip-blocks -fdata-sections -fdce @gol
252 -fdelayed-branch -fdelete-null-pointer-checks @gol
253 -fexpensive-optimizations -ffast-math -ffloat-store @gol
254 -fforce-addr -fforce-mem -ffunction-sections -fgcse @gol
255 -finline-functions -finline-limit=@var{n} -fkeep-inline-functions @gol
256 -fkeep-static-consts -fmove-all-movables @gol
257 -fno-default-inline -fno-defer-pop @gol
258 -fno-function-cse -fno-guess-branch-probability
259 -fno-inline -fno-math-errno -fno-peephole @gol
260 -fomit-frame-pointer -foptimize-register-move @gol
261 -foptimize-sibling-calls -freduce-all-givs @gol
262 -fregmove -frename-registers @gol
263 -frerun-cse-after-loop -frerun-loop-opt @gol
264 -fschedule-insns -fschedule-insns2 @gol
265 -fsingle-precision-constant -fssa @gol
266 -fstrength-reduce -fstrict-aliasing -fthread-jumps -ftrapv @gol
267 -funroll-all-loops -funroll-loops @gol
268 --param @var{name}=@var{value}
269 -O -O0 -O1 -O2 -O3 -Os}
271 @item Preprocessor Options
272 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
274 -$ -A@var{question}=@var{answer} -A-@var{question}@r{[}=@var{answer}@r{]} @gol
275 -C -dD -dI -dM -dN @gol
276 -D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
277 -idirafter @var{dir} @gol
278 -include @var{file} -imacros @var{file} @gol
279 -iprefix @var{file} -iwithprefix @var{dir} @gol
280 -iwithprefixbefore @var{dir} -isystem @var{dir} -isystem-c++ @var{dir} @gol
281 -M -MM -MF -MG -MP -MQ -MT -nostdinc -P -remap @gol
282 -trigraphs -undef -U@var{macro} -Wp\,@var{option}}
284 @item Assembler Option
285 @xref{Assembler Options,,Passing Options to the Assembler}.
290 @xref{Link Options,,Options for Linking}.
292 @var{object-file-name} -l@var{library} @gol
293 -nostartfiles -nodefaultlibs -nostdlib @gol
294 -s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
295 -Wl\,@var{option} -Xlinker @var{option} @gol
298 @item Directory Options
299 @xref{Directory Options,,Options for Directory Search}.
301 -B@var{prefix} -I@var{dir} -I- -L@var{dir} -specs=@var{file}}
304 @c I wrote this xref this way to avoid overfull hbox. -- rms
305 @xref{Target Options}.
307 -b @var{machine} -V @var{version}}
309 @item Machine Dependent Options
310 @xref{Submodel Options,,Hardware Models and Configurations}.
311 @emph{M680x0 Options}
313 -m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
314 -m68060 -mcpu32 -m5200 -m68881 -mbitfield -mc68000 -mc68020 @gol
315 -mfpa -mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
316 -malign-int -mstrict-align}
318 @emph{M68hc1x Options}
320 -m6811 -m6812 -m68hc11 -m68hc12 @gol
321 -mauto-incdec -mshort -msoft-reg-count=@var{count}}
329 -mcpu=@var{cpu type} @gol
330 -mtune=@var{cpu type} @gol
331 -mcmodel=@var{code model} @gol
333 -mapp-regs -mbroken-saverestore -mcypress @gol
334 -mepilogue -mfaster-structs -mflat @gol
335 -mfpu -mhard-float -mhard-quad-float @gol
336 -mimpure-text -mlive-g0 -mno-app-regs @gol
337 -mno-epilogue -mno-faster-structs -mno-flat -mno-fpu @gol
338 -mno-impure-text -mno-stack-bias -mno-unaligned-doubles @gol
339 -msoft-float -msoft-quad-float -msparclite -mstack-bias @gol
340 -msupersparc -munaligned-doubles -mv8}
342 @emph{Convex Options}
344 -mc1 -mc2 -mc32 -mc34 -mc38 @gol
345 -margcount -mnoargcount @gol
346 -mlong32 -mlong64 @gol
347 -mvolatile-cache -mvolatile-nocache}
349 @emph{AMD29K Options}
351 -m29000 -m29050 -mbw -mnbw -mdw -mndw @gol
352 -mlarge -mnormal -msmall @gol
353 -mkernel-registers -mno-reuse-arg-regs @gol
354 -mno-stack-check -mno-storem-bug @gol
355 -mreuse-arg-regs -msoft-float -mstack-check @gol
356 -mstorem-bug -muser-registers}
360 -mapcs-frame -mno-apcs-frame @gol
361 -mapcs-26 -mapcs-32 @gol
362 -mapcs-stack-check -mno-apcs-stack-check @gol
363 -mapcs-float -mno-apcs-float @gol
364 -mapcs-reentrant -mno-apcs-reentrant @gol
365 -msched-prolog -mno-sched-prolog @gol
366 -mlittle-endian -mbig-endian -mwords-little-endian @gol
367 -malignment-traps -mno-alignment-traps @gol
368 -msoft-float -mhard-float -mfpe @gol
369 -mthumb-interwork -mno-thumb-interwork @gol
370 -mcpu= -march= -mfpe= @gol
371 -mstructure-size-boundary= @gol
372 -mbsd -mxopen -mno-symrename @gol
373 -mabort-on-noreturn @gol
374 -mlong-calls -mno-long-calls @gol
375 -mnop-fun-dllimport -mno-nop-fun-dllimport @gol
376 -msingle-pic-base -mno-single-pic-base @gol
381 -mtpcs-frame -mno-tpcs-frame @gol
382 -mtpcs-leaf-frame -mno-tpcs-leaf-frame @gol
383 -mlittle-endian -mbig-endian @gol
384 -mthumb-interwork -mno-thumb-interwork @gol
385 -mstructure-size-boundary= @gol
386 -mnop-fun-dllimport -mno-nop-fun-dllimport @gol
387 -mcallee-super-interworking -mno-callee-super-interworking @gol
388 -mcaller-super-interworking -mno-caller-super-interworking @gol
389 -msingle-pic-base -mno-single-pic-base @gol
392 @emph{MN10200 Options}
396 @emph{MN10300 Options}
404 @emph{M32R/D Options}
406 -mcode-model=@var{model type} -msdata=@var{sdata type} @gol
411 -m88000 -m88100 -m88110 -mbig-pic @gol
412 -mcheck-zero-division -mhandle-large-shift @gol
413 -midentify-revision -mno-check-zero-division @gol
414 -mno-ocs-debug-info -mno-ocs-frame-position @gol
415 -mno-optimize-arg-area -mno-serialize-volatile @gol
416 -mno-underscores -mocs-debug-info @gol
417 -mocs-frame-position -moptimize-arg-area @gol
418 -mserialize-volatile -mshort-data-@var{num} -msvr3 @gol
419 -msvr4 -mtrap-large-shift -muse-div-instruction @gol
420 -mversion-03.00 -mwarn-passed-structs}
422 @emph{RS/6000 and PowerPC Options}
424 -mcpu=@var{cpu type} @gol
425 -mtune=@var{cpu type} @gol
426 -mpower -mno-power -mpower2 -mno-power2 @gol
427 -mpowerpc -mpowerpc64 -mno-powerpc @gol
428 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
429 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
430 -mnew-mnemonics -mold-mnemonics @gol
431 -mfull-toc -mminimal-toc -mno-fop-in-toc -mno-sum-in-toc @gol
432 -m64 -m32 -mxl-call -mno-xl-call -mthreads -mpe @gol
433 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
434 -mstring -mno-string -mupdate -mno-update @gol
435 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
436 -mstrict-align -mno-strict-align -mrelocatable @gol
437 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
438 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
439 -mcall-aix -mcall-sysv -mprototype -mno-prototype @gol
440 -msim -mmvme -mads -myellowknife -memb -msdata @gol
441 -msdata=@var{opt} -mvxworks -G @var{num}}
445 -mcall-lib-mul -mfp-arg-in-fpregs -mfp-arg-in-gregs @gol
446 -mfull-fp-blocks -mhc-struct-return -min-line-mul @gol
447 -mminimum-fp-blocks -mnohc-struct-return}
451 -mabicalls -mcpu=@var{cpu type}
452 -membedded-data -muninit-const-in-rodata @gol
453 -membedded-pic -mfp32 -mfp64 -mgas -mgp32 -mgp64 @gol
454 -mgpopt -mhalf-pic -mhard-float -mint64 -mips1 @gol
455 -mips2 -mips3 -mips4 -mlong64 -mlong32 -mlong-calls -mmemcpy @gol
456 -mmips-as -mmips-tfile -mno-abicalls @gol
457 -mno-embedded-data -mno-uninit-const-in-rodata -mno-embedded-pic @gol
458 -mno-gpopt -mno-long-calls @gol
459 -mno-memcpy -mno-mips-tfile -mno-rnames -mno-stats @gol
460 -mrnames -msoft-float @gol
461 -m4650 -msingle-float -mmad @gol
462 -mstats -EL -EB -G @var{num} -nocpp @gol
463 -mabi=32 -mabi=n32 -mabi=64 -mabi=eabi @gol
468 -mcpu=@var{cpu type} -march=@var{cpu type} @gol
469 -mintel-syntax -mieee-fp -mno-fancy-math-387 @gol
470 -mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
471 -mno-wide-multiply -mrtd -malign-double @gol
472 -mreg-alloc=@var{list} -mregparm=@var{num} @gol
473 -malign-jumps=@var{num} -malign-loops=@var{num} @gol
474 -malign-functions=@var{num} -mpreferred-stack-boundary=@var{num} @gol
475 -mthreads -mno-align-stringops -minline-all-stringops @gol
476 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
481 -march=@var{architecture type} @gol
482 -mbig-switch -mdisable-fpregs -mdisable-indexing @gol
483 -mfast-indirect-calls -mgas -mjump-in-delay @gol
484 -mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
485 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
486 -mno-jump-in-delay -mno-long-load-store @gol
487 -mno-portable-runtime -mno-soft-float @gol
488 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
489 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
490 -mschedule=@var{cpu type} -mspace-regs}
492 @emph{Intel 960 Options}
494 -m@var{cpu type} -masm-compat -mclean-linkage @gol
495 -mcode-align -mcomplex-addr -mleaf-procedures @gol
496 -mic-compat -mic2.0-compat -mic3.0-compat @gol
497 -mintel-asm -mno-clean-linkage -mno-code-align @gol
498 -mno-complex-addr -mno-leaf-procedures @gol
499 -mno-old-align -mno-strict-align -mno-tail-call @gol
500 -mnumerics -mold-align -msoft-float -mstrict-align @gol
503 @emph{DEC Alpha Options}
505 -mfp-regs -mno-fp-regs -mno-soft-float -msoft-float @gol
506 -malpha-as -mgas @gol
507 -mieee -mieee-with-inexact -mieee-conformant @gol
508 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
509 -mtrap-precision=@var{mode} -mbuild-constants @gol
510 -mcpu=@var{cpu type} @gol
511 -mbwx -mno-bwx -mcix -mno-cix -mmax -mno-max @gol
512 -mmemory-latency=@var{time}}
514 @emph{Clipper Options}
518 @emph{H8/300 Options}
520 -mrelax -mh -ms -mint32 -malign-300}
524 -m1 -m2 -m3 -m3e @gol
525 -m4-nofpu -m4-single-only -m4-single -m4 @gol
526 -mb -ml -mdalign -mrelax @gol
527 -mbigtable -mfmovd -mhitachi -mnomacsave @gol
528 -misize -mpadstruct -mspace @gol
532 @emph{System V Options}
534 -Qy -Qn -YP\,@var{paths} -Ym\,@var{dir}}
539 -mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text section} @gol
540 -mdata=@var{data section} -mrodata=@var{readonly data section}}
542 @emph{TMS320C3x/C4x Options}
544 -mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
545 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
546 -mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
547 -mparallel-insns -mparallel-mpy -mpreserve-float}
551 -mlong-calls -mno-long-calls -mep -mno-ep @gol
552 -mprolog-function -mno-prolog-function -mspace @gol
553 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
558 -m32032 -m32332 -m32532 -m32081 -m32381 -mmult-add -mnomult-add @gol
559 -msoft-float -mrtd -mnortd -mregparam -mnoregparam -msb -mnosb @gol
560 -mbitfield -mnobitfield -mhimem -mnohimem}
564 -mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
565 -mcall-prologues -mno-tablejump -mtiny-stack}
569 -mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
570 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
571 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
572 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
573 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
577 -mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
578 -mvolatile-asm-stop -mb-step -mregister-names -mno-sdata @gol
579 -mconstant-gp -mauto-pic -minline-divide-min-latency @gol
580 -minline-divide-max-throughput -mno-dwarf2-asm @gol
581 -mfixed-range=@var{register range}}
583 @item Code Generation Options
584 @xref{Code Gen Options,,Options for Code Generation Conventions}.
586 -fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
587 -fexceptions -funwind-tables -ffixed-@var{reg} @gol
588 -finhibit-size-directive -finstrument-functions @gol
589 -fcheck-memory-usage -fprefix-function-name @gol
590 -fno-common -fno-ident -fno-gnu-linker @gol
591 -fpcc-struct-return -fpic -fPIC @gol
592 -freg-struct-return -fshared-data -fshort-enums @gol
593 -fshort-double -fvolatile -fvolatile-global -fvolatile-static @gol
594 -fverbose-asm -fpack-struct -fstack-check @gol
595 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
596 -fargument-alias -fargument-noalias @gol
597 -fargument-noalias-global @gol
598 -fleading-underscore}
602 * Overall Options:: Controlling the kind of output:
603 an executable, object files, assembler files,
604 or preprocessed source.
605 * C Dialect Options:: Controlling the variant of C language compiled.
606 * C++ Dialect Options:: Variations on C++.
607 * Objective-C Dialect Options:: Variations on Objective-C.
608 * Language Independent Options:: Controlling how diagnostics should be
610 * Warning Options:: How picky should the compiler be?
611 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
612 * Optimize Options:: How much optimization?
613 * Preprocessor Options:: Controlling header files and macro definitions.
614 Also, getting dependency information for Make.
615 * Assembler Options:: Passing options to the assembler.
616 * Link Options:: Specifying libraries and so on.
617 * Directory Options:: Where to find header files and libraries.
618 Where to find the compiler executable files.
619 * Spec Files:: How to pass switches to sub-processes.
620 * Target Options:: Running a cross-compiler, or an old version of GCC.
623 @node Overall Options
624 @section Options Controlling the Kind of Output
626 Compilation can involve up to four stages: preprocessing, compilation
627 proper, assembly and linking, always in that order. The first three
628 stages apply to an individual source file, and end by producing an
629 object file; linking combines all the object files (those newly
630 compiled, and those specified as input) into an executable file.
632 @cindex file name suffix
633 For any given input file, the file name suffix determines what kind of
638 C source code which must be preprocessed.
641 C source code which should not be preprocessed.
644 C++ source code which should not be preprocessed.
647 Objective-C source code. Note that you must link with the library
648 @file{libobjc.a} to make an Objective-C program work.
651 Objective-C source code which should not be preprocessed.
654 C header file (not to be compiled or linked).
658 @itemx @var{file}.cxx
659 @itemx @var{file}.cpp
660 @itemx @var{file}.c++
662 C++ source code which must be preprocessed. Note that in @samp{.cxx},
663 the last two letters must both be literally @samp{x}. Likewise,
664 @samp{.C} refers to a literal capital C.
667 @itemx @var{file}.for
668 @itemx @var{file}.FOR
669 Fortran source code which should not be preprocessed.
672 @itemx @var{file}.fpp
673 @itemx @var{file}.FPP
674 Fortran source code which must be preprocessed (with the traditional
678 Fortran source code which must be preprocessed with a RATFOR
679 preprocessor (not included with GCC).
681 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
682 Using and Porting GNU Fortran}, for more details of the handling of
685 @c FIXME: Descriptions of Java file types.
691 @c GCC also knows about some suffixes for languages not yet included:
701 @itemx @var{file}.chi
702 CHILL source code (preprocessed with the traditional preprocessor).
708 Assembler code which must be preprocessed.
711 An object file to be fed straight into linking.
712 Any file name with no recognized suffix is treated this way.
715 You can specify the input language explicitly with the @samp{-x} option:
718 @item -x @var{language}
719 Specify explicitly the @var{language} for the following input files
720 (rather than letting the compiler choose a default based on the file
721 name suffix). This option applies to all following input files until
722 the next @samp{-x} option. Possible values for @var{language} are:
724 c c-header cpp-output
726 objective-c objc-cpp-output
727 assembler assembler-with-cpp
728 f77 f77-cpp-input ratfor
731 @c Also f77-version, for internal use only.
734 Turn off any specification of a language, so that subsequent files are
735 handled according to their file name suffixes (as they are if @samp{-x}
736 has not been used at all).
738 @item -pass-exit-codes
739 Normally the @command{gcc} program will exit with the code of 1 if any
740 phase of the compiler returns a non-success return code. If you specify
741 @samp{-pass-exit-codes}, the @command{gcc} program will instead return with
742 numerically highest error produced by any phase that returned an error
746 If you only want some of the stages of compilation, you can use
747 @samp{-x} (or filename suffixes) to tell @command{gcc} where to start, and
748 one of the options @samp{-c}, @samp{-S}, or @samp{-E} to say where
749 @command{gcc} is to stop. Note that some combinations (for example,
750 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
754 Compile or assemble the source files, but do not link. The linking
755 stage simply is not done. The ultimate output is in the form of an
756 object file for each source file.
758 By default, the object file name for a source file is made by replacing
759 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
761 Unrecognized input files, not requiring compilation or assembly, are
765 Stop after the stage of compilation proper; do not assemble. The output
766 is in the form of an assembler code file for each non-assembler input
769 By default, the assembler file name for a source file is made by
770 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
772 Input files that don't require compilation are ignored.
775 Stop after the preprocessing stage; do not run the compiler proper. The
776 output is in the form of preprocessed source code, which is sent to the
779 Input files which don't require preprocessing are ignored.
781 @cindex output file option
783 Place output in file @var{file}. This applies regardless to whatever
784 sort of output is being produced, whether it be an executable file,
785 an object file, an assembler file or preprocessed C code.
787 Since only one output file can be specified, it does not make sense to
788 use @samp{-o} when compiling more than one input file, unless you are
789 producing an executable file as output.
791 If @samp{-o} is not specified, the default is to put an executable file
792 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
793 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
794 all preprocessed C source on standard output.@refill
797 Print (on standard error output) the commands executed to run the stages
798 of compilation. Also print the version number of the compiler driver
799 program and of the preprocessor and the compiler proper.
802 Use pipes rather than temporary files for communication between the
803 various stages of compilation. This fails to work on some systems where
804 the assembler is unable to read from a pipe; but the GNU assembler has
808 Print (on the standard output) a description of the command line options
809 understood by @command{gcc}. If the @option{-v} option is also specified
810 then @option{--help} will also be passed on to the various processes
811 invoked by @command{gcc}, so that they can display the command line options
812 they accept. If the @option{-W} option is also specified then command
813 line options which have no documentation associated with them will also
817 Print (on the standard output) a description of target specific command
818 line options for each tool.
822 @section Compiling C++ Programs
824 @cindex suffixes for C++ source
825 @cindex C++ source file suffixes
826 C++ source files conventionally use one of the suffixes @samp{.C},
827 @samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
828 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
829 files with these names and compiles them as C++ programs even if you
830 call the compiler the same way as for compiling C programs (usually with
831 the name @command{gcc}).
835 However, C++ programs often require class libraries as well as a
836 compiler that understands the C++ language---and under some
837 circumstances, you might want to compile programs from standard input,
838 or otherwise without a suffix that flags them as C++ programs.
839 @command{g++} is a program that calls GCC with the default language
840 set to C++, and automatically specifies linking against the C++
841 library. On many systems, @command{g++} is also
842 installed with the name @command{c++}.
844 @cindex invoking @command{g++}
845 When you compile C++ programs, you may specify many of the same
846 command-line options that you use for compiling programs in any
847 language; or command-line options meaningful for C and related
848 languages; or options that are meaningful only for C++ programs.
849 @xref{C Dialect Options,,Options Controlling C Dialect}, for
850 explanations of options for languages related to C.
851 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
852 explanations of options that are meaningful only for C++ programs.
854 @node C Dialect Options
855 @section Options Controlling C Dialect
856 @cindex dialect options
857 @cindex language dialect options
858 @cindex options, dialect
860 The following options control the dialect of C (or languages derived
861 from C, such as C++ and Objective C) that the compiler accepts:
867 In C mode, support all ISO C89 programs. In C++ mode,
868 remove GNU extensions that conflict with ISO C++.
870 This turns off certain features of GCC that are incompatible with ISO
871 C (when compiling C code), or of standard C++ (when compiling C++ code),
872 such as the @code{asm} and @code{typeof} keywords, and
873 predefined macros such as @code{unix} and @code{vax} that identify the
874 type of system you are using. It also enables the undesirable and
875 rarely used ISO trigraph feature. For the C compiler,
876 it disables recognition of C++ style @samp{//} comments as well as
877 the @code{inline} keyword.
879 The alternate keywords @code{__asm__}, @code{__extension__},
880 @code{__inline__} and @code{__typeof__} continue to work despite
881 @samp{-ansi}. You would not want to use them in an ISO C program, of
882 course, but it is useful to put them in header files that might be included
883 in compilations done with @samp{-ansi}. Alternate predefined macros
884 such as @code{__unix__} and @code{__vax__} are also available, with or
885 without @samp{-ansi}.
887 The @samp{-ansi} option does not cause non-ISO programs to be
888 rejected gratuitously. For that, @samp{-pedantic} is required in
889 addition to @samp{-ansi}. @xref{Warning Options}.
891 The macro @code{__STRICT_ANSI__} is predefined when the @samp{-ansi}
892 option is used. Some header files may notice this macro and refrain
893 from declaring certain functions or defining certain macros that the
894 ISO standard doesn't call for; this is to avoid interfering with any
895 programs that might use these names for other things.
897 Functions which would normally be builtin but do not have semantics
898 defined by ISO C (such as @code{alloca} and @code{ffs}) are not builtin
899 functions with @samp{-ansi} is used. @xref{Other Builtins,,Other
900 built-in functions provided by GNU CC}, for details of the functions
904 Determine the language standard. A value for this option must be provided;
909 Same as @option{-ansi}
912 ISO C as modified in amend. 1
915 ISO C99. Note that this standard is not yet fully supported; see
916 @w{@uref{http://gcc.gnu.org/gcc-3.0/c99status.html}} for more information.
919 same as @option{-std=iso9899:1990}
922 same as @option{-std=iso9899:1999}
925 default, iso9899:1990 + gnu extensions
928 iso9899:1999 + gnu extensions
931 same as @option{-std=iso9899:1999}, deprecated
934 same as @option{-std=iso9899:1999}, deprecated
937 same as @option{-std=gnu99}, deprecated
941 Even when this option is not specified, you can still use some of the
942 features of newer standards in so far as they do not conflict with
943 previous C standards. For example, you may use @code{__restrict__} even
944 when @option{-std=c99} is not specified.
946 The @option{-std} options specifying some version of ISO C have the same
947 effects as @option{-ansi}, except that features that were not in ISO C89
948 but are in the specified version (for example, @samp{//} comments and
949 the @code{inline} keyword in ISO C99) are not disabled.
951 @xref{Standards,,Language Standards Supported by GCC}, for details of
952 these standard versions.
955 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
956 keyword, so that code can use these words as identifiers. You can use
957 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
958 instead. @samp{-ansi} implies @samp{-fno-asm}.
960 In C++, this switch only affects the @code{typeof} keyword, since
961 @code{asm} and @code{inline} are standard keywords. You may want to
962 use the @samp{-fno-gnu-keywords} flag instead, which has the same
963 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
964 switch only affects the @code{asm} and @code{typeof} keywords, since
965 @code{inline} is a standard keyword in ISO C99.
968 @cindex builtin functions
969 Don't recognize builtin functions that do not begin with
970 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
971 functions provided by GNU CC}, for details of the functions affected,
972 including those which are not builtin functions when @option{-ansi} or
973 @option{-std} options for strict ISO C conformance are used because they
974 do not have an ISO standard meaning.
976 GCC normally generates special code to handle certain builtin functions
977 more efficiently; for instance, calls to @code{alloca} may become single
978 instructions that adjust the stack directly, and calls to @code{memcpy}
979 may become inline copy loops. The resulting code is often both smaller
980 and faster, but since the function calls no longer appear as such, you
981 cannot set a breakpoint on those calls, nor can you change the behavior
982 of the functions by linking with a different library.
985 @cindex hosted environment
987 Assert that compilation takes place in a hosted environment. This implies
988 @samp{-fbuiltin}. A hosted environment is one in which the
989 entire standard library is available, and in which @code{main} has a return
990 type of @code{int}. Examples are nearly everything except a kernel.
991 This is equivalent to @samp{-fno-freestanding}.
994 @cindex hosted environment
996 Assert that compilation takes place in a freestanding environment. This
997 implies @samp{-fno-builtin}. A freestanding environment
998 is one in which the standard library may not exist, and program startup may
999 not necessarily be at @code{main}. The most obvious example is an OS kernel.
1000 This is equivalent to @samp{-fno-hosted}.
1002 @xref{Standards,,Language Standards Supported by GCC}, for details of
1003 freestanding and hosted environments.
1006 Support ISO C trigraphs. You don't want to know about this
1007 brain-damage. The @option{-ansi} option (and @option{-std} options for
1008 strict ISO C conformance) implies @option{-trigraphs}.
1010 @cindex traditional C language
1011 @cindex C language, traditional
1013 Attempt to support some aspects of traditional C compilers.
1018 All @code{extern} declarations take effect globally even if they
1019 are written inside of a function definition. This includes implicit
1020 declarations of functions.
1023 The newer keywords @code{typeof}, @code{inline}, @code{signed}, @code{const}
1024 and @code{volatile} are not recognized. (You can still use the
1025 alternative keywords such as @code{__typeof__}, @code{__inline__}, and
1029 Comparisons between pointers and integers are always allowed.
1032 Integer types @code{unsigned short} and @code{unsigned char} promote
1033 to @code{unsigned int}.
1036 Out-of-range floating point literals are not an error.
1039 Certain constructs which ISO regards as a single invalid preprocessing
1040 number, such as @samp{0xe-0xd}, are treated as expressions instead.
1043 String ``constants'' are not necessarily constant; they are stored in
1044 writable space, and identical looking constants are allocated
1045 separately. (This is the same as the effect of
1046 @samp{-fwritable-strings}.)
1048 @cindex @code{longjmp} and automatic variables
1050 All automatic variables not declared @code{register} are preserved by
1051 @code{longjmp}. Ordinarily, GNU C follows ISO C: automatic variables
1052 not declared @code{volatile} may be clobbered.
1057 @cindex escape sequences, traditional
1058 The character escape sequences @samp{\x} and @samp{\a} evaluate as the
1059 literal characters @samp{x} and @samp{a} respectively. Without
1060 @w{@samp{-traditional}}, @samp{\x} is a prefix for the hexadecimal
1061 representation of a character, and @samp{\a} produces a bell.
1064 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
1065 if your program uses names that are normally GNU C builtin functions for
1066 other purposes of its own.
1068 You cannot use @samp{-traditional} if you include any header files that
1069 rely on ISO C features. Some vendors are starting to ship systems with
1070 ISO C header files and you cannot use @samp{-traditional} on such
1071 systems to compile files that include any system headers.
1073 The @samp{-traditional} option also enables @samp{-traditional-cpp},
1074 which is described next.
1076 @item -traditional-cpp
1077 Attempt to support some aspects of traditional C preprocessors.
1082 Comments convert to nothing at all, rather than to a space. This allows
1083 traditional token concatenation.
1086 In a preprocessing directive, the @samp{#} symbol must appear as the first
1087 character of a line.
1090 Macro arguments are recognized within string constants in a macro
1091 definition (and their values are stringified, though without additional
1092 quote marks, when they appear in such a context). The preprocessor
1093 always considers a string constant to end at a newline.
1096 @cindex detecting @w{@samp{-traditional}}
1097 The predefined macro @code{__STDC__} is not defined when you use
1098 @samp{-traditional}, but @code{__GNUC__} is (since the GNU extensions
1099 which @code{__GNUC__} indicates are not affected by
1100 @samp{-traditional}). If you need to write header files that work
1101 differently depending on whether @samp{-traditional} is in use, by
1102 testing both of these predefined macros you can distinguish four
1103 situations: GNU C, traditional GNU C, other ISO C compilers, and other
1104 old C compilers. The predefined macro @code{__STDC_VERSION__} is also
1105 not defined when you use @samp{-traditional}. @xref{Standard
1106 Predefined,,Standard Predefined Macros,cpp.info,The C Preprocessor},
1107 for more discussion of these and other predefined macros.
1110 @cindex string constants vs newline
1111 @cindex newline vs string constants
1112 The preprocessor considers a string constant to end at a newline (unless
1113 the newline is escaped with @samp{\}). (Without @w{@samp{-traditional}},
1114 string constants can contain the newline character as typed.)
1117 @item -fcond-mismatch
1118 Allow conditional expressions with mismatched types in the second and
1119 third arguments. The value of such an expression is void. This option
1120 is not supported for C++.
1122 @item -funsigned-char
1123 Let the type @code{char} be unsigned, like @code{unsigned char}.
1125 Each kind of machine has a default for what @code{char} should
1126 be. It is either like @code{unsigned char} by default or like
1127 @code{signed char} by default.
1129 Ideally, a portable program should always use @code{signed char} or
1130 @code{unsigned char} when it depends on the signedness of an object.
1131 But many programs have been written to use plain @code{char} and
1132 expect it to be signed, or expect it to be unsigned, depending on the
1133 machines they were written for. This option, and its inverse, let you
1134 make such a program work with the opposite default.
1136 The type @code{char} is always a distinct type from each of
1137 @code{signed char} or @code{unsigned char}, even though its behavior
1138 is always just like one of those two.
1141 Let the type @code{char} be signed, like @code{signed char}.
1143 Note that this is equivalent to @samp{-fno-unsigned-char}, which is
1144 the negative form of @samp{-funsigned-char}. Likewise, the option
1145 @samp{-fno-signed-char} is equivalent to @samp{-funsigned-char}.
1147 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
1148 if your program uses names that are normally GNU C builtin functions for
1149 other purposes of its own.
1151 You cannot use @samp{-traditional} if you include any header files that
1152 rely on ISO C features. Some vendors are starting to ship systems with
1153 ISO C header files and you cannot use @samp{-traditional} on such
1154 systems to compile files that include any system headers.
1156 @item -fsigned-bitfields
1157 @itemx -funsigned-bitfields
1158 @itemx -fno-signed-bitfields
1159 @itemx -fno-unsigned-bitfields
1160 These options control whether a bitfield is signed or unsigned, when the
1161 declaration does not use either @code{signed} or @code{unsigned}. By
1162 default, such a bitfield is signed, because this is consistent: the
1163 basic integer types such as @code{int} are signed types.
1165 However, when @samp{-traditional} is used, bitfields are all unsigned
1168 @item -fwritable-strings
1169 Store string constants in the writable data segment and don't uniquize
1170 them. This is for compatibility with old programs which assume they can
1171 write into string constants. The option @samp{-traditional} also has
1174 Writing into string constants is a very bad idea; ``constants'' should
1177 @item -fallow-single-precision
1178 Do not promote single precision math operations to double precision,
1179 even when compiling with @samp{-traditional}.
1181 Traditional K&R C promotes all floating point operations to double
1182 precision, regardless of the sizes of the operands. On the
1183 architecture for which you are compiling, single precision may be faster
1184 than double precision. If you must use @samp{-traditional}, but want
1185 to use single precision operations when the operands are single
1186 precision, use this option. This option has no effect when compiling
1187 with ISO or GNU C conventions (the default).
1190 Override the underlying type for @samp{wchar_t} to be @samp{short
1191 unsigned int} instead of the default for the target. This option is
1192 useful for building programs to run under WINE.
1195 @node C++ Dialect Options
1196 @section Options Controlling C++ Dialect
1198 @cindex compiler options, C++
1199 @cindex C++ options, command line
1200 @cindex options, C++
1201 This section describes the command-line options that are only meaningful
1202 for C++ programs; but you can also use most of the GNU compiler options
1203 regardless of what language your program is in. For example, you
1204 might compile a file @code{firstClass.C} like this:
1207 g++ -g -frepo -O -c firstClass.C
1211 In this example, only @samp{-frepo} is an option meant
1212 only for C++ programs; you can use the other options with any
1213 language supported by GCC.
1215 Here is a list of options that are @emph{only} for compiling C++ programs:
1218 @item -fno-access-control
1219 Turn off all access checking. This switch is mainly useful for working
1220 around bugs in the access control code.
1223 Check that the pointer returned by @code{operator new} is non-null
1224 before attempting to modify the storage allocated. The current Working
1225 Paper requires that @code{operator new} never return a null pointer, so
1226 this check is normally unnecessary.
1228 An alternative to using this option is to specify that your
1229 @code{operator new} does not throw any exceptions; if you declare it
1230 @samp{throw()}, g++ will check the return value. See also @samp{new
1233 @item -fconserve-space
1234 Put uninitialized or runtime-initialized global variables into the
1235 common segment, as C does. This saves space in the executable at the
1236 cost of not diagnosing duplicate definitions. If you compile with this
1237 flag and your program mysteriously crashes after @code{main()} has
1238 completed, you may have an object that is being destroyed twice because
1239 two definitions were merged.
1241 This option is no longer useful on most targets, now that support has
1242 been added for putting variables into BSS without making them common.
1244 @item -fno-const-strings
1245 Give string constants type @code{char *} instead of type @code{const
1246 char *}. By default, G++ uses type @code{const char *} as required by
1247 the standard. Even if you use @samp{-fno-const-strings}, you cannot
1248 actually modify the value of a string constant, unless you also use
1249 @samp{-fwritable-strings}.
1251 This option might be removed in a future release of G++. For maximum
1252 portability, you should structure your code so that it works with
1253 string constants that have type @code{const char *}.
1255 @item -fdollars-in-identifiers
1256 Accept @samp{$} in identifiers. You can also explicitly prohibit use of
1257 @samp{$} with the option @samp{-fno-dollars-in-identifiers}. (GNU C allows
1258 @samp{$} by default on most target systems, but there are a few exceptions.)
1259 Traditional C allowed the character @samp{$} to form part of
1260 identifiers. However, ISO C and C++ forbid @samp{$} in identifiers.
1262 @item -fno-elide-constructors
1263 The C++ standard allows an implementation to omit creating a temporary
1264 which is only used to initialize another object of the same type.
1265 Specifying this option disables that optimization, and forces g++ to
1266 call the copy constructor in all cases.
1268 @item -fno-enforce-eh-specs
1269 Don't check for violation of exception specifications at runtime. This
1270 option violates the C++ standard, but may be useful for reducing code
1271 size in production builds, much like defining @samp{NDEBUG}. The compiler
1272 will still optimize based on the exception specifications.
1274 @item -fexternal-templates
1275 Cause template instantiations to obey @samp{#pragma interface} and
1276 @samp{implementation}; template instances are emitted or not according
1277 to the location of the template definition. @xref{Template
1278 Instantiation}, for more information.
1280 This option is deprecated.
1282 @item -falt-external-templates
1283 Similar to -fexternal-templates, but template instances are emitted or
1284 not according to the place where they are first instantiated.
1285 @xref{Template Instantiation}, for more information.
1287 This option is deprecated.
1290 @itemx -fno-for-scope
1291 If -ffor-scope is specified, the scope of variables declared in
1292 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1293 as specified by the C++ standard.
1294 If -fno-for-scope is specified, the scope of variables declared in
1295 a @i{for-init-statement} extends to the end of the enclosing scope,
1296 as was the case in old versions of gcc, and other (traditional)
1297 implementations of C++.
1299 The default if neither flag is given to follow the standard,
1300 but to allow and give a warning for old-style code that would
1301 otherwise be invalid, or have different behavior.
1303 @item -fno-gnu-keywords
1304 Do not recognize @code{typeof} as a keyword, so that code can use this
1305 word as an identifier. You can use the keyword @code{__typeof__} instead.
1306 @samp{-ansi} implies @samp{-fno-gnu-keywords}.
1309 Treat the @code{namespace std} as a namespace, instead of ignoring
1310 it. For compatibility with earlier versions of g++, the compiler will,
1311 by default, ignore @code{namespace-declarations},
1312 @code{using-declarations}, @code{using-directives}, and
1313 @code{namespace-names}, if they involve @code{std}.
1315 @item -fhuge-objects
1316 Support virtual function calls for objects that exceed the size
1317 representable by a @samp{short int}. Users should not use this flag by
1318 default; if you need to use it, the compiler will tell you so.
1320 This flag is not useful when compiling with -fvtable-thunks.
1322 Like all options that change the ABI, all C++ code, @emph{including
1323 libgcc} must be built with the same setting of this option.
1325 @item -fno-implicit-templates
1326 Never emit code for non-inline templates which are instantiated
1327 implicitly (i.e. by use); only emit code for explicit instantiations.
1328 @xref{Template Instantiation}, for more information.
1330 @item -fno-implicit-inline-templates
1331 Don't emit code for implicit instantiations of inline templates, either.
1332 The default is to handle inlines differently so that compiles with and
1333 without optimization will need the same set of explicit instantiations.
1335 @item -fno-implement-inlines
1336 To save space, do not emit out-of-line copies of inline functions
1337 controlled by @samp{#pragma implementation}. This will cause linker
1338 errors if these functions are not inlined everywhere they are called.
1340 @item -fms-extensions
1341 Disable pedantic warnings about constructs used in MFC, such as implicit
1342 int and getting a pointer to member function via non-standard syntax.
1344 @item -fno-nonansi-builtins
1345 Disable builtin declarations of functions that are not mandated by
1346 ANSI/ISO C. These include @code{ffs}, @code{alloca}, @code{_exit},
1347 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1349 @item -fno-operator-names
1350 Do not treat the operator name keywords @code{and}, @code{bitand},
1351 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1352 synonyms as keywords.
1354 @item -fno-optional-diags
1355 Disable diagnostics that the standard says a compiler does not need to
1356 issue. Currently, the only such diagnostic issued by g++ is the one for
1357 a name having multiple meanings within a class.
1360 Downgrade messages about nonconformant code from errors to warnings. By
1361 default, g++ effectively sets @samp{-pedantic-errors} without
1362 @samp{-pedantic}; this option reverses that. This behavior and this
1363 option are superseded by @samp{-pedantic}, which works as it does for GNU C.
1366 Enable automatic template instantiation. This option also implies
1367 @samp{-fno-implicit-templates}. @xref{Template Instantiation}, for more
1371 Disable generation of information about every class with virtual
1372 functions for use by the C++ runtime type identification features
1373 (@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1374 of the language, you can save some space by using this flag. Note that
1375 exception handling uses the same information, but it will generate it as
1379 Emit statistics about front-end processing at the end of the compilation.
1380 This information is generally only useful to the G++ development team.
1382 @item -ftemplate-depth-@var{n}
1383 Set the maximum instantiation depth for template classes to @var{n}.
1384 A limit on the template instantiation depth is needed to detect
1385 endless recursions during template class instantiation. ANSI/ISO C++
1386 conforming programs must not rely on a maximum depth greater than 17.
1388 @item -fuse-cxa-atexit
1389 Register destructors for objects with static storage duration with the
1390 @code{__cxa_atexit} function rather than the @code{atexit} function.
1391 This option is required for fully standards-compliant handling of static
1392 destructors, but will only work if your C library supports
1393 @code{__cxa_atexit}.
1395 @item -fvtable-thunks
1396 Use @samp{thunks} to implement the virtual function dispatch table
1397 (@samp{vtable}). The traditional (cfront-style) approach to
1398 implementing vtables was to store a pointer to the function and two
1399 offsets for adjusting the @samp{this} pointer at the call site. Newer
1400 implementations store a single pointer to a @samp{thunk} function which
1401 does any necessary adjustment and then calls the target function.
1403 This option also enables a heuristic for controlling emission of
1404 vtables; if a class has any non-inline virtual functions, the vtable
1405 will be emitted in the translation unit containing the first one of
1408 Like all options that change the ABI, all C++ code, @emph{including
1409 libgcc.a} must be built with the same setting of this option.
1412 Do not use weak symbol support, even if it is provied by the linker.
1413 By default, G++ will use weak symbols if they are available. This
1414 option exists only for testing, and should not be used by end-users;
1415 it will result in inferior code and has no benefits. This option may
1416 be removed in a future release of G++.
1419 Do not search for header files in the standard directories specific to
1420 C++, but do still search the other standard directories. (This option
1421 is used when building the C++ library.)
1424 In addition, these optimization, warning, and code generation options
1425 have meanings only for C++ programs:
1428 @item -fno-default-inline
1429 Do not assume @samp{inline} for functions defined inside a class scope.
1430 @xref{Optimize Options,,Options That Control Optimization}. Note that these
1431 functions will have linkage like inline functions; they just won't be
1434 @item -Wctor-dtor-privacy (C++ only)
1435 Warn when a class seems unusable, because all the constructors or
1436 destructors in a class are private and the class has no friends or
1437 public static member functions.
1439 @item -Wnon-virtual-dtor (C++ only)
1440 Warn when a class declares a non-virtual destructor that should probably
1441 be virtual, because it looks like the class will be used polymorphically.
1443 @item -Wreorder (C++ only)
1444 @cindex reordering, warning
1445 @cindex warning for reordering of member initializers
1446 Warn when the order of member initializers given in the code does not
1447 match the order in which they must be executed. For instance:
1453 A(): j (0), i (1) @{ @}
1457 Here the compiler will warn that the member initializers for @samp{i}
1458 and @samp{j} will be rearranged to match the declaration order of the
1462 The following @samp{-W@dots{}} options are not affected by @samp{-Wall}.
1465 @item -Weffc++ (C++ only)
1466 Warn about violations of various style guidelines from Scott Meyers'
1467 @cite{Effective C++} books. If you use this option, you should be aware
1468 that the standard library headers do not obey all of these guidelines;
1469 you can use @samp{grep -v} to filter out those warnings.
1471 @item -Wno-deprecated (C++ only)
1472 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1474 @item -Wno-non-template-friend (C++ only)
1475 Disable warnings when non-templatized friend functions are declared
1476 within a template. With the advent of explicit template specification
1477 support in g++, if the name of the friend is an unqualified-id (ie,
1478 @samp{friend foo(int)}), the C++ language specification demands that the
1479 friend declare or define an ordinary, nontemplate function. (Section
1480 14.5.3). Before g++ implemented explicit specification, unqualified-ids
1481 could be interpreted as a particular specialization of a templatized
1482 function. Because this non-conforming behavior is no longer the default
1483 behavior for g++, @samp{-Wnon-template-friend} allows the compiler to
1484 check existing code for potential trouble spots, and is on by default.
1485 This new compiler behavior can be turned off with
1486 @samp{-Wno-non-template-friend} which keeps the conformant compiler code
1487 but disables the helpful warning.
1489 @item -Wold-style-cast (C++ only)
1490 Warn if an old-style (C-style) cast is used within a C++ program. The
1491 new-style casts (@samp{static_cast}, @samp{reinterpret_cast}, and
1492 @samp{const_cast}) are less vulnerable to unintended effects.
1494 @item -Woverloaded-virtual (C++ only)
1495 @cindex overloaded virtual fn, warning
1496 @cindex warning for overloaded virtual fn
1497 Warn when a derived class function declaration may be an error in
1498 defining a virtual function. In a derived class, the
1499 definitions of virtual functions must match the type signature of a
1500 virtual function declared in the base class. With this option, the
1501 compiler warns when you define a function with the same name as a
1502 virtual function, but with a type signature that does not match any
1503 declarations from the base class.
1505 @item -Wno-pmf-conversions (C++ only)
1506 Disable the diagnostic for converting a bound pointer to member function
1509 @item -Wsign-promo (C++ only)
1510 Warn when overload resolution chooses a promotion from unsigned or
1511 enumeral type to a signed type over a conversion to an unsigned type of
1512 the same size. Previous versions of g++ would try to preserve
1513 unsignedness, but the standard mandates the current behavior.
1515 @item -Wsynth (C++ only)
1516 @cindex warning for synthesized methods
1517 @cindex synthesized methods, warning
1518 Warn when g++'s synthesis behavior does not match that of cfront. For
1524 A& operator = (int);
1534 In this example, g++ will synthesize a default @samp{A& operator =
1535 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1538 @node Objective-C Dialect Options
1539 @section Options Controlling Objective-C Dialect
1541 @cindex compiler options, Objective-C
1542 @cindex Objective-C options, command line
1543 @cindex options, Objective-C
1544 This section describes the command-line options that are only meaningful
1545 for Objective-C programs; but you can also use most of the GNU compiler
1546 options regardless of what language your program is in. For example,
1547 you might compile a file @code{some_class.m} like this:
1550 gcc -g -fgnu-runtime -O -c some_class.m
1554 In this example, only @samp{-fgnu-runtime} is an option meant only for
1555 Objective-C programs; you can use the other options with any language
1558 Here is a list of options that are @emph{only} for compiling Objective-C
1562 @item -fconstant-string-class=@var{class name}
1563 Use @var{class name} as the name of the class to instantiate for each
1564 literal string specified with the syntax @code{@@"..."}. The default
1565 class name is @code{NXConstantString}.
1568 Generate object code compatible with the standard GNU Objective-C
1569 runtime. This is the default for most types of systems.
1571 @item -fnext-runtime
1572 Generate output compatible with the NeXT runtime. This is the default
1573 for NeXT-based systems, including Darwin and Mac OS X.
1576 Dump interface declarations for all classes seen in the source file to a
1577 file named @file{@var{sourcename}.decl}.
1580 Do not warn if methods required by a protocol are not implemented
1581 in the class adopting it.
1584 Warn if a selector has multiple methods of different types defined.
1586 @c not documented because only avail via -Wp
1587 @c @item -print-objc-runtime-info
1591 @node Language Independent Options
1592 @section Options to Control Diagnostic Messages Formatting
1593 @cindex options to control diagnostics formatting
1594 @cindex diagnostic messages
1595 @cindex message formatting
1597 Traditionally, diagnostic messages have been formatted irrespective of
1598 the output device's aspect (e.g. its width, ...). The options described
1599 below can be used to control the diagnostic messages formatting
1600 algorithm, e.g. how many characters per line, how often source location
1601 information should be reported. Right now, only the C++ front-end can
1602 honor these options. However it is expected, in the near future, that
1603 the remaining front-ends would be able to digest them correctly.
1606 @item -fmessage-length=@var{n}
1607 Try to format error messages so that they fit on lines of about @var{n}
1608 characters. The default is 72 characters for g++ and 0 for the rest of
1609 the front-ends supported by GCC. If @var{n} is zero, then no
1610 line-wrapping will be done; each error message will appear on a single
1613 @item -fdiagnostics-show-location=once
1614 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
1615 reporter to emit @emph{once} source location information; that is, in
1616 case the message is too long to fit on a single physical line and has to
1617 be wrapped, the source location won't be emitted (as prefix) again,
1618 over and over, in subsequent continuation lines. This is the default
1621 @item -fdiagnostics-show-location=every-line
1622 Only meaningful in line-wrapping mode. Instructs the diagnostic
1623 messages reporter to emit the same source location information (as
1624 prefix) for physical lines that result from the process of breaking a
1625 a message which is too long to fit on a single line.
1629 @node Warning Options
1630 @section Options to Request or Suppress Warnings
1631 @cindex options to control warnings
1632 @cindex warning messages
1633 @cindex messages, warning
1634 @cindex suppressing warnings
1636 Warnings are diagnostic messages that report constructions which
1637 are not inherently erroneous but which are risky or suggest there
1638 may have been an error.
1640 You can request many specific warnings with options beginning @samp{-W},
1641 for example @samp{-Wimplicit} to request warnings on implicit
1642 declarations. Each of these specific warning options also has a
1643 negative form beginning @samp{-Wno-} to turn off warnings;
1644 for example, @samp{-Wno-implicit}. This manual lists only one of the
1645 two forms, whichever is not the default.
1647 These options control the amount and kinds of warnings produced by GCC:
1650 @cindex syntax checking
1652 Check the code for syntax errors, but don't do anything beyond that.
1655 Issue all the warnings demanded by strict ISO C and ISO C++;
1656 reject all programs that use forbidden extensions, and some other
1657 programs that do not follow ISO C and ISO C++. For ISO C, follows the
1658 version of the ISO C standard specified by any @samp{-std} option used.
1660 Valid ISO C and ISO C++ programs should compile properly with or without
1661 this option (though a rare few will require @option{-ansi} or a
1662 @option{-std} option specifying the required version of ISO C). However,
1663 without this option, certain GNU extensions and traditional C and C++
1664 features are supported as well. With this option, they are rejected.
1666 @samp{-pedantic} does not cause warning messages for use of the
1667 alternate keywords whose names begin and end with @samp{__}. Pedantic
1668 warnings are also disabled in the expression that follows
1669 @code{__extension__}. However, only system header files should use
1670 these escape routes; application programs should avoid them.
1671 @xref{Alternate Keywords}.
1673 Some users try to use @samp{-pedantic} to check programs for strict ISO
1674 C conformance. They soon find that it does not do quite what they want:
1675 it finds some non-ISO practices, but not all---only those for which
1676 ISO C @emph{requires} a diagnostic, and some others for which
1677 diagnostics have been added.
1679 A feature to report any failure to conform to ISO C might be useful in
1680 some instances, but would require considerable additional work and would
1681 be quite different from @samp{-pedantic}. We don't have plans to
1682 support such a feature in the near future.
1684 @item -pedantic-errors
1685 Like @samp{-pedantic}, except that errors are produced rather than
1689 Inhibit all warning messages.
1692 Inhibit warning messages about the use of @samp{#import}.
1694 @item -Wchar-subscripts
1695 Warn if an array subscript has type @code{char}. This is a common cause
1696 of error, as programmers often forget that this type is signed on some
1700 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1701 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1704 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1705 the arguments supplied have types appropriate to the format string
1706 specified, and that the conversions specified in the format string make
1707 sense. This includes standard functions, and others specified by format
1708 attributes (@pxref{Function Attributes}), in the @code{printf},
1709 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1710 not in the C standard) families.
1712 The formats are checked against the format features supported by GNU
1713 libc version 2.2. These include all ISO C89 and C99 features, as well
1714 as features from the Single Unix Specification and some BSD and GNU
1715 extensions. Other library implementations may not support all these
1716 features; GCC does not support warning about features that go beyond a
1717 particular library's limitations. However, if @samp{-pedantic} is used
1718 with @samp{-Wformat}, warnings will be given about format features not
1719 in the selected standard version (but not for @code{strfmon} formats,
1720 since those are not in any version of the C standard). @xref{C Dialect
1721 Options,,Options Controlling C Dialect}.
1723 @samp{-Wformat} is included in @samp{-Wall}. For more control over some
1724 aspects of format checking, the options @samp{-Wno-format-y2k},
1725 @samp{-Wno-format-extra-args}, @samp{-Wformat-nonliteral},
1726 @samp{-Wformat-security} and @samp{-Wformat=2} are available, but are
1727 not included in @samp{-Wall}.
1729 @item -Wno-format-y2k
1730 If @samp{-Wformat} is specified, do not warn about @code{strftime}
1731 formats which may yield only a two-digit year.
1733 @item -Wno-format-extra-args
1734 If @samp{-Wformat} is specified, do not warn about excess arguments to a
1735 @code{printf} or @code{scanf} format function. The C standard specifies
1736 that such arguments are ignored.
1738 @item -Wformat-nonliteral
1739 If @samp{-Wformat} is specified, also warn if the format string is not a
1740 string literal and so cannot be checked, unless the format function
1741 takes its format arguments as a @code{va_list}.
1743 @item -Wformat-security
1744 If @samp{-Wformat} is specified, also warn about uses of format
1745 functions that represent possible security problems. At present, this
1746 warns about calls to @code{printf} and @code{scanf} functions where the
1747 format string is not a string literal and there are no format arguments,
1748 as in @code{printf (foo);}. This may be a security hole if the format
1749 string came from untrusted input and contains @samp{%n}. (This is
1750 currently a subset of what @samp{-Wformat-nonliteral} warns about, but
1751 in future warnings may be added to @samp{-Wformat-security} that are not
1752 included in @samp{-Wformat-nonliteral}.)
1755 Enable @samp{-Wformat} plus format checks not included in
1756 @samp{-Wformat}. Currently equivalent to @samp{-Wformat
1757 -Wformat-nonliteral -Wformat-security}.
1759 @item -Wimplicit-int
1760 Warn when a declaration does not specify a type.
1762 @item -Wimplicit-function-declaration
1763 @itemx -Werror-implicit-function-declaration
1764 Give a warning (or error) whenever a function is used before being
1768 Same as @samp{-Wimplicit-int} and @samp{-Wimplicit-function-}@*
1772 Warn if the type of @samp{main} is suspicious. @samp{main} should be a
1773 function with external linkage, returning int, taking either zero
1774 arguments, two, or three arguments of appropriate types.
1776 @item -Wmissing-braces
1777 Warn if an aggregate or union initializer is not fully bracketed. In
1778 the following example, the initializer for @samp{a} is not fully
1779 bracketed, but that for @samp{b} is fully bracketed.
1782 int a[2][2] = @{ 0, 1, 2, 3 @};
1783 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
1787 Warn if a multicharacter constant (@samp{'FOOF'}) is used. Usually they
1788 indicate a typo in the user's code, as they have implementation-defined
1789 values, and should not be used in portable code.
1792 Warn if parentheses are omitted in certain contexts, such
1793 as when there is an assignment in a context where a truth value
1794 is expected, or when operators are nested whose precedence people
1795 often get confused about.
1797 Also warn about constructions where there may be confusion to which
1798 @code{if} statement an @code{else} branch belongs. Here is an example of
1811 In C, every @code{else} branch belongs to the innermost possible @code{if}
1812 statement, which in this example is @code{if (b)}. This is often not
1813 what the programmer expected, as illustrated in the above example by
1814 indentation the programmer chose. When there is the potential for this
1815 confusion, GNU C will issue a warning when this flag is specified.
1816 To eliminate the warning, add explicit braces around the innermost
1817 @code{if} statement so there is no way the @code{else} could belong to
1818 the enclosing @code{if}. The resulting code would look like this:
1832 @item -Wsequence-point
1833 Warn about code that may have undefined semantics because of violations
1834 of sequence point rules in the C standard.
1836 The C standard defines the order in which expressions in a C program are
1837 evaluated in terms of @dfn{sequence points}, which represent a partial
1838 ordering between the execution of parts of the program: those executed
1839 before the sequence point, and those executed after it. These occur
1840 after the evaluation of a full expression (one which is not part of a
1841 larger expression), after the evaluation of the first operand of a
1842 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
1843 function is called (but after the evaluation of its arguments and the
1844 expression denoting the called function), and in certain other places.
1845 Other than as expressed by the sequence point rules, the order of
1846 evaluation of subexpressions of an expression is not specified. All
1847 these rules describe only a partial order rather than a total order,
1848 since, for example, if two functions are called within one expression
1849 with no sequence point between them, the order in which the functions
1850 are called is not specified. However, the standards committee have
1851 ruled that function calls do not overlap.
1853 It is not specified when between sequence points modifications to the
1854 values of objects take effect. Programs whose behavior depends on this
1855 have undefined behavior; the C standard specifies that ``Between the
1856 previous and next sequence point an object shall have its stored value
1857 modified at most once by the evaluation of an expression. Furthermore,
1858 the prior value shall be read only to determine the value to be
1859 stored.''. If a program breaks these rules, the results on any
1860 particular implementation are entirely unpredictable.
1862 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
1863 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
1864 diagnosed by this option, and it may give an occasional false positive
1865 result, but in general it has been found fairly effective at detecting
1866 this sort of problem in programs.
1868 The present implementation of this option only works for C programs. A
1869 future implementation may also work for C++ programs.
1871 There is some controversy over the precise meaning of the sequence point
1872 rules in subtle cases. Alternative formal definitions may be found in
1873 Clive Feather's ``Annex S''
1874 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n925.htm}} and in
1875 Michael Norrish's thesis
1876 @w{@uref{http://www.cl.cam.ac.uk/users/mn200/PhD/thesis-report.ps.gz}}.
1877 Other discussions are by Raymond Mak
1878 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n926.htm}} and
1880 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n927.htm}}.
1883 Warn whenever a function is defined with a return-type that defaults to
1884 @code{int}. Also warn about any @code{return} statement with no
1885 return-value in a function whose return-type is not @code{void}.
1887 For C++, a function without return type always produces a diagnostic
1888 message, even when @samp{-Wno-return-type} is specified. The only
1889 exceptions are @samp{main} and functions defined in system headers.
1892 Warn whenever a @code{switch} statement has an index of enumeral type
1893 and lacks a @code{case} for one or more of the named codes of that
1894 enumeration. (The presence of a @code{default} label prevents this
1895 warning.) @code{case} labels outside the enumeration range also
1896 provoke warnings when this option is used.
1899 Warn if any trigraphs are encountered that might change the meaning of
1900 the program (trigraphs within comments are not warned about).
1902 @item -Wunused-function
1903 Warn whenever a static function is declared but not defined or a
1904 non\-inline static function is unused.
1906 @item -Wunused-label
1907 Warn whenever a label is declared but not used.
1909 To suppress this warning use the @samp{unused} attribute
1910 (@pxref{Variable Attributes}).
1912 @item -Wunused-parameter
1913 Warn whenever a function parameter is unused aside from its declaration.
1915 To suppress this warning use the @samp{unused} attribute
1916 (@pxref{Variable Attributes}).
1918 @item -Wunused-variable
1919 Warn whenever a local variable or non-constant static variable is unused
1920 aside from its declaration
1922 To suppress this warning use the @samp{unused} attribute
1923 (@pxref{Variable Attributes}).
1925 @item -Wunused-value
1926 Warn whenever a statement computes a result that is explicitly not used.
1928 To suppress this warning cast the expression to @samp{void}.
1931 All all the above @samp{-Wunused} options combined.
1933 In order to get a warning about an unused function parameter, you must
1934 either specify @samp{-W -Wunused} or separately specify
1935 @samp{-Wunused-parameter}.
1937 @item -Wuninitialized
1938 Warn if an automatic variable is used without first being initialized or
1939 if a variable may be clobbered by a @code{setjmp} call.
1941 These warnings are possible only in optimizing compilation,
1942 because they require data flow information that is computed only
1943 when optimizing. If you don't specify @samp{-O}, you simply won't
1946 These warnings occur only for variables that are candidates for
1947 register allocation. Therefore, they do not occur for a variable that
1948 is declared @code{volatile}, or whose address is taken, or whose size
1949 is other than 1, 2, 4 or 8 bytes. Also, they do not occur for
1950 structures, unions or arrays, even when they are in registers.
1952 Note that there may be no warning about a variable that is used only
1953 to compute a value that itself is never used, because such
1954 computations may be deleted by data flow analysis before the warnings
1957 These warnings are made optional because GCC is not smart
1958 enough to see all the reasons why the code might be correct
1959 despite appearing to have an error. Here is one example of how
1978 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
1979 always initialized, but GCC doesn't know this. Here is
1980 another common case:
1985 if (change_y) save_y = y, y = new_y;
1987 if (change_y) y = save_y;
1992 This has no bug because @code{save_y} is used only if it is set.
1994 @cindex @code{longjmp} warnings
1995 This option also warns when a non-volatile automatic variable might be
1996 changed by a call to @code{longjmp}. These warnings as well are possible
1997 only in optimizing compilation.
1999 The compiler sees only the calls to @code{setjmp}. It cannot know
2000 where @code{longjmp} will be called; in fact, a signal handler could
2001 call it at any point in the code. As a result, you may get a warning
2002 even when there is in fact no problem because @code{longjmp} cannot
2003 in fact be called at the place which would cause a problem.
2005 Some spurious warnings can be avoided if you declare all the functions
2006 you use that never return as @code{noreturn}. @xref{Function
2009 @item -Wreorder (C++ only)
2010 @cindex reordering, warning
2011 @cindex warning for reordering of member initializers
2012 Warn when the order of member initializers given in the code does not
2013 match the order in which they must be executed. For instance:
2015 @item -Wunknown-pragmas
2016 @cindex warning for unknown pragmas
2017 @cindex unknown pragmas, warning
2018 @cindex pragmas, warning of unknown
2019 Warn when a #pragma directive is encountered which is not understood by
2020 GCC. If this command line option is used, warnings will even be issued
2021 for unknown pragmas in system header files. This is not the case if
2022 the warnings were only enabled by the @samp{-Wall} command line option.
2025 All of the above @samp{-W} options combined. This enables all the
2026 warnings about constructions that some users consider questionable, and
2027 that are easy to avoid (or modify to prevent the warning), even in
2028 conjunction with macros.
2030 @item -Wsystem-headers
2031 @cindex warnings from system headers
2032 @cindex system headers, warnings from
2033 Print warning messages for constructs found in system header files.
2034 Warnings from system headers are normally suppressed, on the assumption
2035 that they usually do not indicate real problems and would only make the
2036 compiler output harder to read. Using this command line option tells
2037 GCC to emit warnings from system headers as if they occurred in user
2038 code. However, note that using @samp{-Wall} in conjunction with this
2039 option will @emph{not} warn about unknown pragmas in system
2040 headers---for that, @samp{-Wunknown-pragmas} must also be used.
2043 The following @samp{-W@dots{}} options are not implied by @samp{-Wall}.
2044 Some of them warn about constructions that users generally do not
2045 consider questionable, but which occasionally you might wish to check
2046 for; others warn about constructions that are necessary or hard to avoid
2047 in some cases, and there is no simple way to modify the code to suppress
2052 Print extra warning messages for these events:
2056 A function can return either with or without a value. (Falling
2057 off the end of the function body is considered returning without
2058 a value.) For example, this function would evoke such a
2072 An expression-statement or the left-hand side of a comma expression
2073 contains no side effects.
2074 To suppress the warning, cast the unused expression to void.
2075 For example, an expression such as @samp{x[i,j]} will cause a warning,
2076 but @samp{x[(void)i,j]} will not.
2079 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
2082 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2083 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2084 that of ordinary mathematical notation.
2087 Storage-class specifiers like @code{static} are not the first things in
2088 a declaration. According to the C Standard, this usage is obsolescent.
2091 The return type of a function has a type qualifier such as @code{const}.
2092 Such a type qualifier has no effect, since the value returned by a
2093 function is not an lvalue. (But don't warn about the GNU extension of
2094 @code{volatile void} return types. That extension will be warned about
2095 if @samp{-pedantic} is specified.)
2098 If @samp{-Wall} or @samp{-Wunused} is also specified, warn about unused
2102 A comparison between signed and unsigned values could produce an
2103 incorrect result when the signed value is converted to unsigned.
2104 (But don't warn if @samp{-Wno-sign-compare} is also specified.)
2107 An aggregate has a partly bracketed initializer.
2108 For example, the following code would evoke such a warning,
2109 because braces are missing around the initializer for @code{x.h}:
2112 struct s @{ int f, g; @};
2113 struct t @{ struct s h; int i; @};
2114 struct t x = @{ 1, 2, 3 @};
2118 An aggregate has an initializer which does not initialize all members.
2119 For example, the following code would cause such a warning, because
2120 @code{x.h} would be implicitly initialized to zero:
2123 struct s @{ int f, g, h; @};
2124 struct s x = @{ 3, 4 @};
2129 Warn if floating point values are used in equality comparisons.
2131 The idea behind this is that sometimes it is convenient (for the
2132 programmer) to consider floating-point values as approximations to
2133 infinitely precise real numbers. If you are doing this, then you need
2134 to compute (by analysing the code, or in some other way) the maximum or
2135 likely maximum error that the computation introduces, and allow for it
2136 when performing comparisons (and when producing output, but that's a
2137 different problem). In particular, instead of testing for equality, you
2138 would check to see whether the two values have ranges that overlap; and
2139 this is done with the relational operators, so equality comparisons are
2142 @item -Wtraditional (C only)
2143 Warn about certain constructs that behave differently in traditional and
2144 ISO C. Also warn about ISO C constructs that have no traditional C
2145 equivalent, and/or problematic constructs which should be avoided.
2149 Macro parameters that appear within string literals in the macro body.
2150 In traditional C macro replacement takes place within string literals,
2151 but does not in ISO C.
2154 In traditional C, some preprocessor directives did not exist.
2155 Traditional preprocessors would only consider a line to be a directive
2156 if the @samp{#} appeared in column 1 on the line. Therefore
2157 @samp{-Wtraditional} warns about directives that traditional C
2158 understands but would ignore because the @samp{#} does not appear as the
2159 first character on the line. It also suggests you hide directives like
2160 @samp{#pragma} not understood by traditional C by indenting them. Some
2161 traditional implementations would not recognise @samp{#elif}, so it
2162 suggests avoiding it altogether.
2165 A function-like macro that appears without arguments.
2168 The unary plus operator.
2171 The `U' integer constant suffix, or the `F' or `L' floating point
2172 constant suffixes. (Traditonal C does support the `L' suffix on integer
2173 constants.) Note, these suffixes appear in macros defined in the system
2174 headers of most modern systems, e.g. the _MIN/_MAX macros in limits.h.
2175 Use of these macros in user code might normally lead to spurious
2176 warnings, however gcc's integrated preprocessor has enough context to
2177 avoid warning in these cases.
2180 A function declared external in one block and then used after the end of
2184 A @code{switch} statement has an operand of type @code{long}.
2187 A non-@code{static} function declaration follows a @code{static} one.
2188 This construct is not accepted by some traditional C compilers.
2191 The ISO type of an integer constant has a different width or
2192 signedness from its traditional type. This warning is only issued if
2193 the base of the constant is ten. I.e. hexadecimal or octal values, which
2194 typically represent bit patterns, are not warned about.
2197 Usage of ISO string concatenation is detected.
2200 Initialization of automatic aggregates.
2203 Identifier conflicts with labels. Traditional C lacks a separate
2204 namespace for labels.
2207 Initialization of unions. If the initializer is zero, the warning is
2208 omitted. This is done under the assumption that the zero initializer in
2209 user code appears conditioned on e.g. @code{__STDC__} to avoid missing
2210 initializer warnings and relies on default initialization to zero in the
2214 Conversions by prototypes between fixed/floating point values and vice
2215 versa. The absence of these prototypes when compiling with traditional
2216 C would cause serious problems. This is a subset of the possible
2217 conversion warnings, for the full set use @samp{-Wconversion}.
2221 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2224 Warn whenever a local variable shadows another local variable, parameter or
2225 global variable or whenever a built-in function is shadowed.
2227 @item -Wid-clash-@var{len}
2228 Warn whenever two distinct identifiers match in the first @var{len}
2229 characters. This may help you prepare a program that will compile
2230 with certain obsolete, brain-damaged compilers.
2232 @item -Wlarger-than-@var{len}
2233 Warn whenever an object of larger than @var{len} bytes is defined.
2235 @item -Wpointer-arith
2236 Warn about anything that depends on the ``size of'' a function type or
2237 of @code{void}. GNU C assigns these types a size of 1, for
2238 convenience in calculations with @code{void *} pointers and pointers
2241 @item -Wbad-function-cast (C only)
2242 Warn whenever a function call is cast to a non-matching type.
2243 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2246 Warn whenever a pointer is cast so as to remove a type qualifier from
2247 the target type. For example, warn if a @code{const char *} is cast
2248 to an ordinary @code{char *}.
2251 Warn whenever a pointer is cast such that the required alignment of the
2252 target is increased. For example, warn if a @code{char *} is cast to
2253 an @code{int *} on machines where integers can only be accessed at
2254 two- or four-byte boundaries.
2256 @item -Wwrite-strings
2257 Give string constants the type @code{const char[@var{length}]} so that
2258 copying the address of one into a non-@code{const} @code{char *}
2259 pointer will get a warning. These warnings will help you find at
2260 compile time code that can try to write into a string constant, but
2261 only if you have been very careful about using @code{const} in
2262 declarations and prototypes. Otherwise, it will just be a nuisance;
2263 this is why we did not make @samp{-Wall} request these warnings.
2266 Warn if a prototype causes a type conversion that is different from what
2267 would happen to the same argument in the absence of a prototype. This
2268 includes conversions of fixed point to floating and vice versa, and
2269 conversions changing the width or signedness of a fixed point argument
2270 except when the same as the default promotion.
2272 Also, warn if a negative integer constant expression is implicitly
2273 converted to an unsigned type. For example, warn about the assignment
2274 @code{x = -1} if @code{x} is unsigned. But do not warn about explicit
2275 casts like @code{(unsigned) -1}.
2277 @item -Wsign-compare
2278 @cindex warning for comparison of signed and unsigned values
2279 @cindex comparison of signed and unsigned values, warning
2280 @cindex signed and unsigned values, comparison warning
2281 Warn when a comparison between signed and unsigned values could produce
2282 an incorrect result when the signed value is converted to unsigned.
2283 This warning is also enabled by @samp{-W}; to get the other warnings
2284 of @samp{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2286 @item -Waggregate-return
2287 Warn if any functions that return structures or unions are defined or
2288 called. (In languages where you can return an array, this also elicits
2291 @item -Wstrict-prototypes (C only)
2292 Warn if a function is declared or defined without specifying the
2293 argument types. (An old-style function definition is permitted without
2294 a warning if preceded by a declaration which specifies the argument
2297 @item -Wmissing-prototypes (C only)
2298 Warn if a global function is defined without a previous prototype
2299 declaration. This warning is issued even if the definition itself
2300 provides a prototype. The aim is to detect global functions that fail
2301 to be declared in header files.
2303 @item -Wmissing-declarations
2304 Warn if a global function is defined without a previous declaration.
2305 Do so even if the definition itself provides a prototype.
2306 Use this option to detect global functions that are not declared in
2309 @item -Wmissing-noreturn
2310 Warn about functions which might be candidates for attribute @code{noreturn}.
2311 Note these are only possible candidates, not absolute ones. Care should
2312 be taken to manually verify functions actually do not ever return before
2313 adding the @code{noreturn} attribute, otherwise subtle code generation
2314 bugs could be introduced. You will not get a warning for @code{main} in
2315 hosted C environments.
2317 @item -Wmissing-format-attribute
2318 If @samp{-Wformat} is enabled, also warn about functions which might be
2319 candidates for @code{format} attributes. Note these are only possible
2320 candidates, not absolute ones. GCC will guess that @code{format}
2321 attributes might be appropriate for any function that calls a function
2322 like @code{vprintf} or @code{vscanf}, but this might not always be the
2323 case, and some functions for which @code{format} attributes are
2324 appropriate may not be detected. This option has no effect unless
2325 @samp{-Wformat} is enabled (possibly by @samp{-Wall}).
2328 Warn if a structure is given the packed attribute, but the packed
2329 attribute has no effect on the layout or size of the structure.
2330 Such structures may be mis-aligned for little benefit. For
2331 instance, in this code, the variable @code{f.x} in @code{struct bar}
2332 will be misaligned even though @code{struct bar} does not itself
2333 have the packed attribute:
2340 @} __attribute__((packed));
2349 Warn if padding is included in a structure, either to align an element
2350 of the structure or to align the whole structure. Sometimes when this
2351 happens it is possible to rearrange the fields of the structure to
2352 reduce the padding and so make the structure smaller.
2354 @item -Wredundant-decls
2355 Warn if anything is declared more than once in the same scope, even in
2356 cases where multiple declaration is valid and changes nothing.
2358 @item -Wnested-externs (C only)
2359 Warn if an @code{extern} declaration is encountered within a function.
2361 @item -Wunreachable-code
2362 Warn if the compiler detects that code will never be executed.
2364 This option is intended to warn when the compiler detects that at
2365 least a whole line of source code will never be executed, because
2366 some condition is never satisfied or because it is after a
2367 procedure that never returns.
2369 It is possible for this option to produce a warning even though there
2370 are circumstances under which part of the affected line can be executed,
2371 so care should be taken when removing apparently-unreachable code.
2373 For instance, when a function is inlined, a warning may mean that the
2374 line is unreachable in only one inlined copy of the function.
2376 This option is not made part of @samp{-Wall} because in a debugging
2377 version of a program there is often substantial code which checks
2378 correct functioning of the program and is, hopefully, unreachable
2379 because the program does work. Another common use of unreachable
2380 code is to provide behaviour which is selectable at compile-time.
2383 Warn if a function can not be inlined and it was declared as inline.
2386 Warn if @samp{long long} type is used. This is default. To inhibit
2387 the warning messages, use @samp{-Wno-long-long}. Flags
2388 @samp{-Wlong-long} and @samp{-Wno-long-long} are taken into account
2389 only when @samp{-pedantic} flag is used.
2391 @item -Wdisabled-optimization
2392 Warn if a requested optimization pass is disabled. This warning does
2393 not generally indicate that there is anything wrong with your code; it
2394 merely indicates that GCC's optimizers were unable to handle the code
2395 effectively. Often, the problem is that your code is too big or too
2396 complex; GCC will refuse to optimize programs when the optimization
2397 itself is likely to take inordinate amounts of time.
2400 Make all warnings into errors.
2403 @node Debugging Options
2404 @section Options for Debugging Your Program or GCC
2405 @cindex options, debugging
2406 @cindex debugging information options
2408 GCC has various special options that are used for debugging
2409 either your program or GCC:
2413 Produce debugging information in the operating system's native format
2414 (stabs, COFF, XCOFF, or DWARF). GDB can work with this debugging
2417 On most systems that use stabs format, @samp{-g} enables use of extra
2418 debugging information that only GDB can use; this extra information
2419 makes debugging work better in GDB but will probably make other debuggers
2421 refuse to read the program. If you want to control for certain whether
2422 to generate the extra information, use @samp{-gstabs+}, @samp{-gstabs},
2423 @samp{-gxcoff+}, @samp{-gxcoff}, @samp{-gdwarf-1+}, or @samp{-gdwarf-1}
2426 Unlike most other C compilers, GCC allows you to use @samp{-g} with
2427 @samp{-O}. The shortcuts taken by optimized code may occasionally
2428 produce surprising results: some variables you declared may not exist
2429 at all; flow of control may briefly move where you did not expect it;
2430 some statements may not be executed because they compute constant
2431 results or their values were already at hand; some statements may
2432 execute in different places because they were moved out of loops.
2434 Nevertheless it proves possible to debug optimized output. This makes
2435 it reasonable to use the optimizer for programs that might have bugs.
2437 The following options are useful when GCC is generated with the
2438 capability for more than one debugging format.
2441 Produce debugging information for use by GDB. This means to use the
2442 most expressive format available (DWARF 2, stabs, or the native format
2443 if neither of those are supported), including GDB extensions if at all
2447 Produce debugging information in stabs format (if that is supported),
2448 without GDB extensions. This is the format used by DBX on most BSD
2449 systems. On MIPS, Alpha and System V Release 4 systems this option
2450 produces stabs debugging output which is not understood by DBX or SDB.
2451 On System V Release 4 systems this option requires the GNU assembler.
2454 Produce debugging information in stabs format (if that is supported),
2455 using GNU extensions understood only by the GNU debugger (GDB). The
2456 use of these extensions is likely to make other debuggers crash or
2457 refuse to read the program.
2460 Produce debugging information in COFF format (if that is supported).
2461 This is the format used by SDB on most System V systems prior to
2465 Produce debugging information in XCOFF format (if that is supported).
2466 This is the format used by the DBX debugger on IBM RS/6000 systems.
2469 Produce debugging information in XCOFF format (if that is supported),
2470 using GNU extensions understood only by the GNU debugger (GDB). The
2471 use of these extensions is likely to make other debuggers crash or
2472 refuse to read the program, and may cause assemblers other than the GNU
2473 assembler (GAS) to fail with an error.
2476 Produce debugging information in DWARF version 1 format (if that is
2477 supported). This is the format used by SDB on most System V Release 4
2481 Produce debugging information in DWARF version 1 format (if that is
2482 supported), using GNU extensions understood only by the GNU debugger
2483 (GDB). The use of these extensions is likely to make other debuggers
2484 crash or refuse to read the program.
2487 Produce debugging information in DWARF version 2 format (if that is
2488 supported). This is the format used by DBX on IRIX 6.
2491 @itemx -ggdb@var{level}
2492 @itemx -gstabs@var{level}
2493 @itemx -gcoff@var{level}
2494 @itemx -gxcoff@var{level}
2495 @itemx -gdwarf@var{level}
2496 @itemx -gdwarf-2@var{level}
2497 Request debugging information and also use @var{level} to specify how
2498 much information. The default level is 2.
2500 Level 1 produces minimal information, enough for making backtraces in
2501 parts of the program that you don't plan to debug. This includes
2502 descriptions of functions and external variables, but no information
2503 about local variables and no line numbers.
2505 Level 3 includes extra information, such as all the macro definitions
2506 present in the program. Some debuggers support macro expansion when
2511 Generate extra code to write profile information suitable for the
2512 analysis program @code{prof}. You must use this option when compiling
2513 the source files you want data about, and you must also use it when
2516 @cindex @code{gprof}
2518 Generate extra code to write profile information suitable for the
2519 analysis program @code{gprof}. You must use this option when compiling
2520 the source files you want data about, and you must also use it when
2525 Generate extra code to write profile information for basic blocks, which will
2526 record the number of times each basic block is executed, the basic block start
2527 address, and the function name containing the basic block. If @samp{-g} is
2528 used, the line number and filename of the start of the basic block will also be
2529 recorded. If not overridden by the machine description, the default action is
2530 to append to the text file @file{bb.out}.
2532 This data could be analyzed by a program like @code{tcov}. Note,
2533 however, that the format of the data is not what @code{tcov} expects.
2534 Eventually GNU @code{gprof} should be extended to process this data.
2537 Makes the compiler print out each function name as it is compiled, and
2538 print some statistics about each pass when it finishes.
2541 Makes the compiler print some statistics about the time consumed by each
2542 pass when it finishes.
2545 Makes the compiler print some statistics about permanent memory
2546 allocation when it finishes.
2549 Generate extra code to profile basic blocks. Your executable will
2550 produce output that is a superset of that produced when @samp{-a} is
2551 used. Additional output is the source and target address of the basic
2552 blocks where a jump takes place, the number of times a jump is executed,
2553 and (optionally) the complete sequence of basic blocks being executed.
2554 The output is appended to file @file{bb.out}.
2556 You can examine different profiling aspects without recompilation. Your
2557 executable will read a list of function names from file @file{bb.in}.
2558 Profiling starts when a function on the list is entered and stops when
2559 that invocation is exited. To exclude a function from profiling, prefix
2560 its name with `-'. If a function name is not unique, you can
2561 disambiguate it by writing it in the form
2562 @samp{/path/filename.d:functionname}. Your executable will write the
2563 available paths and filenames in file @file{bb.out}.
2565 Several function names have a special meaning:
2568 Write source, target and frequency of jumps to file @file{bb.out}.
2569 @item __bb_hidecall__
2570 Exclude function calls from frequency count.
2571 @item __bb_showret__
2572 Include function returns in frequency count.
2574 Write the sequence of basic blocks executed to file @file{bbtrace.gz}.
2575 The file will be compressed using the program @samp{gzip}, which must
2576 exist in your @env{PATH}. On systems without the @samp{popen}
2577 function, the file will be named @file{bbtrace} and will not be
2578 compressed. @strong{Profiling for even a few seconds on these systems
2579 will produce a very large file.} Note: @code{__bb_hidecall__} and
2580 @code{__bb_showret__} will not affect the sequence written to
2584 Here's a short example using different profiling parameters
2585 in file @file{bb.in}. Assume function @code{foo} consists of basic blocks
2586 1 and 2 and is called twice from block 3 of function @code{main}. After
2587 the calls, block 3 transfers control to block 4 of @code{main}.
2589 With @code{__bb_trace__} and @code{main} contained in file @file{bb.in},
2590 the following sequence of blocks is written to file @file{bbtrace.gz}:
2591 0 3 1 2 1 2 4. The return from block 2 to block 3 is not shown, because
2592 the return is to a point inside the block and not to the top. The
2593 block address 0 always indicates, that control is transferred
2594 to the trace from somewhere outside the observed functions. With
2595 @samp{-foo} added to @file{bb.in}, the blocks of function
2596 @code{foo} are removed from the trace, so only 0 3 4 remains.
2598 With @code{__bb_jumps__} and @code{main} contained in file @file{bb.in},
2599 jump frequencies will be written to file @file{bb.out}. The
2600 frequencies are obtained by constructing a trace of blocks
2601 and incrementing a counter for every neighbouring pair of blocks
2602 in the trace. The trace 0 3 1 2 1 2 4 displays the following
2606 Jump from block 0x0 to block 0x3 executed 1 time(s)
2607 Jump from block 0x3 to block 0x1 executed 1 time(s)
2608 Jump from block 0x1 to block 0x2 executed 2 time(s)
2609 Jump from block 0x2 to block 0x1 executed 1 time(s)
2610 Jump from block 0x2 to block 0x4 executed 1 time(s)
2613 With @code{__bb_hidecall__}, control transfer due to call instructions
2614 is removed from the trace, that is the trace is cut into three parts: 0
2615 3 4, 0 1 2 and 0 1 2. With @code{__bb_showret__}, control transfer due
2616 to return instructions is added to the trace. The trace becomes: 0 3 1
2617 2 3 1 2 3 4. Note, that this trace is not the same, as the sequence
2618 written to @file{bbtrace.gz}. It is solely used for counting jump
2621 @item -fprofile-arcs
2622 Instrument @dfn{arcs} during compilation. For each function of your
2623 program, GCC creates a program flow graph, then finds a spanning tree
2624 for the graph. Only arcs that are not on the spanning tree have to be
2625 instrumented: the compiler adds code to count the number of times that these
2626 arcs are executed. When an arc is the only exit or only entrance to a
2627 block, the instrumentation code can be added to the block; otherwise, a
2628 new basic block must be created to hold the instrumentation code.
2630 Since not every arc in the program must be instrumented, programs
2631 compiled with this option run faster than programs compiled with
2632 @samp{-a}, which adds instrumentation code to every basic block in the
2633 program. The tradeoff: since @code{gcov} does not have
2634 execution counts for all branches, it must start with the execution
2635 counts for the instrumented branches, and then iterate over the program
2636 flow graph until the entire graph has been solved. Hence, @code{gcov}
2637 runs a little more slowly than a program which uses information from
2640 @samp{-fprofile-arcs} also makes it possible to estimate branch
2641 probabilities, and to calculate basic block execution counts. In
2642 general, basic block execution counts do not give enough information to
2643 estimate all branch probabilities. When the compiled program exits, it
2644 saves the arc execution counts to a file called
2645 @file{@var{sourcename}.da}. Use the compiler option
2646 @samp{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2647 Control Optimization}) when recompiling, to optimize using estimated
2648 branch probabilities.
2651 @item -ftest-coverage
2652 Create data files for the @code{gcov} code-coverage utility
2653 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
2654 The data file names begin with the name of your source file:
2657 @item @var{sourcename}.bb
2658 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2659 associate basic block execution counts with line numbers.
2661 @item @var{sourcename}.bbg
2662 A list of all arcs in the program flow graph. This allows @code{gcov}
2663 to reconstruct the program flow graph, so that it can compute all basic
2664 block and arc execution counts from the information in the
2665 @code{@var{sourcename}.da} file (this last file is the output from
2666 @samp{-fprofile-arcs}).
2669 @item -d@var{letters}
2670 Says to make debugging dumps during compilation at times specified by
2671 @var{letters}. This is used for debugging the compiler. The file names
2672 for most of the dumps are made by appending a pass number and a word to
2673 the source file name (e.g. @file{foo.c.00.rtl} or @file{foo.c.01.sibling}).
2674 Here are the possible letters for use in @var{letters}, and their meanings:
2678 Annotate the assembler output with miscellaneous debugging information.
2680 Dump after computing branch probabilities, to @file{@var{file}.11.bp}.
2682 Dump after block reordering, to @file{@var{file}.26.bbro}.
2684 Dump after instruction combination, to the file @file{@var{file}.14.combine}.
2686 Dump after the first if conversion, to the file @file{@var{file}.15.ce}.
2688 Dump after delayed branch scheduling, to @file{@var{file}.29.dbr}.
2690 Dump all macro definitions, at the end of preprocessing, in addition to
2693 Dump after SSA optimizations, to @file{@var{file}.05.ssa} and
2694 @file{@var{file}.06.ussa}.
2696 Dump after the second if conversion, to @file{@var{file}.24.ce2}.
2698 Dump after life analysis, to @file{@var{file}.13.life}.
2700 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.04.addressof}.
2702 Dump after global register allocation, to @file{@var{file}.19.greg}.
2704 Dump after post-reload CSE and other optimizations, to @file{@var{file}.20.postreload}.
2706 Dump after GCSE, to @file{@var{file}.08.gcse}.
2708 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
2710 Dump after the first jump optimization, to @file{@var{file}.02.jump}.
2712 Dump after the last jump optimization, to @file{@var{file}.27.jump2}.
2714 Dump after conversion from registers to stack, to @file{@var{file}.29.stack}.
2716 Dump after local register allocation, to @file{@var{file}.18.lreg}.
2718 Dump after loop optimization, to @file{@var{file}.09.loop}.
2720 Dump after performing the machine dependent reorganisation pass, to
2721 @file{@var{file}.28.mach}.
2723 Dump after register renumbering, to @file{@var{file}.23.rnreg}.
2725 Dump after the register move pass, to @file{@var{file}.16.regmove}.
2727 Dump after RTL generation, to @file{@var{file}.00.rtl}.
2729 Dump after the second instruction scheduling pass, to
2730 @file{@var{file}.25.sched2}.
2732 Dump after CSE (including the jump optimization that sometimes follows
2733 CSE), to @file{@var{file}.03.cse}.
2735 Dump after the first instruction scheduling pass, to
2736 @file{@var{file}.17.sched}.
2738 Dump after the second CSE pass (including the jump optimization that
2739 sometimes follows CSE), to @file{@var{file}.10.cse2}.
2741 Dump after the second flow pass, to @file{@var{file}.21.flow2}.
2743 Dump after dead code elimination, to @file{@var{file}.06.dce}.
2745 Dump after the peephole pass, to @file{@var{file}.22.peephole2}.
2747 Produce all the dumps listed above.
2749 Print statistics on memory usage, at the end of the run, to
2752 Annotate the assembler output with a comment indicating which
2753 pattern and alternative was used. The length of each instruction is
2756 Dump the RTL in the assembler output as a comment before each instruction.
2757 Also turns on @samp{-dp} annotation.
2759 For each of the other indicated dump files (except for
2760 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
2761 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
2763 Just generate RTL for a function instead of compiling it. Usually used
2766 Dump debugging information during parsing, to standard error.
2769 @item -fdump-unnumbered
2770 When doing debugging dumps (see -d option above), suppress instruction
2771 numbers and line number note output. This makes it more feasible to
2772 use diff on debugging dumps for compiler invocations with different
2773 options, in particular with and without -g.
2775 @item -fdump-translation-unit=@var{file} (C and C++ only)
2776 Dump a representation of the tree structure for the entire translation
2779 @item -fdump-class_layout=@var{file} (C++ only)
2780 @item -fdump-class_layout (C++ only)
2781 Dump a representation of each class's heirarchy to @var{file}, or
2782 @code{stderr} if not specified.
2784 @item -fpretend-float
2785 When running a cross-compiler, pretend that the target machine uses the
2786 same floating point format as the host machine. This causes incorrect
2787 output of the actual floating constants, but the actual instruction
2788 sequence will probably be the same as GCC would make when running on
2792 Store the usual ``temporary'' intermediate files permanently; place them
2793 in the current directory and name them based on the source file. Thus,
2794 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
2795 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
2796 preprocessed @file{foo.i} output file even though the compiler now
2797 normally uses an integrated preprocessor.
2800 Report the CPU time taken by each subprocess in the compilation
2801 sequence. For C source files, this is the compiler proper and assembler
2802 (plus the linker if linking is done). The output looks like this:
2809 The first number on each line is the ``user time,'' that is time spent
2810 executing the program itself. The second number is ``system time,''
2811 time spent executing operating system routines on behalf of the program.
2812 Both numbers are in seconds.
2814 @item -print-file-name=@var{library}
2815 Print the full absolute name of the library file @var{library} that
2816 would be used when linking---and don't do anything else. With this
2817 option, GCC does not compile or link anything; it just prints the
2820 @item -print-prog-name=@var{program}
2821 Like @samp{-print-file-name}, but searches for a program such as @samp{cpp}.
2823 @item -print-libgcc-file-name
2824 Same as @samp{-print-file-name=libgcc.a}.
2826 This is useful when you use @samp{-nostdlib} or @samp{-nodefaultlibs}
2827 but you do want to link with @file{libgcc.a}. You can do
2830 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
2833 @item -print-search-dirs
2834 Print the name of the configured installation directory and a list of
2835 program and library directories gcc will search---and don't do anything else.
2837 This is useful when gcc prints the error message
2838 @samp{installation problem, cannot exec cpp0: No such file or directory}.
2839 To resolve this you either need to put @file{cpp0} and the other compiler
2840 components where gcc expects to find them, or you can set the environment
2841 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
2842 Don't forget the trailing '/'.
2843 @xref{Environment Variables}.
2846 Print the compiler's target machine (for example,
2847 @samp{i686-pc-linux-gnu})---and don't do anything else.
2850 Print the compiler version (for example, @samp{3.0})---and don't do
2854 Print the compiler's built-in specs---and don't do anything else. (This
2855 is used when GCC itself is being built.) @xref{Spec Files}.
2858 @node Optimize Options
2859 @section Options That Control Optimization
2860 @cindex optimize options
2861 @cindex options, optimization
2863 These options control various sorts of optimizations:
2868 Optimize. Optimizing compilation takes somewhat more time, and a lot
2869 more memory for a large function.
2871 Without @samp{-O}, the compiler's goal is to reduce the cost of
2872 compilation and to make debugging produce the expected results.
2873 Statements are independent: if you stop the program with a breakpoint
2874 between statements, you can then assign a new value to any variable or
2875 change the program counter to any other statement in the function and
2876 get exactly the results you would expect from the source code.
2878 Without @samp{-O}, the compiler only allocates variables declared
2879 @code{register} in registers. The resulting compiled code is a little
2880 worse than produced by PCC without @samp{-O}.
2882 With @samp{-O}, the compiler tries to reduce code size and execution
2885 When you specify @samp{-O}, the compiler turns on @samp{-fthread-jumps}
2886 and @samp{-fdefer-pop} on all machines. The compiler turns on
2887 @samp{-fdelayed-branch} on machines that have delay slots, and
2888 @samp{-fomit-frame-pointer} on machines that can support debugging even
2889 without a frame pointer. On some machines the compiler also turns
2890 on other flags.@refill
2893 Optimize even more. GCC performs nearly all supported optimizations
2894 that do not involve a space-speed tradeoff. The compiler does not
2895 perform loop unrolling or function inlining when you specify @samp{-O2}.
2896 As compared to @samp{-O}, this option increases both compilation time
2897 and the performance of the generated code.
2899 @samp{-O2} turns on all optional optimizations except for loop unrolling,
2900 function inlining, and register renaming. It also turns on the
2901 @samp{-fforce-mem} option on all machines and frame pointer elimination
2902 on machines where doing so does not interfere with debugging.
2905 Optimize yet more. @samp{-O3} turns on all optimizations specified by
2906 @samp{-O2} and also turns on the @samp{-finline-functions} and
2907 @samp{-frename-registers} options.
2913 Optimize for size. @samp{-Os} enables all @samp{-O2} optimizations that
2914 do not typically increase code size. It also performs further
2915 optimizations designed to reduce code size.
2917 If you use multiple @samp{-O} options, with or without level numbers,
2918 the last such option is the one that is effective.
2921 Options of the form @samp{-f@var{flag}} specify machine-independent
2922 flags. Most flags have both positive and negative forms; the negative
2923 form of @samp{-ffoo} would be @samp{-fno-foo}. In the table below,
2924 only one of the forms is listed---the one which is not the default.
2925 You can figure out the other form by either removing @samp{no-} or
2930 Do not store floating point variables in registers, and inhibit other
2931 options that might change whether a floating point value is taken from a
2934 @cindex floating point precision
2935 This option prevents undesirable excess precision on machines such as
2936 the 68000 where the floating registers (of the 68881) keep more
2937 precision than a @code{double} is supposed to have. Similarly for the
2938 x86 architecture. For most programs, the excess precision does only
2939 good, but a few programs rely on the precise definition of IEEE floating
2940 point. Use @samp{-ffloat-store} for such programs, after modifying
2941 them to store all pertinent intermediate computations into variables.
2943 @item -fno-default-inline
2944 Do not make member functions inline by default merely because they are
2945 defined inside the class scope (C++ only). Otherwise, when you specify
2946 @w{@samp{-O}}, member functions defined inside class scope are compiled
2947 inline by default; i.e., you don't need to add @samp{inline} in front of
2948 the member function name.
2950 @item -fno-defer-pop
2951 Always pop the arguments to each function call as soon as that function
2952 returns. For machines which must pop arguments after a function call,
2953 the compiler normally lets arguments accumulate on the stack for several
2954 function calls and pops them all at once.
2957 Force memory operands to be copied into registers before doing
2958 arithmetic on them. This produces better code by making all memory
2959 references potential common subexpressions. When they are not common
2960 subexpressions, instruction combination should eliminate the separate
2961 register-load. The @samp{-O2} option turns on this option.
2964 Force memory address constants to be copied into registers before
2965 doing arithmetic on them. This may produce better code just as
2966 @samp{-fforce-mem} may.
2968 @item -fomit-frame-pointer
2969 Don't keep the frame pointer in a register for functions that
2970 don't need one. This avoids the instructions to save, set up and
2971 restore frame pointers; it also makes an extra register available
2972 in many functions. @strong{It also makes debugging impossible on
2976 On some machines, such as the Vax, this flag has no effect, because
2977 the standard calling sequence automatically handles the frame pointer
2978 and nothing is saved by pretending it doesn't exist. The
2979 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2980 whether a target machine supports this flag. @xref{Registers}.@refill
2983 On some machines, such as the Vax, this flag has no effect, because
2984 the standard calling sequence automatically handles the frame pointer
2985 and nothing is saved by pretending it doesn't exist. The
2986 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2987 whether a target machine supports this flag. @xref{Registers,,Register
2988 Usage, gcc.info, Using and Porting GCC}.@refill
2991 @item -foptimize-sibling-calls
2992 Optimize sibling and tail recursive calls.
2995 This option generates traps for signed overflow on addition, subtraction,
2996 multiplication operations.
2999 Don't pay attention to the @code{inline} keyword. Normally this option
3000 is used to keep the compiler from expanding any functions inline.
3001 Note that if you are not optimizing, no functions can be expanded inline.
3003 @item -finline-functions
3004 Integrate all simple functions into their callers. The compiler
3005 heuristically decides which functions are simple enough to be worth
3006 integrating in this way.
3008 If all calls to a given function are integrated, and the function is
3009 declared @code{static}, then the function is normally not output as
3010 assembler code in its own right.
3012 @item -finline-limit=@var{n}
3013 By default, gcc limits the size of functions that can be inlined. This flag
3014 allows the control of this limit for functions that are explicitly marked as
3015 inline (ie marked with the inline keyword or defined within the class
3016 definition in c++). @var{n} is the size of functions that can be inlined in
3017 number of pseudo instructions (not counting parameter handling). The default
3018 value of n is 10000. Increasing this value can result in more inlined code at
3019 the cost of compilation time and memory consumption. Decreasing usually makes
3020 the compilation faster and less code will be inlined (which presumably
3021 means slower programs). This option is particularly useful for programs that
3022 use inlining heavily such as those based on recursive templates with c++.
3024 @emph{Note:} pseudo instruction represents, in this particular context, an
3025 abstract measurement of function's size. In no way, it represents a count
3026 of assembly instructions and as such its exact meaning might change from one
3027 release to an another.
3029 @item -fkeep-inline-functions
3030 Even if all calls to a given function are integrated, and the function
3031 is declared @code{static}, nevertheless output a separate run-time
3032 callable version of the function. This switch does not affect
3033 @code{extern inline} functions.
3035 @item -fkeep-static-consts
3036 Emit variables declared @code{static const} when optimization isn't turned
3037 on, even if the variables aren't referenced.
3039 GCC enables this option by default. If you want to force the compiler to
3040 check if the variable was referenced, regardless of whether or not
3041 optimization is turned on, use the @samp{-fno-keep-static-consts} option.
3043 @item -fno-function-cse
3044 Do not put function addresses in registers; make each instruction that
3045 calls a constant function contain the function's address explicitly.
3047 This option results in less efficient code, but some strange hacks
3048 that alter the assembler output may be confused by the optimizations
3049 performed when this option is not used.
3052 This option allows GCC to violate some ISO or IEEE rules and/or
3053 specifications in the interest of optimizing code for speed. For
3054 example, it allows the compiler to assume arguments to the @code{sqrt}
3055 function are non-negative numbers and that no floating-point values
3058 This option causes the preprocessor macro __FAST_MATH__ to be defined.
3060 This option should never be turned on by any @samp{-O} option since
3061 it can result in incorrect output for programs which depend on
3062 an exact implementation of IEEE or ISO rules/specifications for
3065 @item -fno-math-errno
3066 Do not set ERRNO after calling math functions that are executed
3067 with a single instruction, e.g., sqrt. A program that relies on
3068 IEEE exceptions for math error handling may want to use this flag
3069 for speed while maintaining IEEE arithmetic compatibility.
3071 The default is @samp{-fmath-errno}. The @samp{-ffast-math} option
3072 sets @samp{-fno-math-errno}.
3075 @c following causes underfulls.. they don't look great, but we deal.
3077 The following options control specific optimizations. The @samp{-O2}
3078 option turns on all of these optimizations except @samp{-funroll-loops}
3079 and @samp{-funroll-all-loops}. On most machines, the @samp{-O} option
3080 turns on the @samp{-fthread-jumps} and @samp{-fdelayed-branch} options,
3081 but specific machines may handle it differently.
3083 You can use the following flags in the rare cases when ``fine-tuning''
3084 of optimizations to be performed is desired.
3087 @item -fstrength-reduce
3088 Perform the optimizations of loop strength reduction and
3089 elimination of iteration variables.
3091 @item -fthread-jumps
3092 Perform optimizations where we check to see if a jump branches to a
3093 location where another comparison subsumed by the first is found. If
3094 so, the first branch is redirected to either the destination of the
3095 second branch or a point immediately following it, depending on whether
3096 the condition is known to be true or false.
3098 @item -fcse-follow-jumps
3099 In common subexpression elimination, scan through jump instructions
3100 when the target of the jump is not reached by any other path. For
3101 example, when CSE encounters an @code{if} statement with an
3102 @code{else} clause, CSE will follow the jump when the condition
3105 @item -fcse-skip-blocks
3106 This is similar to @samp{-fcse-follow-jumps}, but causes CSE to
3107 follow jumps which conditionally skip over blocks. When CSE
3108 encounters a simple @code{if} statement with no else clause,
3109 @samp{-fcse-skip-blocks} causes CSE to follow the jump around the
3110 body of the @code{if}.
3112 @item -frerun-cse-after-loop
3113 Re-run common subexpression elimination after loop optimizations has been
3116 @item -frerun-loop-opt
3117 Run the loop optimizer twice.
3120 Perform a global common subexpression elimination pass.
3121 This pass also performs global constant and copy propagation.
3123 @item -fdelete-null-pointer-checks
3124 Use global dataflow analysis to identify and eliminate useless null
3125 pointer checks. Programs which rely on NULL pointer dereferences @emph{not}
3126 halting the program may not work properly with this option. Use
3127 -fno-delete-null-pointer-checks to disable this optimizing for programs
3128 which depend on that behavior.
3130 @item -fexpensive-optimizations
3131 Perform a number of minor optimizations that are relatively expensive.
3133 @item -foptimize-register-move
3135 Attempt to reassign register numbers in move instructions and as
3136 operands of other simple instructions in order to maximize the amount of
3137 register tying. This is especially helpful on machines with two-operand
3138 instructions. GCC enables this optimization by default with @samp{-O2}
3141 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3144 @item -fdelayed-branch
3145 If supported for the target machine, attempt to reorder instructions
3146 to exploit instruction slots available after delayed branch
3149 @item -fschedule-insns
3150 If supported for the target machine, attempt to reorder instructions to
3151 eliminate execution stalls due to required data being unavailable. This
3152 helps machines that have slow floating point or memory load instructions
3153 by allowing other instructions to be issued until the result of the load
3154 or floating point instruction is required.
3156 @item -fschedule-insns2
3157 Similar to @samp{-fschedule-insns}, but requests an additional pass of
3158 instruction scheduling after register allocation has been done. This is
3159 especially useful on machines with a relatively small number of
3160 registers and where memory load instructions take more than one cycle.
3162 @item -ffunction-sections
3163 @itemx -fdata-sections
3164 Place each function or data item into its own section in the output
3165 file if the target supports arbitrary sections. The name of the
3166 function or the name of the data item determines the section's name
3169 Use these options on systems where the linker can perform optimizations
3170 to improve locality of reference in the instruction space. HPPA
3171 processors running HP-UX and Sparc processors running Solaris 2 have
3172 linkers with such optimizations. Other systems using the ELF object format
3173 as well as AIX may have these optimizations in the future.
3175 Only use these options when there are significant benefits from doing
3176 so. When you specify these options, the assembler and linker will
3177 create larger object and executable files and will also be slower.
3178 You will not be able to use @code{gprof} on all systems if you
3179 specify this option and you may have problems with debugging if
3180 you specify both this option and @samp{-g}.
3182 @item -fcaller-saves
3183 Enable values to be allocated in registers that will be clobbered by
3184 function calls, by emitting extra instructions to save and restore the
3185 registers around such calls. Such allocation is done only when it
3186 seems to result in better code than would otherwise be produced.
3188 This option is always enabled by default on certain machines, usually
3189 those which have no call-preserved registers to use instead.
3191 For all machines, optimization level 2 and higher enables this flag by
3194 @item -funroll-loops
3195 Perform the optimization of loop unrolling. This is only done for loops
3196 whose number of iterations can be determined at compile time or run time.
3197 @samp{-funroll-loops} implies both @samp{-fstrength-reduce} and
3198 @samp{-frerun-cse-after-loop}.
3200 @item -funroll-all-loops
3201 Perform the optimization of loop unrolling. This is done for all loops
3202 and usually makes programs run more slowly. @samp{-funroll-all-loops}
3203 implies @samp{-fstrength-reduce} as well as @samp{-frerun-cse-after-loop}.
3205 @item -fmove-all-movables
3206 Forces all invariant computations in loops to be moved
3209 @item -freduce-all-givs
3210 Forces all general-induction variables in loops to be
3213 @emph{Note:} When compiling programs written in Fortran,
3214 @samp{-fmove-all-movables} and @samp{-freduce-all-givs} are enabled
3215 by default when you use the optimizer.
3217 These options may generate better or worse code; results are highly
3218 dependent on the structure of loops within the source code.
3220 These two options are intended to be removed someday, once
3221 they have helped determine the efficacy of various
3222 approaches to improving loop optimizations.
3224 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3225 know how use of these options affects
3226 the performance of your production code.
3227 We're very interested in code that runs @emph{slower}
3228 when these options are @emph{enabled}.
3231 Disable any machine-specific peephole optimizations.
3233 @item -fbranch-probabilities
3234 After running a program compiled with @samp{-fprofile-arcs}
3235 (@pxref{Debugging Options,, Options for Debugging Your Program or
3236 @command{gcc}}), you can compile it a second time using
3237 @samp{-fbranch-probabilities}, to improve optimizations based on
3238 guessing the path a branch might take.
3241 With @samp{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
3242 note on the first instruction of each basic block, and a
3243 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3244 These can be used to improve optimization. Currently, they are only
3245 used in one place: in @file{reorg.c}, instead of guessing which path a
3246 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3247 exactly determine which path is taken more often.
3250 @item -fno-guess-branch-probability
3251 Sometimes gcc will opt to guess branch probabilities when none are
3252 available from either profile directed feedback (@samp{-fprofile-arcs})
3253 or @samp{__builtin_expect}. In a hard real-time system, people don't
3254 want different runs of the compiler to produce code that has different
3255 behavior; minimizing non-determinism is of paramount import. This
3256 switch allows users to reduce non-determinism, possibly at the expense
3257 of inferior optimization.
3259 @item -fstrict-aliasing
3260 Allows the compiler to assume the strictest aliasing rules applicable to
3261 the language being compiled. For C (and C++), this activates
3262 optimizations based on the type of expressions. In particular, an
3263 object of one type is assumed never to reside at the same address as an
3264 object of a different type, unless the types are almost the same. For
3265 example, an @code{unsigned int} can alias an @code{int}, but not a
3266 @code{void*} or a @code{double}. A character type may alias any other
3269 Pay special attention to code like this:
3282 The practice of reading from a different union member than the one most
3283 recently written to (called ``type-punning'') is common. Even with
3284 @samp{-fstrict-aliasing}, type-punning is allowed, provided the memory
3285 is accessed through the union type. So, the code above will work as
3286 expected. However, this code might not:
3298 Every language that wishes to perform language-specific alias analysis
3299 should define a function that computes, given an @code{tree}
3300 node, an alias set for the node. Nodes in different alias sets are not
3301 allowed to alias. For an example, see the C front-end function
3302 @code{c_get_alias_set}.
3305 @item -falign-functions
3306 @itemx -falign-functions=@var{n}
3307 Align the start of functions to the next power-of-two greater than
3308 @var{n}, skipping up to @var{n} bytes. For instance,
3309 @samp{-falign-functions=32} aligns functions to the next 32-byte
3310 boundary, but @samp{-falign-functions=24} would align to the next
3311 32-byte boundary only if this can be done by skipping 23 bytes or less.
3313 @samp{-fno-align-functions} and @samp{-falign-functions=1} are
3314 equivalent and mean that functions will not be aligned.
3316 Some assemblers only support this flag when @var{n} is a power of two;
3317 in that case, it is rounded up.
3319 If @var{n} is not specified, use a machine-dependent default.
3321 @item -falign-labels
3322 @itemx -falign-labels=@var{n}
3323 Align all branch targets to a power-of-two boundary, skipping up to
3324 @var{n} bytes like @samp{-falign-functions}. This option can easily
3325 make code slower, because it must insert dummy operations for when the
3326 branch target is reached in the usual flow of the code.
3328 If @samp{-falign-loops} or @samp{-falign-jumps} are applicable and
3329 are greater than this value, then their values are used instead.
3331 If @var{n} is not specified, use a machine-dependent default which is
3332 very likely to be @samp{1}, meaning no alignment.
3335 @itemx -falign-loops=@var{n}
3336 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
3337 like @samp{-falign-functions}. The hope is that the loop will be
3338 executed many times, which will make up for any execution of the dummy
3341 If @var{n} is not specified, use a machine-dependent default.
3344 @itemx -falign-jumps=@var{n}
3345 Align branch targets to a power-of-two boundary, for branch targets
3346 where the targets can only be reached by jumping, skipping up to @var{n}
3347 bytes like @samp{-falign-functions}. In this case, no dummy operations
3350 If @var{n} is not specified, use a machine-dependent default.
3353 Perform optimizations in static single assignment form. Each function's
3354 flow graph is translated into SSA form, optimizations are performed, and
3355 the flow graph is translated back from SSA form. User's should not
3356 specify this option, since it is not yet ready for production use.
3359 Perform dead-code elimination in SSA form. Requires @samp{-fssa}. Like
3360 @samp{-fssa}, this is an experimental feature.
3362 @item -fsingle-precision-constant
3363 Treat floating point constant as single precision constant instead of
3364 implicitly converting it to double precision constant.
3366 @item -frename-registers
3367 Attempt to avoid false dependancies in scheduled code by making use
3368 of registers left over after register allocation. This optimization
3369 will most benefit processors with lots of registers. It can, however,
3370 make debugging impossible, since variables will no longer stay in
3371 a ``home register''.
3373 @item --param @var{name}=@var{value}
3374 In some places, GCC uses various constants to control the amount of
3375 optimization that is done. For example, GCC will not inline functions
3376 that contain more that a certain number of instructions. You can
3377 control some of these constants on the command-line using the
3378 @samp{--param} option.
3380 In each case, the @var{value} is a integer. The allowable choices for
3381 @var{name} are given in the following table:
3384 @item max-inline-insns
3385 If an function contains more than this many instructions, it
3386 will not be inlined. This option is precisely equivalent to
3387 @samp{-finline-limit}.
3389 @item max-gcse-memory
3390 The approximate maximum amount of memory that will be allocated in
3391 order to perform the global common subexpression elimination
3392 optimization. If more memory than specified is required, the
3393 optimization will not be done.
3398 @node Preprocessor Options
3399 @section Options Controlling the Preprocessor
3400 @cindex preprocessor options
3401 @cindex options, preprocessor
3403 These options control the C preprocessor, which is run on each C source
3404 file before actual compilation.
3406 If you use the @samp{-E} option, nothing is done except preprocessing.
3407 Some of these options make sense only together with @samp{-E} because
3408 they cause the preprocessor output to be unsuitable for actual
3412 @item -include @var{file}
3413 Process @var{file} as input before processing the regular input file.
3414 In effect, the contents of @var{file} are compiled first. Any @samp{-D}
3415 and @samp{-U} options on the command line are always processed before
3416 @samp{-include @var{file}}, regardless of the order in which they are
3417 written. All the @samp{-include} and @samp{-imacros} options are
3418 processed in the order in which they are written.
3420 @item -imacros @var{file}
3421 Process @var{file} as input, discarding the resulting output, before
3422 processing the regular input file. Because the output generated from
3423 @var{file} is discarded, the only effect of @samp{-imacros @var{file}}
3424 is to make the macros defined in @var{file} available for use in the
3425 main input. All the @samp{-include} and @samp{-imacros} options are
3426 processed in the order in which they are written.
3428 @item -idirafter @var{dir}
3429 @cindex second include path
3430 Add the directory @var{dir} to the second include path. The directories
3431 on the second include path are searched when a header file is not found
3432 in any of the directories in the main include path (the one that
3435 @item -iprefix @var{prefix}
3436 Specify @var{prefix} as the prefix for subsequent @samp{-iwithprefix}
3439 @item -iwithprefix @var{dir}
3440 Add a directory to the second include path. The directory's name is
3441 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
3442 specified previously with @samp{-iprefix}. If you have not specified a
3443 prefix yet, the directory containing the installed passes of the
3444 compiler is used as the default.
3446 @item -iwithprefixbefore @var{dir}
3447 Add a directory to the main include path. The directory's name is made
3448 by concatenating @var{prefix} and @var{dir}, as in the case of
3449 @samp{-iwithprefix}.
3451 @item -isystem @var{dir}
3452 Add a directory to the beginning of the second include path, marking it
3453 as a system directory, so that it gets the same special treatment as
3454 is applied to the standard system directories.
3457 Do not search the standard system directories for header files. Only
3458 the directories you have specified with @samp{-I} options (and the
3459 current directory, if appropriate) are searched. @xref{Directory
3460 Options}, for information on @samp{-I}.
3462 By using both @samp{-nostdinc} and @samp{-I-}, you can limit the include-file
3463 search path to only those directories you specify explicitly.
3467 When searching for a header file in a directory, remap file names if a
3468 file named @file{header.gcc} exists in that directory. This can be used
3469 to work around limitations of file systems with file name restrictions.
3470 The @file{header.gcc} file should contain a series of lines with two
3471 tokens on each line: the first token is the name to map, and the second
3472 token is the actual name to use.
3475 Do not predefine any nonstandard macros. (Including architecture flags).
3478 Run only the C preprocessor. Preprocess all the C source files
3479 specified and output the results to standard output or to the
3480 specified output file.
3483 Tell the preprocessor not to discard comments. Used with the
3487 Tell the preprocessor not to generate @samp{#line} directives.
3488 Used with the @samp{-E} option.
3491 @cindex dependencies, make
3494 Instead of outputting the result of preprocessing, output a rule
3495 suitable for @code{make} describing the dependencies of the main source
3496 file. The preprocessor outputs one @code{make} rule containing the
3497 object file name for that source file, a colon, and the names of all the
3498 included files. Unless overridden explicitly, the object file name
3499 consists of the basename of the source file with any suffix replaced with
3500 object file suffix. If there are many included files then the
3501 rule is split into several lines using @samp{\}-newline.
3503 @samp{-M} implies @samp{-E}.
3507 Like @samp{-M}, but mention only the files included with @samp{#include
3508 "@var{file}"}. System header files included with @samp{#include
3509 <@var{file}>} are omitted.
3513 Like @samp{-M} but the dependency information is written to a file
3514 rather than stdout. @code{gcc} will use the same file name and
3515 directory as the object file, but with the suffix ".d" instead.
3517 This is in addition to compiling the main file as specified ---
3518 @samp{-MD} does not inhibit ordinary compilation the way @samp{-M} does,
3519 unless you also specify @samp{-MG}.
3521 With Mach, you can use the utility @code{md} to merge multiple
3522 dependency files into a single dependency file suitable for using with
3523 the @samp{make} command.
3527 Like @samp{-MD} except mention only user header files, not system
3530 @item -MF @var{file}
3532 When used with @samp{-M} or @samp{-MM}, specifies a file to write the
3533 dependencies to. This allows the preprocessor to write the preprocessed
3534 file to stdout normally. If no @samp{-MF} switch is given, CPP sends
3535 the rules to stdout and suppresses normal preprocessed output.
3537 Another way to specify output of a @code{make} rule is by setting
3538 the environment variable @env{DEPENDENCIES_OUTPUT} (@pxref{Environment
3543 When used with @samp{-M} or @samp{-MM}, @samp{-MG} says to treat missing
3544 header files as generated files and assume they live in the same
3545 directory as the source file. It suppresses preprocessed output, as a
3546 missing header file is ordinarily an error.
3548 This feature is used in automatic updating of makefiles.
3552 This option instructs CPP to add a phony target for each dependency
3553 other than the main file, causing each to depend on nothing. These
3554 dummy rules work around errors @code{make} gives if you remove header
3555 files without updating the @code{Makefile} to match.
3557 This is typical output:-
3560 /tmp/test.o: /tmp/test.c /tmp/test.h
3565 @item -MQ @var{target}
3566 @item -MT @var{target}
3569 By default CPP uses the main file name, including any path, and appends
3570 the object suffix, normally ``.o'', to it to obtain the name of the
3571 target for dependency generation. With @samp{-MT} you can specify a
3572 target yourself, overriding the default one.
3574 If you want multiple targets, you can specify them as a single argument
3575 to @samp{-MT}, or use multiple @samp{-MT} options.
3577 The targets you specify are output in the order they appear on the
3578 command line. @samp{-MQ} is identical to @samp{-MT}, except that the
3579 target name is quoted for Make, but with @samp{-MT} it isn't. For
3580 example, -MT '$(objpfx)foo.o' gives
3583 $(objpfx)foo.o: /tmp/foo.c
3586 but -MQ '$(objpfx)foo.o' gives
3589 $$(objpfx)foo.o: /tmp/foo.c
3592 The default target is automatically quoted, as if it were given with
3596 Print the name of each header file used, in addition to other normal
3599 @item -A@var{question}(@var{answer})
3600 Assert the answer @var{answer} for @var{question}, in case it is tested
3601 with a preprocessing conditional such as @samp{#if
3602 #@var{question}(@var{answer})}. @samp{-A-} disables the standard
3603 assertions that normally describe the target machine.
3606 Define macro @var{macro} with the string @samp{1} as its definition.
3608 @item -D@var{macro}=@var{defn}
3609 Define macro @var{macro} as @var{defn}. All instances of @samp{-D} on
3610 the command line are processed before any @samp{-U} options.
3612 Any @samp{-D} and @samp{-U} options on the command line are processed in
3613 order, and always before @samp{-imacros @var{file}}, regardless of the
3614 order in which they are written.
3617 Undefine macro @var{macro}. @samp{-U} options are evaluated after all
3618 @samp{-D} options, but before any @samp{-include} and @samp{-imacros}
3621 Any @samp{-D} and @samp{-U} options on the command line are processed in
3622 order, and always before @samp{-imacros @var{file}}, regardless of the
3623 order in which they are written.
3626 Tell the preprocessor to output only a list of the macro definitions
3627 that are in effect at the end of preprocessing. Used with the @samp{-E}
3631 Tell the preprocessing to pass all macro definitions into the output, in
3632 their proper sequence in the rest of the output.
3635 Like @samp{-dD} except that the macro arguments and contents are omitted.
3636 Only @samp{#define @var{name}} is included in the output.
3640 Output @samp{#include} directives in addition to the result of
3645 Process ISO standard trigraph sequences. These are three-character
3646 sequences, all starting with @samp{??}, that are defined by ISO C to
3647 stand for single characters. For example, @samp{??/} stands for
3648 @samp{\}, so @samp{'??/n'} is a character constant for a newline. By
3649 default, GCC ignores trigraphs, but in standard-conforming modes it
3650 converts them. See the @samp{-std} and @samp{-ansi} options.
3652 The nine trigraph sequences are
3683 Trigraph support is not popular, so many compilers do not implement it
3684 properly. Portable code should not rely on trigraphs being either
3685 converted or ignored.
3687 @item -Wp\,@var{option}
3688 Pass @var{option} as an option to the preprocessor. If @var{option}
3689 contains commas, it is split into multiple options at the commas.
3692 @node Assembler Options
3693 @section Passing Options to the Assembler
3695 @c prevent bad page break with this line
3696 You can pass options to the assembler.
3699 @item -Wa\,@var{option}
3700 Pass @var{option} as an option to the assembler. If @var{option}
3701 contains commas, it is split into multiple options at the commas.
3705 @section Options for Linking
3706 @cindex link options
3707 @cindex options, linking
3709 These options come into play when the compiler links object files into
3710 an executable output file. They are meaningless if the compiler is
3711 not doing a link step.
3715 @item @var{object-file-name}
3716 A file name that does not end in a special recognized suffix is
3717 considered to name an object file or library. (Object files are
3718 distinguished from libraries by the linker according to the file
3719 contents.) If linking is done, these object files are used as input
3725 If any of these options is used, then the linker is not run, and
3726 object file names should not be used as arguments. @xref{Overall
3730 @item -l@var{library}
3731 Search the library named @var{library} when linking.
3733 It makes a difference where in the command you write this option; the
3734 linker searches processes libraries and object files in the order they
3735 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
3736 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
3737 to functions in @samp{z}, those functions may not be loaded.
3739 The linker searches a standard list of directories for the library,
3740 which is actually a file named @file{lib@var{library}.a}. The linker
3741 then uses this file as if it had been specified precisely by name.
3743 The directories searched include several standard system directories
3744 plus any that you specify with @samp{-L}.
3746 Normally the files found this way are library files---archive files
3747 whose members are object files. The linker handles an archive file by
3748 scanning through it for members which define symbols that have so far
3749 been referenced but not defined. But if the file that is found is an
3750 ordinary object file, it is linked in the usual fashion. The only
3751 difference between using an @samp{-l} option and specifying a file name
3752 is that @samp{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
3753 and searches several directories.
3756 You need this special case of the @samp{-l} option in order to
3757 link an Objective C program.
3760 Do not use the standard system startup files when linking.
3761 The standard system libraries are used normally, unless @option{-nostdlib}
3762 or @option{-nodefaultlibs} is used.
3764 @item -nodefaultlibs
3765 Do not use the standard system libraries when linking.
3766 Only the libraries you specify will be passed to the linker.
3767 The standard startup files are used normally, unless @option{-nostartfiles}
3768 is used. The compiler may generate calls to memcmp, memset, and memcpy
3769 for System V (and ISO C) environments or to bcopy and bzero for
3770 BSD environments. These entries are usually resolved by entries in
3771 libc. These entry points should be supplied through some other
3772 mechanism when this option is specified.
3775 Do not use the standard system startup files or libraries when linking.
3776 No startup files and only the libraries you specify will be passed to
3777 the linker. The compiler may generate calls to memcmp, memset, and memcpy
3778 for System V (and ISO C) environments or to bcopy and bzero for
3779 BSD environments. These entries are usually resolved by entries in
3780 libc. These entry points should be supplied through some other
3781 mechanism when this option is specified.
3783 @cindex @code{-lgcc}, use with @code{-nostdlib}
3784 @cindex @code{-nostdlib} and unresolved references
3785 @cindex unresolved references and @code{-nostdlib}
3786 @cindex @code{-lgcc}, use with @code{-nodefaultlibs}
3787 @cindex @code{-nodefaultlibs} and unresolved references
3788 @cindex unresolved references and @code{-nodefaultlibs}
3789 One of the standard libraries bypassed by @samp{-nostdlib} and
3790 @samp{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
3791 that GCC uses to overcome shortcomings of particular machines, or special
3792 needs for some languages.
3794 (@xref{Interface,,Interfacing to GCC Output}, for more discussion of
3798 (@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
3799 for more discussion of @file{libgcc.a}.)
3801 In most cases, you need @file{libgcc.a} even when you want to avoid
3802 other standard libraries. In other words, when you specify @samp{-nostdlib}
3803 or @samp{-nodefaultlibs} you should usually specify @samp{-lgcc} as well.
3804 This ensures that you have no unresolved references to internal GCC
3805 library subroutines. (For example, @samp{__main}, used to ensure C++
3806 constructors will be called; @pxref{Collect2,,@command{collect2}}.)
3809 Remove all symbol table and relocation information from the executable.
3812 On systems that support dynamic linking, this prevents linking with the shared
3813 libraries. On other systems, this option has no effect.
3816 Produce a shared object which can then be linked with other objects to
3817 form an executable. Not all systems support this option. For predictable
3818 results, you must also specify the same set of options that were used to
3819 generate code (@samp{-fpic}, @samp{-fPIC}, or model suboptions)
3820 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
3821 needs to build supplementary stub code for constructors to work. On
3822 multi-libbed systems, @samp{gcc -shared} must select the correct support
3823 libraries to link against. Failing to supply the correct flags may lead
3824 to subtle defects. Supplying them in cases where they are not necessary
3827 @item -shared-libgcc
3828 @itemx -static-libgcc
3829 On systems that provide @file{libgcc} as a shared library, these options
3830 force the use of either the shared or static version respectively.
3831 If no shared version of @file{libgcc} was built when the compiler was
3832 configured, these options have no effect.
3834 There are several situations in which an application should use the
3835 shared @file{libgcc} instead of the static version. The most common
3836 of these is when the application wishes to throw and catch exceptions
3837 across different shared libraries. In that case, each of the libraries
3838 as well as the application itself should use the shared @file{libgcc}.
3840 Therefore, whenever you specify the @samp{-shared} option, the GCC
3841 driver automatically adds @samp{-shared-libgcc}, unless you explicitly
3842 specify @samp{-static-libgcc}. The G++ driver automatically adds
3843 @samp{-shared-libgcc} when you build a main executable as well because
3844 for C++ programs that is typically the right thing to do.
3845 (Exception-handling will not work reliably otherwise.)
3847 However, when linking a main executable written in C, you must
3848 explicitly say @samp{-shared-libgcc} if you want to use the shared
3852 Bind references to global symbols when building a shared object. Warn
3853 about any unresolved references (unless overridden by the link editor
3854 option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
3857 @item -Xlinker @var{option}
3858 Pass @var{option} as an option to the linker. You can use this to
3859 supply system-specific linker options which GCC does not know how to
3862 If you want to pass an option that takes an argument, you must use
3863 @samp{-Xlinker} twice, once for the option and once for the argument.
3864 For example, to pass @samp{-assert definitions}, you must write
3865 @samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
3866 @samp{-Xlinker "-assert definitions"}, because this passes the entire
3867 string as a single argument, which is not what the linker expects.
3869 @item -Wl\,@var{option}
3870 Pass @var{option} as an option to the linker. If @var{option} contains
3871 commas, it is split into multiple options at the commas.
3873 @item -u @var{symbol}
3874 Pretend the symbol @var{symbol} is undefined, to force linking of
3875 library modules to define it. You can use @samp{-u} multiple times with
3876 different symbols to force loading of additional library modules.
3879 @node Directory Options
3880 @section Options for Directory Search
3881 @cindex directory options
3882 @cindex options, directory search
3885 These options specify directories to search for header files, for
3886 libraries and for parts of the compiler:
3890 Add the directory @var{dir} to the head of the list of directories to be
3891 searched for header files. This can be used to override a system header
3892 file, substituting your own version, since these directories are
3893 searched before the system header file directories. However, you should
3894 not use this option to add directories that contain vendor-supplied
3895 system header files (use @samp{-isystem} for that). If you use more than
3896 one @samp{-I} option, the directories are scanned in left-to-right
3897 order; the standard system directories come after.
3900 Any directories you specify with @samp{-I} options before the @samp{-I-}
3901 option are searched only for the case of @samp{#include "@var{file}"};
3902 they are not searched for @samp{#include <@var{file}>}.
3904 If additional directories are specified with @samp{-I} options after
3905 the @samp{-I-}, these directories are searched for all @samp{#include}
3906 directives. (Ordinarily @emph{all} @samp{-I} directories are used
3909 In addition, the @samp{-I-} option inhibits the use of the current
3910 directory (where the current input file came from) as the first search
3911 directory for @samp{#include "@var{file}"}. There is no way to
3912 override this effect of @samp{-I-}. With @samp{-I.} you can specify
3913 searching the directory which was current when the compiler was
3914 invoked. That is not exactly the same as what the preprocessor does
3915 by default, but it is often satisfactory.
3917 @samp{-I-} does not inhibit the use of the standard system directories
3918 for header files. Thus, @samp{-I-} and @samp{-nostdinc} are
3922 Add directory @var{dir} to the list of directories to be searched
3925 @item -B@var{prefix}
3926 This option specifies where to find the executables, libraries,
3927 include files, and data files of the compiler itself.
3929 The compiler driver program runs one or more of the subprograms
3930 @file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
3931 @var{prefix} as a prefix for each program it tries to run, both with and
3932 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
3934 For each subprogram to be run, the compiler driver first tries the
3935 @samp{-B} prefix, if any. If that name is not found, or if @samp{-B}
3936 was not specified, the driver tries two standard prefixes, which are
3937 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}. If neither of
3938 those results in a file name that is found, the unmodified program
3939 name is searched for using the directories specified in your
3940 @env{PATH} environment variable.
3942 @samp{-B} prefixes that effectively specify directory names also apply
3943 to libraries in the linker, because the compiler translates these
3944 options into @samp{-L} options for the linker. They also apply to
3945 includes files in the preprocessor, because the compiler translates these
3946 options into @samp{-isystem} options for the preprocessor. In this case,
3947 the compiler appends @samp{include} to the prefix.
3949 The run-time support file @file{libgcc.a} can also be searched for using
3950 the @samp{-B} prefix, if needed. If it is not found there, the two
3951 standard prefixes above are tried, and that is all. The file is left
3952 out of the link if it is not found by those means.
3954 Another way to specify a prefix much like the @samp{-B} prefix is to use
3955 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
3958 @item -specs=@var{file}
3959 Process @var{file} after the compiler reads in the standard @file{specs}
3960 file, in order to override the defaults that the @file{gcc} driver
3961 program uses when determining what switches to pass to @file{cc1},
3962 @file{cc1plus}, @file{as}, @file{ld}, etc. More than one
3963 @samp{-specs=}@var{file} can be specified on the command line, and they
3964 are processed in order, from left to right.
3970 @section Specifying subprocesses and the switches to pass to them
3972 @command{gcc} is a driver program. It performs its job by invoking a
3973 sequence of other programs to do the work of compiling, assembling and
3974 linking. GCC interprets its command-line parameters and uses these to
3975 deduce which programs it should invoke, and which command-line options
3976 it ought to place on their command lines. This behaviour is controlled
3977 by @dfn{spec strings}. In most cases there is one spec string for each
3978 program that GCC can invoke, but a few programs have multiple spec
3979 strings to control their behaviour. The spec strings built into GCC can
3980 be overridden by using the @samp{-specs=} command-line switch to specify
3983 @dfn{Spec files} are plaintext files that are used to construct spec
3984 strings. They consist of a sequence of directives separated by blank
3985 lines. The type of directive is determined by the first non-whitespace
3986 character on the line and it can be one of the following:
3989 @item %@var{command}
3990 Issues a @var{command} to the spec file processor. The commands that can
3994 @item %include <@var{file}>
3996 Search for @var{file} and insert its text at the current point in the
3999 @item %include_noerr <@var{file}>
4000 @cindex %include_noerr
4001 Just like @samp{%include}, but do not generate an error message if the include
4002 file cannot be found.
4004 @item %rename @var{old_name} @var{new_name}
4006 Rename the spec string @var{old_name} to @var{new_name}.
4010 @item *[@var{spec_name}]:
4011 This tells the compiler to create, override or delete the named spec
4012 string. All lines after this directive up to the next directive or
4013 blank line are considered to be the text for the spec string. If this
4014 results in an empty string then the spec will be deleted. (Or, if the
4015 spec did not exist, then nothing will happened.) Otherwise, if the spec
4016 does not currently exist a new spec will be created. If the spec does
4017 exist then its contents will be overridden by the text of this
4018 directive, unless the first character of that text is the @samp{+}
4019 character, in which case the text will be appended to the spec.
4021 @item [@var{suffix}]:
4022 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
4023 and up to the next directive or blank line are considered to make up the
4024 spec string for the indicated suffix. When the compiler encounters an
4025 input file with the named suffix, it will processes the spec string in
4026 order to work out how to compile that file. For example:
4033 This says that any input file whose name ends in @samp{.ZZ} should be
4034 passed to the program @samp{z-compile}, which should be invoked with the
4035 command-line switch @samp{-input} and with the result of performing the
4036 @samp{%i} substitution. (See below.)
4038 As an alternative to providing a spec string, the text that follows a
4039 suffix directive can be one of the following:
4042 @item @@@var{language}
4043 This says that the suffix is an alias for a known @var{language}. This is
4044 similar to using the @option{-x} command-line switch to GCC to specify a
4045 language explicitly. For example:
4052 Says that .ZZ files are, in fact, C++ source files.
4055 This causes an error messages saying:
4058 @var{name} compiler not installed on this system.
4062 GCC already has an extensive list of suffixes built into it.
4063 This directive will add an entry to the end of the list of suffixes, but
4064 since the list is searched from the end backwards, it is effectively
4065 possible to override earlier entries using this technique.
4069 GCC has the following spec strings built into it. Spec files can
4070 override these strings or create their own. Note that individual
4071 targets can also add their own spec strings to this list.
4074 asm Options to pass to the assembler
4075 asm_final Options to pass to the assembler post-processor
4076 cpp Options to pass to the C preprocessor
4077 cc1 Options to pass to the C compiler
4078 cc1plus Options to pass to the C++ compiler
4079 endfile Object files to include at the end of the link
4080 link Options to pass to the linker
4081 lib Libraries to include on the command line to the linker
4082 libgcc Decides which GCC support library to pass to the linker
4083 linker Sets the name of the linker
4084 predefines Defines to be passed to the C preprocessor
4085 signed_char Defines to pass to CPP to say whether @code{char} is signed by default
4086 startfile Object files to include at the start of the link
4089 Here is a small example of a spec file:
4095 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
4098 This example renames the spec called @samp{lib} to @samp{old_lib} and
4099 then overrides the previous definition of @samp{lib} with a new one.
4100 The new definition adds in some extra command-line options before
4101 including the text of the old definition.
4103 @dfn{Spec strings} are a list of command-line options to be passed to their
4104 corresponding program. In addition, the spec strings can contain
4105 @samp{%}-prefixed sequences to substitute variable text or to
4106 conditionally insert text into the command line. Using these constructs
4107 it is possible to generate quite complex command lines.
4109 Here is a table of all defined @samp{%}-sequences for spec
4110 strings. Note that spaces are not generated automatically around the
4111 results of expanding these sequences. Therefore you can concatenate them
4112 together or combine them with constant text in a single argument.
4116 Substitute one @samp{%} into the program name or argument.
4119 Substitute the name of the input file being processed.
4122 Substitute the basename of the input file being processed.
4123 This is the substring up to (and not including) the last period
4124 and not including the directory.
4127 This is the same as @samp{%b}, but include the file suffix (text after
4131 Marks the argument containing or following the @samp{%d} as a
4132 temporary file name, so that that file will be deleted if GCC exits
4133 successfully. Unlike @samp{%g}, this contributes no text to the
4136 @item %g@var{suffix}
4137 Substitute a file name that has suffix @var{suffix} and is chosen
4138 once per compilation, and mark the argument in the same way as
4139 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
4140 name is now chosen in a way that is hard to predict even when previously
4141 chosen file names are known. For example, @samp{%g.s ... %g.o ... %g.s}
4142 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
4143 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4144 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
4145 was simply substituted with a file name chosen once per compilation,
4146 without regard to any appended suffix (which was therefore treated
4147 just like ordinary text), making such attacks more likely to succeed.
4149 @item %u@var{suffix}
4150 Like @samp{%g}, but generates a new temporary file name even if
4151 @samp{%u@var{suffix}} was already seen.
4153 @item %U@var{suffix}
4154 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4155 new one if there is no such last file name. In the absence of any
4156 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4157 the same suffix @emph{space}, so @samp{%g.s ... %U.s ... %g.s ... %U.s}
4158 would involve the generation of two distinct file names, one
4159 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
4160 simply substituted with a file name chosen for the previous @samp{%u},
4161 without regard to any appended suffix.
4163 @item %j@var{SUFFIX}
4164 Substitutes the name of the HOST_BIT_BUCKET, if any, and if it is
4165 writable, and if save-temps is off; otherwise, substitute the name
4166 of a temporary file, just like @samp{%u}. This temporary file is not
4167 meant for communication between processes, but rather as a junk
4170 @item %.@var{SUFFIX}
4171 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4172 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
4173 terminated by the next space or %.
4176 Marks the argument containing or following the @samp{%w} as the
4177 designated output file of this compilation. This puts the argument
4178 into the sequence of arguments that @samp{%o} will substitute later.
4181 Substitutes the names of all the output files, with spaces
4182 automatically placed around them. You should write spaces
4183 around the @samp{%o} as well or the results are undefined.
4184 @samp{%o} is for use in the specs for running the linker.
4185 Input files whose names have no recognized suffix are not compiled
4186 at all, but they are included among the output files, so they will
4190 Substitutes the suffix for object files. Note that this is
4191 handled specially when it immediately follows @samp{%g, %u, or %U},
4192 because of the need for those to form complete file names. The
4193 handling is such that @samp{%O} is treated exactly as if it had already
4194 been substituted, except that @samp{%g, %u, and %U} do not currently
4195 support additional @var{suffix} characters following @samp{%O} as they would
4196 following, for example, @samp{.o}.
4199 Substitutes the standard macro predefinitions for the
4200 current target machine. Use this when running @code{cpp}.
4203 Like @samp{%p}, but puts @samp{__} before and after the name of each
4204 predefined macro, except for macros that start with @samp{__} or with
4205 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
4209 Substitute a @samp{-iprefix} option made from GCC_EXEC_PREFIX.
4212 Current argument is the name of a library or startup file of some sort.
4213 Search for that file in a standard list of directories and substitute
4214 the full name found.
4217 Print @var{str} as an error message. @var{str} is terminated by a newline.
4218 Use this when inconsistent options are detected.
4221 Output @samp{-} if the input for the current command is coming from a pipe.
4224 Substitute the contents of spec string @var{name} at this point.
4227 Like @samp{%(...)} but put @samp{__} around @samp{-D} arguments.
4229 @item %x@{@var{option}@}
4230 Accumulate an option for @samp{%X}.
4233 Output the accumulated linker options specified by @samp{-Wl} or a @samp{%x}
4237 Output the accumulated assembler options specified by @samp{-Wa}.
4240 Output the accumulated preprocessor options specified by @samp{-Wp}.
4243 Substitute the major version number of GCC.
4244 (For version 2.9.5, this is 2.)
4247 Substitute the minor version number of GCC.
4248 (For version 2.9.5, this is 9.)
4251 Substitute the patch level number of GCC.
4252 (For version 2.9.5, this is 5.)
4255 Process the @code{asm} spec. This is used to compute the
4256 switches to be passed to the assembler.
4259 Process the @code{asm_final} spec. This is a spec string for
4260 passing switches to an assembler post-processor, if such a program is
4264 Process the @code{link} spec. This is the spec for computing the
4265 command line passed to the linker. Typically it will make use of the
4266 @samp{%L %G %S %D and %E} sequences.
4269 Dump out a @samp{-L} option for each directory that GCC believes might
4270 contain startup files. If the target supports multilibs then the
4271 current multilib directory will be prepended to each of these paths.
4274 Output the multilib directory with directory seperators replaced with
4275 "_". If multilib directories are not set, or the multilib directory is
4276 "." then this option emits nothing.
4279 Process the @code{lib} spec. This is a spec string for deciding which
4280 libraries should be included on the command line to the linker.
4283 Process the @code{libgcc} spec. This is a spec string for deciding
4284 which GCC support library should be included on the command line to the linker.
4287 Process the @code{startfile} spec. This is a spec for deciding which
4288 object files should be the first ones passed to the linker. Typically
4289 this might be a file named @file{crt0.o}.
4292 Process the @code{endfile} spec. This is a spec string that specifies
4293 the last object files that will be passed to the linker.
4296 Process the @code{cpp} spec. This is used to construct the arguments
4297 to be passed to the C preprocessor.
4300 Process the @code{signed_char} spec. This is intended to be used
4301 to tell cpp whether a char is signed. It typically has the definition:
4303 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
4307 Process the @code{cc1} spec. This is used to construct the options to be
4308 passed to the actual C compiler (@samp{cc1}).
4311 Process the @code{cc1plus} spec. This is used to construct the options to be
4312 passed to the actual C++ compiler (@samp{cc1plus}).
4315 Substitute the variable part of a matched option. See below.
4316 Note that each comma in the substituted string is replaced by
4320 Substitutes the @code{-S} switch, if that switch was given to GCC.
4321 If that switch was not specified, this substitutes nothing. Note that
4322 the leading dash is omitted when specifying this option, and it is
4323 automatically inserted if the substitution is performed. Thus the spec
4324 string @samp{%@{foo@}} would match the command-line option @samp{-foo}
4325 and would output the command line option @samp{-foo}.
4327 @item %W@{@code{S}@}
4328 Like %@{@code{S}@} but mark last argument supplied within as a file to be
4331 @item %@{@code{S}*@}
4332 Substitutes all the switches specified to GCC whose names start
4333 with @code{-S}, but which also take an argument. This is used for
4334 switches like @samp{-o, -D, -I}, etc. GCC considers @samp{-o foo} as being
4335 one switch whose names starts with @samp{o}. %@{o*@} would substitute this
4336 text, including the space. Thus two arguments would be generated.
4338 @item %@{^@code{S}*@}
4339 Like %@{@code{S}*@}, but don't put a blank between a switch and its
4340 argument. Thus %@{^o*@} would only generate one argument, not two.
4342 @item %@{@code{S}*&@code{T}*@}
4343 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4344 (the order of @code{S} and @code{T} in the spec is not significant).
4345 There can be any number of ampersand-separated variables; for each the
4346 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
4348 @item %@{<@code{S}@}
4349 Remove all occurrences of @code{-S} from the command line. Note - this
4350 command is position dependent. @samp{%} commands in the spec string
4351 before this option will see @code{-S}, @samp{%} commands in the spec
4352 string after this option will not.
4354 @item %@{@code{S}*:@code{X}@}
4355 Substitutes @code{X} if one or more switches whose names start with
4356 @code{-S} are specified to GCC. Note that the tail part of the
4357 @code{-S} option (i.e. the part matched by the @samp{*}) will be substituted
4358 for each occurrence of @samp{%*} within @code{X}.
4360 @item %@{@code{S}:@code{X}@}
4361 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC.
4363 @item %@{!@code{S}:@code{X}@}
4364 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC.
4366 @item %@{|@code{S}:@code{X}@}
4367 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4369 @item %@{|!@code{S}:@code{X}@}
4370 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4372 @item %@{.@code{S}:@code{X}@}
4373 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4375 @item %@{!.@code{S}:@code{X}@}
4376 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4378 @item %@{@code{S}|@code{P}:@code{X}@}
4379 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC. This may be
4380 combined with @samp{!} and @samp{.} sequences as well, although they
4381 have a stronger binding than the @samp{|}. For example a spec string
4385 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4388 will output the following command-line options from the following input
4389 command-line options:
4394 -d fred.c -foo -baz -boggle
4395 -d jim.d -bar -baz -boggle
4400 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4401 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4402 or spaces, or even newlines. They are processed as usual, as described
4405 The @samp{-O, -f, -m, and -W} switches are handled specifically in these
4406 constructs. If another value of @samp{-O} or the negated form of a @samp{-f, -m, or
4407 -W} switch is found later in the command line, the earlier switch
4408 value is ignored, except with @{@code{S}*@} where @code{S} is just one
4409 letter, which passes all matching options.
4411 The character @samp{|} at the beginning of the predicate text is used to indicate
4412 that a command should be piped to the following command, but only if @samp{-pipe}
4415 It is built into GCC which switches take arguments and which do not.
4416 (You might think it would be useful to generalize this to allow each
4417 compiler's spec to say which switches take arguments. But this cannot
4418 be done in a consistent fashion. GCC cannot even decide which input
4419 files have been specified without knowing which switches take arguments,
4420 and it must know which input files to compile in order to tell which
4423 GCC also knows implicitly that arguments starting in @samp{-l} are to be
4424 treated as compiler output files, and passed to the linker in their
4425 proper position among the other output files.
4427 @c man begin OPTIONS
4429 @node Target Options
4430 @section Specifying Target Machine and Compiler Version
4431 @cindex target options
4432 @cindex cross compiling
4433 @cindex specifying machine version
4434 @cindex specifying compiler version and target machine
4435 @cindex compiler version, specifying
4436 @cindex target machine, specifying
4438 By default, GCC compiles code for the same type of machine that you
4439 are using. However, it can also be installed as a cross-compiler, to
4440 compile for some other type of machine. In fact, several different
4441 configurations of GCC, for different target machines, can be
4442 installed side by side. Then you specify which one to use with the
4445 In addition, older and newer versions of GCC can be installed side
4446 by side. One of them (probably the newest) will be the default, but
4447 you may sometimes wish to use another.
4450 @item -b @var{machine}
4451 The argument @var{machine} specifies the target machine for compilation.
4452 This is useful when you have installed GCC as a cross-compiler.
4454 The value to use for @var{machine} is the same as was specified as the
4455 machine type when configuring GCC as a cross-compiler. For
4456 example, if a cross-compiler was configured with @samp{configure
4457 i386v}, meaning to compile for an 80386 running System V, then you
4458 would specify @samp{-b i386v} to run that cross compiler.
4460 When you do not specify @samp{-b}, it normally means to compile for
4461 the same type of machine that you are using.
4463 @item -V @var{version}
4464 The argument @var{version} specifies which version of GCC to run.
4465 This is useful when multiple versions are installed. For example,
4466 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
4468 The default version, when you do not specify @samp{-V}, is the last
4469 version of GCC that you installed.
4472 The @samp{-b} and @samp{-V} options actually work by controlling part of
4473 the file name used for the executable files and libraries used for
4474 compilation. A given version of GCC, for a given target machine, is
4475 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.@refill
4477 Thus, sites can customize the effect of @samp{-b} or @samp{-V} either by
4478 changing the names of these directories or adding alternate names (or
4479 symbolic links). If in directory @file{/usr/local/lib/gcc-lib/} the
4480 file @file{80386} is a link to the file @file{i386v}, then @samp{-b
4481 80386} becomes an alias for @samp{-b i386v}.
4483 In one respect, the @samp{-b} or @samp{-V} do not completely change
4484 to a different compiler: the top-level driver program @command{gcc}
4485 that you originally invoked continues to run and invoke the other
4486 executables (preprocessor, compiler per se, assembler and linker)
4487 that do the real work. However, since no real work is done in the
4488 driver program, it usually does not matter that the driver program
4489 in use is not the one for the specified target. It is common for the
4490 interface to the other executables to change incompatibly between
4491 compiler versions, so unless the version specified is very close to that
4492 of the driver (for example, @samp{-V 3.0} with a driver program from GCC
4493 version 3.0.1), use of @samp{-V} may not work; for example, using
4494 @samp{-V 2.95.2} will not work with a driver program from GCC 3.0.
4496 The only way that the driver program depends on the target machine is
4497 in the parsing and handling of special machine-specific options.
4498 However, this is controlled by a file which is found, along with the
4499 other executables, in the directory for the specified version and
4500 target machine. As a result, a single installed driver program adapts
4501 to any specified target machine, and sufficiently similar compiler
4504 The driver program executable does control one significant thing,
4505 however: the default version and target machine. Therefore, you can
4506 install different instances of the driver program, compiled for
4507 different targets or versions, under different names.
4509 For example, if the driver for version 2.0 is installed as @command{ogcc}
4510 and that for version 2.1 is installed as @command{gcc}, then the command
4511 @command{gcc} will use version 2.1 by default, while @command{ogcc} will use
4512 2.0 by default. However, you can choose either version with either
4513 command with the @samp{-V} option.
4515 @node Submodel Options
4516 @section Hardware Models and Configurations
4517 @cindex submodel options
4518 @cindex specifying hardware config
4519 @cindex hardware models and configurations, specifying
4520 @cindex machine dependent options
4522 Earlier we discussed the standard option @samp{-b} which chooses among
4523 different installed compilers for completely different target
4524 machines, such as Vax vs. 68000 vs. 80386.
4526 In addition, each of these target machine types can have its own
4527 special options, starting with @samp{-m}, to choose among various
4528 hardware models or configurations---for example, 68010 vs 68020,
4529 floating coprocessor or none. A single installed version of the
4530 compiler can compile for any model or configuration, according to the
4533 Some configurations of the compiler also support additional special
4534 options, usually for compatibility with other compilers on the same
4538 These options are defined by the macro @code{TARGET_SWITCHES} in the
4539 machine description. The default for the options is also defined by
4540 that macro, which enables you to change the defaults.
4556 * RS/6000 and PowerPC Options::
4561 * Intel 960 Options::
4562 * DEC Alpha Options::
4566 * System V Options::
4567 * TMS320C3x/C4x Options::
4577 @node M680x0 Options
4578 @subsection M680x0 Options
4579 @cindex M680x0 options
4581 These are the @samp{-m} options defined for the 68000 series. The default
4582 values for these options depends on which style of 68000 was selected when
4583 the compiler was configured; the defaults for the most common choices are
4589 Generate output for a 68000. This is the default
4590 when the compiler is configured for 68000-based systems.
4592 Use this option for microcontrollers with a 68000 or EC000 core,
4593 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
4597 Generate output for a 68020. This is the default
4598 when the compiler is configured for 68020-based systems.
4601 Generate output containing 68881 instructions for floating point.
4602 This is the default for most 68020 systems unless @samp{-nfp} was
4603 specified when the compiler was configured.
4606 Generate output for a 68030. This is the default when the compiler is
4607 configured for 68030-based systems.
4610 Generate output for a 68040. This is the default when the compiler is
4611 configured for 68040-based systems.
4613 This option inhibits the use of 68881/68882 instructions that have to be
4614 emulated by software on the 68040. Use this option if your 68040 does not
4615 have code to emulate those instructions.
4618 Generate output for a 68060. This is the default when the compiler is
4619 configured for 68060-based systems.
4621 This option inhibits the use of 68020 and 68881/68882 instructions that
4622 have to be emulated by software on the 68060. Use this option if your 68060
4623 does not have code to emulate those instructions.
4626 Generate output for a CPU32. This is the default
4627 when the compiler is configured for CPU32-based systems.
4629 Use this option for microcontrollers with a
4630 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
4631 68336, 68340, 68341, 68349 and 68360.
4634 Generate output for a 520X "coldfire" family cpu. This is the default
4635 when the compiler is configured for 520X-based systems.
4637 Use this option for microcontroller with a 5200 core, including
4638 the MCF5202, MCF5203, MCF5204 and MCF5202.
4642 Generate output for a 68040, without using any of the new instructions.
4643 This results in code which can run relatively efficiently on either a
4644 68020/68881 or a 68030 or a 68040. The generated code does use the
4645 68881 instructions that are emulated on the 68040.
4648 Generate output for a 68060, without using any of the new instructions.
4649 This results in code which can run relatively efficiently on either a
4650 68020/68881 or a 68030 or a 68040. The generated code does use the
4651 68881 instructions that are emulated on the 68060.
4654 Generate output containing Sun FPA instructions for floating point.
4657 Generate output containing library calls for floating point.
4658 @strong{Warning:} the requisite libraries are not available for all m68k
4659 targets. Normally the facilities of the machine's usual C compiler are
4660 used, but this can't be done directly in cross-compilation. You must
4661 make your own arrangements to provide suitable library functions for
4662 cross-compilation. The embedded targets @samp{m68k-*-aout} and
4663 @samp{m68k-*-coff} do provide software floating point support.
4666 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4669 Do not use the bit-field instructions. The @samp{-m68000}, @samp{-mcpu32}
4670 and @samp{-m5200} options imply @w{@samp{-mnobitfield}}.
4673 Do use the bit-field instructions. The @samp{-m68020} option implies
4674 @samp{-mbitfield}. This is the default if you use a configuration
4675 designed for a 68020.
4678 Use a different function-calling convention, in which functions
4679 that take a fixed number of arguments return with the @code{rtd}
4680 instruction, which pops their arguments while returning. This
4681 saves one instruction in the caller since there is no need to pop
4682 the arguments there.
4684 This calling convention is incompatible with the one normally
4685 used on Unix, so you cannot use it if you need to call libraries
4686 compiled with the Unix compiler.
4688 Also, you must provide function prototypes for all functions that
4689 take variable numbers of arguments (including @code{printf});
4690 otherwise incorrect code will be generated for calls to those
4693 In addition, seriously incorrect code will result if you call a
4694 function with too many arguments. (Normally, extra arguments are
4695 harmlessly ignored.)
4697 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
4698 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
4701 @itemx -mno-align-int
4702 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
4703 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
4704 boundary (@samp{-malign-int}) or a 16-bit boundary (@samp{-mno-align-int}).
4705 Aligning variables on 32-bit boundaries produces code that runs somewhat
4706 faster on processors with 32-bit busses at the expense of more memory.
4708 @strong{Warning:} if you use the @samp{-malign-int} switch, GCC will
4709 align structures containing the above types differently than
4710 most published application binary interface specifications for the m68k.
4713 Use the pc-relative addressing mode of the 68000 directly, instead of
4714 using a global offset table. At present, this option implies -fpic,
4715 allowing at most a 16-bit offset for pc-relative addressing. -fPIC is
4716 not presently supported with -mpcrel, though this could be supported for
4717 68020 and higher processors.
4719 @item -mno-strict-align
4720 @itemx -mstrict-align
4721 @kindex -mstrict-align
4722 Do not (do) assume that unaligned memory references will be handled by
4727 @node M68hc1x Options
4728 @subsection M68hc1x Options
4729 @cindex M68hc1x options
4731 These are the @samp{-m} options defined for the 68hc11 and 68hc12
4732 microcontrollers. The default values for these options depends on
4733 which style of microcontroller was selected when the compiler was configured;
4734 the defaults for the most common choices are given below.
4739 Generate output for a 68HC11. This is the default
4740 when the compiler is configured for 68HC11-based systems.
4744 Generate output for a 68HC12. This is the default
4745 when the compiler is configured for 68HC12-based systems.
4748 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
4752 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4754 @item -msoft-reg-count=@var{count}
4755 Specify the number of pseudo-soft registers which are used for the
4756 code generation. The maximum number is 32. Using more pseudo-soft
4757 register may or may not result in better code depending on the program.
4758 The default is 4 for 68HC11 and 2 for 68HC12.
4763 @subsection VAX Options
4766 These @samp{-m} options are defined for the Vax:
4770 Do not output certain jump instructions (@code{aobleq} and so on)
4771 that the Unix assembler for the Vax cannot handle across long
4775 Do output those jump instructions, on the assumption that you
4776 will assemble with the GNU assembler.
4779 Output code for g-format floating point numbers instead of d-format.
4783 @subsection SPARC Options
4784 @cindex SPARC options
4786 These @samp{-m} switches are supported on the SPARC:
4791 Specify @samp{-mapp-regs} to generate output using the global registers
4792 2 through 4, which the SPARC SVR4 ABI reserves for applications. This
4795 To be fully SVR4 ABI compliant at the cost of some performance loss,
4796 specify @samp{-mno-app-regs}. You should compile libraries and system
4797 software with this option.
4801 Generate output containing floating point instructions. This is the
4806 Generate output containing library calls for floating point.
4807 @strong{Warning:} the requisite libraries are not available for all SPARC
4808 targets. Normally the facilities of the machine's usual C compiler are
4809 used, but this cannot be done directly in cross-compilation. You must make
4810 your own arrangements to provide suitable library functions for
4811 cross-compilation. The embedded targets @samp{sparc-*-aout} and
4812 @samp{sparclite-*-*} do provide software floating point support.
4814 @samp{-msoft-float} changes the calling convention in the output file;
4815 therefore, it is only useful if you compile @emph{all} of a program with
4816 this option. In particular, you need to compile @file{libgcc.a}, the
4817 library that comes with GCC, with @samp{-msoft-float} in order for
4820 @item -mhard-quad-float
4821 Generate output containing quad-word (long double) floating point
4824 @item -msoft-quad-float
4825 Generate output containing library calls for quad-word (long double)
4826 floating point instructions. The functions called are those specified
4827 in the SPARC ABI. This is the default.
4829 As of this writing, there are no sparc implementations that have hardware
4830 support for the quad-word floating point instructions. They all invoke
4831 a trap handler for one of these instructions, and then the trap handler
4832 emulates the effect of the instruction. Because of the trap handler overhead,
4833 this is much slower than calling the ABI library routines. Thus the
4834 @samp{-msoft-quad-float} option is the default.
4838 With @samp{-mepilogue} (the default), the compiler always emits code for
4839 function exit at the end of each function. Any function exit in
4840 the middle of the function (such as a return statement in C) will
4841 generate a jump to the exit code at the end of the function.
4843 With @samp{-mno-epilogue}, the compiler tries to emit exit code inline
4844 at every function exit.
4848 With @samp{-mflat}, the compiler does not generate save/restore instructions
4849 and will use a "flat" or single register window calling convention.
4850 This model uses %i7 as the frame pointer and is compatible with the normal
4851 register window model. Code from either may be intermixed.
4852 The local registers and the input registers (0-5) are still treated as
4853 "call saved" registers and will be saved on the stack as necessary.
4855 With @samp{-mno-flat} (the default), the compiler emits save/restore
4856 instructions (except for leaf functions) and is the normal mode of operation.
4858 @item -mno-unaligned-doubles
4859 @itemx -munaligned-doubles
4860 Assume that doubles have 8 byte alignment. This is the default.
4862 With @samp{-munaligned-doubles}, GCC assumes that doubles have 8 byte
4863 alignment only if they are contained in another type, or if they have an
4864 absolute address. Otherwise, it assumes they have 4 byte alignment.
4865 Specifying this option avoids some rare compatibility problems with code
4866 generated by other compilers. It is not the default because it results
4867 in a performance loss, especially for floating point code.
4869 @item -mno-faster-structs
4870 @itemx -mfaster-structs
4871 With @samp{-mfaster-structs}, the compiler assumes that structures
4872 should have 8 byte alignment. This enables the use of pairs of
4873 @code{ldd} and @code{std} instructions for copies in structure
4874 assignment, in place of twice as many @code{ld} and @code{st} pairs.
4875 However, the use of this changed alignment directly violates the Sparc
4876 ABI. Thus, it's intended only for use on targets where the developer
4877 acknowledges that their resulting code will not be directly in line with
4878 the rules of the ABI.
4882 These two options select variations on the SPARC architecture.
4884 By default (unless specifically configured for the Fujitsu SPARClite),
4885 GCC generates code for the v7 variant of the SPARC architecture.
4887 @samp{-mv8} will give you SPARC v8 code. The only difference from v7
4888 code is that the compiler emits the integer multiply and integer
4889 divide instructions which exist in SPARC v8 but not in SPARC v7.
4891 @samp{-msparclite} will give you SPARClite code. This adds the integer
4892 multiply, integer divide step and scan (@code{ffs}) instructions which
4893 exist in SPARClite but not in SPARC v7.
4895 These options are deprecated and will be deleted in a future GCC release.
4896 They have been replaced with @samp{-mcpu=xxx}.
4900 These two options select the processor for which the code is optimised.
4902 With @samp{-mcypress} (the default), the compiler optimizes code for the
4903 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
4904 This is also appropriate for the older SparcStation 1, 2, IPX etc.
4906 With @samp{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
4907 used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
4908 of the full SPARC v8 instruction set.
4910 These options are deprecated and will be deleted in a future GCC release.
4911 They have been replaced with @samp{-mcpu=xxx}.
4913 @item -mcpu=@var{cpu_type}
4914 Set the instruction set, register set, and instruction scheduling parameters
4915 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
4916 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
4917 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
4918 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
4920 Default instruction scheduling parameters are used for values that select
4921 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
4922 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
4924 Here is a list of each supported architecture and their supported
4929 v8: supersparc, hypersparc
4930 sparclite: f930, f934, sparclite86x
4935 @item -mtune=@var{cpu_type}
4936 Set the instruction scheduling parameters for machine type
4937 @var{cpu_type}, but do not set the instruction set or register set that the
4938 option @samp{-mcpu=}@var{cpu_type} would.
4940 The same values for @samp{-mcpu=}@var{cpu_type} are used for
4941 @samp{-mtune=}@*@var{cpu_type}, though the only useful values are those that
4942 select a particular cpu implementation: @samp{cypress}, @samp{supersparc},
4943 @samp{hypersparc}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
4944 @samp{tsc701}, @samp{ultrasparc}.
4948 These @samp{-m} switches are supported in addition to the above
4949 on the SPARCLET processor.
4952 @item -mlittle-endian
4953 Generate code for a processor running in little-endian mode.
4956 Treat register @code{%g0} as a normal register.
4957 GCC will continue to clobber it as necessary but will not assume
4958 it always reads as 0.
4960 @item -mbroken-saverestore
4961 Generate code that does not use non-trivial forms of the @code{save} and
4962 @code{restore} instructions. Early versions of the SPARCLET processor do
4963 not correctly handle @code{save} and @code{restore} instructions used with
4964 arguments. They correctly handle them used without arguments. A @code{save}
4965 instruction used without arguments increments the current window pointer
4966 but does not allocate a new stack frame. It is assumed that the window
4967 overflow trap handler will properly handle this case as will interrupt
4971 These @samp{-m} switches are supported in addition to the above
4972 on SPARC V9 processors in 64-bit environments.
4975 @item -mlittle-endian
4976 Generate code for a processor running in little-endian mode.
4980 Generate code for a 32-bit or 64-bit environment.
4981 The 32-bit environment sets int, long and pointer to 32 bits.
4982 The 64-bit environment sets int to 32 bits and long and pointer
4985 @item -mcmodel=medlow
4986 Generate code for the Medium/Low code model: the program must be linked
4987 in the low 32 bits of the address space. Pointers are 64 bits.
4988 Programs can be statically or dynamically linked.
4990 @item -mcmodel=medmid
4991 Generate code for the Medium/Middle code model: the program must be linked
4992 in the low 44 bits of the address space, the text segment must be less than
4993 2G bytes, and data segment must be within 2G of the text segment.
4994 Pointers are 64 bits.
4996 @item -mcmodel=medany
4997 Generate code for the Medium/Anywhere code model: the program may be linked
4998 anywhere in the address space, the text segment must be less than
4999 2G bytes, and data segment must be within 2G of the text segment.
5000 Pointers are 64 bits.
5002 @item -mcmodel=embmedany
5003 Generate code for the Medium/Anywhere code model for embedded systems:
5004 assume a 32-bit text and a 32-bit data segment, both starting anywhere
5005 (determined at link time). Register %g4 points to the base of the
5006 data segment. Pointers are still 64 bits.
5007 Programs are statically linked, PIC is not supported.
5010 @itemx -mno-stack-bias
5011 With @samp{-mstack-bias}, GCC assumes that the stack pointer, and
5012 frame pointer if present, are offset by -2047 which must be added back
5013 when making stack frame references.
5014 Otherwise, assume no such offset is present.
5017 @node Convex Options
5018 @subsection Convex Options
5019 @cindex Convex options
5021 These @samp{-m} options are defined for Convex:
5025 Generate output for C1. The code will run on any Convex machine.
5026 The preprocessor symbol @code{__convex__c1__} is defined.
5029 Generate output for C2. Uses instructions not available on C1.
5030 Scheduling and other optimizations are chosen for max performance on C2.
5031 The preprocessor symbol @code{__convex_c2__} is defined.
5034 Generate output for C32xx. Uses instructions not available on C1.
5035 Scheduling and other optimizations are chosen for max performance on C32.
5036 The preprocessor symbol @code{__convex_c32__} is defined.
5039 Generate output for C34xx. Uses instructions not available on C1.
5040 Scheduling and other optimizations are chosen for max performance on C34.
5041 The preprocessor symbol @code{__convex_c34__} is defined.
5044 Generate output for C38xx. Uses instructions not available on C1.
5045 Scheduling and other optimizations are chosen for max performance on C38.
5046 The preprocessor symbol @code{__convex_c38__} is defined.
5049 Generate code which puts an argument count in the word preceding each
5050 argument list. This is compatible with regular CC, and a few programs
5051 may need the argument count word. GDB and other source-level debuggers
5052 do not need it; this info is in the symbol table.
5055 Omit the argument count word. This is the default.
5057 @item -mvolatile-cache
5058 Allow volatile references to be cached. This is the default.
5060 @item -mvolatile-nocache
5061 Volatile references bypass the data cache, going all the way to memory.
5062 This is only needed for multi-processor code that does not use standard
5063 synchronization instructions. Making non-volatile references to volatile
5064 locations will not necessarily work.
5067 Type long is 32 bits, the same as type int. This is the default.
5070 Type long is 64 bits, the same as type long long. This option is useless,
5071 because no library support exists for it.
5074 @node AMD29K Options
5075 @subsection AMD29K Options
5076 @cindex AMD29K options
5078 These @samp{-m} options are defined for the AMD Am29000:
5083 @cindex DW bit (29k)
5084 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
5085 halfword operations are directly supported by the hardware. This is the
5090 Generate code that assumes the @code{DW} bit is not set.
5094 @cindex byte writes (29k)
5095 Generate code that assumes the system supports byte and halfword write
5096 operations. This is the default.
5100 Generate code that assumes the systems does not support byte and
5101 halfword write operations. @samp{-mnbw} implies @samp{-mndw}.
5105 @cindex memory model (29k)
5106 Use a small memory model that assumes that all function addresses are
5107 either within a single 256 KB segment or at an absolute address of less
5108 than 256k. This allows the @code{call} instruction to be used instead
5109 of a @code{const}, @code{consth}, @code{calli} sequence.
5113 Use the normal memory model: Generate @code{call} instructions only when
5114 calling functions in the same file and @code{calli} instructions
5115 otherwise. This works if each file occupies less than 256 KB but allows
5116 the entire executable to be larger than 256 KB. This is the default.
5119 Always use @code{calli} instructions. Specify this option if you expect
5120 a single file to compile into more than 256 KB of code.
5124 @cindex processor selection (29k)
5125 Generate code for the Am29050.
5129 Generate code for the Am29000. This is the default.
5131 @item -mkernel-registers
5132 @kindex -mkernel-registers
5133 @cindex kernel and user registers (29k)
5134 Generate references to registers @code{gr64-gr95} instead of to
5135 registers @code{gr96-gr127}. This option can be used when compiling
5136 kernel code that wants a set of global registers disjoint from that used
5139 Note that when this option is used, register names in @samp{-f} flags
5140 must use the normal, user-mode, names.
5142 @item -muser-registers
5143 @kindex -muser-registers
5144 Use the normal set of global registers, @code{gr96-gr127}. This is the
5148 @itemx -mno-stack-check
5149 @kindex -mstack-check
5150 @cindex stack checks (29k)
5151 Insert (or do not insert) a call to @code{__msp_check} after each stack
5152 adjustment. This is often used for kernel code.
5155 @itemx -mno-storem-bug
5156 @kindex -mstorem-bug
5157 @cindex storem bug (29k)
5158 @samp{-mstorem-bug} handles 29k processors which cannot handle the
5159 separation of a mtsrim insn and a storem instruction (most 29000 chips
5160 to date, but not the 29050).
5162 @item -mno-reuse-arg-regs
5163 @itemx -mreuse-arg-regs
5164 @kindex -mreuse-arg-regs
5165 @samp{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5166 registers for copying out arguments. This helps detect calling a function
5167 with fewer arguments than it was declared with.
5169 @item -mno-impure-text
5170 @itemx -mimpure-text
5171 @kindex -mimpure-text
5172 @samp{-mimpure-text}, used in addition to @samp{-shared}, tells the compiler to
5173 not pass @samp{-assert pure-text} to the linker when linking a shared object.
5176 @kindex -msoft-float
5177 Generate output containing library calls for floating point.
5178 @strong{Warning:} the requisite libraries are not part of GCC.
5179 Normally the facilities of the machine's usual C compiler are used, but
5180 this can't be done directly in cross-compilation. You must make your
5181 own arrangements to provide suitable library functions for
5186 Do not generate multm or multmu instructions. This is useful for some embedded
5187 systems which do not have trap handlers for these instructions.
5191 @subsection ARM Options
5194 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5199 @kindex -mapcs-frame
5200 Generate a stack frame that is compliant with the ARM Procedure Call
5201 Standard for all functions, even if this is not strictly necessary for
5202 correct execution of the code. Specifying @samp{-fomit-frame-pointer}
5203 with this option will cause the stack frames not to be generated for
5204 leaf functions. The default is @samp{-mno-apcs-frame}.
5208 This is a synonym for @samp{-mapcs-frame}.
5212 Generate code for a processor running with a 26-bit program counter,
5213 and conforming to the function calling standards for the APCS 26-bit
5214 option. This option replaces the @samp{-m2} and @samp{-m3} options
5215 of previous releases of the compiler.
5219 Generate code for a processor running with a 32-bit program counter,
5220 and conforming to the function calling standards for the APCS 32-bit
5221 option. This option replaces the @samp{-m6} option of previous releases
5224 @item -mapcs-stack-check
5225 @kindex -mapcs-stack-check
5226 @kindex -mno-apcs-stack-check
5227 Generate code to check the amount of stack space available upon entry to
5228 every function (that actually uses some stack space). If there is
5229 insufficient space available then either the function
5230 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5231 called, depending upon the amount of stack space required. The run time
5232 system is required to provide these functions. The default is
5233 @samp{-mno-apcs-stack-check}, since this produces smaller code.
5236 @kindex -mapcs-float
5237 @kindex -mno-apcs-float
5238 Pass floating point arguments using the float point registers. This is
5239 one of the variants of the APCS. This option is recommended if the
5240 target hardware has a floating point unit or if a lot of floating point
5241 arithmetic is going to be performed by the code. The default is
5242 @samp{-mno-apcs-float}, since integer only code is slightly increased in
5243 size if @samp{-mapcs-float} is used.
5245 @item -mapcs-reentrant
5246 @kindex -mapcs-reentrant
5247 @kindex -mno-apcs-reentrant
5248 Generate reentrant, position independent code. This is the equivalent
5249 to specifying the @samp{-fpic} option. The default is
5250 @samp{-mno-apcs-reentrant}.
5252 @item -mthumb-interwork
5253 @kindex -mthumb-interwork
5254 @kindex -mno-thumb-interwork
5255 Generate code which supports calling between the ARM and THUMB
5256 instruction sets. Without this option the two instruction sets cannot
5257 be reliably used inside one program. The default is
5258 @samp{-mno-thumb-interwork}, since slightly larger code is generated
5259 when @samp{-mthumb-interwork} is specified.
5261 @item -mno-sched-prolog
5262 @kindex -mno-sched-prolog
5263 @kindex -msched-prolog
5264 Prevent the reordering of instructions in the function prolog, or the
5265 merging of those instruction with the instructions in the function's
5266 body. This means that all functions will start with a recognizable set
5267 of instructions (or in fact one of a choice from a small set of
5268 different function prologues), and this information can be used to
5269 locate the start if functions inside an executable piece of code. The
5270 default is @samp{-msched-prolog}.
5273 Generate output containing floating point instructions. This is the
5277 Generate output containing library calls for floating point.
5278 @strong{Warning:} the requisite libraries are not available for all ARM
5279 targets. Normally the facilities of the machine's usual C compiler are
5280 used, but this cannot be done directly in cross-compilation. You must make
5281 your own arrangements to provide suitable library functions for
5284 @samp{-msoft-float} changes the calling convention in the output file;
5285 therefore, it is only useful if you compile @emph{all} of a program with
5286 this option. In particular, you need to compile @file{libgcc.a}, the
5287 library that comes with GCC, with @samp{-msoft-float} in order for
5290 @item -mlittle-endian
5291 Generate code for a processor running in little-endian mode. This is
5292 the default for all standard configurations.
5295 Generate code for a processor running in big-endian mode; the default is
5296 to compile code for a little-endian processor.
5298 @item -mwords-little-endian
5299 This option only applies when generating code for big-endian processors.
5300 Generate code for a little-endian word order but a big-endian byte
5301 order. That is, a byte order of the form @samp{32107654}. Note: this
5302 option should only be used if you require compatibility with code for
5303 big-endian ARM processors generated by versions of the compiler prior to
5306 @item -malignment-traps
5307 @kindex -malignment-traps
5308 Generate code that will not trap if the MMU has alignment traps enabled.
5309 On ARM architectures prior to ARMv4, there were no instructions to
5310 access half-word objects stored in memory. However, when reading from
5311 memory a feature of the ARM architecture allows a word load to be used,
5312 even if the address is unaligned, and the processor core will rotate the
5313 data as it is being loaded. This option tells the compiler that such
5314 misaligned accesses will cause a MMU trap and that it should instead
5315 synthesise the access as a series of byte accesses. The compiler can
5316 still use word accesses to load half-word data if it knows that the
5317 address is aligned to a word boundary.
5319 This option is ignored when compiling for ARM architecture 4 or later,
5320 since these processors have instructions to directly access half-word
5323 @item -mno-alignment-traps
5324 @kindex -mno-alignment-traps
5325 Generate code that assumes that the MMU will not trap unaligned
5326 accesses. This produces better code when the target instruction set
5327 does not have half-word memory operations (implementations prior to
5330 Note that you cannot use this option to access unaligned word objects,
5331 since the processor will only fetch one 32-bit aligned object from
5334 The default setting for most targets is -mno-alignment-traps, since
5335 this produces better code when there are no half-word memory
5336 instructions available.
5338 @item -mshort-load-bytes
5339 @kindex -mshort-load-bytes
5340 This is a deprecated alias for @samp{-malignment-traps}.
5342 @item -mno-short-load-bytes
5343 @kindex -mno-short-load-bytes
5344 This is a deprecated alias for @samp{-mno-alignment-traps}.
5346 @item -mshort-load-words
5347 @kindex -mshort-load-words
5348 This is a deprecated alias for @samp{-mno-alignment-traps}.
5350 @item -mno-short-load-words
5351 @kindex -mno-short-load-words
5352 This is a deprecated alias for @samp{-malignment-traps}.
5356 This option only applies to RISC iX. Emulate the native BSD-mode
5357 compiler. This is the default if @samp{-ansi} is not specified.
5361 This option only applies to RISC iX. Emulate the native X/Open-mode
5364 @item -mno-symrename
5365 @kindex -mno-symrename
5366 This option only applies to RISC iX. Do not run the assembler
5367 post-processor, @samp{symrename}, after code has been assembled.
5368 Normally it is necessary to modify some of the standard symbols in
5369 preparation for linking with the RISC iX C library; this option
5370 suppresses this pass. The post-processor is never run when the
5371 compiler is built for cross-compilation.
5375 This specifies the name of the target ARM processor. GCC uses this name
5376 to determine what kind of instructions it can use when generating
5377 assembly code. Permissible names are: arm2, arm250, arm3, arm6, arm60,
5378 arm600, arm610, arm620, arm7, arm7m, arm7d, arm7dm, arm7di, arm7dmi,
5379 arm70, arm700, arm700i, arm710, arm710c, arm7100, arm7500, arm7500fe,
5380 arm7tdmi, arm8, strongarm, strongarm110, strongarm1100, arm8, arm810,
5381 arm9, arm920, arm920t, arm9tdmi.
5383 @itemx -mtune=<name>
5385 This option is very similar to the @samp{-mcpu=} option, except that
5386 instead of specifying the actual target processor type, and hence
5387 restricting which instructions can be used, it specifies that GCC should
5388 tune the performance of the code as if the target were of the type
5389 specified in this option, but still choosing the instructions that it
5390 will generate based on the cpu specified by a @samp{-mcpu=} option.
5391 For some arm implementations better performance can be obtained by using
5396 This specifies the name of the target ARM architecture. GCC uses this
5397 name to determine what kind of instructions it can use when generating
5398 assembly code. This option can be used in conjunction with or instead
5399 of the @samp{-mcpu=} option. Permissible names are: armv2, armv2a,
5400 armv3, armv3m, armv4, armv4t, armv5.
5402 @item -mfpe=<number>
5403 @itemx -mfp=<number>
5406 This specifies the version of the floating point emulation available on
5407 the target. Permissible values are 2 and 3. @samp{-mfp=} is a synonym
5408 for @samp{-mfpe=} to support older versions of GCC.
5410 @item -mstructure-size-boundary=<n>
5411 @kindex -mstructure-size-boundary
5412 The size of all structures and unions will be rounded up to a multiple
5413 of the number of bits set by this option. Permissible values are 8 and
5414 32. The default value varies for different toolchains. For the COFF
5415 targeted toolchain the default value is 8. Specifying the larger number
5416 can produce faster, more efficient code, but can also increase the size
5417 of the program. The two values are potentially incompatible. Code
5418 compiled with one value cannot necessarily expect to work with code or
5419 libraries compiled with the other value, if they exchange information
5420 using structures or unions. Programmers are encouraged to use the 32
5421 value as future versions of the toolchain may default to this value.
5423 @item -mabort-on-noreturn
5424 @kindex -mabort-on-noreturn
5425 @kindex -mnoabort-on-noreturn
5426 Generate a call to the function abort at the end of a noreturn function.
5427 It will be executed if the function tries to return.
5430 @itemx -mno-long-calls
5431 Tells the compiler to perform function calls by first loading the
5432 address of the function into a register and then performing a subroutine
5433 call on this register. This switch is needed if the target function
5434 will lie outside of the 64 megabyte addressing range of the offset based
5435 version of subroutine call instruction.
5437 Even if this switch is enabled, not all function calls will be turned
5438 into long calls. The heuristic is that static functions, functions
5439 which have the @samp{short-call} attribute, functions that are inside
5440 the scope of a @samp{#pragma no_long_calls} directive and functions whose
5441 definitions have already been compiled within the current compilation
5442 unit, will not be turned into long calls. The exception to this rule is
5443 that weak function definitions, functions with the @samp{long-call}
5444 attribute or the @samp{section} attribute, and functions that are within
5445 the scope of a @samp{#pragma long_calls} directive, will always be
5446 turned into long calls.
5448 This feature is not enabled by default. Specifying
5449 @samp{--no-long-calls} will restore the default behaviour, as will
5450 placing the function calls within the scope of a @samp{#pragma
5451 long_calls_off} directive. Note these switches have no effect on how
5452 the compiler generates code to handle function calls via function
5455 @item -mnop-fun-dllimport
5456 @kindex -mnop-fun-dllimport
5457 Disable the support for the @emph{dllimport} attribute.
5459 @item -msingle-pic-base
5460 @kindex -msingle-pic-base
5461 Treat the register used for PIC addressing as read-only, rather than
5462 loading it in the prologue for each function. The run-time system is
5463 responsible for initialising this register with an appropriate value
5464 before execution begins.
5466 @item -mpic-register=<reg>
5467 @kindex -mpic-register=
5468 Specify the register to be used for PIC addressing. The default is R10
5469 unless stack-checking is enabled, when R9 is used.
5474 @subsection Thumb Options
5475 @cindex Thumb Options
5479 @item -mthumb-interwork
5480 @kindex -mthumb-interwork
5481 @kindex -mno-thumb-interwork
5482 Generate code which supports calling between the THUMB and ARM
5483 instruction sets. Without this option the two instruction sets cannot
5484 be reliably used inside one program. The default is
5485 @samp{-mno-thumb-interwork}, since slightly smaller code is generated
5489 @kindex -mtpcs-frame
5490 @kindex -mno-tpcs-frame
5491 Generate a stack frame that is compliant with the Thumb Procedure Call
5492 Standard for all non-leaf functions. (A leaf function is one that does
5493 not call any other functions). The default is @samp{-mno-apcs-frame}.
5495 @item -mtpcs-leaf-frame
5496 @kindex -mtpcs-leaf-frame
5497 @kindex -mno-tpcs-leaf-frame
5498 Generate a stack frame that is compliant with the Thumb Procedure Call
5499 Standard for all leaf functions. (A leaf function is one that does
5500 not call any other functions). The default is @samp{-mno-apcs-leaf-frame}.
5502 @item -mlittle-endian
5503 @kindex -mlittle-endian
5504 Generate code for a processor running in little-endian mode. This is
5505 the default for all standard configurations.
5508 @kindex -mbig-endian
5509 Generate code for a processor running in big-endian mode.
5511 @item -mstructure-size-boundary=<n>
5512 @kindex -mstructure-size-boundary
5513 The size of all structures and unions will be rounded up to a multiple
5514 of the number of bits set by this option. Permissible values are 8 and
5515 32. The default value varies for different toolchains. For the COFF
5516 targeted toolchain the default value is 8. Specifying the larger number
5517 can produced faster, more efficient code, but can also increase the size
5518 of the program. The two values are potentially incompatible. Code
5519 compiled with one value cannot necessarily expect to work with code or
5520 libraries compiled with the other value, if they exchange information
5521 using structures or unions. Programmers are encouraged to use the 32
5522 value as future versions of the toolchain may default to this value.
5524 @item -mnop-fun-dllimport
5525 @kindex -mnop-fun-dllimport
5526 Disable the support for the @emph{dllimport} attribute.
5528 @item -mcallee-super-interworking
5529 @kindex -mcallee-super-interworking
5530 Gives all externally visible functions in the file being compiled an ARM
5531 instruction set header which switches to Thumb mode before executing the
5532 rest of the function. This allows these functions to be called from
5533 non-interworking code.
5535 @item -mcaller-super-interworking
5536 @kindex -mcaller-super-interworking
5537 Allows calls via function pointers (including virtual functions) to
5538 execute correctly regardless of whether the target code has been
5539 compiled for interworking or not. There is a small overhead in the cost
5540 of executing a function pointer if this option is enabled.
5542 @item -msingle-pic-base
5543 @kindex -msingle-pic-base
5544 Treat the register used for PIC addressing as read-only, rather than
5545 loading it in the prologue for each function. The run-time system is
5546 responsible for initialising this register with an appropriate value
5547 before execution begins.
5549 @item -mpic-register=<reg>
5550 @kindex -mpic-register=
5551 Specify the register to be used for PIC addressing. The default is R10.
5555 @node MN10200 Options
5556 @subsection MN10200 Options
5557 @cindex MN10200 options
5558 These @samp{-m} options are defined for Matsushita MN10200 architectures:
5562 Indicate to the linker that it should perform a relaxation optimization pass
5563 to shorten branches, calls and absolute memory addresses. This option only
5564 has an effect when used on the command line for the final link step.
5566 This option makes symbolic debugging impossible.
5569 @node MN10300 Options
5570 @subsection MN10300 Options
5571 @cindex MN10300 options
5572 These @samp{-m} options are defined for Matsushita MN10300 architectures:
5576 Generate code to avoid bugs in the multiply instructions for the MN10300
5577 processors. This is the default.
5580 Do not generate code to avoid bugs in the multiply instructions for the
5584 Generate code which uses features specific to the AM33 processor.
5587 Do not generate code which uses features specific to the AM33 processor. This
5591 Indicate to the linker that it should perform a relaxation optimization pass
5592 to shorten branches, calls and absolute memory addresses. This option only
5593 has an effect when used on the command line for the final link step.
5595 This option makes symbolic debugging impossible.
5599 @node M32R/D Options
5600 @subsection M32R/D Options
5601 @cindex M32R/D options
5603 These @samp{-m} options are defined for Mitsubishi M32R/D architectures:
5606 @item -mcode-model=small
5607 Assume all objects live in the lower 16MB of memory (so that their addresses
5608 can be loaded with the @code{ld24} instruction), and assume all subroutines
5609 are reachable with the @code{bl} instruction.
5610 This is the default.
5612 The addressability of a particular object can be set with the
5613 @code{model} attribute.
5615 @item -mcode-model=medium
5616 Assume objects may be anywhere in the 32-bit address space (the compiler
5617 will generate @code{seth/add3} instructions to load their addresses), and
5618 assume all subroutines are reachable with the @code{bl} instruction.
5620 @item -mcode-model=large
5621 Assume objects may be anywhere in the 32-bit address space (the compiler
5622 will generate @code{seth/add3} instructions to load their addresses), and
5623 assume subroutines may not be reachable with the @code{bl} instruction
5624 (the compiler will generate the much slower @code{seth/add3/jl}
5625 instruction sequence).
5628 Disable use of the small data area. Variables will be put into
5629 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
5630 @code{section} attribute has been specified).
5631 This is the default.
5633 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
5634 Objects may be explicitly put in the small data area with the
5635 @code{section} attribute using one of these sections.
5638 Put small global and static data in the small data area, but do not
5639 generate special code to reference them.
5642 Put small global and static data in the small data area, and generate
5643 special instructions to reference them.
5646 @cindex smaller data references
5647 Put global and static objects less than or equal to @var{num} bytes
5648 into the small data or bss sections instead of the normal data or bss
5649 sections. The default value of @var{num} is 8.
5650 The @samp{-msdata} option must be set to one of @samp{sdata} or @samp{use}
5651 for this option to have any effect.
5653 All modules should be compiled with the same @samp{-G @var{num}} value.
5654 Compiling with different values of @var{num} may or may not work; if it
5655 doesn't the linker will give an error message - incorrect code will not be
5661 @subsection M88K Options
5662 @cindex M88k options
5664 These @samp{-m} options are defined for Motorola 88k architectures:
5669 Generate code that works well on both the m88100 and the
5674 Generate code that works best for the m88100, but that also
5679 Generate code that works best for the m88110, and may not run
5684 Obsolete option to be removed from the next revision.
5687 @item -midentify-revision
5688 @kindex -midentify-revision
5690 @cindex identifying source, compiler (88k)
5691 Include an @code{ident} directive in the assembler output recording the
5692 source file name, compiler name and version, timestamp, and compilation
5695 @item -mno-underscores
5696 @kindex -mno-underscores
5697 @cindex underscores, avoiding (88k)
5698 In assembler output, emit symbol names without adding an underscore
5699 character at the beginning of each name. The default is to use an
5700 underscore as prefix on each name.
5702 @item -mocs-debug-info
5703 @itemx -mno-ocs-debug-info
5704 @kindex -mocs-debug-info
5705 @kindex -mno-ocs-debug-info
5707 @cindex debugging, 88k OCS
5708 Include (or omit) additional debugging information (about registers used
5709 in each stack frame) as specified in the 88open Object Compatibility
5710 Standard, ``OCS''. This extra information allows debugging of code that
5711 has had the frame pointer eliminated. The default for DG/UX, SVr4, and
5712 Delta 88 SVr3.2 is to include this information; other 88k configurations
5713 omit this information by default.
5715 @item -mocs-frame-position
5716 @kindex -mocs-frame-position
5717 @cindex register positions in frame (88k)
5718 When emitting COFF debugging information for automatic variables and
5719 parameters stored on the stack, use the offset from the canonical frame
5720 address, which is the stack pointer (register 31) on entry to the
5721 function. The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
5722 @samp{-mocs-frame-position}; other 88k configurations have the default
5723 @samp{-mno-ocs-frame-position}.
5725 @item -mno-ocs-frame-position
5726 @kindex -mno-ocs-frame-position
5727 @cindex register positions in frame (88k)
5728 When emitting COFF debugging information for automatic variables and
5729 parameters stored on the stack, use the offset from the frame pointer
5730 register (register 30). When this option is in effect, the frame
5731 pointer is not eliminated when debugging information is selected by the
5734 @item -moptimize-arg-area
5735 @itemx -mno-optimize-arg-area
5736 @kindex -moptimize-arg-area
5737 @kindex -mno-optimize-arg-area
5738 @cindex arguments in frame (88k)
5739 Control how function arguments are stored in stack frames.
5740 @samp{-moptimize-arg-area} saves space by optimizing them, but this
5741 conflicts with the 88open specifications. The opposite alternative,
5742 @samp{-mno-optimize-arg-area}, agrees with 88open standards. By default
5743 GCC does not optimize the argument area.
5745 @item -mshort-data-@var{num}
5746 @kindex -mshort-data-@var{num}
5747 @cindex smaller data references (88k)
5748 @cindex r0-relative references (88k)
5749 Generate smaller data references by making them relative to @code{r0},
5750 which allows loading a value using a single instruction (rather than the
5751 usual two). You control which data references are affected by
5752 specifying @var{num} with this option. For example, if you specify
5753 @samp{-mshort-data-512}, then the data references affected are those
5754 involving displacements of less than 512 bytes.
5755 @samp{-mshort-data-@var{num}} is not effective for @var{num} greater
5758 @item -mserialize-volatile
5759 @kindex -mserialize-volatile
5760 @itemx -mno-serialize-volatile
5761 @kindex -mno-serialize-volatile
5762 @cindex sequential consistency on 88k
5763 Do, or don't, generate code to guarantee sequential consistency
5764 of volatile memory references. By default, consistency is
5767 The order of memory references made by the MC88110 processor does
5768 not always match the order of the instructions requesting those
5769 references. In particular, a load instruction may execute before
5770 a preceding store instruction. Such reordering violates
5771 sequential consistency of volatile memory references, when there
5772 are multiple processors. When consistency must be guaranteed,
5773 GNU C generates special instructions, as needed, to force
5774 execution in the proper order.
5776 The MC88100 processor does not reorder memory references and so
5777 always provides sequential consistency. However, by default, GNU
5778 C generates the special instructions to guarantee consistency
5779 even when you use @samp{-m88100}, so that the code may be run on an
5780 MC88110 processor. If you intend to run your code only on the
5781 MC88100 processor, you may use @samp{-mno-serialize-volatile}.
5783 The extra code generated to guarantee consistency may affect the
5784 performance of your application. If you know that you can safely
5785 forgo this guarantee, you may use @samp{-mno-serialize-volatile}.
5791 @cindex assembler syntax, 88k
5793 Turn on (@samp{-msvr4}) or off (@samp{-msvr3}) compiler extensions
5794 related to System V release 4 (SVr4). This controls the following:
5798 Which variant of the assembler syntax to emit.
5800 @samp{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
5801 that is used on System V release 4.
5803 @samp{-msvr4} makes GCC issue additional declaration directives used in
5807 @samp{-msvr4} is the default for the m88k-motorola-sysv4 and
5808 m88k-dg-dgux m88k configurations. @samp{-msvr3} is the default for all
5809 other m88k configurations.
5811 @item -mversion-03.00
5812 @kindex -mversion-03.00
5813 This option is obsolete, and is ignored.
5814 @c ??? which asm syntax better for GAS? option there too?
5816 @item -mno-check-zero-division
5817 @itemx -mcheck-zero-division
5818 @kindex -mno-check-zero-division
5819 @kindex -mcheck-zero-division
5820 @cindex zero division on 88k
5821 Do, or don't, generate code to guarantee that integer division by
5822 zero will be detected. By default, detection is guaranteed.
5824 Some models of the MC88100 processor fail to trap upon integer
5825 division by zero under certain conditions. By default, when
5826 compiling code that might be run on such a processor, GNU C
5827 generates code that explicitly checks for zero-valued divisors
5828 and traps with exception number 503 when one is detected. Use of
5829 mno-check-zero-division suppresses such checking for code
5830 generated to run on an MC88100 processor.
5832 GNU C assumes that the MC88110 processor correctly detects all
5833 instances of integer division by zero. When @samp{-m88110} is
5834 specified, both @samp{-mcheck-zero-division} and
5835 @samp{-mno-check-zero-division} are ignored, and no explicit checks for
5836 zero-valued divisors are generated.
5838 @item -muse-div-instruction
5839 @kindex -muse-div-instruction
5840 @cindex divide instruction, 88k
5841 Use the div instruction for signed integer division on the
5842 MC88100 processor. By default, the div instruction is not used.
5844 On the MC88100 processor the signed integer division instruction
5845 div) traps to the operating system on a negative operand. The
5846 operating system transparently completes the operation, but at a
5847 large cost in execution time. By default, when compiling code
5848 that might be run on an MC88100 processor, GNU C emulates signed
5849 integer division using the unsigned integer division instruction
5850 divu), thereby avoiding the large penalty of a trap to the
5851 operating system. Such emulation has its own, smaller, execution
5852 cost in both time and space. To the extent that your code's
5853 important signed integer division operations are performed on two
5854 nonnegative operands, it may be desirable to use the div
5855 instruction directly.
5857 On the MC88110 processor the div instruction (also known as the
5858 divs instruction) processes negative operands without trapping to
5859 the operating system. When @samp{-m88110} is specified,
5860 @samp{-muse-div-instruction} is ignored, and the div instruction is used
5861 for signed integer division.
5863 Note that the result of dividing INT_MIN by -1 is undefined. In
5864 particular, the behavior of such a division with and without
5865 @samp{-muse-div-instruction} may differ.
5867 @item -mtrap-large-shift
5868 @itemx -mhandle-large-shift
5869 @kindex -mtrap-large-shift
5870 @kindex -mhandle-large-shift
5871 @cindex bit shift overflow (88k)
5872 @cindex large bit shifts (88k)
5873 Include code to detect bit-shifts of more than 31 bits; respectively,
5874 trap such shifts or emit code to handle them properly. By default GCC
5875 makes no special provision for large bit shifts.
5877 @item -mwarn-passed-structs
5878 @kindex -mwarn-passed-structs
5879 @cindex structure passing (88k)
5880 Warn when a function passes a struct as an argument or result.
5881 Structure-passing conventions have changed during the evolution of the C
5882 language, and are often the source of portability problems. By default,
5883 GCC issues no such warning.
5886 @node RS/6000 and PowerPC Options
5887 @subsection IBM RS/6000 and PowerPC Options
5888 @cindex RS/6000 and PowerPC Options
5889 @cindex IBM RS/6000 and PowerPC Options
5891 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
5899 @itemx -mpowerpc-gpopt
5900 @itemx -mno-powerpc-gpopt
5901 @itemx -mpowerpc-gfxopt
5902 @itemx -mno-powerpc-gfxopt
5904 @itemx -mno-powerpc64
5908 @kindex -mpowerpc-gpopt
5909 @kindex -mpowerpc-gfxopt
5911 GCC supports two related instruction set architectures for the
5912 RS/6000 and PowerPC. The @dfn{POWER} instruction set are those
5913 instructions supported by the @samp{rios} chip set used in the original
5914 RS/6000 systems and the @dfn{PowerPC} instruction set is the
5915 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
5916 the IBM 4xx microprocessors.
5918 Neither architecture is a subset of the other. However there is a
5919 large common subset of instructions supported by both. An MQ
5920 register is included in processors supporting the POWER architecture.
5922 You use these options to specify which instructions are available on the
5923 processor you are using. The default value of these options is
5924 determined when configuring GCC. Specifying the
5925 @samp{-mcpu=@var{cpu_type}} overrides the specification of these
5926 options. We recommend you use the @samp{-mcpu=@var{cpu_type}} option
5927 rather than the options listed above.
5929 The @samp{-mpower} option allows GCC to generate instructions that
5930 are found only in the POWER architecture and to use the MQ register.
5931 Specifying @samp{-mpower2} implies @samp{-power} and also allows GCC
5932 to generate instructions that are present in the POWER2 architecture but
5933 not the original POWER architecture.
5935 The @samp{-mpowerpc} option allows GCC to generate instructions that
5936 are found only in the 32-bit subset of the PowerPC architecture.
5937 Specifying @samp{-mpowerpc-gpopt} implies @samp{-mpowerpc} and also allows
5938 GCC to use the optional PowerPC architecture instructions in the
5939 General Purpose group, including floating-point square root. Specifying
5940 @samp{-mpowerpc-gfxopt} implies @samp{-mpowerpc} and also allows GCC to
5941 use the optional PowerPC architecture instructions in the Graphics
5942 group, including floating-point select.
5944 The @samp{-mpowerpc64} option allows GCC to generate the additional
5945 64-bit instructions that are found in the full PowerPC64 architecture
5946 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
5947 @samp{-mno-powerpc64}.
5949 If you specify both @samp{-mno-power} and @samp{-mno-powerpc}, GCC
5950 will use only the instructions in the common subset of both
5951 architectures plus some special AIX common-mode calls, and will not use
5952 the MQ register. Specifying both @samp{-mpower} and @samp{-mpowerpc}
5953 permits GCC to use any instruction from either architecture and to
5954 allow use of the MQ register; specify this for the Motorola MPC601.
5956 @item -mnew-mnemonics
5957 @itemx -mold-mnemonics
5958 @kindex -mnew-mnemonics
5959 @kindex -mold-mnemonics
5960 Select which mnemonics to use in the generated assembler code.
5961 @samp{-mnew-mnemonics} requests output that uses the assembler mnemonics
5962 defined for the PowerPC architecture, while @samp{-mold-mnemonics}
5963 requests the assembler mnemonics defined for the POWER architecture.
5964 Instructions defined in only one architecture have only one mnemonic;
5965 GCC uses that mnemonic irrespective of which of these options is
5968 GCC defaults to the mnemonics appropriate for the architecture in
5969 use. Specifying @samp{-mcpu=@var{cpu_type}} sometimes overrides the
5970 value of these option. Unless you are building a cross-compiler, you
5971 should normally not specify either @samp{-mnew-mnemonics} or
5972 @samp{-mold-mnemonics}, but should instead accept the default.
5974 @item -mcpu=@var{cpu_type}
5976 Set architecture type, register usage, choice of mnemonics, and
5977 instruction scheduling parameters for machine type @var{cpu_type}.
5978 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
5979 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
5980 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
5981 @samp{630}, @samp{740}, @samp{750}, @samp{power}, @samp{power2},
5982 @samp{powerpc}, @samp{403}, @samp{505}, @samp{801}, @samp{821},
5983 @samp{823}, and @samp{860} and @samp{common}. @samp{-mcpu=power},
5984 @samp{-mcpu=power2}, @samp{-mcpu=powerpc}, and @samp{-mcpu=powerpc64}
5985 specify generic POWER, POWER2, pure 32-bit PowerPC (i.e., not MPC601),
5986 and 64-bit PowerPC architecture machine types, with an appropriate,
5987 generic processor model assumed for scheduling purposes.@refill
5989 Specifying any of the following options:
5990 @samp{-mcpu=rios1}, @samp{-mcpu=rios2}, @samp{-mcpu=rsc},
5991 @samp{-mcpu=power}, or @samp{-mcpu=power2}
5992 enables the @samp{-mpower} option and disables the @samp{-mpowerpc} option;
5993 @samp{-mcpu=601} enables both the @samp{-mpower} and @samp{-mpowerpc} options.
5994 All of @samp{-mcpu=rs64a}, @samp{-mcpu=602}, @samp{-mcpu=603},
5995 @samp{-mcpu=603e}, @samp{-mcpu=604}, @samp{-mcpu=620}, @samp{-mcpu=630},
5996 @samp{-mcpu=740}, and @samp{-mcpu=750}
5997 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
5998 Exactly similarly, all of @samp{-mcpu=403},
5999 @samp{-mcpu=505}, @samp{-mcpu=821}, @samp{-mcpu=860} and @samp{-mcpu=powerpc}
6000 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
6001 @samp{-mcpu=common} disables both the
6002 @samp{-mpower} and @samp{-mpowerpc} options.@refill
6004 AIX versions 4 or greater selects @samp{-mcpu=common} by default, so
6005 that code will operate on all members of the RS/6000 POWER and PowerPC
6006 families. In that case, GCC will use only the instructions in the
6007 common subset of both architectures plus some special AIX common-mode
6008 calls, and will not use the MQ register. GCC assumes a generic
6009 processor model for scheduling purposes.
6011 Specifying any of the options @samp{-mcpu=rios1}, @samp{-mcpu=rios2},
6012 @samp{-mcpu=rsc}, @samp{-mcpu=power}, or @samp{-mcpu=power2} also
6013 disables the @samp{new-mnemonics} option. Specifying @samp{-mcpu=601},
6014 @samp{-mcpu=602}, @samp{-mcpu=603}, @samp{-mcpu=603e}, @samp{-mcpu=604},
6015 @samp{-mcpu=620}, @samp{-mcpu=630}, @samp{-mcpu=403}, @samp{-mcpu=505},
6016 @samp{-mcpu=821}, @samp{-mcpu=860} or @samp{-mcpu=powerpc} also enables
6017 the @samp{new-mnemonics} option.@refill
6019 Specifying @samp{-mcpu=403}, @samp{-mcpu=821}, or @samp{-mcpu=860} also
6020 enables the @samp{-msoft-float} option.
6022 @item -mtune=@var{cpu_type}
6023 Set the instruction scheduling parameters for machine type
6024 @var{cpu_type}, but do not set the architecture type, register usage,
6025 choice of mnemonics like @samp{-mcpu=}@var{cpu_type} would. The same
6026 values for @var{cpu_type} are used for @samp{-mtune=}@var{cpu_type} as
6027 for @samp{-mcpu=}@var{cpu_type}. The @samp{-mtune=}@var{cpu_type}
6028 option overrides the @samp{-mcpu=}@var{cpu_type} option in terms of
6029 instruction scheduling parameters.
6032 @itemx -mno-fp-in-toc
6033 @itemx -mno-sum-in-toc
6034 @itemx -mminimal-toc
6035 @kindex -mminimal-toc
6036 Modify generation of the TOC (Table Of Contents), which is created for
6037 every executable file. The @samp{-mfull-toc} option is selected by
6038 default. In that case, GCC will allocate at least one TOC entry for
6039 each unique non-automatic variable reference in your program. GCC
6040 will also place floating-point constants in the TOC. However, only
6041 16,384 entries are available in the TOC.
6043 If you receive a linker error message that saying you have overflowed
6044 the available TOC space, you can reduce the amount of TOC space used
6045 with the @samp{-mno-fp-in-toc} and @samp{-mno-sum-in-toc} options.
6046 @samp{-mno-fp-in-toc} prevents GCC from putting floating-point
6047 constants in the TOC and @samp{-mno-sum-in-toc} forces GCC to
6048 generate code to calculate the sum of an address and a constant at
6049 run-time instead of putting that sum into the TOC. You may specify one
6050 or both of these options. Each causes GCC to produce very slightly
6051 slower and larger code at the expense of conserving TOC space.
6053 If you still run out of space in the TOC even when you specify both of
6054 these options, specify @samp{-mminimal-toc} instead. This option causes
6055 GCC to make only one TOC entry for every file. When you specify this
6056 option, GCC will produce code that is slower and larger but which
6057 uses extremely little TOC space. You may wish to use this option
6058 only on files that contain less frequently executed code. @refill
6064 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6065 @code{long} type, and the infrastructure needed to support them.
6066 Specifying @samp{-maix64} implies @samp{-mpowerpc64} and
6067 @samp{-mpowerpc}, while @samp{-maix32} disables the 64-bit ABI and
6068 implies @samp{-mno-powerpc64}. GCC defaults to @samp{-maix32}.
6073 On AIX, pass floating-point arguments to prototyped functions beyond the
6074 register save area (RSA) on the stack in addition to argument FPRs. The
6075 AIX calling convention was extended but not initially documented to
6076 handle an obscure K&R C case of calling a function that takes the
6077 address of its arguments with fewer arguments than declared. AIX XL
6078 compilers access floating point arguments which do not fit in the
6079 RSA from the stack when a subroutine is compiled without
6080 optimization. Because always storing floating-point arguments on the
6081 stack is inefficient and rarely needed, this option is not enabled by
6082 default and only is necessary when calling subroutines compiled by AIX
6083 XL compilers without optimization.
6087 Support @dfn{AIX Threads}. Link an application written to use
6088 @dfn{pthreads} with special libraries and startup code to enable the
6093 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE). Link an
6094 application written to use message passing with special startup code to
6095 enable the application to run. The system must have PE installed in the
6096 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6097 must be overridden with the @samp{-specs=} option to specify the
6098 appropriate directory location. The Parallel Environment does not
6099 support threads, so the @samp{-mpe} option and the @samp{-mthreads}
6100 option are incompatible.
6104 @kindex -msoft-float
6105 Generate code that does not use (uses) the floating-point register set.
6106 Software floating point emulation is provided if you use the
6107 @samp{-msoft-float} option, and pass the option to GCC when linking.
6110 @itemx -mno-multiple
6111 Generate code that uses (does not use) the load multiple word
6112 instructions and the store multiple word instructions. These
6113 instructions are generated by default on POWER systems, and not
6114 generated on PowerPC systems. Do not use @samp{-mmultiple} on little
6115 endian PowerPC systems, since those instructions do not work when the
6116 processor is in little endian mode. The exceptions are PPC740 and
6117 PPC750 which permit the instructions usage in little endian mode.
6122 Generate code that uses (does not use) the load string instructions
6123 and the store string word instructions to save multiple registers and
6124 do small block moves. These instructions are generated by default on
6125 POWER systems, and not generated on PowerPC systems. Do not use
6126 @samp{-mstring} on little endian PowerPC systems, since those
6127 instructions do not work when the processor is in little endian mode.
6128 The exceptions are PPC740 and PPC750 which permit the instructions
6129 usage in little endian mode.
6134 Generate code that uses (does not use) the load or store instructions
6135 that update the base register to the address of the calculated memory
6136 location. These instructions are generated by default. If you use
6137 @samp{-mno-update}, there is a small window between the time that the
6138 stack pointer is updated and the address of the previous frame is
6139 stored, which means code that walks the stack frame across interrupts or
6140 signals may get corrupted data.
6143 @itemx -mno-fused-madd
6144 @kindex -mfused-madd
6145 Generate code that uses (does not use) the floating point multiply and
6146 accumulate instructions. These instructions are generated by default if
6147 hardware floating is used.
6149 @item -mno-bit-align
6152 On System V.4 and embedded PowerPC systems do not (do) force structures
6153 and unions that contain bit fields to be aligned to the base type of the
6156 For example, by default a structure containing nothing but 8
6157 @code{unsigned} bitfields of length 1 would be aligned to a 4 byte
6158 boundary and have a size of 4 bytes. By using @samp{-mno-bit-align},
6159 the structure would be aligned to a 1 byte boundary and be one byte in
6162 @item -mno-strict-align
6163 @itemx -mstrict-align
6164 @kindex -mstrict-align
6165 On System V.4 and embedded PowerPC systems do not (do) assume that
6166 unaligned memory references will be handled by the system.
6169 @itemx -mno-relocatable
6170 @kindex -mrelocatable
6171 On embedded PowerPC systems generate code that allows (does not allow)
6172 the program to be relocated to a different address at runtime. If you
6173 use @samp{-mrelocatable} on any module, all objects linked together must
6174 be compiled with @samp{-mrelocatable} or @samp{-mrelocatable-lib}.
6176 @item -mrelocatable-lib
6177 @itemx -mno-relocatable-lib
6178 On embedded PowerPC systems generate code that allows (does not allow)
6179 the program to be relocated to a different address at runtime. Modules
6180 compiled with @samp{-mrelocatable-lib} can be linked with either modules
6181 compiled without @samp{-mrelocatable} and @samp{-mrelocatable-lib} or
6182 with modules compiled with the @samp{-mrelocatable} options.
6186 On System V.4 and embedded PowerPC systems do not (do) assume that
6187 register 2 contains a pointer to a global area pointing to the addresses
6188 used in the program.
6191 @itemx -mlittle-endian
6192 On System V.4 and embedded PowerPC systems compile code for the
6193 processor in little endian mode. The @samp{-mlittle-endian} option is
6194 the same as @samp{-mlittle}.
6198 On System V.4 and embedded PowerPC systems compile code for the
6199 processor in big endian mode. The @samp{-mbig-endian} option is
6200 the same as @samp{-mbig}.
6203 On System V.4 and embedded PowerPC systems compile code using calling
6204 conventions that adheres to the March 1995 draft of the System V
6205 Application Binary Interface, PowerPC processor supplement. This is the
6206 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6208 @item -mcall-sysv-eabi
6209 Specify both @samp{-mcall-sysv} and @samp{-meabi} options.
6211 @item -mcall-sysv-noeabi
6212 Specify both @samp{-mcall-sysv} and @samp{-mno-eabi} options.
6215 On System V.4 and embedded PowerPC systems compile code using calling
6216 conventions that are similar to those used on AIX. This is the
6217 default if you configured GCC using @samp{powerpc-*-eabiaix}.
6219 @item -mcall-solaris
6220 On System V.4 and embedded PowerPC systems compile code for the Solaris
6224 On System V.4 and embedded PowerPC systems compile code for the
6225 Linux-based GNU system.
6228 @itemx -mno-prototype
6229 On System V.4 and embedded PowerPC systems assume that all calls to
6230 variable argument functions are properly prototyped. Otherwise, the
6231 compiler must insert an instruction before every non prototyped call to
6232 set or clear bit 6 of the condition code register (@var{CR}) to
6233 indicate whether floating point values were passed in the floating point
6234 registers in case the function takes a variable arguments. With
6235 @samp{-mprototype}, only calls to prototyped variable argument functions
6236 will set or clear the bit.
6239 On embedded PowerPC systems, assume that the startup module is called
6240 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6241 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
6245 On embedded PowerPC systems, assume that the startup module is called
6246 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6250 On embedded PowerPC systems, assume that the startup module is called
6251 @file{crt0.o} and the standard C libraries are @file{libads.a} and
6255 On embedded PowerPC systems, assume that the startup module is called
6256 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
6260 On System V.4 and embedded PowerPC systems, specify that you are
6261 compiling for a VxWorks system.
6264 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
6265 header to indicate that @samp{eabi} extended relocations are used.
6269 On System V.4 and embedded PowerPC systems do (do not) adhere to the
6270 Embedded Applications Binary Interface (eabi) which is a set of
6271 modifications to the System V.4 specifications. Selecting @option{-meabi}
6272 means that the stack is aligned to an 8 byte boundary, a function
6273 @code{__eabi} is called to from @code{main} to set up the eabi
6274 environment, and the @samp{-msdata} option can use both @code{r2} and
6275 @code{r13} to point to two separate small data areas. Selecting
6276 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
6277 do not call an initialization function from @code{main}, and the
6278 @samp{-msdata} option will only use @code{r13} to point to a single
6279 small data area. The @samp{-meabi} option is on by default if you
6280 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
6283 On System V.4 and embedded PowerPC systems, put small initialized
6284 @code{const} global and static data in the @samp{.sdata2} section, which
6285 is pointed to by register @code{r2}. Put small initialized
6286 non-@code{const} global and static data in the @samp{.sdata} section,
6287 which is pointed to by register @code{r13}. Put small uninitialized
6288 global and static data in the @samp{.sbss} section, which is adjacent to
6289 the @samp{.sdata} section. The @samp{-msdata=eabi} option is
6290 incompatible with the @samp{-mrelocatable} option. The
6291 @samp{-msdata=eabi} option also sets the @samp{-memb} option.
6294 On System V.4 and embedded PowerPC systems, put small global and static
6295 data in the @samp{.sdata} section, which is pointed to by register
6296 @code{r13}. Put small uninitialized global and static data in the
6297 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
6298 The @samp{-msdata=sysv} option is incompatible with the
6299 @samp{-mrelocatable} option.
6301 @item -msdata=default
6303 On System V.4 and embedded PowerPC systems, if @samp{-meabi} is used,
6304 compile code the same as @samp{-msdata=eabi}, otherwise compile code the
6305 same as @samp{-msdata=sysv}.
6308 On System V.4 and embedded PowerPC systems, put small global and static
6309 data in the @samp{.sdata} section. Put small uninitialized global and
6310 static data in the @samp{.sbss} section. Do not use register @code{r13}
6311 to address small data however. This is the default behavior unless
6312 other @samp{-msdata} options are used.
6316 On embedded PowerPC systems, put all initialized global and static data
6317 in the @samp{.data} section, and all uninitialized data in the
6318 @samp{.bss} section.
6321 @cindex smaller data references (PowerPC)
6322 @cindex .sdata/.sdata2 references (PowerPC)
6323 On embedded PowerPC systems, put global and static items less than or
6324 equal to @var{num} bytes into the small data or bss sections instead of
6325 the normal data or bss section. By default, @var{num} is 8. The
6326 @samp{-G @var{num}} switch is also passed to the linker.
6327 All modules should be compiled with the same @samp{-G @var{num}} value.
6330 @itemx -mno-regnames
6331 On System V.4 and embedded PowerPC systems do (do not) emit register
6332 names in the assembly language output using symbolic forms.
6337 @subsection IBM RT Options
6339 @cindex IBM RT options
6341 These @samp{-m} options are defined for the IBM RT PC:
6345 Use an in-line code sequence for integer multiplies. This is the
6348 @item -mcall-lib-mul
6349 Call @code{lmul$$} for integer multiples.
6351 @item -mfull-fp-blocks
6352 Generate full-size floating point data blocks, including the minimum
6353 amount of scratch space recommended by IBM. This is the default.
6355 @item -mminimum-fp-blocks
6356 Do not include extra scratch space in floating point data blocks. This
6357 results in smaller code, but slower execution, since scratch space must
6358 be allocated dynamically.
6360 @cindex @file{varargs.h} and RT PC
6361 @cindex @file{stdarg.h} and RT PC
6362 @item -mfp-arg-in-fpregs
6363 Use a calling sequence incompatible with the IBM calling convention in
6364 which floating point arguments are passed in floating point registers.
6365 Note that @code{varargs.h} and @code{stdargs.h} will not work with
6366 floating point operands if this option is specified.
6368 @item -mfp-arg-in-gregs
6369 Use the normal calling convention for floating point arguments. This is
6372 @item -mhc-struct-return
6373 Return structures of more than one word in memory, rather than in a
6374 register. This provides compatibility with the MetaWare HighC (hc)
6375 compiler. Use the option @samp{-fpcc-struct-return} for compatibility
6376 with the Portable C Compiler (pcc).
6378 @item -mnohc-struct-return
6379 Return some structures of more than one word in registers, when
6380 convenient. This is the default. For compatibility with the
6381 IBM-supplied compilers, use the option @samp{-fpcc-struct-return} or the
6382 option @samp{-mhc-struct-return}.
6386 @subsection MIPS Options
6387 @cindex MIPS options
6389 These @samp{-m} options are defined for the MIPS family of computers:
6392 @item -mcpu=@var{cpu type}
6393 Assume the defaults for the machine type @var{cpu type} when scheduling
6394 instructions. The choices for @var{cpu type} are @samp{r2000}, @samp{r3000},
6395 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
6396 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
6397 and @samp{orion}. Additionally, the @samp{r2000}, @samp{r3000},
6398 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
6399 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc. While picking a specific
6400 @var{cpu type} will schedule things appropriately for that particular
6401 chip, the compiler will not generate any code that does not meet level 1
6402 of the MIPS ISA (instruction set architecture) without a @samp{-mipsX}
6403 or @samp{-mabi} switch being used.
6406 Issue instructions from level 1 of the MIPS ISA. This is the default.
6407 @samp{r3000} is the default @var{cpu type} at this ISA level.
6410 Issue instructions from level 2 of the MIPS ISA (branch likely, square
6411 root instructions). @samp{r6000} is the default @var{cpu type} at this
6415 Issue instructions from level 3 of the MIPS ISA (64-bit instructions).
6416 @samp{r4000} is the default @var{cpu type} at this ISA level.
6419 Issue instructions from level 4 of the MIPS ISA (conditional move,
6420 prefetch, enhanced FPU instructions). @samp{r8000} is the default
6421 @var{cpu type} at this ISA level.
6424 Assume that 32 32-bit floating point registers are available. This is
6428 Assume that 32 64-bit floating point registers are available. This is
6429 the default when the @samp{-mips3} option is used.
6432 Assume that 32 32-bit general purpose registers are available. This is
6436 Assume that 32 64-bit general purpose registers are available. This is
6437 the default when the @samp{-mips3} option is used.
6440 Force int and long types to be 64 bits wide. See @samp{-mlong32} for an
6441 explanation of the default, and the width of pointers.
6444 Force long types to be 64 bits wide. See @samp{-mlong32} for an
6445 explanation of the default, and the width of pointers.
6448 Force long, int, and pointer types to be 32 bits wide.
6450 If none of @samp{-mlong32}, @samp{-mlong64}, or @samp{-mint64} are set,
6451 the size of ints, longs, and pointers depends on the ABI and ISA chosen.
6452 For @samp{-mabi=32}, and @samp{-mabi=n32}, ints and longs are 32 bits
6453 wide. For @samp{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
6454 For @samp{-mabi=eabi} and either @samp{-mips1} or @samp{-mips2}, ints
6455 and longs are 32 bits wide. For @samp{-mabi=eabi} and higher ISAs, ints
6456 are 32 bits, and longs are 64 bits wide. The width of pointer types is
6457 the smaller of the width of longs or the width of general purpose
6458 registers (which in turn depends on the ISA).
6465 Generate code for the indicated ABI. The default instruction level is
6466 @samp{-mips1} for @samp{32}, @samp{-mips3} for @samp{n32}, and
6467 @samp{-mips4} otherwise. Conversely, with @samp{-mips1} or
6468 @samp{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
6472 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
6473 add normal debug information. This is the default for all
6474 platforms except for the OSF/1 reference platform, using the OSF/rose
6475 object format. If the either of the @samp{-gstabs} or @samp{-gstabs+}
6476 switches are used, the @file{mips-tfile} program will encapsulate the
6477 stabs within MIPS ECOFF.
6480 Generate code for the GNU assembler. This is the default on the OSF/1
6481 reference platform, using the OSF/rose object format. Also, this is
6482 the default if the configure option @samp{--with-gnu-as} is used.
6484 @item -msplit-addresses
6485 @itemx -mno-split-addresses
6486 Generate code to load the high and low parts of address constants separately.
6487 This allows @code{gcc} to optimize away redundant loads of the high order
6488 bits of addresses. This optimization requires GNU as and GNU ld.
6489 This optimization is enabled by default for some embedded targets where
6490 GNU as and GNU ld are standard.
6494 The @samp{-mrnames} switch says to output code using the MIPS software
6495 names for the registers, instead of the hardware names (ie, @var{a0}
6496 instead of @var{$4}). The only known assembler that supports this option
6497 is the Algorithmics assembler.
6501 The @samp{-mgpopt} switch says to write all of the data declarations
6502 before the instructions in the text section, this allows the MIPS
6503 assembler to generate one word memory references instead of using two
6504 words for short global or static data items. This is on by default if
6505 optimization is selected.
6509 For each non-inline function processed, the @samp{-mstats} switch
6510 causes the compiler to emit one line to the standard error file to
6511 print statistics about the program (number of registers saved, stack
6516 The @samp{-mmemcpy} switch makes all block moves call the appropriate
6517 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
6518 generating inline code.
6521 @itemx -mno-mips-tfile
6522 The @samp{-mno-mips-tfile} switch causes the compiler not
6523 postprocess the object file with the @file{mips-tfile} program,
6524 after the MIPS assembler has generated it to add debug support. If
6525 @file{mips-tfile} is not run, then no local variables will be
6526 available to the debugger. In addition, @file{stage2} and
6527 @file{stage3} objects will have the temporary file names passed to the
6528 assembler embedded in the object file, which means the objects will
6529 not compare the same. The @samp{-mno-mips-tfile} switch should only
6530 be used when there are bugs in the @file{mips-tfile} program that
6531 prevents compilation.
6534 Generate output containing library calls for floating point.
6535 @strong{Warning:} the requisite libraries are not part of GCC.
6536 Normally the facilities of the machine's usual C compiler are used, but
6537 this can't be done directly in cross-compilation. You must make your
6538 own arrangements to provide suitable library functions for
6542 Generate output containing floating point instructions. This is the
6543 default if you use the unmodified sources.
6546 @itemx -mno-abicalls
6547 Emit (or do not emit) the pseudo operations @samp{.abicalls},
6548 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
6549 position independent code.
6552 @itemx -mno-long-calls
6553 Do all calls with the @samp{JALR} instruction, which requires
6554 loading up a function's address into a register before the call.
6555 You need to use this switch, if you call outside of the current
6556 512 megabyte segment to functions that are not through pointers.
6559 @itemx -mno-half-pic
6560 Put pointers to extern references into the data section and load them
6561 up, rather than put the references in the text section.
6563 @item -membedded-pic
6564 @itemx -mno-embedded-pic
6565 Generate PIC code suitable for some embedded systems. All calls are
6566 made using PC relative address, and all data is addressed using the $gp
6567 register. No more than 65536 bytes of global data may be used. This
6568 requires GNU as and GNU ld which do most of the work. This currently
6569 only works on targets which use ECOFF; it does not work with ELF.
6571 @item -membedded-data
6572 @itemx -mno-embedded-data
6573 Allocate variables to the read-only data section first if possible, then
6574 next in the small data section if possible, otherwise in data. This gives
6575 slightly slower code than the default, but reduces the amount of RAM required
6576 when executing, and thus may be preferred for some embedded systems.
6578 @item -muninit-const-in-rodata
6579 @itemx -mno-uninit-const-in-rodata
6580 When used together with -membedded-data, it will always store uninitialized
6581 const variables in the read-only data section.
6583 @item -msingle-float
6584 @itemx -mdouble-float
6585 The @samp{-msingle-float} switch tells gcc to assume that the floating
6586 point coprocessor only supports single precision operations, as on the
6587 @samp{r4650} chip. The @samp{-mdouble-float} switch permits gcc to use
6588 double precision operations. This is the default.
6592 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
6593 as on the @samp{r4650} chip.
6596 Turns on @samp{-msingle-float}, @samp{-mmad}, and, at least for now,
6601 Enable 16-bit instructions.
6604 Use the entry and exit pseudo ops. This option can only be used with
6608 Compile code for the processor in little endian mode.
6609 The requisite libraries are assumed to exist.
6612 Compile code for the processor in big endian mode.
6613 The requisite libraries are assumed to exist.
6616 @cindex smaller data references (MIPS)
6617 @cindex gp-relative references (MIPS)
6618 Put global and static items less than or equal to @var{num} bytes into
6619 the small data or bss sections instead of the normal data or bss
6620 section. This allows the assembler to emit one word memory reference
6621 instructions based on the global pointer (@var{gp} or @var{$28}),
6622 instead of the normal two words used. By default, @var{num} is 8 when
6623 the MIPS assembler is used, and 0 when the GNU assembler is used. The
6624 @samp{-G @var{num}} switch is also passed to the assembler and linker.
6625 All modules should be compiled with the same @samp{-G @var{num}}
6629 Tell the MIPS assembler to not run its preprocessor over user
6630 assembler files (with a @samp{.s} suffix) when assembling them.
6633 Pass an option to gas which will cause nops to be inserted if
6634 the read of the destination register of an mfhi or mflo instruction
6635 occurs in the following two instructions.
6638 Do not include the default crt0.
6642 These options are defined by the macro
6643 @code{TARGET_SWITCHES} in the machine description. The default for the
6644 options is also defined by that macro, which enables you to change the
6649 @subsection Intel 386 Options
6650 @cindex i386 Options
6651 @cindex Intel 386 Options
6653 These @samp{-m} options are defined for the i386 family of computers:
6656 @item -mcpu=@var{cpu type}
6657 Assume the defaults for the machine type @var{cpu type} when scheduling
6658 instructions. The choices for @var{cpu type} are @samp{i386},
6659 @samp{i486}, @samp{i586}, @samp{i686}, @samp{pentium},
6660 @samp{pentiumpro}, @samp{k6}, and @samp{athlon}
6662 While picking a specific @var{cpu type} will schedule things appropriately
6663 for that particular chip, the compiler will not generate any code that
6664 does not run on the i386 without the @samp{-march=@var{cpu type}} option
6665 being used. @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
6666 is equivalent to @samp{pentiumpro}. @samp{k6} is the AMD chip as
6667 opposed to the Intel ones.
6669 @item -march=@var{cpu type}
6670 Generate instructions for the machine type @var{cpu type}. The choices
6671 for @var{cpu type} are the same as for @samp{-mcpu}. Moreover,
6672 specifying @samp{-march=@var{cpu type}} implies @samp{-mcpu=@var{cpu type}}.
6678 Synonyms for -mcpu=i386, -mcpu=i486, -mcpu=pentium, and -mcpu=pentiumpro
6679 respectively. These synonyms are deprecated.
6681 @item -mintel-syntax
6682 Emit assembly using Intel syntax opcodes instead of AT&T syntax.
6686 Control whether or not the compiler uses IEEE floating point
6687 comparisons. These handle correctly the case where the result of a
6688 comparison is unordered.
6691 Generate output containing library calls for floating point.
6692 @strong{Warning:} the requisite libraries are not part of GCC.
6693 Normally the facilities of the machine's usual C compiler are used, but
6694 this can't be done directly in cross-compilation. You must make your
6695 own arrangements to provide suitable library functions for
6698 On machines where a function returns floating point results in the 80387
6699 register stack, some floating point opcodes may be emitted even if
6700 @samp{-msoft-float} is used.
6702 @item -mno-fp-ret-in-387
6703 Do not use the FPU registers for return values of functions.
6705 The usual calling convention has functions return values of types
6706 @code{float} and @code{double} in an FPU register, even if there
6707 is no FPU. The idea is that the operating system should emulate
6710 The option @samp{-mno-fp-ret-in-387} causes such values to be returned
6711 in ordinary CPU registers instead.
6713 @item -mno-fancy-math-387
6714 Some 387 emulators do not support the @code{sin}, @code{cos} and
6715 @code{sqrt} instructions for the 387. Specify this option to avoid
6716 generating those instructions. This option is the default on FreeBSD.
6717 As of revision 2.6.1, these instructions are not generated unless you
6718 also use the @samp{-ffast-math} switch.
6720 @item -malign-double
6721 @itemx -mno-align-double
6722 Control whether GCC aligns @code{double}, @code{long double}, and
6723 @code{long long} variables on a two word boundary or a one word
6724 boundary. Aligning @code{double} variables on a two word boundary will
6725 produce code that runs somewhat faster on a @samp{Pentium} at the
6726 expense of more memory.
6728 @item -m128bit-long-double
6729 @itemx -m128bit-long-double
6730 Control the size of @code{long double} type. i386 application binary interface
6731 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
6732 preffer @code{long double} aligned to 8 or 16 byte boundary. This is
6733 impossible to reach with 12 byte long doubles in the array accesses.
6735 @strong{Warning:} if you use the @samp{-m128bit-long-double} switch, the
6736 structures and arrays containing @code{long double} will change their size as
6737 well as function calling convention for function taking @code{long double}
6740 @item -m96bit-long-double
6741 @itemx -m96bit-long-double
6742 Set the size of @code{long double} to 96 bits as required by the i386
6743 application binary interface. This is the default.
6746 @itemx -mno-svr3-shlib
6747 Control whether GCC places uninitialized locals into @code{bss} or
6748 @code{data}. @samp{-msvr3-shlib} places these locals into @code{bss}.
6749 These options are meaningful only on System V Release 3.
6751 @item -mno-wide-multiply
6752 @itemx -mwide-multiply
6753 Control whether GCC uses the @code{mul} and @code{imul} that produce
6754 64-bit results in @code{eax:edx} from 32-bit operands to do @code{long
6755 long} multiplies and 32-bit division by constants.
6758 Use a different function-calling convention, in which functions that
6759 take a fixed number of arguments return with the @code{ret} @var{num}
6760 instruction, which pops their arguments while returning. This saves one
6761 instruction in the caller since there is no need to pop the arguments
6764 You can specify that an individual function is called with this calling
6765 sequence with the function attribute @samp{stdcall}. You can also
6766 override the @samp{-mrtd} option by using the function attribute
6767 @samp{cdecl}. @xref{Function Attributes}.
6769 @strong{Warning:} this calling convention is incompatible with the one
6770 normally used on Unix, so you cannot use it if you need to call
6771 libraries compiled with the Unix compiler.
6773 Also, you must provide function prototypes for all functions that
6774 take variable numbers of arguments (including @code{printf});
6775 otherwise incorrect code will be generated for calls to those
6778 In addition, seriously incorrect code will result if you call a
6779 function with too many arguments. (Normally, extra arguments are
6780 harmlessly ignored.)
6782 @item -mreg-alloc=@var{regs}
6783 Control the default allocation order of integer registers. The
6784 string @var{regs} is a series of letters specifying a register. The
6785 supported letters are: @code{a} allocate EAX; @code{b} allocate EBX;
6786 @code{c} allocate ECX; @code{d} allocate EDX; @code{S} allocate ESI;
6787 @code{D} allocate EDI; @code{B} allocate EBP.
6788 This option is deprecated and will not be supported by future releases
6791 @item -mregparm=@var{num}
6792 Control how many registers are used to pass integer arguments. By
6793 default, no registers are used to pass arguments, and at most 3
6794 registers can be used. You can control this behavior for a specific
6795 function by using the function attribute @samp{regparm}.
6796 @xref{Function Attributes}.
6798 @strong{Warning:} if you use this switch, and
6799 @var{num} is nonzero, then you must build all modules with the same
6800 value, including any libraries. This includes the system libraries and
6803 @item -malign-loops=@var{num}
6804 Align loops to a 2 raised to a @var{num} byte boundary. If
6805 @samp{-malign-loops} is not specified, the default is 2 unless
6806 gas 2.8 (or later) is being used in which case the default is
6807 to align the loop on a 16 byte boundary if it is less than 8
6810 @item -malign-jumps=@var{num}
6811 Align instructions that are only jumped to to a 2 raised to a @var{num}
6812 byte boundary. If @samp{-malign-jumps} is not specified, the default is
6813 2 if optimizing for a 386, and 4 if optimizing for a 486 unless
6814 gas 2.8 (or later) is being used in which case the default is
6815 to align the instruction on a 16 byte boundary if it is less
6818 @item -malign-functions=@var{num}
6819 Align the start of functions to a 2 raised to @var{num} byte boundary.
6820 If @samp{-malign-functions} is not specified, the default is 2 if optimizing
6821 for a 386, and 4 if optimizing for a 486.
6823 @item -mpreferred-stack-boundary=@var{num}
6824 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
6825 byte boundary. If @samp{-mpreferred-stack-boundary} is not specified,
6826 the default is 4 (16 bytes or 128 bits).
6828 The stack is required to be aligned on a 4 byte boundary. On Pentium
6829 and PentiumPro, @code{double} and @code{long double} values should be
6830 aligned to an 8 byte boundary (see @samp{-malign-double}) or suffer
6831 significant run time performance penalties. On Pentium III, the
6832 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
6833 penalties if it is not 16 byte aligned.
6835 To ensure proper alignment of this values on the stack, the stack boundary
6836 must be as aligned as that required by any value stored on the stack.
6837 Further, every function must be generated such that it keeps the stack
6838 aligned. Thus calling a function compiled with a higher preferred
6839 stack boundary from a function compiled with a lower preferred stack
6840 boundary will most likely misalign the stack. It is recommended that
6841 libraries that use callbacks always use the default setting.
6843 This extra alignment does consume extra stack space. Code that is sensitive
6844 to stack space usage, such as embedded systems and operating system kernels,
6845 may want to reduce the preferred alignment to
6846 @samp{-mpreferred-stack-boundary=2}.
6850 Use PUSH operations to store outgoing parameters. This method is shorter
6851 and usually equally fast as method using SUB/MOV operations and is enabled
6852 by default. In some cases disabling it may improve performance because of
6853 improved scheduling and reduced dependencies.
6855 @item -maccumulate-outgoing-args
6856 @kindex -maccumulate-outgoing-args
6857 If enabled, the maximum amount of space required for outgoing arguments will be
6858 computed in the function prologue. This in faster on most modern CPUs
6859 because of reduced dependencies, improved scheduling and reduced stack usage
6860 when preferred stack boundary is not equal to 2. The drawback is a notable
6861 increase in code size. This switch implies -mno-push-args.
6865 Support thread-safe exception handling on @samp{Mingw32}. Code that relies
6866 on thread-safe exception handling must compile and link all code with the
6867 @samp{-mthreads} option. When compiling, @samp{-mthreads} defines
6868 @samp{-D_MT}; when linking, it links in a special thread helper library
6869 @samp{-lmingwthrd} which cleans up per thread exception handling data.
6871 @item -mno-align-stringops
6872 @kindex -mno-align-stringops
6873 Do not align destination of inlined string operations. This switch reduces
6874 code size and improves performance in case the destination is already aligned,
6875 but gcc don't know about it.
6877 @item -minline-all-stringops
6878 @kindex -minline-all-stringops
6879 By default GCC inlines string operations only when destination is known to be
6880 aligned at least to 4 byte boundary. This enables more inlining, increase code
6881 size, but may improve performance of code that depends on fast memcpy, strlen
6882 and memset for short lengths.
6886 @subsection HPPA Options
6887 @cindex HPPA Options
6889 These @samp{-m} options are defined for the HPPA family of computers:
6892 @item -march=@var{architecture type}
6893 Generate code for the specified architecture. The choices for
6894 @var{architecture type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
6895 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
6896 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
6897 architecture option for your machine. Code compiled for lower numbered
6898 architectures will run on higher numbered architectures, but not the
6901 PA 2.0 support currently requires gas snapshot 19990413 or later. The
6902 next release of binutils (current is 2.9.1) will probably contain PA 2.0
6906 @itemx -mpa-risc-1-1
6907 @itemx -mpa-risc-2-0
6908 Synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively.
6911 Generate code suitable for big switch tables. Use this option only if
6912 the assembler/linker complain about out of range branches within a switch
6915 @item -mjump-in-delay
6916 Fill delay slots of function calls with unconditional jump instructions
6917 by modifying the return pointer for the function call to be the target
6918 of the conditional jump.
6920 @item -mdisable-fpregs
6921 Prevent floating point registers from being used in any manner. This is
6922 necessary for compiling kernels which perform lazy context switching of
6923 floating point registers. If you use this option and attempt to perform
6924 floating point operations, the compiler will abort.
6926 @item -mdisable-indexing
6927 Prevent the compiler from using indexing address modes. This avoids some
6928 rather obscure problems when compiling MIG generated code under MACH.
6930 @item -mno-space-regs
6931 Generate code that assumes the target has no space registers. This allows
6932 GCC to generate faster indirect calls and use unscaled index address modes.
6934 Such code is suitable for level 0 PA systems and kernels.
6936 @item -mfast-indirect-calls
6937 Generate code that assumes calls never cross space boundaries. This
6938 allows GCC to emit code which performs faster indirect calls.
6940 This option will not work in the presence of shared libraries or nested
6943 @item -mlong-load-store
6944 Generate 3-instruction load and store sequences as sometimes required by
6945 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
6948 @item -mportable-runtime
6949 Use the portable calling conventions proposed by HP for ELF systems.
6952 Enable the use of assembler directives only GAS understands.
6954 @item -mschedule=@var{cpu type}
6955 Schedule code according to the constraints for the machine type
6956 @var{cpu type}. The choices for @var{cpu type} are @samp{700}
6957 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}. Refer to
6958 @file{/usr/lib/sched.models} on an HP-UX system to determine the
6959 proper scheduling option for your machine.
6962 Enable the optimization pass in the HPUX linker. Note this makes symbolic
6963 debugging impossible. It also triggers a bug in the HPUX 8 and HPUX 9 linkers
6964 in which they give bogus error messages when linking some programs.
6967 Generate output containing library calls for floating point.
6968 @strong{Warning:} the requisite libraries are not available for all HPPA
6969 targets. Normally the facilities of the machine's usual C compiler are
6970 used, but this cannot be done directly in cross-compilation. You must make
6971 your own arrangements to provide suitable library functions for
6972 cross-compilation. The embedded target @samp{hppa1.1-*-pro}
6973 does provide software floating point support.
6975 @samp{-msoft-float} changes the calling convention in the output file;
6976 therefore, it is only useful if you compile @emph{all} of a program with
6977 this option. In particular, you need to compile @file{libgcc.a}, the
6978 library that comes with GCC, with @samp{-msoft-float} in order for
6982 @node Intel 960 Options
6983 @subsection Intel 960 Options
6985 These @samp{-m} options are defined for the Intel 960 implementations:
6988 @item -m@var{cpu type}
6989 Assume the defaults for the machine type @var{cpu type} for some of
6990 the other options, including instruction scheduling, floating point
6991 support, and addressing modes. The choices for @var{cpu type} are
6992 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
6993 @samp{sa}, and @samp{sb}.
6999 The @samp{-mnumerics} option indicates that the processor does support
7000 floating-point instructions. The @samp{-msoft-float} option indicates
7001 that floating-point support should not be assumed.
7003 @item -mleaf-procedures
7004 @itemx -mno-leaf-procedures
7005 Do (or do not) attempt to alter leaf procedures to be callable with the
7006 @code{bal} instruction as well as @code{call}. This will result in more
7007 efficient code for explicit calls when the @code{bal} instruction can be
7008 substituted by the assembler or linker, but less efficient code in other
7009 cases, such as calls via function pointers, or using a linker that doesn't
7010 support this optimization.
7013 @itemx -mno-tail-call
7014 Do (or do not) make additional attempts (beyond those of the
7015 machine-independent portions of the compiler) to optimize tail-recursive
7016 calls into branches. You may not want to do this because the detection of
7017 cases where this is not valid is not totally complete. The default is
7018 @samp{-mno-tail-call}.
7020 @item -mcomplex-addr
7021 @itemx -mno-complex-addr
7022 Assume (or do not assume) that the use of a complex addressing mode is a
7023 win on this implementation of the i960. Complex addressing modes may not
7024 be worthwhile on the K-series, but they definitely are on the C-series.
7025 The default is currently @samp{-mcomplex-addr} for all processors except
7029 @itemx -mno-code-align
7030 Align code to 8-byte boundaries for faster fetching (or don't bother).
7031 Currently turned on by default for C-series implementations only.
7034 @item -mclean-linkage
7035 @itemx -mno-clean-linkage
7036 These options are not fully implemented.
7040 @itemx -mic2.0-compat
7041 @itemx -mic3.0-compat
7042 Enable compatibility with iC960 v2.0 or v3.0.
7046 Enable compatibility with the iC960 assembler.
7048 @item -mstrict-align
7049 @itemx -mno-strict-align
7050 Do not permit (do permit) unaligned accesses.
7053 Enable structure-alignment compatibility with Intel's gcc release version
7054 1.3 (based on gcc 1.37). This option implies @samp{-mstrict-align}.
7056 @item -mlong-double-64
7057 Implement type @samp{long double} as 64-bit floating point numbers.
7058 Without the option @samp{long double} is implemented by 80-bit
7059 floating point numbers. The only reason we have it because there is
7060 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet. So it
7061 is only useful for people using soft-float targets. Otherwise, we
7062 should recommend against use of it.
7066 @node DEC Alpha Options
7067 @subsection DEC Alpha Options
7069 These @samp{-m} options are defined for the DEC Alpha implementations:
7072 @item -mno-soft-float
7074 Use (do not use) the hardware floating-point instructions for
7075 floating-point operations. When @option{-msoft-float} is specified,
7076 functions in @file{libgcc1.c} will be used to perform floating-point
7077 operations. Unless they are replaced by routines that emulate the
7078 floating-point operations, or compiled in such a way as to call such
7079 emulations routines, these routines will issue floating-point
7080 operations. If you are compiling for an Alpha without floating-point
7081 operations, you must ensure that the library is built so as not to call
7084 Note that Alpha implementations without floating-point operations are
7085 required to have floating-point registers.
7089 Generate code that uses (does not use) the floating-point register set.
7090 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
7091 register set is not used, floating point operands are passed in integer
7092 registers as if they were integers and floating-point results are passed
7093 in $0 instead of $f0. This is a non-standard calling sequence, so any
7094 function with a floating-point argument or return value called by code
7095 compiled with @option{-mno-fp-regs} must also be compiled with that
7098 A typical use of this option is building a kernel that does not use,
7099 and hence need not save and restore, any floating-point registers.
7102 The Alpha architecture implements floating-point hardware optimized for
7103 maximum performance. It is mostly compliant with the IEEE floating
7104 point standard. However, for full compliance, software assistance is
7105 required. This option generates code fully IEEE compliant code
7106 @emph{except} that the @var{inexact flag} is not maintained (see below).
7107 If this option is turned on, the CPP macro @code{_IEEE_FP} is defined
7108 during compilation. The option is a shorthand for: @samp{-D_IEEE_FP
7109 -mfp-trap-mode=su -mtrap-precision=i -mieee-conformant}. The resulting
7110 code is less efficient but is able to correctly support denormalized
7111 numbers and exceptional IEEE values such as not-a-number and plus/minus
7112 infinity. Other Alpha compilers call this option
7113 @option{-ieee_with_no_inexact}.
7115 @item -mieee-with-inexact
7116 @c overfull hbox here --bob 22 jul96
7117 @c original text between ignore ... end ignore
7119 This is like @samp{-mieee} except the generated code also maintains the
7120 IEEE @var{inexact flag}. Turning on this option causes the generated
7121 code to implement fully-compliant IEEE math. The option is a shorthand
7122 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus @samp{-mieee-conformant},
7123 @samp{-mfp-trap-mode=sui}, and @samp{-mtrap-precision=i}. On some Alpha
7124 implementations the resulting code may execute significantly slower than
7125 the code generated by default. Since there is very little code that
7126 depends on the @var{inexact flag}, you should normally not specify this
7127 option. Other Alpha compilers call this option
7128 @samp{-ieee_with_inexact}.
7130 @c changed paragraph
7131 This is like @samp{-mieee} except the generated code also maintains the
7132 IEEE @var{inexact flag}. Turning on this option causes the generated
7133 code to implement fully-compliant IEEE math. The option is a shorthand
7134 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus the three following:
7135 @samp{-mieee-conformant},
7136 @samp{-mfp-trap-mode=sui},
7137 and @samp{-mtrap-precision=i}.
7138 On some Alpha implementations the resulting code may execute
7139 significantly slower than the code generated by default. Since there
7140 is very little code that depends on the @var{inexact flag}, you should
7141 normally not specify this option. Other Alpha compilers call this
7142 option @samp{-ieee_with_inexact}.
7143 @c end changes to prevent overfull hboxes
7145 @item -mfp-trap-mode=@var{trap mode}
7146 This option controls what floating-point related traps are enabled.
7147 Other Alpha compilers call this option @samp{-fptm }@var{trap mode}.
7148 The trap mode can be set to one of four values:
7152 This is the default (normal) setting. The only traps that are enabled
7153 are the ones that cannot be disabled in software (e.g., division by zero
7157 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7161 Like @samp{su}, but the instructions are marked to be safe for software
7162 completion (see Alpha architecture manual for details).
7165 Like @samp{su}, but inexact traps are enabled as well.
7168 @item -mfp-rounding-mode=@var{rounding mode}
7169 Selects the IEEE rounding mode. Other Alpha compilers call this option
7170 @samp{-fprm }@var{rounding mode}. The @var{rounding mode} can be one
7175 Normal IEEE rounding mode. Floating point numbers are rounded towards
7176 the nearest machine number or towards the even machine number in case
7180 Round towards minus infinity.
7183 Chopped rounding mode. Floating point numbers are rounded towards zero.
7186 Dynamic rounding mode. A field in the floating point control register
7187 (@var{fpcr}, see Alpha architecture reference manual) controls the
7188 rounding mode in effect. The C library initializes this register for
7189 rounding towards plus infinity. Thus, unless your program modifies the
7190 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7193 @item -mtrap-precision=@var{trap precision}
7194 In the Alpha architecture, floating point traps are imprecise. This
7195 means without software assistance it is impossible to recover from a
7196 floating trap and program execution normally needs to be terminated.
7197 GCC can generate code that can assist operating system trap handlers
7198 in determining the exact location that caused a floating point trap.
7199 Depending on the requirements of an application, different levels of
7200 precisions can be selected:
7204 Program precision. This option is the default and means a trap handler
7205 can only identify which program caused a floating point exception.
7208 Function precision. The trap handler can determine the function that
7209 caused a floating point exception.
7212 Instruction precision. The trap handler can determine the exact
7213 instruction that caused a floating point exception.
7216 Other Alpha compilers provide the equivalent options called
7217 @samp{-scope_safe} and @samp{-resumption_safe}.
7219 @item -mieee-conformant
7220 This option marks the generated code as IEEE conformant. You must not
7221 use this option unless you also specify @samp{-mtrap-precision=i} and either
7222 @samp{-mfp-trap-mode=su} or @samp{-mfp-trap-mode=sui}. Its only effect
7223 is to emit the line @samp{.eflag 48} in the function prologue of the
7224 generated assembly file. Under DEC Unix, this has the effect that
7225 IEEE-conformant math library routines will be linked in.
7227 @item -mbuild-constants
7228 Normally GCC examines a 32- or 64-bit integer constant to
7229 see if it can construct it from smaller constants in two or three
7230 instructions. If it cannot, it will output the constant as a literal and
7231 generate code to load it from the data segment at runtime.
7233 Use this option to require GCC to construct @emph{all} integer constants
7234 using code, even if it takes more instructions (the maximum is six).
7236 You would typically use this option to build a shared library dynamic
7237 loader. Itself a shared library, it must relocate itself in memory
7238 before it can find the variables and constants in its own data segment.
7242 Select whether to generate code to be assembled by the vendor-supplied
7243 assembler (@samp{-malpha-as}) or by the GNU assembler @samp{-mgas}.
7251 Indicate whether GCC should generate code to use the optional BWX,
7252 CIX, and MAX instruction sets. The default is to use the instruction sets
7253 supported by the CPU type specified via @samp{-mcpu=} option or that
7254 of the CPU on which GCC was built if none was specified.
7256 @item -mcpu=@var{cpu_type}
7257 Set the instruction set, register set, and instruction scheduling
7258 parameters for machine type @var{cpu_type}. You can specify either the
7259 @samp{EV} style name or the corresponding chip number. GCC
7260 supports scheduling parameters for the EV4 and EV5 family of processors
7261 and will choose the default values for the instruction set from
7262 the processor you specify. If you do not specify a processor type,
7263 GCC will default to the processor on which the compiler was built.
7265 Supported values for @var{cpu_type} are
7270 Schedules as an EV4 and has no instruction set extensions.
7274 Schedules as an EV5 and has no instruction set extensions.
7278 Schedules as an EV5 and supports the BWX extension.
7283 Schedules as an EV5 and supports the BWX and MAX extensions.
7287 Schedules as an EV5 (until Digital releases the scheduling parameters
7288 for the EV6) and supports the BWX, CIX, and MAX extensions.
7291 @item -mmemory-latency=@var{time}
7292 Sets the latency the scheduler should assume for typical memory
7293 references as seen by the application. This number is highly
7294 dependent on the memory access patterns used by the application
7295 and the size of the external cache on the machine.
7297 Valid options for @var{time} are
7301 A decimal number representing clock cycles.
7307 The compiler contains estimates of the number of clock cycles for
7308 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7309 (also called Dcache, Scache, and Bcache), as well as to main memory.
7310 Note that L3 is only valid for EV5.
7315 @node Clipper Options
7316 @subsection Clipper Options
7318 These @samp{-m} options are defined for the Clipper implementations:
7322 Produce code for a C300 Clipper processor. This is the default.
7325 Produce code for a C400 Clipper processor i.e. use floating point
7329 @node H8/300 Options
7330 @subsection H8/300 Options
7332 These @samp{-m} options are defined for the H8/300 implementations:
7336 Shorten some address references at link time, when possible; uses the
7337 linker option @samp{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
7338 ld.info, Using ld}, for a fuller description.
7341 Generate code for the H8/300H.
7344 Generate code for the H8/S.
7347 Generate code for the H8/S2600. This switch must be used with -ms.
7350 Make @code{int} data 32 bits by default.
7353 On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
7354 The default for the H8/300H and H8/S is to align longs and floats on 4
7356 @samp{-malign-300} causes them to be aligned on 2 byte boundaries.
7357 This option has no effect on the H8/300.
7361 @subsection SH Options
7363 These @samp{-m} options are defined for the SH implementations:
7367 Generate code for the SH1.
7370 Generate code for the SH2.
7373 Generate code for the SH3.
7376 Generate code for the SH3e.
7379 Generate code for the SH4 without a floating-point unit.
7381 @item -m4-single-only
7382 Generate code for the SH4 with a floating-point unit that only
7383 supports single-precision arithmentic.
7386 Generate code for the SH4 assuming the floating-point unit is in
7387 single-precision mode by default.
7390 Generate code for the SH4.
7393 Compile code for the processor in big endian mode.
7396 Compile code for the processor in little endian mode.
7399 Align doubles at 64-bit boundaries. Note that this changes the calling
7400 conventions, and thus some functions from the standard C library will
7401 not work unless you recompile it first with -mdalign.
7404 Shorten some address references at link time, when possible; uses the
7405 linker option @samp{-relax}.
7408 Use 32-bit offsets in @code{switch} tables. The default is to use
7412 Enable the use of the instruction @code{fmovd}.
7415 Comply with the calling conventions defined by Hitachi.
7418 Mark the @code{MAC} register as call-clobbered, even if
7419 @option{-mhitachi} is given.
7422 Dump instruction size and location in the assembly code.
7425 This option is deprecated. It pads structures to multiple of 4 bytes,
7426 which is incompatible with the SH ABI.
7429 Optimize for space instead of speed. Implied by @option{-Os}.
7432 When generating position-independent code, emit function calls using
7433 the Global Offset Table instead of the Procedure Linkage Table.
7436 Generate a library function call to invalidate instruction cache
7437 entries, after fixing up a trampoline. This library function call
7438 doesn't assume it can write to the whole memory address space. This
7439 is the default when the target is @code{sh-*-linux*}.
7442 @node System V Options
7443 @subsection Options for System V
7445 These additional options are available on System V Release 4 for
7446 compatibility with other compilers on those systems:
7450 Create a shared object.
7451 It is recommended that @samp{-symbolic} or @samp{-shared} be used instead.
7454 Identify the versions of each tool used by the compiler, in a
7455 @code{.ident} assembler directive in the output.
7458 Refrain from adding @code{.ident} directives to the output file (this is
7461 @item -YP\,@var{dirs}
7462 Search the directories @var{dirs}, and no others, for libraries
7463 specified with @samp{-l}.
7465 @item -Ym\,@var{dir}
7466 Look in the directory @var{dir} to find the M4 preprocessor.
7467 The assembler uses this option.
7468 @c This is supposed to go with a -Yd for predefined M4 macro files, but
7469 @c the generic assembler that comes with Solaris takes just -Ym.
7472 @node TMS320C3x/C4x Options
7473 @subsection TMS320C3x/C4x Options
7474 @cindex TMS320C3x/C4x Options
7476 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
7480 @item -mcpu=@var{cpu_type}
7481 Set the instruction set, register set, and instruction scheduling
7482 parameters for machine type @var{cpu_type}. Supported values for
7483 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
7484 @samp{c44}. The default is @samp{c40} to generate code for the
7489 @itemx -msmall-memory
7491 Generates code for the big or small memory model. The small memory
7492 model assumed that all data fits into one 64K word page. At run-time
7493 the data page (DP) register must be set to point to the 64K page
7494 containing the .bss and .data program sections. The big memory model is
7495 the default and requires reloading of the DP register for every direct
7500 Allow (disallow) allocation of general integer operands into the block
7505 Enable (disable) generation of code using decrement and branch,
7506 DBcond(D), instructions. This is enabled by default for the C4x. To be
7507 on the safe side, this is disabled for the C3x, since the maximum
7508 iteration count on the C3x is 2^23 + 1 (but who iterates loops more than
7509 2^23 times on the C3x?). Note that GCC will try to reverse a loop so
7510 that it can utilise the decrement and branch instruction, but will give
7511 up if there is more than one memory reference in the loop. Thus a loop
7512 where the loop counter is decremented can generate slightly more
7513 efficient code, in cases where the RPTB instruction cannot be utilised.
7515 @item -mdp-isr-reload
7517 Force the DP register to be saved on entry to an interrupt service
7518 routine (ISR), reloaded to point to the data section, and restored on
7519 exit from the ISR. This should not be required unless someone has
7520 violated the small memory model by modifying the DP register, say within
7525 For the C3x use the 24-bit MPYI instruction for integer multiplies
7526 instead of a library call to guarantee 32-bit results. Note that if one
7527 of the operands is a constant, then the multiplication will be performed
7528 using shifts and adds. If the -mmpyi option is not specified for the C3x,
7529 then squaring operations are performed inline instead of a library call.
7532 @itemx -mno-fast-fix
7533 The C3x/C4x FIX instruction to convert a floating point value to an
7534 integer value chooses the nearest integer less than or equal to the
7535 floating point value rather than to the nearest integer. Thus if the
7536 floating point number is negative, the result will be incorrectly
7537 truncated an additional code is necessary to detect and correct this
7538 case. This option can be used to disable generation of the additional
7539 code required to correct the result.
7543 Enable (disable) generation of repeat block sequences using the RPTB
7544 instruction for zero overhead looping. The RPTB construct is only used
7545 for innermost loops that do not call functions or jump across the loop
7546 boundaries. There is no advantage having nested RPTB loops due to the
7547 overhead required to save and restore the RC, RS, and RE registers.
7548 This is enabled by default with -O2.
7550 @item -mrpts=@var{count}
7552 Enable (disable) the use of the single instruction repeat instruction
7553 RPTS. If a repeat block contains a single instruction, and the loop
7554 count can be guaranteed to be less than the value @var{count}, GCC will
7555 emit a RPTS instruction instead of a RPTB. If no value is specified,
7556 then a RPTS will be emitted even if the loop count cannot be determined
7557 at compile time. Note that the repeated instruction following RPTS does
7558 not have to be reloaded from memory each iteration, thus freeing up the
7559 CPU buses for operands. However, since interrupts are blocked by this
7560 instruction, it is disabled by default.
7562 @item -mloop-unsigned
7563 @itemx -mno-loop-unsigned
7564 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
7565 is 2^31 + 1 since these instructions test if the iteration count is
7566 negative to terminate the loop. If the iteration count is unsigned
7567 there is a possibility than the 2^31 + 1 maximum iteration count may be
7568 exceeded. This switch allows an unsigned iteration count.
7571 Try to emit an assembler syntax that the TI assembler (asm30) is happy
7572 with. This also enforces compatibility with the API employed by the TI
7573 C3x C compiler. For example, long doubles are passed as structures
7574 rather than in floating point registers.
7578 Generate code that uses registers (stack) for passing arguments to functions.
7579 By default, arguments are passed in registers where possible rather
7580 than by pushing arguments on to the stack.
7582 @item -mparallel-insns
7583 @itemx -mno-parallel-insns
7584 Allow the generation of parallel instructions. This is enabled by
7587 @item -mparallel-mpy
7588 @itemx -mno-parallel-mpy
7589 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
7590 provided -mparallel-insns is also specified. These instructions have
7591 tight register constraints which can pessimize the code generation
7597 @subsection V850 Options
7598 @cindex V850 Options
7600 These @samp{-m} options are defined for V850 implementations:
7604 @itemx -mno-long-calls
7605 Treat all calls as being far away (near). If calls are assumed to be
7606 far away, the compiler will always load the functions address up into a
7607 register, and call indirect through the pointer.
7611 Do not optimize (do optimize) basic blocks that use the same index
7612 pointer 4 or more times to copy pointer into the @code{ep} register, and
7613 use the shorter @code{sld} and @code{sst} instructions. The @samp{-mep}
7614 option is on by default if you optimize.
7616 @item -mno-prolog-function
7617 @itemx -mprolog-function
7618 Do not use (do use) external functions to save and restore registers at
7619 the prolog and epilog of a function. The external functions are slower,
7620 but use less code space if more than one function saves the same number
7621 of registers. The @samp{-mprolog-function} option is on by default if
7625 Try to make the code as small as possible. At present, this just turns
7626 on the @samp{-mep} and @samp{-mprolog-function} options.
7629 Put static or global variables whose size is @var{n} bytes or less into
7630 the tiny data area that register @code{ep} points to. The tiny data
7631 area can hold up to 256 bytes in total (128 bytes for byte references).
7634 Put static or global variables whose size is @var{n} bytes or less into
7635 the small data area that register @code{gp} points to. The small data
7636 area can hold up to 64 kilobytes.
7639 Put static or global variables whose size is @var{n} bytes or less into
7640 the first 32 kilobytes of memory.
7643 Specify that the target processor is the V850.
7646 Generate code suitable for big switch tables. Use this option only if
7647 the assembler/linker complain about out of range branches within a switch
7652 @subsection ARC Options
7655 These options are defined for ARC implementations:
7659 Compile code for little endian mode. This is the default.
7662 Compile code for big endian mode.
7665 Prepend the name of the cpu to all public symbol names.
7666 In multiple-processor systems, there are many ARC variants with different
7667 instruction and register set characteristics. This flag prevents code
7668 compiled for one cpu to be linked with code compiled for another.
7669 No facility exists for handling variants that are "almost identical".
7670 This is an all or nothing option.
7672 @item -mcpu=@var{cpu}
7673 Compile code for ARC variant @var{cpu}.
7674 Which variants are supported depend on the configuration.
7675 All variants support @samp{-mcpu=base}, this is the default.
7677 @item -mtext=@var{text section}
7678 @itemx -mdata=@var{data section}
7679 @itemx -mrodata=@var{readonly data section}
7680 Put functions, data, and readonly data in @var{text section},
7681 @var{data section}, and @var{readonly data section} respectively
7682 by default. This can be overridden with the @code{section} attribute.
7683 @xref{Variable Attributes}.
7688 @subsection NS32K Options
7689 @cindex NS32K options
7691 These are the @samp{-m} options defined for the 32000 series. The default
7692 values for these options depends on which style of 32000 was selected when
7693 the compiler was configured; the defaults for the most common choices are
7699 Generate output for a 32032. This is the default
7700 when the compiler is configured for 32032 and 32016 based systems.
7704 Generate output for a 32332. This is the default
7705 when the compiler is configured for 32332-based systems.
7709 Generate output for a 32532. This is the default
7710 when the compiler is configured for 32532-based systems.
7713 Generate output containing 32081 instructions for floating point.
7714 This is the default for all systems.
7717 Generate output containing 32381 instructions for floating point. This
7718 also implies @samp{-m32081}. The 32381 is only compatible with the 32332
7719 and 32532 cpus. This is the default for the pc532-netbsd configuration.
7722 Try and generate multiply-add floating point instructions @code{polyF}
7723 and @code{dotF}. This option is only available if the @samp{-m32381}
7724 option is in effect. Using these instructions requires changes to to
7725 register allocation which generally has a negative impact on
7726 performance. This option should only be enabled when compiling code
7727 particularly likely to make heavy use of multiply-add instructions.
7730 Do not try and generate multiply-add floating point instructions
7731 @code{polyF} and @code{dotF}. This is the default on all platforms.
7734 Generate output containing library calls for floating point.
7735 @strong{Warning:} the requisite libraries may not be available.
7738 Do not use the bit-field instructions. On some machines it is faster to
7739 use shifting and masking operations. This is the default for the pc532.
7742 Do use the bit-field instructions. This is the default for all platforms
7746 Use a different function-calling convention, in which functions
7747 that take a fixed number of arguments return pop their
7748 arguments on return with the @code{ret} instruction.
7750 This calling convention is incompatible with the one normally
7751 used on Unix, so you cannot use it if you need to call libraries
7752 compiled with the Unix compiler.
7754 Also, you must provide function prototypes for all functions that
7755 take variable numbers of arguments (including @code{printf});
7756 otherwise incorrect code will be generated for calls to those
7759 In addition, seriously incorrect code will result if you call a
7760 function with too many arguments. (Normally, extra arguments are
7761 harmlessly ignored.)
7763 This option takes its name from the 680x0 @code{rtd} instruction.
7767 Use a different function-calling convention where the first two arguments
7768 are passed in registers.
7770 This calling convention is incompatible with the one normally
7771 used on Unix, so you cannot use it if you need to call libraries
7772 compiled with the Unix compiler.
7775 Do not pass any arguments in registers. This is the default for all
7779 It is OK to use the sb as an index register which is always loaded with
7780 zero. This is the default for the pc532-netbsd target.
7783 The sb register is not available for use or has not been initialized to
7784 zero by the run time system. This is the default for all targets except
7785 the pc532-netbsd. It is also implied whenever @samp{-mhimem} or
7786 @samp{-fpic} is set.
7789 Many ns32000 series addressing modes use displacements of up to 512MB.
7790 If an address is above 512MB then displacements from zero can not be used.
7791 This option causes code to be generated which can be loaded above 512MB.
7792 This may be useful for operating systems or ROM code.
7795 Assume code will be loaded in the first 512MB of virtual address space.
7796 This is the default for all platforms.
7802 @subsection AVR Options
7805 These options are defined for AVR implementations:
7808 @item -mmcu=@var{mcu}
7809 Specify ATMEL AVR instruction set or MCU type.
7811 Instruction set avr1 is for the minimal AVR core, not supported by the C
7812 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7813 attiny11, attiny12, attiny15, attiny28).
7815 Instruction set avr2 (default) is for the classic AVR core with up to
7816 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7817 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7818 at90c8534, at90s8535).
7820 Instruction set avr3 is for the classic AVR core with up to 128K program
7821 memory space (MCU types: atmega103, atmega603).
7823 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7824 memory space (MCU types: atmega83, atmega85).
7826 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7827 memory space (MCU types: atmega161, atmega163, atmega32, at94k).
7830 Output instruction sizes to the asm file.
7832 @item -minit-stack=@var{N}
7833 Specify the initial stack address, which may be a symbol or numeric value,
7834 __stack is the default.
7836 @item -mno-interrupts
7837 Generated code is not compatible with hardware interrupts.
7838 Code size will be smaller.
7840 @item -mcall-prologues
7841 Functions prologues/epilogues expanded as call to appropriate
7842 subroutines. Code size will be smaller.
7844 @item -mno-tablejump
7845 Do not generate tablejump insns which sometimes increase code size.
7848 Change only the low 8 bits of the stack pointer.
7852 @subsection MCore Options
7853 @cindex MCore options
7855 These are the @samp{-m} options defined for the Motorola M*Core
7863 Inline constants into the code stream if it can be done in two
7864 instructions or less.
7869 Use the divide instruction. (Enabled by default).
7871 @item -mrelax-immediate
7872 @itemx -mrelax-immediate
7873 @itemx -mno-relax-immediate
7874 Allow arbitrary sized immediates in bit operations.
7876 @item -mwide-bitfields
7877 @itemx -mwide-bitfields
7878 @itemx -mno-wide-bitfields
7879 Always treat bitfields as int-sized.
7881 @item -m4byte-functions
7882 @itemx -m4byte-functions
7883 @itemx -mno-4byte-functions
7884 Force all functions to be aligned to a four byte boundary.
7886 @item -mcallgraph-data
7887 @itemx -mcallgraph-data
7888 @itemx -mno-callgraph-data
7889 Emit callgraph information.
7893 @itemx -mno-slow-bytes
7894 Prefer word access when reading byte quantities.
7896 @item -mlittle-endian
7897 @itemx -mlittle-endian
7899 Generate code for a little endian target.
7904 Generate code for the 210 processor.
7908 @subsection IA-64 Options
7909 @cindex IA-64 Options
7911 These are the @samp{-m} options defined for the Intel IA-64 architecture.
7915 Generate code for a big endian target. This is the default for HPUX.
7917 @item -mlittle-endian
7918 Generate code for a little endian target. This is the default for AIX5
7923 Generate (or don't) code for the GNU assembler. This is the default.
7924 @c Also, this is the default if the configure option @samp{--with-gnu-as}
7929 Generate (or don't) code for the GNU linker. This is the default.
7930 @c Also, this is the default if the configure option @samp{--with-gnu-ld}
7934 Generate code that does not use a global pointer register. The result
7935 is not position independent code, and violates the IA-64 ABI.
7937 @item -mvolatile-asm-stop
7938 @itemx -mno-volatile-asm-stop
7939 Generate (or don't) a stop bit immediately before and after volatile asm
7943 Generate code that works around Itanium B step errata.
7945 @item -mregister-names
7946 @itemx -mno-register-names
7947 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
7948 the stacked registers. This may make assembler output more readable.
7952 Disable (or enable) optimizations that use the small data section. This may
7953 be useful for working around optimizer bugs.
7956 Generate code that uses a single constant global pointer value. This is
7957 useful when compiling kernel code.
7960 Generate code that is self-relocatable. This implies @samp{-mconstant-gp}.
7961 This is useful when compiling firmware code.
7963 @item -minline-divide-min-latency
7964 Generate code for inline divides using the minimum latency algorithm.
7966 @item -minline-divide-max-throughput
7967 Generate code for inline divides using the maximum throughput algorithm.
7969 @item -mno-dwarf2-asm
7971 Don't (or do) generate assembler code for the DWARF2 line number debugging
7972 info. This may be useful when not using the GNU assembler.
7974 @item -mfixed-range=@var{register range}
7975 Generate code treating the given register range as fixed registers.
7976 A fixed register is one that the register allocator can not use. This is
7977 useful when compiling kernel code. A register range is specified as
7978 two registers separated by a dash. Multiple register ranges can be
7979 specified separated by a comma.
7983 @subsection D30V Options
7984 @cindex D30V Options
7986 These @samp{-m} options are defined for D30V implementations:
7990 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
7991 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
7992 memory, which starts at location @code{0x80000000}.
7995 Same as the @samp{-mextmem} switch.
7998 Link the @samp{.text} section into onchip text memory, which starts at
7999 location @code{0x0}. Also link @samp{.data}, @samp{.bss},
8000 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
8001 into onchip data memory, which starts at location @code{0x20000000}.
8003 @item -mno-asm-optimize
8004 @itemx -masm-optimize
8005 Disable (enable) passing @samp{-O} to the assembler when optimizing.
8006 The assembler uses the @samp{-O} option to automatically parallelize
8007 adjacent short instructions where possible.
8009 @item -mbranch-cost=@var{n}
8010 Increase the internal costs of branches to @var{n}. Higher costs means
8011 that the compiler will issue more instructions to avoid doing a branch.
8014 @item -mcond-exec=@var{n}
8015 Specify the maximum number of conditionally executed instructions that
8016 replace a branch. The default is 4.
8019 @node Code Gen Options
8020 @section Options for Code Generation Conventions
8021 @cindex code generation conventions
8022 @cindex options, code generation
8023 @cindex run-time options
8025 These machine-independent options control the interface conventions
8026 used in code generation.
8028 Most of them have both positive and negative forms; the negative form
8029 of @samp{-ffoo} would be @samp{-fno-foo}. In the table below, only
8030 one of the forms is listed---the one which is not the default. You
8031 can figure out the other form by either removing @samp{no-} or adding
8036 Enable exception handling. Generates extra code needed to propagate
8037 exceptions. For some targets, this implies GNU CC will generate frame
8038 unwind information for all functions, which can produce significant data
8039 size overhead, although it does not affect execution. If you do not
8040 specify this option, GNU CC will enable it by default for languages like
8041 C++ which normally require exception handling, and disable itfor
8042 languages like C that do not normally require it. However, you may need
8043 to enable this option when compiling C code that needs to interoperate
8044 properly with exception handlers written in C++. You may also wish to
8045 disable this option if you are compiling older C++ programs that don't
8046 use exception handling.
8048 @item -funwind-tables
8049 Similar to @option{-fexceptions}, except that it will just generate any needed
8050 static data, but will not affect the generated code in any other way.
8051 You will normally not enable this option; instead, a language processor
8052 that needs this handling would enable it on your behalf.
8054 @item -fpcc-struct-return
8055 Return ``short'' @code{struct} and @code{union} values in memory like
8056 longer ones, rather than in registers. This convention is less
8057 efficient, but it has the advantage of allowing intercallability between
8058 GCC-compiled files and files compiled with other compilers.
8060 The precise convention for returning structures in memory depends
8061 on the target configuration macros.
8063 Short structures and unions are those whose size and alignment match
8064 that of some integer type.
8066 @item -freg-struct-return
8067 Use the convention that @code{struct} and @code{union} values are
8068 returned in registers when possible. This is more efficient for small
8069 structures than @samp{-fpcc-struct-return}.
8071 If you specify neither @samp{-fpcc-struct-return} nor its contrary
8072 @samp{-freg-struct-return}, GCC defaults to whichever convention is
8073 standard for the target. If there is no standard convention, GCC
8074 defaults to @samp{-fpcc-struct-return}, except on targets where GCC
8075 is the principal compiler. In those cases, we can choose the standard,
8076 and we chose the more efficient register return alternative.
8079 Allocate to an @code{enum} type only as many bytes as it needs for the
8080 declared range of possible values. Specifically, the @code{enum} type
8081 will be equivalent to the smallest integer type which has enough room.
8083 @item -fshort-double
8084 Use the same size for @code{double} as for @code{float}.
8087 Requests that the data and non-@code{const} variables of this
8088 compilation be shared data rather than private data. The distinction
8089 makes sense only on certain operating systems, where shared data is
8090 shared between processes running the same program, while private data
8091 exists in one copy per process.
8094 Allocate even uninitialized global variables in the data section of the
8095 object file, rather than generating them as common blocks. This has the
8096 effect that if the same variable is declared (without @code{extern}) in
8097 two different compilations, you will get an error when you link them.
8098 The only reason this might be useful is if you wish to verify that the
8099 program will work on other systems which always work this way.
8102 Ignore the @samp{#ident} directive.
8104 @item -fno-gnu-linker
8105 Do not output global initializations (such as C++ constructors and
8106 destructors) in the form used by the GNU linker (on systems where the GNU
8107 linker is the standard method of handling them). Use this option when
8108 you want to use a non-GNU linker, which also requires using the
8109 @command{collect2} program to make sure the system linker includes
8110 constructors and destructors. (@command{collect2} is included in the GCC
8111 distribution.) For systems which @emph{must} use @command{collect2}, the
8112 compiler driver @command{gcc} is configured to do this automatically.
8114 @item -finhibit-size-directive
8115 Don't output a @code{.size} assembler directive, or anything else that
8116 would cause trouble if the function is split in the middle, and the
8117 two halves are placed at locations far apart in memory. This option is
8118 used when compiling @file{crtstuff.c}; you should not need to use it
8122 Put extra commentary information in the generated assembly code to
8123 make it more readable. This option is generally only of use to those
8124 who actually need to read the generated assembly code (perhaps while
8125 debugging the compiler itself).
8127 @samp{-fno-verbose-asm}, the default, causes the
8128 extra information to be omitted and is useful when comparing two assembler
8132 Consider all memory references through pointers to be volatile.
8134 @item -fvolatile-global
8135 Consider all memory references to extern and global data items to
8136 be volatile. GCC does not consider static data items to be volatile
8137 because of this switch.
8139 @item -fvolatile-static
8140 Consider all memory references to static data to be volatile.
8143 @cindex global offset table
8145 Generate position-independent code (PIC) suitable for use in a shared
8146 library, if supported for the target machine. Such code accesses all
8147 constant addresses through a global offset table (GOT). The dynamic
8148 loader resolves the GOT entries when the program starts (the dynamic
8149 loader is not part of GCC; it is part of the operating system). If
8150 the GOT size for the linked executable exceeds a machine-specific
8151 maximum size, you get an error message from the linker indicating that
8152 @samp{-fpic} does not work; in that case, recompile with @samp{-fPIC}
8153 instead. (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
8154 on the m68k and RS/6000. The 386 has no such limit.)
8156 Position-independent code requires special support, and therefore works
8157 only on certain machines. For the 386, GCC supports PIC for System V
8158 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
8159 position-independent.
8162 If supported for the target machine, emit position-independent code,
8163 suitable for dynamic linking and avoiding any limit on the size of the
8164 global offset table. This option makes a difference on the m68k, m88k,
8167 Position-independent code requires special support, and therefore works
8168 only on certain machines.
8170 @item -ffixed-@var{reg}
8171 Treat the register named @var{reg} as a fixed register; generated code
8172 should never refer to it (except perhaps as a stack pointer, frame
8173 pointer or in some other fixed role).
8175 @var{reg} must be the name of a register. The register names accepted
8176 are machine-specific and are defined in the @code{REGISTER_NAMES}
8177 macro in the machine description macro file.
8179 This flag does not have a negative form, because it specifies a
8182 @item -fcall-used-@var{reg}
8183 Treat the register named @var{reg} as an allocable register that is
8184 clobbered by function calls. It may be allocated for temporaries or
8185 variables that do not live across a call. Functions compiled this way
8186 will not save and restore the register @var{reg}.
8188 It is an error to used this flag with the frame pointer or stack pointer.
8189 Use of this flag for other registers that have fixed pervasive roles in
8190 the machine's execution model will produce disastrous results.
8192 This flag does not have a negative form, because it specifies a
8195 @item -fcall-saved-@var{reg}
8196 Treat the register named @var{reg} as an allocable register saved by
8197 functions. It may be allocated even for temporaries or variables that
8198 live across a call. Functions compiled this way will save and restore
8199 the register @var{reg} if they use it.
8201 It is an error to used this flag with the frame pointer or stack pointer.
8202 Use of this flag for other registers that have fixed pervasive roles in
8203 the machine's execution model will produce disastrous results.
8205 A different sort of disaster will result from the use of this flag for
8206 a register in which function values may be returned.
8208 This flag does not have a negative form, because it specifies a
8212 Pack all structure members together without holes. Usually you would
8213 not want to use this option, since it makes the code suboptimal, and
8214 the offsets of structure members won't agree with system libraries.
8216 @item -fcheck-memory-usage
8217 Generate extra code to check each memory access. GCC will generate
8218 code that is suitable for a detector of bad memory accesses such as
8221 Normally, you should compile all, or none, of your code with this option.
8223 If you do mix code compiled with and without this option,
8224 you must ensure that all code that has side effects
8225 and that is called by code compiled with this option
8226 is, itself, compiled with this option.
8227 If you do not, you might get erroneous messages from the detector.
8229 If you use functions from a library that have side-effects (such as
8230 @code{read}), you might not be able to recompile the library and
8231 specify this option. In that case, you can enable the
8232 @samp{-fprefix-function-name} option, which requests GCC to encapsulate
8233 your code and make other functions look as if they were compiled with
8234 @samp{-fcheck-memory-usage}. This is done by calling ``stubs'',
8235 which are provided by the detector. If you cannot find or build
8236 stubs for every function you call, you might have to specify
8237 @samp{-fcheck-memory-usage} without @samp{-fprefix-function-name}.
8239 If you specify this option, you can not use the @code{asm} or
8240 @code{__asm__} keywords in functions with memory checking enabled. GNU
8241 CC cannot understand what the @code{asm} statement may do, and therefore
8242 cannot generate the appropriate code, so it will reject it. However, if
8243 you specify the function attribute @code{no_check_memory_usage}
8244 (@pxref{Function Attributes}), GNU CC will disable memory checking within a
8245 function; you may use @code{asm} statements inside such functions. You
8246 may have an inline expansion of a non-checked function within a checked
8247 function; in that case GNU CC will not generate checks for the inlined
8248 function's memory accesses.
8250 If you move your @code{asm} statements to non-checked inline functions
8251 and they do access memory, you can add calls to the support code in your
8252 inline function, to indicate any reads, writes, or copies being done.
8253 These calls would be similar to those done in the stubs described above.
8255 @item -fprefix-function-name
8256 Request GCC to add a prefix to the symbols generated for function names.
8257 GCC adds a prefix to the names of functions defined as well as
8258 functions called. Code compiled with this option and code compiled
8259 without the option can't be linked together, unless stubs are used.
8261 If you compile the following code with @samp{-fprefix-function-name}
8263 extern void bar (int);
8272 GCC will compile the code as if it was written:
8274 extern void prefix_bar (int);
8278 return prefix_bar (a + 5);
8281 This option is designed to be used with @samp{-fcheck-memory-usage}.
8283 @item -finstrument-functions
8284 Generate instrumentation calls for entry and exit to functions. Just
8285 after function entry and just before function exit, the following
8286 profiling functions will be called with the address of the current
8287 function and its call site. (On some platforms,
8288 @code{__builtin_return_address} does not work beyond the current
8289 function, so the call site information may not be available to the
8290 profiling functions otherwise.)
8293 void __cyg_profile_func_enter (void *this_fn, void *call_site);
8294 void __cyg_profile_func_exit (void *this_fn, void *call_site);
8297 The first argument is the address of the start of the current function,
8298 which may be looked up exactly in the symbol table.
8300 This instrumentation is also done for functions expanded inline in other
8301 functions. The profiling calls will indicate where, conceptually, the
8302 inline function is entered and exited. This means that addressable
8303 versions of such functions must be available. If all your uses of a
8304 function are expanded inline, this may mean an additional expansion of
8305 code size. If you use @samp{extern inline} in your C code, an
8306 addressable version of such functions must be provided. (This is
8307 normally the case anyways, but if you get lucky and the optimizer always
8308 expands the functions inline, you might have gotten away without
8309 providing static copies.)
8311 A function may be given the attribute @code{no_instrument_function}, in
8312 which case this instrumentation will not be done. This can be used, for
8313 example, for the profiling functions listed above, high-priority
8314 interrupt routines, and any functions from which the profiling functions
8315 cannot safely be called (perhaps signal handlers, if the profiling
8316 routines generate output or allocate memory).
8319 Generate code to verify that you do not go beyond the boundary of the
8320 stack. You should specify this flag if you are running in an
8321 environment with multiple threads, but only rarely need to specify it in
8322 a single-threaded environment since stack overflow is automatically
8323 detected on nearly all systems if there is only one stack.
8325 Note that this switch does not actually cause checking to be done; the
8326 operating system must do that. The switch causes generation of code
8327 to ensure that the operating system sees the stack being extended.
8329 @item -fstack-limit-register=@var{reg}
8330 @itemx -fstack-limit-symbol=@var{sym}
8331 @itemx -fno-stack-limit
8332 Generate code to ensure that the stack does not grow beyond a certain value,
8333 either the value of a register or the address of a symbol. If the stack
8334 would grow beyond the value, a signal is raised. For most targets,
8335 the signal is raised before the stack overruns the boundary, so
8336 it is possible to catch the signal without taking special precautions.
8338 For instance, if the stack starts at address @samp{0x80000000} and grows
8339 downwards you can use the flags
8340 @samp{-fstack-limit-symbol=__stack_limit}
8341 @samp{-Wl,--defsym,__stack_limit=0x7ffe0000} which will enforce a stack
8344 @cindex aliasing of parameters
8345 @cindex parameters, aliased
8346 @item -fargument-alias
8347 @itemx -fargument-noalias
8348 @itemx -fargument-noalias-global
8349 Specify the possible relationships among parameters and between
8350 parameters and global data.
8352 @samp{-fargument-alias} specifies that arguments (parameters) may
8353 alias each other and may alias global storage.
8354 @samp{-fargument-noalias} specifies that arguments do not alias
8355 each other, but may alias global storage.
8356 @samp{-fargument-noalias-global} specifies that arguments do not
8357 alias each other and do not alias global storage.
8359 Each language will automatically use whatever option is required by
8360 the language standard. You should not need to use these options yourself.
8362 @item -fleading-underscore
8363 This option and its counterpart, -fno-leading-underscore, forcibly
8364 change the way C symbols are represented in the object file. One use
8365 is to help link with legacy assembly code.
8367 Be warned that you should know what you are doing when invoking this
8368 option, and that not all targets provide complete support for it.
8373 @node Environment Variables
8374 @section Environment Variables Affecting GCC
8375 @cindex environment variables
8377 @c man begin ENVIRONMENT
8379 This section describes several environment variables that affect how GCC
8380 operates. Some of them work by specifying directories or prefixes to use
8381 when searching for various kinds of files. Some are used to specify other
8382 aspects of the compilation environment.
8385 Note that you can also specify places to search using options such as
8386 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}). These
8387 take precedence over places specified using environment variables, which
8388 in turn take precedence over those specified by the configuration of GCC.
8392 Note that you can also specify places to search using options such as
8393 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}). These
8394 take precedence over places specified using environment variables, which
8395 in turn take precedence over those specified by the configuration of GCC.
8402 @c @itemx LC_COLLATE
8404 @c @itemx LC_MONETARY
8405 @c @itemx LC_NUMERIC
8410 @c @findex LC_COLLATE
8412 @c @findex LC_MONETARY
8413 @c @findex LC_NUMERIC
8417 These environment variables control the way that GCC uses
8418 localization information that allow GCC to work with different
8419 national conventions. GCC inspects the locale categories
8420 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
8421 so. These locale categories can be set to any value supported by your
8422 installation. A typical value is @samp{en_UK} for English in the United
8425 The @env{LC_CTYPE} environment variable specifies character
8426 classification. GCC uses it to determine the character boundaries in
8427 a string; this is needed for some multibyte encodings that contain quote
8428 and escape characters that would otherwise be interpreted as a string
8431 The @env{LC_MESSAGES} environment variable specifies the language to
8432 use in diagnostic messages.
8434 If the @env{LC_ALL} environment variable is set, it overrides the value
8435 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
8436 and @env{LC_MESSAGES} default to the value of the @env{LANG}
8437 environment variable. If none of these variables are set, GCC
8438 defaults to traditional C English behavior.
8442 If @env{TMPDIR} is set, it specifies the directory to use for temporary
8443 files. GCC uses temporary files to hold the output of one stage of
8444 compilation which is to be used as input to the next stage: for example,
8445 the output of the preprocessor, which is the input to the compiler
8448 @item GCC_EXEC_PREFIX
8449 @findex GCC_EXEC_PREFIX
8450 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
8451 names of the subprograms executed by the compiler. No slash is added
8452 when this prefix is combined with the name of a subprogram, but you can
8453 specify a prefix that ends with a slash if you wish.
8455 If @env{GCC_EXEC_PREFIX} is not set, GNU CC will attempt to figure out
8456 an appropriate prefix to use based on the pathname it was invoked with.
8458 If GCC cannot find the subprogram using the specified prefix, it
8459 tries looking in the usual places for the subprogram.
8461 The default value of @env{GCC_EXEC_PREFIX} is
8462 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
8463 of @code{prefix} when you ran the @file{configure} script.
8465 Other prefixes specified with @samp{-B} take precedence over this prefix.
8467 This prefix is also used for finding files such as @file{crt0.o} that are
8470 In addition, the prefix is used in an unusual way in finding the
8471 directories to search for header files. For each of the standard
8472 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
8473 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
8474 replacing that beginning with the specified prefix to produce an
8475 alternate directory name. Thus, with @samp{-Bfoo/}, GCC will search
8476 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
8477 These alternate directories are searched first; the standard directories
8481 @findex COMPILER_PATH
8482 The value of @env{COMPILER_PATH} is a colon-separated list of
8483 directories, much like @env{PATH}. GCC tries the directories thus
8484 specified when searching for subprograms, if it can't find the
8485 subprograms using @env{GCC_EXEC_PREFIX}.
8488 @findex LIBRARY_PATH
8489 The value of @env{LIBRARY_PATH} is a colon-separated list of
8490 directories, much like @env{PATH}. When configured as a native compiler,
8491 GCC tries the directories thus specified when searching for special
8492 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
8493 using GCC also uses these directories when searching for ordinary
8494 libraries for the @samp{-l} option (but directories specified with
8495 @samp{-L} come first).
8497 @item C_INCLUDE_PATH
8498 @itemx CPLUS_INCLUDE_PATH
8499 @itemx OBJC_INCLUDE_PATH
8500 @findex C_INCLUDE_PATH
8501 @findex CPLUS_INCLUDE_PATH
8502 @findex OBJC_INCLUDE_PATH
8503 @c @itemx OBJCPLUS_INCLUDE_PATH
8504 These environment variables pertain to particular languages. Each
8505 variable's value is a colon-separated list of directories, much like
8506 @env{PATH}. When GCC searches for header files, it tries the
8507 directories listed in the variable for the language you are using, after
8508 the directories specified with @samp{-I} but before the standard header
8511 @item DEPENDENCIES_OUTPUT
8512 @findex DEPENDENCIES_OUTPUT
8513 @cindex dependencies for make as output
8514 If this variable is set, its value specifies how to output dependencies
8515 for Make based on the header files processed by the compiler. This
8516 output looks much like the output from the @samp{-M} option
8517 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
8518 in addition to the usual results of compilation.
8520 The value of @env{DEPENDENCIES_OUTPUT} can be just a file name, in
8521 which case the Make rules are written to that file, guessing the target
8522 name from the source file name. Or the value can have the form
8523 @samp{@var{file} @var{target}}, in which case the rules are written to
8524 file @var{file} using @var{target} as the target name.
8528 @cindex locale definition
8529 This variable is used to pass locale information to the compiler. One way in
8530 which this information is used is to determine the character set to be used
8531 when character literals, string literals and comments are parsed in C and C++.
8532 When the compiler is configured to allow multibyte characters,
8533 the following values for @env{LANG} are recognized:
8537 Recognize JIS characters.
8539 Recognize SJIS characters.
8541 Recognize EUCJP characters.
8544 If @env{LANG} is not defined, or if it has some other value, then the
8545 compiler will use mblen and mbtowc as defined by the default locale to
8546 recognize and translate multibyte characters.
8551 @node Running Protoize
8552 @section Running Protoize
8554 The program @code{protoize} is an optional part of GNU C. You can use
8555 it to add prototypes to a program, thus converting the program to ISO
8556 C in one respect. The companion program @code{unprotoize} does the
8557 reverse: it removes argument types from any prototypes that are found.
8559 When you run these programs, you must specify a set of source files as
8560 command line arguments. The conversion programs start out by compiling
8561 these files to see what functions they define. The information gathered
8562 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
8564 After scanning comes actual conversion. The specified files are all
8565 eligible to be converted; any files they include (whether sources or
8566 just headers) are eligible as well.
8568 But not all the eligible files are converted. By default,
8569 @code{protoize} and @code{unprotoize} convert only source and header
8570 files in the current directory. You can specify additional directories
8571 whose files should be converted with the @samp{-d @var{directory}}
8572 option. You can also specify particular files to exclude with the
8573 @samp{-x @var{file}} option. A file is converted if it is eligible, its
8574 directory name matches one of the specified directory names, and its
8575 name within the directory has not been excluded.
8577 Basic conversion with @code{protoize} consists of rewriting most
8578 function definitions and function declarations to specify the types of
8579 the arguments. The only ones not rewritten are those for varargs
8582 @code{protoize} optionally inserts prototype declarations at the
8583 beginning of the source file, to make them available for any calls that
8584 precede the function's definition. Or it can insert prototype
8585 declarations with block scope in the blocks where undeclared functions
8588 Basic conversion with @code{unprotoize} consists of rewriting most
8589 function declarations to remove any argument types, and rewriting
8590 function definitions to the old-style pre-ISO form.
8592 Both conversion programs print a warning for any function declaration or
8593 definition that they can't convert. You can suppress these warnings
8596 The output from @code{protoize} or @code{unprotoize} replaces the
8597 original source file. The original file is renamed to a name ending
8598 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
8599 without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
8600 for DOS) file already exists, then the source file is simply discarded.
8602 @code{protoize} and @code{unprotoize} both depend on GCC itself to
8603 scan the program and collect information about the functions it uses.
8604 So neither of these programs will work until GCC is installed.
8606 Here is a table of the options you can use with @code{protoize} and
8607 @code{unprotoize}. Each option works with both programs unless
8611 @item -B @var{directory}
8612 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
8613 usual directory (normally @file{/usr/local/lib}). This file contains
8614 prototype information about standard system functions. This option
8615 applies only to @code{protoize}.
8617 @item -c @var{compilation-options}
8618 Use @var{compilation-options} as the options when running @code{gcc} to
8619 produce the @samp{.X} files. The special option @samp{-aux-info} is
8620 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
8622 Note that the compilation options must be given as a single argument to
8623 @code{protoize} or @code{unprotoize}. If you want to specify several
8624 @code{gcc} options, you must quote the entire set of compilation options
8625 to make them a single word in the shell.
8627 There are certain @code{gcc} arguments that you cannot use, because they
8628 would produce the wrong kind of output. These include @samp{-g},
8629 @samp{-O}, @samp{-c}, @samp{-S}, and @samp{-o} If you include these in
8630 the @var{compilation-options}, they are ignored.
8633 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
8634 systems) instead of @samp{.c}. This is convenient if you are converting
8635 a C program to C++. This option applies only to @code{protoize}.
8638 Add explicit global declarations. This means inserting explicit
8639 declarations at the beginning of each source file for each function
8640 that is called in the file and was not declared. These declarations
8641 precede the first function definition that contains a call to an
8642 undeclared function. This option applies only to @code{protoize}.
8644 @item -i @var{string}
8645 Indent old-style parameter declarations with the string @var{string}.
8646 This option applies only to @code{protoize}.
8648 @code{unprotoize} converts prototyped function definitions to old-style
8649 function definitions, where the arguments are declared between the
8650 argument list and the initial @samp{@{}. By default, @code{unprotoize}
8651 uses five spaces as the indentation. If you want to indent with just
8652 one space instead, use @samp{-i " "}.
8655 Keep the @samp{.X} files. Normally, they are deleted after conversion
8659 Add explicit local declarations. @code{protoize} with @samp{-l} inserts
8660 a prototype declaration for each function in each block which calls the
8661 function without any declaration. This option applies only to
8665 Make no real changes. This mode just prints information about the conversions
8666 that would have been done without @samp{-n}.
8669 Make no @samp{.save} files. The original files are simply deleted.
8670 Use this option with caution.
8672 @item -p @var{program}
8673 Use the program @var{program} as the compiler. Normally, the name
8677 Work quietly. Most warnings are suppressed.
8680 Print the version number, just like @samp{-v} for @code{gcc}.
8683 If you need special compiler options to compile one of your program's
8684 source files, then you should generate that file's @samp{.X} file
8685 specially, by running @code{gcc} on that source file with the
8686 appropriate options and the option @samp{-aux-info}. Then run
8687 @code{protoize} on the entire set of files. @code{protoize} will use
8688 the existing @samp{.X} file because it is newer than the source file.
8692 gcc -Dfoo=bar file1.c -aux-info
8697 You need to include the special files along with the rest in the
8698 @code{protoize} command, even though their @samp{.X} files already
8699 exist, because otherwise they won't get converted.
8701 @xref{Protoize Caveats}, for more information on how to use
8702 @code{protoize} successfully.