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