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