invoke.texi (RS/6000 and PowerPC Options): Document -mspe option.
[gcc.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below). A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21 A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25 You have freedom to copy and modify this GNU Manual, like GNU
26 software. Copies published by the Free Software Foundation raise
27 funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34 [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35 [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36 [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37 [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38 [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39 [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder. @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}. Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
68 @c man begin DESCRIPTION
69
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking. The ``overall options'' allow you to stop this
72 process at an intermediate stage. For example, the @option{-c} option
73 says not to run the linker. Then the output consists of object files
74 output by the assembler.
75
76 Other options are passed on to one stage of processing. Some options
77 control the preprocessor and others the compiler itself. Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
80
81 @cindex C compilation options
82 Most of the command line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly. If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
87
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
91
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands. Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
97 -r}}.
98
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments. For the most part, the order
102 you use doesn't matter. Order does matter when you use several options
103 of the same kind; for example, if you specify @option{-L} more than once,
104 the directories are searched in the order specified.
105
106 Many options have long names starting with @samp{-f} or with
107 @samp{-W}---for example, @option{-fforce-mem},
108 @option{-fstrength-reduce}, @option{-Wformat} and so on. Most of
109 these have both positive and negative forms; the negative form of
110 @option{-ffoo} would be @option{-fno-foo}. This manual documents
111 only one of these two forms, whichever one is not the default.
112
113 @c man end
114
115 @xref{Option Index}, for an index to GCC's options.
116
117 @menu
118 * Option Summary:: Brief list of all options, without explanations.
119 * Overall Options:: Controlling the kind of output:
120 an executable, object files, assembler files,
121 or preprocessed source.
122 * Invoking G++:: Compiling C++ programs.
123 * C Dialect Options:: Controlling the variant of C language compiled.
124 * C++ Dialect Options:: Variations on C++.
125 * Objective-C Dialect Options:: Variations on Objective-C.
126 * Language Independent Options:: Controlling how diagnostics should be
127 formatted.
128 * Warning Options:: How picky should the compiler be?
129 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
130 * Optimize Options:: How much optimization?
131 * Preprocessor Options:: Controlling header files and macro definitions.
132 Also, getting dependency information for Make.
133 * Assembler Options:: Passing options to the assembler.
134 * Link Options:: Specifying libraries and so on.
135 * Directory Options:: Where to find header files and libraries.
136 Where to find the compiler executable files.
137 * Spec Files:: How to pass switches to sub-processes.
138 * Target Options:: Running a cross-compiler, or an old version of GCC.
139 * Submodel Options:: Specifying minor hardware or convention variations,
140 such as 68010 vs 68020.
141 * Code Gen Options:: Specifying conventions for function calls, data layout
142 and register usage.
143 * Environment Variables:: Env vars that affect GCC.
144 * Precompiled Headers:: Compiling a header once, and using it many times.
145 * Running Protoize:: Automatically adding or removing function prototypes.
146 @end menu
147
148 @c man begin OPTIONS
149
150 @node Option Summary
151 @section Option Summary
152
153 Here is a summary of all the options, grouped by type. Explanations are
154 in the following sections.
155
156 @table @emph
157 @item Overall Options
158 @xref{Overall Options,,Options Controlling the Kind of Output}.
159 @gccoptlist{
160 -c -S -E -o @var{file} -pipe -pass-exit-codes -x @var{language} @gol
161 -v -### --help --target-help --version}
162
163 @item C Language Options
164 @xref{C Dialect Options,,Options Controlling C Dialect}.
165 @gccoptlist{
166 -ansi -std=@var{standard} -aux-info @var{filename} @gol
167 -fno-asm -fno-builtin -fno-builtin-@var{function} @gol
168 -fhosted -ffreestanding -fms-extensions @gol
169 -trigraphs -no-integrated-cpp -traditional -traditional-cpp @gol
170 -fallow-single-precision -fcond-mismatch @gol
171 -fsigned-bitfields -fsigned-char @gol
172 -funsigned-bitfields -funsigned-char @gol
173 -fwritable-strings}
174
175 @item C++ Language Options
176 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
177 @gccoptlist{
178 -fabi-version=@var{n} -fno-access-control -fcheck-new @gol
179 -fconserve-space -fno-const-strings -fdollars-in-identifiers @gol
180 -fno-elide-constructors @gol
181 -fno-enforce-eh-specs -fexternal-templates @gol
182 -falt-external-templates @gol
183 -ffor-scope -fno-for-scope -fno-gnu-keywords @gol
184 -fno-implicit-templates @gol
185 -fno-implicit-inline-templates @gol
186 -fno-implement-inlines -fms-extensions @gol
187 -fno-nonansi-builtins -fno-operator-names @gol
188 -fno-optional-diags -fpermissive @gol
189 -frepo -fno-rtti -fstats -ftemplate-depth-@var{n} @gol
190 -fuse-cxa-atexit -fvtable-gc -fno-weak -nostdinc++ @gol
191 -fno-default-inline -Wabi -Wctor-dtor-privacy @gol
192 -Wnon-virtual-dtor -Wreorder @gol
193 -Weffc++ -Wno-deprecated @gol
194 -Wno-non-template-friend -Wold-style-cast @gol
195 -Woverloaded-virtual -Wno-pmf-conversions @gol
196 -Wsign-promo -Wsynth}
197
198 @item Objective-C Language Options
199 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
200 @gccoptlist{
201 -fconstant-string-class=@var{class-name} @gol
202 -fgnu-runtime -fnext-runtime -gen-decls @gol
203 -Wno-protocol -Wselector -Wundeclared-selector}
204
205 @item Language Independent Options
206 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
207 @gccoptlist{
208 -fmessage-length=@var{n} @gol
209 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
210
211 @item Warning Options
212 @xref{Warning Options,,Options to Request or Suppress Warnings}.
213 @gccoptlist{
214 -fsyntax-only -pedantic -pedantic-errors @gol
215 -w -Wextra -Wall -Waggregate-return @gol
216 -Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment @gol
217 -Wconversion -Wno-deprecated-declarations @gol
218 -Wdisabled-optimization -Wno-div-by-zero -Werror @gol
219 -Wfloat-equal -Wformat -Wformat=2 @gol
220 -Wformat-nonliteral -Wformat-security @gol
221 -Wimplicit -Wimplicit-int @gol
222 -Wimplicit-function-declaration @gol
223 -Werror-implicit-function-declaration @gol
224 -Wimport -Winline -Winvalid-pch -Wno-endif-labels @gol
225 -Wlarger-than-@var{len} -Wlong-long @gol
226 -Wmain -Wmissing-braces @gol
227 -Wmissing-format-attribute -Wmissing-noreturn @gol
228 -Wno-multichar -Wno-format-extra-args -Wno-format-y2k @gol
229 -Wno-import -Wnonnull -Wpacked -Wpadded @gol
230 -Wparentheses -Wpointer-arith -Wredundant-decls @gol
231 -Wreturn-type -Wsequence-point -Wshadow @gol
232 -Wsign-compare -Wstrict-aliasing @gol
233 -Wswitch -Wswitch-default -Wswitch-enum @gol
234 -Wsystem-headers -Wtrigraphs -Wundef -Wuninitialized @gol
235 -Wunknown-pragmas -Wunreachable-code @gol
236 -Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
237 -Wunused-value -Wunused-variable -Wwrite-strings}
238
239 @item C-only Warning Options
240 @gccoptlist{
241 -Wbad-function-cast -Wmissing-declarations @gol
242 -Wmissing-prototypes -Wnested-externs @gol
243 -Wstrict-prototypes -Wtraditional}
244
245 @item Debugging Options
246 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
247 @gccoptlist{
248 -d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
249 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
250 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
251 -fdump-tree-original@r{[}-@var{n}@r{]} -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
252 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
253 -feliminate-dwarf2-dups -fmem-report @gol
254 -fprofile-arcs -fsched-verbose=@var{n} @gol
255 -ftest-coverage -ftime-report @gol
256 -g -g@var{level} -gcoff -gdwarf -gdwarf-1 -gdwarf-1+ -gdwarf-2 @gol
257 -ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ @gol
258 -p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
259 -print-multi-directory -print-multi-lib @gol
260 -print-prog-name=@var{program} -print-search-dirs -Q @gol
261 -feliminate-unused-debug-types @gol
262 -save-temps -time}
263
264 @item Optimization Options
265 @xref{Optimize Options,,Options that Control Optimization}.
266 @gccoptlist{
267 -falign-functions=@var{n} -falign-jumps=@var{n} @gol
268 -falign-labels=@var{n} -falign-loops=@var{n} @gol
269 -fbranch-probabilities -fcaller-saves -fcprop-registers @gol
270 -fcse-follow-jumps -fcse-skip-blocks -fdata-sections @gol
271 -fdelayed-branch -fdelete-null-pointer-checks @gol
272 -fexpensive-optimizations -ffast-math -ffloat-store @gol
273 -fforce-addr -fforce-mem -ffunction-sections @gol
274 -fgcse -fgcse-lm -fgcse-sm -floop-optimize -fcrossjumping @gol
275 -fif-conversion -fif-conversion2 @gol
276 -finline-functions -finline-limit=@var{n} -fkeep-inline-functions @gol
277 -fkeep-static-consts -fmerge-constants -fmerge-all-constants @gol
278 -fmove-all-movables -fnew-ra -fno-branch-count-reg @gol
279 -fno-default-inline -fno-defer-pop @gol
280 -fno-function-cse -fno-guess-branch-probability @gol
281 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
282 -funsafe-math-optimizations -ffinite-math-only @gol
283 -fno-trapping-math -fno-zero-initialized-in-bss @gol
284 -fomit-frame-pointer -foptimize-register-move @gol
285 -foptimize-sibling-calls -fprefetch-loop-arrays @gol
286 -freduce-all-givs -fregmove -frename-registers @gol
287 -freorder-blocks -freorder-functions @gol
288 -frerun-cse-after-loop -frerun-loop-opt @gol
289 -fschedule-insns -fschedule-insns2 @gol
290 -fno-sched-interblock -fno-sched-spec -fsched-spec-load @gol
291 -fsched-spec-load-dangerous -fsched2-use-superblocks @gol
292 -fsched2-use-traces -fsignaling-nans @gol
293 -fsingle-precision-constant -fssa -fssa-ccp -fssa-dce @gol
294 -fstrength-reduce -fstrict-aliasing -ftracer -fthread-jumps @gol
295 -funroll-all-loops -funroll-loops -fpeel-loops -funswitch-loops @gol
296 -fold-unroll-loops -fold-unroll-all-loops @gol
297 --param @var{name}=@var{value}
298 -O -O0 -O1 -O2 -O3 -Os}
299
300 @item Preprocessor Options
301 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
302 @gccoptlist{
303 -$ -A@var{question}=@var{answer} -A-@var{question}@r{[}=@var{answer}@r{]} @gol
304 -C -dD -dI -dM -dN @gol
305 -D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
306 -idirafter @var{dir} @gol
307 -include @var{file} -imacros @var{file} @gol
308 -iprefix @var{file} -iwithprefix @var{dir} @gol
309 -iwithprefixbefore @var{dir} -isystem @var{dir} @gol
310 -M -MM -MF -MG -MP -MQ -MT -nostdinc -P -remap @gol
311 -trigraphs -undef -U@var{macro} -Wp,@var{option} -Xpreprocessor @var{option}}
312
313 @item Assembler Option
314 @xref{Assembler Options,,Passing Options to the Assembler}.
315 @gccoptlist{
316 -Wa,@var{option} -Xassembler @var{option}}
317
318 @item Linker Options
319 @xref{Link Options,,Options for Linking}.
320 @gccoptlist{
321 @var{object-file-name} -l@var{library} @gol
322 -nostartfiles -nodefaultlibs -nostdlib @gol
323 -s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
324 -Wl,@var{option} -Xlinker @var{option} @gol
325 -u @var{symbol}}
326
327 @item Directory Options
328 @xref{Directory Options,,Options for Directory Search}.
329 @gccoptlist{
330 -B@var{prefix} -I@var{dir} -I- -L@var{dir} -specs=@var{file}}
331
332 @item Target Options
333 @c I wrote this xref this way to avoid overfull hbox. -- rms
334 @xref{Target Options}.
335 @gccoptlist{
336 -V @var{version} -b @var{machine}}
337
338 @item Machine Dependent Options
339 @xref{Submodel Options,,Hardware Models and Configurations}.
340
341 @emph{M680x0 Options}
342 @gccoptlist{
343 -m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
344 -m68060 -mcpu32 -m5200 -m68881 -mbitfield -mc68000 -mc68020 @gol
345 -mfpa -mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
346 -malign-int -mstrict-align}
347
348 @emph{M68hc1x Options}
349 @gccoptlist{
350 -m6811 -m6812 -m68hc11 -m68hc12 -m68hcs12 @gol
351 -mauto-incdec -minmax -mlong-calls -mshort @gol
352 -msoft-reg-count=@var{count}}
353
354 @emph{VAX Options}
355 @gccoptlist{
356 -mg -mgnu -munix}
357
358 @emph{SPARC Options}
359 @gccoptlist{
360 -mcpu=@var{cpu-type} @gol
361 -mtune=@var{cpu-type} @gol
362 -mcmodel=@var{code-model} @gol
363 -m32 -m64 @gol
364 -mapp-regs -mbroken-saverestore -mcypress @gol
365 -mfaster-structs -mflat @gol
366 -mfpu -mhard-float -mhard-quad-float @gol
367 -mimpure-text -mlive-g0 -mno-app-regs @gol
368 -mno-faster-structs -mno-flat -mno-fpu @gol
369 -mno-impure-text -mno-stack-bias -mno-unaligned-doubles @gol
370 -msoft-float -msoft-quad-float -msparclite -mstack-bias @gol
371 -msupersparc -munaligned-doubles -mv8}
372
373 @emph{ARM Options}
374 @gccoptlist{
375 -mapcs-frame -mno-apcs-frame @gol
376 -mapcs-26 -mapcs-32 @gol
377 -mapcs-stack-check -mno-apcs-stack-check @gol
378 -mapcs-float -mno-apcs-float @gol
379 -mapcs-reentrant -mno-apcs-reentrant @gol
380 -msched-prolog -mno-sched-prolog @gol
381 -mlittle-endian -mbig-endian -mwords-little-endian @gol
382 -malignment-traps -mno-alignment-traps @gol
383 -msoft-float -mhard-float -mfpe @gol
384 -mthumb-interwork -mno-thumb-interwork @gol
385 -mcpu=@var{name} -march=@var{name} -mfpe=@var{name} @gol
386 -mstructure-size-boundary=@var{n} @gol
387 -mabort-on-noreturn @gol
388 -mlong-calls -mno-long-calls @gol
389 -msingle-pic-base -mno-single-pic-base @gol
390 -mpic-register=@var{reg} @gol
391 -mnop-fun-dllimport @gol
392 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
393 -mpoke-function-name @gol
394 -mthumb -marm @gol
395 -mtpcs-frame -mtpcs-leaf-frame @gol
396 -mcaller-super-interworking -mcallee-super-interworking }
397
398 @emph{MN10200 Options}
399 @gccoptlist{
400 -mrelax}
401
402 @emph{MN10300 Options}
403 @gccoptlist{
404 -mmult-bug -mno-mult-bug @gol
405 -mam33 -mno-am33 @gol
406 -mno-crt0 -mrelax}
407
408 @emph{M32R/D Options}
409 @gccoptlist{
410 -m32rx -m32r -mcode-model=@var{model-type} -msdata=@var{sdata-type} @gol
411 -G @var{num}}
412
413 @emph{M88K Options}
414 @gccoptlist{
415 -m88000 -m88100 -m88110 -mbig-pic @gol
416 -mcheck-zero-division -mhandle-large-shift @gol
417 -midentify-revision -mno-check-zero-division @gol
418 -mno-ocs-debug-info -mno-ocs-frame-position @gol
419 -mno-optimize-arg-area -mno-serialize-volatile @gol
420 -mno-underscores -mocs-debug-info @gol
421 -mocs-frame-position -moptimize-arg-area @gol
422 -mserialize-volatile -mshort-data-@var{num} -msvr3 @gol
423 -msvr4 -mtrap-large-shift -muse-div-instruction @gol
424 -mversion-03.00 -mwarn-passed-structs}
425
426 @emph{RS/6000 and PowerPC Options}
427 @gccoptlist{
428 -mcpu=@var{cpu-type} @gol
429 -mtune=@var{cpu-type} @gol
430 -mpower -mno-power -mpower2 -mno-power2 @gol
431 -mpowerpc -mpowerpc64 -mno-powerpc @gol
432 -maltivec -mno-altivec @gol
433 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
434 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
435 -mnew-mnemonics -mold-mnemonics @gol
436 -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
437 -m64 -m32 -mxl-call -mno-xl-call -mpe @gol
438 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
439 -mstring -mno-string -mupdate -mno-update @gol
440 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
441 -mstrict-align -mno-strict-align -mrelocatable @gol
442 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
443 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
444 -mdynamic-no-pic @gol
445 -mcall-aix -mcall-sysv -mcall-netbsd @gol
446 -maix-struct-return -msvr4-struct-return @gol
447 -mabi=altivec -mabi=no-altivec @gol
448 -mabi=spe -mabi=no-spe @gol
449 -misel=yes -misel=no @gol
450 -mspe=yes -mspe=no @gol
451 -mprototype -mno-prototype @gol
452 -msim -mmvme -mads -myellowknife -memb -msdata @gol
453 -msdata=@var{opt} -mvxworks -mwindiss -G @var{num} -pthread}
454
455 @emph{Darwin Options}
456 @gccoptlist{
457 -all_load -allowable_client -arch -arch_errors_fatal @gol
458 -arch_only -bind_at_load -bundle -bundle_loader @gol
459 -client_name -compatibility_version -current_version @gol
460 -dependency-file -dylib_file -dylinker_install_name @gol
461 -dynamic -dynamiclib -exported_symbols_list @gol
462 -filelist -flat_namespace -force_cpusubtype_ALL @gol
463 -force_flat_namespace -headerpad_max_install_names @gol
464 -image_base -init -install_name -keep_private_externs @gol
465 -multi_module -multiply_defined -multiply_defined_unused @gol
466 -noall_load -nomultidefs -noprebind -noseglinkedit @gol
467 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
468 -private_bundle -read_only_relocs -sectalign @gol
469 -sectobjectsymbols -whyload -seg1addr @gol
470 -sectcreate -sectobjectsymbols -sectorder @gol
471 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
472 -segprot -segs_read_only_addr -segs_read_write_addr @gol
473 -single_module -static -sub_library -sub_umbrella @gol
474 -twolevel_namespace -umbrella -undefined @gol
475 -unexported_symbols_list -weak_reference_mismatches -whatsloaded}
476
477 @emph{RT Options}
478 @gccoptlist{
479 -mcall-lib-mul -mfp-arg-in-fpregs -mfp-arg-in-gregs @gol
480 -mfull-fp-blocks -mhc-struct-return -min-line-mul @gol
481 -mminimum-fp-blocks -mnohc-struct-return}
482
483 @emph{MIPS Options}
484 @gccoptlist{
485 -mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
486 -mcpu=@var{cpu-type} -membedded-data -muninit-const-in-rodata @gol
487 -membedded-pic -mfp32 -mfp64 -mfused-madd -mno-fused-madd @gol
488 -mgas -mgp32 -mgp64 @gol
489 -mgpopt -mhalf-pic -mhard-float -mint64 -mips1 @gol
490 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips64 @gol
491 -mlong64 -mlong32 -mlong-calls -mmemcpy @gol
492 -mmips-as -mmips-tfile -mno-abicalls @gol
493 -mno-embedded-data -mno-uninit-const-in-rodata @gol
494 -mno-embedded-pic -mno-gpopt -mno-long-calls @gol
495 -mno-memcpy -mno-mips-tfile -mno-rnames -mno-stats @gol
496 -mrnames -msoft-float @gol
497 -m4650 -msingle-float -mmad @gol
498 -mstats -EL -EB -G @var{num} -nocpp @gol
499 -mabi=32 -mabi=n32 -mabi=64 -mabi=eabi -mabi-fake-default @gol
500 -mfix7000 -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
501 -mbranch-likely -mno-branch-likely}
502
503 @emph{i386 and x86-64 Options}
504 @gccoptlist{
505 -mtune=@var{cpu-type} -march=@var{cpu-type} -mfpmath=@var{unit} @gol
506 -masm=@var{dialect} -mno-fancy-math-387 @gol
507 -mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
508 -mno-wide-multiply -mrtd -malign-double @gol
509 -mpreferred-stack-boundary=@var{num} @gol
510 -mmmx -msse -msse2 -m3dnow @gol
511 -mthreads -mno-align-stringops -minline-all-stringops @gol
512 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
513 -m96bit-long-double -mregparm=@var{num} -momit-leaf-frame-pointer @gol
514 -mno-red-zone@gol
515 -mcmodel=@var{code-model} @gol
516 -m32 -m64}
517
518 @emph{HPPA Options}
519 @gccoptlist{
520 -march=@var{architecture-type} @gol
521 -mbig-switch -mdisable-fpregs -mdisable-indexing @gol
522 -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
523 -mjump-in-delay -mlinker-opt -mlong-calls @gol
524 -mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
525 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
526 -mno-jump-in-delay -mno-long-load-store @gol
527 -mno-portable-runtime -mno-soft-float @gol
528 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
529 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
530 -mschedule=@var{cpu-type} -mspace-regs -msio -mwsio}
531
532 @emph{Intel 960 Options}
533 @gccoptlist{
534 -m@var{cpu-type} -masm-compat -mclean-linkage @gol
535 -mcode-align -mcomplex-addr -mleaf-procedures @gol
536 -mic-compat -mic2.0-compat -mic3.0-compat @gol
537 -mintel-asm -mno-clean-linkage -mno-code-align @gol
538 -mno-complex-addr -mno-leaf-procedures @gol
539 -mno-old-align -mno-strict-align -mno-tail-call @gol
540 -mnumerics -mold-align -msoft-float -mstrict-align @gol
541 -mtail-call}
542
543 @emph{DEC Alpha Options}
544 @gccoptlist{
545 -mno-fp-regs -msoft-float -malpha-as -mgas @gol
546 -mieee -mieee-with-inexact -mieee-conformant @gol
547 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
548 -mtrap-precision=@var{mode} -mbuild-constants @gol
549 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
550 -mbwx -mmax -mfix -mcix @gol
551 -mfloat-vax -mfloat-ieee @gol
552 -mexplicit-relocs -msmall-data -mlarge-data -msmall-text -mlarge-text @gol
553 -mmemory-latency=@var{time}}
554
555 @emph{DEC Alpha/VMS Options}
556 @gccoptlist{
557 -mvms-return-codes}
558
559 @emph{H8/300 Options}
560 @gccoptlist{
561 -mrelax -mh -ms -mn -mint32 -malign-300}
562
563 @emph{SH Options}
564 @gccoptlist{
565 -m1 -m2 -m2e -m3 -m3e @gol
566 -m4-nofpu -m4-single-only -m4-single -m4 @gol
567 -m5-64media -m5-64media-nofpu @gol
568 -m5-32media -m5-32media-nofpu @gol
569 -m5-compact -m5-compact-nofpu @gol
570 -mb -ml -mdalign -mrelax @gol
571 -mbigtable -mfmovd -mhitachi -mnomacsave @gol
572 -mieee -misize -mpadstruct -mspace @gol
573 -mprefergot -musermode}
574
575 @emph{System V Options}
576 @gccoptlist{
577 -Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
578
579 @emph{ARC Options}
580 @gccoptlist{
581 -EB -EL @gol
582 -mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
583 -mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
584
585 @emph{TMS320C3x/C4x Options}
586 @gccoptlist{
587 -mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
588 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
589 -mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
590 -mparallel-insns -mparallel-mpy -mpreserve-float}
591
592 @emph{V850 Options}
593 @gccoptlist{
594 -mlong-calls -mno-long-calls -mep -mno-ep @gol
595 -mprolog-function -mno-prolog-function -mspace @gol
596 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
597 -mapp-regs -mno-app-regs @gol
598 -mdisable-callt -mno-disable-callt @gol
599 -mv850e @gol
600 -mv850 -mbig-switch}
601
602 @emph{NS32K Options}
603 @gccoptlist{
604 -m32032 -m32332 -m32532 -m32081 -m32381 @gol
605 -mmult-add -mnomult-add -msoft-float -mrtd -mnortd @gol
606 -mregparam -mnoregparam -msb -mnosb @gol
607 -mbitfield -mnobitfield -mhimem -mnohimem}
608
609 @emph{AVR Options}
610 @gccoptlist{
611 -mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
612 -mcall-prologues -mno-tablejump -mtiny-stack}
613
614 @emph{MCore Options}
615 @gccoptlist{
616 -mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
617 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
618 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
619 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
620 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
621
622 @emph{MMIX Options}
623 @gccoptlist{
624 -mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
625 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
626 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
627 -mno-base-addresses -msingle-exit -mno-single-exit}
628
629 @emph{IA-64 Options}
630 @gccoptlist{
631 -mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
632 -mvolatile-asm-stop -mb-step -mregister-names -mno-sdata @gol
633 -mconstant-gp -mauto-pic -minline-float-divide-min-latency @gol
634 -minline-float-divide-max-throughput -minline-int-divide-min-latency @gol
635 -minline-int-divide-max-throughput -mno-dwarf2-asm @gol
636 -mfixed-range=@var{register-range}}
637
638 @emph{D30V Options}
639 @gccoptlist{
640 -mextmem -mextmemory -monchip -mno-asm-optimize @gol
641 -masm-optimize -mbranch-cost=@var{n} -mcond-exec=@var{n}}
642
643 @emph{S/390 and zSeries Options}
644 @gccoptlist{
645 -mtune=@var{cpu-type} -march=@var{cpu-type} @gol
646 -mhard-float -msoft-float -mbackchain -mno-backchain @gol
647 -msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
648 -m64 -m31 -mdebug -mno-debug -mesa -mzarch}
649
650 @emph{CRIS Options}
651 @gccoptlist{
652 -mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
653 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
654 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
655 -mstack-align -mdata-align -mconst-align @gol
656 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
657 -melf -maout -melinux -mlinux -sim -sim2}
658
659 @emph{PDP-11 Options}
660 @gccoptlist{
661 -mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
662 -mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
663 -mint16 -mno-int32 -mfloat32 -mno-float64 @gol
664 -mfloat64 -mno-float32 -mabshi -mno-abshi @gol
665 -mbranch-expensive -mbranch-cheap @gol
666 -msplit -mno-split -munix-asm -mdec-asm}
667
668 @emph{Xstormy16 Options}
669 @gccoptlist{
670 -msim}
671
672 @emph{Xtensa Options}
673 @gccoptlist{
674 -mbig-endian -mlittle-endian @gol
675 -mdensity -mno-density @gol
676 -mmac16 -mno-mac16 @gol
677 -mmul16 -mno-mul16 @gol
678 -mmul32 -mno-mul32 @gol
679 -mnsa -mno-nsa @gol
680 -mminmax -mno-minmax @gol
681 -msext -mno-sext @gol
682 -mbooleans -mno-booleans @gol
683 -mhard-float -msoft-float @gol
684 -mfused-madd -mno-fused-madd @gol
685 -mserialize-volatile -mno-serialize-volatile @gol
686 -mtext-section-literals -mno-text-section-literals @gol
687 -mtarget-align -mno-target-align @gol
688 -mlongcalls -mno-longcalls}
689
690 @emph{FRV Options}
691 @gccoptlist{
692 -mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 -mhard-float -msoft-float @gol
693 -malloc-cc -mfixed-cc -mdword -mno-dword -mdouble -mno-double @gol
694 -mmedia -mno-media -mmuladd -mno-muladd -mlibrary-pic -macc-4 @gol
695 -macc-8 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
696 -mscc -mno-scc -mcond-exec -mno-cond-exec -mvliw-branch -mno-vliw-branch @gol
697 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
698 -mno-nested-cond-exec -mtomcat-stats @gol
699 -mcpu=@var{cpu}}
700
701
702
703 @item Code Generation Options
704 @xref{Code Gen Options,,Options for Code Generation Conventions}.
705 @gccoptlist{
706 -fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
707 -ffixed-@var{reg} -fexceptions @gol
708 -fnon-call-exceptions -funwind-tables @gol
709 -fasynchronous-unwind-tables -fforced-unwind-exceptions @gol
710 -finhibit-size-directive -finstrument-functions @gol
711 -fno-common -fno-ident -fno-gnu-linker @gol
712 -fpcc-struct-return -fpic -fPIC @gol
713 -freg-struct-return -fshared-data -fshort-enums @gol
714 -fshort-double -fshort-wchar @gol
715 -fverbose-asm -fpack-struct -fstack-check @gol
716 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
717 -fargument-alias -fargument-noalias @gol
718 -fargument-noalias-global -fleading-underscore @gol
719 -ftls-model=@var{model} @gol
720 -ftrapv -fbounds-check}
721 @end table
722
723 @menu
724 * Overall Options:: Controlling the kind of output:
725 an executable, object files, assembler files,
726 or preprocessed source.
727 * C Dialect Options:: Controlling the variant of C language compiled.
728 * C++ Dialect Options:: Variations on C++.
729 * Objective-C Dialect Options:: Variations on Objective-C.
730 * Language Independent Options:: Controlling how diagnostics should be
731 formatted.
732 * Warning Options:: How picky should the compiler be?
733 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
734 * Optimize Options:: How much optimization?
735 * Preprocessor Options:: Controlling header files and macro definitions.
736 Also, getting dependency information for Make.
737 * Assembler Options:: Passing options to the assembler.
738 * Link Options:: Specifying libraries and so on.
739 * Directory Options:: Where to find header files and libraries.
740 Where to find the compiler executable files.
741 * Spec Files:: How to pass switches to sub-processes.
742 * Target Options:: Running a cross-compiler, or an old version of GCC.
743 @end menu
744
745 @node Overall Options
746 @section Options Controlling the Kind of Output
747
748 Compilation can involve up to four stages: preprocessing, compilation
749 proper, assembly and linking, always in that order. The first three
750 stages apply to an individual source file, and end by producing an
751 object file; linking combines all the object files (those newly
752 compiled, and those specified as input) into an executable file.
753
754 @cindex file name suffix
755 For any given input file, the file name suffix determines what kind of
756 compilation is done:
757
758 @table @gcctabopt
759 @item @var{file}.c
760 C source code which must be preprocessed.
761
762 @item @var{file}.i
763 C source code which should not be preprocessed.
764
765 @item @var{file}.ii
766 C++ source code which should not be preprocessed.
767
768 @item @var{file}.m
769 Objective-C source code. Note that you must link with the library
770 @file{libobjc.a} to make an Objective-C program work.
771
772 @item @var{file}.mi
773 Objective-C source code which should not be preprocessed.
774
775 @item @var{file}.h
776 C or C++ header file to be turned into a precompiled header.
777
778 @item @var{file}.cc
779 @itemx @var{file}.cp
780 @itemx @var{file}.cxx
781 @itemx @var{file}.cpp
782 @itemx @var{file}.CPP
783 @itemx @var{file}.c++
784 @itemx @var{file}.C
785 C++ source code which must be preprocessed. Note that in @samp{.cxx},
786 the last two letters must both be literally @samp{x}. Likewise,
787 @samp{.C} refers to a literal capital C@.
788
789 @item @var{file}.hh
790 @itemx @var{file}.H
791 C++ header file to be turned into a precompiled header.
792
793 @item @var{file}.f
794 @itemx @var{file}.for
795 @itemx @var{file}.FOR
796 Fortran source code which should not be preprocessed.
797
798 @item @var{file}.F
799 @itemx @var{file}.fpp
800 @itemx @var{file}.FPP
801 Fortran source code which must be preprocessed (with the traditional
802 preprocessor).
803
804 @item @var{file}.r
805 Fortran source code which must be preprocessed with a RATFOR
806 preprocessor (not included with GCC)@.
807
808 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
809 Using and Porting GNU Fortran}, for more details of the handling of
810 Fortran input files.
811
812 @c FIXME: Descriptions of Java file types.
813 @c @var{file}.java
814 @c @var{file}.class
815 @c @var{file}.zip
816 @c @var{file}.jar
817
818 @item @var{file}.ads
819 Ada source code file which contains a library unit declaration (a
820 declaration of a package, subprogram, or generic, or a generic
821 instantiation), or a library unit renaming declaration (a package,
822 generic, or subprogram renaming declaration). Such files are also
823 called @dfn{specs}.
824
825 @itemx @var{file}.adb
826 Ada source code file containing a library unit body (a subprogram or
827 package body). Such files are also called @dfn{bodies}.
828
829 @c GCC also knows about some suffixes for languages not yet included:
830 @c Pascal:
831 @c @var{file}.p
832 @c @var{file}.pas
833
834 @item @var{file}.s
835 Assembler code.
836
837 @item @var{file}.S
838 Assembler code which must be preprocessed.
839
840 @item @var{other}
841 An object file to be fed straight into linking.
842 Any file name with no recognized suffix is treated this way.
843 @end table
844
845 @opindex x
846 You can specify the input language explicitly with the @option{-x} option:
847
848 @table @gcctabopt
849 @item -x @var{language}
850 Specify explicitly the @var{language} for the following input files
851 (rather than letting the compiler choose a default based on the file
852 name suffix). This option applies to all following input files until
853 the next @option{-x} option. Possible values for @var{language} are:
854 @example
855 c c-header cpp-output
856 c++ c++-header c++-cpp-output
857 objective-c objc-cpp-output
858 assembler assembler-with-cpp
859 ada
860 f77 f77-cpp-input ratfor
861 java
862 treelang
863 @end example
864
865 @item -x none
866 Turn off any specification of a language, so that subsequent files are
867 handled according to their file name suffixes (as they are if @option{-x}
868 has not been used at all).
869
870 @item -pass-exit-codes
871 @opindex pass-exit-codes
872 Normally the @command{gcc} program will exit with the code of 1 if any
873 phase of the compiler returns a non-success return code. If you specify
874 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
875 numerically highest error produced by any phase that returned an error
876 indication.
877 @end table
878
879 If you only want some of the stages of compilation, you can use
880 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
881 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
882 @command{gcc} is to stop. Note that some combinations (for example,
883 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
884
885 @table @gcctabopt
886 @item -c
887 @opindex c
888 Compile or assemble the source files, but do not link. The linking
889 stage simply is not done. The ultimate output is in the form of an
890 object file for each source file.
891
892 By default, the object file name for a source file is made by replacing
893 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
894
895 Unrecognized input files, not requiring compilation or assembly, are
896 ignored.
897
898 @item -S
899 @opindex S
900 Stop after the stage of compilation proper; do not assemble. The output
901 is in the form of an assembler code file for each non-assembler input
902 file specified.
903
904 By default, the assembler file name for a source file is made by
905 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
906
907 Input files that don't require compilation are ignored.
908
909 @item -E
910 @opindex E
911 Stop after the preprocessing stage; do not run the compiler proper. The
912 output is in the form of preprocessed source code, which is sent to the
913 standard output.
914
915 Input files which don't require preprocessing are ignored.
916
917 @cindex output file option
918 @item -o @var{file}
919 @opindex o
920 Place output in file @var{file}. This applies regardless to whatever
921 sort of output is being produced, whether it be an executable file,
922 an object file, an assembler file or preprocessed C code.
923
924 Since only one output file can be specified, it does not make sense to
925 use @option{-o} when compiling more than one input file, unless you are
926 producing an executable file as output.
927
928 If @option{-o} is not specified, the default is to put an executable file
929 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
930 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
931 all preprocessed C source on standard output.
932
933 @item -v
934 @opindex v
935 Print (on standard error output) the commands executed to run the stages
936 of compilation. Also print the version number of the compiler driver
937 program and of the preprocessor and the compiler proper.
938
939 @item -###
940 @opindex ###
941 Like @option{-v} except the commands are not executed and all command
942 arguments are quoted. This is useful for shell scripts to capture the
943 driver-generated command lines.
944
945 @item -pipe
946 @opindex pipe
947 Use pipes rather than temporary files for communication between the
948 various stages of compilation. This fails to work on some systems where
949 the assembler is unable to read from a pipe; but the GNU assembler has
950 no trouble.
951
952 @item --help
953 @opindex help
954 Print (on the standard output) a description of the command line options
955 understood by @command{gcc}. If the @option{-v} option is also specified
956 then @option{--help} will also be passed on to the various processes
957 invoked by @command{gcc}, so that they can display the command line options
958 they accept. If the @option{-Wextra} option is also specified then command
959 line options which have no documentation associated with them will also
960 be displayed.
961
962 @item --target-help
963 @opindex target-help
964 Print (on the standard output) a description of target specific command
965 line options for each tool.
966
967 @item --version
968 @opindex version
969 Display the version number and copyrights of the invoked GCC.
970 @end table
971
972 @node Invoking G++
973 @section Compiling C++ Programs
974
975 @cindex suffixes for C++ source
976 @cindex C++ source file suffixes
977 C++ source files conventionally use one of the suffixes @samp{.C},
978 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
979 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
980 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
981 files with these names and compiles them as C++ programs even if you
982 call the compiler the same way as for compiling C programs (usually
983 with the name @command{gcc}).
984
985 @findex g++
986 @findex c++
987 However, C++ programs often require class libraries as well as a
988 compiler that understands the C++ language---and under some
989 circumstances, you might want to compile programs or header files from
990 standard input, or otherwise without a suffix that flags them as C++
991 programs. You might also like to precompile a C header file with a
992 @samp{.h} extension to be used in C++ compilations. @command{g++} is a
993 program that calls GCC with the default language set to C++, and
994 automatically specifies linking against the C++ library. On many
995 systems, @command{g++} is also installed with the name @command{c++}.
996
997 @cindex invoking @command{g++}
998 When you compile C++ programs, you may specify many of the same
999 command-line options that you use for compiling programs in any
1000 language; or command-line options meaningful for C and related
1001 languages; or options that are meaningful only for C++ programs.
1002 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1003 explanations of options for languages related to C@.
1004 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1005 explanations of options that are meaningful only for C++ programs.
1006
1007 @node C Dialect Options
1008 @section Options Controlling C Dialect
1009 @cindex dialect options
1010 @cindex language dialect options
1011 @cindex options, dialect
1012
1013 The following options control the dialect of C (or languages derived
1014 from C, such as C++ and Objective-C) that the compiler accepts:
1015
1016 @table @gcctabopt
1017 @cindex ANSI support
1018 @cindex ISO support
1019 @item -ansi
1020 @opindex ansi
1021 In C mode, support all ISO C90 programs. In C++ mode,
1022 remove GNU extensions that conflict with ISO C++.
1023
1024 This turns off certain features of GCC that are incompatible with ISO
1025 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1026 such as the @code{asm} and @code{typeof} keywords, and
1027 predefined macros such as @code{unix} and @code{vax} that identify the
1028 type of system you are using. It also enables the undesirable and
1029 rarely used ISO trigraph feature. For the C compiler,
1030 it disables recognition of C++ style @samp{//} comments as well as
1031 the @code{inline} keyword.
1032
1033 The alternate keywords @code{__asm__}, @code{__extension__},
1034 @code{__inline__} and @code{__typeof__} continue to work despite
1035 @option{-ansi}. You would not want to use them in an ISO C program, of
1036 course, but it is useful to put them in header files that might be included
1037 in compilations done with @option{-ansi}. Alternate predefined macros
1038 such as @code{__unix__} and @code{__vax__} are also available, with or
1039 without @option{-ansi}.
1040
1041 The @option{-ansi} option does not cause non-ISO programs to be
1042 rejected gratuitously. For that, @option{-pedantic} is required in
1043 addition to @option{-ansi}. @xref{Warning Options}.
1044
1045 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1046 option is used. Some header files may notice this macro and refrain
1047 from declaring certain functions or defining certain macros that the
1048 ISO standard doesn't call for; this is to avoid interfering with any
1049 programs that might use these names for other things.
1050
1051 Functions which would normally be built in but do not have semantics
1052 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1053 functions with @option{-ansi} is used. @xref{Other Builtins,,Other
1054 built-in functions provided by GCC}, for details of the functions
1055 affected.
1056
1057 @item -std=
1058 @opindex std
1059 Determine the language standard. This option is currently only
1060 supported when compiling C or C++. A value for this option must be
1061 provided; possible values are
1062
1063 @table @samp
1064 @item c89
1065 @itemx iso9899:1990
1066 ISO C90 (same as @option{-ansi}).
1067
1068 @item iso9899:199409
1069 ISO C90 as modified in amendment 1.
1070
1071 @item c99
1072 @itemx c9x
1073 @itemx iso9899:1999
1074 @itemx iso9899:199x
1075 ISO C99. Note that this standard is not yet fully supported; see
1076 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1077 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1078
1079 @item gnu89
1080 Default, ISO C90 plus GNU extensions (including some C99 features).
1081
1082 @item gnu99
1083 @item gnu9x
1084 ISO C99 plus GNU extensions. When ISO C99 is fully implemented in GCC,
1085 this will become the default. The name @samp{gnu9x} is deprecated.
1086
1087 @item c++98
1088 The 1998 ISO C++ standard plus amendments.
1089
1090 @item gnu++98
1091 The same as @option{-std=c++98} plus GNU extensions. This is the
1092 default for C++ code.
1093 @end table
1094
1095 Even when this option is not specified, you can still use some of the
1096 features of newer standards in so far as they do not conflict with
1097 previous C standards. For example, you may use @code{__restrict__} even
1098 when @option{-std=c99} is not specified.
1099
1100 The @option{-std} options specifying some version of ISO C have the same
1101 effects as @option{-ansi}, except that features that were not in ISO C90
1102 but are in the specified version (for example, @samp{//} comments and
1103 the @code{inline} keyword in ISO C99) are not disabled.
1104
1105 @xref{Standards,,Language Standards Supported by GCC}, for details of
1106 these standard versions.
1107
1108 @item -aux-info @var{filename}
1109 @opindex aux-info
1110 Output to the given filename prototyped declarations for all functions
1111 declared and/or defined in a translation unit, including those in header
1112 files. This option is silently ignored in any language other than C@.
1113
1114 Besides declarations, the file indicates, in comments, the origin of
1115 each declaration (source file and line), whether the declaration was
1116 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1117 @samp{O} for old, respectively, in the first character after the line
1118 number and the colon), and whether it came from a declaration or a
1119 definition (@samp{C} or @samp{F}, respectively, in the following
1120 character). In the case of function definitions, a K&R-style list of
1121 arguments followed by their declarations is also provided, inside
1122 comments, after the declaration.
1123
1124 @item -fno-asm
1125 @opindex fno-asm
1126 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1127 keyword, so that code can use these words as identifiers. You can use
1128 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1129 instead. @option{-ansi} implies @option{-fno-asm}.
1130
1131 In C++, this switch only affects the @code{typeof} keyword, since
1132 @code{asm} and @code{inline} are standard keywords. You may want to
1133 use the @option{-fno-gnu-keywords} flag instead, which has the same
1134 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1135 switch only affects the @code{asm} and @code{typeof} keywords, since
1136 @code{inline} is a standard keyword in ISO C99.
1137
1138 @item -fno-builtin
1139 @itemx -fno-builtin-@var{function}
1140 @opindex fno-builtin
1141 @cindex built-in functions
1142 Don't recognize built-in functions that do not begin with
1143 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
1144 functions provided by GCC}, for details of the functions affected,
1145 including those which are not built-in functions when @option{-ansi} or
1146 @option{-std} options for strict ISO C conformance are used because they
1147 do not have an ISO standard meaning.
1148
1149 GCC normally generates special code to handle certain built-in functions
1150 more efficiently; for instance, calls to @code{alloca} may become single
1151 instructions that adjust the stack directly, and calls to @code{memcpy}
1152 may become inline copy loops. The resulting code is often both smaller
1153 and faster, but since the function calls no longer appear as such, you
1154 cannot set a breakpoint on those calls, nor can you change the behavior
1155 of the functions by linking with a different library.
1156
1157 With the @option{-fno-builtin-@var{function}} option
1158 only the built-in function @var{function} is
1159 disabled. @var{function} must not begin with @samp{__builtin_}. If a
1160 function is named this is not built-in in this version of GCC, this
1161 option is ignored. There is no corresponding
1162 @option{-fbuiltin-@var{function}} option; if you wish to enable
1163 built-in functions selectively when using @option{-fno-builtin} or
1164 @option{-ffreestanding}, you may define macros such as:
1165
1166 @smallexample
1167 #define abs(n) __builtin_abs ((n))
1168 #define strcpy(d, s) __builtin_strcpy ((d), (s))
1169 @end smallexample
1170
1171 @item -fhosted
1172 @opindex fhosted
1173 @cindex hosted environment
1174
1175 Assert that compilation takes place in a hosted environment. This implies
1176 @option{-fbuiltin}. A hosted environment is one in which the
1177 entire standard library is available, and in which @code{main} has a return
1178 type of @code{int}. Examples are nearly everything except a kernel.
1179 This is equivalent to @option{-fno-freestanding}.
1180
1181 @item -ffreestanding
1182 @opindex ffreestanding
1183 @cindex hosted environment
1184
1185 Assert that compilation takes place in a freestanding environment. This
1186 implies @option{-fno-builtin}. A freestanding environment
1187 is one in which the standard library may not exist, and program startup may
1188 not necessarily be at @code{main}. The most obvious example is an OS kernel.
1189 This is equivalent to @option{-fno-hosted}.
1190
1191 @xref{Standards,,Language Standards Supported by GCC}, for details of
1192 freestanding and hosted environments.
1193
1194 @item -fms-extensions
1195 @opindex fms-extensions
1196 Accept some non-standard constructs used in Microsoft header files.
1197
1198 @item -trigraphs
1199 @opindex trigraphs
1200 Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1201 options for strict ISO C conformance) implies @option{-trigraphs}.
1202
1203 @item -no-integrated-cpp
1204 @opindex no-integrated-cpp
1205 Performs a compilation in two passes: preprocessing and compiling. This
1206 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1207 @option{-B} option. The user supplied compilation step can then add in
1208 an additional preprocessing step after normal preprocessing but before
1209 compiling. The default is to use the integrated cpp (internal cpp)
1210
1211 The semantics of this option will change if "cc1", "cc1plus", and
1212 "cc1obj" are merged.
1213
1214 @cindex traditional C language
1215 @cindex C language, traditional
1216 @item -traditional
1217 @itemx -traditional-cpp
1218 @opindex traditional-cpp
1219 @opindex traditional
1220 Formerly, these options caused GCC to attempt to emulate a pre-standard
1221 C compiler. They are now only supported with the @option{-E} switch.
1222 The preprocessor continues to support a pre-standard mode. See the GNU
1223 CPP manual for details.
1224
1225 @item -fcond-mismatch
1226 @opindex fcond-mismatch
1227 Allow conditional expressions with mismatched types in the second and
1228 third arguments. The value of such an expression is void. This option
1229 is not supported for C++.
1230
1231 @item -funsigned-char
1232 @opindex funsigned-char
1233 Let the type @code{char} be unsigned, like @code{unsigned char}.
1234
1235 Each kind of machine has a default for what @code{char} should
1236 be. It is either like @code{unsigned char} by default or like
1237 @code{signed char} by default.
1238
1239 Ideally, a portable program should always use @code{signed char} or
1240 @code{unsigned char} when it depends on the signedness of an object.
1241 But many programs have been written to use plain @code{char} and
1242 expect it to be signed, or expect it to be unsigned, depending on the
1243 machines they were written for. This option, and its inverse, let you
1244 make such a program work with the opposite default.
1245
1246 The type @code{char} is always a distinct type from each of
1247 @code{signed char} or @code{unsigned char}, even though its behavior
1248 is always just like one of those two.
1249
1250 @item -fsigned-char
1251 @opindex fsigned-char
1252 Let the type @code{char} be signed, like @code{signed char}.
1253
1254 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1255 the negative form of @option{-funsigned-char}. Likewise, the option
1256 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1257
1258 @item -fsigned-bitfields
1259 @itemx -funsigned-bitfields
1260 @itemx -fno-signed-bitfields
1261 @itemx -fno-unsigned-bitfields
1262 @opindex fsigned-bitfields
1263 @opindex funsigned-bitfields
1264 @opindex fno-signed-bitfields
1265 @opindex fno-unsigned-bitfields
1266 These options control whether a bit-field is signed or unsigned, when the
1267 declaration does not use either @code{signed} or @code{unsigned}. By
1268 default, such a bit-field is signed, because this is consistent: the
1269 basic integer types such as @code{int} are signed types.
1270
1271 @item -fwritable-strings
1272 @opindex fwritable-strings
1273 Store string constants in the writable data segment and don't uniquize
1274 them. This is for compatibility with old programs which assume they can
1275 write into string constants.
1276
1277 Writing into string constants is a very bad idea; ``constants'' should
1278 be constant.
1279 @end table
1280
1281 @node C++ Dialect Options
1282 @section Options Controlling C++ Dialect
1283
1284 @cindex compiler options, C++
1285 @cindex C++ options, command line
1286 @cindex options, C++
1287 This section describes the command-line options that are only meaningful
1288 for C++ programs; but you can also use most of the GNU compiler options
1289 regardless of what language your program is in. For example, you
1290 might compile a file @code{firstClass.C} like this:
1291
1292 @example
1293 g++ -g -frepo -O -c firstClass.C
1294 @end example
1295
1296 @noindent
1297 In this example, only @option{-frepo} is an option meant
1298 only for C++ programs; you can use the other options with any
1299 language supported by GCC@.
1300
1301 Here is a list of options that are @emph{only} for compiling C++ programs:
1302
1303 @table @gcctabopt
1304
1305 @item -fabi-version=@var{n}
1306 @opindex fabi-version
1307 Use version @var{n} of the C++ ABI. Version 1 is the version of the C++
1308 ABI that first appeared in G++ 3.2. Version 0 will always be the
1309 version that conforms most closely to the C++ ABI specification.
1310 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1311 fixed.
1312
1313 The default is version 1.
1314
1315 @item -fno-access-control
1316 @opindex fno-access-control
1317 Turn off all access checking. This switch is mainly useful for working
1318 around bugs in the access control code.
1319
1320 @item -fcheck-new
1321 @opindex fcheck-new
1322 Check that the pointer returned by @code{operator new} is non-null
1323 before attempting to modify the storage allocated. The current Working
1324 Paper requires that @code{operator new} never return a null pointer, so
1325 this check is normally unnecessary.
1326
1327 An alternative to using this option is to specify that your
1328 @code{operator new} does not throw any exceptions; if you declare it
1329 @samp{throw()}, G++ will check the return value. See also @samp{new
1330 (nothrow)}.
1331
1332 @item -fconserve-space
1333 @opindex fconserve-space
1334 Put uninitialized or runtime-initialized global variables into the
1335 common segment, as C does. This saves space in the executable at the
1336 cost of not diagnosing duplicate definitions. If you compile with this
1337 flag and your program mysteriously crashes after @code{main()} has
1338 completed, you may have an object that is being destroyed twice because
1339 two definitions were merged.
1340
1341 This option is no longer useful on most targets, now that support has
1342 been added for putting variables into BSS without making them common.
1343
1344 @item -fno-const-strings
1345 @opindex fno-const-strings
1346 Give string constants type @code{char *} instead of type @code{const
1347 char *}. By default, G++ uses type @code{const char *} as required by
1348 the standard. Even if you use @option{-fno-const-strings}, you cannot
1349 actually modify the value of a string constant, unless you also use
1350 @option{-fwritable-strings}.
1351
1352 This option might be removed in a future release of G++. For maximum
1353 portability, you should structure your code so that it works with
1354 string constants that have type @code{const char *}.
1355
1356 @item -fdollars-in-identifiers
1357 @opindex fdollars-in-identifiers
1358 Accept @samp{$} in identifiers. You can also explicitly prohibit use of
1359 @samp{$} with the option @option{-fno-dollars-in-identifiers}. (GNU C allows
1360 @samp{$} by default on most target systems, but there are a few exceptions.)
1361 Traditional C allowed the character @samp{$} to form part of
1362 identifiers. However, ISO C and C++ forbid @samp{$} in identifiers.
1363
1364 @item -fno-elide-constructors
1365 @opindex fno-elide-constructors
1366 The C++ standard allows an implementation to omit creating a temporary
1367 which is only used to initialize another object of the same type.
1368 Specifying this option disables that optimization, and forces G++ to
1369 call the copy constructor in all cases.
1370
1371 @item -fno-enforce-eh-specs
1372 @opindex fno-enforce-eh-specs
1373 Don't check for violation of exception specifications at runtime. This
1374 option violates the C++ standard, but may be useful for reducing code
1375 size in production builds, much like defining @samp{NDEBUG}. The compiler
1376 will still optimize based on the exception specifications.
1377
1378 @item -fexternal-templates
1379 @opindex fexternal-templates
1380
1381 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1382 template instantiation; template instances are emitted or not according
1383 to the location of the template definition. @xref{Template
1384 Instantiation}, for more information.
1385
1386 This option is deprecated.
1387
1388 @item -falt-external-templates
1389 @opindex falt-external-templates
1390 Similar to @option{-fexternal-templates}, but template instances are
1391 emitted or not according to the place where they are first instantiated.
1392 @xref{Template Instantiation}, for more information.
1393
1394 This option is deprecated.
1395
1396 @item -ffor-scope
1397 @itemx -fno-for-scope
1398 @opindex ffor-scope
1399 @opindex fno-for-scope
1400 If @option{-ffor-scope} is specified, the scope of variables declared in
1401 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1402 as specified by the C++ standard.
1403 If @option{-fno-for-scope} is specified, the scope of variables declared in
1404 a @i{for-init-statement} extends to the end of the enclosing scope,
1405 as was the case in old versions of G++, and other (traditional)
1406 implementations of C++.
1407
1408 The default if neither flag is given to follow the standard,
1409 but to allow and give a warning for old-style code that would
1410 otherwise be invalid, or have different behavior.
1411
1412 @item -fno-gnu-keywords
1413 @opindex fno-gnu-keywords
1414 Do not recognize @code{typeof} as a keyword, so that code can use this
1415 word as an identifier. You can use the keyword @code{__typeof__} instead.
1416 @option{-ansi} implies @option{-fno-gnu-keywords}.
1417
1418 @item -fno-implicit-templates
1419 @opindex fno-implicit-templates
1420 Never emit code for non-inline templates which are instantiated
1421 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1422 @xref{Template Instantiation}, for more information.
1423
1424 @item -fno-implicit-inline-templates
1425 @opindex fno-implicit-inline-templates
1426 Don't emit code for implicit instantiations of inline templates, either.
1427 The default is to handle inlines differently so that compiles with and
1428 without optimization will need the same set of explicit instantiations.
1429
1430 @item -fno-implement-inlines
1431 @opindex fno-implement-inlines
1432 To save space, do not emit out-of-line copies of inline functions
1433 controlled by @samp{#pragma implementation}. This will cause linker
1434 errors if these functions are not inlined everywhere they are called.
1435
1436 @item -fms-extensions
1437 @opindex fms-extensions
1438 Disable pedantic warnings about constructs used in MFC, such as implicit
1439 int and getting a pointer to member function via non-standard syntax.
1440
1441 @item -fno-nonansi-builtins
1442 @opindex fno-nonansi-builtins
1443 Disable built-in declarations of functions that are not mandated by
1444 ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
1445 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1446
1447 @item -fno-operator-names
1448 @opindex fno-operator-names
1449 Do not treat the operator name keywords @code{and}, @code{bitand},
1450 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1451 synonyms as keywords.
1452
1453 @item -fno-optional-diags
1454 @opindex fno-optional-diags
1455 Disable diagnostics that the standard says a compiler does not need to
1456 issue. Currently, the only such diagnostic issued by G++ is the one for
1457 a name having multiple meanings within a class.
1458
1459 @item -fpermissive
1460 @opindex fpermissive
1461 Downgrade messages about nonconformant code from errors to warnings. By
1462 default, G++ effectively sets @option{-pedantic-errors} without
1463 @option{-pedantic}; this option reverses that. This behavior and this
1464 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1465
1466 @item -frepo
1467 @opindex frepo
1468 Enable automatic template instantiation at link time. This option also
1469 implies @option{-fno-implicit-templates}. @xref{Template
1470 Instantiation}, for more information.
1471
1472 @item -fno-rtti
1473 @opindex fno-rtti
1474 Disable generation of information about every class with virtual
1475 functions for use by the C++ runtime type identification features
1476 (@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1477 of the language, you can save some space by using this flag. Note that
1478 exception handling uses the same information, but it will generate it as
1479 needed.
1480
1481 @item -fstats
1482 @opindex fstats
1483 Emit statistics about front-end processing at the end of the compilation.
1484 This information is generally only useful to the G++ development team.
1485
1486 @item -ftemplate-depth-@var{n}
1487 @opindex ftemplate-depth
1488 Set the maximum instantiation depth for template classes to @var{n}.
1489 A limit on the template instantiation depth is needed to detect
1490 endless recursions during template class instantiation. ANSI/ISO C++
1491 conforming programs must not rely on a maximum depth greater than 17.
1492
1493 @item -fuse-cxa-atexit
1494 @opindex fuse-cxa-atexit
1495 Register destructors for objects with static storage duration with the
1496 @code{__cxa_atexit} function rather than the @code{atexit} function.
1497 This option is required for fully standards-compliant handling of static
1498 destructors, but will only work if your C library supports
1499 @code{__cxa_atexit}.
1500
1501 @item -fvtable-gc
1502 @opindex fvtable-gc
1503 Emit special relocations for vtables and virtual function references
1504 so that the linker can identify unused virtual functions and zero out
1505 vtable slots that refer to them. This is most useful with
1506 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1507 also discard the functions themselves.
1508
1509 This optimization requires GNU as and GNU ld. Not all systems support
1510 this option. @option{-Wl,--gc-sections} is ignored without @option{-static}.
1511
1512 @item -fno-weak
1513 @opindex fno-weak
1514 Do not use weak symbol support, even if it is provided by the linker.
1515 By default, G++ will use weak symbols if they are available. This
1516 option exists only for testing, and should not be used by end-users;
1517 it will result in inferior code and has no benefits. This option may
1518 be removed in a future release of G++.
1519
1520 @item -nostdinc++
1521 @opindex nostdinc++
1522 Do not search for header files in the standard directories specific to
1523 C++, but do still search the other standard directories. (This option
1524 is used when building the C++ library.)
1525 @end table
1526
1527 In addition, these optimization, warning, and code generation options
1528 have meanings only for C++ programs:
1529
1530 @table @gcctabopt
1531 @item -fno-default-inline
1532 @opindex fno-default-inline
1533 Do not assume @samp{inline} for functions defined inside a class scope.
1534 @xref{Optimize Options,,Options That Control Optimization}. Note that these
1535 functions will have linkage like inline functions; they just won't be
1536 inlined by default.
1537
1538 @item -Wabi @r{(C++ only)}
1539 @opindex Wabi
1540 Warn when G++ generates code that is probably not compatible with the
1541 vendor-neutral C++ ABI. Although an effort has been made to warn about
1542 all such cases, there are probably some cases that are not warned about,
1543 even though G++ is generating incompatible code. There may also be
1544 cases where warnings are emitted even though the code that is generated
1545 will be compatible.
1546
1547 You should rewrite your code to avoid these warnings if you are
1548 concerned about the fact that code generated by G++ may not be binary
1549 compatible with code generated by other compilers.
1550
1551 The known incompatibilities at this point include:
1552
1553 @itemize @bullet
1554
1555 @item
1556 Incorrect handling of tail-padding for bit-fields. G++ may attempt to
1557 pack data into the same byte as a base class. For example:
1558
1559 @smallexample
1560 struct A @{ virtual void f(); int f1 : 1; @};
1561 struct B : public A @{ int f2 : 1; @};
1562 @end smallexample
1563
1564 @noindent
1565 In this case, G++ will place @code{B::f2} into the same byte
1566 as@code{A::f1}; other compilers will not. You can avoid this problem
1567 by explicitly padding @code{A} so that its size is a multiple of the
1568 byte size on your platform; that will cause G++ and other compilers to
1569 layout @code{B} identically.
1570
1571 @item
1572 Incorrect handling of tail-padding for virtual bases. G++ does not use
1573 tail padding when laying out virtual bases. For example:
1574
1575 @smallexample
1576 struct A @{ virtual void f(); char c1; @};
1577 struct B @{ B(); char c2; @};
1578 struct C : public A, public virtual B @{@};
1579 @end smallexample
1580
1581 @noindent
1582 In this case, G++ will not place @code{B} into the tail-padding for
1583 @code{A}; other compilers will. You can avoid this problem by
1584 explicitly padding @code{A} so that its size is a multiple of its
1585 alignment (ignoring virtual base classes); that will cause G++ and other
1586 compilers to layout @code{C} identically.
1587
1588 @item
1589 Incorrect handling of bit-fields with declared widths greater than that
1590 of their underlying types, when the bit-fields appear in a union. For
1591 example:
1592
1593 @smallexample
1594 union U @{ int i : 4096; @};
1595 @end smallexample
1596
1597 @noindent
1598 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1599 union too small by the number of bits in an @code{int}.
1600
1601 @item
1602 Empty classes can be placed at incorrect offsets. For example:
1603
1604 @smallexample
1605 struct A @{@};
1606
1607 struct B @{
1608 A a;
1609 virtual void f ();
1610 @};
1611
1612 struct C : public B, public A @{@};
1613 @end smallexample
1614
1615 @noindent
1616 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1617 it should be placed at offset zero. G++ mistakenly believes that the
1618 @code{A} data member of @code{B} is already at offset zero.
1619
1620 @item
1621 Names of template functions whose types involve @code{typename} or
1622 template template parameters can be mangled incorrectly.
1623
1624 @smallexample
1625 template <typename Q>
1626 void f(typename Q::X) @{@}
1627
1628 template <template <typename> class Q>
1629 void f(typename Q<int>::X) @{@}
1630 @end smallexample
1631
1632 @noindent
1633 Instantiations of these templates may be mangled incorrectly.
1634
1635 @end itemize
1636
1637 @item -Wctor-dtor-privacy @r{(C++ only)}
1638 @opindex Wctor-dtor-privacy
1639 Warn when a class seems unusable, because all the constructors or
1640 destructors in a class are private and the class has no friends or
1641 public static member functions. This warning is enabled by default.
1642
1643 @item -Wnon-virtual-dtor @r{(C++ only)}
1644 @opindex Wnon-virtual-dtor
1645 Warn when a class declares a non-virtual destructor that should probably
1646 be virtual, because it looks like the class will be used polymorphically.
1647 This warning is enabled by @option{-Wall}.
1648
1649 @item -Wreorder @r{(C++ only)}
1650 @opindex Wreorder
1651 @cindex reordering, warning
1652 @cindex warning for reordering of member initializers
1653 Warn when the order of member initializers given in the code does not
1654 match the order in which they must be executed. For instance:
1655
1656 @smallexample
1657 struct A @{
1658 int i;
1659 int j;
1660 A(): j (0), i (1) @{ @}
1661 @};
1662 @end smallexample
1663
1664 Here the compiler will warn that the member initializers for @samp{i}
1665 and @samp{j} will be rearranged to match the declaration order of the
1666 members. This warning is enabled by @option{-Wall}.
1667 @end table
1668
1669 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1670
1671 @table @gcctabopt
1672 @item -Weffc++ @r{(C++ only)}
1673 @opindex Weffc++
1674 Warn about violations of the following style guidelines from Scott Meyers'
1675 @cite{Effective C++} book:
1676
1677 @itemize @bullet
1678 @item
1679 Item 11: Define a copy constructor and an assignment operator for classes
1680 with dynamically allocated memory.
1681
1682 @item
1683 Item 12: Prefer initialization to assignment in constructors.
1684
1685 @item
1686 Item 14: Make destructors virtual in base classes.
1687
1688 @item
1689 Item 15: Have @code{operator=} return a reference to @code{*this}.
1690
1691 @item
1692 Item 23: Don't try to return a reference when you must return an object.
1693
1694 @end itemize
1695
1696 and about violations of the following style guidelines from Scott Meyers'
1697 @cite{More Effective C++} book:
1698
1699 @itemize @bullet
1700 @item
1701 Item 6: Distinguish between prefix and postfix forms of increment and
1702 decrement operators.
1703
1704 @item
1705 Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
1706
1707 @end itemize
1708
1709 If you use this option, you should be aware that the standard library
1710 headers do not obey all of these guidelines; you can use @samp{grep -v}
1711 to filter out those warnings.
1712
1713 @item -Wno-deprecated @r{(C++ only)}
1714 @opindex Wno-deprecated
1715 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1716
1717 @item -Wno-non-template-friend @r{(C++ only)}
1718 @opindex Wno-non-template-friend
1719 Disable warnings when non-templatized friend functions are declared
1720 within a template. With the advent of explicit template specification
1721 support in G++, if the name of the friend is an unqualified-id (i.e.,
1722 @samp{friend foo(int)}), the C++ language specification demands that the
1723 friend declare or define an ordinary, nontemplate function. (Section
1724 14.5.3). Before G++ implemented explicit specification, unqualified-ids
1725 could be interpreted as a particular specialization of a templatized
1726 function. Because this non-conforming behavior is no longer the default
1727 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1728 check existing code for potential trouble spots, and is on by default.
1729 This new compiler behavior can be turned off with
1730 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1731 but disables the helpful warning.
1732
1733 @item -Wold-style-cast @r{(C++ only)}
1734 @opindex Wold-style-cast
1735 Warn if an old-style (C-style) cast to a non-void type is used within
1736 a C++ program. The new-style casts (@samp{static_cast},
1737 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1738 unintended effects, and much easier to grep for.
1739
1740 @item -Woverloaded-virtual @r{(C++ only)}
1741 @opindex Woverloaded-virtual
1742 @cindex overloaded virtual fn, warning
1743 @cindex warning for overloaded virtual fn
1744 Warn when a function declaration hides virtual functions from a
1745 base class. For example, in:
1746
1747 @smallexample
1748 struct A @{
1749 virtual void f();
1750 @};
1751
1752 struct B: public A @{
1753 void f(int);
1754 @};
1755 @end smallexample
1756
1757 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1758 like this:
1759
1760 @smallexample
1761 B* b;
1762 b->f();
1763 @end smallexample
1764
1765 will fail to compile.
1766
1767 @item -Wno-pmf-conversions @r{(C++ only)}
1768 @opindex Wno-pmf-conversions
1769 Disable the diagnostic for converting a bound pointer to member function
1770 to a plain pointer.
1771
1772 @item -Wsign-promo @r{(C++ only)}
1773 @opindex Wsign-promo
1774 Warn when overload resolution chooses a promotion from unsigned or
1775 enumeral type to a signed type over a conversion to an unsigned type of
1776 the same size. Previous versions of G++ would try to preserve
1777 unsignedness, but the standard mandates the current behavior.
1778
1779 @item -Wsynth @r{(C++ only)}
1780 @opindex Wsynth
1781 @cindex warning for synthesized methods
1782 @cindex synthesized methods, warning
1783 Warn when G++'s synthesis behavior does not match that of cfront. For
1784 instance:
1785
1786 @smallexample
1787 struct A @{
1788 operator int ();
1789 A& operator = (int);
1790 @};
1791
1792 main ()
1793 @{
1794 A a,b;
1795 a = b;
1796 @}
1797 @end smallexample
1798
1799 In this example, G++ will synthesize a default @samp{A& operator =
1800 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1801 @end table
1802
1803 @node Objective-C Dialect Options
1804 @section Options Controlling Objective-C Dialect
1805
1806 @cindex compiler options, Objective-C
1807 @cindex Objective-C options, command line
1808 @cindex options, Objective-C
1809 This section describes the command-line options that are only meaningful
1810 for Objective-C programs; but you can also use most of the GNU compiler
1811 options regardless of what language your program is in. For example,
1812 you might compile a file @code{some_class.m} like this:
1813
1814 @example
1815 gcc -g -fgnu-runtime -O -c some_class.m
1816 @end example
1817
1818 @noindent
1819 In this example, only @option{-fgnu-runtime} is an option meant only for
1820 Objective-C programs; you can use the other options with any language
1821 supported by GCC@.
1822
1823 Here is a list of options that are @emph{only} for compiling Objective-C
1824 programs:
1825
1826 @table @gcctabopt
1827 @item -fconstant-string-class=@var{class-name}
1828 @opindex fconstant-string-class
1829 Use @var{class-name} as the name of the class to instantiate for each
1830 literal string specified with the syntax @code{@@"@dots{}"}. The default
1831 class name is @code{NXConstantString}.
1832
1833 @item -fgnu-runtime
1834 @opindex fgnu-runtime
1835 Generate object code compatible with the standard GNU Objective-C
1836 runtime. This is the default for most types of systems.
1837
1838 @item -fnext-runtime
1839 @opindex fnext-runtime
1840 Generate output compatible with the NeXT runtime. This is the default
1841 for NeXT-based systems, including Darwin and Mac OS X@. The macro
1842 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1843 used.
1844
1845 @item -gen-decls
1846 @opindex gen-decls
1847 Dump interface declarations for all classes seen in the source file to a
1848 file named @file{@var{sourcename}.decl}.
1849
1850 @item -Wno-protocol
1851 @opindex Wno-protocol
1852 If a class is declared to implement a protocol, a warning is issued for
1853 every method in the protocol that is not implemented by the class. The
1854 default behavior is to issue a warning for every method not explicitly
1855 implemented in the class, even if a method implementation is inherited
1856 from the superclass. If you use the @code{-Wno-protocol} option, then
1857 methods inherited from the superclass are considered to be implemented,
1858 and no warning is issued for them.
1859
1860 @item -Wselector
1861 @opindex Wselector
1862 Warn if multiple methods of different types for the same selector are
1863 found during compilation. The check is performed on the list of methods
1864 in the final stage of compilation. Additionally, a check is performed
1865 that for each selector appearing in a @code{@@selector(@dots{})}
1866 expression, a corresponding method with that selector has been found
1867 during compilation. Because these checks scan the method table only at
1868 the end of compilation, these warnings are not produced if the final
1869 stage of compilation is not reached, for example because an error is
1870 found during compilation, or because the @code{-fsyntax-only} option is
1871 being used.
1872
1873 @item -Wundeclared-selector
1874 @opindex Wundeclared-selector
1875 Warn if a @code{@@selector(@dots{})} expression referring to an
1876 undeclared selector is found. A selector is considered undeclared if no
1877 method with that name has been declared (explicitly, in an
1878 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1879 an @code{@@implementation} section) before the
1880 @code{@@selector(@dots{})} expression. This option always performs its
1881 checks as soon as a @code{@@selector(@dots{})} expression is found
1882 (while @code{-Wselector} only performs its checks in the final stage of
1883 compilation), and so additionally enforces the coding style convention
1884 that methods and selectors must be declared before being used.
1885
1886 @c not documented because only avail via -Wp
1887 @c @item -print-objc-runtime-info
1888
1889 @end table
1890
1891 @node Language Independent Options
1892 @section Options to Control Diagnostic Messages Formatting
1893 @cindex options to control diagnostics formatting
1894 @cindex diagnostic messages
1895 @cindex message formatting
1896
1897 Traditionally, diagnostic messages have been formatted irrespective of
1898 the output device's aspect (e.g.@: its width, @dots{}). The options described
1899 below can be used to control the diagnostic messages formatting
1900 algorithm, e.g.@: how many characters per line, how often source location
1901 information should be reported. Right now, only the C++ front end can
1902 honor these options. However it is expected, in the near future, that
1903 the remaining front ends would be able to digest them correctly.
1904
1905 @table @gcctabopt
1906 @item -fmessage-length=@var{n}
1907 @opindex fmessage-length
1908 Try to format error messages so that they fit on lines of about @var{n}
1909 characters. The default is 72 characters for @command{g++} and 0 for the rest of
1910 the front ends supported by GCC@. If @var{n} is zero, then no
1911 line-wrapping will be done; each error message will appear on a single
1912 line.
1913
1914 @opindex fdiagnostics-show-location
1915 @item -fdiagnostics-show-location=once
1916 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
1917 reporter to emit @emph{once} source location information; that is, in
1918 case the message is too long to fit on a single physical line and has to
1919 be wrapped, the source location won't be emitted (as prefix) again,
1920 over and over, in subsequent continuation lines. This is the default
1921 behavior.
1922
1923 @item -fdiagnostics-show-location=every-line
1924 Only meaningful in line-wrapping mode. Instructs the diagnostic
1925 messages reporter to emit the same source location information (as
1926 prefix) for physical lines that result from the process of breaking
1927 a message which is too long to fit on a single line.
1928
1929 @end table
1930
1931 @node Warning Options
1932 @section Options to Request or Suppress Warnings
1933 @cindex options to control warnings
1934 @cindex warning messages
1935 @cindex messages, warning
1936 @cindex suppressing warnings
1937
1938 Warnings are diagnostic messages that report constructions which
1939 are not inherently erroneous but which are risky or suggest there
1940 may have been an error.
1941
1942 You can request many specific warnings with options beginning @samp{-W},
1943 for example @option{-Wimplicit} to request warnings on implicit
1944 declarations. Each of these specific warning options also has a
1945 negative form beginning @samp{-Wno-} to turn off warnings;
1946 for example, @option{-Wno-implicit}. This manual lists only one of the
1947 two forms, whichever is not the default.
1948
1949 The following options control the amount and kinds of warnings produced
1950 by GCC; for further, language-specific options also refer to
1951 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1952
1953 @table @gcctabopt
1954 @cindex syntax checking
1955 @item -fsyntax-only
1956 @opindex fsyntax-only
1957 Check the code for syntax errors, but don't do anything beyond that.
1958
1959 @item -pedantic
1960 @opindex pedantic
1961 Issue all the warnings demanded by strict ISO C and ISO C++;
1962 reject all programs that use forbidden extensions, and some other
1963 programs that do not follow ISO C and ISO C++. For ISO C, follows the
1964 version of the ISO C standard specified by any @option{-std} option used.
1965
1966 Valid ISO C and ISO C++ programs should compile properly with or without
1967 this option (though a rare few will require @option{-ansi} or a
1968 @option{-std} option specifying the required version of ISO C)@. However,
1969 without this option, certain GNU extensions and traditional C and C++
1970 features are supported as well. With this option, they are rejected.
1971
1972 @option{-pedantic} does not cause warning messages for use of the
1973 alternate keywords whose names begin and end with @samp{__}. Pedantic
1974 warnings are also disabled in the expression that follows
1975 @code{__extension__}. However, only system header files should use
1976 these escape routes; application programs should avoid them.
1977 @xref{Alternate Keywords}.
1978
1979 Some users try to use @option{-pedantic} to check programs for strict ISO
1980 C conformance. They soon find that it does not do quite what they want:
1981 it finds some non-ISO practices, but not all---only those for which
1982 ISO C @emph{requires} a diagnostic, and some others for which
1983 diagnostics have been added.
1984
1985 A feature to report any failure to conform to ISO C might be useful in
1986 some instances, but would require considerable additional work and would
1987 be quite different from @option{-pedantic}. We don't have plans to
1988 support such a feature in the near future.
1989
1990 Where the standard specified with @option{-std} represents a GNU
1991 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1992 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1993 extended dialect is based. Warnings from @option{-pedantic} are given
1994 where they are required by the base standard. (It would not make sense
1995 for such warnings to be given only for features not in the specified GNU
1996 C dialect, since by definition the GNU dialects of C include all
1997 features the compiler supports with the given option, and there would be
1998 nothing to warn about.)
1999
2000 @item -pedantic-errors
2001 @opindex pedantic-errors
2002 Like @option{-pedantic}, except that errors are produced rather than
2003 warnings.
2004
2005 @item -w
2006 @opindex w
2007 Inhibit all warning messages.
2008
2009 @item -Wno-import
2010 @opindex Wno-import
2011 Inhibit warning messages about the use of @samp{#import}.
2012
2013 @item -Wchar-subscripts
2014 @opindex Wchar-subscripts
2015 Warn if an array subscript has type @code{char}. This is a common cause
2016 of error, as programmers often forget that this type is signed on some
2017 machines.
2018
2019 @item -Wcomment
2020 @opindex Wcomment
2021 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2022 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2023
2024 @item -Wformat
2025 @opindex Wformat
2026 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2027 the arguments supplied have types appropriate to the format string
2028 specified, and that the conversions specified in the format string make
2029 sense. This includes standard functions, and others specified by format
2030 attributes (@pxref{Function Attributes}), in the @code{printf},
2031 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2032 not in the C standard) families.
2033
2034 The formats are checked against the format features supported by GNU
2035 libc version 2.2. These include all ISO C90 and C99 features, as well
2036 as features from the Single Unix Specification and some BSD and GNU
2037 extensions. Other library implementations may not support all these
2038 features; GCC does not support warning about features that go beyond a
2039 particular library's limitations. However, if @option{-pedantic} is used
2040 with @option{-Wformat}, warnings will be given about format features not
2041 in the selected standard version (but not for @code{strfmon} formats,
2042 since those are not in any version of the C standard). @xref{C Dialect
2043 Options,,Options Controlling C Dialect}.
2044
2045 Since @option{-Wformat} also checks for null format arguments for
2046 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2047
2048 @option{-Wformat} is included in @option{-Wall}. For more control over some
2049 aspects of format checking, the options @option{-Wno-format-y2k},
2050 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2051 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2052 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2053
2054 @item -Wno-format-y2k
2055 @opindex Wno-format-y2k
2056 If @option{-Wformat} is specified, do not warn about @code{strftime}
2057 formats which may yield only a two-digit year.
2058
2059 @item -Wno-format-extra-args
2060 @opindex Wno-format-extra-args
2061 If @option{-Wformat} is specified, do not warn about excess arguments to a
2062 @code{printf} or @code{scanf} format function. The C standard specifies
2063 that such arguments are ignored.
2064
2065 Where the unused arguments lie between used arguments that are
2066 specified with @samp{$} operand number specifications, normally
2067 warnings are still given, since the implementation could not know what
2068 type to pass to @code{va_arg} to skip the unused arguments. However,
2069 in the case of @code{scanf} formats, this option will suppress the
2070 warning if the unused arguments are all pointers, since the Single
2071 Unix Specification says that such unused arguments are allowed.
2072
2073 @item -Wno-format-zero-length
2074 @opindex Wno-format-zero-length
2075 If @option{-Wformat} is specified, do not warn about zero-length formats.
2076 The C standard specifies that zero-length formats are allowed.
2077
2078 @item -Wformat-nonliteral
2079 @opindex Wformat-nonliteral
2080 If @option{-Wformat} is specified, also warn if the format string is not a
2081 string literal and so cannot be checked, unless the format function
2082 takes its format arguments as a @code{va_list}.
2083
2084 @item -Wformat-security
2085 @opindex Wformat-security
2086 If @option{-Wformat} is specified, also warn about uses of format
2087 functions that represent possible security problems. At present, this
2088 warns about calls to @code{printf} and @code{scanf} functions where the
2089 format string is not a string literal and there are no format arguments,
2090 as in @code{printf (foo);}. This may be a security hole if the format
2091 string came from untrusted input and contains @samp{%n}. (This is
2092 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2093 in future warnings may be added to @option{-Wformat-security} that are not
2094 included in @option{-Wformat-nonliteral}.)
2095
2096 @item -Wformat=2
2097 @opindex Wformat=2
2098 Enable @option{-Wformat} plus format checks not included in
2099 @option{-Wformat}. Currently equivalent to @samp{-Wformat
2100 -Wformat-nonliteral -Wformat-security}.
2101
2102 @item -Wnonnull
2103 @opindex Wnonnull
2104 Enable warning about passing a null pointer for arguments marked as
2105 requiring a non-null value by the @code{nonnull} function attribute.
2106
2107 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
2108 can be disabled with the @option{-Wno-nonnull} option.
2109
2110 @item -Wimplicit-int
2111 @opindex Wimplicit-int
2112 Warn when a declaration does not specify a type.
2113
2114 @item -Wimplicit-function-declaration
2115 @itemx -Werror-implicit-function-declaration
2116 @opindex Wimplicit-function-declaration
2117 @opindex Werror-implicit-function-declaration
2118 Give a warning (or error) whenever a function is used before being
2119 declared.
2120
2121 @item -Wimplicit
2122 @opindex Wimplicit
2123 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2124
2125 @item -Wmain
2126 @opindex Wmain
2127 Warn if the type of @samp{main} is suspicious. @samp{main} should be a
2128 function with external linkage, returning int, taking either zero
2129 arguments, two, or three arguments of appropriate types.
2130
2131 @item -Wmissing-braces
2132 @opindex Wmissing-braces
2133 Warn if an aggregate or union initializer is not fully bracketed. In
2134 the following example, the initializer for @samp{a} is not fully
2135 bracketed, but that for @samp{b} is fully bracketed.
2136
2137 @smallexample
2138 int a[2][2] = @{ 0, 1, 2, 3 @};
2139 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2140 @end smallexample
2141
2142 @item -Wparentheses
2143 @opindex Wparentheses
2144 Warn if parentheses are omitted in certain contexts, such
2145 as when there is an assignment in a context where a truth value
2146 is expected, or when operators are nested whose precedence people
2147 often get confused about.
2148
2149 Also warn about constructions where there may be confusion to which
2150 @code{if} statement an @code{else} branch belongs. Here is an example of
2151 such a case:
2152
2153 @smallexample
2154 @group
2155 @{
2156 if (a)
2157 if (b)
2158 foo ();
2159 else
2160 bar ();
2161 @}
2162 @end group
2163 @end smallexample
2164
2165 In C, every @code{else} branch belongs to the innermost possible @code{if}
2166 statement, which in this example is @code{if (b)}. This is often not
2167 what the programmer expected, as illustrated in the above example by
2168 indentation the programmer chose. When there is the potential for this
2169 confusion, GCC will issue a warning when this flag is specified.
2170 To eliminate the warning, add explicit braces around the innermost
2171 @code{if} statement so there is no way the @code{else} could belong to
2172 the enclosing @code{if}. The resulting code would look like this:
2173
2174 @smallexample
2175 @group
2176 @{
2177 if (a)
2178 @{
2179 if (b)
2180 foo ();
2181 else
2182 bar ();
2183 @}
2184 @}
2185 @end group
2186 @end smallexample
2187
2188 @item -Wsequence-point
2189 @opindex Wsequence-point
2190 Warn about code that may have undefined semantics because of violations
2191 of sequence point rules in the C standard.
2192
2193 The C standard defines the order in which expressions in a C program are
2194 evaluated in terms of @dfn{sequence points}, which represent a partial
2195 ordering between the execution of parts of the program: those executed
2196 before the sequence point, and those executed after it. These occur
2197 after the evaluation of a full expression (one which is not part of a
2198 larger expression), after the evaluation of the first operand of a
2199 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2200 function is called (but after the evaluation of its arguments and the
2201 expression denoting the called function), and in certain other places.
2202 Other than as expressed by the sequence point rules, the order of
2203 evaluation of subexpressions of an expression is not specified. All
2204 these rules describe only a partial order rather than a total order,
2205 since, for example, if two functions are called within one expression
2206 with no sequence point between them, the order in which the functions
2207 are called is not specified. However, the standards committee have
2208 ruled that function calls do not overlap.
2209
2210 It is not specified when between sequence points modifications to the
2211 values of objects take effect. Programs whose behavior depends on this
2212 have undefined behavior; the C standard specifies that ``Between the
2213 previous and next sequence point an object shall have its stored value
2214 modified at most once by the evaluation of an expression. Furthermore,
2215 the prior value shall be read only to determine the value to be
2216 stored.''. If a program breaks these rules, the results on any
2217 particular implementation are entirely unpredictable.
2218
2219 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2220 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
2221 diagnosed by this option, and it may give an occasional false positive
2222 result, but in general it has been found fairly effective at detecting
2223 this sort of problem in programs.
2224
2225 The present implementation of this option only works for C programs. A
2226 future implementation may also work for C++ programs.
2227
2228 The C standard is worded confusingly, therefore there is some debate
2229 over the precise meaning of the sequence point rules in subtle cases.
2230 Links to discussions of the problem, including proposed formal
2231 definitions, may be found on our readings page, at
2232 @w{@uref{http://gcc.gnu.org/readings.html}}.
2233
2234 @item -Wreturn-type
2235 @opindex Wreturn-type
2236 Warn whenever a function is defined with a return-type that defaults to
2237 @code{int}. Also warn about any @code{return} statement with no
2238 return-value in a function whose return-type is not @code{void}.
2239
2240 For C++, a function without return type always produces a diagnostic
2241 message, even when @option{-Wno-return-type} is specified. The only
2242 exceptions are @samp{main} and functions defined in system headers.
2243
2244 @item -Wswitch
2245 @opindex Wswitch
2246 Warn whenever a @code{switch} statement has an index of enumeral type
2247 and lacks a @code{case} for one or more of the named codes of that
2248 enumeration. (The presence of a @code{default} label prevents this
2249 warning.) @code{case} labels outside the enumeration range also
2250 provoke warnings when this option is used.
2251
2252 @item -Wswitch-default
2253 @opindex Wswitch-switch
2254 Warn whenever a @code{switch} statement does not have a @code{default}
2255 case.
2256
2257 @item -Wswitch-enum
2258 @opindex Wswitch-enum
2259 Warn whenever a @code{switch} statement has an index of enumeral type
2260 and lacks a @code{case} for one or more of the named codes of that
2261 enumeration. @code{case} labels outside the enumeration range also
2262 provoke warnings when this option is used.
2263
2264 @item -Wtrigraphs
2265 @opindex Wtrigraphs
2266 Warn if any trigraphs are encountered that might change the meaning of
2267 the program (trigraphs within comments are not warned about).
2268
2269 @item -Wunused-function
2270 @opindex Wunused-function
2271 Warn whenever a static function is declared but not defined or a
2272 non\-inline static function is unused.
2273
2274 @item -Wunused-label
2275 @opindex Wunused-label
2276 Warn whenever a label is declared but not used.
2277
2278 To suppress this warning use the @samp{unused} attribute
2279 (@pxref{Variable Attributes}).
2280
2281 @item -Wunused-parameter
2282 @opindex Wunused-parameter
2283 Warn whenever a function parameter is unused aside from its declaration.
2284
2285 To suppress this warning use the @samp{unused} attribute
2286 (@pxref{Variable Attributes}).
2287
2288 @item -Wunused-variable
2289 @opindex Wunused-variable
2290 Warn whenever a local variable or non-constant static variable is unused
2291 aside from its declaration
2292
2293 To suppress this warning use the @samp{unused} attribute
2294 (@pxref{Variable Attributes}).
2295
2296 @item -Wunused-value
2297 @opindex Wunused-value
2298 Warn whenever a statement computes a result that is explicitly not used.
2299
2300 To suppress this warning cast the expression to @samp{void}.
2301
2302 @item -Wunused
2303 @opindex Wunused
2304 All the above @option{-Wunused} options combined.
2305
2306 In order to get a warning about an unused function parameter, you must
2307 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2308 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2309
2310 @item -Wuninitialized
2311 @opindex Wuninitialized
2312 Warn if an automatic variable is used without first being initialized or
2313 if a variable may be clobbered by a @code{setjmp} call.
2314
2315 These warnings are possible only in optimizing compilation,
2316 because they require data flow information that is computed only
2317 when optimizing. If you don't specify @option{-O}, you simply won't
2318 get these warnings.
2319
2320 These warnings occur only for variables that are candidates for
2321 register allocation. Therefore, they do not occur for a variable that
2322 is declared @code{volatile}, or whose address is taken, or whose size
2323 is other than 1, 2, 4 or 8 bytes. Also, they do not occur for
2324 structures, unions or arrays, even when they are in registers.
2325
2326 Note that there may be no warning about a variable that is used only
2327 to compute a value that itself is never used, because such
2328 computations may be deleted by data flow analysis before the warnings
2329 are printed.
2330
2331 These warnings are made optional because GCC is not smart
2332 enough to see all the reasons why the code might be correct
2333 despite appearing to have an error. Here is one example of how
2334 this can happen:
2335
2336 @smallexample
2337 @group
2338 @{
2339 int x;
2340 switch (y)
2341 @{
2342 case 1: x = 1;
2343 break;
2344 case 2: x = 4;
2345 break;
2346 case 3: x = 5;
2347 @}
2348 foo (x);
2349 @}
2350 @end group
2351 @end smallexample
2352
2353 @noindent
2354 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2355 always initialized, but GCC doesn't know this. Here is
2356 another common case:
2357
2358 @smallexample
2359 @{
2360 int save_y;
2361 if (change_y) save_y = y, y = new_y;
2362 @dots{}
2363 if (change_y) y = save_y;
2364 @}
2365 @end smallexample
2366
2367 @noindent
2368 This has no bug because @code{save_y} is used only if it is set.
2369
2370 @cindex @code{longjmp} warnings
2371 This option also warns when a non-volatile automatic variable might be
2372 changed by a call to @code{longjmp}. These warnings as well are possible
2373 only in optimizing compilation.
2374
2375 The compiler sees only the calls to @code{setjmp}. It cannot know
2376 where @code{longjmp} will be called; in fact, a signal handler could
2377 call it at any point in the code. As a result, you may get a warning
2378 even when there is in fact no problem because @code{longjmp} cannot
2379 in fact be called at the place which would cause a problem.
2380
2381 Some spurious warnings can be avoided if you declare all the functions
2382 you use that never return as @code{noreturn}. @xref{Function
2383 Attributes}.
2384
2385 @item -Wunknown-pragmas
2386 @opindex Wunknown-pragmas
2387 @cindex warning for unknown pragmas
2388 @cindex unknown pragmas, warning
2389 @cindex pragmas, warning of unknown
2390 Warn when a #pragma directive is encountered which is not understood by
2391 GCC@. If this command line option is used, warnings will even be issued
2392 for unknown pragmas in system header files. This is not the case if
2393 the warnings were only enabled by the @option{-Wall} command line option.
2394
2395 @item -Wstrict-aliasing
2396 @opindex Wstrict-aliasing
2397 This option is only active when @option{-fstrict-aliasing} is active.
2398 It warns about code which might break the strict aliasing rules that the
2399 compiler is using for optimization. The warning does not catch all
2400 cases, but does attempt to catch the more common pitfalls. It is
2401 included in @option{-Wall}.
2402
2403 @item -Wall
2404 @opindex Wall
2405 All of the above @samp{-W} options combined. This enables all the
2406 warnings about constructions that some users consider questionable, and
2407 that are easy to avoid (or modify to prevent the warning), even in
2408 conjunction with macros. This also enables some language-specific
2409 warnings described in @ref{C++ Dialect Options} and
2410 @ref{Objective-C Dialect Options}.
2411 @end table
2412
2413 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2414 Some of them warn about constructions that users generally do not
2415 consider questionable, but which occasionally you might wish to check
2416 for; others warn about constructions that are necessary or hard to avoid
2417 in some cases, and there is no simple way to modify the code to suppress
2418 the warning.
2419
2420 @table @gcctabopt
2421 @item -Wextra
2422 @opindex W
2423 @opindex Wextra
2424 (This option used to be called @option{-W}. The older name is still
2425 supported, but the newer name is more descriptive.) Print extra warning
2426 messages for these events:
2427
2428 @itemize @bullet
2429 @item
2430 A function can return either with or without a value. (Falling
2431 off the end of the function body is considered returning without
2432 a value.) For example, this function would evoke such a
2433 warning:
2434
2435 @smallexample
2436 @group
2437 foo (a)
2438 @{
2439 if (a > 0)
2440 return a;
2441 @}
2442 @end group
2443 @end smallexample
2444
2445 @item
2446 An expression-statement or the left-hand side of a comma expression
2447 contains no side effects.
2448 To suppress the warning, cast the unused expression to void.
2449 For example, an expression such as @samp{x[i,j]} will cause a warning,
2450 but @samp{x[(void)i,j]} will not.
2451
2452 @item
2453 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2454
2455 @item
2456 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2457 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2458 that of ordinary mathematical notation.
2459
2460 @item
2461 Storage-class specifiers like @code{static} are not the first things in
2462 a declaration. According to the C Standard, this usage is obsolescent.
2463
2464 @item
2465 The return type of a function has a type qualifier such as @code{const}.
2466 Such a type qualifier has no effect, since the value returned by a
2467 function is not an lvalue. (But don't warn about the GNU extension of
2468 @code{volatile void} return types. That extension will be warned about
2469 if @option{-pedantic} is specified.)
2470
2471 @item
2472 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2473 arguments.
2474
2475 @item
2476 A comparison between signed and unsigned values could produce an
2477 incorrect result when the signed value is converted to unsigned.
2478 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2479
2480 @item
2481 An aggregate has an initializer which does not initialize all members.
2482 For example, the following code would cause such a warning, because
2483 @code{x.h} would be implicitly initialized to zero:
2484
2485 @smallexample
2486 struct s @{ int f, g, h; @};
2487 struct s x = @{ 3, 4 @};
2488 @end smallexample
2489
2490 @item
2491 A function parameter is declared without a type specifier in K&R-style
2492 functions:
2493
2494 @smallexample
2495 void foo(bar) @{ @}
2496 @end smallexample
2497
2498 @item
2499 An empty body occurs in an @samp{if} or @samp{else} statement.
2500
2501 @item
2502 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2503 @samp{>}, or @samp{>=}.
2504
2505 @item
2506 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2507
2508 @item
2509 Any of several floating-point events that often indicate errors, such as
2510 overflow, underflow, loss of precision, etc.
2511
2512 @item @r{(C++ only)}
2513 An enumerator and a non-enumerator both appear in a conditional expression.
2514
2515 @item @r{(C++ only)}
2516 A non-static reference or non-static @samp{const} member appears in a
2517 class without constructors.
2518
2519 @item @r{(C++ only)}
2520 Ambiguous virtual bases.
2521
2522 @item @r{(C++ only)}
2523 Subscripting an array which has been declared @samp{register}.
2524
2525 @item @r{(C++ only)}
2526 Taking the address of a variable which has been declared @samp{register}.
2527
2528 @item @r{(C++ only)}
2529 A base class is not initialized in a derived class' copy constrcutor.
2530 @end itemize
2531
2532 @item -Wno-div-by-zero
2533 @opindex Wno-div-by-zero
2534 @opindex Wdiv-by-zero
2535 Do not warn about compile-time integer division by zero. Floating point
2536 division by zero is not warned about, as it can be a legitimate way of
2537 obtaining infinities and NaNs.
2538
2539 @item -Wsystem-headers
2540 @opindex Wsystem-headers
2541 @cindex warnings from system headers
2542 @cindex system headers, warnings from
2543 Print warning messages for constructs found in system header files.
2544 Warnings from system headers are normally suppressed, on the assumption
2545 that they usually do not indicate real problems and would only make the
2546 compiler output harder to read. Using this command line option tells
2547 GCC to emit warnings from system headers as if they occurred in user
2548 code. However, note that using @option{-Wall} in conjunction with this
2549 option will @emph{not} warn about unknown pragmas in system
2550 headers---for that, @option{-Wunknown-pragmas} must also be used.
2551
2552 @item -Wfloat-equal
2553 @opindex Wfloat-equal
2554 Warn if floating point values are used in equality comparisons.
2555
2556 The idea behind this is that sometimes it is convenient (for the
2557 programmer) to consider floating-point values as approximations to
2558 infinitely precise real numbers. If you are doing this, then you need
2559 to compute (by analyzing the code, or in some other way) the maximum or
2560 likely maximum error that the computation introduces, and allow for it
2561 when performing comparisons (and when producing output, but that's a
2562 different problem). In particular, instead of testing for equality, you
2563 would check to see whether the two values have ranges that overlap; and
2564 this is done with the relational operators, so equality comparisons are
2565 probably mistaken.
2566
2567 @item -Wtraditional @r{(C only)}
2568 @opindex Wtraditional
2569 Warn about certain constructs that behave differently in traditional and
2570 ISO C@. Also warn about ISO C constructs that have no traditional C
2571 equivalent, and/or problematic constructs which should be avoided.
2572
2573 @itemize @bullet
2574 @item
2575 Macro parameters that appear within string literals in the macro body.
2576 In traditional C macro replacement takes place within string literals,
2577 but does not in ISO C@.
2578
2579 @item
2580 In traditional C, some preprocessor directives did not exist.
2581 Traditional preprocessors would only consider a line to be a directive
2582 if the @samp{#} appeared in column 1 on the line. Therefore
2583 @option{-Wtraditional} warns about directives that traditional C
2584 understands but would ignore because the @samp{#} does not appear as the
2585 first character on the line. It also suggests you hide directives like
2586 @samp{#pragma} not understood by traditional C by indenting them. Some
2587 traditional implementations would not recognize @samp{#elif}, so it
2588 suggests avoiding it altogether.
2589
2590 @item
2591 A function-like macro that appears without arguments.
2592
2593 @item
2594 The unary plus operator.
2595
2596 @item
2597 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2598 constant suffixes. (Traditional C does support the @samp{L} suffix on integer
2599 constants.) Note, these suffixes appear in macros defined in the system
2600 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2601 Use of these macros in user code might normally lead to spurious
2602 warnings, however gcc's integrated preprocessor has enough context to
2603 avoid warning in these cases.
2604
2605 @item
2606 A function declared external in one block and then used after the end of
2607 the block.
2608
2609 @item
2610 A @code{switch} statement has an operand of type @code{long}.
2611
2612 @item
2613 A non-@code{static} function declaration follows a @code{static} one.
2614 This construct is not accepted by some traditional C compilers.
2615
2616 @item
2617 The ISO type of an integer constant has a different width or
2618 signedness from its traditional type. This warning is only issued if
2619 the base of the constant is ten. I.e.@: hexadecimal or octal values, which
2620 typically represent bit patterns, are not warned about.
2621
2622 @item
2623 Usage of ISO string concatenation is detected.
2624
2625 @item
2626 Initialization of automatic aggregates.
2627
2628 @item
2629 Identifier conflicts with labels. Traditional C lacks a separate
2630 namespace for labels.
2631
2632 @item
2633 Initialization of unions. If the initializer is zero, the warning is
2634 omitted. This is done under the assumption that the zero initializer in
2635 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2636 initializer warnings and relies on default initialization to zero in the
2637 traditional C case.
2638
2639 @item
2640 Conversions by prototypes between fixed/floating point values and vice
2641 versa. The absence of these prototypes when compiling with traditional
2642 C would cause serious problems. This is a subset of the possible
2643 conversion warnings, for the full set use @option{-Wconversion}.
2644
2645 @item
2646 Use of ISO C style function definitions. This warning intentionally is
2647 @emph{not} issued for prototype declarations or variadic functions
2648 because these ISO C features will appear in your code when using
2649 libiberty's traditional C compatibility macros, @code{PARAMS} and
2650 @code{VPARAMS}. This warning is also bypassed for nested functions
2651 because that feature is already a gcc extension and thus not relevant to
2652 traditional C compatibility.
2653 @end itemize
2654
2655 @item -Wundef
2656 @opindex Wundef
2657 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2658
2659 @item -Wendif-labels
2660 @opindex Wendif-labels
2661 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2662
2663 @item -Wshadow
2664 @opindex Wshadow
2665 Warn whenever a local variable shadows another local variable, parameter or
2666 global variable or whenever a built-in function is shadowed.
2667
2668 @item -Wlarger-than-@var{len}
2669 @opindex Wlarger-than
2670 Warn whenever an object of larger than @var{len} bytes is defined.
2671
2672 @item -Wpointer-arith
2673 @opindex Wpointer-arith
2674 Warn about anything that depends on the ``size of'' a function type or
2675 of @code{void}. GNU C assigns these types a size of 1, for
2676 convenience in calculations with @code{void *} pointers and pointers
2677 to functions.
2678
2679 @item -Wbad-function-cast @r{(C only)}
2680 @opindex Wbad-function-cast
2681 Warn whenever a function call is cast to a non-matching type.
2682 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2683
2684 @item -Wcast-qual
2685 @opindex Wcast-qual
2686 Warn whenever a pointer is cast so as to remove a type qualifier from
2687 the target type. For example, warn if a @code{const char *} is cast
2688 to an ordinary @code{char *}.
2689
2690 @item -Wcast-align
2691 @opindex Wcast-align
2692 Warn whenever a pointer is cast such that the required alignment of the
2693 target is increased. For example, warn if a @code{char *} is cast to
2694 an @code{int *} on machines where integers can only be accessed at
2695 two- or four-byte boundaries.
2696
2697 @item -Wwrite-strings
2698 @opindex Wwrite-strings
2699 When compiling C, give string constants the type @code{const
2700 char[@var{length}]} so that
2701 copying the address of one into a non-@code{const} @code{char *}
2702 pointer will get a warning; when compiling C++, warn about the
2703 deprecated conversion from string constants to @code{char *}.
2704 These warnings will help you find at
2705 compile time code that can try to write into a string constant, but
2706 only if you have been very careful about using @code{const} in
2707 declarations and prototypes. Otherwise, it will just be a nuisance;
2708 this is why we did not make @option{-Wall} request these warnings.
2709
2710 @item -Wconversion
2711 @opindex Wconversion
2712 Warn if a prototype causes a type conversion that is different from what
2713 would happen to the same argument in the absence of a prototype. This
2714 includes conversions of fixed point to floating and vice versa, and
2715 conversions changing the width or signedness of a fixed point argument
2716 except when the same as the default promotion.
2717
2718 Also, warn if a negative integer constant expression is implicitly
2719 converted to an unsigned type. For example, warn about the assignment
2720 @code{x = -1} if @code{x} is unsigned. But do not warn about explicit
2721 casts like @code{(unsigned) -1}.
2722
2723 @item -Wsign-compare
2724 @opindex Wsign-compare
2725 @cindex warning for comparison of signed and unsigned values
2726 @cindex comparison of signed and unsigned values, warning
2727 @cindex signed and unsigned values, comparison warning
2728 Warn when a comparison between signed and unsigned values could produce
2729 an incorrect result when the signed value is converted to unsigned.
2730 This warning is also enabled by @option{-Wextra}; to get the other warnings
2731 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2732
2733 @item -Waggregate-return
2734 @opindex Waggregate-return
2735 Warn if any functions that return structures or unions are defined or
2736 called. (In languages where you can return an array, this also elicits
2737 a warning.)
2738
2739 @item -Wstrict-prototypes @r{(C only)}
2740 @opindex Wstrict-prototypes
2741 Warn if a function is declared or defined without specifying the
2742 argument types. (An old-style function definition is permitted without
2743 a warning if preceded by a declaration which specifies the argument
2744 types.)
2745
2746 @item -Wmissing-prototypes @r{(C only)}
2747 @opindex Wmissing-prototypes
2748 Warn if a global function is defined without a previous prototype
2749 declaration. This warning is issued even if the definition itself
2750 provides a prototype. The aim is to detect global functions that fail
2751 to be declared in header files.
2752
2753 @item -Wmissing-declarations
2754 @opindex Wmissing-declarations
2755 Warn if a global function is defined without a previous declaration.
2756 Do so even if the definition itself provides a prototype.
2757 Use this option to detect global functions that are not declared in
2758 header files.
2759
2760 @item -Wmissing-noreturn
2761 @opindex Wmissing-noreturn
2762 Warn about functions which might be candidates for attribute @code{noreturn}.
2763 Note these are only possible candidates, not absolute ones. Care should
2764 be taken to manually verify functions actually do not ever return before
2765 adding the @code{noreturn} attribute, otherwise subtle code generation
2766 bugs could be introduced. You will not get a warning for @code{main} in
2767 hosted C environments.
2768
2769 @item -Wmissing-format-attribute
2770 @opindex Wmissing-format-attribute
2771 @opindex Wformat
2772 If @option{-Wformat} is enabled, also warn about functions which might be
2773 candidates for @code{format} attributes. Note these are only possible
2774 candidates, not absolute ones. GCC will guess that @code{format}
2775 attributes might be appropriate for any function that calls a function
2776 like @code{vprintf} or @code{vscanf}, but this might not always be the
2777 case, and some functions for which @code{format} attributes are
2778 appropriate may not be detected. This option has no effect unless
2779 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2780
2781 @item -Wno-multichar
2782 @opindex Wno-multichar
2783 @opindex Wmultichar
2784 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2785 Usually they indicate a typo in the user's code, as they have
2786 implementation-defined values, and should not be used in portable code.
2787
2788 @item -Wno-deprecated-declarations
2789 @opindex Wno-deprecated-declarations
2790 Do not warn about uses of functions, variables, and types marked as
2791 deprecated by using the @code{deprecated} attribute.
2792 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2793 @pxref{Type Attributes}.)
2794
2795 @item -Wpacked
2796 @opindex Wpacked
2797 Warn if a structure is given the packed attribute, but the packed
2798 attribute has no effect on the layout or size of the structure.
2799 Such structures may be mis-aligned for little benefit. For
2800 instance, in this code, the variable @code{f.x} in @code{struct bar}
2801 will be misaligned even though @code{struct bar} does not itself
2802 have the packed attribute:
2803
2804 @smallexample
2805 @group
2806 struct foo @{
2807 int x;
2808 char a, b, c, d;
2809 @} __attribute__((packed));
2810 struct bar @{
2811 char z;
2812 struct foo f;
2813 @};
2814 @end group
2815 @end smallexample
2816
2817 @item -Wpadded
2818 @opindex Wpadded
2819 Warn if padding is included in a structure, either to align an element
2820 of the structure or to align the whole structure. Sometimes when this
2821 happens it is possible to rearrange the fields of the structure to
2822 reduce the padding and so make the structure smaller.
2823
2824 @item -Wredundant-decls
2825 @opindex Wredundant-decls
2826 Warn if anything is declared more than once in the same scope, even in
2827 cases where multiple declaration is valid and changes nothing.
2828
2829 @item -Wnested-externs @r{(C only)}
2830 @opindex Wnested-externs
2831 Warn if an @code{extern} declaration is encountered within a function.
2832
2833 @item -Wunreachable-code
2834 @opindex Wunreachable-code
2835 Warn if the compiler detects that code will never be executed.
2836
2837 This option is intended to warn when the compiler detects that at
2838 least a whole line of source code will never be executed, because
2839 some condition is never satisfied or because it is after a
2840 procedure that never returns.
2841
2842 It is possible for this option to produce a warning even though there
2843 are circumstances under which part of the affected line can be executed,
2844 so care should be taken when removing apparently-unreachable code.
2845
2846 For instance, when a function is inlined, a warning may mean that the
2847 line is unreachable in only one inlined copy of the function.
2848
2849 This option is not made part of @option{-Wall} because in a debugging
2850 version of a program there is often substantial code which checks
2851 correct functioning of the program and is, hopefully, unreachable
2852 because the program does work. Another common use of unreachable
2853 code is to provide behavior which is selectable at compile-time.
2854
2855 @item -Winline
2856 @opindex Winline
2857 Warn if a function can not be inlined and it was declared as inline.
2858
2859 @item -Winvalid-pch
2860 @opindex Winvalid-pch
2861 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2862 the search path but can't be used.
2863
2864 @item -Wlong-long
2865 @opindex Wlong-long
2866 @opindex Wno-long-long
2867 Warn if @samp{long long} type is used. This is default. To inhibit
2868 the warning messages, use @option{-Wno-long-long}. Flags
2869 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2870 only when @option{-pedantic} flag is used.
2871
2872 @item -Wdisabled-optimization
2873 @opindex Wdisabled-optimization
2874 Warn if a requested optimization pass is disabled. This warning does
2875 not generally indicate that there is anything wrong with your code; it
2876 merely indicates that GCC's optimizers were unable to handle the code
2877 effectively. Often, the problem is that your code is too big or too
2878 complex; GCC will refuse to optimize programs when the optimization
2879 itself is likely to take inordinate amounts of time.
2880
2881 @item -Werror
2882 @opindex Werror
2883 Make all warnings into errors.
2884 @end table
2885
2886 @node Debugging Options
2887 @section Options for Debugging Your Program or GCC
2888 @cindex options, debugging
2889 @cindex debugging information options
2890
2891 GCC has various special options that are used for debugging
2892 either your program or GCC:
2893
2894 @table @gcctabopt
2895 @item -g
2896 @opindex g
2897 Produce debugging information in the operating system's native format
2898 (stabs, COFF, XCOFF, or DWARF)@. GDB can work with this debugging
2899 information.
2900
2901 On most systems that use stabs format, @option{-g} enables use of extra
2902 debugging information that only GDB can use; this extra information
2903 makes debugging work better in GDB but will probably make other debuggers
2904 crash or
2905 refuse to read the program. If you want to control for certain whether
2906 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2907 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2908 or @option{-gvms} (see below).
2909
2910 Unlike most other C compilers, GCC allows you to use @option{-g} with
2911 @option{-O}. The shortcuts taken by optimized code may occasionally
2912 produce surprising results: some variables you declared may not exist
2913 at all; flow of control may briefly move where you did not expect it;
2914 some statements may not be executed because they compute constant
2915 results or their values were already at hand; some statements may
2916 execute in different places because they were moved out of loops.
2917
2918 Nevertheless it proves possible to debug optimized output. This makes
2919 it reasonable to use the optimizer for programs that might have bugs.
2920
2921 The following options are useful when GCC is generated with the
2922 capability for more than one debugging format.
2923
2924 @item -ggdb
2925 @opindex ggdb
2926 Produce debugging information for use by GDB@. This means to use the
2927 most expressive format available (DWARF 2, stabs, or the native format
2928 if neither of those are supported), including GDB extensions if at all
2929 possible.
2930
2931 @item -gstabs
2932 @opindex gstabs
2933 Produce debugging information in stabs format (if that is supported),
2934 without GDB extensions. This is the format used by DBX on most BSD
2935 systems. On MIPS, Alpha and System V Release 4 systems this option
2936 produces stabs debugging output which is not understood by DBX or SDB@.
2937 On System V Release 4 systems this option requires the GNU assembler.
2938
2939 @item -gstabs+
2940 @opindex gstabs+
2941 Produce debugging information in stabs format (if that is supported),
2942 using GNU extensions understood only by the GNU debugger (GDB)@. The
2943 use of these extensions is likely to make other debuggers crash or
2944 refuse to read the program.
2945
2946 @item -gcoff
2947 @opindex gcoff
2948 Produce debugging information in COFF format (if that is supported).
2949 This is the format used by SDB on most System V systems prior to
2950 System V Release 4.
2951
2952 @item -gxcoff
2953 @opindex gxcoff
2954 Produce debugging information in XCOFF format (if that is supported).
2955 This is the format used by the DBX debugger on IBM RS/6000 systems.
2956
2957 @item -gxcoff+
2958 @opindex gxcoff+
2959 Produce debugging information in XCOFF format (if that is supported),
2960 using GNU extensions understood only by the GNU debugger (GDB)@. The
2961 use of these extensions is likely to make other debuggers crash or
2962 refuse to read the program, and may cause assemblers other than the GNU
2963 assembler (GAS) to fail with an error.
2964
2965 @item -gdwarf
2966 @opindex gdwarf
2967 Produce debugging information in DWARF version 1 format (if that is
2968 supported). This is the format used by SDB on most System V Release 4
2969 systems.
2970
2971 This option is deprecated.
2972
2973 @item -gdwarf+
2974 @opindex gdwarf+
2975 Produce debugging information in DWARF version 1 format (if that is
2976 supported), using GNU extensions understood only by the GNU debugger
2977 (GDB)@. The use of these extensions is likely to make other debuggers
2978 crash or refuse to read the program.
2979
2980 This option is deprecated.
2981
2982 @item -gdwarf-2
2983 @opindex gdwarf-2
2984 Produce debugging information in DWARF version 2 format (if that is
2985 supported). This is the format used by DBX on IRIX 6.
2986
2987 @item -gvms
2988 @opindex gvms
2989 Produce debugging information in VMS debug format (if that is
2990 supported). This is the format used by DEBUG on VMS systems.
2991
2992 @item -g@var{level}
2993 @itemx -ggdb@var{level}
2994 @itemx -gstabs@var{level}
2995 @itemx -gcoff@var{level}
2996 @itemx -gxcoff@var{level}
2997 @itemx -gvms@var{level}
2998 Request debugging information and also use @var{level} to specify how
2999 much information. The default level is 2.
3000
3001 Level 1 produces minimal information, enough for making backtraces in
3002 parts of the program that you don't plan to debug. This includes
3003 descriptions of functions and external variables, but no information
3004 about local variables and no line numbers.
3005
3006 Level 3 includes extra information, such as all the macro definitions
3007 present in the program. Some debuggers support macro expansion when
3008 you use @option{-g3}.
3009
3010 Note that in order to avoid confusion between DWARF1 debug level 2,
3011 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
3012 a concatenated debug level. Instead use an additional @option{-g@var{level}}
3013 option to change the debug level for DWARF1 or DWARF2.
3014
3015 @item -feliminate-dwarf2-dups
3016 @opindex feliminate-dwarf2-dups
3017 Compress DWARF2 debugging information by eliminating duplicated
3018 information about each symbol. This option only makes sense when
3019 generating DWARF2 debugging information with @option{-gdwarf-2}.
3020
3021 @cindex @command{prof}
3022 @item -p
3023 @opindex p
3024 Generate extra code to write profile information suitable for the
3025 analysis program @command{prof}. You must use this option when compiling
3026 the source files you want data about, and you must also use it when
3027 linking.
3028
3029 @cindex @command{gprof}
3030 @item -pg
3031 @opindex pg
3032 Generate extra code to write profile information suitable for the
3033 analysis program @command{gprof}. You must use this option when compiling
3034 the source files you want data about, and you must also use it when
3035 linking.
3036
3037 @item -Q
3038 @opindex Q
3039 Makes the compiler print out each function name as it is compiled, and
3040 print some statistics about each pass when it finishes.
3041
3042 @item -ftime-report
3043 @opindex ftime-report
3044 Makes the compiler print some statistics about the time consumed by each
3045 pass when it finishes.
3046
3047 @item -fmem-report
3048 @opindex fmem-report
3049 Makes the compiler print some statistics about permanent memory
3050 allocation when it finishes.
3051
3052 @item -fprofile-arcs
3053 @opindex fprofile-arcs
3054 Add code so that program flow @dfn{arcs} are instrumented. During
3055 execution the program records how many times each branch and call is
3056 executed and how many times it is taken or returns. When the compiled
3057 program exits it saves this data to a file called
3058 @file{@var{auxname}.da} for each source file. The data may be used for
3059 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3060 test coverage analysis (@option{-ftest-coverage}). Each object file's
3061 @var{auxname} is generated from the name of the output file, if
3062 explicitly specified and it is not the final executable, otherwise it is
3063 the basename of the source file. In both cases any suffix is removed
3064 (e.g. @file{foo.da} for input file @file{dir/foo.c}, or
3065 @file{dir/foo.da} for output file specified as @option{-o dir/foo.o}).
3066
3067 @itemize
3068
3069 @item
3070 Compile the source files with @option{-fprofile-arcs} plus optimization
3071 and code generation options. For test coverage analysis, use the
3072 additional @option{-ftest-coverage} option. You do not need to profile
3073 every source file in a program.
3074
3075 @item
3076 Link your object files as normal.
3077
3078 @item
3079 Run the program on a representative workload to generate the arc profile
3080 information. This may be repeated any number of times.
3081
3082 @item
3083 For profile-directed optimizations, compile the source files again with
3084 the same optimization and code generation options plus
3085 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3086 Control Optimization}).
3087
3088 @item
3089 For test coverage analysis, use @command{gcov} to produce human readable
3090 information from the @file{.bbg} and @file{.da} files. Refer to the
3091 @command{gcov} documentation for further information.
3092
3093 @end itemize
3094
3095 With @option{-fprofile-arcs}, for each function of your program GCC
3096 creates a program flow graph, then finds a spanning tree for the graph.
3097 Only arcs that are not on the spanning tree have to be instrumented: the
3098 compiler adds code to count the number of times that these arcs are
3099 executed. When an arc is the only exit or only entrance to a block, the
3100 instrumentation code can be added to the block; otherwise, a new basic
3101 block must be created to hold the instrumentation code.
3102
3103 @need 2000
3104 @item -ftest-coverage
3105 @opindex ftest-coverage
3106 Produce a graph file that the @command{gcov} code-coverage utility
3107 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3108 show program coverage. Each source file's data file is called
3109 @file{@var{auxname}.bbg}. Refer to the @option{-fprofile-arcs} option
3110 above for a description of @var{auxname} and instructions on how to
3111 generate test coverage data. Coverage data will match the source files
3112 more closely, if you do not optimize.
3113
3114 @item -d@var{letters}
3115 @opindex d
3116 Says to make debugging dumps during compilation at times specified by
3117 @var{letters}. This is used for debugging the compiler. The file names
3118 for most of the dumps are made by appending a pass number and a word to
3119 the @var{dumpname}. @var{dumpname} is generated from the name of the
3120 output file, if explicitly specified and it is not an executable,
3121 otherwise it is the basename of the source file. In both cases any
3122 suffix is removed (e.g. @file{foo.00.rtl} or @file{foo.01.sibling}).
3123 Here are the possible letters for use in @var{letters}, and their
3124 meanings:
3125
3126 @table @samp
3127 @item A
3128 @opindex dA
3129 Annotate the assembler output with miscellaneous debugging information.
3130 @item b
3131 @opindex db
3132 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
3133 @item B
3134 @opindex dB
3135 Dump after block reordering, to @file{@var{file}.32.bbro}.
3136 @item c
3137 @opindex dc
3138 Dump after instruction combination, to the file @file{@var{file}.19.combine}.
3139 @item C
3140 @opindex dC
3141 Dump after the first if conversion, to the file @file{@var{file}.15.ce1}.
3142 @item d
3143 @opindex dd
3144 Dump after delayed branch scheduling, to @file{@var{file}.34.dbr}.
3145 @item D
3146 @opindex dD
3147 Dump all macro definitions, at the end of preprocessing, in addition to
3148 normal output.
3149 @item e
3150 @opindex de
3151 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3152 @file{@var{file}.07.ussa}.
3153 @item E
3154 @opindex dE
3155 Dump after the second if conversion, to @file{@var{file}.29.ce3}.
3156 @item f
3157 @opindex df
3158 Dump after life analysis, to @file{@var{file}.18.life}.
3159 @item F
3160 @opindex dF
3161 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3162 @item g
3163 @opindex dg
3164 Dump after global register allocation, to @file{@var{file}.24.greg}.
3165 @item h
3166 @opindex dh
3167 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3168 @item k
3169 @opindex dk
3170 Dump after reg-to-stack conversion, to @file{@var{file}.31.stack}.
3171 @item o
3172 @opindex do
3173 Dump after post-reload optimizations, to @file{@var{file}.25.postreload}.
3174 @item G
3175 @opindex dG
3176 Dump after GCSE, to @file{@var{file}.11.gcse}.
3177 @item i
3178 @opindex di
3179 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3180 @item j
3181 @opindex dj
3182 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3183 @item k
3184 @opindex dk
3185 Dump after conversion from registers to stack, to @file{@var{file}.31.stack}.
3186 @item l
3187 @opindex dl
3188 Dump after local register allocation, to @file{@var{file}.23.lreg}.
3189 @item L
3190 @opindex dL
3191 Dump after loop optimization passes, to @file{@var{file}.12.loop} and
3192 @file{@var{file}.18.loop2}.
3193 @item M
3194 @opindex dM
3195 Dump after performing the machine dependent reorganization pass, to
3196 @file{@var{file}.33.mach}.
3197 @item n
3198 @opindex dn
3199 Dump after register renumbering, to @file{@var{file}.28.rnreg}.
3200 @item N
3201 @opindex dN
3202 Dump after the register move pass, to @file{@var{file}.21.regmove}.
3203 @item r
3204 @opindex dr
3205 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3206 @item R
3207 @opindex dR
3208 Dump after the second scheduling pass, to @file{@var{file}.30.sched2}.
3209 @item s
3210 @opindex ds
3211 Dump after CSE (including the jump optimization that sometimes follows
3212 CSE), to @file{@var{file}.09.cse}.
3213 @item S
3214 @opindex dS
3215 Dump after the first scheduling pass, to @file{@var{file}.22.sched}.
3216 @item t
3217 @opindex dt
3218 Dump after the second CSE pass (including the jump optimization that
3219 sometimes follows CSE), to @file{@var{file}.17.cse2}.
3220 @item u
3221 @opindex du
3222 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3223 @item w
3224 @opindex dw
3225 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3226 @item X
3227 @opindex dX
3228 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3229 @item z
3230 @opindex dz
3231 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3232 @item a
3233 @opindex da
3234 Produce all the dumps listed above.
3235 @item H
3236 @opindex dH
3237 Produce a core dump whenever an error occurs.
3238 @item m
3239 @opindex dm
3240 Print statistics on memory usage, at the end of the run, to
3241 standard error.
3242 @item p
3243 @opindex dp
3244 Annotate the assembler output with a comment indicating which
3245 pattern and alternative was used. The length of each instruction is
3246 also printed.
3247 @item P
3248 @opindex dP
3249 Dump the RTL in the assembler output as a comment before each instruction.
3250 Also turns on @option{-dp} annotation.
3251 @item v
3252 @opindex dv
3253 For each of the other indicated dump files (except for
3254 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3255 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3256 @item x
3257 @opindex dx
3258 Just generate RTL for a function instead of compiling it. Usually used
3259 with @samp{r}.
3260 @item y
3261 @opindex dy
3262 Dump debugging information during parsing, to standard error.
3263 @end table
3264
3265 @item -fdump-unnumbered
3266 @opindex fdump-unnumbered
3267 When doing debugging dumps (see @option{-d} option above), suppress instruction
3268 numbers and line number note output. This makes it more feasible to
3269 use diff on debugging dumps for compiler invocations with different
3270 options, in particular with and without @option{-g}.
3271
3272 @item -fdump-translation-unit @r{(C and C++ only)}
3273 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3274 @opindex fdump-translation-unit
3275 Dump a representation of the tree structure for the entire translation
3276 unit to a file. The file name is made by appending @file{.tu} to the
3277 source file name. If the @samp{-@var{options}} form is used, @var{options}
3278 controls the details of the dump as described for the
3279 @option{-fdump-tree} options.
3280
3281 @item -fdump-class-hierarchy @r{(C++ only)}
3282 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3283 @opindex fdump-class-hierarchy
3284 Dump a representation of each class's hierarchy and virtual function
3285 table layout to a file. The file name is made by appending @file{.class}
3286 to the source file name. If the @samp{-@var{options}} form is used,
3287 @var{options} controls the details of the dump as described for the
3288 @option{-fdump-tree} options.
3289
3290 @item -fdump-tree-@var{switch} @r{(C++ only)}
3291 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3292 @opindex fdump-tree
3293 Control the dumping at various stages of processing the intermediate
3294 language tree to a file. The file name is generated by appending a switch
3295 specific suffix to the source file name. If the @samp{-@var{options}}
3296 form is used, @var{options} is a list of @samp{-} separated options that
3297 control the details of the dump. Not all options are applicable to all
3298 dumps, those which are not meaningful will be ignored. The following
3299 options are available
3300
3301 @table @samp
3302 @item address
3303 Print the address of each node. Usually this is not meaningful as it
3304 changes according to the environment and source file. Its primary use
3305 is for tying up a dump file with a debug environment.
3306 @item slim
3307 Inhibit dumping of members of a scope or body of a function merely
3308 because that scope has been reached. Only dump such items when they
3309 are directly reachable by some other path.
3310 @item all
3311 Turn on all options.
3312 @end table
3313
3314 The following tree dumps are possible:
3315 @table @samp
3316 @item original
3317 Dump before any tree based optimization, to @file{@var{file}.original}.
3318 @item optimized
3319 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3320 @item inlined
3321 Dump after function inlining, to @file{@var{file}.inlined}.
3322 @end table
3323
3324 @item -fsched-verbose=@var{n}
3325 @opindex fsched-verbose
3326 On targets that use instruction scheduling, this option controls the
3327 amount of debugging output the scheduler prints. This information is
3328 written to standard error, unless @option{-dS} or @option{-dR} is
3329 specified, in which case it is output to the usual dump
3330 listing file, @file{.sched} or @file{.sched2} respectively. However
3331 for @var{n} greater than nine, the output is always printed to standard
3332 error.
3333
3334 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3335 same information as @option{-dRS}. For @var{n} greater than one, it
3336 also output basic block probabilities, detailed ready list information
3337 and unit/insn info. For @var{n} greater than two, it includes RTL
3338 at abort point, control-flow and regions info. And for @var{n} over
3339 four, @option{-fsched-verbose} also includes dependence info.
3340
3341 @item -save-temps
3342 @opindex save-temps
3343 Store the usual ``temporary'' intermediate files permanently; place them
3344 in the current directory and name them based on the source file. Thus,
3345 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3346 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
3347 preprocessed @file{foo.i} output file even though the compiler now
3348 normally uses an integrated preprocessor.
3349
3350 @item -time
3351 @opindex time
3352 Report the CPU time taken by each subprocess in the compilation
3353 sequence. For C source files, this is the compiler proper and assembler
3354 (plus the linker if linking is done). The output looks like this:
3355
3356 @smallexample
3357 # cc1 0.12 0.01
3358 # as 0.00 0.01
3359 @end smallexample
3360
3361 The first number on each line is the ``user time,'' that is time spent
3362 executing the program itself. The second number is ``system time,''
3363 time spent executing operating system routines on behalf of the program.
3364 Both numbers are in seconds.
3365
3366 @item -print-file-name=@var{library}
3367 @opindex print-file-name
3368 Print the full absolute name of the library file @var{library} that
3369 would be used when linking---and don't do anything else. With this
3370 option, GCC does not compile or link anything; it just prints the
3371 file name.
3372
3373 @item -print-multi-directory
3374 @opindex print-multi-directory
3375 Print the directory name corresponding to the multilib selected by any
3376 other switches present in the command line. This directory is supposed
3377 to exist in @env{GCC_EXEC_PREFIX}.
3378
3379 @item -print-multi-lib
3380 @opindex print-multi-lib
3381 Print the mapping from multilib directory names to compiler switches
3382 that enable them. The directory name is separated from the switches by
3383 @samp{;}, and each switch starts with an @samp{@@} instead of the
3384 @samp{-}, without spaces between multiple switches. This is supposed to
3385 ease shell-processing.
3386
3387 @item -print-prog-name=@var{program}
3388 @opindex print-prog-name
3389 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3390
3391 @item -print-libgcc-file-name
3392 @opindex print-libgcc-file-name
3393 Same as @option{-print-file-name=libgcc.a}.
3394
3395 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3396 but you do want to link with @file{libgcc.a}. You can do
3397
3398 @example
3399 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3400 @end example
3401
3402 @item -print-search-dirs
3403 @opindex print-search-dirs
3404 Print the name of the configured installation directory and a list of
3405 program and library directories gcc will search---and don't do anything else.
3406
3407 This is useful when gcc prints the error message
3408 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3409 To resolve this you either need to put @file{cpp0} and the other compiler
3410 components where gcc expects to find them, or you can set the environment
3411 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3412 Don't forget the trailing '/'.
3413 @xref{Environment Variables}.
3414
3415 @item -dumpmachine
3416 @opindex dumpmachine
3417 Print the compiler's target machine (for example,
3418 @samp{i686-pc-linux-gnu})---and don't do anything else.
3419
3420 @item -dumpversion
3421 @opindex dumpversion
3422 Print the compiler version (for example, @samp{3.0})---and don't do
3423 anything else.
3424
3425 @item -dumpspecs
3426 @opindex dumpspecs
3427 Print the compiler's built-in specs---and don't do anything else. (This
3428 is used when GCC itself is being built.) @xref{Spec Files}.
3429
3430 @item -feliminate-unused-debug-types
3431 @opindex feliminate-unused-debug-types
3432 Normally, when producing DWARF2 output, GCC will emit debugging
3433 information for all types declared in a compilation
3434 unit, regardless of whether or not they are actually used
3435 in that compilation unit. Sometimes this is useful, such as
3436 if, in the debugger, you want to cast a value to a type that is
3437 not actually used in your program (but is declared). More often,
3438 however, this results in a significant amount of wasted space.
3439 With this option, GCC will avoid producing debug symbol output
3440 for types that are nowhere used in the source file being compiled.
3441 @end table
3442
3443 @node Optimize Options
3444 @section Options That Control Optimization
3445 @cindex optimize options
3446 @cindex options, optimization
3447
3448 These options control various sorts of optimizations.
3449
3450 Without any optimization option, the compiler's goal is to reduce the
3451 cost of compilation and to make debugging produce the expected
3452 results. Statements are independent: if you stop the program with a
3453 breakpoint between statements, you can then assign a new value to any
3454 variable or change the program counter to any other statement in the
3455 function and get exactly the results you would expect from the source
3456 code.
3457
3458 Turning on optimization flags makes the compiler attempt to improve
3459 the performance and/or code size at the expense of compilation time
3460 and possibly the ability to debug the program.
3461
3462 Not all optimizations are controlled directly by a flag. Only
3463 optimizations that have a flag are listed.
3464
3465 @table @gcctabopt
3466 @item -O
3467 @itemx -O1
3468 @opindex O
3469 @opindex O1
3470 Optimize. Optimizing compilation takes somewhat more time, and a lot
3471 more memory for a large function.
3472
3473 With @option{-O}, the compiler tries to reduce code size and execution
3474 time, without performing any optimizations that take a great deal of
3475 compilation time.
3476
3477 @option{-O} turns on the following optimization flags:
3478 @gccoptlist{-fdefer-pop
3479 -fmerge-constants
3480 -fthread-jumps
3481 -floop-optimize
3482 -fcrossjumping
3483 -fif-conversion
3484 -fif-conversion2
3485 -fdelayed-branch
3486 -fguess-branch-probability
3487 -fcprop-registers}
3488
3489 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3490 where doing so does not interfere with debugging.
3491
3492 @item -O2
3493 @opindex O2
3494 Optimize even more. GCC performs nearly all supported optimizations
3495 that do not involve a space-speed tradeoff. The compiler does not
3496 perform loop unrolling or function inlining when you specify @option{-O2}.
3497 As compared to @option{-O}, this option increases both compilation time
3498 and the performance of the generated code.
3499
3500 @option{-O2} turns on all optimization flags specified by @option{-O}. It
3501 also turns on the following optimization flags:
3502 @gccoptlist{-fforce-mem
3503 -foptimize-sibling-calls
3504 -fstrength-reduce
3505 -fcse-follow-jumps -fcse-skip-blocks
3506 -frerun-cse-after-loop -frerun-loop-opt
3507 -fgcse -fgcse-lm -fgcse-sm
3508 -fdelete-null-pointer-checks
3509 -fexpensive-optimizations
3510 -fregmove
3511 -fschedule-insns -fschedule-insns2
3512 -fsched-interblock -fsched-spec
3513 -fcaller-saves
3514 -fpeephole2
3515 -freorder-blocks -freorder-functions
3516 -fstrict-aliasing
3517 -falign-functions -falign-jumps
3518 -falign-loops -falign-labels}
3519
3520 Please note the warning under @option{-fgcse} about
3521 invoking @option{-O2} on programs that use computed gotos.
3522
3523 @item -O3
3524 @opindex O3
3525 Optimize yet more. @option{-O3} turns on all optimizations specified by
3526 @option{-O2} and also turns on the @option{-finline-functions},
3527 @option{-funit-at-a-time} and @option{-frename-registers} options.
3528
3529 @item -O0
3530 @opindex O0
3531 Do not optimize. This is the default.
3532
3533 @item -Os
3534 @opindex Os
3535 Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
3536 do not typically increase code size. It also performs further
3537 optimizations designed to reduce code size.
3538
3539 @option{-Os} disables the following optimization flags:
3540 @gccoptlist{-falign-functions -falign-jumps -falign-loops
3541 -falign-labels -freorder-blocks -fprefetch-loop-arrays}
3542
3543 If you use multiple @option{-O} options, with or without level numbers,
3544 the last such option is the one that is effective.
3545 @end table
3546
3547 Options of the form @option{-f@var{flag}} specify machine-independent
3548 flags. Most flags have both positive and negative forms; the negative
3549 form of @option{-ffoo} would be @option{-fno-foo}. In the table
3550 below, only one of the forms is listed---the one you typically will
3551 use. You can figure out the other form by either removing @samp{no-}
3552 or adding it.
3553
3554 The following options control specific optimizations. They are either
3555 activated by @option{-O} options or are related to ones that are. You
3556 can use the following flags in the rare cases when ``fine-tuning'' of
3557 optimizations to be performed is desired.
3558
3559 @table @gcctabopt
3560 @item -fno-default-inline
3561 @opindex fno-default-inline
3562 Do not make member functions inline by default merely because they are
3563 defined inside the class scope (C++ only). Otherwise, when you specify
3564 @w{@option{-O}}, member functions defined inside class scope are compiled
3565 inline by default; i.e., you don't need to add @samp{inline} in front of
3566 the member function name.
3567
3568 @item -fno-defer-pop
3569 @opindex fno-defer-pop
3570 Always pop the arguments to each function call as soon as that function
3571 returns. For machines which must pop arguments after a function call,
3572 the compiler normally lets arguments accumulate on the stack for several
3573 function calls and pops them all at once.
3574
3575 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3576
3577 @item -fforce-mem
3578 @opindex fforce-mem
3579 Force memory operands to be copied into registers before doing
3580 arithmetic on them. This produces better code by making all memory
3581 references potential common subexpressions. When they are not common
3582 subexpressions, instruction combination should eliminate the separate
3583 register-load.
3584
3585 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3586
3587 @item -fforce-addr
3588 @opindex fforce-addr
3589 Force memory address constants to be copied into registers before
3590 doing arithmetic on them. This may produce better code just as
3591 @option{-fforce-mem} may.
3592
3593 @item -fomit-frame-pointer
3594 @opindex fomit-frame-pointer
3595 Don't keep the frame pointer in a register for functions that
3596 don't need one. This avoids the instructions to save, set up and
3597 restore frame pointers; it also makes an extra register available
3598 in many functions. @strong{It also makes debugging impossible on
3599 some machines.}
3600
3601 On some machines, such as the VAX, this flag has no effect, because
3602 the standard calling sequence automatically handles the frame pointer
3603 and nothing is saved by pretending it doesn't exist. The
3604 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3605 whether a target machine supports this flag. @xref{Registers,,Register
3606 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3607
3608 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3609
3610 @item -foptimize-sibling-calls
3611 @opindex foptimize-sibling-calls
3612 Optimize sibling and tail recursive calls.
3613
3614 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3615
3616 @item -fno-inline
3617 @opindex fno-inline
3618 Don't pay attention to the @code{inline} keyword. Normally this option
3619 is used to keep the compiler from expanding any functions inline.
3620 Note that if you are not optimizing, no functions can be expanded inline.
3621
3622 @item -finline-functions
3623 @opindex finline-functions
3624 Integrate all simple functions into their callers. The compiler
3625 heuristically decides which functions are simple enough to be worth
3626 integrating in this way.
3627
3628 If all calls to a given function are integrated, and the function is
3629 declared @code{static}, then the function is normally not output as
3630 assembler code in its own right.
3631
3632 Enabled at level @option{-O3}.
3633
3634 @item -finline-limit=@var{n}
3635 @opindex finline-limit
3636 By default, gcc limits the size of functions that can be inlined. This flag
3637 allows the control of this limit for functions that are explicitly marked as
3638 inline (i.e., marked with the inline keyword or defined within the class
3639 definition in c++). @var{n} is the size of functions that can be inlined in
3640 number of pseudo instructions (not counting parameter handling). The default
3641 value of @var{n} is 600.
3642 Increasing this value can result in more inlined code at
3643 the cost of compilation time and memory consumption. Decreasing usually makes
3644 the compilation faster and less code will be inlined (which presumably
3645 means slower programs). This option is particularly useful for programs that
3646 use inlining heavily such as those based on recursive templates with C++.
3647
3648 Inlining is actually controlled by a number of parameters, which may be
3649 specified individually by using @option{--param @var{name}=@var{value}}.
3650 The @option{-finline-limit=@var{n}} option sets some of these parameters
3651 as follows:
3652
3653 @table @gcctabopt
3654 @item max-inline-insns
3655 is set to @var{n}.
3656 @item max-inline-insns-single
3657 is set to @var{n}/2.
3658 @item max-inline-insns-single-auto
3659 is set to @var{n}/2.
3660 @item min-inline-insns
3661 is set to 130 or @var{n}/4, whichever is smaller.
3662 @item max-inline-insns-rtl
3663 is set to @var{n}.
3664 @end table
3665
3666 Using @option{-finline-limit=600} thus results in the default settings
3667 for these parameters. See below for a documentation of the individual
3668 parameters controlling inlining.
3669
3670 @emph{Note:} pseudo instruction represents, in this particular context, an
3671 abstract measurement of function's size. In no way, it represents a count
3672 of assembly instructions and as such its exact meaning might change from one
3673 release to an another.
3674
3675 @item -fkeep-inline-functions
3676 @opindex fkeep-inline-functions
3677 Even if all calls to a given function are integrated, and the function
3678 is declared @code{static}, nevertheless output a separate run-time
3679 callable version of the function. This switch does not affect
3680 @code{extern inline} functions.
3681
3682 @item -fkeep-static-consts
3683 @opindex fkeep-static-consts
3684 Emit variables declared @code{static const} when optimization isn't turned
3685 on, even if the variables aren't referenced.
3686
3687 GCC enables this option by default. If you want to force the compiler to
3688 check if the variable was referenced, regardless of whether or not
3689 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3690
3691 @item -fmerge-constants
3692 Attempt to merge identical constants (string constants and floating point
3693 constants) across compilation units.
3694
3695 This option is the default for optimized compilation if the assembler and
3696 linker support it. Use @option{-fno-merge-constants} to inhibit this
3697 behavior.
3698
3699 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3700
3701 @item -fmerge-all-constants
3702 Attempt to merge identical constants and identical variables.
3703
3704 This option implies @option{-fmerge-constants}. In addition to
3705 @option{-fmerge-constants} this considers e.g. even constant initialized
3706 arrays or initialized constant variables with integral or floating point
3707 types. Languages like C or C++ require each non-automatic variable to
3708 have distinct location, so using this option will result in non-conforming
3709 behavior.
3710
3711 @item -fnew-ra
3712 @opindex fnew-ra
3713 Use a graph coloring register allocator. Currently this option is meant
3714 for testing, so we are interested to hear about miscompilations with
3715 @option{-fnew-ra}.
3716
3717 @item -fno-branch-count-reg
3718 @opindex fno-branch-count-reg
3719 Do not use ``decrement and branch'' instructions on a count register,
3720 but instead generate a sequence of instructions that decrement a
3721 register, compare it against zero, then branch based upon the result.
3722 This option is only meaningful on architectures that support such
3723 instructions, which include x86, PowerPC, IA-64 and S/390.
3724
3725 The default is @option{-fbranch-count-reg}, enabled when
3726 @option{-fstrength-reduce} is enabled.
3727
3728 @item -fno-function-cse
3729 @opindex fno-function-cse
3730 Do not put function addresses in registers; make each instruction that
3731 calls a constant function contain the function's address explicitly.
3732
3733 This option results in less efficient code, but some strange hacks
3734 that alter the assembler output may be confused by the optimizations
3735 performed when this option is not used.
3736
3737 The default is @option{-ffunction-cse}
3738
3739 @item -fno-zero-initialized-in-bss
3740 @opindex fno-zero-initialized-in-bss
3741 If the target supports a BSS section, GCC by default puts variables that
3742 are initialized to zero into BSS@. This can save space in the resulting
3743 code.
3744
3745 This option turns off this behavior because some programs explicitly
3746 rely on variables going to the data section. E.g., so that the
3747 resulting executable can find the beginning of that section and/or make
3748 assumptions based on that.
3749
3750 The default is @option{-fzero-initialized-in-bss}.
3751
3752 @item -fstrength-reduce
3753 @opindex fstrength-reduce
3754 Perform the optimizations of loop strength reduction and
3755 elimination of iteration variables.
3756
3757 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3758
3759 @item -fthread-jumps
3760 @opindex fthread-jumps
3761 Perform optimizations where we check to see if a jump branches to a
3762 location where another comparison subsumed by the first is found. If
3763 so, the first branch is redirected to either the destination of the
3764 second branch or a point immediately following it, depending on whether
3765 the condition is known to be true or false.
3766
3767 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3768
3769 @item -fcse-follow-jumps
3770 @opindex fcse-follow-jumps
3771 In common subexpression elimination, scan through jump instructions
3772 when the target of the jump is not reached by any other path. For
3773 example, when CSE encounters an @code{if} statement with an
3774 @code{else} clause, CSE will follow the jump when the condition
3775 tested is false.
3776
3777 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3778
3779 @item -fcse-skip-blocks
3780 @opindex fcse-skip-blocks
3781 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3782 follow jumps which conditionally skip over blocks. When CSE
3783 encounters a simple @code{if} statement with no else clause,
3784 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3785 body of the @code{if}.
3786
3787 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3788
3789 @item -frerun-cse-after-loop
3790 @opindex frerun-cse-after-loop
3791 Re-run common subexpression elimination after loop optimizations has been
3792 performed.
3793
3794 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3795
3796 @item -frerun-loop-opt
3797 @opindex frerun-loop-opt
3798 Run the loop optimizer twice.
3799
3800 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3801
3802 @item -fgcse
3803 @opindex fgcse
3804 Perform a global common subexpression elimination pass.
3805 This pass also performs global constant and copy propagation.
3806
3807 @emph{Note:} When compiling a program using computed gotos, a GCC
3808 extension, you may get better runtime performance if you disable
3809 the global common subexpression elimination pass by adding
3810 @option{-fno-gcse} to the command line.
3811
3812 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3813
3814 @item -fgcse-lm
3815 @opindex fgcse-lm
3816 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3817 attempt to move loads which are only killed by stores into themselves. This
3818 allows a loop containing a load/store sequence to be changed to a load outside
3819 the loop, and a copy/store within the loop.
3820
3821 Enabled by default when gcse is enabled.
3822
3823 @item -fgcse-sm
3824 @opindex fgcse-sm
3825 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3826 subexpression elimination. This pass will attempt to move stores out of loops.
3827 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3828 can be changed to a load before the loop and a store after the loop.
3829
3830 Enabled by default when gcse is enabled.
3831
3832 @item -floop-optimize
3833 @opindex floop-optimize
3834 Perform loop optimizations: move constant expressions out of loops, simplify
3835 exit test conditions and optionally do strength-reduction and loop unrolling as
3836 well.
3837
3838 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3839
3840 @item -fcrossjumping
3841 @opindex crossjumping
3842 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3843 resulting code may or may not perform better than without cross-jumping.
3844
3845 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3846
3847 @item -fif-conversion
3848 @opindex if-conversion
3849 Attempt to transform conditional jumps into branch-less equivalents. This
3850 include use of conditional moves, min, max, set flags and abs instructions, and
3851 some tricks doable by standard arithmetics. The use of conditional execution
3852 on chips where it is available is controlled by @code{if-conversion2}.
3853
3854 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3855
3856 @item -fif-conversion2
3857 @opindex if-conversion2
3858 Use conditional execution (where available) to transform conditional jumps into
3859 branch-less equivalents.
3860
3861 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3862
3863 @item -fdelete-null-pointer-checks
3864 @opindex fdelete-null-pointer-checks
3865 Use global dataflow analysis to identify and eliminate useless checks
3866 for null pointers. The compiler assumes that dereferencing a null
3867 pointer would have halted the program. If a pointer is checked after
3868 it has already been dereferenced, it cannot be null.
3869
3870 In some environments, this assumption is not true, and programs can
3871 safely dereference null pointers. Use
3872 @option{-fno-delete-null-pointer-checks} to disable this optimization
3873 for programs which depend on that behavior.
3874
3875 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3876
3877 @item -fexpensive-optimizations
3878 @opindex fexpensive-optimizations
3879 Perform a number of minor optimizations that are relatively expensive.
3880
3881 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3882
3883 @item -foptimize-register-move
3884 @itemx -fregmove
3885 @opindex foptimize-register-move
3886 @opindex fregmove
3887 Attempt to reassign register numbers in move instructions and as
3888 operands of other simple instructions in order to maximize the amount of
3889 register tying. This is especially helpful on machines with two-operand
3890 instructions.
3891
3892 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3893 optimization.
3894
3895 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3896
3897 @item -fdelayed-branch
3898 @opindex fdelayed-branch
3899 If supported for the target machine, attempt to reorder instructions
3900 to exploit instruction slots available after delayed branch
3901 instructions.
3902
3903 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3904
3905 @item -fschedule-insns
3906 @opindex fschedule-insns
3907 If supported for the target machine, attempt to reorder instructions to
3908 eliminate execution stalls due to required data being unavailable. This
3909 helps machines that have slow floating point or memory load instructions
3910 by allowing other instructions to be issued until the result of the load
3911 or floating point instruction is required.
3912
3913 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3914
3915 @item -fschedule-insns2
3916 @opindex fschedule-insns2
3917 Similar to @option{-fschedule-insns}, but requests an additional pass of
3918 instruction scheduling after register allocation has been done. This is
3919 especially useful on machines with a relatively small number of
3920 registers and where memory load instructions take more than one cycle.
3921
3922 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3923
3924 @item -fno-sched-interblock
3925 @opindex fno-sched-interblock
3926 Don't schedule instructions across basic blocks. This is normally
3927 enabled by default when scheduling before register allocation, i.e.@:
3928 with @option{-fschedule-insns} or at @option{-O2} or higher.
3929
3930 @item -fno-sched-spec
3931 @opindex fno-sched-spec
3932 Don't allow speculative motion of non-load instructions. This is normally
3933 enabled by default when scheduling before register allocation, i.e.@:
3934 with @option{-fschedule-insns} or at @option{-O2} or higher.
3935
3936 @item -fsched-spec-load
3937 @opindex fsched-spec-load
3938 Allow speculative motion of some load instructions. This only makes
3939 sense when scheduling before register allocation, i.e.@: with
3940 @option{-fschedule-insns} or at @option{-O2} or higher.
3941
3942 @item -fsched-spec-load-dangerous
3943 @opindex fsched-spec-load-dangerous
3944 Allow speculative motion of more load instructions. This only makes
3945 sense when scheduling before register allocation, i.e.@: with
3946 @option{-fschedule-insns} or at @option{-O2} or higher.
3947
3948 @item -fsched2-use-superblocks
3949 @opindex fsched2-use-superblocks
3950 When schedulilng after register allocation, do use superblock scheduling
3951 algorithm. Superblock scheduling allows motion acress basic block boundaries
3952 resulting on faster schedules. This option is experimental, as not all machine
3953 descriptions used by GCC model the CPU closely enought to avoid unreliable
3954 results from the algorithm.
3955
3956 This only makes sense when scheduling after register allocation, i.e.@: with
3957 @option{-fschedule-insns2} or at @option{-O2} or higher.
3958
3959 @item -fsched2-use-traces
3960 @opindex fsched2-use-traces
3961 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
3962 allocation and additionally perform code duplication in order to increase the
3963 size of superblocks using tracer pass. See @option{-ftracer} for details on
3964 trace formation.
3965
3966 This mode should produce faster but singificantly longer programs. Also
3967 without @code{-fbranch-probabilities} the traces constructed may not match the
3968 reality and hurt the performance. This only makes
3969 sense when scheduling after register allocation, i.e.@: with
3970 @option{-fschedule-insns2} or at @option{-O2} or higher.
3971
3972 @item -fcaller-saves
3973 @opindex fcaller-saves
3974 Enable values to be allocated in registers that will be clobbered by
3975 function calls, by emitting extra instructions to save and restore the
3976 registers around such calls. Such allocation is done only when it
3977 seems to result in better code than would otherwise be produced.
3978
3979 This option is always enabled by default on certain machines, usually
3980 those which have no call-preserved registers to use instead.
3981
3982 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3983
3984 @item -fmove-all-movables
3985 @opindex fmove-all-movables
3986 Forces all invariant computations in loops to be moved
3987 outside the loop.
3988
3989 @item -freduce-all-givs
3990 @opindex freduce-all-givs
3991 Forces all general-induction variables in loops to be
3992 strength-reduced.
3993
3994 @emph{Note:} When compiling programs written in Fortran,
3995 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3996 by default when you use the optimizer.
3997
3998 These options may generate better or worse code; results are highly
3999 dependent on the structure of loops within the source code.
4000
4001 These two options are intended to be removed someday, once
4002 they have helped determine the efficacy of various
4003 approaches to improving loop optimizations.
4004
4005 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4006 know how use of these options affects
4007 the performance of your production code.
4008 We're very interested in code that runs @emph{slower}
4009 when these options are @emph{enabled}.
4010
4011 @item -fno-peephole
4012 @itemx -fno-peephole2
4013 @opindex fno-peephole
4014 @opindex fno-peephole2
4015 Disable any machine-specific peephole optimizations. The difference
4016 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4017 are implemented in the compiler; some targets use one, some use the
4018 other, a few use both.
4019
4020 @option{-fpeephole} is enabled by default.
4021 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4022
4023 @item -fno-guess-branch-probability
4024 @opindex fno-guess-branch-probability
4025 Do not guess branch probabilities using a randomized model.
4026
4027 Sometimes gcc will opt to use a randomized model to guess branch
4028 probabilities, when none are available from either profiling feedback
4029 (@option{-fprofile-arcs}) or @samp{__builtin_expect}. This means that
4030 different runs of the compiler on the same program may produce different
4031 object code.
4032
4033 In a hard real-time system, people don't want different runs of the
4034 compiler to produce code that has different behavior; minimizing
4035 non-determinism is of paramount import. This switch allows users to
4036 reduce non-determinism, possibly at the expense of inferior
4037 optimization.
4038
4039 The default is @option{-fguess-branch-probability} at levels
4040 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4041
4042 @item -freorder-blocks
4043 @opindex freorder-blocks
4044 Reorder basic blocks in the compiled function in order to reduce number of
4045 taken branches and improve code locality.
4046
4047 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4048
4049 @item -freorder-functions
4050 @opindex freorder-functions
4051 Reorder basic blocks in the compiled function in order to reduce number of
4052 taken branches and improve code locality. This is implemented by using special
4053 subsections @code{text.hot} for most frequently executed functions and
4054 @code{text.unlikely} for unlikely executed functions. Reordering is done by
4055 the linker so object file format must support named sections and linker must
4056 place them in a reasonable way.
4057
4058 Also profile feedback must be available in to make this option effective. See
4059 @option{-fprofile-arcs} for details.
4060
4061 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4062
4063 @item -fstrict-aliasing
4064 @opindex fstrict-aliasing
4065 Allows the compiler to assume the strictest aliasing rules applicable to
4066 the language being compiled. For C (and C++), this activates
4067 optimizations based on the type of expressions. In particular, an
4068 object of one type is assumed never to reside at the same address as an
4069 object of a different type, unless the types are almost the same. For
4070 example, an @code{unsigned int} can alias an @code{int}, but not a
4071 @code{void*} or a @code{double}. A character type may alias any other
4072 type.
4073
4074 Pay special attention to code like this:
4075 @example
4076 union a_union @{
4077 int i;
4078 double d;
4079 @};
4080
4081 int f() @{
4082 a_union t;
4083 t.d = 3.0;
4084 return t.i;
4085 @}
4086 @end example
4087 The practice of reading from a different union member than the one most
4088 recently written to (called ``type-punning'') is common. Even with
4089 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4090 is accessed through the union type. So, the code above will work as
4091 expected. However, this code might not:
4092 @example
4093 int f() @{
4094 a_union t;
4095 int* ip;
4096 t.d = 3.0;
4097 ip = &t.i;
4098 return *ip;
4099 @}
4100 @end example
4101
4102 Every language that wishes to perform language-specific alias analysis
4103 should define a function that computes, given an @code{tree}
4104 node, an alias set for the node. Nodes in different alias sets are not
4105 allowed to alias. For an example, see the C front-end function
4106 @code{c_get_alias_set}.
4107
4108 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4109
4110 @item -falign-functions
4111 @itemx -falign-functions=@var{n}
4112 @opindex falign-functions
4113 Align the start of functions to the next power-of-two greater than
4114 @var{n}, skipping up to @var{n} bytes. For instance,
4115 @option{-falign-functions=32} aligns functions to the next 32-byte
4116 boundary, but @option{-falign-functions=24} would align to the next
4117 32-byte boundary only if this can be done by skipping 23 bytes or less.
4118
4119 @option{-fno-align-functions} and @option{-falign-functions=1} are
4120 equivalent and mean that functions will not be aligned.
4121
4122 Some assemblers only support this flag when @var{n} is a power of two;
4123 in that case, it is rounded up.
4124
4125 If @var{n} is not specified, use a machine-dependent default.
4126
4127 Enabled at levels @option{-O2}, @option{-O3}.
4128
4129 @item -falign-labels
4130 @itemx -falign-labels=@var{n}
4131 @opindex falign-labels
4132 Align all branch targets to a power-of-two boundary, skipping up to
4133 @var{n} bytes like @option{-falign-functions}. This option can easily
4134 make code slower, because it must insert dummy operations for when the
4135 branch target is reached in the usual flow of the code.
4136
4137 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4138 are greater than this value, then their values are used instead.
4139
4140 If @var{n} is not specified, use a machine-dependent default which is
4141 very likely to be @samp{1}, meaning no alignment.
4142
4143 Enabled at levels @option{-O2}, @option{-O3}.
4144
4145 @item -falign-loops
4146 @itemx -falign-loops=@var{n}
4147 @opindex falign-loops
4148 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4149 like @option{-falign-functions}. The hope is that the loop will be
4150 executed many times, which will make up for any execution of the dummy
4151 operations.
4152
4153 If @var{n} is not specified, use a machine-dependent default.
4154
4155 Enabled at levels @option{-O2}, @option{-O3}.
4156
4157 @item -falign-jumps
4158 @itemx -falign-jumps=@var{n}
4159 @opindex falign-jumps
4160 Align branch targets to a power-of-two boundary, for branch targets
4161 where the targets can only be reached by jumping, skipping up to @var{n}
4162 bytes like @option{-falign-functions}. In this case, no dummy operations
4163 need be executed.
4164
4165 If @var{n} is not specified, use a machine-dependent default.
4166
4167 Enabled at levels @option{-O2}, @option{-O3}.
4168
4169 @item -frename-registers
4170 @opindex frename-registers
4171 Attempt to avoid false dependencies in scheduled code by making use
4172 of registers left over after register allocation. This optimization
4173 will most benefit processors with lots of registers. It can, however,
4174 make debugging impossible, since variables will no longer stay in
4175 a ``home register''.
4176
4177 Enabled at levels @option{-O3}.
4178
4179 @item -fno-cprop-registers
4180 @opindex fno-cprop-registers
4181 After register allocation and post-register allocation instruction splitting,
4182 we perform a copy-propagation pass to try to reduce scheduling dependencies
4183 and occasionally eliminate the copy.
4184
4185 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4186
4187 @end table
4188
4189 The following options control compiler behavior regarding floating
4190 point arithmetic. These options trade off between speed and
4191 correctness. All must be specifically enabled.
4192
4193 @table @gcctabopt
4194 @item -ffloat-store
4195 @opindex ffloat-store
4196 Do not store floating point variables in registers, and inhibit other
4197 options that might change whether a floating point value is taken from a
4198 register or memory.
4199
4200 @cindex floating point precision
4201 This option prevents undesirable excess precision on machines such as
4202 the 68000 where the floating registers (of the 68881) keep more
4203 precision than a @code{double} is supposed to have. Similarly for the
4204 x86 architecture. For most programs, the excess precision does only
4205 good, but a few programs rely on the precise definition of IEEE floating
4206 point. Use @option{-ffloat-store} for such programs, after modifying
4207 them to store all pertinent intermediate computations into variables.
4208
4209 @item -ffast-math
4210 @opindex ffast-math
4211 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4212 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
4213 @option{-fno-signaling-nans}.
4214
4215 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4216
4217 This option should never be turned on by any @option{-O} option since
4218 it can result in incorrect output for programs which depend on
4219 an exact implementation of IEEE or ISO rules/specifications for
4220 math functions.
4221
4222 @item -fno-math-errno
4223 @opindex fno-math-errno
4224 Do not set ERRNO after calling math functions that are executed
4225 with a single instruction, e.g., sqrt. A program that relies on
4226 IEEE exceptions for math error handling may want to use this flag
4227 for speed while maintaining IEEE arithmetic compatibility.
4228
4229 This option should never be turned on by any @option{-O} option since
4230 it can result in incorrect output for programs which depend on
4231 an exact implementation of IEEE or ISO rules/specifications for
4232 math functions.
4233
4234 The default is @option{-fmath-errno}.
4235
4236 @item -funsafe-math-optimizations
4237 @opindex funsafe-math-optimizations
4238 Allow optimizations for floating-point arithmetic that (a) assume
4239 that arguments and results are valid and (b) may violate IEEE or
4240 ANSI standards. When used at link-time, it may include libraries
4241 or startup files that change the default FPU control word or other
4242 similar optimizations.
4243
4244 This option should never be turned on by any @option{-O} option since
4245 it can result in incorrect output for programs which depend on
4246 an exact implementation of IEEE or ISO rules/specifications for
4247 math functions.
4248
4249 The default is @option{-fno-unsafe-math-optimizations}.
4250
4251 @item -ffinite-math-only
4252 @opindex ffinite-math-only
4253 Allow optimizations for floating-point arithmetic that assume
4254 that arguments and results are not NaNs or +-Infs.
4255
4256 This option should never be turned on by any @option{-O} option since
4257 it can result in incorrect output for programs which depend on
4258 an exact implementation of IEEE or ISO rules/specifications.
4259
4260 The default is @option{-fno-finite-math-only}.
4261
4262 @item -fno-trapping-math
4263 @opindex fno-trapping-math
4264 Compile code assuming that floating-point operations cannot generate
4265 user-visible traps. These traps include division by zero, overflow,
4266 underflow, inexact result and invalid operation. This option implies
4267 @option{-fno-signaling-nans}. Setting this option may allow faster
4268 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4269
4270 This option should never be turned on by any @option{-O} option since
4271 it can result in incorrect output for programs which depend on
4272 an exact implementation of IEEE or ISO rules/specifications for
4273 math functions.
4274
4275 The default is @option{-ftrapping-math}.
4276
4277 @item -fsignaling-nans
4278 @opindex fsignaling-nans
4279 Compile code assuming that IEEE signaling NaNs may generate user-visible
4280 traps during floating-point operations. Setting this option disables
4281 optimizations that may change the number of exceptions visible with
4282 signaling NaNs. This option implies @option{-ftrapping-math}.
4283
4284 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4285 be defined.
4286
4287 The default is @option{-fno-signaling-nans}.
4288
4289 This option is experimental and does not currently guarantee to
4290 disable all GCC optimizations that affect signaling NaN behavior.
4291
4292 @item -fsingle-precision-constant
4293 @opindex fsingle-precision-constant
4294 Treat floating point constant as single precision constant instead of
4295 implicitly converting it to double precision constant.
4296
4297
4298 @end table
4299
4300 The following options control optimizations that may improve
4301 performance, but are not enabled by any @option{-O} options. This
4302 section includes experimental options that may produce broken code.
4303
4304 @table @gcctabopt
4305 @item -fbranch-probabilities
4306 @opindex fbranch-probabilities
4307 After running a program compiled with @option{-fprofile-arcs}
4308 (@pxref{Debugging Options,, Options for Debugging Your Program or
4309 @command{gcc}}), you can compile it a second time using
4310 @option{-fbranch-probabilities}, to improve optimizations based on
4311 the number of times each branch was taken. When the program
4312 compiled with @option{-fprofile-arcs} exits it saves arc execution
4313 counts to a file called @file{@var{sourcename}.da} for each source
4314 file The information in this data file is very dependent on the
4315 structure of the generated code, so you must use the same source code
4316 and the same optimization options for both compilations.
4317
4318 With @option{-fbranch-probabilities}, GCC puts a
4319 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4320 These can be used to improve optimization. Currently, they are only
4321 used in one place: in @file{reorg.c}, instead of guessing which path a
4322 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4323 exactly determine which path is taken more often.
4324
4325 @item -fnew-ra
4326 @opindex fnew-ra
4327 Use a graph coloring register allocator. Currently this option is meant
4328 for testing, so we are interested to hear about miscompilations with
4329 @option{-fnew-ra}.
4330
4331 @item -ftracer
4332 @opindex ftracer
4333 Perform tail duplication to enlarge superblock size. This transformation
4334 simplifies the control flow of the function allowing other optimizations to do
4335 better job.
4336
4337 @item -funit-at-a-time
4338 @opindex funit-at-a-time
4339 Parse the whole compilation unit before starting to produce code. This allows some
4340 extra optimizations to take place but consumes more memory.
4341
4342 @item -funroll-loops
4343 @opindex funroll-loops
4344 Unroll loops whose number of iterations can be determined at compile time or
4345 upon entry to the loop. @option{-funroll-loops} implies
4346 @option{-frerun-cse-after-loop}. It also turns on complete loop peeling
4347 (i.e. complete removal of loops with small constant number of iterations).
4348 This option makes code larger, and may or may not make it run faster.
4349
4350 @item -funroll-all-loops
4351 @opindex funroll-all-loops
4352 Unroll all loops, even if their number of iterations is uncertain when
4353 the loop is entered. This usually makes programs run more slowly.
4354 @option{-funroll-all-loops} implies the same options as
4355 @option{-funroll-loops}.
4356
4357 @item -fpeel-loops
4358 @opindex fpeel-loops
4359 Peels the loops for that there is enough information that they do not
4360 roll much (from profile feedback). It also turns on complete loop peeling
4361 (i.e. complete removal of loops with small constant number of iterations).
4362
4363 @item -funswitch-loops
4364 @opindex funswitch-loops
4365 Move branches with loop invariant conditions out of the loop, with duplicates
4366 of the loop on both branches (modified according to result of the condition).
4367
4368 @item -fold-unroll-loops
4369 @opindex fold-unroll-loops
4370 Unroll loops whose number of iterations can be determined at compile
4371 time or upon entry to the loop, using the old loop unroller whose loop
4372 recognition is based on notes from frontend. @option{-fold-unroll-loops} implies
4373 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}. This
4374 option makes code larger, and may or may not make it run faster.
4375
4376 @item -fold-unroll-all-loops
4377 @opindex fold-unroll-all-loops
4378 Unroll all loops, even if their number of iterations is uncertain when
4379 the loop is entered. This is done using the old loop unroller whose loop
4380 recognition is based on notes from frontend. This usually makes programs run more slowly.
4381 @option{-fold-unroll-all-loops} implies the same options as
4382 @option{-fold-unroll-loops}.
4383
4384 @item -funswitch-loops
4385 @opindex funswitch-loops
4386 Move branches with loop invariant conditions out of the loop, with duplicates
4387 of the loop on both branches (modified according to result of the condition).
4388
4389 @item -funswitch-loops
4390 @opindex funswitch-loops
4391 Move branches with loop invariant conditions out of the loop, with duplicates
4392 of the loop on both branches (modified according to result of the condition).
4393
4394 @item -fprefetch-loop-arrays
4395 @opindex fprefetch-loop-arrays
4396 If supported by the target machine, generate instructions to prefetch
4397 memory to improve the performance of loops that access large arrays.
4398
4399 Disabled at level @option{-Os}.
4400
4401 @item -ffunction-sections
4402 @itemx -fdata-sections
4403 @opindex ffunction-sections
4404 @opindex fdata-sections
4405 Place each function or data item into its own section in the output
4406 file if the target supports arbitrary sections. The name of the
4407 function or the name of the data item determines the section's name
4408 in the output file.
4409
4410 Use these options on systems where the linker can perform optimizations
4411 to improve locality of reference in the instruction space. HPPA
4412 processors running HP-UX and SPARC processors running Solaris 2 have
4413 linkers with such optimizations. Other systems using the ELF object format
4414 as well as AIX may have these optimizations in the future.
4415
4416 Only use these options when there are significant benefits from doing
4417 so. When you specify these options, the assembler and linker will
4418 create larger object and executable files and will also be slower.
4419 You will not be able to use @code{gprof} on all systems if you
4420 specify this option and you may have problems with debugging if
4421 you specify both this option and @option{-g}.
4422
4423 @item -fssa
4424 @opindex fssa
4425 Perform optimizations in static single assignment form. Each function's
4426 flow graph is translated into SSA form, optimizations are performed, and
4427 the flow graph is translated back from SSA form. Users should not
4428 specify this option, since it is not yet ready for production use.
4429
4430 @item -fssa-ccp
4431 @opindex fssa-ccp
4432 Perform Sparse Conditional Constant Propagation in SSA form. Requires
4433 @option{-fssa}. Like @option{-fssa}, this is an experimental feature.
4434
4435 @item -fssa-dce
4436 @opindex fssa-dce
4437 Perform aggressive dead-code elimination in SSA form. Requires @option{-fssa}.
4438 Like @option{-fssa}, this is an experimental feature.
4439
4440
4441
4442
4443 @item --param @var{name}=@var{value}
4444 @opindex param
4445 In some places, GCC uses various constants to control the amount of
4446 optimization that is done. For example, GCC will not inline functions
4447 that contain more that a certain number of instructions. You can
4448 control some of these constants on the command-line using the
4449 @option{--param} option.
4450
4451 In each case, the @var{value} is an integer. The allowable choices for
4452 @var{name} are given in the following table:
4453
4454 @table @gcctabopt
4455 @item max-crossjump-edges
4456 The maximum number of incoming edges to consider for crossjumping.
4457 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4458 the number of edges incoming to each block. Increasing values mean
4459 more aggressive optimization, making the compile time increase with
4460 probably small improvement in executable size.
4461
4462 @item max-delay-slot-insn-search
4463 The maximum number of instructions to consider when looking for an
4464 instruction to fill a delay slot. If more than this arbitrary number of
4465 instructions is searched, the time savings from filling the delay slot
4466 will be minimal so stop searching. Increasing values mean more
4467 aggressive optimization, making the compile time increase with probably
4468 small improvement in executable run time.
4469
4470 @item max-delay-slot-live-search
4471 When trying to fill delay slots, the maximum number of instructions to
4472 consider when searching for a block with valid live register
4473 information. Increasing this arbitrarily chosen value means more
4474 aggressive optimization, increasing the compile time. This parameter
4475 should be removed when the delay slot code is rewritten to maintain the
4476 control-flow graph.
4477
4478 @item max-gcse-memory
4479 The approximate maximum amount of memory that will be allocated in
4480 order to perform the global common subexpression elimination
4481 optimization. If more memory than specified is required, the
4482 optimization will not be done.
4483
4484 @item max-gcse-passes
4485 The maximum number of passes of GCSE to run.
4486
4487 @item max-pending-list-length
4488 The maximum number of pending dependencies scheduling will allow
4489 before flushing the current state and starting over. Large functions
4490 with few branches or calls can create excessively large lists which
4491 needlessly consume memory and resources.
4492
4493 @item max-inline-insns-single
4494 Several parameters control the tree inliner used in gcc.
4495 This number sets the maximum number of instructions (counted in gcc's
4496 internal representation) in a single function that the tree inliner
4497 will consider for inlining. This only affects functions declared
4498 inline and methods implemented in a class declaration (C++).
4499 The default value is 300.
4500
4501 @item max-inline-insns-auto
4502 When you use @option{-finline-functions} (included in @option{-O3}),
4503 a lot of functions that would otherwise not be considered for inlining
4504 by the compiler will be investigated. To those functions, a different
4505 (more restrictive) limit compared to functions declared inline can
4506 be applied.
4507 The default value is 300.
4508
4509 @item max-inline-insns
4510 The tree inliner does decrease the allowable size for single functions
4511 to be inlined after we already inlined the number of instructions
4512 given here by repeated inlining. This number should be a factor of
4513 two or more larger than the single function limit.
4514 Higher numbers result in better runtime performance, but incur higher
4515 compile-time resource (CPU time, memory) requirements and result in
4516 larger binaries. Very high values are not advisable, as too large
4517 binaries may adversely affect runtime performance.
4518 The default value is 600.
4519
4520 @item max-inline-slope
4521 After exceeding the maximum number of inlined instructions by repeated
4522 inlining, a linear function is used to decrease the allowable size
4523 for single functions. The slope of that function is the negative
4524 reciprocal of the number specified here.
4525 The default value is 32.
4526
4527 @item min-inline-insns
4528 The repeated inlining is throttled more and more by the linear function
4529 after exceeding the limit. To avoid too much throttling, a minimum for
4530 this function is specified here to allow repeated inlining for very small
4531 functions even when a lot of repeated inlining already has been done.
4532 The default value is 130.
4533
4534 @item max-inline-insns-rtl
4535 For languages that use the RTL inliner (this happens at a later stage
4536 than tree inlining), you can set the maximum allowable size (counted
4537 in RTL instructions) for the RTL inliner with this parameter.
4538 The default value is 600.
4539
4540
4541 @item max-unrolled-insns
4542 The maximum number of instructions that a loop should have if that loop
4543 is unrolled, and if the loop is unrolled, it determines how many times
4544 the loop code is unrolled.
4545
4546 @item max-average-unrolled-insns
4547 The maximum number of instructions biased by probabilities of their execution
4548 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4549 it determines how many times the loop code is unrolled.
4550
4551 @item max-unroll-times
4552 The maximum number of unrollings of a single loop.
4553
4554 @item max-peeled-insns
4555 The maximum number of instructions that a loop should have if that loop
4556 is peeled, and if the loop is peeled, it determines how many times
4557 the loop code is peeled.
4558
4559 @item max-peel-times
4560 The maximum number of peelings of a single loop.
4561
4562 @item max-completely-peeled-insns
4563 The maximum number of insns of a completely peeled loop.
4564
4565 @item max-completely-peel-times
4566 The maximum number of iterations of a loop to be suitable for complete peeling.
4567
4568 @item max-unswitch-insns
4569 The maximum number of insns of an unswitched loop.
4570
4571 @item max-unswitch-level
4572 The maximum number of branches unswitched in a single loop.
4573
4574 @item hot-bb-count-fraction
4575 Select fraction of the maximal count of repetitions of basic block in program
4576 given basic block needs to have to be considered hot.
4577
4578 @item hot-bb-frequency-fraction
4579 Select fraction of the maximal frequency of executions of basic block in
4580 function given basic block needs to have to be considered hot
4581
4582 @item tracer-dynamic-coverage
4583 @itemx tracer-dynamic-coverage-feedback
4584
4585 This value is used to limit superblock formation once the given percentage of
4586 executed instructions is covered. This limits unnecessary code size
4587 expansion.
4588
4589 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4590 feedback is available. The real profiles (as opposed to statically estimated
4591 ones) are much less balanced allowing the threshold to be larger value.
4592
4593 @item tracer-max-code-growth
4594 Stop tail duplication once code growth has reached given percentage. This is
4595 rather hokey argument, as most of the duplicates will be eliminated later in
4596 cross jumping, so it may be set to much higher values than is the desired code
4597 growth.
4598
4599 @item tracer-min-branch-ratio
4600
4601 Stop reverse growth when the reverse probability of best edge is less than this
4602 threshold (in percent).
4603
4604 @item tracer-min-branch-ratio
4605 @itemx tracer-min-branch-ratio-feedback
4606
4607 Stop forward growth if the best edge do have probability lower than this
4608 threshold.
4609
4610 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4611 compilation for profile feedback and one for compilation without. The value
4612 for compilation with profile feedback needs to be more conservative (higher) in
4613 order to make tracer effective.
4614
4615 @item ggc-min-expand
4616
4617 GCC uses a garbage collector to manage its own memory allocation. This
4618 parameter specifies the minimum percentage by which the garbage
4619 collector's heap should be allowed to expand between collections.
4620 Tuning this may improve compilation speed; it has no effect on code
4621 generation.
4622
4623 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4624 RAM >= 1GB. If @code{getrlimit} is available, the notion of "RAM" is
4625 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS. If
4626 GCC is not able to calculate RAM on a particular platform, the lower
4627 bound of 30% is used. Setting this parameter and
4628 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4629 every opportunity. This is extremely slow, but can be useful for
4630 debugging.
4631
4632 @item ggc-min-heapsize
4633
4634 Minimum size of the garbage collector's heap before it begins bothering
4635 to collect garbage. The first collection occurs after the heap expands
4636 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
4637 tuning this may improve compilation speed, and has no effect on code
4638 generation.
4639
4640 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4641 upper bound of 131072 (128 megabytes). If @code{getrlimit} is
4642 available, the notion of "RAM" is the smallest of actual RAM,
4643 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS. If GCC is not able to calculate
4644 RAM on a particular platform, the lower bound is used. Setting this
4645 parameter very large effectively disables garbage collection. Setting
4646 this parameter and @option{ggc-min-expand} to zero causes a full
4647 collection to occur at every opportunity.
4648
4649 @end table
4650 @end table
4651
4652 @node Preprocessor Options
4653 @section Options Controlling the Preprocessor
4654 @cindex preprocessor options
4655 @cindex options, preprocessor
4656
4657 These options control the C preprocessor, which is run on each C source
4658 file before actual compilation.
4659
4660 If you use the @option{-E} option, nothing is done except preprocessing.
4661 Some of these options make sense only together with @option{-E} because
4662 they cause the preprocessor output to be unsuitable for actual
4663 compilation.
4664
4665 @table @gcctabopt
4666 @opindex Wp
4667 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4668 and pass @var{option} directly through to the preprocessor. If
4669 @var{option} contains commas, it is split into multiple options at the
4670 commas. However, many options are modified, translated or interpreted
4671 by the compiler driver before being passed to the preprocessor, and
4672 @option{-Wp} forcibly bypasses this phase. The preprocessor's direct
4673 interface is undocumented and subject to change, so whenever possible
4674 you should avoid using @option{-Wp} and let the driver handle the
4675 options instead.
4676
4677 @item -Xpreprocessor @var{option}
4678 @opindex preprocessor
4679 Pass @var{option} as an option to the preprocessor. You can use this to
4680 supply system-specific preprocessor options which GCC does not know how to
4681 recognize.
4682
4683 If you want to pass an option that takes an argument, you must use
4684 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4685 @end table
4686
4687 @include cppopts.texi
4688
4689 @node Assembler Options
4690 @section Passing Options to the Assembler
4691
4692 @c prevent bad page break with this line
4693 You can pass options to the assembler.
4694
4695 @table @gcctabopt
4696 @item -Wa,@var{option}
4697 @opindex Wa
4698 Pass @var{option} as an option to the assembler. If @var{option}
4699 contains commas, it is split into multiple options at the commas.
4700
4701 @item -Xassembler @var{option}
4702 @opindex Xassembler
4703 Pass @var{option} as an option to the assembler. You can use this to
4704 supply system-specific assembler options which GCC does not know how to
4705 recognize.
4706
4707 If you want to pass an option that takes an argument, you must use
4708 @option{-Xassembler} twice, once for the option and once for the argument.
4709
4710 @end table
4711
4712 @node Link Options
4713 @section Options for Linking
4714 @cindex link options
4715 @cindex options, linking
4716
4717 These options come into play when the compiler links object files into
4718 an executable output file. They are meaningless if the compiler is
4719 not doing a link step.
4720
4721 @table @gcctabopt
4722 @cindex file names
4723 @item @var{object-file-name}
4724 A file name that does not end in a special recognized suffix is
4725 considered to name an object file or library. (Object files are
4726 distinguished from libraries by the linker according to the file
4727 contents.) If linking is done, these object files are used as input
4728 to the linker.
4729
4730 @item -c
4731 @itemx -S
4732 @itemx -E
4733 @opindex c
4734 @opindex S
4735 @opindex E
4736 If any of these options is used, then the linker is not run, and
4737 object file names should not be used as arguments. @xref{Overall
4738 Options}.
4739
4740 @cindex Libraries
4741 @item -l@var{library}
4742 @itemx -l @var{library}
4743 @opindex l
4744 Search the library named @var{library} when linking. (The second
4745 alternative with the library as a separate argument is only for
4746 POSIX compliance and is not recommended.)
4747
4748 It makes a difference where in the command you write this option; the
4749 linker searches and processes libraries and object files in the order they
4750 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4751 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
4752 to functions in @samp{z}, those functions may not be loaded.
4753
4754 The linker searches a standard list of directories for the library,
4755 which is actually a file named @file{lib@var{library}.a}. The linker
4756 then uses this file as if it had been specified precisely by name.
4757
4758 The directories searched include several standard system directories
4759 plus any that you specify with @option{-L}.
4760
4761 Normally the files found this way are library files---archive files
4762 whose members are object files. The linker handles an archive file by
4763 scanning through it for members which define symbols that have so far
4764 been referenced but not defined. But if the file that is found is an
4765 ordinary object file, it is linked in the usual fashion. The only
4766 difference between using an @option{-l} option and specifying a file name
4767 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4768 and searches several directories.
4769
4770 @item -lobjc
4771 @opindex lobjc
4772 You need this special case of the @option{-l} option in order to
4773 link an Objective-C program.
4774
4775 @item -nostartfiles
4776 @opindex nostartfiles
4777 Do not use the standard system startup files when linking.
4778 The standard system libraries are used normally, unless @option{-nostdlib}
4779 or @option{-nodefaultlibs} is used.
4780
4781 @item -nodefaultlibs
4782 @opindex nodefaultlibs
4783 Do not use the standard system libraries when linking.
4784 Only the libraries you specify will be passed to the linker.
4785 The standard startup files are used normally, unless @option{-nostartfiles}
4786 is used. The compiler may generate calls to memcmp, memset, and memcpy
4787 for System V (and ISO C) environments or to bcopy and bzero for
4788 BSD environments. These entries are usually resolved by entries in
4789 libc. These entry points should be supplied through some other
4790 mechanism when this option is specified.
4791
4792 @item -nostdlib
4793 @opindex nostdlib
4794 Do not use the standard system startup files or libraries when linking.
4795 No startup files and only the libraries you specify will be passed to
4796 the linker. The compiler may generate calls to memcmp, memset, and memcpy
4797 for System V (and ISO C) environments or to bcopy and bzero for
4798 BSD environments. These entries are usually resolved by entries in
4799 libc. These entry points should be supplied through some other
4800 mechanism when this option is specified.
4801
4802 @cindex @option{-lgcc}, use with @option{-nostdlib}
4803 @cindex @option{-nostdlib} and unresolved references
4804 @cindex unresolved references and @option{-nostdlib}
4805 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4806 @cindex @option{-nodefaultlibs} and unresolved references
4807 @cindex unresolved references and @option{-nodefaultlibs}
4808 One of the standard libraries bypassed by @option{-nostdlib} and
4809 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4810 that GCC uses to overcome shortcomings of particular machines, or special
4811 needs for some languages.
4812 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4813 Collection (GCC) Internals},
4814 for more discussion of @file{libgcc.a}.)
4815 In most cases, you need @file{libgcc.a} even when you want to avoid
4816 other standard libraries. In other words, when you specify @option{-nostdlib}
4817 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4818 This ensures that you have no unresolved references to internal GCC
4819 library subroutines. (For example, @samp{__main}, used to ensure C++
4820 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4821 GNU Compiler Collection (GCC) Internals}.)
4822
4823 @item -s
4824 @opindex s
4825 Remove all symbol table and relocation information from the executable.
4826
4827 @item -static
4828 @opindex static
4829 On systems that support dynamic linking, this prevents linking with the shared
4830 libraries. On other systems, this option has no effect.
4831
4832 @item -shared
4833 @opindex shared
4834 Produce a shared object which can then be linked with other objects to
4835 form an executable. Not all systems support this option. For predictable
4836 results, you must also specify the same set of options that were used to
4837 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4838 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4839 needs to build supplementary stub code for constructors to work. On
4840 multi-libbed systems, @samp{gcc -shared} must select the correct support
4841 libraries to link against. Failing to supply the correct flags may lead
4842 to subtle defects. Supplying them in cases where they are not necessary
4843 is innocuous.}
4844
4845 @item -shared-libgcc
4846 @itemx -static-libgcc
4847 @opindex shared-libgcc
4848 @opindex static-libgcc
4849 On systems that provide @file{libgcc} as a shared library, these options
4850 force the use of either the shared or static version respectively.
4851 If no shared version of @file{libgcc} was built when the compiler was
4852 configured, these options have no effect.
4853
4854 There are several situations in which an application should use the
4855 shared @file{libgcc} instead of the static version. The most common
4856 of these is when the application wishes to throw and catch exceptions
4857 across different shared libraries. In that case, each of the libraries
4858 as well as the application itself should use the shared @file{libgcc}.
4859
4860 Therefore, the G++ and GCJ drivers automatically add
4861 @option{-shared-libgcc} whenever you build a shared library or a main
4862 executable, because C++ and Java programs typically use exceptions, so
4863 this is the right thing to do.
4864
4865 If, instead, you use the GCC driver to create shared libraries, you may
4866 find that they will not always be linked with the shared @file{libgcc}.
4867 If GCC finds, at its configuration time, that you have a GNU linker that
4868 does not support option @option{--eh-frame-hdr}, it will link the shared
4869 version of @file{libgcc} into shared libraries by default. Otherwise,
4870 it will take advantage of the linker and optimize away the linking with
4871 the shared version of @file{libgcc}, linking with the static version of
4872 libgcc by default. This allows exceptions to propagate through such
4873 shared libraries, without incurring relocation costs at library load
4874 time.
4875
4876 However, if a library or main executable is supposed to throw or catch
4877 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4878 for the languages used in the program, or using the option
4879 @option{-shared-libgcc}, such that it is linked with the shared
4880 @file{libgcc}.
4881
4882 @item -symbolic
4883 @opindex symbolic
4884 Bind references to global symbols when building a shared object. Warn
4885 about any unresolved references (unless overridden by the link editor
4886 option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
4887 this option.
4888
4889 @item -Xlinker @var{option}
4890 @opindex Xlinker
4891 Pass @var{option} as an option to the linker. You can use this to
4892 supply system-specific linker options which GCC does not know how to
4893 recognize.
4894
4895 If you want to pass an option that takes an argument, you must use
4896 @option{-Xlinker} twice, once for the option and once for the argument.
4897 For example, to pass @option{-assert definitions}, you must write
4898 @samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
4899 @option{-Xlinker "-assert definitions"}, because this passes the entire
4900 string as a single argument, which is not what the linker expects.
4901
4902 @item -Wl,@var{option}
4903 @opindex Wl
4904 Pass @var{option} as an option to the linker. If @var{option} contains
4905 commas, it is split into multiple options at the commas.
4906
4907 @item -u @var{symbol}
4908 @opindex u
4909 Pretend the symbol @var{symbol} is undefined, to force linking of
4910 library modules to define it. You can use @option{-u} multiple times with
4911 different symbols to force loading of additional library modules.
4912 @end table
4913
4914 @node Directory Options
4915 @section Options for Directory Search
4916 @cindex directory options
4917 @cindex options, directory search
4918 @cindex search path
4919
4920 These options specify directories to search for header files, for
4921 libraries and for parts of the compiler:
4922
4923 @table @gcctabopt
4924 @item -I@var{dir}
4925 @opindex I
4926 Add the directory @var{dir} to the head of the list of directories to be
4927 searched for header files. This can be used to override a system header
4928 file, substituting your own version, since these directories are
4929 searched before the system header file directories. However, you should
4930 not use this option to add directories that contain vendor-supplied
4931 system header files (use @option{-isystem} for that). If you use more than
4932 one @option{-I} option, the directories are scanned in left-to-right
4933 order; the standard system directories come after.
4934
4935 If a standard system include directory, or a directory specified with
4936 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4937 option will be ignored. The directory will still be searched but as a
4938 system directory at its normal position in the system include chain.
4939 This is to ensure that GCC's procedure to fix buggy system headers and
4940 the ordering for the include_next directive are not inadvertently changed.
4941 If you really need to change the search order for system directories,
4942 use the @option{-nostdinc} and/or @option{-isystem} options.
4943
4944 @item -I-
4945 @opindex I-
4946 Any directories you specify with @option{-I} options before the @option{-I-}
4947 option are searched only for the case of @samp{#include "@var{file}"};
4948 they are not searched for @samp{#include <@var{file}>}.
4949
4950 If additional directories are specified with @option{-I} options after
4951 the @option{-I-}, these directories are searched for all @samp{#include}
4952 directives. (Ordinarily @emph{all} @option{-I} directories are used
4953 this way.)
4954
4955 In addition, the @option{-I-} option inhibits the use of the current
4956 directory (where the current input file came from) as the first search
4957 directory for @samp{#include "@var{file}"}. There is no way to
4958 override this effect of @option{-I-}. With @option{-I.} you can specify
4959 searching the directory which was current when the compiler was
4960 invoked. That is not exactly the same as what the preprocessor does
4961 by default, but it is often satisfactory.
4962
4963 @option{-I-} does not inhibit the use of the standard system directories
4964 for header files. Thus, @option{-I-} and @option{-nostdinc} are
4965 independent.
4966
4967 @item -L@var{dir}
4968 @opindex L
4969 Add directory @var{dir} to the list of directories to be searched
4970 for @option{-l}.
4971
4972 @item -B@var{prefix}
4973 @opindex B
4974 This option specifies where to find the executables, libraries,
4975 include files, and data files of the compiler itself.
4976
4977 The compiler driver program runs one or more of the subprograms
4978 @file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
4979 @var{prefix} as a prefix for each program it tries to run, both with and
4980 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4981
4982 For each subprogram to be run, the compiler driver first tries the
4983 @option{-B} prefix, if any. If that name is not found, or if @option{-B}
4984 was not specified, the driver tries two standard prefixes, which are
4985 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}. If neither of
4986 those results in a file name that is found, the unmodified program
4987 name is searched for using the directories specified in your
4988 @env{PATH} environment variable.
4989
4990 The compiler will check to see if the path provided by the @option{-B}
4991 refers to a directory, and if necessary it will add a directory
4992 separator character at the end of the path.
4993
4994 @option{-B} prefixes that effectively specify directory names also apply
4995 to libraries in the linker, because the compiler translates these
4996 options into @option{-L} options for the linker. They also apply to
4997 includes files in the preprocessor, because the compiler translates these
4998 options into @option{-isystem} options for the preprocessor. In this case,
4999 the compiler appends @samp{include} to the prefix.
5000
5001 The run-time support file @file{libgcc.a} can also be searched for using
5002 the @option{-B} prefix, if needed. If it is not found there, the two
5003 standard prefixes above are tried, and that is all. The file is left
5004 out of the link if it is not found by those means.
5005
5006 Another way to specify a prefix much like the @option{-B} prefix is to use
5007 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
5008 Variables}.
5009
5010 As a special kludge, if the path provided by @option{-B} is
5011 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5012 9, then it will be replaced by @file{[dir/]include}. This is to help
5013 with boot-strapping the compiler.
5014
5015 @item -specs=@var{file}
5016 @opindex specs
5017 Process @var{file} after the compiler reads in the standard @file{specs}
5018 file, in order to override the defaults that the @file{gcc} driver
5019 program uses when determining what switches to pass to @file{cc1},
5020 @file{cc1plus}, @file{as}, @file{ld}, etc. More than one
5021 @option{-specs=@var{file}} can be specified on the command line, and they
5022 are processed in order, from left to right.
5023 @end table
5024
5025 @c man end
5026
5027 @node Spec Files
5028 @section Specifying subprocesses and the switches to pass to them
5029 @cindex Spec Files
5030 @command{gcc} is a driver program. It performs its job by invoking a
5031 sequence of other programs to do the work of compiling, assembling and
5032 linking. GCC interprets its command-line parameters and uses these to
5033 deduce which programs it should invoke, and which command-line options
5034 it ought to place on their command lines. This behavior is controlled
5035 by @dfn{spec strings}. In most cases there is one spec string for each
5036 program that GCC can invoke, but a few programs have multiple spec
5037 strings to control their behavior. The spec strings built into GCC can
5038 be overridden by using the @option{-specs=} command-line switch to specify
5039 a spec file.
5040
5041 @dfn{Spec files} are plaintext files that are used to construct spec
5042 strings. They consist of a sequence of directives separated by blank
5043 lines. The type of directive is determined by the first non-whitespace
5044 character on the line and it can be one of the following:
5045
5046 @table @code
5047 @item %@var{command}
5048 Issues a @var{command} to the spec file processor. The commands that can
5049 appear here are:
5050
5051 @table @code
5052 @item %include <@var{file}>
5053 @cindex %include
5054 Search for @var{file} and insert its text at the current point in the
5055 specs file.
5056
5057 @item %include_noerr <@var{file}>
5058 @cindex %include_noerr
5059 Just like @samp{%include}, but do not generate an error message if the include
5060 file cannot be found.
5061
5062 @item %rename @var{old_name} @var{new_name}
5063 @cindex %rename
5064 Rename the spec string @var{old_name} to @var{new_name}.
5065
5066 @end table
5067
5068 @item *[@var{spec_name}]:
5069 This tells the compiler to create, override or delete the named spec
5070 string. All lines after this directive up to the next directive or
5071 blank line are considered to be the text for the spec string. If this
5072 results in an empty string then the spec will be deleted. (Or, if the
5073 spec did not exist, then nothing will happened.) Otherwise, if the spec
5074 does not currently exist a new spec will be created. If the spec does
5075 exist then its contents will be overridden by the text of this
5076 directive, unless the first character of that text is the @samp{+}
5077 character, in which case the text will be appended to the spec.
5078
5079 @item [@var{suffix}]:
5080 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
5081 and up to the next directive or blank line are considered to make up the
5082 spec string for the indicated suffix. When the compiler encounters an
5083 input file with the named suffix, it will processes the spec string in
5084 order to work out how to compile that file. For example:
5085
5086 @smallexample
5087 .ZZ:
5088 z-compile -input %i
5089 @end smallexample
5090
5091 This says that any input file whose name ends in @samp{.ZZ} should be
5092 passed to the program @samp{z-compile}, which should be invoked with the
5093 command-line switch @option{-input} and with the result of performing the
5094 @samp{%i} substitution. (See below.)
5095
5096 As an alternative to providing a spec string, the text that follows a
5097 suffix directive can be one of the following:
5098
5099 @table @code
5100 @item @@@var{language}
5101 This says that the suffix is an alias for a known @var{language}. This is
5102 similar to using the @option{-x} command-line switch to GCC to specify a
5103 language explicitly. For example:
5104
5105 @smallexample
5106 .ZZ:
5107 @@c++
5108 @end smallexample
5109
5110 Says that .ZZ files are, in fact, C++ source files.
5111
5112 @item #@var{name}
5113 This causes an error messages saying:
5114
5115 @smallexample
5116 @var{name} compiler not installed on this system.
5117 @end smallexample
5118 @end table
5119
5120 GCC already has an extensive list of suffixes built into it.
5121 This directive will add an entry to the end of the list of suffixes, but
5122 since the list is searched from the end backwards, it is effectively
5123 possible to override earlier entries using this technique.
5124
5125 @end table
5126
5127 GCC has the following spec strings built into it. Spec files can
5128 override these strings or create their own. Note that individual
5129 targets can also add their own spec strings to this list.
5130
5131 @smallexample
5132 asm Options to pass to the assembler
5133 asm_final Options to pass to the assembler post-processor
5134 cpp Options to pass to the C preprocessor
5135 cc1 Options to pass to the C compiler
5136 cc1plus Options to pass to the C++ compiler
5137 endfile Object files to include at the end of the link
5138 link Options to pass to the linker
5139 lib Libraries to include on the command line to the linker
5140 libgcc Decides which GCC support library to pass to the linker
5141 linker Sets the name of the linker
5142 predefines Defines to be passed to the C preprocessor
5143 signed_char Defines to pass to CPP to say whether @code{char} is signed
5144 by default
5145 startfile Object files to include at the start of the link
5146 @end smallexample
5147
5148 Here is a small example of a spec file:
5149
5150 @smallexample
5151 %rename lib old_lib
5152
5153 *lib:
5154 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5155 @end smallexample
5156
5157 This example renames the spec called @samp{lib} to @samp{old_lib} and
5158 then overrides the previous definition of @samp{lib} with a new one.
5159 The new definition adds in some extra command-line options before
5160 including the text of the old definition.
5161
5162 @dfn{Spec strings} are a list of command-line options to be passed to their
5163 corresponding program. In addition, the spec strings can contain
5164 @samp{%}-prefixed sequences to substitute variable text or to
5165 conditionally insert text into the command line. Using these constructs
5166 it is possible to generate quite complex command lines.
5167
5168 Here is a table of all defined @samp{%}-sequences for spec
5169 strings. Note that spaces are not generated automatically around the
5170 results of expanding these sequences. Therefore you can concatenate them
5171 together or combine them with constant text in a single argument.
5172
5173 @table @code
5174 @item %%
5175 Substitute one @samp{%} into the program name or argument.
5176
5177 @item %i
5178 Substitute the name of the input file being processed.
5179
5180 @item %b
5181 Substitute the basename of the input file being processed.
5182 This is the substring up to (and not including) the last period
5183 and not including the directory.
5184
5185 @item %B
5186 This is the same as @samp{%b}, but include the file suffix (text after
5187 the last period).
5188
5189 @item %d
5190 Marks the argument containing or following the @samp{%d} as a
5191 temporary file name, so that that file will be deleted if GCC exits
5192 successfully. Unlike @samp{%g}, this contributes no text to the
5193 argument.
5194
5195 @item %g@var{suffix}
5196 Substitute a file name that has suffix @var{suffix} and is chosen
5197 once per compilation, and mark the argument in the same way as
5198 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
5199 name is now chosen in a way that is hard to predict even when previously
5200 chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5201 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
5202 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5203 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
5204 was simply substituted with a file name chosen once per compilation,
5205 without regard to any appended suffix (which was therefore treated
5206 just like ordinary text), making such attacks more likely to succeed.
5207
5208 @item %u@var{suffix}
5209 Like @samp{%g}, but generates a new temporary file name even if
5210 @samp{%u@var{suffix}} was already seen.
5211
5212 @item %U@var{suffix}
5213 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5214 new one if there is no such last file name. In the absence of any
5215 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5216 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5217 would involve the generation of two distinct file names, one
5218 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
5219 simply substituted with a file name chosen for the previous @samp{%u},
5220 without regard to any appended suffix.
5221
5222 @item %j@var{suffix}
5223 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5224 writable, and if save-temps is off; otherwise, substitute the name
5225 of a temporary file, just like @samp{%u}. This temporary file is not
5226 meant for communication between processes, but rather as a junk
5227 disposal mechanism.
5228
5229 @item %|@var{suffix}
5230 @itemx %m@var{suffix}
5231 Like @samp{%g}, except if @option{-pipe} is in effect. In that case
5232 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5233 all. These are the two most common ways to instruct a program that it
5234 should read from standard input or write to standard output. If you
5235 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5236 construct: see for example @file{f/lang-specs.h}.
5237
5238 @item %.@var{SUFFIX}
5239 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5240 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
5241 terminated by the next space or %.
5242
5243 @item %w
5244 Marks the argument containing or following the @samp{%w} as the
5245 designated output file of this compilation. This puts the argument
5246 into the sequence of arguments that @samp{%o} will substitute later.
5247
5248 @item %o
5249 Substitutes the names of all the output files, with spaces
5250 automatically placed around them. You should write spaces
5251 around the @samp{%o} as well or the results are undefined.
5252 @samp{%o} is for use in the specs for running the linker.
5253 Input files whose names have no recognized suffix are not compiled
5254 at all, but they are included among the output files, so they will
5255 be linked.
5256
5257 @item %O
5258 Substitutes the suffix for object files. Note that this is
5259 handled specially when it immediately follows @samp{%g, %u, or %U},
5260 because of the need for those to form complete file names. The
5261 handling is such that @samp{%O} is treated exactly as if it had already
5262 been substituted, except that @samp{%g, %u, and %U} do not currently
5263 support additional @var{suffix} characters following @samp{%O} as they would
5264 following, for example, @samp{.o}.
5265
5266 @item %p
5267 Substitutes the standard macro predefinitions for the
5268 current target machine. Use this when running @code{cpp}.
5269
5270 @item %P
5271 Like @samp{%p}, but puts @samp{__} before and after the name of each
5272 predefined macro, except for macros that start with @samp{__} or with
5273 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
5274 C@.
5275
5276 @item %I
5277 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5278 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5279 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5280 as necessary.
5281
5282 @item %s
5283 Current argument is the name of a library or startup file of some sort.
5284 Search for that file in a standard list of directories and substitute
5285 the full name found.
5286
5287 @item %e@var{str}
5288 Print @var{str} as an error message. @var{str} is terminated by a newline.
5289 Use this when inconsistent options are detected.
5290
5291 @item %(@var{name})
5292 Substitute the contents of spec string @var{name} at this point.
5293
5294 @item %[@var{name}]
5295 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5296
5297 @item %x@{@var{option}@}
5298 Accumulate an option for @samp{%X}.
5299
5300 @item %X
5301 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5302 spec string.
5303
5304 @item %Y
5305 Output the accumulated assembler options specified by @option{-Wa}.
5306
5307 @item %Z
5308 Output the accumulated preprocessor options specified by @option{-Wp}.
5309
5310 @item %a
5311 Process the @code{asm} spec. This is used to compute the
5312 switches to be passed to the assembler.
5313
5314 @item %A
5315 Process the @code{asm_final} spec. This is a spec string for
5316 passing switches to an assembler post-processor, if such a program is
5317 needed.
5318
5319 @item %l
5320 Process the @code{link} spec. This is the spec for computing the
5321 command line passed to the linker. Typically it will make use of the
5322 @samp{%L %G %S %D and %E} sequences.
5323
5324 @item %D
5325 Dump out a @option{-L} option for each directory that GCC believes might
5326 contain startup files. If the target supports multilibs then the
5327 current multilib directory will be prepended to each of these paths.
5328
5329 @item %M
5330 Output the multilib directory with directory separators replaced with
5331 @samp{_}. If multilib directories are not set, or the multilib directory is
5332 @file{.} then this option emits nothing.
5333
5334 @item %L
5335 Process the @code{lib} spec. This is a spec string for deciding which
5336 libraries should be included on the command line to the linker.
5337
5338 @item %G
5339 Process the @code{libgcc} spec. This is a spec string for deciding
5340 which GCC support library should be included on the command line to the linker.
5341
5342 @item %S
5343 Process the @code{startfile} spec. This is a spec for deciding which
5344 object files should be the first ones passed to the linker. Typically
5345 this might be a file named @file{crt0.o}.
5346
5347 @item %E
5348 Process the @code{endfile} spec. This is a spec string that specifies
5349 the last object files that will be passed to the linker.
5350
5351 @item %C
5352 Process the @code{cpp} spec. This is used to construct the arguments
5353 to be passed to the C preprocessor.
5354
5355 @item %c
5356 Process the @code{signed_char} spec. This is intended to be used
5357 to tell cpp whether a char is signed. It typically has the definition:
5358 @smallexample
5359 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5360 @end smallexample
5361
5362 @item %1
5363 Process the @code{cc1} spec. This is used to construct the options to be
5364 passed to the actual C compiler (@samp{cc1}).
5365
5366 @item %2
5367 Process the @code{cc1plus} spec. This is used to construct the options to be
5368 passed to the actual C++ compiler (@samp{cc1plus}).
5369
5370 @item %*
5371 Substitute the variable part of a matched option. See below.
5372 Note that each comma in the substituted string is replaced by
5373 a single space.
5374
5375 @item %<@code{S}
5376 Remove all occurrences of @code{-S} from the command line. Note---this
5377 command is position dependent. @samp{%} commands in the spec string
5378 before this one will see @code{-S}, @samp{%} commands in the spec string
5379 after this one will not.
5380
5381 @item %:@var{function}(@var{args})
5382 Call the named function @var{function}, passing it @var{args}.
5383 @var{args} is first processed as a nested spec string, then split
5384 into an argument vector in the usual fashion. The function returns
5385 a string which is processed as if it had appeared literally as part
5386 of the current spec.
5387
5388 The following built-in spec functions are provided:
5389
5390 @table @code
5391 @item @code{if-exists}
5392 The @code{if-exists} spec function takes one argument, an absolute
5393 pathname to a file. If the file exists, @code{if-exists} returns the
5394 pathname. Here is a small example of its usage:
5395
5396 @smallexample
5397 *startfile:
5398 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5399 @end smallexample
5400
5401 @item @code{if-exists-else}
5402 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5403 spec function, except that it takes two arguments. The first argument is
5404 an absolute pathname to a file. If the file exists, @code{if-exists-else}
5405 returns the pathname. If it does not exist, it returns the second argument.
5406 This way, @code{if-exists-else} can be used to select one file or another,
5407 based on the existence of the first. Here is a small example of its usage:
5408
5409 @smallexample
5410 *startfile:
5411 crt0%O%s %:if-exists(crti%O%s) %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5412 @end smallexample
5413 @end table
5414
5415 @item %@{@code{S}@}
5416 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5417 If that switch was not specified, this substitutes nothing. Note that
5418 the leading dash is omitted when specifying this option, and it is
5419 automatically inserted if the substitution is performed. Thus the spec
5420 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5421 and would output the command line option @option{-foo}.
5422
5423 @item %W@{@code{S}@}
5424 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5425 deleted on failure.
5426
5427 @item %@{@code{S}*@}
5428 Substitutes all the switches specified to GCC whose names start
5429 with @code{-S}, but which also take an argument. This is used for
5430 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5431 GCC considers @option{-o foo} as being
5432 one switch whose names starts with @samp{o}. %@{o*@} would substitute this
5433 text, including the space. Thus two arguments would be generated.
5434
5435 @item %@{@code{S}*&@code{T}*@}
5436 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5437 (the order of @code{S} and @code{T} in the spec is not significant).
5438 There can be any number of ampersand-separated variables; for each the
5439 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
5440
5441 @item %@{@code{S}:@code{X}@}
5442 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5443
5444 @item %@{!@code{S}:@code{X}@}
5445 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5446
5447 @item %@{@code{S}*:@code{X}@}
5448 Substitutes @code{X} if one or more switches whose names start with
5449 @code{-S} are specified to GCC@. Normally @code{X} is substituted only
5450 once, no matter how many such switches appeared. However, if @code{%*}
5451 appears somewhere in @code{X}, then @code{X} will be substituted once
5452 for each matching switch, with the @code{%*} replaced by the part of
5453 that switch that matched the @code{*}.
5454
5455 @item %@{.@code{S}:@code{X}@}
5456 Substitutes @code{X}, if processing a file with suffix @code{S}.
5457
5458 @item %@{!.@code{S}:@code{X}@}
5459 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5460
5461 @item %@{@code{S}|@code{P}:@code{X}@}
5462 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5463 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5464 although they have a stronger binding than the @samp{|}. If @code{%*}
5465 appears in @code{X}, all of the alternatives must be starred, and only
5466 the first matching alternative is substituted.
5467
5468 For example, a spec string like this:
5469
5470 @smallexample
5471 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5472 @end smallexample
5473
5474 will output the following command-line options from the following input
5475 command-line options:
5476
5477 @smallexample
5478 fred.c -foo -baz
5479 jim.d -bar -boggle
5480 -d fred.c -foo -baz -boggle
5481 -d jim.d -bar -baz -boggle
5482 @end smallexample
5483
5484 @item %@{S:X; T:Y; :D@}
5485
5486 If @code{S} was given to GCC, substitues @code{X}; else if @code{T} was
5487 given to GCC, substitues @code{Y}; else substitutes @code{D}. There can
5488 be as many clauses as you need. This may be combined with @code{.},
5489 @code{!}, @code{|}, and @code{*} as needed.
5490
5491
5492 @end table
5493
5494 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5495 construct may contain other nested @samp{%} constructs or spaces, or
5496 even newlines. They are processed as usual, as described above.
5497 Trailing white space in @code{X} is ignored. White space may also
5498 appear anywhere on the left side of the colon in these constructs,
5499 except between @code{.} or @code{*} and the corresponding word.
5500
5501 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5502 handled specifically in these constructs. If another value of
5503 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5504 @option{-W} switch is found later in the command line, the earlier
5505 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5506 just one letter, which passes all matching options.
5507
5508 The character @samp{|} at the beginning of the predicate text is used to
5509 indicate that a command should be piped to the following command, but
5510 only if @option{-pipe} is specified.
5511
5512 It is built into GCC which switches take arguments and which do not.
5513 (You might think it would be useful to generalize this to allow each
5514 compiler's spec to say which switches take arguments. But this cannot
5515 be done in a consistent fashion. GCC cannot even decide which input
5516 files have been specified without knowing which switches take arguments,
5517 and it must know which input files to compile in order to tell which
5518 compilers to run).
5519
5520 GCC also knows implicitly that arguments starting in @option{-l} are to be
5521 treated as compiler output files, and passed to the linker in their
5522 proper position among the other output files.
5523
5524 @c man begin OPTIONS
5525
5526 @node Target Options
5527 @section Specifying Target Machine and Compiler Version
5528 @cindex target options
5529 @cindex cross compiling
5530 @cindex specifying machine version
5531 @cindex specifying compiler version and target machine
5532 @cindex compiler version, specifying
5533 @cindex target machine, specifying
5534
5535 The usual way to run GCC is to run the executable called @file{gcc}, or
5536 @file{<machine>-gcc} when cross-compiling, or
5537 @file{<machine>-gcc-<version>} to run a version other than the one that
5538 was installed last. Sometimes this is inconvenient, so GCC provides
5539 options that will switch to another cross-compiler or version.
5540
5541 @table @gcctabopt
5542 @item -b @var{machine}
5543 @opindex b
5544 The argument @var{machine} specifies the target machine for compilation.
5545
5546 The value to use for @var{machine} is the same as was specified as the
5547 machine type when configuring GCC as a cross-compiler. For
5548 example, if a cross-compiler was configured with @samp{configure
5549 i386v}, meaning to compile for an 80386 running System V, then you
5550 would specify @option{-b i386v} to run that cross compiler.
5551
5552 @item -V @var{version}
5553 @opindex V
5554 The argument @var{version} specifies which version of GCC to run.
5555 This is useful when multiple versions are installed. For example,
5556 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5557 @end table
5558
5559 The @option{-V} and @option{-b} options work by running the
5560 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5561 use them if you can just run that directly.
5562
5563 @node Submodel Options
5564 @section Hardware Models and Configurations
5565 @cindex submodel options
5566 @cindex specifying hardware config
5567 @cindex hardware models and configurations, specifying
5568 @cindex machine dependent options
5569
5570 Earlier we discussed the standard option @option{-b} which chooses among
5571 different installed compilers for completely different target
5572 machines, such as VAX vs.@: 68000 vs.@: 80386.
5573
5574 In addition, each of these target machine types can have its own
5575 special options, starting with @samp{-m}, to choose among various
5576 hardware models or configurations---for example, 68010 vs 68020,
5577 floating coprocessor or none. A single installed version of the
5578 compiler can compile for any model or configuration, according to the
5579 options specified.
5580
5581 Some configurations of the compiler also support additional special
5582 options, usually for compatibility with other compilers on the same
5583 platform.
5584
5585 These options are defined by the macro @code{TARGET_SWITCHES} in the
5586 machine description. The default for the options is also defined by
5587 that macro, which enables you to change the defaults.
5588
5589 @menu
5590 * M680x0 Options::
5591 * M68hc1x Options::
5592 * VAX Options::
5593 * SPARC Options::
5594 * ARM Options::
5595 * MN10200 Options::
5596 * MN10300 Options::
5597 * M32R/D Options::
5598 * M88K Options::
5599 * RS/6000 and PowerPC Options::
5600 * Darwin Options::
5601 * RT Options::
5602 * MIPS Options::
5603 * i386 and x86-64 Options::
5604 * HPPA Options::
5605 * Intel 960 Options::
5606 * DEC Alpha Options::
5607 * DEC Alpha/VMS Options::
5608 * H8/300 Options::
5609 * SH Options::
5610 * System V Options::
5611 * TMS320C3x/C4x Options::
5612 * V850 Options::
5613 * ARC Options::
5614 * NS32K Options::
5615 * AVR Options::
5616 * MCore Options::
5617 * IA-64 Options::
5618 * D30V Options::
5619 * S/390 and zSeries Options::
5620 * CRIS Options::
5621 * MMIX Options::
5622 * PDP-11 Options::
5623 * Xstormy16 Options::
5624 * Xtensa Options::
5625 * FRV Options::
5626 @end menu
5627
5628 @node M680x0 Options
5629 @subsection M680x0 Options
5630 @cindex M680x0 options
5631
5632 These are the @samp{-m} options defined for the 68000 series. The default
5633 values for these options depends on which style of 68000 was selected when
5634 the compiler was configured; the defaults for the most common choices are
5635 given below.
5636
5637 @table @gcctabopt
5638 @item -m68000
5639 @itemx -mc68000
5640 @opindex m68000
5641 @opindex mc68000
5642 Generate output for a 68000. This is the default
5643 when the compiler is configured for 68000-based systems.
5644
5645 Use this option for microcontrollers with a 68000 or EC000 core,
5646 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5647
5648 @item -m68020
5649 @itemx -mc68020
5650 @opindex m68020
5651 @opindex mc68020
5652 Generate output for a 68020. This is the default
5653 when the compiler is configured for 68020-based systems.
5654
5655 @item -m68881
5656 @opindex m68881
5657 Generate output containing 68881 instructions for floating point.
5658 This is the default for most 68020 systems unless @option{--nfp} was
5659 specified when the compiler was configured.
5660
5661 @item -m68030
5662 @opindex m68030
5663 Generate output for a 68030. This is the default when the compiler is
5664 configured for 68030-based systems.
5665
5666 @item -m68040
5667 @opindex m68040
5668 Generate output for a 68040. This is the default when the compiler is
5669 configured for 68040-based systems.
5670
5671 This option inhibits the use of 68881/68882 instructions that have to be
5672 emulated by software on the 68040. Use this option if your 68040 does not
5673 have code to emulate those instructions.
5674
5675 @item -m68060
5676 @opindex m68060
5677 Generate output for a 68060. This is the default when the compiler is
5678 configured for 68060-based systems.
5679
5680 This option inhibits the use of 68020 and 68881/68882 instructions that
5681 have to be emulated by software on the 68060. Use this option if your 68060
5682 does not have code to emulate those instructions.
5683
5684 @item -mcpu32
5685 @opindex mcpu32
5686 Generate output for a CPU32. This is the default
5687 when the compiler is configured for CPU32-based systems.
5688
5689 Use this option for microcontrollers with a
5690 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5691 68336, 68340, 68341, 68349 and 68360.
5692
5693 @item -m5200
5694 @opindex m5200
5695 Generate output for a 520X ``coldfire'' family cpu. This is the default
5696 when the compiler is configured for 520X-based systems.
5697
5698 Use this option for microcontroller with a 5200 core, including
5699 the MCF5202, MCF5203, MCF5204 and MCF5202.
5700
5701
5702 @item -m68020-40
5703 @opindex m68020-40
5704 Generate output for a 68040, without using any of the new instructions.
5705 This results in code which can run relatively efficiently on either a
5706 68020/68881 or a 68030 or a 68040. The generated code does use the
5707 68881 instructions that are emulated on the 68040.
5708
5709 @item -m68020-60
5710 @opindex m68020-60
5711 Generate output for a 68060, without using any of the new instructions.
5712 This results in code which can run relatively efficiently on either a
5713 68020/68881 or a 68030 or a 68040. The generated code does use the
5714 68881 instructions that are emulated on the 68060.
5715
5716 @item -mfpa
5717 @opindex mfpa
5718 Generate output containing Sun FPA instructions for floating point.
5719
5720 @item -msoft-float
5721 @opindex msoft-float
5722 Generate output containing library calls for floating point.
5723 @strong{Warning:} the requisite libraries are not available for all m68k
5724 targets. Normally the facilities of the machine's usual C compiler are
5725 used, but this can't be done directly in cross-compilation. You must
5726 make your own arrangements to provide suitable library functions for
5727 cross-compilation. The embedded targets @samp{m68k-*-aout} and
5728 @samp{m68k-*-coff} do provide software floating point support.
5729
5730 @item -mshort
5731 @opindex mshort
5732 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5733
5734 @item -mnobitfield
5735 @opindex mnobitfield
5736 Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
5737 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5738
5739 @item -mbitfield
5740 @opindex mbitfield
5741 Do use the bit-field instructions. The @option{-m68020} option implies
5742 @option{-mbitfield}. This is the default if you use a configuration
5743 designed for a 68020.
5744
5745 @item -mrtd
5746 @opindex mrtd
5747 Use a different function-calling convention, in which functions
5748 that take a fixed number of arguments return with the @code{rtd}
5749 instruction, which pops their arguments while returning. This
5750 saves one instruction in the caller since there is no need to pop
5751 the arguments there.
5752
5753 This calling convention is incompatible with the one normally
5754 used on Unix, so you cannot use it if you need to call libraries
5755 compiled with the Unix compiler.
5756
5757 Also, you must provide function prototypes for all functions that
5758 take variable numbers of arguments (including @code{printf});
5759 otherwise incorrect code will be generated for calls to those
5760 functions.
5761
5762 In addition, seriously incorrect code will result if you call a
5763 function with too many arguments. (Normally, extra arguments are
5764 harmlessly ignored.)
5765
5766 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5767 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5768
5769 @item -malign-int
5770 @itemx -mno-align-int
5771 @opindex malign-int
5772 @opindex mno-align-int
5773 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5774 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5775 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5776 Aligning variables on 32-bit boundaries produces code that runs somewhat
5777 faster on processors with 32-bit busses at the expense of more memory.
5778
5779 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5780 align structures containing the above types differently than
5781 most published application binary interface specifications for the m68k.
5782
5783 @item -mpcrel
5784 @opindex mpcrel
5785 Use the pc-relative addressing mode of the 68000 directly, instead of
5786 using a global offset table. At present, this option implies @option{-fpic},
5787 allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
5788 not presently supported with @option{-mpcrel}, though this could be supported for
5789 68020 and higher processors.
5790
5791 @item -mno-strict-align
5792 @itemx -mstrict-align
5793 @opindex mno-strict-align
5794 @opindex mstrict-align
5795 Do not (do) assume that unaligned memory references will be handled by
5796 the system.
5797
5798 @end table
5799
5800 @node M68hc1x Options
5801 @subsection M68hc1x Options
5802 @cindex M68hc1x options
5803
5804 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5805 microcontrollers. The default values for these options depends on
5806 which style of microcontroller was selected when the compiler was configured;
5807 the defaults for the most common choices are given below.
5808
5809 @table @gcctabopt
5810 @item -m6811
5811 @itemx -m68hc11
5812 @opindex m6811
5813 @opindex m68hc11
5814 Generate output for a 68HC11. This is the default
5815 when the compiler is configured for 68HC11-based systems.
5816
5817 @item -m6812
5818 @itemx -m68hc12
5819 @opindex m6812
5820 @opindex m68hc12
5821 Generate output for a 68HC12. This is the default
5822 when the compiler is configured for 68HC12-based systems.
5823
5824 @item -m68S12
5825 @itemx -m68hcs12
5826 @opindex m68S12
5827 @opindex m68hcs12
5828 Generate output for a 68HCS12.
5829
5830 @item -mauto-incdec
5831 @opindex mauto-incdec
5832 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5833 addressing modes.
5834
5835 @item -minmax
5836 @itemx -nominmax
5837 @opindex minmax
5838 @opindex mnominmax
5839 Enable the use of 68HC12 min and max instructions.
5840
5841 @item -mlong-calls
5842 @itemx -mno-long-calls
5843 @opindex mlong-calls
5844 @opindex mno-long-calls
5845 Treat all calls as being far away (near). If calls are assumed to be
5846 far away, the compiler will use the @code{call} instruction to
5847 call a function and the @code{rtc} instruction for returning.
5848
5849 @item -mshort
5850 @opindex mshort
5851 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5852
5853 @item -msoft-reg-count=@var{count}
5854 @opindex msoft-reg-count
5855 Specify the number of pseudo-soft registers which are used for the
5856 code generation. The maximum number is 32. Using more pseudo-soft
5857 register may or may not result in better code depending on the program.
5858 The default is 4 for 68HC11 and 2 for 68HC12.
5859
5860 @end table
5861
5862 @node VAX Options
5863 @subsection VAX Options
5864 @cindex VAX options
5865
5866 These @samp{-m} options are defined for the VAX:
5867
5868 @table @gcctabopt
5869 @item -munix
5870 @opindex munix
5871 Do not output certain jump instructions (@code{aobleq} and so on)
5872 that the Unix assembler for the VAX cannot handle across long
5873 ranges.
5874
5875 @item -mgnu
5876 @opindex mgnu
5877 Do output those jump instructions, on the assumption that you
5878 will assemble with the GNU assembler.
5879
5880 @item -mg
5881 @opindex mg
5882 Output code for g-format floating point numbers instead of d-format.
5883 @end table
5884
5885 @node SPARC Options
5886 @subsection SPARC Options
5887 @cindex SPARC options
5888
5889 These @samp{-m} switches are supported on the SPARC:
5890
5891 @table @gcctabopt
5892 @item -mno-app-regs
5893 @itemx -mapp-regs
5894 @opindex mno-app-regs
5895 @opindex mapp-regs
5896 Specify @option{-mapp-regs} to generate output using the global registers
5897 2 through 4, which the SPARC SVR4 ABI reserves for applications. This
5898 is the default.
5899
5900 To be fully SVR4 ABI compliant at the cost of some performance loss,
5901 specify @option{-mno-app-regs}. You should compile libraries and system
5902 software with this option.
5903
5904 @item -mfpu
5905 @itemx -mhard-float
5906 @opindex mfpu
5907 @opindex mhard-float
5908 Generate output containing floating point instructions. This is the
5909 default.
5910
5911 @item -mno-fpu
5912 @itemx -msoft-float
5913 @opindex mno-fpu
5914 @opindex msoft-float
5915 Generate output containing library calls for floating point.
5916 @strong{Warning:} the requisite libraries are not available for all SPARC
5917 targets. Normally the facilities of the machine's usual C compiler are
5918 used, but this cannot be done directly in cross-compilation. You must make
5919 your own arrangements to provide suitable library functions for
5920 cross-compilation. The embedded targets @samp{sparc-*-aout} and
5921 @samp{sparclite-*-*} do provide software floating point support.
5922
5923 @option{-msoft-float} changes the calling convention in the output file;
5924 therefore, it is only useful if you compile @emph{all} of a program with
5925 this option. In particular, you need to compile @file{libgcc.a}, the
5926 library that comes with GCC, with @option{-msoft-float} in order for
5927 this to work.
5928
5929 @item -mhard-quad-float
5930 @opindex mhard-quad-float
5931 Generate output containing quad-word (long double) floating point
5932 instructions.
5933
5934 @item -msoft-quad-float
5935 @opindex msoft-quad-float
5936 Generate output containing library calls for quad-word (long double)
5937 floating point instructions. The functions called are those specified
5938 in the SPARC ABI@. This is the default.
5939
5940 As of this writing, there are no sparc implementations that have hardware
5941 support for the quad-word floating point instructions. They all invoke
5942 a trap handler for one of these instructions, and then the trap handler
5943 emulates the effect of the instruction. Because of the trap handler overhead,
5944 this is much slower than calling the ABI library routines. Thus the
5945 @option{-msoft-quad-float} option is the default.
5946
5947 @item -mno-flat
5948 @itemx -mflat
5949 @opindex mno-flat
5950 @opindex mflat
5951 With @option{-mflat}, the compiler does not generate save/restore instructions
5952 and will use a ``flat'' or single register window calling convention.
5953 This model uses %i7 as the frame pointer and is compatible with the normal
5954 register window model. Code from either may be intermixed.
5955 The local registers and the input registers (0--5) are still treated as
5956 ``call saved'' registers and will be saved on the stack as necessary.
5957
5958 With @option{-mno-flat} (the default), the compiler emits save/restore
5959 instructions (except for leaf functions) and is the normal mode of operation.
5960
5961 @item -mno-unaligned-doubles
5962 @itemx -munaligned-doubles
5963 @opindex mno-unaligned-doubles
5964 @opindex munaligned-doubles
5965 Assume that doubles have 8 byte alignment. This is the default.
5966
5967 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5968 alignment only if they are contained in another type, or if they have an
5969 absolute address. Otherwise, it assumes they have 4 byte alignment.
5970 Specifying this option avoids some rare compatibility problems with code
5971 generated by other compilers. It is not the default because it results
5972 in a performance loss, especially for floating point code.
5973
5974 @item -mno-faster-structs
5975 @itemx -mfaster-structs
5976 @opindex mno-faster-structs
5977 @opindex mfaster-structs
5978 With @option{-mfaster-structs}, the compiler assumes that structures
5979 should have 8 byte alignment. This enables the use of pairs of
5980 @code{ldd} and @code{std} instructions for copies in structure
5981 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5982 However, the use of this changed alignment directly violates the SPARC
5983 ABI@. Thus, it's intended only for use on targets where the developer
5984 acknowledges that their resulting code will not be directly in line with
5985 the rules of the ABI@.
5986
5987 @item -mv8
5988 @itemx -msparclite
5989 @opindex mv8
5990 @opindex msparclite
5991 These two options select variations on the SPARC architecture.
5992
5993 By default (unless specifically configured for the Fujitsu SPARClite),
5994 GCC generates code for the v7 variant of the SPARC architecture.
5995
5996 @option{-mv8} will give you SPARC v8 code. The only difference from v7
5997 code is that the compiler emits the integer multiply and integer
5998 divide instructions which exist in SPARC v8 but not in SPARC v7.
5999
6000 @option{-msparclite} will give you SPARClite code. This adds the integer
6001 multiply, integer divide step and scan (@code{ffs}) instructions which
6002 exist in SPARClite but not in SPARC v7.
6003
6004 These options are deprecated and will be deleted in a future GCC release.
6005 They have been replaced with @option{-mcpu=xxx}.
6006
6007 @item -mcypress
6008 @itemx -msupersparc
6009 @opindex mcypress
6010 @opindex msupersparc
6011 These two options select the processor for which the code is optimized.
6012
6013 With @option{-mcypress} (the default), the compiler optimizes code for the
6014 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
6015 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
6016
6017 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
6018 used in the SPARCStation 10, 1000 and 2000 series. This flag also enables use
6019 of the full SPARC v8 instruction set.
6020
6021 These options are deprecated and will be deleted in a future GCC release.
6022 They have been replaced with @option{-mcpu=xxx}.
6023
6024 @item -mcpu=@var{cpu_type}
6025 @opindex mcpu
6026 Set the instruction set, register set, and instruction scheduling parameters
6027 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
6028 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6029 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
6030 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6031 @samp{ultrasparc3}.
6032
6033 Default instruction scheduling parameters are used for values that select
6034 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
6035 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6036
6037 Here is a list of each supported architecture and their supported
6038 implementations.
6039
6040 @smallexample
6041 v7: cypress
6042 v8: supersparc, hypersparc
6043 sparclite: f930, f934, sparclite86x
6044 sparclet: tsc701
6045 v9: ultrasparc, ultrasparc3
6046 @end smallexample
6047
6048 @item -mtune=@var{cpu_type}
6049 @opindex mtune
6050 Set the instruction scheduling parameters for machine type
6051 @var{cpu_type}, but do not set the instruction set or register set that the
6052 option @option{-mcpu=@var{cpu_type}} would.
6053
6054 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6055 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6056 that select a particular cpu implementation. Those are @samp{cypress},
6057 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6058 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6059 @samp{ultrasparc3}.
6060
6061 @end table
6062
6063 These @samp{-m} switches are supported in addition to the above
6064 on the SPARCLET processor.
6065
6066 @table @gcctabopt
6067 @item -mlittle-endian
6068 @opindex mlittle-endian
6069 Generate code for a processor running in little-endian mode.
6070
6071 @item -mlive-g0
6072 @opindex mlive-g0
6073 Treat register @code{%g0} as a normal register.
6074 GCC will continue to clobber it as necessary but will not assume
6075 it always reads as 0.
6076
6077 @item -mbroken-saverestore
6078 @opindex mbroken-saverestore
6079 Generate code that does not use non-trivial forms of the @code{save} and
6080 @code{restore} instructions. Early versions of the SPARCLET processor do
6081 not correctly handle @code{save} and @code{restore} instructions used with
6082 arguments. They correctly handle them used without arguments. A @code{save}
6083 instruction used without arguments increments the current window pointer
6084 but does not allocate a new stack frame. It is assumed that the window
6085 overflow trap handler will properly handle this case as will interrupt
6086 handlers.
6087 @end table
6088
6089 These @samp{-m} switches are supported in addition to the above
6090 on SPARC V9 processors in 64-bit environments.
6091
6092 @table @gcctabopt
6093 @item -mlittle-endian
6094 @opindex mlittle-endian
6095 Generate code for a processor running in little-endian mode.
6096
6097 @item -m32
6098 @itemx -m64
6099 @opindex m32
6100 @opindex m64
6101 Generate code for a 32-bit or 64-bit environment.
6102 The 32-bit environment sets int, long and pointer to 32 bits.
6103 The 64-bit environment sets int to 32 bits and long and pointer
6104 to 64 bits.
6105
6106 @item -mcmodel=medlow
6107 @opindex mcmodel=medlow
6108 Generate code for the Medium/Low code model: the program must be linked
6109 in the low 32 bits of the address space. Pointers are 64 bits.
6110 Programs can be statically or dynamically linked.
6111
6112 @item -mcmodel=medmid
6113 @opindex mcmodel=medmid
6114 Generate code for the Medium/Middle code model: the program must be linked
6115 in the low 44 bits of the address space, the text segment must be less than
6116 2G bytes, and data segment must be within 2G of the text segment.
6117 Pointers are 64 bits.
6118
6119 @item -mcmodel=medany
6120 @opindex mcmodel=medany
6121 Generate code for the Medium/Anywhere code model: the program may be linked
6122 anywhere in the address space, the text segment must be less than
6123 2G bytes, and data segment must be within 2G of the text segment.
6124 Pointers are 64 bits.
6125
6126 @item -mcmodel=embmedany
6127 @opindex mcmodel=embmedany
6128 Generate code for the Medium/Anywhere code model for embedded systems:
6129 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6130 (determined at link time). Register %g4 points to the base of the
6131 data segment. Pointers are still 64 bits.
6132 Programs are statically linked, PIC is not supported.
6133
6134 @item -mstack-bias
6135 @itemx -mno-stack-bias
6136 @opindex mstack-bias
6137 @opindex mno-stack-bias
6138 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6139 frame pointer if present, are offset by @minus{}2047 which must be added back
6140 when making stack frame references.
6141 Otherwise, assume no such offset is present.
6142 @end table
6143
6144 @node ARM Options
6145 @subsection ARM Options
6146 @cindex ARM options
6147
6148 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6149 architectures:
6150
6151 @table @gcctabopt
6152 @item -mapcs-frame
6153 @opindex mapcs-frame
6154 Generate a stack frame that is compliant with the ARM Procedure Call
6155 Standard for all functions, even if this is not strictly necessary for
6156 correct execution of the code. Specifying @option{-fomit-frame-pointer}
6157 with this option will cause the stack frames not to be generated for
6158 leaf functions. The default is @option{-mno-apcs-frame}.
6159
6160 @item -mapcs
6161 @opindex mapcs
6162 This is a synonym for @option{-mapcs-frame}.
6163
6164 @item -mapcs-26
6165 @opindex mapcs-26
6166 Generate code for a processor running with a 26-bit program counter,
6167 and conforming to the function calling standards for the APCS 26-bit
6168 option. This option replaces the @option{-m2} and @option{-m3} options
6169 of previous releases of the compiler.
6170
6171 @item -mapcs-32
6172 @opindex mapcs-32
6173 Generate code for a processor running with a 32-bit program counter,
6174 and conforming to the function calling standards for the APCS 32-bit
6175 option. This option replaces the @option{-m6} option of previous releases
6176 of the compiler.
6177
6178 @ignore
6179 @c not currently implemented
6180 @item -mapcs-stack-check
6181 @opindex mapcs-stack-check
6182 Generate code to check the amount of stack space available upon entry to
6183 every function (that actually uses some stack space). If there is
6184 insufficient space available then either the function
6185 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6186 called, depending upon the amount of stack space required. The run time
6187 system is required to provide these functions. The default is
6188 @option{-mno-apcs-stack-check}, since this produces smaller code.
6189
6190 @c not currently implemented
6191 @item -mapcs-float
6192 @opindex mapcs-float
6193 Pass floating point arguments using the float point registers. This is
6194 one of the variants of the APCS@. This option is recommended if the
6195 target hardware has a floating point unit or if a lot of floating point
6196 arithmetic is going to be performed by the code. The default is
6197 @option{-mno-apcs-float}, since integer only code is slightly increased in
6198 size if @option{-mapcs-float} is used.
6199
6200 @c not currently implemented
6201 @item -mapcs-reentrant
6202 @opindex mapcs-reentrant
6203 Generate reentrant, position independent code. The default is
6204 @option{-mno-apcs-reentrant}.
6205 @end ignore
6206
6207 @item -mthumb-interwork
6208 @opindex mthumb-interwork
6209 Generate code which supports calling between the ARM and Thumb
6210 instruction sets. Without this option the two instruction sets cannot
6211 be reliably used inside one program. The default is
6212 @option{-mno-thumb-interwork}, since slightly larger code is generated
6213 when @option{-mthumb-interwork} is specified.
6214
6215 @item -mno-sched-prolog
6216 @opindex mno-sched-prolog
6217 Prevent the reordering of instructions in the function prolog, or the
6218 merging of those instruction with the instructions in the function's
6219 body. This means that all functions will start with a recognizable set
6220 of instructions (or in fact one of a choice from a small set of
6221 different function prologues), and this information can be used to
6222 locate the start if functions inside an executable piece of code. The
6223 default is @option{-msched-prolog}.
6224
6225 @item -mhard-float
6226 @opindex mhard-float
6227 Generate output containing floating point instructions. This is the
6228 default.
6229
6230 @item -msoft-float
6231 @opindex msoft-float
6232 Generate output containing library calls for floating point.
6233 @strong{Warning:} the requisite libraries are not available for all ARM
6234 targets. Normally the facilities of the machine's usual C compiler are
6235 used, but this cannot be done directly in cross-compilation. You must make
6236 your own arrangements to provide suitable library functions for
6237 cross-compilation.
6238
6239 @option{-msoft-float} changes the calling convention in the output file;
6240 therefore, it is only useful if you compile @emph{all} of a program with
6241 this option. In particular, you need to compile @file{libgcc.a}, the
6242 library that comes with GCC, with @option{-msoft-float} in order for
6243 this to work.
6244
6245 @item -mlittle-endian
6246 @opindex mlittle-endian
6247 Generate code for a processor running in little-endian mode. This is
6248 the default for all standard configurations.
6249
6250 @item -mbig-endian
6251 @opindex mbig-endian
6252 Generate code for a processor running in big-endian mode; the default is
6253 to compile code for a little-endian processor.
6254
6255 @item -mwords-little-endian
6256 @opindex mwords-little-endian
6257 This option only applies when generating code for big-endian processors.
6258 Generate code for a little-endian word order but a big-endian byte
6259 order. That is, a byte order of the form @samp{32107654}. Note: this
6260 option should only be used if you require compatibility with code for
6261 big-endian ARM processors generated by versions of the compiler prior to
6262 2.8.
6263
6264 @item -malignment-traps
6265 @opindex malignment-traps
6266 Generate code that will not trap if the MMU has alignment traps enabled.
6267 On ARM architectures prior to ARMv4, there were no instructions to
6268 access half-word objects stored in memory. However, when reading from
6269 memory a feature of the ARM architecture allows a word load to be used,
6270 even if the address is unaligned, and the processor core will rotate the
6271 data as it is being loaded. This option tells the compiler that such
6272 misaligned accesses will cause a MMU trap and that it should instead
6273 synthesize the access as a series of byte accesses. The compiler can
6274 still use word accesses to load half-word data if it knows that the
6275 address is aligned to a word boundary.
6276
6277 This option is ignored when compiling for ARM architecture 4 or later,
6278 since these processors have instructions to directly access half-word
6279 objects in memory.
6280
6281 @item -mno-alignment-traps
6282 @opindex mno-alignment-traps
6283 Generate code that assumes that the MMU will not trap unaligned
6284 accesses. This produces better code when the target instruction set
6285 does not have half-word memory operations (i.e.@: implementations prior to
6286 ARMv4).
6287
6288 Note that you cannot use this option to access unaligned word objects,
6289 since the processor will only fetch one 32-bit aligned object from
6290 memory.
6291
6292 The default setting for most targets is @option{-mno-alignment-traps}, since
6293 this produces better code when there are no half-word memory
6294 instructions available.
6295
6296 @item -mshort-load-bytes
6297 @itemx -mno-short-load-words
6298 @opindex mshort-load-bytes
6299 @opindex mno-short-load-words
6300 These are deprecated aliases for @option{-malignment-traps}.
6301
6302 @item -mno-short-load-bytes
6303 @itemx -mshort-load-words
6304 @opindex mno-short-load-bytes
6305 @opindex mshort-load-words
6306 This are deprecated aliases for @option{-mno-alignment-traps}.
6307
6308 @item -mcpu=@var{name}
6309 @opindex mcpu
6310 This specifies the name of the target ARM processor. GCC uses this name
6311 to determine what kind of instructions it can emit when generating
6312 assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
6313 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6314 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6315 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6316 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6317 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6318 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6319 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6320 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6321 @samp{arm1020t}, @samp{xscale}, @samp{ep9312}.
6322
6323 @itemx -mtune=@var{name}
6324 @opindex mtune
6325 This option is very similar to the @option{-mcpu=} option, except that
6326 instead of specifying the actual target processor type, and hence
6327 restricting which instructions can be used, it specifies that GCC should
6328 tune the performance of the code as if the target were of the type
6329 specified in this option, but still choosing the instructions that it
6330 will generate based on the cpu specified by a @option{-mcpu=} option.
6331 For some ARM implementations better performance can be obtained by using
6332 this option.
6333
6334 @item -march=@var{name}
6335 @opindex march
6336 This specifies the name of the target ARM architecture. GCC uses this
6337 name to determine what kind of instructions it can emit when generating
6338 assembly code. This option can be used in conjunction with or instead
6339 of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
6340 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6341 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{ep9312}.
6342
6343 @item -mfpe=@var{number}
6344 @itemx -mfp=@var{number}
6345 @opindex mfpe
6346 @opindex mfp
6347 This specifies the version of the floating point emulation available on
6348 the target. Permissible values are 2 and 3. @option{-mfp=} is a synonym
6349 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6350
6351 @item -mstructure-size-boundary=@var{n}
6352 @opindex mstructure-size-boundary
6353 The size of all structures and unions will be rounded up to a multiple
6354 of the number of bits set by this option. Permissible values are 8 and
6355 32. The default value varies for different toolchains. For the COFF
6356 targeted toolchain the default value is 8. Specifying the larger number
6357 can produce faster, more efficient code, but can also increase the size
6358 of the program. The two values are potentially incompatible. Code
6359 compiled with one value cannot necessarily expect to work with code or
6360 libraries compiled with the other value, if they exchange information
6361 using structures or unions.
6362
6363 @item -mabort-on-noreturn
6364 @opindex mabort-on-noreturn
6365 Generate a call to the function @code{abort} at the end of a
6366 @code{noreturn} function. It will be executed if the function tries to
6367 return.
6368
6369 @item -mlong-calls
6370 @itemx -mno-long-calls
6371 @opindex mlong-calls
6372 @opindex mno-long-calls
6373 Tells the compiler to perform function calls by first loading the
6374 address of the function into a register and then performing a subroutine
6375 call on this register. This switch is needed if the target function
6376 will lie outside of the 64 megabyte addressing range of the offset based
6377 version of subroutine call instruction.
6378
6379 Even if this switch is enabled, not all function calls will be turned
6380 into long calls. The heuristic is that static functions, functions
6381 which have the @samp{short-call} attribute, functions that are inside
6382 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6383 definitions have already been compiled within the current compilation
6384 unit, will not be turned into long calls. The exception to this rule is
6385 that weak function definitions, functions with the @samp{long-call}
6386 attribute or the @samp{section} attribute, and functions that are within
6387 the scope of a @samp{#pragma long_calls} directive, will always be
6388 turned into long calls.
6389
6390 This feature is not enabled by default. Specifying
6391 @option{-mno-long-calls} will restore the default behavior, as will
6392 placing the function calls within the scope of a @samp{#pragma
6393 long_calls_off} directive. Note these switches have no effect on how
6394 the compiler generates code to handle function calls via function
6395 pointers.
6396
6397 @item -mnop-fun-dllimport
6398 @opindex mnop-fun-dllimport
6399 Disable support for the @code{dllimport} attribute.
6400
6401 @item -msingle-pic-base
6402 @opindex msingle-pic-base
6403 Treat the register used for PIC addressing as read-only, rather than
6404 loading it in the prologue for each function. The run-time system is
6405 responsible for initializing this register with an appropriate value
6406 before execution begins.
6407
6408 @item -mpic-register=@var{reg}
6409 @opindex mpic-register
6410 Specify the register to be used for PIC addressing. The default is R10
6411 unless stack-checking is enabled, when R9 is used.
6412
6413 @item -mcirrus-fix-invalid-insns
6414 @opindex -mcirrus-fix-invalid-insns
6415 @opindex -mno-cirrus-fix-invalid-insns
6416 Insert NOPs into the instruction stream to in order to work around
6417 problems with invalid Maverick instruction combinations. This option
6418 is only valid if the @option{-mcpu=ep9312} option has been used to
6419 enable generation of instructions for the Cirrus Maverick floating
6420 point co-processor. This option is not enabled by default, since the
6421 problem is only present in older Maverick implemenations. The default
6422 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6423 switch.
6424
6425 @item -mpoke-function-name
6426 @opindex mpoke-function-name
6427 Write the name of each function into the text section, directly
6428 preceding the function prologue. The generated code is similar to this:
6429
6430 @smallexample
6431 t0
6432 .ascii "arm_poke_function_name", 0
6433 .align
6434 t1
6435 .word 0xff000000 + (t1 - t0)
6436 arm_poke_function_name
6437 mov ip, sp
6438 stmfd sp!, @{fp, ip, lr, pc@}
6439 sub fp, ip, #4
6440 @end smallexample
6441
6442 When performing a stack backtrace, code can inspect the value of
6443 @code{pc} stored at @code{fp + 0}. If the trace function then looks at
6444 location @code{pc - 12} and the top 8 bits are set, then we know that
6445 there is a function name embedded immediately preceding this location
6446 and has length @code{((pc[-3]) & 0xff000000)}.
6447
6448 @item -mthumb
6449 @opindex mthumb
6450 Generate code for the 16-bit Thumb instruction set. The default is to
6451 use the 32-bit ARM instruction set.
6452
6453 @item -mtpcs-frame
6454 @opindex mtpcs-frame
6455 Generate a stack frame that is compliant with the Thumb Procedure Call
6456 Standard for all non-leaf functions. (A leaf function is one that does
6457 not call any other functions.) The default is @option{-mno-tpcs-frame}.
6458
6459 @item -mtpcs-leaf-frame
6460 @opindex mtpcs-leaf-frame
6461 Generate a stack frame that is compliant with the Thumb Procedure Call
6462 Standard for all leaf functions. (A leaf function is one that does
6463 not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
6464
6465 @item -mcallee-super-interworking
6466 @opindex mcallee-super-interworking
6467 Gives all externally visible functions in the file being compiled an ARM
6468 instruction set header which switches to Thumb mode before executing the
6469 rest of the function. This allows these functions to be called from
6470 non-interworking code.
6471
6472 @item -mcaller-super-interworking
6473 @opindex mcaller-super-interworking
6474 Allows calls via function pointers (including virtual functions) to
6475 execute correctly regardless of whether the target code has been
6476 compiled for interworking or not. There is a small overhead in the cost
6477 of executing a function pointer if this option is enabled.
6478
6479 @end table
6480
6481 @node MN10200 Options
6482 @subsection MN10200 Options
6483 @cindex MN10200 options
6484 These @option{-m} options are defined for Matsushita MN10200 architectures:
6485 @table @gcctabopt
6486
6487 @item -mrelax
6488 @opindex mrelax
6489 Indicate to the linker that it should perform a relaxation optimization pass
6490 to shorten branches, calls and absolute memory addresses. This option only
6491 has an effect when used on the command line for the final link step.
6492
6493 This option makes symbolic debugging impossible.
6494 @end table
6495
6496 @node MN10300 Options
6497 @subsection MN10300 Options
6498 @cindex MN10300 options
6499 These @option{-m} options are defined for Matsushita MN10300 architectures:
6500
6501 @table @gcctabopt
6502 @item -mmult-bug
6503 @opindex mmult-bug
6504 Generate code to avoid bugs in the multiply instructions for the MN10300
6505 processors. This is the default.
6506
6507 @item -mno-mult-bug
6508 @opindex mno-mult-bug
6509 Do not generate code to avoid bugs in the multiply instructions for the
6510 MN10300 processors.
6511
6512 @item -mam33
6513 @opindex mam33
6514 Generate code which uses features specific to the AM33 processor.
6515
6516 @item -mno-am33
6517 @opindex mno-am33
6518 Do not generate code which uses features specific to the AM33 processor. This
6519 is the default.
6520
6521 @item -mno-crt0
6522 @opindex mno-crt0
6523 Do not link in the C run-time initialization object file.
6524
6525 @item -mrelax
6526 @opindex mrelax
6527 Indicate to the linker that it should perform a relaxation optimization pass
6528 to shorten branches, calls and absolute memory addresses. This option only
6529 has an effect when used on the command line for the final link step.
6530
6531 This option makes symbolic debugging impossible.
6532 @end table
6533
6534
6535 @node M32R/D Options
6536 @subsection M32R/D Options
6537 @cindex M32R/D options
6538
6539 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6540
6541 @table @gcctabopt
6542 @item -m32rx
6543 @opindex m32rx
6544 Generate code for the M32R/X@.
6545
6546 @item -m32r
6547 @opindex m32r
6548 Generate code for the M32R@. This is the default.
6549
6550 @item -mcode-model=small
6551 @opindex mcode-model=small
6552 Assume all objects live in the lower 16MB of memory (so that their addresses
6553 can be loaded with the @code{ld24} instruction), and assume all subroutines
6554 are reachable with the @code{bl} instruction.
6555 This is the default.
6556
6557 The addressability of a particular object can be set with the
6558 @code{model} attribute.
6559
6560 @item -mcode-model=medium
6561 @opindex mcode-model=medium
6562 Assume objects may be anywhere in the 32-bit address space (the compiler
6563 will generate @code{seth/add3} instructions to load their addresses), and
6564 assume all subroutines are reachable with the @code{bl} instruction.
6565
6566 @item -mcode-model=large
6567 @opindex mcode-model=large
6568 Assume objects may be anywhere in the 32-bit address space (the compiler
6569 will generate @code{seth/add3} instructions to load their addresses), and
6570 assume subroutines may not be reachable with the @code{bl} instruction
6571 (the compiler will generate the much slower @code{seth/add3/jl}
6572 instruction sequence).
6573
6574 @item -msdata=none
6575 @opindex msdata=none
6576 Disable use of the small data area. Variables will be put into
6577 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6578 @code{section} attribute has been specified).
6579 This is the default.
6580
6581 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6582 Objects may be explicitly put in the small data area with the
6583 @code{section} attribute using one of these sections.
6584
6585 @item -msdata=sdata
6586 @opindex msdata=sdata
6587 Put small global and static data in the small data area, but do not
6588 generate special code to reference them.
6589
6590 @item -msdata=use
6591 @opindex msdata=use
6592 Put small global and static data in the small data area, and generate
6593 special instructions to reference them.
6594
6595 @item -G @var{num}
6596 @opindex G
6597 @cindex smaller data references
6598 Put global and static objects less than or equal to @var{num} bytes
6599 into the small data or bss sections instead of the normal data or bss
6600 sections. The default value of @var{num} is 8.
6601 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6602 for this option to have any effect.
6603
6604 All modules should be compiled with the same @option{-G @var{num}} value.
6605 Compiling with different values of @var{num} may or may not work; if it
6606 doesn't the linker will give an error message---incorrect code will not be
6607 generated.
6608
6609 @end table
6610
6611 @node M88K Options
6612 @subsection M88K Options
6613 @cindex M88k options
6614
6615 These @samp{-m} options are defined for Motorola 88k architectures:
6616
6617 @table @gcctabopt
6618 @item -m88000
6619 @opindex m88000
6620 Generate code that works well on both the m88100 and the
6621 m88110.
6622
6623 @item -m88100
6624 @opindex m88100
6625 Generate code that works best for the m88100, but that also
6626 runs on the m88110.
6627
6628 @item -m88110
6629 @opindex m88110
6630 Generate code that works best for the m88110, and may not run
6631 on the m88100.
6632
6633 @item -mbig-pic
6634 @opindex mbig-pic
6635 Obsolete option to be removed from the next revision.
6636 Use @option{-fPIC}.
6637
6638 @item -midentify-revision
6639 @opindex midentify-revision
6640 @cindex identifying source, compiler (88k)
6641 Include an @code{ident} directive in the assembler output recording the
6642 source file name, compiler name and version, timestamp, and compilation
6643 flags used.
6644
6645 @item -mno-underscores
6646 @opindex mno-underscores
6647 @cindex underscores, avoiding (88k)
6648 In assembler output, emit symbol names without adding an underscore
6649 character at the beginning of each name. The default is to use an
6650 underscore as prefix on each name.
6651
6652 @item -mocs-debug-info
6653 @itemx -mno-ocs-debug-info
6654 @opindex mocs-debug-info
6655 @opindex mno-ocs-debug-info
6656 @cindex OCS (88k)
6657 @cindex debugging, 88k OCS
6658 Include (or omit) additional debugging information (about registers used
6659 in each stack frame) as specified in the 88open Object Compatibility
6660 Standard, ``OCS''@. This extra information allows debugging of code that
6661 has had the frame pointer eliminated. The default for SVr4 and Delta 88
6662 SVr3.2 is to include this information; other 88k configurations omit this
6663 information by default.
6664
6665 @item -mocs-frame-position
6666 @opindex mocs-frame-position
6667 @cindex register positions in frame (88k)
6668 When emitting COFF debugging information for automatic variables and
6669 parameters stored on the stack, use the offset from the canonical frame
6670 address, which is the stack pointer (register 31) on entry to the
6671 function. The SVr4 and Delta88 SVr3.2, and BCS configurations use
6672 @option{-mocs-frame-position}; other 88k configurations have the default
6673 @option{-mno-ocs-frame-position}.
6674
6675 @item -mno-ocs-frame-position
6676 @opindex mno-ocs-frame-position
6677 @cindex register positions in frame (88k)
6678 When emitting COFF debugging information for automatic variables and
6679 parameters stored on the stack, use the offset from the frame pointer
6680 register (register 30). When this option is in effect, the frame
6681 pointer is not eliminated when debugging information is selected by the
6682 -g switch.
6683
6684 @item -moptimize-arg-area
6685 @opindex moptimize-arg-area
6686 @cindex arguments in frame (88k)
6687 Save space by reorganizing the stack frame. This option generates code
6688 that does not agree with the 88open specifications, but uses less
6689 memory.
6690
6691 @itemx -mno-optimize-arg-area
6692 @opindex mno-optimize-arg-area
6693 Do not reorganize the stack frame to save space. This is the default.
6694 The generated conforms to the specification, but uses more memory.
6695
6696 @item -mshort-data-@var{num}
6697 @opindex mshort-data
6698 @cindex smaller data references (88k)
6699 @cindex r0-relative references (88k)
6700 Generate smaller data references by making them relative to @code{r0},
6701 which allows loading a value using a single instruction (rather than the
6702 usual two). You control which data references are affected by
6703 specifying @var{num} with this option. For example, if you specify
6704 @option{-mshort-data-512}, then the data references affected are those
6705 involving displacements of less than 512 bytes.
6706 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6707 than 64k.
6708
6709 @item -mserialize-volatile
6710 @opindex mserialize-volatile
6711 @itemx -mno-serialize-volatile
6712 @opindex mno-serialize-volatile
6713 @cindex sequential consistency on 88k
6714 Do, or don't, generate code to guarantee sequential consistency
6715 of volatile memory references. By default, consistency is
6716 guaranteed.
6717
6718 The order of memory references made by the MC88110 processor does
6719 not always match the order of the instructions requesting those
6720 references. In particular, a load instruction may execute before
6721 a preceding store instruction. Such reordering violates
6722 sequential consistency of volatile memory references, when there
6723 are multiple processors. When consistency must be guaranteed,
6724 GCC generates special instructions, as needed, to force
6725 execution in the proper order.
6726
6727 The MC88100 processor does not reorder memory references and so
6728 always provides sequential consistency. However, by default, GCC
6729 generates the special instructions to guarantee consistency
6730 even when you use @option{-m88100}, so that the code may be run on an
6731 MC88110 processor. If you intend to run your code only on the
6732 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6733
6734 The extra code generated to guarantee consistency may affect the
6735 performance of your application. If you know that you can safely
6736 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6737
6738 @item -msvr4
6739 @itemx -msvr3
6740 @opindex msvr4
6741 @opindex msvr3
6742 @cindex assembler syntax, 88k
6743 @cindex SVr4
6744 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6745 related to System V release 4 (SVr4). This controls the following:
6746
6747 @enumerate
6748 @item
6749 Which variant of the assembler syntax to emit.
6750 @item
6751 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6752 that is used on System V release 4.
6753 @item
6754 @option{-msvr4} makes GCC issue additional declaration directives used in
6755 SVr4.
6756 @end enumerate
6757
6758 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
6759 @option{-msvr3} is the default for all other m88k configurations.
6760
6761 @item -mversion-03.00
6762 @opindex mversion-03.00
6763 This option is obsolete, and is ignored.
6764 @c ??? which asm syntax better for GAS? option there too?
6765
6766 @item -mno-check-zero-division
6767 @itemx -mcheck-zero-division
6768 @opindex mno-check-zero-division
6769 @opindex mcheck-zero-division
6770 @cindex zero division on 88k
6771 Do, or don't, generate code to guarantee that integer division by
6772 zero will be detected. By default, detection is guaranteed.
6773
6774 Some models of the MC88100 processor fail to trap upon integer
6775 division by zero under certain conditions. By default, when
6776 compiling code that might be run on such a processor, GCC
6777 generates code that explicitly checks for zero-valued divisors
6778 and traps with exception number 503 when one is detected. Use of
6779 @option{-mno-check-zero-division} suppresses such checking for code
6780 generated to run on an MC88100 processor.
6781
6782 GCC assumes that the MC88110 processor correctly detects all instances
6783 of integer division by zero. When @option{-m88110} is specified, no
6784 explicit checks for zero-valued divisors are generated, and both
6785 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6786 ignored.
6787
6788 @item -muse-div-instruction
6789 @opindex muse-div-instruction
6790 @cindex divide instruction, 88k
6791 Use the div instruction for signed integer division on the
6792 MC88100 processor. By default, the div instruction is not used.
6793
6794 On the MC88100 processor the signed integer division instruction
6795 div) traps to the operating system on a negative operand. The
6796 operating system transparently completes the operation, but at a
6797 large cost in execution time. By default, when compiling code
6798 that might be run on an MC88100 processor, GCC emulates signed
6799 integer division using the unsigned integer division instruction
6800 divu), thereby avoiding the large penalty of a trap to the
6801 operating system. Such emulation has its own, smaller, execution
6802 cost in both time and space. To the extent that your code's
6803 important signed integer division operations are performed on two
6804 nonnegative operands, it may be desirable to use the div
6805 instruction directly.
6806
6807 On the MC88110 processor the div instruction (also known as the
6808 divs instruction) processes negative operands without trapping to
6809 the operating system. When @option{-m88110} is specified,
6810 @option{-muse-div-instruction} is ignored, and the div instruction is used
6811 for signed integer division.
6812
6813 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined. In
6814 particular, the behavior of such a division with and without
6815 @option{-muse-div-instruction} may differ.
6816
6817 @item -mtrap-large-shift
6818 @itemx -mhandle-large-shift
6819 @opindex mtrap-large-shift
6820 @opindex mhandle-large-shift
6821 @cindex bit shift overflow (88k)
6822 @cindex large bit shifts (88k)
6823 Include code to detect bit-shifts of more than 31 bits; respectively,
6824 trap such shifts or emit code to handle them properly. By default GCC
6825 makes no special provision for large bit shifts.
6826
6827 @item -mwarn-passed-structs
6828 @opindex mwarn-passed-structs
6829 @cindex structure passing (88k)
6830 Warn when a function passes a struct as an argument or result.
6831 Structure-passing conventions have changed during the evolution of the C
6832 language, and are often the source of portability problems. By default,
6833 GCC issues no such warning.
6834 @end table
6835
6836 @c break page here to avoid unsightly interparagraph stretch.
6837 @c -zw, 2001-8-17
6838 @page
6839
6840 @node RS/6000 and PowerPC Options
6841 @subsection IBM RS/6000 and PowerPC Options
6842 @cindex RS/6000 and PowerPC Options
6843 @cindex IBM RS/6000 and PowerPC Options
6844
6845 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6846 @table @gcctabopt
6847 @item -mpower
6848 @itemx -mno-power
6849 @itemx -mpower2
6850 @itemx -mno-power2
6851 @itemx -mpowerpc
6852 @itemx -mno-powerpc
6853 @itemx -mpowerpc-gpopt
6854 @itemx -mno-powerpc-gpopt
6855 @itemx -mpowerpc-gfxopt
6856 @itemx -mno-powerpc-gfxopt
6857 @itemx -mpowerpc64
6858 @itemx -mno-powerpc64
6859 @opindex mpower
6860 @opindex mno-power
6861 @opindex mpower2
6862 @opindex mno-power2
6863 @opindex mpowerpc
6864 @opindex mno-powerpc
6865 @opindex mpowerpc-gpopt
6866 @opindex mno-powerpc-gpopt
6867 @opindex mpowerpc-gfxopt
6868 @opindex mno-powerpc-gfxopt
6869 @opindex mpowerpc64
6870 @opindex mno-powerpc64
6871 GCC supports two related instruction set architectures for the
6872 RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
6873 instructions supported by the @samp{rios} chip set used in the original
6874 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6875 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6876 the IBM 4xx microprocessors.
6877
6878 Neither architecture is a subset of the other. However there is a
6879 large common subset of instructions supported by both. An MQ
6880 register is included in processors supporting the POWER architecture.
6881
6882 You use these options to specify which instructions are available on the
6883 processor you are using. The default value of these options is
6884 determined when configuring GCC@. Specifying the
6885 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6886 options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
6887 rather than the options listed above.
6888
6889 The @option{-mpower} option allows GCC to generate instructions that
6890 are found only in the POWER architecture and to use the MQ register.
6891 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6892 to generate instructions that are present in the POWER2 architecture but
6893 not the original POWER architecture.
6894
6895 The @option{-mpowerpc} option allows GCC to generate instructions that
6896 are found only in the 32-bit subset of the PowerPC architecture.
6897 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6898 GCC to use the optional PowerPC architecture instructions in the
6899 General Purpose group, including floating-point square root. Specifying
6900 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6901 use the optional PowerPC architecture instructions in the Graphics
6902 group, including floating-point select.
6903
6904 The @option{-mpowerpc64} option allows GCC to generate the additional
6905 64-bit instructions that are found in the full PowerPC64 architecture
6906 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
6907 @option{-mno-powerpc64}.
6908
6909 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6910 will use only the instructions in the common subset of both
6911 architectures plus some special AIX common-mode calls, and will not use
6912 the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
6913 permits GCC to use any instruction from either architecture and to
6914 allow use of the MQ register; specify this for the Motorola MPC601.
6915
6916 @item -mnew-mnemonics
6917 @itemx -mold-mnemonics
6918 @opindex mnew-mnemonics
6919 @opindex mold-mnemonics
6920 Select which mnemonics to use in the generated assembler code. With
6921 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6922 the PowerPC architecture. With @option{-mold-mnemonics} it uses the
6923 assembler mnemonics defined for the POWER architecture. Instructions
6924 defined in only one architecture have only one mnemonic; GCC uses that
6925 mnemonic irrespective of which of these options is specified.
6926
6927 GCC defaults to the mnemonics appropriate for the architecture in
6928 use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6929 value of these option. Unless you are building a cross-compiler, you
6930 should normally not specify either @option{-mnew-mnemonics} or
6931 @option{-mold-mnemonics}, but should instead accept the default.
6932
6933 @item -mcpu=@var{cpu_type}
6934 @opindex mcpu
6935 Set architecture type, register usage, choice of mnemonics, and
6936 instruction scheduling parameters for machine type @var{cpu_type}.
6937 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6938 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6939 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6940 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6941 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6942 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6943
6944 @option{-mcpu=common} selects a completely generic processor. Code
6945 generated under this option will run on any POWER or PowerPC processor.
6946 GCC will use only the instructions in the common subset of both
6947 architectures, and will not use the MQ register. GCC assumes a generic
6948 processor model for scheduling purposes.
6949
6950 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6951 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6952 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6953 types, with an appropriate, generic processor model assumed for
6954 scheduling purposes.
6955
6956 The other options specify a specific processor. Code generated under
6957 those options will run best on that processor, and may not run at all on
6958 others.
6959
6960 The @option{-mcpu} options automatically enable or disable other
6961 @option{-m} options as follows:
6962
6963 @table @samp
6964 @item common
6965 @option{-mno-power}, @option{-mno-powerpc}
6966
6967 @item power
6968 @itemx power2
6969 @itemx rios1
6970 @itemx rios2
6971 @itemx rsc
6972 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6973
6974 @item powerpc
6975 @itemx rs64a
6976 @itemx 602
6977 @itemx 603
6978 @itemx 603e
6979 @itemx 604
6980 @itemx 620
6981 @itemx 630
6982 @itemx 740
6983 @itemx 7400
6984 @itemx 7450
6985 @itemx 750
6986 @itemx 505
6987 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6988
6989 @item 601
6990 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6991
6992 @item 403
6993 @itemx 821
6994 @itemx 860
6995 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6996 @end table
6997
6998 @item -mtune=@var{cpu_type}
6999 @opindex mtune
7000 Set the instruction scheduling parameters for machine type
7001 @var{cpu_type}, but do not set the architecture type, register usage, or
7002 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
7003 values for @var{cpu_type} are used for @option{-mtune} as for
7004 @option{-mcpu}. If both are specified, the code generated will use the
7005 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7006 scheduling parameters set by @option{-mtune}.
7007
7008 @item -maltivec
7009 @itemx -mno-altivec
7010 @opindex maltivec
7011 @opindex mno-altivec
7012 These switches enable or disable the use of built-in functions that
7013 allow access to the AltiVec instruction set. You may also need to set
7014 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7015 enhancements.
7016
7017 @item -mabi=spe
7018 @opindex mabi=spe
7019 Extend the current ABI with SPE ABI extensions. This does not change
7020 the default ABI, instead it adds the SPE ABI extensions to the current
7021 ABI@.
7022
7023 @item -mabi=no-spe
7024 @opindex mabi=no-spe
7025 Disable Booke SPE ABI extensions for the current ABI.
7026
7027 @item -misel=@var{yes/no}
7028 @itemx -misel
7029 @opindex misel
7030 This switch enables or disables the generation of ISEL instructions.
7031
7032 @item -mspe=@var{yes/no}
7033 @itemx -mspe
7034 @opindex mspe
7035 This switch enables or disables the generation of SPE simd
7036 instructions.
7037
7038 @item -mfull-toc
7039 @itemx -mno-fp-in-toc
7040 @itemx -mno-sum-in-toc
7041 @itemx -mminimal-toc
7042 @opindex mfull-toc
7043 @opindex mno-fp-in-toc
7044 @opindex mno-sum-in-toc
7045 @opindex mminimal-toc
7046 Modify generation of the TOC (Table Of Contents), which is created for
7047 every executable file. The @option{-mfull-toc} option is selected by
7048 default. In that case, GCC will allocate at least one TOC entry for
7049 each unique non-automatic variable reference in your program. GCC
7050 will also place floating-point constants in the TOC@. However, only
7051 16,384 entries are available in the TOC@.
7052
7053 If you receive a linker error message that saying you have overflowed
7054 the available TOC space, you can reduce the amount of TOC space used
7055 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7056 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7057 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7058 generate code to calculate the sum of an address and a constant at
7059 run-time instead of putting that sum into the TOC@. You may specify one
7060 or both of these options. Each causes GCC to produce very slightly
7061 slower and larger code at the expense of conserving TOC space.
7062
7063 If you still run out of space in the TOC even when you specify both of
7064 these options, specify @option{-mminimal-toc} instead. This option causes
7065 GCC to make only one TOC entry for every file. When you specify this
7066 option, GCC will produce code that is slower and larger but which
7067 uses extremely little TOC space. You may wish to use this option
7068 only on files that contain less frequently executed code.
7069
7070 @item -maix64
7071 @itemx -maix32
7072 @opindex maix64
7073 @opindex maix32
7074 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7075 @code{long} type, and the infrastructure needed to support them.
7076 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7077 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7078 implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
7079
7080 @item -mxl-call
7081 @itemx -mno-xl-call
7082 @opindex mxl-call
7083 @opindex mno-xl-call
7084 On AIX, pass floating-point arguments to prototyped functions beyond the
7085 register save area (RSA) on the stack in addition to argument FPRs. The
7086 AIX calling convention was extended but not initially documented to
7087 handle an obscure K&R C case of calling a function that takes the
7088 address of its arguments with fewer arguments than declared. AIX XL
7089 compilers access floating point arguments which do not fit in the
7090 RSA from the stack when a subroutine is compiled without
7091 optimization. Because always storing floating-point arguments on the
7092 stack is inefficient and rarely needed, this option is not enabled by
7093 default and only is necessary when calling subroutines compiled by AIX
7094 XL compilers without optimization.
7095
7096 @item -mpe
7097 @opindex mpe
7098 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
7099 application written to use message passing with special startup code to
7100 enable the application to run. The system must have PE installed in the
7101 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7102 must be overridden with the @option{-specs=} option to specify the
7103 appropriate directory location. The Parallel Environment does not
7104 support threads, so the @option{-mpe} option and the @option{-pthread}
7105 option are incompatible.
7106
7107 @item -msoft-float
7108 @itemx -mhard-float
7109 @opindex msoft-float
7110 @opindex mhard-float
7111 Generate code that does not use (uses) the floating-point register set.
7112 Software floating point emulation is provided if you use the
7113 @option{-msoft-float} option, and pass the option to GCC when linking.
7114
7115 @item -mmultiple
7116 @itemx -mno-multiple
7117 @opindex mmultiple
7118 @opindex mno-multiple
7119 Generate code that uses (does not use) the load multiple word
7120 instructions and the store multiple word instructions. These
7121 instructions are generated by default on POWER systems, and not
7122 generated on PowerPC systems. Do not use @option{-mmultiple} on little
7123 endian PowerPC systems, since those instructions do not work when the
7124 processor is in little endian mode. The exceptions are PPC740 and
7125 PPC750 which permit the instructions usage in little endian mode.
7126
7127 @item -mstring
7128 @itemx -mno-string
7129 @opindex mstring
7130 @opindex mno-string
7131 Generate code that uses (does not use) the load string instructions
7132 and the store string word instructions to save multiple registers and
7133 do small block moves. These instructions are generated by default on
7134 POWER systems, and not generated on PowerPC systems. Do not use
7135 @option{-mstring} on little endian PowerPC systems, since those
7136 instructions do not work when the processor is in little endian mode.
7137 The exceptions are PPC740 and PPC750 which permit the instructions
7138 usage in little endian mode.
7139
7140 @item -mupdate
7141 @itemx -mno-update
7142 @opindex mupdate
7143 @opindex mno-update
7144 Generate code that uses (does not use) the load or store instructions
7145 that update the base register to the address of the calculated memory
7146 location. These instructions are generated by default. If you use
7147 @option{-mno-update}, there is a small window between the time that the
7148 stack pointer is updated and the address of the previous frame is
7149 stored, which means code that walks the stack frame across interrupts or
7150 signals may get corrupted data.
7151
7152 @item -mfused-madd
7153 @itemx -mno-fused-madd
7154 @opindex mfused-madd
7155 @opindex mno-fused-madd
7156 Generate code that uses (does not use) the floating point multiply and
7157 accumulate instructions. These instructions are generated by default if
7158 hardware floating is used.
7159
7160 @item -mno-bit-align
7161 @itemx -mbit-align
7162 @opindex mno-bit-align
7163 @opindex mbit-align
7164 On System V.4 and embedded PowerPC systems do not (do) force structures
7165 and unions that contain bit-fields to be aligned to the base type of the
7166 bit-field.
7167
7168 For example, by default a structure containing nothing but 8
7169 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7170 boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
7171 the structure would be aligned to a 1 byte boundary and be one byte in
7172 size.
7173
7174 @item -mno-strict-align
7175 @itemx -mstrict-align
7176 @opindex mno-strict-align
7177 @opindex mstrict-align
7178 On System V.4 and embedded PowerPC systems do not (do) assume that
7179 unaligned memory references will be handled by the system.
7180
7181 @item -mrelocatable
7182 @itemx -mno-relocatable
7183 @opindex mrelocatable
7184 @opindex mno-relocatable
7185 On embedded PowerPC systems generate code that allows (does not allow)
7186 the program to be relocated to a different address at runtime. If you
7187 use @option{-mrelocatable} on any module, all objects linked together must
7188 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7189
7190 @item -mrelocatable-lib
7191 @itemx -mno-relocatable-lib
7192 @opindex mrelocatable-lib
7193 @opindex mno-relocatable-lib
7194 On embedded PowerPC systems generate code that allows (does not allow)
7195 the program to be relocated to a different address at runtime. Modules
7196 compiled with @option{-mrelocatable-lib} can be linked with either modules
7197 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7198 with modules compiled with the @option{-mrelocatable} options.
7199
7200 @item -mno-toc
7201 @itemx -mtoc
7202 @opindex mno-toc
7203 @opindex mtoc
7204 On System V.4 and embedded PowerPC systems do not (do) assume that
7205 register 2 contains a pointer to a global area pointing to the addresses
7206 used in the program.
7207
7208 @item -mlittle
7209 @itemx -mlittle-endian
7210 @opindex mlittle
7211 @opindex mlittle-endian
7212 On System V.4 and embedded PowerPC systems compile code for the
7213 processor in little endian mode. The @option{-mlittle-endian} option is
7214 the same as @option{-mlittle}.
7215
7216 @item -mbig
7217 @itemx -mbig-endian
7218 @opindex mbig
7219 @opindex mbig-endian
7220 On System V.4 and embedded PowerPC systems compile code for the
7221 processor in big endian mode. The @option{-mbig-endian} option is
7222 the same as @option{-mbig}.
7223
7224 @item -mdynamic-no-pic
7225 @opindex mdynamic-no-pic
7226 On Darwin and Mac OS X systems, compile code so that it is not
7227 relocatable, but that its external references are relocatable. The
7228 resulting code is suitable for applications, but not shared
7229 libraries.
7230
7231 @item -mcall-sysv
7232 @opindex mcall-sysv
7233 On System V.4 and embedded PowerPC systems compile code using calling
7234 conventions that adheres to the March 1995 draft of the System V
7235 Application Binary Interface, PowerPC processor supplement. This is the
7236 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7237
7238 @item -mcall-sysv-eabi
7239 @opindex mcall-sysv-eabi
7240 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7241
7242 @item -mcall-sysv-noeabi
7243 @opindex mcall-sysv-noeabi
7244 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7245
7246 @item -mcall-aix
7247 @opindex mcall-aix
7248 On System V.4 and embedded PowerPC systems compile code using calling
7249 conventions that are similar to those used on AIX@. This is the
7250 default if you configured GCC using @samp{powerpc-*-eabiaix}.
7251
7252 @item -mcall-solaris
7253 @opindex mcall-solaris
7254 On System V.4 and embedded PowerPC systems compile code for the Solaris
7255 operating system.
7256
7257 @item -mcall-linux
7258 @opindex mcall-linux
7259 On System V.4 and embedded PowerPC systems compile code for the
7260 Linux-based GNU system.
7261
7262 @item -mcall-gnu
7263 @opindex mcall-gnu
7264 On System V.4 and embedded PowerPC systems compile code for the
7265 Hurd-based GNU system.
7266
7267 @item -mcall-netbsd
7268 @opindex mcall-netbsd
7269 On System V.4 and embedded PowerPC systems compile code for the
7270 NetBSD operating system.
7271
7272 @item -maix-struct-return
7273 @opindex maix-struct-return
7274 Return all structures in memory (as specified by the AIX ABI)@.
7275
7276 @item -msvr4-struct-return
7277 @opindex msvr4-struct-return
7278 Return structures smaller than 8 bytes in registers (as specified by the
7279 SVR4 ABI)@.
7280
7281 @item -mabi=altivec
7282 @opindex mabi=altivec
7283 Extend the current ABI with AltiVec ABI extensions. This does not
7284 change the default ABI, instead it adds the AltiVec ABI extensions to
7285 the current ABI@.
7286
7287 @item -mabi=no-altivec
7288 @opindex mabi=no-altivec
7289 Disable AltiVec ABI extensions for the current ABI.
7290
7291 @item -mprototype
7292 @itemx -mno-prototype
7293 @opindex mprototype
7294 @opindex mno-prototype
7295 On System V.4 and embedded PowerPC systems assume that all calls to
7296 variable argument functions are properly prototyped. Otherwise, the
7297 compiler must insert an instruction before every non prototyped call to
7298 set or clear bit 6 of the condition code register (@var{CR}) to
7299 indicate whether floating point values were passed in the floating point
7300 registers in case the function takes a variable arguments. With
7301 @option{-mprototype}, only calls to prototyped variable argument functions
7302 will set or clear the bit.
7303
7304 @item -msim
7305 @opindex msim
7306 On embedded PowerPC systems, assume that the startup module is called
7307 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7308 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
7309 configurations.
7310
7311 @item -mmvme
7312 @opindex mmvme
7313 On embedded PowerPC systems, assume that the startup module is called
7314 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7315 @file{libc.a}.
7316
7317 @item -mads
7318 @opindex mads
7319 On embedded PowerPC systems, assume that the startup module is called
7320 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7321 @file{libc.a}.
7322
7323 @item -myellowknife
7324 @opindex myellowknife
7325 On embedded PowerPC systems, assume that the startup module is called
7326 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7327 @file{libc.a}.
7328
7329 @item -mvxworks
7330 @opindex mvxworks
7331 On System V.4 and embedded PowerPC systems, specify that you are
7332 compiling for a VxWorks system.
7333
7334 @item -mwindiss
7335 @opindex mwindiss
7336 Specify that you are compiling for the WindISS simulation environment.
7337
7338 @item -memb
7339 @opindex memb
7340 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7341 header to indicate that @samp{eabi} extended relocations are used.
7342
7343 @item -meabi
7344 @itemx -mno-eabi
7345 @opindex meabi
7346 @opindex mno-eabi
7347 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7348 Embedded Applications Binary Interface (eabi) which is a set of
7349 modifications to the System V.4 specifications. Selecting @option{-meabi}
7350 means that the stack is aligned to an 8 byte boundary, a function
7351 @code{__eabi} is called to from @code{main} to set up the eabi
7352 environment, and the @option{-msdata} option can use both @code{r2} and
7353 @code{r13} to point to two separate small data areas. Selecting
7354 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7355 do not call an initialization function from @code{main}, and the
7356 @option{-msdata} option will only use @code{r13} to point to a single
7357 small data area. The @option{-meabi} option is on by default if you
7358 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7359
7360 @item -msdata=eabi
7361 @opindex msdata=eabi
7362 On System V.4 and embedded PowerPC systems, put small initialized
7363 @code{const} global and static data in the @samp{.sdata2} section, which
7364 is pointed to by register @code{r2}. Put small initialized
7365 non-@code{const} global and static data in the @samp{.sdata} section,
7366 which is pointed to by register @code{r13}. Put small uninitialized
7367 global and static data in the @samp{.sbss} section, which is adjacent to
7368 the @samp{.sdata} section. The @option{-msdata=eabi} option is
7369 incompatible with the @option{-mrelocatable} option. The
7370 @option{-msdata=eabi} option also sets the @option{-memb} option.
7371
7372 @item -msdata=sysv
7373 @opindex msdata=sysv
7374 On System V.4 and embedded PowerPC systems, put small global and static
7375 data in the @samp{.sdata} section, which is pointed to by register
7376 @code{r13}. Put small uninitialized global and static data in the
7377 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7378 The @option{-msdata=sysv} option is incompatible with the
7379 @option{-mrelocatable} option.
7380
7381 @item -msdata=default
7382 @itemx -msdata
7383 @opindex msdata=default
7384 @opindex msdata
7385 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7386 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7387 same as @option{-msdata=sysv}.
7388
7389 @item -msdata-data
7390 @opindex msdata-data
7391 On System V.4 and embedded PowerPC systems, put small global and static
7392 data in the @samp{.sdata} section. Put small uninitialized global and
7393 static data in the @samp{.sbss} section. Do not use register @code{r13}
7394 to address small data however. This is the default behavior unless
7395 other @option{-msdata} options are used.
7396
7397 @item -msdata=none
7398 @itemx -mno-sdata
7399 @opindex msdata=none
7400 @opindex mno-sdata
7401 On embedded PowerPC systems, put all initialized global and static data
7402 in the @samp{.data} section, and all uninitialized data in the
7403 @samp{.bss} section.
7404
7405 @item -G @var{num}
7406 @opindex G
7407 @cindex smaller data references (PowerPC)
7408 @cindex .sdata/.sdata2 references (PowerPC)
7409 On embedded PowerPC systems, put global and static items less than or
7410 equal to @var{num} bytes into the small data or bss sections instead of
7411 the normal data or bss section. By default, @var{num} is 8. The
7412 @option{-G @var{num}} switch is also passed to the linker.
7413 All modules should be compiled with the same @option{-G @var{num}} value.
7414
7415 @item -mregnames
7416 @itemx -mno-regnames
7417 @opindex mregnames
7418 @opindex mno-regnames
7419 On System V.4 and embedded PowerPC systems do (do not) emit register
7420 names in the assembly language output using symbolic forms.
7421
7422 @item -mlongcall
7423 @itemx -mno-longcall
7424 @opindex mlongcall
7425 @opindex mno-longcall
7426 Default to making all function calls via pointers, so that functions
7427 which reside further than 64 megabytes (67,108,864 bytes) from the
7428 current location can be called. This setting can be overridden by the
7429 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7430
7431 Some linkers are capable of detecting out-of-range calls and generating
7432 glue code on the fly. On these systems, long calls are unnecessary and
7433 generate slower code. As of this writing, the AIX linker can do this,
7434 as can the GNU linker for PowerPC/64. It is planned to add this feature
7435 to the GNU linker for 32-bit PowerPC systems as well.
7436
7437 In the future, we may cause GCC to ignore all longcall specifications
7438 when the linker is known to generate glue.
7439
7440 @item -pthread
7441 @opindex pthread
7442 Adds support for multithreading with the @dfn{pthreads} library.
7443 This option sets flags for both the preprocessor and linker.
7444
7445 @end table
7446
7447 @node Darwin Options
7448 @subsection Darwin Options
7449 @cindex Darwin options
7450 @table @gcctabopt
7451 @item -all_load
7452 @opindex all_load
7453 Loads all members of static archive libraries.
7454 See man ld(1) for more information.
7455
7456 @item -arch_errors_fatal
7457 @opindex arch_errors_fatal
7458 Cause the errors having to do with files that have the wrong architecture
7459 to be fatal.
7460
7461 @item -bind_at_load
7462 @opindex bind_at_load
7463 Causes the output file to be marked such that the dynamic linker will
7464 bind all undefined references when the file is loaded or launched.
7465
7466 @item -bundle
7467 @opindex bundle
7468 Produce a Mach-o bundle format file.
7469 See man ld(1) for more information.
7470
7471 @item -bundle_loader @var{executable}
7472 @opindex bundle_loader
7473 This specifies the @var{executable} that will be loading the build
7474 output file being linked. See man ld(1) for more information.
7475
7476 @item -allowable_client @var{client_name}
7477 @item -arch_only
7478
7479 @item -client_name
7480 @item -compatibility_version
7481 @item -current_version
7482 @item -dependency-file
7483 @item -dylib_file
7484 @item -dylinker_install_name
7485 @item -dynamic
7486 @item -dynamiclib
7487 @item -exported_symbols_list
7488 @item -filelist
7489 @item -flat_namespace
7490 @item -force_cpusubtype_ALL
7491 @item -force_flat_namespace
7492 @item -headerpad_max_install_names
7493 @item -image_base
7494 @item -init
7495 @item -install_name
7496 @item -keep_private_externs
7497 @item -multi_module
7498 @item -multiply_defined
7499 @item -multiply_defined_unused
7500 @item -noall_load
7501 @item -nomultidefs
7502 @item -noprebind
7503 @item -noseglinkedit
7504 @item -pagezero_size
7505 @item -prebind
7506 @item -prebind_all_twolevel_modules
7507 @item -private_bundle
7508 @item -read_only_relocs
7509 @item -sectalign
7510 @item -sectobjectsymbols
7511 @item -whyload
7512 @item -seg1addr
7513 @item -sectcreate
7514 @item -sectobjectsymbols
7515 @item -sectorder
7516 @item -seg_addr_table
7517 @item -seg_addr_table_filename
7518 @item -seglinkedit
7519 @item -segprot
7520 @item -segs_read_only_addr
7521 @item -segs_read_write_addr
7522 @item -single_module
7523 @item -static
7524 @item -sub_library
7525 @item -sub_umbrella
7526 @item -twolevel_namespace
7527 @item -umbrella
7528 @item -undefined
7529 @item -unexported_symbols_list
7530 @item -weak_reference_mismatches
7531 @item -whatsloaded
7532
7533 @opindex allowable_client
7534 @opindex arch_only
7535 @opindex client_name
7536 @opindex compatibility_version
7537 @opindex current_version
7538 @opindex dependency-file
7539 @opindex dylib_file
7540 @opindex dylinker_install_name
7541 @opindex dynamic
7542 @opindex dynamiclib
7543 @opindex exported_symbols_list
7544 @opindex filelist
7545 @opindex flat_namespace
7546 @opindex force_cpusubtype_ALL
7547 @opindex force_flat_namespace
7548 @opindex headerpad_max_install_names
7549 @opindex image_base
7550 @opindex init
7551 @opindex install_name
7552 @opindex keep_private_externs
7553 @opindex multi_module
7554 @opindex multiply_defined
7555 @opindex multiply_defined_unused
7556 @opindex noall_load
7557 @opindex nomultidefs
7558 @opindex noprebind
7559 @opindex noseglinkedit
7560 @opindex pagezero_size
7561 @opindex prebind
7562 @opindex prebind_all_twolevel_modules
7563 @opindex private_bundle
7564 @opindex read_only_relocs
7565 @opindex sectalign
7566 @opindex sectobjectsymbols
7567 @opindex whyload
7568 @opindex seg1addr
7569 @opindex sectcreate
7570 @opindex sectobjectsymbols
7571 @opindex sectorder
7572 @opindex seg_addr_table
7573 @opindex seg_addr_table_filename
7574 @opindex seglinkedit
7575 @opindex segprot
7576 @opindex segs_read_only_addr
7577 @opindex segs_read_write_addr
7578 @opindex single_module
7579 @opindex static
7580 @opindex sub_library
7581 @opindex sub_umbrella
7582 @opindex twolevel_namespace
7583 @opindex umbrella
7584 @opindex undefined
7585 @opindex unexported_symbols_list
7586 @opindex weak_reference_mismatches
7587 @opindex whatsloaded
7588
7589 This options are available for Darwin linker. Darwin linker man page
7590 describes them in detail.
7591 @end table
7592
7593
7594 @node RT Options
7595 @subsection IBM RT Options
7596 @cindex RT options
7597 @cindex IBM RT options
7598
7599 These @samp{-m} options are defined for the IBM RT PC:
7600
7601 @table @gcctabopt
7602 @item -min-line-mul
7603 @opindex min-line-mul
7604 Use an in-line code sequence for integer multiplies. This is the
7605 default.
7606
7607 @item -mcall-lib-mul
7608 @opindex mcall-lib-mul
7609 Call @code{lmul$$} for integer multiples.
7610
7611 @item -mfull-fp-blocks
7612 @opindex mfull-fp-blocks
7613 Generate full-size floating point data blocks, including the minimum
7614 amount of scratch space recommended by IBM@. This is the default.
7615
7616 @item -mminimum-fp-blocks
7617 @opindex mminimum-fp-blocks
7618 Do not include extra scratch space in floating point data blocks. This
7619 results in smaller code, but slower execution, since scratch space must
7620 be allocated dynamically.
7621
7622 @cindex @file{stdarg.h} and RT PC
7623 @item -mfp-arg-in-fpregs
7624 @opindex mfp-arg-in-fpregs
7625 Use a calling sequence incompatible with the IBM calling convention in
7626 which floating point arguments are passed in floating point registers.
7627 Note that @code{stdarg.h} will not work with floating point operands
7628 if this option is specified.
7629
7630 @item -mfp-arg-in-gregs
7631 @opindex mfp-arg-in-gregs
7632 Use the normal calling convention for floating point arguments. This is
7633 the default.
7634
7635 @item -mhc-struct-return
7636 @opindex mhc-struct-return
7637 Return structures of more than one word in memory, rather than in a
7638 register. This provides compatibility with the MetaWare HighC (hc)
7639 compiler. Use the option @option{-fpcc-struct-return} for compatibility
7640 with the Portable C Compiler (pcc).
7641
7642 @item -mnohc-struct-return
7643 @opindex mnohc-struct-return
7644 Return some structures of more than one word in registers, when
7645 convenient. This is the default. For compatibility with the
7646 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7647 option @option{-mhc-struct-return}.
7648 @end table
7649
7650 @node MIPS Options
7651 @subsection MIPS Options
7652 @cindex MIPS options
7653
7654 These @samp{-m} options are defined for the MIPS family of computers:
7655
7656 @table @gcctabopt
7657
7658 @item -march=@var{arch}
7659 @opindex march
7660 Generate code that will run on @var{arch}, which can be the name of a
7661 generic MIPS ISA, or the name of a particular processor.
7662 The ISA names are:
7663 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7664 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7665 The processor names are:
7666 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7667 @samp{m4k},
7668 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7669 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
7670 @samp{orion},
7671 @samp{sb1},
7672 @samp{vr4100}, @samp{vr4300}, and @samp{vr5000}.
7673 The special value @samp{from-abi} selects the
7674 most compatible architecture for the selected ABI (that is,
7675 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7676
7677 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7678 (for example, @samp{-march=r2k}). Prefixes are optional, and
7679 @samp{vr} may be written @samp{r}.
7680
7681 GCC defines two macros based on the value of this option. The first
7682 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7683 a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
7684 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7685 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7686 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7687
7688 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7689 above. In other words, it will have the full prefix and will not
7690 abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
7691 the macro names the resolved architecture (either @samp{"mips1"} or
7692 @samp{"mips3"}). It names the default architecture when no
7693 @option{-march} option is given.
7694
7695 @item -mtune=@var{arch}
7696 @opindex mtune
7697 Optimize for @var{arch}. Among other things, this option controls
7698 the way instructions are scheduled, and the perceived cost of arithmetic
7699 operations. The list of @var{arch} values is the same as for
7700 @option{-march}.
7701
7702 When this option is not used, GCC will optimize for the processor
7703 specified by @option{-march}. By using @option{-march} and
7704 @option{-mtune} together, it is possible to generate code that will
7705 run on a family of processors, but optimize the code for one
7706 particular member of that family.
7707
7708 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7709 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7710 @samp{-march} ones described above.
7711
7712 @item -mips1
7713 @opindex mips1
7714 Equivalent to @samp{-march=mips1}.
7715
7716 @item -mips2
7717 @opindex mips2
7718 Equivalent to @samp{-march=mips2}.
7719
7720 @item -mips3
7721 @opindex mips3
7722 Equivalent to @samp{-march=mips3}.
7723
7724 @item -mips4
7725 @opindex mips4
7726 Equivalent to @samp{-march=mips4}.
7727
7728 @item -mips32
7729 @opindex mips32
7730 Equivalent to @samp{-march=mips32}.
7731
7732 @item -mips32r2
7733 @opindex mips32r2
7734 Equivalent to @samp{-march=mips32r2}.
7735
7736 @item -mips64
7737 @opindex mips64
7738 Equivalent to @samp{-march=mips64}.
7739
7740 @item -mfused-madd
7741 @itemx -mno-fused-madd
7742 @opindex mfused-madd
7743 @opindex mno-fused-madd
7744 Generate code that uses (does not use) the floating point multiply and
7745 accumulate instructions, when they are available. These instructions
7746 are generated by default if they are available, but this may be
7747 undesirable if the extra precision causes problems or on certain chips
7748 in the mode where denormals are rounded to zero where denormals
7749 generated by multiply and accumulate instructions cause exceptions
7750 anyway.
7751
7752 @item -mfp32
7753 @opindex mfp32
7754 Assume that floating point registers are 32 bits wide.
7755
7756 @item -mfp64
7757 @opindex mfp64
7758 Assume that floating point registers are 64 bits wide.
7759
7760 @item -mgp32
7761 @opindex mgp32
7762 Assume that general purpose registers are 32 bits wide.
7763
7764 @item -mgp64
7765 @opindex mgp64
7766 Assume that general purpose registers are 64 bits wide.
7767
7768 @item -mint64
7769 @opindex mint64
7770 Force int and long types to be 64 bits wide. See @option{-mlong32} for an
7771 explanation of the default, and the width of pointers.
7772
7773 @item -mlong64
7774 @opindex mlong64
7775 Force long types to be 64 bits wide. See @option{-mlong32} for an
7776 explanation of the default, and the width of pointers.
7777
7778 @item -mlong32
7779 @opindex mlong32
7780 Force long, int, and pointer types to be 32 bits wide.
7781
7782 The default size of ints, longs and pointers depends on the ABI@. All
7783 the supported ABIs use 32-bit ints. The n64 ABI uses 64-bit longs, as
7784 does the 64-bit Cygnus EABI; the others use 32-bit longs. Pointers
7785 are the same size as longs, or the same size as integer registers,
7786 whichever is smaller.
7787
7788 @item -mabi=32
7789 @itemx -mabi=o64
7790 @itemx -mabi=n32
7791 @itemx -mabi=64
7792 @itemx -mabi=eabi
7793 @itemx -mabi=meabi
7794 @opindex mabi=32
7795 @opindex mabi=o64
7796 @opindex mabi=n32
7797 @opindex mabi=64
7798 @opindex mabi=eabi
7799 @opindex mabi=meabi
7800 Generate code for the given ABI@.
7801
7802 Note that there are two embedded ABIs: @option{-mabi=eabi}
7803 selects the one defined by Cygnus while @option{-meabi=meabi}
7804 selects the one defined by MIPS@. Both these ABIs have
7805 32-bit and 64-bit variants. Normally, GCC will generate
7806 64-bit code when you select a 64-bit architecture, but you
7807 can use @option{-mgp32} to get 32-bit code instead.
7808
7809 @item -mabi-fake-default
7810 @opindex mabi-fake-default
7811 You don't want to know what this option does. No, really. I mean
7812 it. Move on to the next option.
7813
7814 What? You're still here? Oh, well@enddots{} Ok, here's the deal. GCC
7815 wants the default set of options to get the root of the multilib tree,
7816 and the shared library SONAMEs without any multilib-indicating
7817 suffixes. This is not convenience for @samp{mips64-linux-gnu}, since
7818 we want to default to the N32 ABI, while still being binary-compatible
7819 with @samp{mips-linux-gnu} if you stick to the O32 ABI@. Being
7820 binary-compatible means shared libraries should have the same SONAMEs,
7821 and libraries should live in the same location. Having O32 libraries
7822 in a sub-directory named say @file{o32} is not acceptable.
7823
7824 So we trick GCC into believing that O32 is the default ABI, except
7825 that we override the default with some internal command-line
7826 processing magic. Problem is, if we stopped at that, and you then
7827 created a multilib-aware package that used the output of @command{gcc
7828 -print-multi-lib} to decide which multilibs to build, and how, and
7829 you'd find yourself in an awkward situation when you found out that
7830 some of the options listed ended up mapping to the same multilib, and
7831 none of your libraries was actually built for the multilib that
7832 @option{-print-multi-lib} claims to be the default. So we added this
7833 option that disables the default switcher, falling back to GCC's
7834 original notion of the default library. Confused yet?
7835
7836 For short: don't ever use this option, unless you find it in the list
7837 of additional options to be used when building for multilibs, in the
7838 output of @option{gcc -print-multi-lib}.
7839
7840 @item -mmips-as
7841 @opindex mmips-as
7842 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7843 add normal debug information. This is the default for all
7844 platforms except for the OSF/1 reference platform, using the OSF/rose
7845 object format. If the either of the @option{-gstabs} or @option{-gstabs+}
7846 switches are used, the @file{mips-tfile} program will encapsulate the
7847 stabs within MIPS ECOFF@.
7848
7849 @item -mgas
7850 @opindex mgas
7851 Generate code for the GNU assembler. This is the default on the OSF/1
7852 reference platform, using the OSF/rose object format. Also, this is
7853 the default if the configure option @option{--with-gnu-as} is used.
7854
7855 @item -msplit-addresses
7856 @itemx -mno-split-addresses
7857 @opindex msplit-addresses
7858 @opindex mno-split-addresses
7859 Generate code to load the high and low parts of address constants separately.
7860 This allows GCC to optimize away redundant loads of the high order
7861 bits of addresses. This optimization requires GNU as and GNU ld.
7862 This optimization is enabled by default for some embedded targets where
7863 GNU as and GNU ld are standard.
7864
7865 @item -mrnames
7866 @itemx -mno-rnames
7867 @opindex mrnames
7868 @opindex mno-rnames
7869 The @option{-mrnames} switch says to output code using the MIPS software
7870 names for the registers, instead of the hardware names (ie, @var{a0}
7871 instead of @var{$4}). The only known assembler that supports this option
7872 is the Algorithmics assembler.
7873
7874 @item -mgpopt
7875 @itemx -mno-gpopt
7876 @opindex mgpopt
7877 @opindex mno-gpopt
7878 The @option{-mgpopt} switch says to write all of the data declarations
7879 before the instructions in the text section, this allows the MIPS
7880 assembler to generate one word memory references instead of using two
7881 words for short global or static data items. This is on by default if
7882 optimization is selected.
7883
7884 @item -mstats
7885 @itemx -mno-stats
7886 @opindex mstats
7887 @opindex mno-stats
7888 For each non-inline function processed, the @option{-mstats} switch
7889 causes the compiler to emit one line to the standard error file to
7890 print statistics about the program (number of registers saved, stack
7891 size, etc.).
7892
7893 @item -mmemcpy
7894 @itemx -mno-memcpy
7895 @opindex mmemcpy
7896 @opindex mno-memcpy
7897 The @option{-mmemcpy} switch makes all block moves call the appropriate
7898 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7899 generating inline code.
7900
7901 @item -mmips-tfile
7902 @itemx -mno-mips-tfile
7903 @opindex mmips-tfile
7904 @opindex mno-mips-tfile
7905 The @option{-mno-mips-tfile} switch causes the compiler not
7906 postprocess the object file with the @file{mips-tfile} program,
7907 after the MIPS assembler has generated it to add debug support. If
7908 @file{mips-tfile} is not run, then no local variables will be
7909 available to the debugger. In addition, @file{stage2} and
7910 @file{stage3} objects will have the temporary file names passed to the
7911 assembler embedded in the object file, which means the objects will
7912 not compare the same. The @option{-mno-mips-tfile} switch should only
7913 be used when there are bugs in the @file{mips-tfile} program that
7914 prevents compilation.
7915
7916 @item -msoft-float
7917 @opindex msoft-float
7918 Generate output containing library calls for floating point.
7919 @strong{Warning:} the requisite libraries are not part of GCC@.
7920 Normally the facilities of the machine's usual C compiler are used, but
7921 this can't be done directly in cross-compilation. You must make your
7922 own arrangements to provide suitable library functions for
7923 cross-compilation.
7924
7925 @item -mhard-float
7926 @opindex mhard-float
7927 Generate output containing floating point instructions. This is the
7928 default if you use the unmodified sources.
7929
7930 @item -mabicalls
7931 @itemx -mno-abicalls
7932 @opindex mabicalls
7933 @opindex mno-abicalls
7934 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7935 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7936 position independent code.
7937
7938 @item -mlong-calls
7939 @itemx -mno-long-calls
7940 @opindex mlong-calls
7941 @opindex mno-long-calls
7942 Do all calls with the @samp{JALR} instruction, which requires
7943 loading up a function's address into a register before the call.
7944 You need to use this switch, if you call outside of the current
7945 512 megabyte segment to functions that are not through pointers.
7946
7947 @item -mhalf-pic
7948 @itemx -mno-half-pic
7949 @opindex mhalf-pic
7950 @opindex mno-half-pic
7951 Put pointers to extern references into the data section and load them
7952 up, rather than put the references in the text section.
7953
7954 @item -membedded-pic
7955 @itemx -mno-embedded-pic
7956 @opindex membedded-pic
7957 @opindex mno-embedded-pic
7958 Generate PIC code suitable for some embedded systems. All calls are
7959 made using PC relative address, and all data is addressed using the $gp
7960 register. No more than 65536 bytes of global data may be used. This
7961 requires GNU as and GNU ld which do most of the work. This currently
7962 only works on targets which use ECOFF; it does not work with ELF@.
7963
7964 @item -membedded-data
7965 @itemx -mno-embedded-data
7966 @opindex membedded-data
7967 @opindex mno-embedded-data
7968 Allocate variables to the read-only data section first if possible, then
7969 next in the small data section if possible, otherwise in data. This gives
7970 slightly slower code than the default, but reduces the amount of RAM required
7971 when executing, and thus may be preferred for some embedded systems.
7972
7973 @item -muninit-const-in-rodata
7974 @itemx -mno-uninit-const-in-rodata
7975 @opindex muninit-const-in-rodata
7976 @opindex mno-uninit-const-in-rodata
7977 When used together with @option{-membedded-data}, it will always store uninitialized
7978 const variables in the read-only data section.
7979
7980 @item -msingle-float
7981 @itemx -mdouble-float
7982 @opindex msingle-float
7983 @opindex mdouble-float
7984 The @option{-msingle-float} switch tells gcc to assume that the floating
7985 point coprocessor only supports single precision operations, as on the
7986 @samp{r4650} chip. The @option{-mdouble-float} switch permits gcc to use
7987 double precision operations. This is the default.
7988
7989 @item -mmad
7990 @itemx -mno-mad
7991 @opindex mmad
7992 @opindex mno-mad
7993 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7994 as on the @samp{r4650} chip.
7995
7996 @item -m4650
7997 @opindex m4650
7998 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7999 @option{-mcpu=r4650}.
8000
8001 @item -mips16
8002 @itemx -mno-mips16
8003 @opindex mips16
8004 @opindex mno-mips16
8005 Enable 16-bit instructions.
8006
8007 @item -mentry
8008 @opindex mentry
8009 Use the entry and exit pseudo ops. This option can only be used with
8010 @option{-mips16}.
8011
8012 @item -EL
8013 @opindex EL
8014 Compile code for the processor in little endian mode.
8015 The requisite libraries are assumed to exist.
8016
8017 @item -EB
8018 @opindex EB
8019 Compile code for the processor in big endian mode.
8020 The requisite libraries are assumed to exist.
8021
8022 @item -G @var{num}
8023 @opindex G
8024 @cindex smaller data references (MIPS)
8025 @cindex gp-relative references (MIPS)
8026 Put global and static items less than or equal to @var{num} bytes into
8027 the small data or bss sections instead of the normal data or bss
8028 section. This allows the assembler to emit one word memory reference
8029 instructions based on the global pointer (@var{gp} or @var{$28}),
8030 instead of the normal two words used. By default, @var{num} is 8 when
8031 the MIPS assembler is used, and 0 when the GNU assembler is used. The
8032 @option{-G @var{num}} switch is also passed to the assembler and linker.
8033 All modules should be compiled with the same @option{-G @var{num}}
8034 value.
8035
8036 @item -nocpp
8037 @opindex nocpp
8038 Tell the MIPS assembler to not run its preprocessor over user
8039 assembler files (with a @samp{.s} suffix) when assembling them.
8040
8041 @item -mfix7000
8042 @opindex mfix7000
8043 Pass an option to gas which will cause nops to be inserted if
8044 the read of the destination register of an mfhi or mflo instruction
8045 occurs in the following two instructions.
8046
8047 @item -no-crt0
8048 @opindex no-crt0
8049 Do not include the default crt0.
8050
8051 @item -mflush-func=@var{func}
8052 @itemx -mno-flush-func
8053 @opindex mflush-func
8054 Specifies the function to call to flush the I and D caches, or to not
8055 call any such function. If called, the function must take the same
8056 arguments as the common @code{_flush_func()}, that is, the address of the
8057 memory range for which the cache is being flushed, the size of the
8058 memory range, and the number 3 (to flush both caches). The default
8059 depends on the target gcc was configured for, but commonly is either
8060 @samp{_flush_func} or @samp{__cpu_flush}.
8061
8062 @item -mbranch-likely
8063 @itemx -mno-branch-likely
8064 @opindex mbranch-likely
8065 @opindex mno-branch-likely
8066 Enable or disable use of Branch Likely instructions, regardless of the
8067 default for the selected architecture. By default, Branch Likely
8068 instructions may be generated if they are supported by the selected
8069 architecture. An exception is for the MIPS32 and MIPS64 architectures
8070 and processors which implement those architectures; for those, Branch
8071 Likely instructions will not be generated by default because the MIPS32
8072 and MIPS64 architectures specifically deprecate their use.
8073 @end table
8074
8075 @node i386 and x86-64 Options
8076 @subsection Intel 386 and AMD x86-64 Options
8077 @cindex i386 Options
8078 @cindex x86-64 Options
8079 @cindex Intel 386 Options
8080 @cindex AMD x86-64 Options
8081
8082 These @samp{-m} options are defined for the i386 and x86-64 family of
8083 computers:
8084
8085 @table @gcctabopt
8086 @item -mtune=@var{cpu-type}
8087 @opindex mtune
8088 Tune to @var{cpu-type} everything applicable about the generated code, except
8089 for the ABI and the set of available instructions. The choices for
8090 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8091 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8092 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8093 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8094 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8095 and @samp{c3-2}.
8096
8097 While picking a specific @var{cpu-type} will schedule things appropriately
8098 for that particular chip, the compiler will not generate any code that
8099 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8100 being used. @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8101 is equivalent to @samp{pentiumpro}. @samp{k6} and @samp{athlon} are the
8102 AMD chips as opposed to the Intel ones.
8103
8104 @item -march=@var{cpu-type}
8105 @opindex march
8106 Generate instructions for the machine type @var{cpu-type}. The choices
8107 for @var{cpu-type} are the same as for @option{-mtune}. Moreover,
8108 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8109
8110 @item -mcpu=@var{cpu-type}
8111 @opindex mcpu
8112 A deprecated synonym for @option{-mtune}.
8113
8114 @item -m386
8115 @itemx -m486
8116 @itemx -mpentium
8117 @itemx -mpentiumpro
8118 @opindex m386
8119 @opindex m486
8120 @opindex mpentium
8121 @opindex mpentiumpro
8122 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8123 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8124 These synonyms are deprecated.
8125
8126 @item -mfpmath=@var{unit}
8127 @opindex march
8128 generate floating point arithmetics for selected unit @var{unit}. the choices
8129 for @var{unit} are:
8130
8131 @table @samp
8132 @item 387
8133 Use the standard 387 floating point coprocessor present majority of chips and
8134 emulated otherwise. Code compiled with this option will run almost everywhere.
8135 The temporary results are computed in 80bit precision instead of precision
8136 specified by the type resulting in slightly different results compared to most
8137 of other chips. See @option{-ffloat-store} for more detailed description.
8138
8139 This is the default choice for i386 compiler.
8140
8141 @item sse
8142 Use scalar floating point instructions present in the SSE instruction set.
8143 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8144 by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
8145 instruction set supports only single precision arithmetics, thus the double and
8146 extended precision arithmetics is still done using 387. Later version, present
8147 only in Pentium4 and the future AMD x86-64 chips supports double precision
8148 arithmetics too.
8149
8150 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8151 @option{-msse2} switches to enable SSE extensions and make this option
8152 effective. For x86-64 compiler, these extensions are enabled by default.
8153
8154 The resulting code should be considerably faster in majority of cases and avoid
8155 the numerical instability problems of 387 code, but may break some existing
8156 code that expects temporaries to be 80bit.
8157
8158 This is the default choice for x86-64 compiler.
8159
8160 @item sse,387
8161 Attempt to utilize both instruction sets at once. This effectively double the
8162 amount of available registers and on chips with separate execution units for
8163 387 and SSE the execution resources too. Use this option with care, as it is
8164 still experimental, because gcc register allocator does not model separate
8165 functional units well resulting in instable performance.
8166 @end table
8167
8168 @item -masm=@var{dialect}
8169 @opindex masm=@var{dialect}
8170 Output asm instructions using selected @var{dialect}. Supported choices are
8171 @samp{intel} or @samp{att} (the default one).
8172
8173 @item -mieee-fp
8174 @itemx -mno-ieee-fp
8175 @opindex mieee-fp
8176 @opindex mno-ieee-fp
8177 Control whether or not the compiler uses IEEE floating point
8178 comparisons. These handle correctly the case where the result of a
8179 comparison is unordered.
8180
8181 @item -msoft-float
8182 @opindex msoft-float
8183 Generate output containing library calls for floating point.
8184 @strong{Warning:} the requisite libraries are not part of GCC@.
8185 Normally the facilities of the machine's usual C compiler are used, but
8186 this can't be done directly in cross-compilation. You must make your
8187 own arrangements to provide suitable library functions for
8188 cross-compilation.
8189
8190 On machines where a function returns floating point results in the 80387
8191 register stack, some floating point opcodes may be emitted even if
8192 @option{-msoft-float} is used.
8193
8194 @item -mno-fp-ret-in-387
8195 @opindex mno-fp-ret-in-387
8196 Do not use the FPU registers for return values of functions.
8197
8198 The usual calling convention has functions return values of types
8199 @code{float} and @code{double} in an FPU register, even if there
8200 is no FPU@. The idea is that the operating system should emulate
8201 an FPU@.
8202
8203 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8204 in ordinary CPU registers instead.
8205
8206 @item -mno-fancy-math-387
8207 @opindex mno-fancy-math-387
8208 Some 387 emulators do not support the @code{sin}, @code{cos} and
8209 @code{sqrt} instructions for the 387. Specify this option to avoid
8210 generating those instructions. This option is the default on FreeBSD,
8211 OpenBSD and NetBSD@. This option is overridden when @option{-march}
8212 indicates that the target cpu will always have an FPU and so the
8213 instruction will not need emulation. As of revision 2.6.1, these
8214 instructions are not generated unless you also use the
8215 @option{-funsafe-math-optimizations} switch.
8216
8217 @item -malign-double
8218 @itemx -mno-align-double
8219 @opindex malign-double
8220 @opindex mno-align-double
8221 Control whether GCC aligns @code{double}, @code{long double}, and
8222 @code{long long} variables on a two word boundary or a one word
8223 boundary. Aligning @code{double} variables on a two word boundary will
8224 produce code that runs somewhat faster on a @samp{Pentium} at the
8225 expense of more memory.
8226
8227 @strong{Warning:} if you use the @option{-malign-double} switch,
8228 structures containing the above types will be aligned differently than
8229 the published application binary interface specifications for the 386
8230 and will not be binary compatible with structures in code compiled
8231 without that switch.
8232
8233 @item -m128bit-long-double
8234 @opindex m128bit-long-double
8235 Control the size of @code{long double} type. i386 application binary interface
8236 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
8237 prefer @code{long double} aligned to 8 or 16 byte boundary. This is
8238 impossible to reach with 12 byte long doubles in the array accesses.
8239
8240 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
8241 structures and arrays containing @code{long double} will change their size as
8242 well as function calling convention for function taking @code{long double}
8243 will be modified.
8244
8245 @item -m96bit-long-double
8246 @opindex m96bit-long-double
8247 Set the size of @code{long double} to 96 bits as required by the i386
8248 application binary interface. This is the default.
8249
8250 @item -msvr3-shlib
8251 @itemx -mno-svr3-shlib
8252 @opindex msvr3-shlib
8253 @opindex mno-svr3-shlib
8254 Control whether GCC places uninitialized local variables into the
8255 @code{bss} or @code{data} segments. @option{-msvr3-shlib} places them
8256 into @code{bss}. These options are meaningful only on System V Release 3.
8257
8258 @item -mrtd
8259 @opindex mrtd
8260 Use a different function-calling convention, in which functions that
8261 take a fixed number of arguments return with the @code{ret} @var{num}
8262 instruction, which pops their arguments while returning. This saves one
8263 instruction in the caller since there is no need to pop the arguments
8264 there.
8265
8266 You can specify that an individual function is called with this calling
8267 sequence with the function attribute @samp{stdcall}. You can also
8268 override the @option{-mrtd} option by using the function attribute
8269 @samp{cdecl}. @xref{Function Attributes}.
8270
8271 @strong{Warning:} this calling convention is incompatible with the one
8272 normally used on Unix, so you cannot use it if you need to call
8273 libraries compiled with the Unix compiler.
8274
8275 Also, you must provide function prototypes for all functions that
8276 take variable numbers of arguments (including @code{printf});
8277 otherwise incorrect code will be generated for calls to those
8278 functions.
8279
8280 In addition, seriously incorrect code will result if you call a
8281 function with too many arguments. (Normally, extra arguments are
8282 harmlessly ignored.)
8283
8284 @item -mregparm=@var{num}
8285 @opindex mregparm
8286 Control how many registers are used to pass integer arguments. By
8287 default, no registers are used to pass arguments, and at most 3
8288 registers can be used. You can control this behavior for a specific
8289 function by using the function attribute @samp{regparm}.
8290 @xref{Function Attributes}.
8291
8292 @strong{Warning:} if you use this switch, and
8293 @var{num} is nonzero, then you must build all modules with the same
8294 value, including any libraries. This includes the system libraries and
8295 startup modules.
8296
8297 @item -mpreferred-stack-boundary=@var{num}
8298 @opindex mpreferred-stack-boundary
8299 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8300 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
8301 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8302 size (@option{-Os}), in which case the default is the minimum correct
8303 alignment (4 bytes for x86, and 8 bytes for x86-64).
8304
8305 On Pentium and PentiumPro, @code{double} and @code{long double} values
8306 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8307 suffer significant run time performance penalties. On Pentium III, the
8308 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8309 penalties if it is not 16 byte aligned.
8310
8311 To ensure proper alignment of this values on the stack, the stack boundary
8312 must be as aligned as that required by any value stored on the stack.
8313 Further, every function must be generated such that it keeps the stack
8314 aligned. Thus calling a function compiled with a higher preferred
8315 stack boundary from a function compiled with a lower preferred stack
8316 boundary will most likely misalign the stack. It is recommended that
8317 libraries that use callbacks always use the default setting.
8318
8319 This extra alignment does consume extra stack space, and generally
8320 increases code size. Code that is sensitive to stack space usage, such
8321 as embedded systems and operating system kernels, may want to reduce the
8322 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8323
8324 @item -mmmx
8325 @itemx -mno-mmx
8326 @item -msse
8327 @itemx -mno-sse
8328 @item -msse2
8329 @itemx -mno-sse2
8330 @item -m3dnow
8331 @itemx -mno-3dnow
8332 @opindex mmmx
8333 @opindex mno-mmx
8334 @opindex msse
8335 @opindex mno-sse
8336 @opindex m3dnow
8337 @opindex mno-3dnow
8338 These switches enable or disable the use of built-in functions that allow
8339 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8340
8341 @xref{X86 Built-in Functions}, for details of the functions enabled
8342 and disabled by these switches.
8343
8344 To have SSE/SSE2 instructions generated automatically from floating-point
8345 code, see @option{-mfpmath=sse}.
8346
8347 @item -mpush-args
8348 @itemx -mno-push-args
8349 @opindex mpush-args
8350 @opindex mno-push-args
8351 Use PUSH operations to store outgoing parameters. This method is shorter
8352 and usually equally fast as method using SUB/MOV operations and is enabled
8353 by default. In some cases disabling it may improve performance because of
8354 improved scheduling and reduced dependencies.
8355
8356 @item -maccumulate-outgoing-args
8357 @opindex maccumulate-outgoing-args
8358 If enabled, the maximum amount of space required for outgoing arguments will be
8359 computed in the function prologue. This is faster on most modern CPUs
8360 because of reduced dependencies, improved scheduling and reduced stack usage
8361 when preferred stack boundary is not equal to 2. The drawback is a notable
8362 increase in code size. This switch implies @option{-mno-push-args}.
8363
8364 @item -mthreads
8365 @opindex mthreads
8366 Support thread-safe exception handling on @samp{Mingw32}. Code that relies
8367 on thread-safe exception handling must compile and link all code with the
8368 @option{-mthreads} option. When compiling, @option{-mthreads} defines
8369 @option{-D_MT}; when linking, it links in a special thread helper library
8370 @option{-lmingwthrd} which cleans up per thread exception handling data.
8371
8372 @item -mno-align-stringops
8373 @opindex mno-align-stringops
8374 Do not align destination of inlined string operations. This switch reduces
8375 code size and improves performance in case the destination is already aligned,
8376 but gcc don't know about it.
8377
8378 @item -minline-all-stringops
8379 @opindex minline-all-stringops
8380 By default GCC inlines string operations only when destination is known to be
8381 aligned at least to 4 byte boundary. This enables more inlining, increase code
8382 size, but may improve performance of code that depends on fast memcpy, strlen
8383 and memset for short lengths.
8384
8385 @item -momit-leaf-frame-pointer
8386 @opindex momit-leaf-frame-pointer
8387 Don't keep the frame pointer in a register for leaf functions. This
8388 avoids the instructions to save, set up and restore frame pointers and
8389 makes an extra register available in leaf functions. The option
8390 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8391 which might make debugging harder.
8392 @end table
8393
8394 These @samp{-m} switches are supported in addition to the above
8395 on AMD x86-64 processors in 64-bit environments.
8396
8397 @table @gcctabopt
8398 @item -m32
8399 @itemx -m64
8400 @opindex m32
8401 @opindex m64
8402 Generate code for a 32-bit or 64-bit environment.
8403 The 32-bit environment sets int, long and pointer to 32 bits and
8404 generates code that runs on any i386 system.
8405 The 64-bit environment sets int to 32 bits and long and pointer
8406 to 64 bits and generates code for AMD's x86-64 architecture.
8407
8408 @item -mno-red-zone
8409 @opindex no-red-zone
8410 Do not use a so called red zone for x86-64 code. The red zone is mandated
8411 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8412 stack pointer that will not be modified by signal or interrupt handlers
8413 and therefore can be used for temporary data without adjusting the stack
8414 pointer. The flag @option{-mno-red-zone} disables this red zone.
8415
8416 @item -mcmodel=small
8417 @opindex mcmodel=small
8418 Generate code for the small code model: the program and its symbols must
8419 be linked in the lower 2 GB of the address space. Pointers are 64 bits.
8420 Programs can be statically or dynamically linked. This is the default
8421 code model.
8422
8423 @item -mcmodel=kernel
8424 @opindex mcmodel=kernel
8425 Generate code for the kernel code model. The kernel runs in the
8426 negative 2 GB of the address space.
8427 This model has to be used for Linux kernel code.
8428
8429 @item -mcmodel=medium
8430 @opindex mcmodel=medium
8431 Generate code for the medium model: The program is linked in the lower 2
8432 GB of the address space but symbols can be located anywhere in the
8433 address space. Programs can be statically or dynamically linked, but
8434 building of shared libraries are not supported with the medium model.
8435
8436 @item -mcmodel=large
8437 @opindex mcmodel=large
8438 Generate code for the large model: This model makes no assumptions
8439 about addresses and sizes of sections. Currently GCC does not implement
8440 this model.
8441 @end table
8442
8443 @node HPPA Options
8444 @subsection HPPA Options
8445 @cindex HPPA Options
8446
8447 These @samp{-m} options are defined for the HPPA family of computers:
8448
8449 @table @gcctabopt
8450 @item -march=@var{architecture-type}
8451 @opindex march
8452 Generate code for the specified architecture. The choices for
8453 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8454 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
8455 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8456 architecture option for your machine. Code compiled for lower numbered
8457 architectures will run on higher numbered architectures, but not the
8458 other way around.
8459
8460 PA 2.0 support currently requires gas snapshot 19990413 or later. The
8461 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8462 support.
8463
8464 @item -mpa-risc-1-0
8465 @itemx -mpa-risc-1-1
8466 @itemx -mpa-risc-2-0
8467 @opindex mpa-risc-1-0
8468 @opindex mpa-risc-1-1
8469 @opindex mpa-risc-2-0
8470 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8471
8472 @item -mbig-switch
8473 @opindex mbig-switch
8474 Generate code suitable for big switch tables. Use this option only if
8475 the assembler/linker complain about out of range branches within a switch
8476 table.
8477
8478 @item -mjump-in-delay
8479 @opindex mjump-in-delay
8480 Fill delay slots of function calls with unconditional jump instructions
8481 by modifying the return pointer for the function call to be the target
8482 of the conditional jump.
8483
8484 @item -mdisable-fpregs
8485 @opindex mdisable-fpregs
8486 Prevent floating point registers from being used in any manner. This is
8487 necessary for compiling kernels which perform lazy context switching of
8488 floating point registers. If you use this option and attempt to perform
8489 floating point operations, the compiler will abort.
8490
8491 @item -mdisable-indexing
8492 @opindex mdisable-indexing
8493 Prevent the compiler from using indexing address modes. This avoids some
8494 rather obscure problems when compiling MIG generated code under MACH@.
8495
8496 @item -mno-space-regs
8497 @opindex mno-space-regs
8498 Generate code that assumes the target has no space registers. This allows
8499 GCC to generate faster indirect calls and use unscaled index address modes.
8500
8501 Such code is suitable for level 0 PA systems and kernels.
8502
8503 @item -mfast-indirect-calls
8504 @opindex mfast-indirect-calls
8505 Generate code that assumes calls never cross space boundaries. This
8506 allows GCC to emit code which performs faster indirect calls.
8507
8508 This option will not work in the presence of shared libraries or nested
8509 functions.
8510
8511 @item -mlong-load-store
8512 @opindex mlong-load-store
8513 Generate 3-instruction load and store sequences as sometimes required by
8514 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
8515 the HP compilers.
8516
8517 @item -mportable-runtime
8518 @opindex mportable-runtime
8519 Use the portable calling conventions proposed by HP for ELF systems.
8520
8521 @item -mgas
8522 @opindex mgas
8523 Enable the use of assembler directives only GAS understands.
8524
8525 @item -mschedule=@var{cpu-type}
8526 @opindex mschedule
8527 Schedule code according to the constraints for the machine type
8528 @var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
8529 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
8530 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8531 proper scheduling option for your machine. The default scheduling is
8532 @samp{8000}.
8533
8534 @item -mlinker-opt
8535 @opindex mlinker-opt
8536 Enable the optimization pass in the HP-UX linker. Note this makes symbolic
8537 debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
8538 linkers in which they give bogus error messages when linking some programs.
8539
8540 @item -msoft-float
8541 @opindex msoft-float
8542 Generate output containing library calls for floating point.
8543 @strong{Warning:} the requisite libraries are not available for all HPPA
8544 targets. Normally the facilities of the machine's usual C compiler are
8545 used, but this cannot be done directly in cross-compilation. You must make
8546 your own arrangements to provide suitable library functions for
8547 cross-compilation. The embedded target @samp{hppa1.1-*-pro}
8548 does provide software floating point support.
8549
8550 @option{-msoft-float} changes the calling convention in the output file;
8551 therefore, it is only useful if you compile @emph{all} of a program with
8552 this option. In particular, you need to compile @file{libgcc.a}, the
8553 library that comes with GCC, with @option{-msoft-float} in order for
8554 this to work.
8555
8556 @item -msio
8557 @opindex msio
8558 Generate the predefine, @code{_SIO}, for server IO. The default is
8559 @option{-mwsio}. This generates the predefines, @code{__hp9000s700},
8560 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO. These
8561 options are available under HP-UX and HI-UX.
8562
8563 @item -mgnu-ld
8564 @opindex gnu-ld
8565 Use GNU ld specific options. This passes @option{-shared} to ld when
8566 building a shared library. It is the default when GCC is configured,
8567 explicitly or implicitly, with the GNU linker. This option does not
8568 have any affect on which ld is called, it only changes what parameters
8569 are passed to that ld. The ld that is called is determined by the
8570 @option{--with-ld} configure option, gcc's program search path, and
8571 finally by the user's @env{PATH}. The linker used by GCC can be printed
8572 using @samp{which `gcc -print-prog-name=ld`}.
8573
8574 @item -mhp-ld
8575 @opindex hp-ld
8576 Use HP ld specific options. This passes @option{-b} to ld when building
8577 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8578 links. It is the default when GCC is configured, explicitly or
8579 implicitly, with the HP linker. This option does not have any affect on
8580 which ld is called, it only changes what parameters are passed to that
8581 ld. The ld that is called is determined by the @option{--with-ld}
8582 configure option, gcc's program search path, and finally by the user's
8583 @env{PATH}. The linker used by GCC can be printed using @samp{which
8584 `gcc -print-prog-name=ld`}.
8585
8586 @item -mlong-calls
8587 @opindex mno-long-calls
8588 Generate code that uses long call sequences. This ensures that a call
8589 is always able to reach linker generated stubs. The default is to generate
8590 long calls only when the distance from the call site to the beginning
8591 of the function or translation unit, as the case may be, exceeds a
8592 predefined limit set by the branch type being used. The limits for
8593 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8594 PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
8595 240,000 bytes.
8596
8597 Distances are measured from the beginning of functions when using the
8598 @option{-ffunction-sections} option, or when using the @option{-mgas}
8599 and @option{-mno-portable-runtime} options together under HP-UX with
8600 the SOM linker.
8601
8602 It is normally not desirable to use this option as it will degrade
8603 performance. However, it may be useful in large applications,
8604 particularly when partial linking is used to build the application.
8605
8606 The types of long calls used depends on the capabilities of the
8607 assembler and linker, and the type of code being generated. The
8608 impact on systems that support long absolute calls, and long pic
8609 symbol-difference or pc-relative calls should be relatively small.
8610 However, an indirect call is used on 32-bit ELF systems in pic code
8611 and it is quite long.
8612
8613 @end table
8614
8615 @node Intel 960 Options
8616 @subsection Intel 960 Options
8617
8618 These @samp{-m} options are defined for the Intel 960 implementations:
8619
8620 @table @gcctabopt
8621 @item -m@var{cpu-type}
8622 @opindex mka
8623 @opindex mkb
8624 @opindex mmc
8625 @opindex mca
8626 @opindex mcf
8627 @opindex msa
8628 @opindex msb
8629 Assume the defaults for the machine type @var{cpu-type} for some of
8630 the other options, including instruction scheduling, floating point
8631 support, and addressing modes. The choices for @var{cpu-type} are
8632 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8633 @samp{sa}, and @samp{sb}.
8634 The default is
8635 @samp{kb}.
8636
8637 @item -mnumerics
8638 @itemx -msoft-float
8639 @opindex mnumerics
8640 @opindex msoft-float
8641 The @option{-mnumerics} option indicates that the processor does support
8642 floating-point instructions. The @option{-msoft-float} option indicates
8643 that floating-point support should not be assumed.
8644
8645 @item -mleaf-procedures
8646 @itemx -mno-leaf-procedures
8647 @opindex mleaf-procedures
8648 @opindex mno-leaf-procedures
8649 Do (or do not) attempt to alter leaf procedures to be callable with the
8650 @code{bal} instruction as well as @code{call}. This will result in more
8651 efficient code for explicit calls when the @code{bal} instruction can be
8652 substituted by the assembler or linker, but less efficient code in other
8653 cases, such as calls via function pointers, or using a linker that doesn't
8654 support this optimization.
8655
8656 @item -mtail-call
8657 @itemx -mno-tail-call
8658 @opindex mtail-call
8659 @opindex mno-tail-call
8660 Do (or do not) make additional attempts (beyond those of the
8661 machine-independent portions of the compiler) to optimize tail-recursive
8662 calls into branches. You may not want to do this because the detection of
8663 cases where this is not valid is not totally complete. The default is
8664 @option{-mno-tail-call}.
8665
8666 @item -mcomplex-addr
8667 @itemx -mno-complex-addr
8668 @opindex mcomplex-addr
8669 @opindex mno-complex-addr
8670 Assume (or do not assume) that the use of a complex addressing mode is a
8671 win on this implementation of the i960. Complex addressing modes may not
8672 be worthwhile on the K-series, but they definitely are on the C-series.
8673 The default is currently @option{-mcomplex-addr} for all processors except
8674 the CB and CC@.
8675
8676 @item -mcode-align
8677 @itemx -mno-code-align
8678 @opindex mcode-align
8679 @opindex mno-code-align
8680 Align code to 8-byte boundaries for faster fetching (or don't bother).
8681 Currently turned on by default for C-series implementations only.
8682
8683 @ignore
8684 @item -mclean-linkage
8685 @itemx -mno-clean-linkage
8686 @opindex mclean-linkage
8687 @opindex mno-clean-linkage
8688 These options are not fully implemented.
8689 @end ignore
8690
8691 @item -mic-compat
8692 @itemx -mic2.0-compat
8693 @itemx -mic3.0-compat
8694 @opindex mic-compat
8695 @opindex mic2.0-compat
8696 @opindex mic3.0-compat
8697 Enable compatibility with iC960 v2.0 or v3.0.
8698
8699 @item -masm-compat
8700 @itemx -mintel-asm
8701 @opindex masm-compat
8702 @opindex mintel-asm
8703 Enable compatibility with the iC960 assembler.
8704
8705 @item -mstrict-align
8706 @itemx -mno-strict-align
8707 @opindex mstrict-align
8708 @opindex mno-strict-align
8709 Do not permit (do permit) unaligned accesses.
8710
8711 @item -mold-align
8712 @opindex mold-align
8713 Enable structure-alignment compatibility with Intel's gcc release version
8714 1.3 (based on gcc 1.37). This option implies @option{-mstrict-align}.
8715
8716 @item -mlong-double-64
8717 @opindex mlong-double-64
8718 Implement type @samp{long double} as 64-bit floating point numbers.
8719 Without the option @samp{long double} is implemented by 80-bit
8720 floating point numbers. The only reason we have it because there is
8721 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet. So it
8722 is only useful for people using soft-float targets. Otherwise, we
8723 should recommend against use of it.
8724
8725 @end table
8726
8727 @node DEC Alpha Options
8728 @subsection DEC Alpha Options
8729
8730 These @samp{-m} options are defined for the DEC Alpha implementations:
8731
8732 @table @gcctabopt
8733 @item -mno-soft-float
8734 @itemx -msoft-float
8735 @opindex mno-soft-float
8736 @opindex msoft-float
8737 Use (do not use) the hardware floating-point instructions for
8738 floating-point operations. When @option{-msoft-float} is specified,
8739 functions in @file{libgcc.a} will be used to perform floating-point
8740 operations. Unless they are replaced by routines that emulate the
8741 floating-point operations, or compiled in such a way as to call such
8742 emulations routines, these routines will issue floating-point
8743 operations. If you are compiling for an Alpha without floating-point
8744 operations, you must ensure that the library is built so as not to call
8745 them.
8746
8747 Note that Alpha implementations without floating-point operations are
8748 required to have floating-point registers.
8749
8750 @item -mfp-reg
8751 @itemx -mno-fp-regs
8752 @opindex mfp-reg
8753 @opindex mno-fp-regs
8754 Generate code that uses (does not use) the floating-point register set.
8755 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
8756 register set is not used, floating point operands are passed in integer
8757 registers as if they were integers and floating-point results are passed
8758 in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
8759 so any function with a floating-point argument or return value called by code
8760 compiled with @option{-mno-fp-regs} must also be compiled with that
8761 option.
8762
8763 A typical use of this option is building a kernel that does not use,
8764 and hence need not save and restore, any floating-point registers.
8765
8766 @item -mieee
8767 @opindex mieee
8768 The Alpha architecture implements floating-point hardware optimized for
8769 maximum performance. It is mostly compliant with the IEEE floating
8770 point standard. However, for full compliance, software assistance is
8771 required. This option generates code fully IEEE compliant code
8772 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8773 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8774 defined during compilation. The resulting code is less efficient but is
8775 able to correctly support denormalized numbers and exceptional IEEE
8776 values such as not-a-number and plus/minus infinity. Other Alpha
8777 compilers call this option @option{-ieee_with_no_inexact}.
8778
8779 @item -mieee-with-inexact
8780 @opindex mieee-with-inexact
8781 This is like @option{-mieee} except the generated code also maintains
8782 the IEEE @var{inexact-flag}. Turning on this option causes the
8783 generated code to implement fully-compliant IEEE math. In addition to
8784 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8785 macro. On some Alpha implementations the resulting code may execute
8786 significantly slower than the code generated by default. Since there is
8787 very little code that depends on the @var{inexact-flag}, you should
8788 normally not specify this option. Other Alpha compilers call this
8789 option @option{-ieee_with_inexact}.
8790
8791 @item -mfp-trap-mode=@var{trap-mode}
8792 @opindex mfp-trap-mode
8793 This option controls what floating-point related traps are enabled.
8794 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8795 The trap mode can be set to one of four values:
8796
8797 @table @samp
8798 @item n
8799 This is the default (normal) setting. The only traps that are enabled
8800 are the ones that cannot be disabled in software (e.g., division by zero
8801 trap).
8802
8803 @item u
8804 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8805 as well.
8806
8807 @item su
8808 Like @samp{su}, but the instructions are marked to be safe for software
8809 completion (see Alpha architecture manual for details).
8810
8811 @item sui
8812 Like @samp{su}, but inexact traps are enabled as well.
8813 @end table
8814
8815 @item -mfp-rounding-mode=@var{rounding-mode}
8816 @opindex mfp-rounding-mode
8817 Selects the IEEE rounding mode. Other Alpha compilers call this option
8818 @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
8819 of:
8820
8821 @table @samp
8822 @item n
8823 Normal IEEE rounding mode. Floating point numbers are rounded towards
8824 the nearest machine number or towards the even machine number in case
8825 of a tie.
8826
8827 @item m
8828 Round towards minus infinity.
8829
8830 @item c
8831 Chopped rounding mode. Floating point numbers are rounded towards zero.
8832
8833 @item d
8834 Dynamic rounding mode. A field in the floating point control register
8835 (@var{fpcr}, see Alpha architecture reference manual) controls the
8836 rounding mode in effect. The C library initializes this register for
8837 rounding towards plus infinity. Thus, unless your program modifies the
8838 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8839 @end table
8840
8841 @item -mtrap-precision=@var{trap-precision}
8842 @opindex mtrap-precision
8843 In the Alpha architecture, floating point traps are imprecise. This
8844 means without software assistance it is impossible to recover from a
8845 floating trap and program execution normally needs to be terminated.
8846 GCC can generate code that can assist operating system trap handlers
8847 in determining the exact location that caused a floating point trap.
8848 Depending on the requirements of an application, different levels of
8849 precisions can be selected:
8850
8851 @table @samp
8852 @item p
8853 Program precision. This option is the default and means a trap handler
8854 can only identify which program caused a floating point exception.
8855
8856 @item f
8857 Function precision. The trap handler can determine the function that
8858 caused a floating point exception.
8859
8860 @item i
8861 Instruction precision. The trap handler can determine the exact
8862 instruction that caused a floating point exception.
8863 @end table
8864
8865 Other Alpha compilers provide the equivalent options called
8866 @option{-scope_safe} and @option{-resumption_safe}.
8867
8868 @item -mieee-conformant
8869 @opindex mieee-conformant
8870 This option marks the generated code as IEEE conformant. You must not
8871 use this option unless you also specify @option{-mtrap-precision=i} and either
8872 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
8873 is to emit the line @samp{.eflag 48} in the function prologue of the
8874 generated assembly file. Under DEC Unix, this has the effect that
8875 IEEE-conformant math library routines will be linked in.
8876
8877 @item -mbuild-constants
8878 @opindex mbuild-constants
8879 Normally GCC examines a 32- or 64-bit integer constant to
8880 see if it can construct it from smaller constants in two or three
8881 instructions. If it cannot, it will output the constant as a literal and
8882 generate code to load it from the data segment at runtime.
8883
8884 Use this option to require GCC to construct @emph{all} integer constants
8885 using code, even if it takes more instructions (the maximum is six).
8886
8887 You would typically use this option to build a shared library dynamic
8888 loader. Itself a shared library, it must relocate itself in memory
8889 before it can find the variables and constants in its own data segment.
8890
8891 @item -malpha-as
8892 @itemx -mgas
8893 @opindex malpha-as
8894 @opindex mgas
8895 Select whether to generate code to be assembled by the vendor-supplied
8896 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8897
8898 @item -mbwx
8899 @itemx -mno-bwx
8900 @itemx -mcix
8901 @itemx -mno-cix
8902 @itemx -mfix
8903 @itemx -mno-fix
8904 @itemx -mmax
8905 @itemx -mno-max
8906 @opindex mbwx
8907 @opindex mno-bwx
8908 @opindex mcix
8909 @opindex mno-cix
8910 @opindex mfix
8911 @opindex mno-fix
8912 @opindex mmax
8913 @opindex mno-max
8914 Indicate whether GCC should generate code to use the optional BWX,
8915 CIX, FIX and MAX instruction sets. The default is to use the instruction
8916 sets supported by the CPU type specified via @option{-mcpu=} option or that
8917 of the CPU on which GCC was built if none was specified.
8918
8919 @item -mfloat-vax
8920 @itemx -mfloat-ieee
8921 @opindex mfloat-vax
8922 @opindex mfloat-ieee
8923 Generate code that uses (does not use) VAX F and G floating point
8924 arithmetic instead of IEEE single and double precision.
8925
8926 @item -mexplicit-relocs
8927 @itemx -mno-explicit-relocs
8928 @opindex mexplicit-relocs
8929 @opindex mno-explicit-relocs
8930 Older Alpha assemblers provided no way to generate symbol relocations
8931 except via assembler macros. Use of these macros does not allow
8932 optimal instruction scheduling. GNU binutils as of version 2.12
8933 supports a new syntax that allows the compiler to explicitly mark
8934 which relocations should apply to which instructions. This option
8935 is mostly useful for debugging, as GCC detects the capabilities of
8936 the assembler when it is built and sets the default accordingly.
8937
8938 @item -msmall-data
8939 @itemx -mlarge-data
8940 @opindex msmall-data
8941 @opindex mlarge-data
8942 When @option{-mexplicit-relocs} is in effect, static data is
8943 accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
8944 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8945 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8946 16-bit relocations off of the @code{$gp} register. This limits the
8947 size of the small data area to 64KB, but allows the variables to be
8948 directly accessed via a single instruction.
8949
8950 The default is @option{-mlarge-data}. With this option the data area
8951 is limited to just below 2GB. Programs that require more than 2GB of
8952 data must use @code{malloc} or @code{mmap} to allocate the data in the
8953 heap instead of in the program's data segment.
8954
8955 When generating code for shared libraries, @option{-fpic} implies
8956 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8957
8958 @item -msmall-text
8959 @itemx -mlarge-text
8960 @opindex msmall-text
8961 @opindex mlarge-text
8962 When @option{-msmall-text} is used, the compiler assumes that the
8963 code of the entire program (or shared library) fits in 4MB, and is
8964 thus reachable with a branch instruction. When @option{-msmall-data}
8965 is used, the compiler can assume that all local symbols share the
8966 same @code{$gp} value, and thus reduce the number of instructions
8967 required for a function call from 4 to 1.
8968
8969 The default is @option{-mlarge-text}.
8970
8971 @item -mcpu=@var{cpu_type}
8972 @opindex mcpu
8973 Set the instruction set and instruction scheduling parameters for
8974 machine type @var{cpu_type}. You can specify either the @samp{EV}
8975 style name or the corresponding chip number. GCC supports scheduling
8976 parameters for the EV4, EV5 and EV6 family of processors and will
8977 choose the default values for the instruction set from the processor
8978 you specify. If you do not specify a processor type, GCC will default
8979 to the processor on which the compiler was built.
8980
8981 Supported values for @var{cpu_type} are
8982
8983 @table @samp
8984 @item ev4
8985 @item ev45
8986 @itemx 21064
8987 Schedules as an EV4 and has no instruction set extensions.
8988
8989 @item ev5
8990 @itemx 21164
8991 Schedules as an EV5 and has no instruction set extensions.
8992
8993 @item ev56
8994 @itemx 21164a
8995 Schedules as an EV5 and supports the BWX extension.
8996
8997 @item pca56
8998 @itemx 21164pc
8999 @itemx 21164PC
9000 Schedules as an EV5 and supports the BWX and MAX extensions.
9001
9002 @item ev6
9003 @itemx 21264
9004 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9005
9006 @item ev67
9007 @item 21264a
9008 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9009 @end table
9010
9011 @item -mtune=@var{cpu_type}
9012 @opindex mtune
9013 Set only the instruction scheduling parameters for machine type
9014 @var{cpu_type}. The instruction set is not changed.
9015
9016 @item -mmemory-latency=@var{time}
9017 @opindex mmemory-latency
9018 Sets the latency the scheduler should assume for typical memory
9019 references as seen by the application. This number is highly
9020 dependent on the memory access patterns used by the application
9021 and the size of the external cache on the machine.
9022
9023 Valid options for @var{time} are
9024
9025 @table @samp
9026 @item @var{number}
9027 A decimal number representing clock cycles.
9028
9029 @item L1
9030 @itemx L2
9031 @itemx L3
9032 @itemx main
9033 The compiler contains estimates of the number of clock cycles for
9034 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9035 (also called Dcache, Scache, and Bcache), as well as to main memory.
9036 Note that L3 is only valid for EV5.
9037
9038 @end table
9039 @end table
9040
9041 @node DEC Alpha/VMS Options
9042 @subsection DEC Alpha/VMS Options
9043
9044 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9045
9046 @table @gcctabopt
9047 @item -mvms-return-codes
9048 @opindex mvms-return-codes
9049 Return VMS condition codes from main. The default is to return POSIX
9050 style condition (e.g.@ error) codes.
9051 @end table
9052
9053 @node H8/300 Options
9054 @subsection H8/300 Options
9055
9056 These @samp{-m} options are defined for the H8/300 implementations:
9057
9058 @table @gcctabopt
9059 @item -mrelax
9060 @opindex mrelax
9061 Shorten some address references at link time, when possible; uses the
9062 linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
9063 ld.info, Using ld}, for a fuller description.
9064
9065 @item -mh
9066 @opindex mh
9067 Generate code for the H8/300H@.
9068
9069 @item -ms
9070 @opindex ms
9071 Generate code for the H8S@.
9072
9073 @item -mn
9074 @opindex mn
9075 Generate code for the H8S and H8/300H in the normal mode. This switch
9076 must be used either with -mh or -ms.
9077
9078 @item -ms2600
9079 @opindex ms2600
9080 Generate code for the H8S/2600. This switch must be used with @option{-ms}.
9081
9082 @item -mint32
9083 @opindex mint32
9084 Make @code{int} data 32 bits by default.
9085
9086 @item -malign-300
9087 @opindex malign-300
9088 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9089 The default for the H8/300H and H8S is to align longs and floats on 4
9090 byte boundaries.
9091 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9092 This option has no effect on the H8/300.
9093 @end table
9094
9095 @node SH Options
9096 @subsection SH Options
9097
9098 These @samp{-m} options are defined for the SH implementations:
9099
9100 @table @gcctabopt
9101 @item -m1
9102 @opindex m1
9103 Generate code for the SH1.
9104
9105 @item -m2
9106 @opindex m2
9107 Generate code for the SH2.
9108
9109 @item -m2e
9110 Generate code for the SH2e.
9111
9112 @item -m3
9113 @opindex m3
9114 Generate code for the SH3.
9115
9116 @item -m3e
9117 @opindex m3e
9118 Generate code for the SH3e.
9119
9120 @item -m4-nofpu
9121 @opindex m4-nofpu
9122 Generate code for the SH4 without a floating-point unit.
9123
9124 @item -m4-single-only
9125 @opindex m4-single-only
9126 Generate code for the SH4 with a floating-point unit that only
9127 supports single-precision arithmetic.
9128
9129 @item -m4-single
9130 @opindex m4-single
9131 Generate code for the SH4 assuming the floating-point unit is in
9132 single-precision mode by default.
9133
9134 @item -m4
9135 @opindex m4
9136 Generate code for the SH4.
9137
9138 @item -mb
9139 @opindex mb
9140 Compile code for the processor in big endian mode.
9141
9142 @item -ml
9143 @opindex ml
9144 Compile code for the processor in little endian mode.
9145
9146 @item -mdalign
9147 @opindex mdalign
9148 Align doubles at 64-bit boundaries. Note that this changes the calling
9149 conventions, and thus some functions from the standard C library will
9150 not work unless you recompile it first with @option{-mdalign}.
9151
9152 @item -mrelax
9153 @opindex mrelax
9154 Shorten some address references at link time, when possible; uses the
9155 linker option @option{-relax}.
9156
9157 @item -mbigtable
9158 @opindex mbigtable
9159 Use 32-bit offsets in @code{switch} tables. The default is to use
9160 16-bit offsets.
9161
9162 @item -mfmovd
9163 @opindex mfmovd
9164 Enable the use of the instruction @code{fmovd}.
9165
9166 @item -mhitachi
9167 @opindex mhitachi
9168 Comply with the calling conventions defined by Hitachi.
9169
9170 @item -mnomacsave
9171 @opindex mnomacsave
9172 Mark the @code{MAC} register as call-clobbered, even if
9173 @option{-mhitachi} is given.
9174
9175 @item -mieee
9176 @opindex mieee
9177 Increase IEEE-compliance of floating-point code.
9178
9179 @item -misize
9180 @opindex misize
9181 Dump instruction size and location in the assembly code.
9182
9183 @item -mpadstruct
9184 @opindex mpadstruct
9185 This option is deprecated. It pads structures to multiple of 4 bytes,
9186 which is incompatible with the SH ABI@.
9187
9188 @item -mspace
9189 @opindex mspace
9190 Optimize for space instead of speed. Implied by @option{-Os}.
9191
9192 @item -mprefergot
9193 @opindex mprefergot
9194 When generating position-independent code, emit function calls using
9195 the Global Offset Table instead of the Procedure Linkage Table.
9196
9197 @item -musermode
9198 @opindex musermode
9199 Generate a library function call to invalidate instruction cache
9200 entries, after fixing up a trampoline. This library function call
9201 doesn't assume it can write to the whole memory address space. This
9202 is the default when the target is @code{sh-*-linux*}.
9203 @end table
9204
9205 @node System V Options
9206 @subsection Options for System V
9207
9208 These additional options are available on System V Release 4 for
9209 compatibility with other compilers on those systems:
9210
9211 @table @gcctabopt
9212 @item -G
9213 @opindex G
9214 Create a shared object.
9215 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9216
9217 @item -Qy
9218 @opindex Qy
9219 Identify the versions of each tool used by the compiler, in a
9220 @code{.ident} assembler directive in the output.
9221
9222 @item -Qn
9223 @opindex Qn
9224 Refrain from adding @code{.ident} directives to the output file (this is
9225 the default).
9226
9227 @item -YP,@var{dirs}
9228 @opindex YP
9229 Search the directories @var{dirs}, and no others, for libraries
9230 specified with @option{-l}.
9231
9232 @item -Ym,@var{dir}
9233 @opindex Ym
9234 Look in the directory @var{dir} to find the M4 preprocessor.
9235 The assembler uses this option.
9236 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9237 @c the generic assembler that comes with Solaris takes just -Ym.
9238 @end table
9239
9240 @node TMS320C3x/C4x Options
9241 @subsection TMS320C3x/C4x Options
9242 @cindex TMS320C3x/C4x Options
9243
9244 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9245
9246 @table @gcctabopt
9247
9248 @item -mcpu=@var{cpu_type}
9249 @opindex mcpu
9250 Set the instruction set, register set, and instruction scheduling
9251 parameters for machine type @var{cpu_type}. Supported values for
9252 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9253 @samp{c44}. The default is @samp{c40} to generate code for the
9254 TMS320C40.
9255
9256 @item -mbig-memory
9257 @item -mbig
9258 @itemx -msmall-memory
9259 @itemx -msmall
9260 @opindex mbig-memory
9261 @opindex mbig
9262 @opindex msmall-memory
9263 @opindex msmall
9264 Generates code for the big or small memory model. The small memory
9265 model assumed that all data fits into one 64K word page. At run-time
9266 the data page (DP) register must be set to point to the 64K page
9267 containing the .bss and .data program sections. The big memory model is
9268 the default and requires reloading of the DP register for every direct
9269 memory access.
9270
9271 @item -mbk
9272 @itemx -mno-bk
9273 @opindex mbk
9274 @opindex mno-bk
9275 Allow (disallow) allocation of general integer operands into the block
9276 count register BK@.
9277
9278 @item -mdb
9279 @itemx -mno-db
9280 @opindex mdb
9281 @opindex mno-db
9282 Enable (disable) generation of code using decrement and branch,
9283 DBcond(D), instructions. This is enabled by default for the C4x. To be
9284 on the safe side, this is disabled for the C3x, since the maximum
9285 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9286 @math{2^{23}} times on the C3x?). Note that GCC will try to reverse a loop so
9287 that it can utilize the decrement and branch instruction, but will give
9288 up if there is more than one memory reference in the loop. Thus a loop
9289 where the loop counter is decremented can generate slightly more
9290 efficient code, in cases where the RPTB instruction cannot be utilized.
9291
9292 @item -mdp-isr-reload
9293 @itemx -mparanoid
9294 @opindex mdp-isr-reload
9295 @opindex mparanoid
9296 Force the DP register to be saved on entry to an interrupt service
9297 routine (ISR), reloaded to point to the data section, and restored on
9298 exit from the ISR@. This should not be required unless someone has
9299 violated the small memory model by modifying the DP register, say within
9300 an object library.
9301
9302 @item -mmpyi
9303 @itemx -mno-mpyi
9304 @opindex mmpyi
9305 @opindex mno-mpyi
9306 For the C3x use the 24-bit MPYI instruction for integer multiplies
9307 instead of a library call to guarantee 32-bit results. Note that if one
9308 of the operands is a constant, then the multiplication will be performed
9309 using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
9310 then squaring operations are performed inline instead of a library call.
9311
9312 @item -mfast-fix
9313 @itemx -mno-fast-fix
9314 @opindex mfast-fix
9315 @opindex mno-fast-fix
9316 The C3x/C4x FIX instruction to convert a floating point value to an
9317 integer value chooses the nearest integer less than or equal to the
9318 floating point value rather than to the nearest integer. Thus if the
9319 floating point number is negative, the result will be incorrectly
9320 truncated an additional code is necessary to detect and correct this
9321 case. This option can be used to disable generation of the additional
9322 code required to correct the result.
9323
9324 @item -mrptb
9325 @itemx -mno-rptb
9326 @opindex mrptb
9327 @opindex mno-rptb
9328 Enable (disable) generation of repeat block sequences using the RPTB
9329 instruction for zero overhead looping. The RPTB construct is only used
9330 for innermost loops that do not call functions or jump across the loop
9331 boundaries. There is no advantage having nested RPTB loops due to the
9332 overhead required to save and restore the RC, RS, and RE registers.
9333 This is enabled by default with @option{-O2}.
9334
9335 @item -mrpts=@var{count}
9336 @itemx -mno-rpts
9337 @opindex mrpts
9338 @opindex mno-rpts
9339 Enable (disable) the use of the single instruction repeat instruction
9340 RPTS@. If a repeat block contains a single instruction, and the loop
9341 count can be guaranteed to be less than the value @var{count}, GCC will
9342 emit a RPTS instruction instead of a RPTB@. If no value is specified,
9343 then a RPTS will be emitted even if the loop count cannot be determined
9344 at compile time. Note that the repeated instruction following RPTS does
9345 not have to be reloaded from memory each iteration, thus freeing up the
9346 CPU buses for operands. However, since interrupts are blocked by this
9347 instruction, it is disabled by default.
9348
9349 @item -mloop-unsigned
9350 @itemx -mno-loop-unsigned
9351 @opindex mloop-unsigned
9352 @opindex mno-loop-unsigned
9353 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9354 is @math{2^{31} + 1} since these instructions test if the iteration count is
9355 negative to terminate the loop. If the iteration count is unsigned
9356 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9357 exceeded. This switch allows an unsigned iteration count.
9358
9359 @item -mti
9360 @opindex mti
9361 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9362 with. This also enforces compatibility with the API employed by the TI
9363 C3x C compiler. For example, long doubles are passed as structures
9364 rather than in floating point registers.
9365
9366 @item -mregparm
9367 @itemx -mmemparm
9368 @opindex mregparm
9369 @opindex mmemparm
9370 Generate code that uses registers (stack) for passing arguments to functions.
9371 By default, arguments are passed in registers where possible rather
9372 than by pushing arguments on to the stack.
9373
9374 @item -mparallel-insns
9375 @itemx -mno-parallel-insns
9376 @opindex mparallel-insns
9377 @opindex mno-parallel-insns
9378 Allow the generation of parallel instructions. This is enabled by
9379 default with @option{-O2}.
9380
9381 @item -mparallel-mpy
9382 @itemx -mno-parallel-mpy
9383 @opindex mparallel-mpy
9384 @opindex mno-parallel-mpy
9385 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9386 provided @option{-mparallel-insns} is also specified. These instructions have
9387 tight register constraints which can pessimize the code generation
9388 of large functions.
9389
9390 @end table
9391
9392 @node V850 Options
9393 @subsection V850 Options
9394 @cindex V850 Options
9395
9396 These @samp{-m} options are defined for V850 implementations:
9397
9398 @table @gcctabopt
9399 @item -mlong-calls
9400 @itemx -mno-long-calls
9401 @opindex mlong-calls
9402 @opindex mno-long-calls
9403 Treat all calls as being far away (near). If calls are assumed to be
9404 far away, the compiler will always load the functions address up into a
9405 register, and call indirect through the pointer.
9406
9407 @item -mno-ep
9408 @itemx -mep
9409 @opindex mno-ep
9410 @opindex mep
9411 Do not optimize (do optimize) basic blocks that use the same index
9412 pointer 4 or more times to copy pointer into the @code{ep} register, and
9413 use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
9414 option is on by default if you optimize.
9415
9416 @item -mno-prolog-function
9417 @itemx -mprolog-function
9418 @opindex mno-prolog-function
9419 @opindex mprolog-function
9420 Do not use (do use) external functions to save and restore registers at
9421 the prolog and epilog of a function. The external functions are slower,
9422 but use less code space if more than one function saves the same number
9423 of registers. The @option{-mprolog-function} option is on by default if
9424 you optimize.
9425
9426 @item -mspace
9427 @opindex mspace
9428 Try to make the code as small as possible. At present, this just turns
9429 on the @option{-mep} and @option{-mprolog-function} options.
9430
9431 @item -mtda=@var{n}
9432 @opindex mtda
9433 Put static or global variables whose size is @var{n} bytes or less into
9434 the tiny data area that register @code{ep} points to. The tiny data
9435 area can hold up to 256 bytes in total (128 bytes for byte references).
9436
9437 @item -msda=@var{n}
9438 @opindex msda
9439 Put static or global variables whose size is @var{n} bytes or less into
9440 the small data area that register @code{gp} points to. The small data
9441 area can hold up to 64 kilobytes.
9442
9443 @item -mzda=@var{n}
9444 @opindex mzda
9445 Put static or global variables whose size is @var{n} bytes or less into
9446 the first 32 kilobytes of memory.
9447
9448 @item -mv850
9449 @opindex mv850
9450 Specify that the target processor is the V850.
9451
9452 @item -mbig-switch
9453 @opindex mbig-switch
9454 Generate code suitable for big switch tables. Use this option only if
9455 the assembler/linker complain about out of range branches within a switch
9456 table.
9457
9458 @item -mapp-regs
9459 @opindex -mapp-regs
9460 This option will cause r2 and r5 to be used in the code generated by
9461 the compiler. This setting is the default.
9462
9463 @item -mno-app-regs
9464 @opindex -mno-app-regs
9465 This option will cause r2 and r5 to be treated as fixed registers.
9466
9467 @item -mv850e
9468 @opindex -mv850e
9469 Specify that the target processor is the V850E. The preprocessor
9470 constant @samp{__v850e__} will be defined if this option is used.
9471
9472 If neither @option{-mv850} nor @option{-mv850e} are defined
9473 then a default target processor will be chosen and the relevant
9474 @samp{__v850*__} preprocessor constant will be defined.
9475
9476 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9477 defined, regardless of which processor variant is the target.
9478
9479 @item -mdisable-callt
9480 @opindex -mdisable-callt
9481 This option will suppress generation of the CALLT instruction for the
9482 v850e flavors of the v850 architecture. The default is
9483 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9484
9485 @end table
9486
9487 @node ARC Options
9488 @subsection ARC Options
9489 @cindex ARC Options
9490
9491 These options are defined for ARC implementations:
9492
9493 @table @gcctabopt
9494 @item -EL
9495 @opindex EL
9496 Compile code for little endian mode. This is the default.
9497
9498 @item -EB
9499 @opindex EB
9500 Compile code for big endian mode.
9501
9502 @item -mmangle-cpu
9503 @opindex mmangle-cpu
9504 Prepend the name of the cpu to all public symbol names.
9505 In multiple-processor systems, there are many ARC variants with different
9506 instruction and register set characteristics. This flag prevents code
9507 compiled for one cpu to be linked with code compiled for another.
9508 No facility exists for handling variants that are ``almost identical''.
9509 This is an all or nothing option.
9510
9511 @item -mcpu=@var{cpu}
9512 @opindex mcpu
9513 Compile code for ARC variant @var{cpu}.
9514 Which variants are supported depend on the configuration.
9515 All variants support @option{-mcpu=base}, this is the default.
9516
9517 @item -mtext=@var{text-section}
9518 @itemx -mdata=@var{data-section}
9519 @itemx -mrodata=@var{readonly-data-section}
9520 @opindex mtext
9521 @opindex mdata
9522 @opindex mrodata
9523 Put functions, data, and readonly data in @var{text-section},
9524 @var{data-section}, and @var{readonly-data-section} respectively
9525 by default. This can be overridden with the @code{section} attribute.
9526 @xref{Variable Attributes}.
9527
9528 @end table
9529
9530 @node NS32K Options
9531 @subsection NS32K Options
9532 @cindex NS32K options
9533
9534 These are the @samp{-m} options defined for the 32000 series. The default
9535 values for these options depends on which style of 32000 was selected when
9536 the compiler was configured; the defaults for the most common choices are
9537 given below.
9538
9539 @table @gcctabopt
9540 @item -m32032
9541 @itemx -m32032
9542 @opindex m32032
9543 @opindex m32032
9544 Generate output for a 32032. This is the default
9545 when the compiler is configured for 32032 and 32016 based systems.
9546
9547 @item -m32332
9548 @itemx -m32332
9549 @opindex m32332
9550 @opindex m32332
9551 Generate output for a 32332. This is the default
9552 when the compiler is configured for 32332-based systems.
9553
9554 @item -m32532
9555 @itemx -m32532
9556 @opindex m32532
9557 @opindex m32532
9558 Generate output for a 32532. This is the default
9559 when the compiler is configured for 32532-based systems.
9560
9561 @item -m32081
9562 @opindex m32081
9563 Generate output containing 32081 instructions for floating point.
9564 This is the default for all systems.
9565
9566 @item -m32381
9567 @opindex m32381
9568 Generate output containing 32381 instructions for floating point. This
9569 also implies @option{-m32081}. The 32381 is only compatible with the 32332
9570 and 32532 cpus. This is the default for the pc532-netbsd configuration.
9571
9572 @item -mmulti-add
9573 @opindex mmulti-add
9574 Try and generate multiply-add floating point instructions @code{polyF}
9575 and @code{dotF}. This option is only available if the @option{-m32381}
9576 option is in effect. Using these instructions requires changes to
9577 register allocation which generally has a negative impact on
9578 performance. This option should only be enabled when compiling code
9579 particularly likely to make heavy use of multiply-add instructions.
9580
9581 @item -mnomulti-add
9582 @opindex mnomulti-add
9583 Do not try and generate multiply-add floating point instructions
9584 @code{polyF} and @code{dotF}. This is the default on all platforms.
9585
9586 @item -msoft-float
9587 @opindex msoft-float
9588 Generate output containing library calls for floating point.
9589 @strong{Warning:} the requisite libraries may not be available.
9590
9591 @item -mieee-compare
9592 @itemx -mno-ieee-compare
9593 @opindex mieee-compare
9594 @opindex mno-ieee-compare
9595 Control whether or not the compiler uses IEEE floating point
9596 comparisons. These handle correctly the case where the result of a
9597 comparison is unordered.
9598 @strong{Warning:} the requisite kernel support may not be available.
9599
9600 @item -mnobitfield
9601 @opindex mnobitfield
9602 Do not use the bit-field instructions. On some machines it is faster to
9603 use shifting and masking operations. This is the default for the pc532.
9604
9605 @item -mbitfield
9606 @opindex mbitfield
9607 Do use the bit-field instructions. This is the default for all platforms
9608 except the pc532.
9609
9610 @item -mrtd
9611 @opindex mrtd
9612 Use a different function-calling convention, in which functions
9613 that take a fixed number of arguments return pop their
9614 arguments on return with the @code{ret} instruction.
9615
9616 This calling convention is incompatible with the one normally
9617 used on Unix, so you cannot use it if you need to call libraries
9618 compiled with the Unix compiler.
9619
9620 Also, you must provide function prototypes for all functions that
9621 take variable numbers of arguments (including @code{printf});
9622 otherwise incorrect code will be generated for calls to those
9623 functions.
9624
9625 In addition, seriously incorrect code will result if you call a
9626 function with too many arguments. (Normally, extra arguments are
9627 harmlessly ignored.)
9628
9629 This option takes its name from the 680x0 @code{rtd} instruction.
9630
9631
9632 @item -mregparam
9633 @opindex mregparam
9634 Use a different function-calling convention where the first two arguments
9635 are passed in registers.
9636
9637 This calling convention is incompatible with the one normally
9638 used on Unix, so you cannot use it if you need to call libraries
9639 compiled with the Unix compiler.
9640
9641 @item -mnoregparam
9642 @opindex mnoregparam
9643 Do not pass any arguments in registers. This is the default for all
9644 targets.
9645
9646 @item -msb
9647 @opindex msb
9648 It is OK to use the sb as an index register which is always loaded with
9649 zero. This is the default for the pc532-netbsd target.
9650
9651 @item -mnosb
9652 @opindex mnosb
9653 The sb register is not available for use or has not been initialized to
9654 zero by the run time system. This is the default for all targets except
9655 the pc532-netbsd. It is also implied whenever @option{-mhimem} or
9656 @option{-fpic} is set.
9657
9658 @item -mhimem
9659 @opindex mhimem
9660 Many ns32000 series addressing modes use displacements of up to 512MB@.
9661 If an address is above 512MB then displacements from zero can not be used.
9662 This option causes code to be generated which can be loaded above 512MB@.
9663 This may be useful for operating systems or ROM code.
9664
9665 @item -mnohimem
9666 @opindex mnohimem
9667 Assume code will be loaded in the first 512MB of virtual address space.
9668 This is the default for all platforms.
9669
9670
9671 @end table
9672
9673 @node AVR Options
9674 @subsection AVR Options
9675 @cindex AVR Options
9676
9677 These options are defined for AVR implementations:
9678
9679 @table @gcctabopt
9680 @item -mmcu=@var{mcu}
9681 @opindex mmcu
9682 Specify ATMEL AVR instruction set or MCU type.
9683
9684 Instruction set avr1 is for the minimal AVR core, not supported by the C
9685 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9686 attiny11, attiny12, attiny15, attiny28).
9687
9688 Instruction set avr2 (default) is for the classic AVR core with up to
9689 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9690 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9691 at90c8534, at90s8535).
9692
9693 Instruction set avr3 is for the classic AVR core with up to 128K program
9694 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9695
9696 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9697 memory space (MCU types: atmega8, atmega83, atmega85).
9698
9699 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9700 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9701 atmega64, atmega128, at43usb355, at94k).
9702
9703 @item -msize
9704 @opindex msize
9705 Output instruction sizes to the asm file.
9706
9707 @item -minit-stack=@var{N}
9708 @opindex minit-stack
9709 Specify the initial stack address, which may be a symbol or numeric value,
9710 @samp{__stack} is the default.
9711
9712 @item -mno-interrupts
9713 @opindex mno-interrupts
9714 Generated code is not compatible with hardware interrupts.
9715 Code size will be smaller.
9716
9717 @item -mcall-prologues
9718 @opindex mcall-prologues
9719 Functions prologues/epilogues expanded as call to appropriate
9720 subroutines. Code size will be smaller.
9721
9722 @item -mno-tablejump
9723 @opindex mno-tablejump
9724 Do not generate tablejump insns which sometimes increase code size.
9725
9726 @item -mtiny-stack
9727 @opindex mtiny-stack
9728 Change only the low 8 bits of the stack pointer.
9729 @end table
9730
9731 @node MCore Options
9732 @subsection MCore Options
9733 @cindex MCore options
9734
9735 These are the @samp{-m} options defined for the Motorola M*Core
9736 processors.
9737
9738 @table @gcctabopt
9739
9740 @item -mhardlit
9741 @itemx -mhardlit
9742 @itemx -mno-hardlit
9743 @opindex mhardlit
9744 @opindex mhardlit
9745 @opindex mno-hardlit
9746 Inline constants into the code stream if it can be done in two
9747 instructions or less.
9748
9749 @item -mdiv
9750 @itemx -mdiv
9751 @itemx -mno-div
9752 @opindex mdiv
9753 @opindex mdiv
9754 @opindex mno-div
9755 Use the divide instruction. (Enabled by default).
9756
9757 @item -mrelax-immediate
9758 @itemx -mrelax-immediate
9759 @itemx -mno-relax-immediate
9760 @opindex mrelax-immediate
9761 @opindex mrelax-immediate
9762 @opindex mno-relax-immediate
9763 Allow arbitrary sized immediates in bit operations.
9764
9765 @item -mwide-bitfields
9766 @itemx -mwide-bitfields
9767 @itemx -mno-wide-bitfields
9768 @opindex mwide-bitfields
9769 @opindex mwide-bitfields
9770 @opindex mno-wide-bitfields
9771 Always treat bit-fields as int-sized.
9772
9773 @item -m4byte-functions
9774 @itemx -m4byte-functions
9775 @itemx -mno-4byte-functions
9776 @opindex m4byte-functions
9777 @opindex m4byte-functions
9778 @opindex mno-4byte-functions
9779 Force all functions to be aligned to a four byte boundary.
9780
9781 @item -mcallgraph-data
9782 @itemx -mcallgraph-data
9783 @itemx -mno-callgraph-data
9784 @opindex mcallgraph-data
9785 @opindex mcallgraph-data
9786 @opindex mno-callgraph-data
9787 Emit callgraph information.
9788
9789 @item -mslow-bytes
9790 @itemx -mslow-bytes
9791 @itemx -mno-slow-bytes
9792 @opindex mslow-bytes
9793 @opindex mslow-bytes
9794 @opindex mno-slow-bytes
9795 Prefer word access when reading byte quantities.
9796
9797 @item -mlittle-endian
9798 @itemx -mlittle-endian
9799 @itemx -mbig-endian
9800 @opindex mlittle-endian
9801 @opindex mlittle-endian
9802 @opindex mbig-endian
9803 Generate code for a little endian target.
9804
9805 @item -m210
9806 @itemx -m210
9807 @itemx -m340
9808 @opindex m210
9809 @opindex m210
9810 @opindex m340
9811 Generate code for the 210 processor.
9812 @end table
9813
9814 @node IA-64 Options
9815 @subsection IA-64 Options
9816 @cindex IA-64 Options
9817
9818 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9819
9820 @table @gcctabopt
9821 @item -mbig-endian
9822 @opindex mbig-endian
9823 Generate code for a big endian target. This is the default for HP-UX@.
9824
9825 @item -mlittle-endian
9826 @opindex mlittle-endian
9827 Generate code for a little endian target. This is the default for AIX5
9828 and Linux.
9829
9830 @item -mgnu-as
9831 @itemx -mno-gnu-as
9832 @opindex mgnu-as
9833 @opindex mno-gnu-as
9834 Generate (or don't) code for the GNU assembler. This is the default.
9835 @c Also, this is the default if the configure option @option{--with-gnu-as}
9836 @c is used.
9837
9838 @item -mgnu-ld
9839 @itemx -mno-gnu-ld
9840 @opindex mgnu-ld
9841 @opindex mno-gnu-ld
9842 Generate (or don't) code for the GNU linker. This is the default.
9843 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9844 @c is used.
9845
9846 @item -mno-pic
9847 @opindex mno-pic
9848 Generate code that does not use a global pointer register. The result
9849 is not position independent code, and violates the IA-64 ABI@.
9850
9851 @item -mvolatile-asm-stop
9852 @itemx -mno-volatile-asm-stop
9853 @opindex mvolatile-asm-stop
9854 @opindex mno-volatile-asm-stop
9855 Generate (or don't) a stop bit immediately before and after volatile asm
9856 statements.
9857
9858 @item -mb-step
9859 @opindex mb-step
9860 Generate code that works around Itanium B step errata.
9861
9862 @item -mregister-names
9863 @itemx -mno-register-names
9864 @opindex mregister-names
9865 @opindex mno-register-names
9866 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9867 the stacked registers. This may make assembler output more readable.
9868
9869 @item -mno-sdata
9870 @itemx -msdata
9871 @opindex mno-sdata
9872 @opindex msdata
9873 Disable (or enable) optimizations that use the small data section. This may
9874 be useful for working around optimizer bugs.
9875
9876 @item -mconstant-gp
9877 @opindex mconstant-gp
9878 Generate code that uses a single constant global pointer value. This is
9879 useful when compiling kernel code.
9880
9881 @item -mauto-pic
9882 @opindex mauto-pic
9883 Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
9884 This is useful when compiling firmware code.
9885
9886 @item -minline-float-divide-min-latency
9887 @opindex minline-float-divide-min-latency
9888 Generate code for inline divides of floating point values
9889 using the minimum latency algorithm.
9890
9891 @item -minline-float-divide-max-throughput
9892 @opindex minline-float-divide-max-throughput
9893 Generate code for inline divides of floating point values
9894 using the maximum throughput algorithm.
9895
9896 @item -minline-int-divide-min-latency
9897 @opindex minline-int-divide-min-latency
9898 Generate code for inline divides of integer values
9899 using the minimum latency algorithm.
9900
9901 @item -minline-int-divide-max-throughput
9902 @opindex minline-int-divide-max-throughput
9903 Generate code for inline divides of integer values
9904 using the maximum throughput algorithm.
9905
9906 @item -mno-dwarf2-asm
9907 @itemx -mdwarf2-asm
9908 @opindex mno-dwarf2-asm
9909 @opindex mdwarf2-asm
9910 Don't (or do) generate assembler code for the DWARF2 line number debugging
9911 info. This may be useful when not using the GNU assembler.
9912
9913 @item -mfixed-range=@var{register-range}
9914 @opindex mfixed-range
9915 Generate code treating the given register range as fixed registers.
9916 A fixed register is one that the register allocator can not use. This is
9917 useful when compiling kernel code. A register range is specified as
9918 two registers separated by a dash. Multiple register ranges can be
9919 specified separated by a comma.
9920
9921 @item -mearly-stop-bits
9922 @itemx -mno-early-stop-bits
9923 @opindex mearly-stop-bits
9924 @opindex mno-early-stop-bits
9925 Allow stop bits to be placed earlier than immediately preceding the
9926 instruction that triggered the stop bit. This can improve instruction
9927 scheduling, but does not always do so.
9928 @end table
9929
9930 @node D30V Options
9931 @subsection D30V Options
9932 @cindex D30V Options
9933
9934 These @samp{-m} options are defined for D30V implementations:
9935
9936 @table @gcctabopt
9937 @item -mextmem
9938 @opindex mextmem
9939 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9940 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9941 memory, which starts at location @code{0x80000000}.
9942
9943 @item -mextmemory
9944 @opindex mextmemory
9945 Same as the @option{-mextmem} switch.
9946
9947 @item -monchip
9948 @opindex monchip
9949 Link the @samp{.text} section into onchip text memory, which starts at
9950 location @code{0x0}. Also link @samp{.data}, @samp{.bss},
9951 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9952 into onchip data memory, which starts at location @code{0x20000000}.
9953
9954 @item -mno-asm-optimize
9955 @itemx -masm-optimize
9956 @opindex mno-asm-optimize
9957 @opindex masm-optimize
9958 Disable (enable) passing @option{-O} to the assembler when optimizing.
9959 The assembler uses the @option{-O} option to automatically parallelize
9960 adjacent short instructions where possible.
9961
9962 @item -mbranch-cost=@var{n}
9963 @opindex mbranch-cost
9964 Increase the internal costs of branches to @var{n}. Higher costs means
9965 that the compiler will issue more instructions to avoid doing a branch.
9966 The default is 2.
9967
9968 @item -mcond-exec=@var{n}
9969 @opindex mcond-exec
9970 Specify the maximum number of conditionally executed instructions that
9971 replace a branch. The default is 4.
9972 @end table
9973
9974 @node S/390 and zSeries Options
9975 @subsection S/390 and zSeries Options
9976 @cindex S/390 and zSeries Options
9977
9978 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9979
9980 @table @gcctabopt
9981 @item -mhard-float
9982 @itemx -msoft-float
9983 @opindex mhard-float
9984 @opindex msoft-float
9985 Use (do not use) the hardware floating-point instructions and registers
9986 for floating-point operations. When @option{-msoft-float} is specified,
9987 functions in @file{libgcc.a} will be used to perform floating-point
9988 operations. When @option{-mhard-float} is specified, the compiler
9989 generates IEEE floating-point instructions. This is the default.
9990
9991 @item -mbackchain
9992 @itemx -mno-backchain
9993 @opindex mbackchain
9994 @opindex mno-backchain
9995 Generate (or do not generate) code which maintains an explicit
9996 backchain within the stack frame that points to the caller's frame.
9997 This is currently needed to allow debugging. The default is to
9998 generate the backchain.
9999
10000 @item -msmall-exec
10001 @itemx -mno-small-exec
10002 @opindex msmall-exec
10003 @opindex mno-small-exec
10004 Generate (or do not generate) code using the @code{bras} instruction
10005 to do subroutine calls.
10006 This only works reliably if the total executable size does not
10007 exceed 64k. The default is to use the @code{basr} instruction instead,
10008 which does not have this limitation.
10009
10010 @item -m64
10011 @itemx -m31
10012 @opindex m64
10013 @opindex m31
10014 When @option{-m31} is specified, generate code compliant to the
10015 Linux for S/390 ABI@. When @option{-m64} is specified, generate
10016 code compliant to the Linux for zSeries ABI@. This allows GCC in
10017 particular to generate 64-bit instructions. For the @samp{s390}
10018 targets, the default is @option{-m31}, while the @samp{s390x}
10019 targets default to @option{-m64}.
10020
10021 @item -mzarch
10022 @itemx -mesa
10023 @opindex mzarch
10024 @opindex mesa
10025 When @option{-mzarch} is specified, generate code using the
10026 instructions available on z/Architecture.
10027 When @option{-mesa} is specified, generate code using the
10028 instructions available on ESA/390. Note that @option{-mesa} is
10029 not possible with @option{-m64}.
10030 For the @samp{s390} targets, the default is @option{-mesa},
10031 while the @samp{s390x} targets default to @option{-mzarch}.
10032
10033 @item -mmvcle
10034 @itemx -mno-mvcle
10035 @opindex mmvcle
10036 @opindex mno-mvcle
10037 Generate (or do not generate) code using the @code{mvcle} instruction
10038 to perform block moves. When @option{-mno-mvcle} is specified,
10039 use a @code{mvc} loop instead. This is the default.
10040
10041 @item -mdebug
10042 @itemx -mno-debug
10043 @opindex mdebug
10044 @opindex mno-debug
10045 Print (or do not print) additional debug information when compiling.
10046 The default is to not print debug information.
10047
10048 @item -march=@var{arch}
10049 @opindex march
10050 Generate code that will run on @var{arch}, which is the name of system
10051 representing a certain processor type. Possible values for
10052 @var{cpu-type} are @samp{g5}, @samp{g6} and @samp{z900}.
10053
10054 @item -mtune=@var{arch}
10055 @opindex mtune
10056 Tune to @var{cpu-type} everything applicable about the generated code,
10057 except for the ABI and the set of available instructions.
10058 The list of @var{arch} values is the same as for @option{-march}.
10059
10060 @end table
10061
10062 @node CRIS Options
10063 @subsection CRIS Options
10064 @cindex CRIS Options
10065
10066 These options are defined specifically for the CRIS ports.
10067
10068 @table @gcctabopt
10069 @item -march=@var{architecture-type}
10070 @itemx -mcpu=@var{architecture-type}
10071 @opindex march
10072 @opindex mcpu
10073 Generate code for the specified architecture. The choices for
10074 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10075 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10076 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10077 @samp{v10}.
10078
10079 @item -mtune=@var{architecture-type}
10080 @opindex mtune
10081 Tune to @var{architecture-type} everything applicable about the generated
10082 code, except for the ABI and the set of available instructions. The
10083 choices for @var{architecture-type} are the same as for
10084 @option{-march=@var{architecture-type}}.
10085
10086 @item -mmax-stack-frame=@var{n}
10087 @opindex mmax-stack-frame
10088 Warn when the stack frame of a function exceeds @var{n} bytes.
10089
10090 @item -melinux-stacksize=@var{n}
10091 @opindex melinux-stacksize
10092 Only available with the @samp{cris-axis-aout} target. Arranges for
10093 indications in the program to the kernel loader that the stack of the
10094 program should be set to @var{n} bytes.
10095
10096 @item -metrax4
10097 @itemx -metrax100
10098 @opindex metrax4
10099 @opindex metrax100
10100 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10101 @option{-march=v3} and @option{-march=v8} respectively.
10102
10103 @item -mpdebug
10104 @opindex mpdebug
10105 Enable CRIS-specific verbose debug-related information in the assembly
10106 code. This option also has the effect to turn off the @samp{#NO_APP}
10107 formatted-code indicator to the assembler at the beginning of the
10108 assembly file.
10109
10110 @item -mcc-init
10111 @opindex mcc-init
10112 Do not use condition-code results from previous instruction; always emit
10113 compare and test instructions before use of condition codes.
10114
10115 @item -mno-side-effects
10116 @opindex mno-side-effects
10117 Do not emit instructions with side-effects in addressing modes other than
10118 post-increment.
10119
10120 @item -mstack-align
10121 @itemx -mno-stack-align
10122 @itemx -mdata-align
10123 @itemx -mno-data-align
10124 @itemx -mconst-align
10125 @itemx -mno-const-align
10126 @opindex mstack-align
10127 @opindex mno-stack-align
10128 @opindex mdata-align
10129 @opindex mno-data-align
10130 @opindex mconst-align
10131 @opindex mno-const-align
10132 These options (no-options) arranges (eliminate arrangements) for the
10133 stack-frame, individual data and constants to be aligned for the maximum
10134 single data access size for the chosen CPU model. The default is to
10135 arrange for 32-bit alignment. ABI details such as structure layout are
10136 not affected by these options.
10137
10138 @item -m32-bit
10139 @itemx -m16-bit
10140 @itemx -m8-bit
10141 @opindex m32-bit
10142 @opindex m16-bit
10143 @opindex m8-bit
10144 Similar to the stack- data- and const-align options above, these options
10145 arrange for stack-frame, writable data and constants to all be 32-bit,
10146 16-bit or 8-bit aligned. The default is 32-bit alignment.
10147
10148 @item -mno-prologue-epilogue
10149 @itemx -mprologue-epilogue
10150 @opindex mno-prologue-epilogue
10151 @opindex mprologue-epilogue
10152 With @option{-mno-prologue-epilogue}, the normal function prologue and
10153 epilogue that sets up the stack-frame are omitted and no return
10154 instructions or return sequences are generated in the code. Use this
10155 option only together with visual inspection of the compiled code: no
10156 warnings or errors are generated when call-saved registers must be saved,
10157 or storage for local variable needs to be allocated.
10158
10159 @item -mno-gotplt
10160 @itemx -mgotplt
10161 @opindex mno-gotplt
10162 @opindex mgotplt
10163 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10164 instruction sequences that load addresses for functions from the PLT part
10165 of the GOT rather than (traditional on other architectures) calls to the
10166 PLT. The default is @option{-mgotplt}.
10167
10168 @item -maout
10169 @opindex maout
10170 Legacy no-op option only recognized with the cris-axis-aout target.
10171
10172 @item -melf
10173 @opindex melf
10174 Legacy no-op option only recognized with the cris-axis-elf and
10175 cris-axis-linux-gnu targets.
10176
10177 @item -melinux
10178 @opindex melinux
10179 Only recognized with the cris-axis-aout target, where it selects a
10180 GNU/linux-like multilib, include files and instruction set for
10181 @option{-march=v8}.
10182
10183 @item -mlinux
10184 @opindex mlinux
10185 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10186
10187 @item -sim
10188 @opindex sim
10189 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10190 to link with input-output functions from a simulator library. Code,
10191 initialized data and zero-initialized data are allocated consecutively.
10192
10193 @item -sim2
10194 @opindex sim2
10195 Like @option{-sim}, but pass linker options to locate initialized data at
10196 0x40000000 and zero-initialized data at 0x80000000.
10197 @end table
10198
10199 @node MMIX Options
10200 @subsection MMIX Options
10201 @cindex MMIX Options
10202
10203 These options are defined for the MMIX:
10204
10205 @table @gcctabopt
10206 @item -mlibfuncs
10207 @itemx -mno-libfuncs
10208 @opindex mlibfuncs
10209 @opindex mno-libfuncs
10210 Specify that intrinsic library functions are being compiled, passing all
10211 values in registers, no matter the size.
10212
10213 @item -mepsilon
10214 @itemx -mno-epsilon
10215 @opindex mepsilon
10216 @opindex mno-epsilon
10217 Generate floating-point comparison instructions that compare with respect
10218 to the @code{rE} epsilon register.
10219
10220 @item -mabi=mmixware
10221 @itemx -mabi=gnu
10222 @opindex mabi-mmixware
10223 @opindex mabi=gnu
10224 Generate code that passes function parameters and return values that (in
10225 the called function) are seen as registers @code{$0} and up, as opposed to
10226 the GNU ABI which uses global registers @code{$231} and up.
10227
10228 @item -mzero-extend
10229 @itemx -mno-zero-extend
10230 @opindex mzero-extend
10231 @opindex mno-zero-extend
10232 When reading data from memory in sizes shorter than 64 bits, use (do not
10233 use) zero-extending load instructions by default, rather than
10234 sign-extending ones.
10235
10236 @item -mknuthdiv
10237 @itemx -mno-knuthdiv
10238 @opindex mknuthdiv
10239 @opindex mno-knuthdiv
10240 Make the result of a division yielding a remainder have the same sign as
10241 the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
10242 remainder follows the sign of the dividend. Both methods are
10243 arithmetically valid, the latter being almost exclusively used.
10244
10245 @item -mtoplevel-symbols
10246 @itemx -mno-toplevel-symbols
10247 @opindex mtoplevel-symbols
10248 @opindex mno-toplevel-symbols
10249 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10250 code can be used with the @code{PREFIX} assembly directive.
10251
10252 @item -melf
10253 @opindex melf
10254 Generate an executable in the ELF format, rather than the default
10255 @samp{mmo} format used by the @command{mmix} simulator.
10256
10257 @item -mbranch-predict
10258 @itemx -mno-branch-predict
10259 @opindex mbranch-predict
10260 @opindex mno-branch-predict
10261 Use (do not use) the probable-branch instructions, when static branch
10262 prediction indicates a probable branch.
10263
10264 @item -mbase-addresses
10265 @itemx -mno-base-addresses
10266 @opindex mbase-addresses
10267 @opindex mno-base-addresses
10268 Generate (do not generate) code that uses @emph{base addresses}. Using a
10269 base address automatically generates a request (handled by the assembler
10270 and the linker) for a constant to be set up in a global register. The
10271 register is used for one or more base address requests within the range 0
10272 to 255 from the value held in the register. The generally leads to short
10273 and fast code, but the number of different data items that can be
10274 addressed is limited. This means that a program that uses lots of static
10275 data may require @option{-mno-base-addresses}.
10276
10277 @item -msingle-exit
10278 @itemx -mno-single-exit
10279 @opindex msingle-exit
10280 @opindex mno-single-exit
10281 Force (do not force) generated code to have a single exit point in each
10282 function.
10283 @end table
10284
10285 @node PDP-11 Options
10286 @subsection PDP-11 Options
10287 @cindex PDP-11 Options
10288
10289 These options are defined for the PDP-11:
10290
10291 @table @gcctabopt
10292 @item -mfpu
10293 @opindex mfpu
10294 Use hardware FPP floating point. This is the default. (FIS floating
10295 point on the PDP-11/40 is not supported.)
10296
10297 @item -msoft-float
10298 @opindex msoft-float
10299 Do not use hardware floating point.
10300
10301 @item -mac0
10302 @opindex mac0
10303 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10304
10305 @item -mno-ac0
10306 @opindex mno-ac0
10307 Return floating-point results in memory. This is the default.
10308
10309 @item -m40
10310 @opindex m40
10311 Generate code for a PDP-11/40.
10312
10313 @item -m45
10314 @opindex m45
10315 Generate code for a PDP-11/45. This is the default.
10316
10317 @item -m10
10318 @opindex m10
10319 Generate code for a PDP-11/10.
10320
10321 @item -mbcopy-builtin
10322 @opindex bcopy-builtin
10323 Use inline @code{movstrhi} patterns for copying memory. This is the
10324 default.
10325
10326 @item -mbcopy
10327 @opindex mbcopy
10328 Do not use inline @code{movstrhi} patterns for copying memory.
10329
10330 @item -mint16
10331 @itemx -mno-int32
10332 @opindex mint16
10333 @opindex mno-int32
10334 Use 16-bit @code{int}. This is the default.
10335
10336 @item -mint32
10337 @itemx -mno-int16
10338 @opindex mint32
10339 @opindex mno-int16
10340 Use 32-bit @code{int}.
10341
10342 @item -mfloat64
10343 @itemx -mno-float32
10344 @opindex mfloat64
10345 @opindex mno-float32
10346 Use 64-bit @code{float}. This is the default.
10347
10348 @item -mfloat32
10349 @item -mno-float64
10350 @opindex mfloat32
10351 @opindex mno-float64
10352 Use 32-bit @code{float}.
10353
10354 @item -mabshi
10355 @opindex mabshi
10356 Use @code{abshi2} pattern. This is the default.
10357
10358 @item -mno-abshi
10359 @opindex mno-abshi
10360 Do not use @code{abshi2} pattern.
10361
10362 @item -mbranch-expensive
10363 @opindex mbranch-expensive
10364 Pretend that branches are expensive. This is for experimenting with
10365 code generation only.
10366
10367 @item -mbranch-cheap
10368 @opindex mbranch-cheap
10369 Do not pretend that branches are expensive. This is the default.
10370
10371 @item -msplit
10372 @opindex msplit
10373 Generate code for a system with split I&D.
10374
10375 @item -mno-split
10376 @opindex mno-split
10377 Generate code for a system without split I&D. This is the default.
10378
10379 @item -munix-asm
10380 @opindex munix-asm
10381 Use Unix assembler syntax. This is the default when configured for
10382 @samp{pdp11-*-bsd}.
10383
10384 @item -mdec-asm
10385 @opindex mdec-asm
10386 Use DEC assembler syntax. This is the default when configured for any
10387 PDP-11 target other than @samp{pdp11-*-bsd}.
10388 @end table
10389
10390 @node Xstormy16 Options
10391 @subsection Xstormy16 Options
10392 @cindex Xstormy16 Options
10393
10394 These options are defined for Xstormy16:
10395
10396 @table @gcctabopt
10397 @item -msim
10398 @opindex msim
10399 Choose startup files and linker script suitable for the simulator.
10400 @end table
10401
10402 @node FRV Options
10403 @subsection FRV Options
10404 @cindex FRV Options
10405
10406 @table @gcctabopt
10407 @item -mgpr-32
10408 @opindex mgpr-32
10409
10410 Only use the first 32 general purpose registers.
10411
10412 @item -mgpr-64
10413 @opindex mgpr-64
10414
10415 Use all 64 general purpose registers.
10416
10417 @item -mfpr-32
10418 @opindex mfpr-32
10419
10420 Use only the first 32 floating point registers.
10421
10422 @item -mfpr-64
10423 @opindex mfpr-64
10424
10425 Use all 64 floating point registers
10426
10427 @item -mhard-float
10428 @opindex mhard-float
10429
10430 Use hardware instructions for floating point operations.
10431
10432 @item -msoft-float
10433 @opindex msoft-float
10434
10435 Use library routines for floating point operations.
10436
10437 @item -malloc-cc
10438 @opindex malloc-cc
10439
10440 Dynamically allocate condition code registers.
10441
10442 @item -mfixed-cc
10443 @opindex mfixed-cc
10444
10445 Do not try to dynamically allocate condition code registers, only
10446 use @code{icc0} and @code{fcc0}.
10447
10448 @item -mdword
10449 @opindex mdword
10450
10451 Change ABI to use double word insns.
10452
10453 @item -mno-dword
10454 @opindex mno-dword
10455
10456 Do not use double word instructions.
10457
10458 @item -mdouble
10459 @opindex mdouble
10460
10461 Use floating point double instructions.
10462
10463 @item -mno-double
10464 @opindex mno-double
10465
10466 Do not use floating point double instructions.
10467
10468 @item -mmedia
10469 @opindex mmedia
10470
10471 Use media instructions.
10472
10473 @item -mno-media
10474 @opindex mno-media
10475
10476 Do not use media instructions.
10477
10478 @item -mmuladd
10479 @opindex mmuladd
10480
10481 Use multiply and add/subtract instructions.
10482
10483 @item -mno-muladd
10484 @opindex mno-muladd
10485
10486 Do not use multiply and add/subtract instructions.
10487
10488 @item -mlibrary-pic
10489 @opindex mlibrary-pic
10490
10491 Enable PIC support for building libraries
10492
10493 @item -macc-4
10494 @opindex macc-4
10495
10496 Use only the first four media accumulator registers.
10497
10498 @item -macc-8
10499 @opindex macc-8
10500
10501 Use all eight media accumulator registers.
10502
10503 @item -mpack
10504 @opindex mpack
10505
10506 Pack VLIW instructions.
10507
10508 @item -mno-pack
10509 @opindex mno-pack
10510
10511 Do not pack VLIW instructions.
10512
10513 @item -mno-eflags
10514 @opindex mno-eflags
10515
10516 Do not mark ABI switches in e_flags.
10517
10518 @item -mcond-move
10519 @opindex mcond-move
10520
10521 Enable the use of conditional-move instructions (default).
10522
10523 This switch is mainly for debugging the compiler and will likely be removed
10524 in a future version.
10525
10526 @item -mno-cond-move
10527 @opindex mno-cond-move
10528
10529 Disable the use of conditional-move instructions.
10530
10531 This switch is mainly for debugging the compiler and will likely be removed
10532 in a future version.
10533
10534 @item -mscc
10535 @opindex mscc
10536
10537 Enable the use of conditional set instructions (default).
10538
10539 This switch is mainly for debugging the compiler and will likely be removed
10540 in a future version.
10541
10542 @item -mno-scc
10543 @opindex mno-scc
10544
10545 Disable the use of conditional set instructions.
10546
10547 This switch is mainly for debugging the compiler and will likely be removed
10548 in a future version.
10549
10550 @item -mcond-exec
10551 @opindex mcond-exec
10552
10553 Enable the use of conditional execution (default).
10554
10555 This switch is mainly for debugging the compiler and will likely be removed
10556 in a future version.
10557
10558 @item -mno-cond-exec
10559 @opindex mno-cond-exec
10560
10561 Disable the use of conditional execution.
10562
10563 This switch is mainly for debugging the compiler and will likely be removed
10564 in a future version.
10565
10566 @item -mvliw-branch
10567 @opindex mvliw-branch
10568
10569 Run a pass to pack branches into VLIW instructions (default).
10570
10571 This switch is mainly for debugging the compiler and will likely be removed
10572 in a future version.
10573
10574 @item -mno-vliw-branch
10575 @opindex mno-vliw-branch
10576
10577 Do not run a pass to pack branches into VLIW instructions.
10578
10579 This switch is mainly for debugging the compiler and will likely be removed
10580 in a future version.
10581
10582 @item -mmulti-cond-exec
10583 @opindex mmulti-cond-exec
10584
10585 Enable optimization of @code{&&} and @code{||} in conditional execution
10586 (default).
10587
10588 This switch is mainly for debugging the compiler and will likely be removed
10589 in a future version.
10590
10591 @item -mno-multi-cond-exec
10592 @opindex mno-multi-cond-exec
10593
10594 Disable optimization of @code{&&} and @code{||} in conditional execution.
10595
10596 This switch is mainly for debugging the compiler and will likely be removed
10597 in a future version.
10598
10599 @item -mnested-cond-exec
10600 @opindex mnested-cond-exec
10601
10602 Enable nested conditional execution optimizations (default).
10603
10604 This switch is mainly for debugging the compiler and will likely be removed
10605 in a future version.
10606
10607 @item -mno-nested-cond-exec
10608 @opindex mno-nested-cond-exec
10609
10610 Disable nested conditional execution optimizations.
10611
10612 This switch is mainly for debugging the compiler and will likely be removed
10613 in a future version.
10614
10615 @item -mtomcat-stats
10616 @opindex mtomcat-stats
10617
10618 Cause gas to print out tomcat statistics.
10619
10620 @item -mcpu=@var{cpu}
10621 @opindex mcpu
10622
10623 Select the processor type for which to generate code. Possible values are
10624 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10625 @samp{frv}.
10626
10627 @end table
10628
10629 @node Xtensa Options
10630 @subsection Xtensa Options
10631 @cindex Xtensa Options
10632
10633 The Xtensa architecture is designed to support many different
10634 configurations. The compiler's default options can be set to match a
10635 particular Xtensa configuration by copying a configuration file into the
10636 GCC sources when building GCC@. The options below may be used to
10637 override the default options.
10638
10639 @table @gcctabopt
10640 @item -mbig-endian
10641 @itemx -mlittle-endian
10642 @opindex mbig-endian
10643 @opindex mlittle-endian
10644 Specify big-endian or little-endian byte ordering for the target Xtensa
10645 processor.
10646
10647 @item -mdensity
10648 @itemx -mno-density
10649 @opindex mdensity
10650 @opindex mno-density
10651 Enable or disable use of the optional Xtensa code density instructions.
10652
10653 @item -mmac16
10654 @itemx -mno-mac16
10655 @opindex mmac16
10656 @opindex mno-mac16
10657 Enable or disable use of the Xtensa MAC16 option. When enabled, GCC
10658 will generate MAC16 instructions from standard C code, with the
10659 limitation that it will use neither the MR register file nor any
10660 instruction that operates on the MR registers. When this option is
10661 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10662 combination of core instructions and library calls, depending on whether
10663 any other multiplier options are enabled.
10664
10665 @item -mmul16
10666 @itemx -mno-mul16
10667 @opindex mmul16
10668 @opindex mno-mul16
10669 Enable or disable use of the 16-bit integer multiplier option. When
10670 enabled, the compiler will generate 16-bit multiply instructions for
10671 multiplications of 16 bits or smaller in standard C code. When this
10672 option is disabled, the compiler will either use 32-bit multiply or
10673 MAC16 instructions if they are available or generate library calls to
10674 perform the multiply operations using shifts and adds.
10675
10676 @item -mmul32
10677 @itemx -mno-mul32
10678 @opindex mmul32
10679 @opindex mno-mul32
10680 Enable or disable use of the 32-bit integer multiplier option. When
10681 enabled, the compiler will generate 32-bit multiply instructions for
10682 multiplications of 32 bits or smaller in standard C code. When this
10683 option is disabled, the compiler will generate library calls to perform
10684 the multiply operations using either shifts and adds or 16-bit multiply
10685 instructions if they are available.
10686
10687 @item -mnsa
10688 @itemx -mno-nsa
10689 @opindex mnsa
10690 @opindex mno-nsa
10691 Enable or disable use of the optional normalization shift amount
10692 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10693
10694 @item -mminmax
10695 @itemx -mno-minmax
10696 @opindex mminmax
10697 @opindex mno-minmax
10698 Enable or disable use of the optional minimum and maximum value
10699 instructions.
10700
10701 @item -msext
10702 @itemx -mno-sext
10703 @opindex msext
10704 @opindex mno-sext
10705 Enable or disable use of the optional sign extend (@code{SEXT})
10706 instruction.
10707
10708 @item -mbooleans
10709 @itemx -mno-booleans
10710 @opindex mbooleans
10711 @opindex mno-booleans
10712 Enable or disable support for the boolean register file used by Xtensa
10713 coprocessors. This is not typically useful by itself but may be
10714 required for other options that make use of the boolean registers (e.g.,
10715 the floating-point option).
10716
10717 @item -mhard-float
10718 @itemx -msoft-float
10719 @opindex mhard-float
10720 @opindex msoft-float
10721 Enable or disable use of the floating-point option. When enabled, GCC
10722 generates floating-point instructions for 32-bit @code{float}
10723 operations. When this option is disabled, GCC generates library calls
10724 to emulate 32-bit floating-point operations using integer instructions.
10725 Regardless of this option, 64-bit @code{double} operations are always
10726 emulated with calls to library functions.
10727
10728 @item -mfused-madd
10729 @itemx -mno-fused-madd
10730 @opindex mfused-madd
10731 @opindex mno-fused-madd
10732 Enable or disable use of fused multiply/add and multiply/subtract
10733 instructions in the floating-point option. This has no effect if the
10734 floating-point option is not also enabled. Disabling fused multiply/add
10735 and multiply/subtract instructions forces the compiler to use separate
10736 instructions for the multiply and add/subtract operations. This may be
10737 desirable in some cases where strict IEEE 754-compliant results are
10738 required: the fused multiply add/subtract instructions do not round the
10739 intermediate result, thereby producing results with @emph{more} bits of
10740 precision than specified by the IEEE standard. Disabling fused multiply
10741 add/subtract instructions also ensures that the program output is not
10742 sensitive to the compiler's ability to combine multiply and add/subtract
10743 operations.
10744
10745 @item -mserialize-volatile
10746 @itemx -mno-serialize-volatile
10747 @opindex mserialize-volatile
10748 @opindex mno-serialize-volatile
10749 When this option is enabled, GCC inserts @code{MEMW} instructions before
10750 @code{volatile} memory references to guarantee sequential consistency.
10751 The default is @option{-mserialize-volatile}. Use
10752 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
10753
10754 @item -mtext-section-literals
10755 @itemx -mno-text-section-literals
10756 @opindex mtext-section-literals
10757 @opindex mno-text-section-literals
10758 Control the treatment of literal pools. The default is
10759 @option{-mno-text-section-literals}, which places literals in a separate
10760 section in the output file. This allows the literal pool to be placed
10761 in a data RAM/ROM, and it also allows the linker to combine literal
10762 pools from separate object files to remove redundant literals and
10763 improve code size. With @option{-mtext-section-literals}, the literals
10764 are interspersed in the text section in order to keep them as close as
10765 possible to their references. This may be necessary for large assembly
10766 files.
10767
10768 @item -mtarget-align
10769 @itemx -mno-target-align
10770 @opindex mtarget-align
10771 @opindex mno-target-align
10772 When this option is enabled, GCC instructs the assembler to
10773 automatically align instructions to reduce branch penalties at the
10774 expense of some code density. The assembler attempts to widen density
10775 instructions to align branch targets and the instructions following call
10776 instructions. If there are not enough preceding safe density
10777 instructions to align a target, no widening will be performed. The
10778 default is @option{-mtarget-align}. These options do not affect the
10779 treatment of auto-aligned instructions like @code{LOOP}, which the
10780 assembler will always align, either by widening density instructions or
10781 by inserting no-op instructions.
10782
10783 @item -mlongcalls
10784 @itemx -mno-longcalls
10785 @opindex mlongcalls
10786 @opindex mno-longcalls
10787 When this option is enabled, GCC instructs the assembler to translate
10788 direct calls to indirect calls unless it can determine that the target
10789 of a direct call is in the range allowed by the call instruction. This
10790 translation typically occurs for calls to functions in other source
10791 files. Specifically, the assembler translates a direct @code{CALL}
10792 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10793 The default is @option{-mno-longcalls}. This option should be used in
10794 programs where the call target can potentially be out of range. This
10795 option is implemented in the assembler, not the compiler, so the
10796 assembly code generated by GCC will still show direct call
10797 instructions---look at the disassembled object code to see the actual
10798 instructions. Note that the assembler will use an indirect call for
10799 every cross-file call, not just those that really will be out of range.
10800 @end table
10801
10802 @node Code Gen Options
10803 @section Options for Code Generation Conventions
10804 @cindex code generation conventions
10805 @cindex options, code generation
10806 @cindex run-time options
10807
10808 These machine-independent options control the interface conventions
10809 used in code generation.
10810
10811 Most of them have both positive and negative forms; the negative form
10812 of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
10813 one of the forms is listed---the one which is not the default. You
10814 can figure out the other form by either removing @samp{no-} or adding
10815 it.
10816
10817 @table @gcctabopt
10818 @item -fbounds-check
10819 @opindex fbounds-check
10820 For front-ends that support it, generate additional code to check that
10821 indices used to access arrays are within the declared range. This is
10822 currently only supported by the Java and Fortran 77 front-ends, where
10823 this option defaults to true and false respectively.
10824
10825 @item -ftrapv
10826 @opindex ftrapv
10827 This option generates traps for signed overflow on addition, subtraction,
10828 multiplication operations.
10829
10830 @item -fexceptions
10831 @opindex fexceptions
10832 Enable exception handling. Generates extra code needed to propagate
10833 exceptions. For some targets, this implies GCC will generate frame
10834 unwind information for all functions, which can produce significant data
10835 size overhead, although it does not affect execution. If you do not
10836 specify this option, GCC will enable it by default for languages like
10837 C++ which normally require exception handling, and disable it for
10838 languages like C that do not normally require it. However, you may need
10839 to enable this option when compiling C code that needs to interoperate
10840 properly with exception handlers written in C++. You may also wish to
10841 disable this option if you are compiling older C++ programs that don't
10842 use exception handling.
10843
10844 @item -fnon-call-exceptions
10845 @opindex fnon-call-exceptions
10846 Generate code that allows trapping instructions to throw exceptions.
10847 Note that this requires platform-specific runtime support that does
10848 not exist everywhere. Moreover, it only allows @emph{trapping}
10849 instructions to throw exceptions, i.e.@: memory references or floating
10850 point instructions. It does not allow exceptions to be thrown from
10851 arbitrary signal handlers such as @code{SIGALRM}.
10852
10853 @item -fforced-unwind-exceptions
10854 @opindex fforced-unwind-exceptions
10855 Generate code that checks for non-catchable exceptions derived from
10856 @code{_Unwind_ForcedUnwind}, such as from @code{longjmp_unwind} or
10857 from pthread cancellation. There is some amount of code-size
10858 overhead associated with this, so it is not default.
10859
10860 @item -funwind-tables
10861 @opindex funwind-tables
10862 Similar to @option{-fexceptions}, except that it will just generate any needed
10863 static data, but will not affect the generated code in any other way.
10864 You will normally not enable this option; instead, a language processor
10865 that needs this handling would enable it on your behalf.
10866
10867 @item -fasynchronous-unwind-tables
10868 @opindex funwind-tables
10869 Generate unwind table in dwarf2 format, if supported by target machine. The
10870 table is exact at each instruction boundary, so it can be used for stack
10871 unwinding from asynchronous events (such as debugger or garbage collector).
10872
10873 @item -fpcc-struct-return
10874 @opindex fpcc-struct-return
10875 Return ``short'' @code{struct} and @code{union} values in memory like
10876 longer ones, rather than in registers. This convention is less
10877 efficient, but it has the advantage of allowing intercallability between
10878 GCC-compiled files and files compiled with other compilers, particularly
10879 the Portable C Compiler (pcc).
10880
10881 The precise convention for returning structures in memory depends
10882 on the target configuration macros.
10883
10884 Short structures and unions are those whose size and alignment match
10885 that of some integer type.
10886
10887 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10888 switch is not binary compatible with code compiled with the
10889 @option{-freg-struct-return} switch.
10890 Use it to conform to a non-default application binary interface.
10891
10892 @item -freg-struct-return
10893 @opindex freg-struct-return
10894 Return @code{struct} and @code{union} values in registers when possible.
10895 This is more efficient for small structures than
10896 @option{-fpcc-struct-return}.
10897
10898 If you specify neither @option{-fpcc-struct-return} nor
10899 @option{-freg-struct-return}, GCC defaults to whichever convention is
10900 standard for the target. If there is no standard convention, GCC
10901 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10902 the principal compiler. In those cases, we can choose the standard, and
10903 we chose the more efficient register return alternative.
10904
10905 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10906 switch is not binary compatible with code compiled with the
10907 @option{-fpcc-struct-return} switch.
10908 Use it to conform to a non-default application binary interface.
10909
10910 @item -fshort-enums
10911 @opindex fshort-enums
10912 Allocate to an @code{enum} type only as many bytes as it needs for the
10913 declared range of possible values. Specifically, the @code{enum} type
10914 will be equivalent to the smallest integer type which has enough room.
10915
10916 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10917 code that is not binary compatible with code generated without that switch.
10918 Use it to conform to a non-default application binary interface.
10919
10920 @item -fshort-double
10921 @opindex fshort-double
10922 Use the same size for @code{double} as for @code{float}.
10923
10924 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10925 code that is not binary compatible with code generated without that switch.
10926 Use it to conform to a non-default application binary interface.
10927
10928 @item -fshort-wchar
10929 @opindex fshort-wchar
10930 Override the underlying type for @samp{wchar_t} to be @samp{short
10931 unsigned int} instead of the default for the target. This option is
10932 useful for building programs to run under WINE@.
10933
10934 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10935 code that is not binary compatible with code generated without that switch.
10936 Use it to conform to a non-default application binary interface.
10937
10938 @item -fshared-data
10939 @opindex fshared-data
10940 Requests that the data and non-@code{const} variables of this
10941 compilation be shared data rather than private data. The distinction
10942 makes sense only on certain operating systems, where shared data is
10943 shared between processes running the same program, while private data
10944 exists in one copy per process.
10945
10946 @item -fno-common
10947 @opindex fno-common
10948 In C, allocate even uninitialized global variables in the data section of the
10949 object file, rather than generating them as common blocks. This has the
10950 effect that if the same variable is declared (without @code{extern}) in
10951 two different compilations, you will get an error when you link them.
10952 The only reason this might be useful is if you wish to verify that the
10953 program will work on other systems which always work this way.
10954
10955 @item -fno-ident
10956 @opindex fno-ident
10957 Ignore the @samp{#ident} directive.
10958
10959 @item -fno-gnu-linker
10960 @opindex fno-gnu-linker
10961 Do not output global initializations (such as C++ constructors and
10962 destructors) in the form used by the GNU linker (on systems where the GNU
10963 linker is the standard method of handling them). Use this option when
10964 you want to use a non-GNU linker, which also requires using the
10965 @command{collect2} program to make sure the system linker includes
10966 constructors and destructors. (@command{collect2} is included in the GCC
10967 distribution.) For systems which @emph{must} use @command{collect2}, the
10968 compiler driver @command{gcc} is configured to do this automatically.
10969
10970 @item -finhibit-size-directive
10971 @opindex finhibit-size-directive
10972 Don't output a @code{.size} assembler directive, or anything else that
10973 would cause trouble if the function is split in the middle, and the
10974 two halves are placed at locations far apart in memory. This option is
10975 used when compiling @file{crtstuff.c}; you should not need to use it
10976 for anything else.
10977
10978 @item -fverbose-asm
10979 @opindex fverbose-asm
10980 Put extra commentary information in the generated assembly code to
10981 make it more readable. This option is generally only of use to those
10982 who actually need to read the generated assembly code (perhaps while
10983 debugging the compiler itself).
10984
10985 @option{-fno-verbose-asm}, the default, causes the
10986 extra information to be omitted and is useful when comparing two assembler
10987 files.
10988
10989 @item -fpic
10990 @opindex fpic
10991 @cindex global offset table
10992 @cindex PIC
10993 Generate position-independent code (PIC) suitable for use in a shared
10994 library, if supported for the target machine. Such code accesses all
10995 constant addresses through a global offset table (GOT)@. The dynamic
10996 loader resolves the GOT entries when the program starts (the dynamic
10997 loader is not part of GCC; it is part of the operating system). If
10998 the GOT size for the linked executable exceeds a machine-specific
10999 maximum size, you get an error message from the linker indicating that
11000 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11001 instead. (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
11002 on the m68k and RS/6000. The 386 has no such limit.)
11003
11004 Position-independent code requires special support, and therefore works
11005 only on certain machines. For the 386, GCC supports PIC for System V
11006 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
11007 position-independent.
11008
11009 @item -fPIC
11010 @opindex fPIC
11011 If supported for the target machine, emit position-independent code,
11012 suitable for dynamic linking and avoiding any limit on the size of the
11013 global offset table. This option makes a difference on the m68k, m88k,
11014 and the SPARC.
11015
11016 Position-independent code requires special support, and therefore works
11017 only on certain machines.
11018
11019 @item -ffixed-@var{reg}
11020 @opindex ffixed
11021 Treat the register named @var{reg} as a fixed register; generated code
11022 should never refer to it (except perhaps as a stack pointer, frame
11023 pointer or in some other fixed role).
11024
11025 @var{reg} must be the name of a register. The register names accepted
11026 are machine-specific and are defined in the @code{REGISTER_NAMES}
11027 macro in the machine description macro file.
11028
11029 This flag does not have a negative form, because it specifies a
11030 three-way choice.
11031
11032 @item -fcall-used-@var{reg}
11033 @opindex fcall-used
11034 Treat the register named @var{reg} as an allocable register that is
11035 clobbered by function calls. It may be allocated for temporaries or
11036 variables that do not live across a call. Functions compiled this way
11037 will not save and restore the register @var{reg}.
11038
11039 It is an error to used this flag with the frame pointer or stack pointer.
11040 Use of this flag for other registers that have fixed pervasive roles in
11041 the machine's execution model will produce disastrous results.
11042
11043 This flag does not have a negative form, because it specifies a
11044 three-way choice.
11045
11046 @item -fcall-saved-@var{reg}
11047 @opindex fcall-saved
11048 Treat the register named @var{reg} as an allocable register saved by
11049 functions. It may be allocated even for temporaries or variables that
11050 live across a call. Functions compiled this way will save and restore
11051 the register @var{reg} if they use it.
11052
11053 It is an error to used this flag with the frame pointer or stack pointer.
11054 Use of this flag for other registers that have fixed pervasive roles in
11055 the machine's execution model will produce disastrous results.
11056
11057 A different sort of disaster will result from the use of this flag for
11058 a register in which function values may be returned.
11059
11060 This flag does not have a negative form, because it specifies a
11061 three-way choice.
11062
11063 @item -fpack-struct
11064 @opindex fpack-struct
11065 Pack all structure members together without holes.
11066
11067 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11068 code that is not binary compatible with code generated without that switch.
11069 Additionally, it makes the code suboptimal.
11070 Use it to conform to a non-default application binary interface.
11071
11072 @item -finstrument-functions
11073 @opindex finstrument-functions
11074 Generate instrumentation calls for entry and exit to functions. Just
11075 after function entry and just before function exit, the following
11076 profiling functions will be called with the address of the current
11077 function and its call site. (On some platforms,
11078 @code{__builtin_return_address} does not work beyond the current
11079 function, so the call site information may not be available to the
11080 profiling functions otherwise.)
11081
11082 @example
11083 void __cyg_profile_func_enter (void *this_fn,
11084 void *call_site);
11085 void __cyg_profile_func_exit (void *this_fn,
11086 void *call_site);
11087 @end example
11088
11089 The first argument is the address of the start of the current function,
11090 which may be looked up exactly in the symbol table.
11091
11092 This instrumentation is also done for functions expanded inline in other
11093 functions. The profiling calls will indicate where, conceptually, the
11094 inline function is entered and exited. This means that addressable
11095 versions of such functions must be available. If all your uses of a
11096 function are expanded inline, this may mean an additional expansion of
11097 code size. If you use @samp{extern inline} in your C code, an
11098 addressable version of such functions must be provided. (This is
11099 normally the case anyways, but if you get lucky and the optimizer always
11100 expands the functions inline, you might have gotten away without
11101 providing static copies.)
11102
11103 A function may be given the attribute @code{no_instrument_function}, in
11104 which case this instrumentation will not be done. This can be used, for
11105 example, for the profiling functions listed above, high-priority
11106 interrupt routines, and any functions from which the profiling functions
11107 cannot safely be called (perhaps signal handlers, if the profiling
11108 routines generate output or allocate memory).
11109
11110 @item -fstack-check
11111 @opindex fstack-check
11112 Generate code to verify that you do not go beyond the boundary of the
11113 stack. You should specify this flag if you are running in an
11114 environment with multiple threads, but only rarely need to specify it in
11115 a single-threaded environment since stack overflow is automatically
11116 detected on nearly all systems if there is only one stack.
11117
11118 Note that this switch does not actually cause checking to be done; the
11119 operating system must do that. The switch causes generation of code
11120 to ensure that the operating system sees the stack being extended.
11121
11122 @item -fstack-limit-register=@var{reg}
11123 @itemx -fstack-limit-symbol=@var{sym}
11124 @itemx -fno-stack-limit
11125 @opindex fstack-limit-register
11126 @opindex fstack-limit-symbol
11127 @opindex fno-stack-limit
11128 Generate code to ensure that the stack does not grow beyond a certain value,
11129 either the value of a register or the address of a symbol. If the stack
11130 would grow beyond the value, a signal is raised. For most targets,
11131 the signal is raised before the stack overruns the boundary, so
11132 it is possible to catch the signal without taking special precautions.
11133
11134 For instance, if the stack starts at absolute address @samp{0x80000000}
11135 and grows downwards, you can use the flags
11136 @option{-fstack-limit-symbol=__stack_limit} and
11137 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11138 of 128KB@. Note that this may only work with the GNU linker.
11139
11140 @cindex aliasing of parameters
11141 @cindex parameters, aliased
11142 @item -fargument-alias
11143 @itemx -fargument-noalias
11144 @itemx -fargument-noalias-global
11145 @opindex fargument-alias
11146 @opindex fargument-noalias
11147 @opindex fargument-noalias-global
11148 Specify the possible relationships among parameters and between
11149 parameters and global data.
11150
11151 @option{-fargument-alias} specifies that arguments (parameters) may
11152 alias each other and may alias global storage.@*
11153 @option{-fargument-noalias} specifies that arguments do not alias
11154 each other, but may alias global storage.@*
11155 @option{-fargument-noalias-global} specifies that arguments do not
11156 alias each other and do not alias global storage.
11157
11158 Each language will automatically use whatever option is required by
11159 the language standard. You should not need to use these options yourself.
11160
11161 @item -fleading-underscore
11162 @opindex fleading-underscore
11163 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11164 change the way C symbols are represented in the object file. One use
11165 is to help link with legacy assembly code.
11166
11167 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11168 generate code that is not binary compatible with code generated without that
11169 switch. Use it to conform to a non-default application binary interface.
11170 Not all targets provide complete support for this switch.
11171
11172 @item -ftls-model=@var{model}
11173 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11174 The @var{model} argument should be one of @code{global-dynamic},
11175 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11176
11177 The default without @option{-fpic} is @code{initial-exec}; with
11178 @option{-fpic} the default is @code{global-dynamic}.
11179 @end table
11180
11181 @c man end
11182
11183 @node Environment Variables
11184 @section Environment Variables Affecting GCC
11185 @cindex environment variables
11186
11187 @c man begin ENVIRONMENT
11188
11189 This section describes several environment variables that affect how GCC
11190 operates. Some of them work by specifying directories or prefixes to use
11191 when searching for various kinds of files. Some are used to specify other
11192 aspects of the compilation environment.
11193
11194 Note that you can also specify places to search using options such as
11195 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
11196 take precedence over places specified using environment variables, which
11197 in turn take precedence over those specified by the configuration of GCC@.
11198 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11199 GNU Compiler Collection (GCC) Internals}.
11200
11201 @table @env
11202 @item LANG
11203 @itemx LC_CTYPE
11204 @c @itemx LC_COLLATE
11205 @itemx LC_MESSAGES
11206 @c @itemx LC_MONETARY
11207 @c @itemx LC_NUMERIC
11208 @c @itemx LC_TIME
11209 @itemx LC_ALL
11210 @findex LANG
11211 @findex LC_CTYPE
11212 @c @findex LC_COLLATE
11213 @findex LC_MESSAGES
11214 @c @findex LC_MONETARY
11215 @c @findex LC_NUMERIC
11216 @c @findex LC_TIME
11217 @findex LC_ALL
11218 @cindex locale
11219 These environment variables control the way that GCC uses
11220 localization information that allow GCC to work with different
11221 national conventions. GCC inspects the locale categories
11222 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11223 so. These locale categories can be set to any value supported by your
11224 installation. A typical value is @samp{en_UK} for English in the United
11225 Kingdom.
11226
11227 The @env{LC_CTYPE} environment variable specifies character
11228 classification. GCC uses it to determine the character boundaries in
11229 a string; this is needed for some multibyte encodings that contain quote
11230 and escape characters that would otherwise be interpreted as a string
11231 end or escape.
11232
11233 The @env{LC_MESSAGES} environment variable specifies the language to
11234 use in diagnostic messages.
11235
11236 If the @env{LC_ALL} environment variable is set, it overrides the value
11237 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11238 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11239 environment variable. If none of these variables are set, GCC
11240 defaults to traditional C English behavior.
11241
11242 @item TMPDIR
11243 @findex TMPDIR
11244 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11245 files. GCC uses temporary files to hold the output of one stage of
11246 compilation which is to be used as input to the next stage: for example,
11247 the output of the preprocessor, which is the input to the compiler
11248 proper.
11249
11250 @item GCC_EXEC_PREFIX
11251 @findex GCC_EXEC_PREFIX
11252 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11253 names of the subprograms executed by the compiler. No slash is added
11254 when this prefix is combined with the name of a subprogram, but you can
11255 specify a prefix that ends with a slash if you wish.
11256
11257 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11258 an appropriate prefix to use based on the pathname it was invoked with.
11259
11260 If GCC cannot find the subprogram using the specified prefix, it
11261 tries looking in the usual places for the subprogram.
11262
11263 The default value of @env{GCC_EXEC_PREFIX} is
11264 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11265 of @code{prefix} when you ran the @file{configure} script.
11266
11267 Other prefixes specified with @option{-B} take precedence over this prefix.
11268
11269 This prefix is also used for finding files such as @file{crt0.o} that are
11270 used for linking.
11271
11272 In addition, the prefix is used in an unusual way in finding the
11273 directories to search for header files. For each of the standard
11274 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11275 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11276 replacing that beginning with the specified prefix to produce an
11277 alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
11278 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11279 These alternate directories are searched first; the standard directories
11280 come next.
11281
11282 @item COMPILER_PATH
11283 @findex COMPILER_PATH
11284 The value of @env{COMPILER_PATH} is a colon-separated list of
11285 directories, much like @env{PATH}. GCC tries the directories thus
11286 specified when searching for subprograms, if it can't find the
11287 subprograms using @env{GCC_EXEC_PREFIX}.
11288
11289 @item LIBRARY_PATH
11290 @findex LIBRARY_PATH
11291 The value of @env{LIBRARY_PATH} is a colon-separated list of
11292 directories, much like @env{PATH}. When configured as a native compiler,
11293 GCC tries the directories thus specified when searching for special
11294 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
11295 using GCC also uses these directories when searching for ordinary
11296 libraries for the @option{-l} option (but directories specified with
11297 @option{-L} come first).
11298
11299 @item LANG
11300 @findex LANG
11301 @cindex locale definition
11302 This variable is used to pass locale information to the compiler. One way in
11303 which this information is used is to determine the character set to be used
11304 when character literals, string literals and comments are parsed in C and C++.
11305 When the compiler is configured to allow multibyte characters,
11306 the following values for @env{LANG} are recognized:
11307
11308 @table @samp
11309 @item C-JIS
11310 Recognize JIS characters.
11311 @item C-SJIS
11312 Recognize SJIS characters.
11313 @item C-EUCJP
11314 Recognize EUCJP characters.
11315 @end table
11316
11317 If @env{LANG} is not defined, or if it has some other value, then the
11318 compiler will use mblen and mbtowc as defined by the default locale to
11319 recognize and translate multibyte characters.
11320 @end table
11321
11322 @noindent
11323 Some additional environments variables affect the behavior of the
11324 preprocessor.
11325
11326 @include cppenv.texi
11327
11328 @c man end
11329
11330 @node Precompiled Headers
11331 @section Using Precompiled Headers
11332 @cindex precompiled headers
11333 @cindex speed of compilation
11334
11335 Often large projects have many header files that are included in every
11336 source file. The time the compiler takes to process these header files
11337 over and over again can account for nearly all of the time required to
11338 build the project. To make builds faster, GCC allows users to
11339 `precompile' a header file; then, if builds can use the precompiled
11340 header file they will be much faster.
11341
11342 To create a precompiled header file, simply compile it as you would any
11343 other file, if necessary using the @option{-x} option to make the driver
11344 treat it as a C or C++ header file. You will probably want to use a
11345 tool like @command{make} to keep the precompiled header up-to-date when
11346 the headers it contains change.
11347
11348 A precompiled header file will be searched for when @code{#include} is
11349 seen in the compilation. As it searches for the included file
11350 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11351 compiler looks for a precompiled header in each directory just before it
11352 looks for the include file in that directory. The name searched for is
11353 the name specified in the @code{#include} with @samp{.gch} appended. If
11354 the precompiled header file can't be used, it is ignored.
11355
11356 For instance, if you have @code{#include "all.h"}, and you have
11357 @file{all.h.gch} in the same directory as @file{all.h}, then the
11358 precompiled header file will be used if possible, and the original
11359 header will be used otherwise.
11360
11361 Alternatively, you might decide to put the precompiled header file in a
11362 directory and use @option{-I} to ensure that directory is searched
11363 before (or instead of) the directory containing the original header.
11364 Then, if you want to check that the precompiled header file is always
11365 used, you can put a file of the same name as the original header in this
11366 directory containing an @code{#error} command.
11367
11368 This also works with @option{-include}. So yet another way to use
11369 precompiled headers, good for projects not designed with precompiled
11370 header files in mind, is to simply take most of the header files used by
11371 a project, include them from another header file, precompile that header
11372 file, and @option{-include} the precompiled header. If the header files
11373 have guards against multiple inclusion, they will be skipped because
11374 they've already been included (in the precompiled header).
11375
11376 If you need to precompile the same header file for different
11377 languages, targets, or compiler options, you can instead make a
11378 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11379 header in the directory. (It doesn't matter what you call the files
11380 in the directory, every precompiled header in the directory will be
11381 considered.) The first precompiled header encountered in the
11382 directory that is valid for this compilation will be used; they're
11383 searched in no particular order.
11384
11385 There are many other possibilities, limited only by your imagination,
11386 good sense, and the constraints of your build system.
11387
11388 A precompiled header file can be used only when these conditions apply:
11389
11390 @itemize
11391 @item
11392 Only one precompiled header can be used in a particular compilation.
11393 @item
11394 A precompiled header can't be used once the first C token is seen. You
11395 can have preprocessor directives before a precompiled header; you can
11396 even include a precompiled header from inside another header, so long as
11397 there are no C tokens before the @code{#include}.
11398 @item
11399 The precompiled header file must be produced for the same language as
11400 the current compilation. You can't use a C precompiled header for a C++
11401 compilation.
11402 @item
11403 The precompiled header file must be produced by the same compiler
11404 version and configuration as the current compilation is using.
11405 The easiest way to guarantee this is to use the same compiler binary
11406 for creating and using precompiled headers.
11407 @item
11408 Any macros defined before the precompiled header (including with
11409 @option{-D}) must either be defined in the same way as when the
11410 precompiled header was generated, or must not affect the precompiled
11411 header, which usually means that the they don't appear in the
11412 precompiled header at all.
11413 @item
11414 Certain command-line options must be defined in the same way as when the
11415 precompiled header was generated. At present, it's not clear which
11416 options are safe to change and which are not; the safest choice is to
11417 use exactly the same options when generating and using the precompiled
11418 header.
11419 @end itemize
11420
11421 For all of these but the last, the compiler will automatically ignore
11422 the precompiled header if the conditions aren't met. For the last item,
11423 some option changes will cause the precompiled header to be rejected,
11424 but not all incompatible option combinations have yet been found. If
11425 you find a new incompatible combination, please consider filing a bug
11426 report, see @ref{Bugs}.
11427
11428 @node Running Protoize
11429 @section Running Protoize
11430
11431 The program @code{protoize} is an optional part of GCC@. You can use
11432 it to add prototypes to a program, thus converting the program to ISO
11433 C in one respect. The companion program @code{unprotoize} does the
11434 reverse: it removes argument types from any prototypes that are found.
11435
11436 When you run these programs, you must specify a set of source files as
11437 command line arguments. The conversion programs start out by compiling
11438 these files to see what functions they define. The information gathered
11439 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11440
11441 After scanning comes actual conversion. The specified files are all
11442 eligible to be converted; any files they include (whether sources or
11443 just headers) are eligible as well.
11444
11445 But not all the eligible files are converted. By default,
11446 @code{protoize} and @code{unprotoize} convert only source and header
11447 files in the current directory. You can specify additional directories
11448 whose files should be converted with the @option{-d @var{directory}}
11449 option. You can also specify particular files to exclude with the
11450 @option{-x @var{file}} option. A file is converted if it is eligible, its
11451 directory name matches one of the specified directory names, and its
11452 name within the directory has not been excluded.
11453
11454 Basic conversion with @code{protoize} consists of rewriting most
11455 function definitions and function declarations to specify the types of
11456 the arguments. The only ones not rewritten are those for varargs
11457 functions.
11458
11459 @code{protoize} optionally inserts prototype declarations at the
11460 beginning of the source file, to make them available for any calls that
11461 precede the function's definition. Or it can insert prototype
11462 declarations with block scope in the blocks where undeclared functions
11463 are called.
11464
11465 Basic conversion with @code{unprotoize} consists of rewriting most
11466 function declarations to remove any argument types, and rewriting
11467 function definitions to the old-style pre-ISO form.
11468
11469 Both conversion programs print a warning for any function declaration or
11470 definition that they can't convert. You can suppress these warnings
11471 with @option{-q}.
11472
11473 The output from @code{protoize} or @code{unprotoize} replaces the
11474 original source file. The original file is renamed to a name ending
11475 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11476 without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
11477 for DOS) file already exists, then the source file is simply discarded.
11478
11479 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11480 scan the program and collect information about the functions it uses.
11481 So neither of these programs will work until GCC is installed.
11482
11483 Here is a table of the options you can use with @code{protoize} and
11484 @code{unprotoize}. Each option works with both programs unless
11485 otherwise stated.
11486
11487 @table @code
11488 @item -B @var{directory}
11489 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11490 usual directory (normally @file{/usr/local/lib}). This file contains
11491 prototype information about standard system functions. This option
11492 applies only to @code{protoize}.
11493
11494 @item -c @var{compilation-options}
11495 Use @var{compilation-options} as the options when running @command{gcc} to
11496 produce the @samp{.X} files. The special option @option{-aux-info} is
11497 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11498
11499 Note that the compilation options must be given as a single argument to
11500 @code{protoize} or @code{unprotoize}. If you want to specify several
11501 @command{gcc} options, you must quote the entire set of compilation options
11502 to make them a single word in the shell.
11503
11504 There are certain @command{gcc} arguments that you cannot use, because they
11505 would produce the wrong kind of output. These include @option{-g},
11506 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11507 the @var{compilation-options}, they are ignored.
11508
11509 @item -C
11510 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11511 systems) instead of @samp{.c}. This is convenient if you are converting
11512 a C program to C++. This option applies only to @code{protoize}.
11513
11514 @item -g
11515 Add explicit global declarations. This means inserting explicit
11516 declarations at the beginning of each source file for each function
11517 that is called in the file and was not declared. These declarations
11518 precede the first function definition that contains a call to an
11519 undeclared function. This option applies only to @code{protoize}.
11520
11521 @item -i @var{string}
11522 Indent old-style parameter declarations with the string @var{string}.
11523 This option applies only to @code{protoize}.
11524
11525 @code{unprotoize} converts prototyped function definitions to old-style
11526 function definitions, where the arguments are declared between the
11527 argument list and the initial @samp{@{}. By default, @code{unprotoize}
11528 uses five spaces as the indentation. If you want to indent with just
11529 one space instead, use @option{-i " "}.
11530
11531 @item -k
11532 Keep the @samp{.X} files. Normally, they are deleted after conversion
11533 is finished.
11534
11535 @item -l
11536 Add explicit local declarations. @code{protoize} with @option{-l} inserts
11537 a prototype declaration for each function in each block which calls the
11538 function without any declaration. This option applies only to
11539 @code{protoize}.
11540
11541 @item -n
11542 Make no real changes. This mode just prints information about the conversions
11543 that would have been done without @option{-n}.
11544
11545 @item -N
11546 Make no @samp{.save} files. The original files are simply deleted.
11547 Use this option with caution.
11548
11549 @item -p @var{program}
11550 Use the program @var{program} as the compiler. Normally, the name
11551 @file{gcc} is used.
11552
11553 @item -q
11554 Work quietly. Most warnings are suppressed.
11555
11556 @item -v
11557 Print the version number, just like @option{-v} for @command{gcc}.
11558 @end table
11559
11560 If you need special compiler options to compile one of your program's
11561 source files, then you should generate that file's @samp{.X} file
11562 specially, by running @command{gcc} on that source file with the
11563 appropriate options and the option @option{-aux-info}. Then run
11564 @code{protoize} on the entire set of files. @code{protoize} will use
11565 the existing @samp{.X} file because it is newer than the source file.
11566 For example:
11567
11568 @example
11569 gcc -Dfoo=bar file1.c -aux-info file1.X
11570 protoize *.c
11571 @end example
11572
11573 @noindent
11574 You need to include the special files along with the rest in the
11575 @code{protoize} command, even though their @samp{.X} files already
11576 exist, because otherwise they won't get converted.
11577
11578 @xref{Protoize Caveats}, for more information on how to use
11579 @code{protoize} successfully.