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