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