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