* doc/extend.texi (Blackfin Built-in Functions): New section.
[official-gcc.git] / gcc / doc / invoke.texi
blob0f509d0ce7b43213c5141ffbca2668e7363fbaf4
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
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, 2004, 2005 Free Software Foundation, Inc.
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.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
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{}
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), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @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}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking.  The ``overall options'' allow you to stop this
70 process at an intermediate stage.  For example, the @option{-c} option
71 says not to run the linker.  Then the output consists of object files
72 output by the assembler.
74 Other options are passed on to one stage of processing.  Some options
75 control the preprocessor and others the compiler itself.  Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly.  If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands.  Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments.  For the most part, the order
100 you use doesn't matter.  Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example, 
106 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
109 only one of these two forms, whichever one is not the default.
111 @c man end
113 @xref{Option Index}, for an index to GCC's options.
115 @menu
116 * Option Summary::      Brief list of all options, without explanations.
117 * Overall Options::     Controlling the kind of output:
118                         an executable, object files, assembler files,
119                         or preprocessed source.
120 * Invoking G++::        Compiling C++ programs.
121 * C Dialect Options::   Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124                         and Objective-C++.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
147 @c man begin OPTIONS
149 @node Option Summary
150 @section Option Summary
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char}
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
174 -fconserve-space  -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -fvisibility-inlines-hidden @gol
186 -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo}
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-call-cxx-cdtors @gol
201 -fobjc-direct-dispatch @gol
202 -fobjc-exceptions @gol
203 -fobjc-gc @gol
204 -freplace-objc-classes @gol
205 -fzero-link @gol
206 -gen-decls @gol
207 -Wassign-intercept @gol
208 -Wno-protocol  -Wselector @gol
209 -Wstrict-selector-match @gol
210 -Wundeclared-selector}
212 @item Language Independent Options
213 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
214 @gccoptlist{-fmessage-length=@var{n}  @gol
215 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
216 -fdiagnostics-show-options
218 @item Warning Options
219 @xref{Warning Options,,Options to Request or Suppress Warnings}.
220 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
221 -w  -Wextra  -Wall  -Waggregate-return -Wno-attributes @gol
222 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
223 -Wconversion  -Wno-deprecated-declarations @gol
224 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
225 -Werror  -Werror-implicit-function-declaration @gol
226 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
227 -Wno-format-extra-args -Wformat-nonliteral @gol
228 -Wformat-security  -Wformat-y2k @gol
229 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
230 -Wimport  -Wno-import  -Winit-self  -Winline @gol
231 -Wno-int-to-pointer-cast @gol
232 -Wno-invalid-offsetof  -Winvalid-pch @gol
233 -Wlarger-than-@var{len}  -Wlong-long @gol
234 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
235 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
236 -Wmissing-noreturn @gol
237 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
238 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
239 -Wredundant-decls @gol
240 -Wreturn-type  -Wsequence-point  -Wshadow @gol
241 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
242 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
243 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
244 -Wunknown-pragmas  -Wunreachable-code @gol
245 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
246 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
247 -Wvariadic-macros}
249 @item C-only Warning Options
250 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
251 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
252 -Wstrict-prototypes  -Wtraditional @gol
253 -Wdeclaration-after-statement -Wno-pointer-sign}
255 @item Debugging Options
256 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
257 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
258 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
259 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
260 -fdump-ipa-all -fdump-ipa-cgraph @gol
261 -fdump-tree-all @gol
262 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
263 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
266 -fdump-tree-ch @gol
267 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-nrv -fdump-tree-vect @gol
276 -fdump-tree-sink @gol
277 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-salias @gol
279 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
281 -ftree-vectorizer-verbose=@var{n} @gol
282 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
283 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
284 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
285 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
286 -ftest-coverage  -ftime-report -fvar-tracking @gol
287 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
288 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
289 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
290 -print-multi-directory  -print-multi-lib @gol
291 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
292 -save-temps  -time}
294 @item Optimization Options
295 @xref{Optimize Options,,Options that Control Optimization}.
296 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
297 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
298 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
299 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
300 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
301 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
302 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
303 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
304 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
305 -fforce-addr  -ffunction-sections @gol
306 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
307 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
308 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
309 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
310 -fmodulo-sched -fno-branch-count-reg @gol
311 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
312 -fno-function-cse  -fno-guess-branch-probability @gol
313 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
314 -funsafe-math-optimizations  -ffinite-math-only @gol
315 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
316 -fomit-frame-pointer  -foptimize-register-move @gol
317 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
318 -fprofile-generate -fprofile-use @gol
319 -fregmove  -frename-registers @gol
320 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
321 -frerun-cse-after-loop  -frerun-loop-opt @gol
322 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
323 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
324 -fsched-spec-load-dangerous  @gol
325 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
326 -fsched2-use-superblocks @gol
327 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
328 -fsignaling-nans -fsingle-precision-constant  -fspeculative-prefetching @gol
329 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
330 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
331 -fsplit-ivs-in-unroller -funswitch-loops @gol
332 -fvariable-expansion-in-unroller @gol
333 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
334 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
335 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
336 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
337 -ftree-salias -fweb @gol
338 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
339 --param @var{name}=@var{value}
340 -O  -O0  -O1  -O2  -O3  -Os}
342 @item Preprocessor Options
343 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
344 @gccoptlist{-A@var{question}=@var{answer} @gol
345 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
346 -C  -dD  -dI  -dM  -dN @gol
347 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
348 -idirafter @var{dir} @gol
349 -include @var{file}  -imacros @var{file} @gol
350 -iprefix @var{file}  -iwithprefix @var{dir} @gol
351 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
352 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
353 -P  -fworking-directory  -remap @gol
354 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
355 -Xpreprocessor @var{option}}
357 @item Assembler Option
358 @xref{Assembler Options,,Passing Options to the Assembler}.
359 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
361 @item Linker Options
362 @xref{Link Options,,Options for Linking}.
363 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
364 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
365 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
366 -Wl,@var{option}  -Xlinker @var{option} @gol
367 -u @var{symbol}}
369 @item Directory Options
370 @xref{Directory Options,,Options for Directory Search}.
371 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
373 @item Target Options
374 @c I wrote this xref this way to avoid overfull hbox. -- rms
375 @xref{Target Options}.
376 @gccoptlist{-V @var{version}  -b @var{machine}}
378 @item Machine Dependent Options
379 @xref{Submodel Options,,Hardware Models and Configurations}.
380 @c This list is ordered alphanumerically by subsection name.
381 @c Try and put the significant identifier (CPU or system) first,
382 @c so users have a clue at guessing where the ones they want will be.
384 @emph{ARC Options}
385 @gccoptlist{-EB  -EL @gol
386 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
387 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
389 @emph{ARM Options}
390 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
391 -mabi=@var{name} @gol
392 -mapcs-stack-check  -mno-apcs-stack-check @gol
393 -mapcs-float  -mno-apcs-float @gol
394 -mapcs-reentrant  -mno-apcs-reentrant @gol
395 -msched-prolog  -mno-sched-prolog @gol
396 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
397 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
398 -mthumb-interwork  -mno-thumb-interwork @gol
399 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
400 -mstructure-size-boundary=@var{n} @gol
401 -mabort-on-noreturn @gol
402 -mlong-calls  -mno-long-calls @gol
403 -msingle-pic-base  -mno-single-pic-base @gol
404 -mpic-register=@var{reg} @gol
405 -mnop-fun-dllimport @gol
406 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
407 -mpoke-function-name @gol
408 -mthumb  -marm @gol
409 -mtpcs-frame  -mtpcs-leaf-frame @gol
410 -mcaller-super-interworking  -mcallee-super-interworking}
412 @emph{AVR Options}
413 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
414 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
416 @emph{Blackfin Options}
417 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
418 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
419 -mlow-64k -mno-low64k -mid-shared-library @gol
420 -mno-id-shared-library -mshared-library-id=@var{n} @gol
421 -mlong-calls  -mno-long-calls}
423 @emph{CRIS Options}
424 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
425 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
426 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
427 -mstack-align  -mdata-align  -mconst-align @gol
428 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
429 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
430 -mmul-bug-workaround  -mno-mul-bug-workaround}
432 @emph{Darwin Options}
433 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
434 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
435 -client_name  -compatibility_version  -current_version @gol
436 -dead_strip @gol
437 -dependency-file  -dylib_file  -dylinker_install_name @gol
438 -dynamic  -dynamiclib  -exported_symbols_list @gol
439 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
440 -force_flat_namespace  -headerpad_max_install_names @gol
441 -image_base  -init  -install_name  -keep_private_externs @gol
442 -multi_module  -multiply_defined  -multiply_defined_unused @gol
443 -noall_load   -no_dead_strip_inits_and_terms @gol
444 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
445 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
446 -private_bundle  -read_only_relocs  -sectalign @gol
447 -sectobjectsymbols  -whyload  -seg1addr @gol
448 -sectcreate  -sectobjectsymbols  -sectorder @gol
449 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
450 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
451 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
452 -single_module  -static  -sub_library  -sub_umbrella @gol
453 -twolevel_namespace  -umbrella  -undefined @gol
454 -unexported_symbols_list  -weak_reference_mismatches @gol
455 -whatsloaded -F -gused -gfull -mmacosx-min-version=@var{version} @gol
456 -mone-byte-bool}
458 @emph{DEC Alpha Options}
459 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
460 -mieee  -mieee-with-inexact  -mieee-conformant @gol
461 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
462 -mtrap-precision=@var{mode}  -mbuild-constants @gol
463 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
464 -mbwx  -mmax  -mfix  -mcix @gol
465 -mfloat-vax  -mfloat-ieee @gol
466 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
467 -msmall-text  -mlarge-text @gol
468 -mmemory-latency=@var{time}}
470 @emph{DEC Alpha/VMS Options}
471 @gccoptlist{-mvms-return-codes}
473 @emph{FRV Options}
474 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
475 -mhard-float  -msoft-float @gol
476 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
477 -mdouble  -mno-double @gol
478 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
479 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
480 -mlinked-fp  -mlong-calls  -malign-labels @gol
481 -mlibrary-pic  -macc-4  -macc-8 @gol
482 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
483 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
484 -mvliw-branch  -mno-vliw-branch @gol
485 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
486 -mno-nested-cond-exec  -mtomcat-stats @gol
487 -mTLS -mtls @gol
488 -mcpu=@var{cpu}}
490 @emph{H8/300 Options}
491 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
493 @emph{HPPA Options}
494 @gccoptlist{-march=@var{architecture-type} @gol
495 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
496 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
497 -mfixed-range=@var{register-range} @gol
498 -mjump-in-delay -mlinker-opt -mlong-calls @gol
499 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
500 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
501 -mno-jump-in-delay  -mno-long-load-store @gol
502 -mno-portable-runtime  -mno-soft-float @gol
503 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
504 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
505 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
506 -munix=@var{unix-std}  -nolibdld  -static  -threads}
508 @emph{i386 and x86-64 Options}
509 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
510 -mfpmath=@var{unit} @gol
511 -masm=@var{dialect}  -mno-fancy-math-387 @gol
512 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
513 -mno-wide-multiply  -mrtd  -malign-double @gol
514 -mpreferred-stack-boundary=@var{num} @gol
515 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
516 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
517 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
518 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
519 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
520 -mcmodel=@var{code-model} @gol
521 -m32  -m64}
523 @emph{IA-64 Options}
524 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
525 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
526 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
527 -minline-float-divide-max-throughput @gol
528 -minline-int-divide-min-latency @gol
529 -minline-int-divide-max-throughput  @gol
530 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
531 -mno-dwarf2-asm -mearly-stop-bits @gol
532 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
533 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
535 @emph{M32R/D Options}
536 @gccoptlist{-m32r2 -m32rx -m32r @gol
537 -mdebug @gol
538 -malign-loops -mno-align-loops @gol
539 -missue-rate=@var{number} @gol
540 -mbranch-cost=@var{number} @gol
541 -mmodel=@var{code-size-model-type} @gol
542 -msdata=@var{sdata-type} @gol
543 -mno-flush-func -mflush-func=@var{name} @gol
544 -mno-flush-trap -mflush-trap=@var{number} @gol
545 -G @var{num}}
547 @emph{M680x0 Options}
548 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
549 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
550 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
551 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
552 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
554 @emph{M68hc1x Options}
555 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
556 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
557 -msoft-reg-count=@var{count}}
559 @emph{MCore Options}
560 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
561 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
562 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
563 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
564 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
566 @emph{MIPS Options}
567 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
568 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
569 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
570 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
571 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
572 -mpaired-single  -mips3d @gol
573 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
574 -G@var{num}  -membedded-data  -mno-embedded-data @gol
575 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
576 -msplit-addresses  -mno-split-addresses  @gol
577 -mexplicit-relocs  -mno-explicit-relocs  @gol
578 -mcheck-zero-division  -mno-check-zero-division @gol
579 -mdivide-traps  -mdivide-breaks @gol
580 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
581 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
582 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
583 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
584 -mfix-sb1  -mno-fix-sb1 @gol
585 -mflush-func=@var{func}  -mno-flush-func @gol
586 -mbranch-likely  -mno-branch-likely @gol
587 -mfp-exceptions -mno-fp-exceptions @gol
588 -mvr4130-align -mno-vr4130-align}
590 @emph{MMIX Options}
591 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
592 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
593 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
594 -mno-base-addresses  -msingle-exit  -mno-single-exit}
596 @emph{MN10300 Options}
597 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
598 -mam33  -mno-am33 @gol
599 -mam33-2  -mno-am33-2 @gol
600 -mno-crt0  -mrelax}
602 @emph{NS32K Options}
603 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
604 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
605 -mregparam  -mnoregparam  -msb  -mnosb @gol
606 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
608 @emph{PDP-11 Options}
609 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
610 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
611 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
612 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
613 -mbranch-expensive  -mbranch-cheap @gol
614 -msplit  -mno-split  -munix-asm  -mdec-asm}
616 @emph{PowerPC Options}
617 See RS/6000 and PowerPC Options.
619 @emph{RS/6000 and PowerPC Options}
620 @gccoptlist{-mcpu=@var{cpu-type} @gol
621 -mtune=@var{cpu-type} @gol
622 -mpower  -mno-power  -mpower2  -mno-power2 @gol
623 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
624 -maltivec  -mno-altivec @gol
625 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
626 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
627 -mnew-mnemonics  -mold-mnemonics @gol
628 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
629 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
630 -malign-power  -malign-natural @gol
631 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
632 -mstring  -mno-string  -mupdate  -mno-update @gol
633 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
634 -mstrict-align  -mno-strict-align  -mrelocatable @gol
635 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
636 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
637 -mdynamic-no-pic  -maltivec  -mswdiv @gol
638 -mprioritize-restricted-insns=@var{priority} @gol
639 -msched-costly-dep=@var{dependence_type} @gol
640 -minsert-sched-nops=@var{scheme} @gol
641 -mcall-sysv  -mcall-netbsd @gol
642 -maix-struct-return  -msvr4-struct-return @gol
643 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
644 -misel -mno-isel @gol
645 -misel=yes  -misel=no @gol
646 -mspe -mno-spe @gol
647 -mspe=yes  -mspe=no @gol
648 -mvrsave -mno-vrsave @gol
649 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
650 -mprototype  -mno-prototype @gol
651 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
652 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
654 @emph{S/390 and zSeries Options}
655 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
656 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
657 -mpacked-stack  -mno-packed-stack @gol
658 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
659 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
660 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
661 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
663 @emph{SH Options}
664 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
665 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
666 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
667 -m5-64media  -m5-64media-nofpu @gol
668 -m5-32media  -m5-32media-nofpu @gol
669 -m5-compact  -m5-compact-nofpu @gol
670 -mb  -ml  -mdalign  -mrelax @gol
671 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
672 -mieee  -misize  -mpadstruct  -mspace @gol
673 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
674 -mdivsi3_libfunc=@var{name}  @gol
675 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
676  -minvalid-symbols}
678 @emph{SPARC Options}
679 @gccoptlist{-mcpu=@var{cpu-type} @gol
680 -mtune=@var{cpu-type} @gol
681 -mcmodel=@var{code-model} @gol
682 -m32  -m64  -mapp-regs  -mno-app-regs @gol
683 -mfaster-structs  -mno-faster-structs @gol
684 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
685 -mhard-quad-float  -msoft-quad-float @gol
686 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
687 -mstack-bias  -mno-stack-bias @gol
688 -munaligned-doubles  -mno-unaligned-doubles @gol
689 -mv8plus  -mno-v8plus  -mvis  -mno-vis
690 -threads -pthreads}
692 @emph{System V Options}
693 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
695 @emph{TMS320C3x/C4x Options}
696 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
697 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
698 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
699 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
701 @emph{V850 Options}
702 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
703 -mprolog-function  -mno-prolog-function  -mspace @gol
704 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
705 -mapp-regs  -mno-app-regs @gol
706 -mdisable-callt  -mno-disable-callt @gol
707 -mv850e1 @gol
708 -mv850e @gol
709 -mv850  -mbig-switch}
711 @emph{VAX Options}
712 @gccoptlist{-mg  -mgnu  -munix}
714 @emph{x86-64 Options}
715 See i386 and x86-64 Options.
717 @emph{Xstormy16 Options}
718 @gccoptlist{-msim}
720 @emph{Xtensa Options}
721 @gccoptlist{-mconst16 -mno-const16 @gol
722 -mfused-madd  -mno-fused-madd @gol
723 -mtext-section-literals  -mno-text-section-literals @gol
724 -mtarget-align  -mno-target-align @gol
725 -mlongcalls  -mno-longcalls}
727 @emph{zSeries Options}
728 See S/390 and zSeries Options.
730 @item Code Generation Options
731 @xref{Code Gen Options,,Options for Code Generation Conventions}.
732 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
733 -ffixed-@var{reg}  -fexceptions @gol
734 -fnon-call-exceptions  -funwind-tables @gol
735 -fasynchronous-unwind-tables @gol
736 -finhibit-size-directive  -finstrument-functions @gol
737 -fno-common  -fno-ident @gol
738 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
739 -fno-jump-tables @gol
740 -freg-struct-return  -fshared-data  -fshort-enums @gol
741 -fshort-double  -fshort-wchar @gol
742 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
743 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
744 -fargument-alias  -fargument-noalias @gol
745 -fargument-noalias-global  -fleading-underscore @gol
746 -ftls-model=@var{model} @gol
747 -ftrapv  -fwrapv  -fbounds-check @gol
748 -fvisibility}
749 @end table
751 @menu
752 * Overall Options::     Controlling the kind of output:
753                         an executable, object files, assembler files,
754                         or preprocessed source.
755 * C Dialect Options::   Controlling the variant of C language compiled.
756 * C++ Dialect Options:: Variations on C++.
757 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
758                         and Objective-C++.
759 * Language Independent Options:: Controlling how diagnostics should be
760                         formatted.
761 * Warning Options::     How picky should the compiler be?
762 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
763 * Optimize Options::    How much optimization?
764 * Preprocessor Options:: Controlling header files and macro definitions.
765                          Also, getting dependency information for Make.
766 * Assembler Options::   Passing options to the assembler.
767 * Link Options::        Specifying libraries and so on.
768 * Directory Options::   Where to find header files and libraries.
769                         Where to find the compiler executable files.
770 * Spec Files::          How to pass switches to sub-processes.
771 * Target Options::      Running a cross-compiler, or an old version of GCC.
772 @end menu
774 @node Overall Options
775 @section Options Controlling the Kind of Output
777 Compilation can involve up to four stages: preprocessing, compilation
778 proper, assembly and linking, always in that order.  GCC is capable of
779 preprocessing and compiling several files either into several
780 assembler input files, or into one assembler input file; then each
781 assembler input file produces an object file, and linking combines all
782 the object files (those newly compiled, and those specified as input)
783 into an executable file.
785 @cindex file name suffix
786 For any given input file, the file name suffix determines what kind of
787 compilation is done:
789 @table @gcctabopt
790 @item @var{file}.c
791 C source code which must be preprocessed.
793 @item @var{file}.i
794 C source code which should not be preprocessed.
796 @item @var{file}.ii
797 C++ source code which should not be preprocessed.
799 @item @var{file}.m
800 Objective-C source code.  Note that you must link with the @file{libobjc}
801 library to make an Objective-C program work.
803 @item @var{file}.mi
804 Objective-C source code which should not be preprocessed.
806 @item @var{file}.mm
807 @itemx @var{file}.M
808 Objective-C++ source code.  Note that you must link with the @file{libobjc}
809 library to make an Objective-C++ program work.  Note that @samp{.M} refers
810 to a literal capital M@.
812 @item @var{file}.mii
813 Objective-C++ source code which should not be preprocessed.
815 @item @var{file}.h
816 C, C++, Objective-C or Objective-C++ header file to be turned into a
817 precompiled header.
819 @item @var{file}.cc
820 @itemx @var{file}.cp
821 @itemx @var{file}.cxx
822 @itemx @var{file}.cpp
823 @itemx @var{file}.CPP
824 @itemx @var{file}.c++
825 @itemx @var{file}.C
826 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
827 the last two letters must both be literally @samp{x}.  Likewise,
828 @samp{.C} refers to a literal capital C@.
830 @item @var{file}.mm
831 @itemx @var{file}.M
832 Objective-C++ source code which must be preprocessed.
834 @item @var{file}.mii
835 Objective-C++ source code which should not be preprocessed.
837 @item @var{file}.hh
838 @itemx @var{file}.H
839 C++ header file to be turned into a precompiled header.
841 @item @var{file}.f
842 @itemx @var{file}.for
843 @itemx @var{file}.FOR
844 Fortran source code which should not be preprocessed.
846 @item @var{file}.F
847 @itemx @var{file}.fpp
848 @itemx @var{file}.FPP
849 Fortran source code which must be preprocessed (with the traditional
850 preprocessor).
852 @item @var{file}.r
853 Fortran source code which must be preprocessed with a RATFOR
854 preprocessor (not included with GCC)@.
856 @item @var{file}.f90
857 @itemx @var{file}.f95
858 Fortran 90/95 source code which should not be preprocessed.
860 @c FIXME: Descriptions of Java file types.
861 @c @var{file}.java
862 @c @var{file}.class
863 @c @var{file}.zip
864 @c @var{file}.jar
866 @item @var{file}.ads
867 Ada source code file which contains a library unit declaration (a
868 declaration of a package, subprogram, or generic, or a generic
869 instantiation), or a library unit renaming declaration (a package,
870 generic, or subprogram renaming declaration).  Such files are also
871 called @dfn{specs}.
873 @itemx @var{file}.adb
874 Ada source code file containing a library unit body (a subprogram or
875 package body).  Such files are also called @dfn{bodies}.
877 @c GCC also knows about some suffixes for languages not yet included:
878 @c Pascal:
879 @c @var{file}.p
880 @c @var{file}.pas
882 @item @var{file}.s
883 Assembler code.
885 @item @var{file}.S
886 Assembler code which must be preprocessed.
888 @item @var{other}
889 An object file to be fed straight into linking.
890 Any file name with no recognized suffix is treated this way.
891 @end table
893 @opindex x
894 You can specify the input language explicitly with the @option{-x} option:
896 @table @gcctabopt
897 @item -x @var{language}
898 Specify explicitly the @var{language} for the following input files
899 (rather than letting the compiler choose a default based on the file
900 name suffix).  This option applies to all following input files until
901 the next @option{-x} option.  Possible values for @var{language} are:
902 @smallexample
903 c  c-header  c-cpp-output
904 c++  c++-header  c++-cpp-output
905 objective-c  objective-c-header  objective-c-cpp-output
906 objective-c++ objective-c++-header objective-c++-cpp-output
907 assembler  assembler-with-cpp
909 f77  f77-cpp-input  ratfor
911 java
912 treelang
913 @end smallexample
915 @item -x none
916 Turn off any specification of a language, so that subsequent files are
917 handled according to their file name suffixes (as they are if @option{-x}
918 has not been used at all).
920 @item -pass-exit-codes
921 @opindex pass-exit-codes
922 Normally the @command{gcc} program will exit with the code of 1 if any
923 phase of the compiler returns a non-success return code.  If you specify
924 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
925 numerically highest error produced by any phase that returned an error
926 indication.
927 @end table
929 If you only want some of the stages of compilation, you can use
930 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
931 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
932 @command{gcc} is to stop.  Note that some combinations (for example,
933 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
935 @table @gcctabopt
936 @item -c
937 @opindex c
938 Compile or assemble the source files, but do not link.  The linking
939 stage simply is not done.  The ultimate output is in the form of an
940 object file for each source file.
942 By default, the object file name for a source file is made by replacing
943 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
945 Unrecognized input files, not requiring compilation or assembly, are
946 ignored.
948 @item -S
949 @opindex S
950 Stop after the stage of compilation proper; do not assemble.  The output
951 is in the form of an assembler code file for each non-assembler input
952 file specified.
954 By default, the assembler file name for a source file is made by
955 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
957 Input files that don't require compilation are ignored.
959 @item -E
960 @opindex E
961 Stop after the preprocessing stage; do not run the compiler proper.  The
962 output is in the form of preprocessed source code, which is sent to the
963 standard output.
965 Input files which don't require preprocessing are ignored.
967 @cindex output file option
968 @item -o @var{file}
969 @opindex o
970 Place output in file @var{file}.  This applies regardless to whatever
971 sort of output is being produced, whether it be an executable file,
972 an object file, an assembler file or preprocessed C code.
974 If @option{-o} is not specified, the default is to put an executable
975 file in @file{a.out}, the object file for
976 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
977 assembler file in @file{@var{source}.s}, a precompiled header file in
978 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
979 standard output.
981 @item -v
982 @opindex v
983 Print (on standard error output) the commands executed to run the stages
984 of compilation.  Also print the version number of the compiler driver
985 program and of the preprocessor and the compiler proper.
987 @item -###
988 @opindex ###
989 Like @option{-v} except the commands are not executed and all command
990 arguments are quoted.  This is useful for shell scripts to capture the
991 driver-generated command lines.
993 @item -pipe
994 @opindex pipe
995 Use pipes rather than temporary files for communication between the
996 various stages of compilation.  This fails to work on some systems where
997 the assembler is unable to read from a pipe; but the GNU assembler has
998 no trouble.
1000 @item -combine
1001 @opindex combine
1002 If you are compiling multiple source files, this option tells the driver
1003 to pass all the source files to the compiler at once (for those
1004 languages for which the compiler can handle this).  This will allow
1005 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1006 language for which this is supported is C@.  If you pass source files for
1007 multiple languages to the driver, using this option, the driver will invoke
1008 the compiler(s) that support IMA once each, passing each compiler all the
1009 source files appropriate for it.  For those languages that do not support
1010 IMA this option will be ignored, and the compiler will be invoked once for
1011 each source file in that language.  If you use this option in conjunction
1012 with @option{-save-temps}, the compiler will generate multiple
1013 pre-processed files
1014 (one for each source file), but only one (combined) @file{.o} or
1015 @file{.s} file.
1017 @item --help
1018 @opindex help
1019 Print (on the standard output) a description of the command line options
1020 understood by @command{gcc}.  If the @option{-v} option is also specified
1021 then @option{--help} will also be passed on to the various processes
1022 invoked by @command{gcc}, so that they can display the command line options
1023 they accept.  If the @option{-Wextra} option is also specified then command
1024 line options which have no documentation associated with them will also
1025 be displayed.
1027 @item --target-help
1028 @opindex target-help
1029 Print (on the standard output) a description of target specific command
1030 line options for each tool.
1032 @item --version
1033 @opindex version
1034 Display the version number and copyrights of the invoked GCC@.
1035 @end table
1037 @node Invoking G++
1038 @section Compiling C++ Programs
1040 @cindex suffixes for C++ source
1041 @cindex C++ source file suffixes
1042 C++ source files conventionally use one of the suffixes @samp{.C},
1043 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1044 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1045 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1046 files with these names and compiles them as C++ programs even if you
1047 call the compiler the same way as for compiling C programs (usually
1048 with the name @command{gcc}).
1050 @findex g++
1051 @findex c++
1052 However, C++ programs often require class libraries as well as a
1053 compiler that understands the C++ language---and under some
1054 circumstances, you might want to compile programs or header files from
1055 standard input, or otherwise without a suffix that flags them as C++
1056 programs.  You might also like to precompile a C header file with a
1057 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1058 program that calls GCC with the default language set to C++, and
1059 automatically specifies linking against the C++ library.  On many
1060 systems, @command{g++} is also installed with the name @command{c++}.
1062 @cindex invoking @command{g++}
1063 When you compile C++ programs, you may specify many of the same
1064 command-line options that you use for compiling programs in any
1065 language; or command-line options meaningful for C and related
1066 languages; or options that are meaningful only for C++ programs.
1067 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1068 explanations of options for languages related to C@.
1069 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1070 explanations of options that are meaningful only for C++ programs.
1072 @node C Dialect Options
1073 @section Options Controlling C Dialect
1074 @cindex dialect options
1075 @cindex language dialect options
1076 @cindex options, dialect
1078 The following options control the dialect of C (or languages derived
1079 from C, such as C++, Objective-C and Objective-C++) that the compiler
1080 accepts:
1082 @table @gcctabopt
1083 @cindex ANSI support
1084 @cindex ISO support
1085 @item -ansi
1086 @opindex ansi
1087 In C mode, support all ISO C90 programs.  In C++ mode,
1088 remove GNU extensions that conflict with ISO C++.
1090 This turns off certain features of GCC that are incompatible with ISO
1091 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1092 such as the @code{asm} and @code{typeof} keywords, and
1093 predefined macros such as @code{unix} and @code{vax} that identify the
1094 type of system you are using.  It also enables the undesirable and
1095 rarely used ISO trigraph feature.  For the C compiler,
1096 it disables recognition of C++ style @samp{//} comments as well as
1097 the @code{inline} keyword.
1099 The alternate keywords @code{__asm__}, @code{__extension__},
1100 @code{__inline__} and @code{__typeof__} continue to work despite
1101 @option{-ansi}.  You would not want to use them in an ISO C program, of
1102 course, but it is useful to put them in header files that might be included
1103 in compilations done with @option{-ansi}.  Alternate predefined macros
1104 such as @code{__unix__} and @code{__vax__} are also available, with or
1105 without @option{-ansi}.
1107 The @option{-ansi} option does not cause non-ISO programs to be
1108 rejected gratuitously.  For that, @option{-pedantic} is required in
1109 addition to @option{-ansi}.  @xref{Warning Options}.
1111 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1112 option is used.  Some header files may notice this macro and refrain
1113 from declaring certain functions or defining certain macros that the
1114 ISO standard doesn't call for; this is to avoid interfering with any
1115 programs that might use these names for other things.
1117 Functions which would normally be built in but do not have semantics
1118 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1119 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1120 built-in functions provided by GCC}, for details of the functions
1121 affected.
1123 @item -std=
1124 @opindex std
1125 Determine the language standard.  This option is currently only
1126 supported when compiling C or C++.  A value for this option must be
1127 provided; possible values are
1129 @table @samp
1130 @item c89
1131 @itemx iso9899:1990
1132 ISO C90 (same as @option{-ansi}).
1134 @item iso9899:199409
1135 ISO C90 as modified in amendment 1.
1137 @item c99
1138 @itemx c9x
1139 @itemx iso9899:1999
1140 @itemx iso9899:199x
1141 ISO C99.  Note that this standard is not yet fully supported; see
1142 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1143 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1145 @item gnu89
1146 Default, ISO C90 plus GNU extensions (including some C99 features).
1148 @item gnu99
1149 @itemx gnu9x
1150 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1151 this will become the default.  The name @samp{gnu9x} is deprecated.
1153 @item c++98
1154 The 1998 ISO C++ standard plus amendments.
1156 @item gnu++98
1157 The same as @option{-std=c++98} plus GNU extensions.  This is the
1158 default for C++ code.
1159 @end table
1161 Even when this option is not specified, you can still use some of the
1162 features of newer standards in so far as they do not conflict with
1163 previous C standards.  For example, you may use @code{__restrict__} even
1164 when @option{-std=c99} is not specified.
1166 The @option{-std} options specifying some version of ISO C have the same
1167 effects as @option{-ansi}, except that features that were not in ISO C90
1168 but are in the specified version (for example, @samp{//} comments and
1169 the @code{inline} keyword in ISO C99) are not disabled.
1171 @xref{Standards,,Language Standards Supported by GCC}, for details of
1172 these standard versions.
1174 @item -aux-info @var{filename}
1175 @opindex aux-info
1176 Output to the given filename prototyped declarations for all functions
1177 declared and/or defined in a translation unit, including those in header
1178 files.  This option is silently ignored in any language other than C@.
1180 Besides declarations, the file indicates, in comments, the origin of
1181 each declaration (source file and line), whether the declaration was
1182 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1183 @samp{O} for old, respectively, in the first character after the line
1184 number and the colon), and whether it came from a declaration or a
1185 definition (@samp{C} or @samp{F}, respectively, in the following
1186 character).  In the case of function definitions, a K&R-style list of
1187 arguments followed by their declarations is also provided, inside
1188 comments, after the declaration.
1190 @item -fno-asm
1191 @opindex fno-asm
1192 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1193 keyword, so that code can use these words as identifiers.  You can use
1194 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1195 instead.  @option{-ansi} implies @option{-fno-asm}.
1197 In C++, this switch only affects the @code{typeof} keyword, since
1198 @code{asm} and @code{inline} are standard keywords.  You may want to
1199 use the @option{-fno-gnu-keywords} flag instead, which has the same
1200 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1201 switch only affects the @code{asm} and @code{typeof} keywords, since
1202 @code{inline} is a standard keyword in ISO C99.
1204 @item -fno-builtin
1205 @itemx -fno-builtin-@var{function}
1206 @opindex fno-builtin
1207 @cindex built-in functions
1208 Don't recognize built-in functions that do not begin with
1209 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1210 functions provided by GCC}, for details of the functions affected,
1211 including those which are not built-in functions when @option{-ansi} or
1212 @option{-std} options for strict ISO C conformance are used because they
1213 do not have an ISO standard meaning.
1215 GCC normally generates special code to handle certain built-in functions
1216 more efficiently; for instance, calls to @code{alloca} may become single
1217 instructions that adjust the stack directly, and calls to @code{memcpy}
1218 may become inline copy loops.  The resulting code is often both smaller
1219 and faster, but since the function calls no longer appear as such, you
1220 cannot set a breakpoint on those calls, nor can you change the behavior
1221 of the functions by linking with a different library.  In addition,
1222 when a function is recognized as a built-in function, GCC may use
1223 information about that function to warn about problems with calls to
1224 that function, or to generate more efficient code, even if the
1225 resulting code still contains calls to that function.  For example,
1226 warnings are given with @option{-Wformat} for bad calls to
1227 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1228 known not to modify global memory.
1230 With the @option{-fno-builtin-@var{function}} option
1231 only the built-in function @var{function} is
1232 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1233 function is named this is not built-in in this version of GCC, this
1234 option is ignored.  There is no corresponding
1235 @option{-fbuiltin-@var{function}} option; if you wish to enable
1236 built-in functions selectively when using @option{-fno-builtin} or
1237 @option{-ffreestanding}, you may define macros such as:
1239 @smallexample
1240 #define abs(n)          __builtin_abs ((n))
1241 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1242 @end smallexample
1244 @item -fhosted
1245 @opindex fhosted
1246 @cindex hosted environment
1248 Assert that compilation takes place in a hosted environment.  This implies
1249 @option{-fbuiltin}.  A hosted environment is one in which the
1250 entire standard library is available, and in which @code{main} has a return
1251 type of @code{int}.  Examples are nearly everything except a kernel.
1252 This is equivalent to @option{-fno-freestanding}.
1254 @item -ffreestanding
1255 @opindex ffreestanding
1256 @cindex hosted environment
1258 Assert that compilation takes place in a freestanding environment.  This
1259 implies @option{-fno-builtin}.  A freestanding environment
1260 is one in which the standard library may not exist, and program startup may
1261 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1262 This is equivalent to @option{-fno-hosted}.
1264 @xref{Standards,,Language Standards Supported by GCC}, for details of
1265 freestanding and hosted environments.
1267 @item -fms-extensions
1268 @opindex fms-extensions
1269 Accept some non-standard constructs used in Microsoft header files.
1271 Some cases of unnamed fields in structures and unions are only
1272 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1273 fields within structs/unions}, for details.
1275 @item -trigraphs
1276 @opindex trigraphs
1277 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1278 options for strict ISO C conformance) implies @option{-trigraphs}.
1280 @item -no-integrated-cpp
1281 @opindex no-integrated-cpp
1282 Performs a compilation in two passes: preprocessing and compiling.  This
1283 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1284 @option{-B} option.  The user supplied compilation step can then add in
1285 an additional preprocessing step after normal preprocessing but before
1286 compiling.  The default is to use the integrated cpp (internal cpp)
1288 The semantics of this option will change if "cc1", "cc1plus", and
1289 "cc1obj" are merged.
1291 @cindex traditional C language
1292 @cindex C language, traditional
1293 @item -traditional
1294 @itemx -traditional-cpp
1295 @opindex traditional-cpp
1296 @opindex traditional
1297 Formerly, these options caused GCC to attempt to emulate a pre-standard
1298 C compiler.  They are now only supported with the @option{-E} switch.
1299 The preprocessor continues to support a pre-standard mode.  See the GNU
1300 CPP manual for details.
1302 @item -fcond-mismatch
1303 @opindex fcond-mismatch
1304 Allow conditional expressions with mismatched types in the second and
1305 third arguments.  The value of such an expression is void.  This option
1306 is not supported for C++.
1308 @item -funsigned-char
1309 @opindex funsigned-char
1310 Let the type @code{char} be unsigned, like @code{unsigned char}.
1312 Each kind of machine has a default for what @code{char} should
1313 be.  It is either like @code{unsigned char} by default or like
1314 @code{signed char} by default.
1316 Ideally, a portable program should always use @code{signed char} or
1317 @code{unsigned char} when it depends on the signedness of an object.
1318 But many programs have been written to use plain @code{char} and
1319 expect it to be signed, or expect it to be unsigned, depending on the
1320 machines they were written for.  This option, and its inverse, let you
1321 make such a program work with the opposite default.
1323 The type @code{char} is always a distinct type from each of
1324 @code{signed char} or @code{unsigned char}, even though its behavior
1325 is always just like one of those two.
1327 @item -fsigned-char
1328 @opindex fsigned-char
1329 Let the type @code{char} be signed, like @code{signed char}.
1331 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1332 the negative form of @option{-funsigned-char}.  Likewise, the option
1333 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1335 @item -fsigned-bitfields
1336 @itemx -funsigned-bitfields
1337 @itemx -fno-signed-bitfields
1338 @itemx -fno-unsigned-bitfields
1339 @opindex fsigned-bitfields
1340 @opindex funsigned-bitfields
1341 @opindex fno-signed-bitfields
1342 @opindex fno-unsigned-bitfields
1343 These options control whether a bit-field is signed or unsigned, when the
1344 declaration does not use either @code{signed} or @code{unsigned}.  By
1345 default, such a bit-field is signed, because this is consistent: the
1346 basic integer types such as @code{int} are signed types.
1347 @end table
1349 @node C++ Dialect Options
1350 @section Options Controlling C++ Dialect
1352 @cindex compiler options, C++
1353 @cindex C++ options, command line
1354 @cindex options, C++
1355 This section describes the command-line options that are only meaningful
1356 for C++ programs; but you can also use most of the GNU compiler options
1357 regardless of what language your program is in.  For example, you
1358 might compile a file @code{firstClass.C} like this:
1360 @smallexample
1361 g++ -g -frepo -O -c firstClass.C
1362 @end smallexample
1364 @noindent
1365 In this example, only @option{-frepo} is an option meant
1366 only for C++ programs; you can use the other options with any
1367 language supported by GCC@.
1369 Here is a list of options that are @emph{only} for compiling C++ programs:
1371 @table @gcctabopt
1373 @item -fabi-version=@var{n}
1374 @opindex fabi-version
1375 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1376 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1377 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1378 the version that conforms most closely to the C++ ABI specification.
1379 Therefore, the ABI obtained using version 0 will change as ABI bugs
1380 are fixed.
1382 The default is version 2.
1384 @item -fno-access-control
1385 @opindex fno-access-control
1386 Turn off all access checking.  This switch is mainly useful for working
1387 around bugs in the access control code.
1389 @item -fcheck-new
1390 @opindex fcheck-new
1391 Check that the pointer returned by @code{operator new} is non-null
1392 before attempting to modify the storage allocated.  This check is
1393 normally unnecessary because the C++ standard specifies that
1394 @code{operator new} will only return @code{0} if it is declared
1395 @samp{throw()}, in which case the compiler will always check the
1396 return value even without this option.  In all other cases, when
1397 @code{operator new} has a non-empty exception specification, memory
1398 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1399 @samp{new (nothrow)}.
1401 @item -fconserve-space
1402 @opindex fconserve-space
1403 Put uninitialized or runtime-initialized global variables into the
1404 common segment, as C does.  This saves space in the executable at the
1405 cost of not diagnosing duplicate definitions.  If you compile with this
1406 flag and your program mysteriously crashes after @code{main()} has
1407 completed, you may have an object that is being destroyed twice because
1408 two definitions were merged.
1410 This option is no longer useful on most targets, now that support has
1411 been added for putting variables into BSS without making them common.
1413 @item -fno-const-strings
1414 @opindex fno-const-strings
1415 Give string constants type @code{char *} instead of type @code{const
1416 char *}.  By default, G++ uses type @code{const char *} as required by
1417 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1418 actually modify the value of a string constant.
1420 This option might be removed in a future release of G++.  For maximum
1421 portability, you should structure your code so that it works with
1422 string constants that have type @code{const char *}.
1424 @item -fno-elide-constructors
1425 @opindex fno-elide-constructors
1426 The C++ standard allows an implementation to omit creating a temporary
1427 which is only used to initialize another object of the same type.
1428 Specifying this option disables that optimization, and forces G++ to
1429 call the copy constructor in all cases.
1431 @item -fno-enforce-eh-specs
1432 @opindex fno-enforce-eh-specs
1433 Don't check for violation of exception specifications at runtime.  This
1434 option violates the C++ standard, but may be useful for reducing code
1435 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1436 will still optimize based on the exception specifications.
1438 @item -ffor-scope
1439 @itemx -fno-for-scope
1440 @opindex ffor-scope
1441 @opindex fno-for-scope
1442 If @option{-ffor-scope} is specified, the scope of variables declared in
1443 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1444 as specified by the C++ standard.
1445 If @option{-fno-for-scope} is specified, the scope of variables declared in
1446 a @i{for-init-statement} extends to the end of the enclosing scope,
1447 as was the case in old versions of G++, and other (traditional)
1448 implementations of C++.
1450 The default if neither flag is given to follow the standard,
1451 but to allow and give a warning for old-style code that would
1452 otherwise be invalid, or have different behavior.
1454 @item -fno-gnu-keywords
1455 @opindex fno-gnu-keywords
1456 Do not recognize @code{typeof} as a keyword, so that code can use this
1457 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1458 @option{-ansi} implies @option{-fno-gnu-keywords}.
1460 @item -fno-implicit-templates
1461 @opindex fno-implicit-templates
1462 Never emit code for non-inline templates which are instantiated
1463 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1464 @xref{Template Instantiation}, for more information.
1466 @item -fno-implicit-inline-templates
1467 @opindex fno-implicit-inline-templates
1468 Don't emit code for implicit instantiations of inline templates, either.
1469 The default is to handle inlines differently so that compiles with and
1470 without optimization will need the same set of explicit instantiations.
1472 @item -fno-implement-inlines
1473 @opindex fno-implement-inlines
1474 To save space, do not emit out-of-line copies of inline functions
1475 controlled by @samp{#pragma implementation}.  This will cause linker
1476 errors if these functions are not inlined everywhere they are called.
1478 @item -fms-extensions
1479 @opindex fms-extensions
1480 Disable pedantic warnings about constructs used in MFC, such as implicit
1481 int and getting a pointer to member function via non-standard syntax.
1483 @item -fno-nonansi-builtins
1484 @opindex fno-nonansi-builtins
1485 Disable built-in declarations of functions that are not mandated by
1486 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1487 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1489 @item -fno-operator-names
1490 @opindex fno-operator-names
1491 Do not treat the operator name keywords @code{and}, @code{bitand},
1492 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1493 synonyms as keywords.
1495 @item -fno-optional-diags
1496 @opindex fno-optional-diags
1497 Disable diagnostics that the standard says a compiler does not need to
1498 issue.  Currently, the only such diagnostic issued by G++ is the one for
1499 a name having multiple meanings within a class.
1501 @item -fpermissive
1502 @opindex fpermissive
1503 Downgrade some diagnostics about nonconformant code from errors to
1504 warnings.  Thus, using @option{-fpermissive} will allow some
1505 nonconforming code to compile.
1507 @item -frepo
1508 @opindex frepo
1509 Enable automatic template instantiation at link time.  This option also
1510 implies @option{-fno-implicit-templates}.  @xref{Template
1511 Instantiation}, for more information.
1513 @item -fno-rtti
1514 @opindex fno-rtti
1515 Disable generation of information about every class with virtual
1516 functions for use by the C++ runtime type identification features
1517 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1518 of the language, you can save some space by using this flag.  Note that
1519 exception handling uses the same information, but it will generate it as
1520 needed.
1522 @item -fstats
1523 @opindex fstats
1524 Emit statistics about front-end processing at the end of the compilation.
1525 This information is generally only useful to the G++ development team.
1527 @item -ftemplate-depth-@var{n}
1528 @opindex ftemplate-depth
1529 Set the maximum instantiation depth for template classes to @var{n}.
1530 A limit on the template instantiation depth is needed to detect
1531 endless recursions during template class instantiation.  ANSI/ISO C++
1532 conforming programs must not rely on a maximum depth greater than 17.
1534 @item -fno-threadsafe-statics
1535 @opindex fno-threadsafe-statics
1536 Do not emit the extra code to use the routines specified in the C++
1537 ABI for thread-safe initialization of local statics.  You can use this
1538 option to reduce code size slightly in code that doesn't need to be
1539 thread-safe.
1541 @item -fuse-cxa-atexit
1542 @opindex fuse-cxa-atexit
1543 Register destructors for objects with static storage duration with the
1544 @code{__cxa_atexit} function rather than the @code{atexit} function.
1545 This option is required for fully standards-compliant handling of static
1546 destructors, but will only work if your C library supports
1547 @code{__cxa_atexit}.
1549 @item -fvisibility-inlines-hidden
1550 @opindex fvisibility-inlines-hidden
1551 Causes all inlined methods to be marked with
1552 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1553 appear in the export table of a DSO and do not require a PLT indirection
1554 when used within the DSO@.  Enabling this option can have a dramatic effect
1555 on load and link times of a DSO as it massively reduces the size of the
1556 dynamic export table when the library makes heavy use of templates.  While
1557 it can cause bloating through duplication of code within each DSO where
1558 it is used, often the wastage is less than the considerable space occupied
1559 by a long symbol name in the export table which is typical when using
1560 templates and namespaces.  For even more savings, combine with the
1561 @option{-fvisibility=hidden} switch.
1563 @item -fno-weak
1564 @opindex fno-weak
1565 Do not use weak symbol support, even if it is provided by the linker.
1566 By default, G++ will use weak symbols if they are available.  This
1567 option exists only for testing, and should not be used by end-users;
1568 it will result in inferior code and has no benefits.  This option may
1569 be removed in a future release of G++.
1571 @item -nostdinc++
1572 @opindex nostdinc++
1573 Do not search for header files in the standard directories specific to
1574 C++, but do still search the other standard directories.  (This option
1575 is used when building the C++ library.)
1576 @end table
1578 In addition, these optimization, warning, and code generation options
1579 have meanings only for C++ programs:
1581 @table @gcctabopt
1582 @item -fno-default-inline
1583 @opindex fno-default-inline
1584 Do not assume @samp{inline} for functions defined inside a class scope.
1585 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1586 functions will have linkage like inline functions; they just won't be
1587 inlined by default.
1589 @item -Wabi @r{(C++ only)}
1590 @opindex Wabi
1591 Warn when G++ generates code that is probably not compatible with the
1592 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1593 all such cases, there are probably some cases that are not warned about,
1594 even though G++ is generating incompatible code.  There may also be
1595 cases where warnings are emitted even though the code that is generated
1596 will be compatible.
1598 You should rewrite your code to avoid these warnings if you are
1599 concerned about the fact that code generated by G++ may not be binary
1600 compatible with code generated by other compilers.
1602 The known incompatibilities at this point include:
1604 @itemize @bullet
1606 @item
1607 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1608 pack data into the same byte as a base class.  For example:
1610 @smallexample
1611 struct A @{ virtual void f(); int f1 : 1; @};
1612 struct B : public A @{ int f2 : 1; @};
1613 @end smallexample
1615 @noindent
1616 In this case, G++ will place @code{B::f2} into the same byte
1617 as@code{A::f1}; other compilers will not.  You can avoid this problem
1618 by explicitly padding @code{A} so that its size is a multiple of the
1619 byte size on your platform; that will cause G++ and other compilers to
1620 layout @code{B} identically.
1622 @item
1623 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1624 tail padding when laying out virtual bases.  For example:
1626 @smallexample
1627 struct A @{ virtual void f(); char c1; @};
1628 struct B @{ B(); char c2; @};
1629 struct C : public A, public virtual B @{@};
1630 @end smallexample
1632 @noindent
1633 In this case, G++ will not place @code{B} into the tail-padding for
1634 @code{A}; other compilers will.  You can avoid this problem by
1635 explicitly padding @code{A} so that its size is a multiple of its
1636 alignment (ignoring virtual base classes); that will cause G++ and other
1637 compilers to layout @code{C} identically.
1639 @item
1640 Incorrect handling of bit-fields with declared widths greater than that
1641 of their underlying types, when the bit-fields appear in a union.  For
1642 example:
1644 @smallexample
1645 union U @{ int i : 4096; @};
1646 @end smallexample
1648 @noindent
1649 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1650 union too small by the number of bits in an @code{int}.
1652 @item
1653 Empty classes can be placed at incorrect offsets.  For example:
1655 @smallexample
1656 struct A @{@};
1658 struct B @{
1659   A a;
1660   virtual void f ();
1663 struct C : public B, public A @{@};
1664 @end smallexample
1666 @noindent
1667 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1668 it should be placed at offset zero.  G++ mistakenly believes that the
1669 @code{A} data member of @code{B} is already at offset zero.
1671 @item
1672 Names of template functions whose types involve @code{typename} or
1673 template template parameters can be mangled incorrectly.
1675 @smallexample
1676 template <typename Q>
1677 void f(typename Q::X) @{@}
1679 template <template <typename> class Q>
1680 void f(typename Q<int>::X) @{@}
1681 @end smallexample
1683 @noindent
1684 Instantiations of these templates may be mangled incorrectly.
1686 @end itemize
1688 @item -Wctor-dtor-privacy @r{(C++ only)}
1689 @opindex Wctor-dtor-privacy
1690 Warn when a class seems unusable because all the constructors or
1691 destructors in that class are private, and it has neither friends nor
1692 public static member functions.
1694 @item -Wnon-virtual-dtor @r{(C++ only)}
1695 @opindex Wnon-virtual-dtor
1696 Warn when a class appears to be polymorphic, thereby requiring a virtual
1697 destructor, yet it declares a non-virtual one.
1698 This warning is enabled by @option{-Wall}.
1700 @item -Wreorder @r{(C++ only)}
1701 @opindex Wreorder
1702 @cindex reordering, warning
1703 @cindex warning for reordering of member initializers
1704 Warn when the order of member initializers given in the code does not
1705 match the order in which they must be executed.  For instance:
1707 @smallexample
1708 struct A @{
1709   int i;
1710   int j;
1711   A(): j (0), i (1) @{ @}
1713 @end smallexample
1715 The compiler will rearrange the member initializers for @samp{i}
1716 and @samp{j} to match the declaration order of the members, emitting
1717 a warning to that effect.  This warning is enabled by @option{-Wall}.
1718 @end table
1720 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1722 @table @gcctabopt
1723 @item -Weffc++ @r{(C++ only)}
1724 @opindex Weffc++
1725 Warn about violations of the following style guidelines from Scott Meyers'
1726 @cite{Effective C++} book:
1728 @itemize @bullet
1729 @item
1730 Item 11:  Define a copy constructor and an assignment operator for classes
1731 with dynamically allocated memory.
1733 @item
1734 Item 12:  Prefer initialization to assignment in constructors.
1736 @item
1737 Item 14:  Make destructors virtual in base classes.
1739 @item
1740 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1742 @item
1743 Item 23:  Don't try to return a reference when you must return an object.
1745 @end itemize
1747 Also warn about violations of the following style guidelines from
1748 Scott Meyers' @cite{More Effective C++} book:
1750 @itemize @bullet
1751 @item
1752 Item 6:  Distinguish between prefix and postfix forms of increment and
1753 decrement operators.
1755 @item
1756 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1758 @end itemize
1760 When selecting this option, be aware that the standard library
1761 headers do not obey all of these guidelines; use @samp{grep -v}
1762 to filter out those warnings.
1764 @item -Wno-deprecated @r{(C++ only)}
1765 @opindex Wno-deprecated
1766 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1768 @item -Wstrict-null-sentinel @r{(C++ only)}
1769 @opindex Wstrict-null-sentinel
1770 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1771 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1772 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1773 it is guaranteed to of the same size as a pointer.  But this use is
1774 not portable across different compilers.
1776 @item -Wno-non-template-friend @r{(C++ only)}
1777 @opindex Wno-non-template-friend
1778 Disable warnings when non-templatized friend functions are declared
1779 within a template.  Since the advent of explicit template specification
1780 support in G++, if the name of the friend is an unqualified-id (i.e.,
1781 @samp{friend foo(int)}), the C++ language specification demands that the
1782 friend declare or define an ordinary, nontemplate function.  (Section
1783 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1784 could be interpreted as a particular specialization of a templatized
1785 function.  Because this non-conforming behavior is no longer the default
1786 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1787 check existing code for potential trouble spots and is on by default.
1788 This new compiler behavior can be turned off with
1789 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1790 but disables the helpful warning.
1792 @item -Wold-style-cast @r{(C++ only)}
1793 @opindex Wold-style-cast
1794 Warn if an old-style (C-style) cast to a non-void type is used within
1795 a C++ program.  The new-style casts (@samp{static_cast},
1796 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1797 unintended effects and much easier to search for.
1799 @item -Woverloaded-virtual @r{(C++ only)}
1800 @opindex Woverloaded-virtual
1801 @cindex overloaded virtual fn, warning
1802 @cindex warning for overloaded virtual fn
1803 Warn when a function declaration hides virtual functions from a
1804 base class.  For example, in:
1806 @smallexample
1807 struct A @{
1808   virtual void f();
1811 struct B: public A @{
1812   void f(int);
1814 @end smallexample
1816 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1817 like:
1819 @smallexample
1820 B* b;
1821 b->f();
1822 @end smallexample
1824 will fail to compile.
1826 @item -Wno-pmf-conversions @r{(C++ only)}
1827 @opindex Wno-pmf-conversions
1828 Disable the diagnostic for converting a bound pointer to member function
1829 to a plain pointer.
1831 @item -Wsign-promo @r{(C++ only)}
1832 @opindex Wsign-promo
1833 Warn when overload resolution chooses a promotion from unsigned or
1834 enumerated type to a signed type, over a conversion to an unsigned type of
1835 the same size.  Previous versions of G++ would try to preserve
1836 unsignedness, but the standard mandates the current behavior.
1838 @smallexample
1839 struct A @{
1840   operator int ();
1841   A& operator = (int);
1844 main ()
1846   A a,b;
1847   a = b;
1849 @end smallexample
1851 In this example, G++ will synthesize a default @samp{A& operator =
1852 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1853 @end table
1855 @node Objective-C and Objective-C++ Dialect Options
1856 @section Options Controlling Objective-C and Objective-C++ Dialects
1858 @cindex compiler options, Objective-C and Objective-C++
1859 @cindex Objective-C and Objective-C++ options, command line
1860 @cindex options, Objective-C and Objective-C++
1861 (NOTE: This manual does not describe the Objective-C and Objective-C++
1862 languages themselves.  See @xref{Standards,,Language Standards
1863 Supported by GCC}, for references.)
1865 This section describes the command-line options that are only meaningful
1866 for Objective-C and Objective-C++ programs, but you can also use most of
1867 the language-independent GNU compiler options.
1868 For example, you might compile a file @code{some_class.m} like this:
1870 @smallexample
1871 gcc -g -fgnu-runtime -O -c some_class.m
1872 @end smallexample
1874 @noindent
1875 In this example, @option{-fgnu-runtime} is an option meant only for
1876 Objective-C and Objective-C++ programs; you can use the other options with
1877 any language supported by GCC@.
1879 Note that since Objective-C is an extension of the C language, Objective-C
1880 compilations may also use options specific to the C front-end (e.g.,
1881 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1882 C++-specific options (e.g., @option{-Wabi}).
1884 Here is a list of options that are @emph{only} for compiling Objective-C
1885 and Objective-C++ programs:
1887 @table @gcctabopt
1888 @item -fconstant-string-class=@var{class-name}
1889 @opindex fconstant-string-class
1890 Use @var{class-name} as the name of the class to instantiate for each
1891 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1892 class name is @code{NXConstantString} if the GNU runtime is being used, and
1893 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1894 @option{-fconstant-cfstrings} option, if also present, will override the
1895 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1896 to be laid out as constant CoreFoundation strings.
1898 @item -fgnu-runtime
1899 @opindex fgnu-runtime
1900 Generate object code compatible with the standard GNU Objective-C
1901 runtime.  This is the default for most types of systems.
1903 @item -fnext-runtime
1904 @opindex fnext-runtime
1905 Generate output compatible with the NeXT runtime.  This is the default
1906 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1907 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1908 used.
1910 @item -fno-nil-receivers
1911 @opindex fno-nil-receivers
1912 Assume that all Objective-C message dispatches (e.g.,
1913 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1914 is not @code{nil}.  This allows for more efficient entry points in the runtime
1915 to be used.  Currently, this option is only available in conjunction with
1916 the NeXT runtime on Mac OS X 10.3 and later.
1918 @item -fobjc-call-cxx-cdtors
1919 @opindex fobjc-call-cxx-cdtors
1920 For each Objective-C class, check if any of its instance variables is a
1921 C++ object with a non-trivial default constructor.  If so, synthesize a
1922 special @code{- (id) .cxx_construct} instance method that will run
1923 non-trivial default constructors on any such instance variables, in order,
1924 and then return @code{self}.  Similarly, check if any instance variable
1925 is a C++ object with a non-trivial destructor, and if so, synthesize a
1926 special @code{- (void) .cxx_destruct} method that will run
1927 all such default destructors, in reverse order.
1929 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1930 thusly generated will only operate on instance variables declared in the
1931 current Objective-C class, and not those inherited from superclasses.  It
1932 is the responsibility of the Objective-C runtime to invoke all such methods
1933 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1934 will be invoked by the runtime immediately after a new object
1935 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1936 be invoked immediately before the runtime deallocates an object instance.
1938 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1939 support for invoking the @code{- (id) .cxx_construct} and
1940 @code{- (void) .cxx_destruct} methods.
1942 @item -fobjc-direct-dispatch
1943 @opindex fobjc-direct-dispatch
1944 Allow fast jumps to the message dispatcher.  On Darwin this is
1945 accomplished via the comm page.
1947 @item -fobjc-exceptions
1948 @opindex fobjc-exceptions
1949 Enable syntactic support for structured exception handling in Objective-C,
1950 similar to what is offered by C++ and Java.  Currently, this option is only
1951 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1953 @smallexample
1954   @@try @{
1955     @dots{}
1956        @@throw expr;
1957     @dots{}
1958   @}
1959   @@catch (AnObjCClass *exc) @{
1960     @dots{}
1961       @@throw expr;
1962     @dots{}
1963       @@throw;
1964     @dots{}
1965   @}
1966   @@catch (AnotherClass *exc) @{
1967     @dots{}
1968   @}
1969   @@catch (id allOthers) @{
1970     @dots{}
1971   @}
1972   @@finally @{
1973     @dots{}
1974       @@throw expr;
1975     @dots{}
1976   @}
1977 @end smallexample
1979 The @code{@@throw} statement may appear anywhere in an Objective-C or
1980 Objective-C++ program; when used inside of a @code{@@catch} block, the
1981 @code{@@throw} may appear without an argument (as shown above), in which case
1982 the object caught by the @code{@@catch} will be rethrown.
1984 Note that only (pointers to) Objective-C objects may be thrown and
1985 caught using this scheme.  When an object is thrown, it will be caught
1986 by the nearest @code{@@catch} clause capable of handling objects of that type,
1987 analogously to how @code{catch} blocks work in C++ and Java.  A
1988 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1989 any and all Objective-C exceptions not caught by previous @code{@@catch}
1990 clauses (if any).
1992 The @code{@@finally} clause, if present, will be executed upon exit from the
1993 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1994 regardless of whether any exceptions are thrown, caught or rethrown
1995 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1996 of the @code{finally} clause in Java.
1998 There are several caveats to using the new exception mechanism:
2000 @itemize @bullet
2001 @item
2002 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2003 idioms provided by the @code{NSException} class, the new
2004 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2005 systems, due to additional functionality needed in the (NeXT) Objective-C
2006 runtime.
2008 @item
2009 As mentioned above, the new exceptions do not support handling
2010 types other than Objective-C objects.   Furthermore, when used from
2011 Objective-C++, the Objective-C exception model does not interoperate with C++
2012 exceptions at this time.  This means you cannot @code{@@throw} an exception
2013 from Objective-C and @code{catch} it in C++, or vice versa
2014 (i.e., @code{throw @dots{} @@catch}).
2015 @end itemize
2017 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2018 blocks for thread-safe execution:
2020 @smallexample
2021   @@synchronized (ObjCClass *guard) @{
2022     @dots{}
2023   @}
2024 @end smallexample
2026 Upon entering the @code{@@synchronized} block, a thread of execution shall
2027 first check whether a lock has been placed on the corresponding @code{guard}
2028 object by another thread.  If it has, the current thread shall wait until
2029 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2030 the current thread will place its own lock on it, execute the code contained in
2031 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2032 making @code{guard} available to other threads).
2034 Unlike Java, Objective-C does not allow for entire methods to be marked
2035 @code{@@synchronized}.  Note that throwing exceptions out of
2036 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2037 to be unlocked properly.
2039 @item -fobjc-gc
2040 @opindex fobjc-gc
2041 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2043 @item -freplace-objc-classes
2044 @opindex freplace-objc-classes
2045 Emit a special marker instructing @command{ld(1)} not to statically link in
2046 the resulting object file, and allow @command{dyld(1)} to load it in at
2047 run time instead.  This is used in conjunction with the Fix-and-Continue
2048 debugging mode, where the object file in question may be recompiled and
2049 dynamically reloaded in the course of program execution, without the need
2050 to restart the program itself.  Currently, Fix-and-Continue functionality
2051 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2052 and later.
2054 @item -fzero-link
2055 @opindex fzero-link
2056 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2057 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2058 compile time) with static class references that get initialized at load time,
2059 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2060 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2061 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2062 for individual class implementations to be modified during program execution.
2064 @item -gen-decls
2065 @opindex gen-decls
2066 Dump interface declarations for all classes seen in the source file to a
2067 file named @file{@var{sourcename}.decl}.
2069 @item -Wassign-intercept
2070 @opindex Wassign-intercept
2071 Warn whenever an Objective-C assignment is being intercepted by the
2072 garbage collector.
2074 @item -Wno-protocol
2075 @opindex Wno-protocol
2076 If a class is declared to implement a protocol, a warning is issued for
2077 every method in the protocol that is not implemented by the class.  The
2078 default behavior is to issue a warning for every method not explicitly
2079 implemented in the class, even if a method implementation is inherited
2080 from the superclass.  If you use the @option{-Wno-protocol} option, then
2081 methods inherited from the superclass are considered to be implemented,
2082 and no warning is issued for them.
2084 @item -Wselector
2085 @opindex Wselector
2086 Warn if multiple methods of different types for the same selector are
2087 found during compilation.  The check is performed on the list of methods
2088 in the final stage of compilation.  Additionally, a check is performed
2089 for each selector appearing in a @code{@@selector(@dots{})}
2090 expression, and a corresponding method for that selector has been found
2091 during compilation.  Because these checks scan the method table only at
2092 the end of compilation, these warnings are not produced if the final
2093 stage of compilation is not reached, for example because an error is
2094 found during compilation, or because the @option{-fsyntax-only} option is
2095 being used.
2097 @item -Wstrict-selector-match
2098 @opindex Wstrict-selector-match
2099 Warn if multiple methods with differing argument and/or return types are
2100 found for a given selector when attempting to send a message using this
2101 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2102 is off (which is the default behavior), the compiler will omit such warnings
2103 if any differences found are confined to types which share the same size
2104 and alignment.
2106 @item -Wundeclared-selector
2107 @opindex Wundeclared-selector
2108 Warn if a @code{@@selector(@dots{})} expression referring to an
2109 undeclared selector is found.  A selector is considered undeclared if no
2110 method with that name has been declared before the
2111 @code{@@selector(@dots{})} expression, either explicitly in an
2112 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2113 an @code{@@implementation} section.  This option always performs its
2114 checks as soon as a @code{@@selector(@dots{})} expression is found,
2115 while @option{-Wselector} only performs its checks in the final stage of
2116 compilation.  This also enforces the coding style convention
2117 that methods and selectors must be declared before being used.
2119 @item -print-objc-runtime-info
2120 @opindex print-objc-runtime-info
2121 Generate C header describing the largest structure that is passed by
2122 value, if any.
2124 @end table
2126 @node Language Independent Options
2127 @section Options to Control Diagnostic Messages Formatting
2128 @cindex options to control diagnostics formatting
2129 @cindex diagnostic messages
2130 @cindex message formatting
2132 Traditionally, diagnostic messages have been formatted irrespective of
2133 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2134 below can be used to control the diagnostic messages formatting
2135 algorithm, e.g.@: how many characters per line, how often source location
2136 information should be reported.  Right now, only the C++ front end can
2137 honor these options.  However it is expected, in the near future, that
2138 the remaining front ends would be able to digest them correctly.
2140 @table @gcctabopt
2141 @item -fmessage-length=@var{n}
2142 @opindex fmessage-length
2143 Try to format error messages so that they fit on lines of about @var{n}
2144 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2145 the front ends supported by GCC@.  If @var{n} is zero, then no
2146 line-wrapping will be done; each error message will appear on a single
2147 line.
2149 @opindex fdiagnostics-show-location
2150 @item -fdiagnostics-show-location=once
2151 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2152 reporter to emit @emph{once} source location information; that is, in
2153 case the message is too long to fit on a single physical line and has to
2154 be wrapped, the source location won't be emitted (as prefix) again,
2155 over and over, in subsequent continuation lines.  This is the default
2156 behavior.
2158 @item -fdiagnostics-show-location=every-line
2159 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2160 messages reporter to emit the same source location information (as
2161 prefix) for physical lines that result from the process of breaking
2162 a message which is too long to fit on a single line.
2164 @item -fdiagnostics-show-options
2165 @opindex fdiagnostics-show-options
2166 This option instructs the diagnostic machinery to add text to each
2167 diagnostic emitted, which indicates which command line option directly
2168 controls that diagnostic, when such an option is known to the
2169 diagnostic machinery.
2171 @end table
2173 @node Warning Options
2174 @section Options to Request or Suppress Warnings
2175 @cindex options to control warnings
2176 @cindex warning messages
2177 @cindex messages, warning
2178 @cindex suppressing warnings
2180 Warnings are diagnostic messages that report constructions which
2181 are not inherently erroneous but which are risky or suggest there
2182 may have been an error.
2184 You can request many specific warnings with options beginning @samp{-W},
2185 for example @option{-Wimplicit} to request warnings on implicit
2186 declarations.  Each of these specific warning options also has a
2187 negative form beginning @samp{-Wno-} to turn off warnings;
2188 for example, @option{-Wno-implicit}.  This manual lists only one of the
2189 two forms, whichever is not the default.
2191 The following options control the amount and kinds of warnings produced
2192 by GCC; for further, language-specific options also refer to
2193 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2194 Options}.
2196 @table @gcctabopt
2197 @cindex syntax checking
2198 @item -fsyntax-only
2199 @opindex fsyntax-only
2200 Check the code for syntax errors, but don't do anything beyond that.
2202 @item -pedantic
2203 @opindex pedantic
2204 Issue all the warnings demanded by strict ISO C and ISO C++;
2205 reject all programs that use forbidden extensions, and some other
2206 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2207 version of the ISO C standard specified by any @option{-std} option used.
2209 Valid ISO C and ISO C++ programs should compile properly with or without
2210 this option (though a rare few will require @option{-ansi} or a
2211 @option{-std} option specifying the required version of ISO C)@.  However,
2212 without this option, certain GNU extensions and traditional C and C++
2213 features are supported as well.  With this option, they are rejected.
2215 @option{-pedantic} does not cause warning messages for use of the
2216 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2217 warnings are also disabled in the expression that follows
2218 @code{__extension__}.  However, only system header files should use
2219 these escape routes; application programs should avoid them.
2220 @xref{Alternate Keywords}.
2222 Some users try to use @option{-pedantic} to check programs for strict ISO
2223 C conformance.  They soon find that it does not do quite what they want:
2224 it finds some non-ISO practices, but not all---only those for which
2225 ISO C @emph{requires} a diagnostic, and some others for which
2226 diagnostics have been added.
2228 A feature to report any failure to conform to ISO C might be useful in
2229 some instances, but would require considerable additional work and would
2230 be quite different from @option{-pedantic}.  We don't have plans to
2231 support such a feature in the near future.
2233 Where the standard specified with @option{-std} represents a GNU
2234 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2235 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2236 extended dialect is based.  Warnings from @option{-pedantic} are given
2237 where they are required by the base standard.  (It would not make sense
2238 for such warnings to be given only for features not in the specified GNU
2239 C dialect, since by definition the GNU dialects of C include all
2240 features the compiler supports with the given option, and there would be
2241 nothing to warn about.)
2243 @item -pedantic-errors
2244 @opindex pedantic-errors
2245 Like @option{-pedantic}, except that errors are produced rather than
2246 warnings.
2248 @item -w
2249 @opindex w
2250 Inhibit all warning messages.
2252 @item -Wno-import
2253 @opindex Wno-import
2254 Inhibit warning messages about the use of @samp{#import}.
2256 @item -Wchar-subscripts
2257 @opindex Wchar-subscripts
2258 Warn if an array subscript has type @code{char}.  This is a common cause
2259 of error, as programmers often forget that this type is signed on some
2260 machines.
2261 This warning is enabled by @option{-Wall}.
2263 @item -Wcomment
2264 @opindex Wcomment
2265 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2266 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2267 This warning is enabled by @option{-Wall}.
2269 @item -Wfatal-errors
2270 @opindex Wfatal-errors
2271 This option causes the compiler to abort compilation on the first error
2272 occurred rather than trying to keep going and printing further error
2273 messages.
2275 @item -Wformat
2276 @opindex Wformat
2277 @opindex ffreestanding
2278 @opindex fno-builtin
2279 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2280 the arguments supplied have types appropriate to the format string
2281 specified, and that the conversions specified in the format string make
2282 sense.  This includes standard functions, and others specified by format
2283 attributes (@pxref{Function Attributes}), in the @code{printf},
2284 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2285 not in the C standard) families (or other target-specific families).
2286 Which functions are checked without format attributes having been
2287 specified depends on the standard version selected, and such checks of
2288 functions without the attribute specified are disabled by
2289 @option{-ffreestanding} or @option{-fno-builtin}.
2291 The formats are checked against the format features supported by GNU
2292 libc version 2.2.  These include all ISO C90 and C99 features, as well
2293 as features from the Single Unix Specification and some BSD and GNU
2294 extensions.  Other library implementations may not support all these
2295 features; GCC does not support warning about features that go beyond a
2296 particular library's limitations.  However, if @option{-pedantic} is used
2297 with @option{-Wformat}, warnings will be given about format features not
2298 in the selected standard version (but not for @code{strfmon} formats,
2299 since those are not in any version of the C standard).  @xref{C Dialect
2300 Options,,Options Controlling C Dialect}.
2302 Since @option{-Wformat} also checks for null format arguments for
2303 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2305 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2306 aspects of format checking, the options @option{-Wformat-y2k},
2307 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2308 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2309 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2311 @item -Wformat-y2k
2312 @opindex Wformat-y2k
2313 If @option{-Wformat} is specified, also warn about @code{strftime}
2314 formats which may yield only a two-digit year.
2316 @item -Wno-format-extra-args
2317 @opindex Wno-format-extra-args
2318 If @option{-Wformat} is specified, do not warn about excess arguments to a
2319 @code{printf} or @code{scanf} format function.  The C standard specifies
2320 that such arguments are ignored.
2322 Where the unused arguments lie between used arguments that are
2323 specified with @samp{$} operand number specifications, normally
2324 warnings are still given, since the implementation could not know what
2325 type to pass to @code{va_arg} to skip the unused arguments.  However,
2326 in the case of @code{scanf} formats, this option will suppress the
2327 warning if the unused arguments are all pointers, since the Single
2328 Unix Specification says that such unused arguments are allowed.
2330 @item -Wno-format-zero-length
2331 @opindex Wno-format-zero-length
2332 If @option{-Wformat} is specified, do not warn about zero-length formats.
2333 The C standard specifies that zero-length formats are allowed.
2335 @item -Wformat-nonliteral
2336 @opindex Wformat-nonliteral
2337 If @option{-Wformat} is specified, also warn if the format string is not a
2338 string literal and so cannot be checked, unless the format function
2339 takes its format arguments as a @code{va_list}.
2341 @item -Wformat-security
2342 @opindex Wformat-security
2343 If @option{-Wformat} is specified, also warn about uses of format
2344 functions that represent possible security problems.  At present, this
2345 warns about calls to @code{printf} and @code{scanf} functions where the
2346 format string is not a string literal and there are no format arguments,
2347 as in @code{printf (foo);}.  This may be a security hole if the format
2348 string came from untrusted input and contains @samp{%n}.  (This is
2349 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2350 in future warnings may be added to @option{-Wformat-security} that are not
2351 included in @option{-Wformat-nonliteral}.)
2353 @item -Wformat=2
2354 @opindex Wformat=2
2355 Enable @option{-Wformat} plus format checks not included in
2356 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2357 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2359 @item -Wnonnull
2360 @opindex Wnonnull
2361 Warn about passing a null pointer for arguments marked as
2362 requiring a non-null value by the @code{nonnull} function attribute.
2364 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2365 can be disabled with the @option{-Wno-nonnull} option.
2367 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2368 @opindex Winit-self
2369 Warn about uninitialized variables which are initialized with themselves.
2370 Note this option can only be used with the @option{-Wuninitialized} option,
2371 which in turn only works with @option{-O1} and above.
2373 For example, GCC will warn about @code{i} being uninitialized in the
2374 following snippet only when @option{-Winit-self} has been specified:
2375 @smallexample
2376 @group
2377 int f()
2379   int i = i;
2380   return i;
2382 @end group
2383 @end smallexample
2385 @item -Wimplicit-int
2386 @opindex Wimplicit-int
2387 Warn when a declaration does not specify a type.
2388 This warning is enabled by @option{-Wall}.
2390 @item -Wimplicit-function-declaration
2391 @itemx -Werror-implicit-function-declaration
2392 @opindex Wimplicit-function-declaration
2393 @opindex Werror-implicit-function-declaration
2394 Give a warning (or error) whenever a function is used before being
2395 declared.  The form @option{-Wno-error-implicit-function-declaration}
2396 is not supported.
2397 This warning is enabled by @option{-Wall} (as a warning, not an error).
2399 @item -Wimplicit
2400 @opindex Wimplicit
2401 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2402 This warning is enabled by @option{-Wall}.
2404 @item -Wmain
2405 @opindex Wmain
2406 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2407 function with external linkage, returning int, taking either zero
2408 arguments, two, or three arguments of appropriate types.
2409 This warning is enabled by @option{-Wall}.
2411 @item -Wmissing-braces
2412 @opindex Wmissing-braces
2413 Warn if an aggregate or union initializer is not fully bracketed.  In
2414 the following example, the initializer for @samp{a} is not fully
2415 bracketed, but that for @samp{b} is fully bracketed.
2417 @smallexample
2418 int a[2][2] = @{ 0, 1, 2, 3 @};
2419 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2420 @end smallexample
2422 This warning is enabled by @option{-Wall}.
2424 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2425 @opindex Wmissing-include-dirs
2426 Warn if a user-supplied include directory does not exist.
2428 @item -Wparentheses
2429 @opindex Wparentheses
2430 Warn if parentheses are omitted in certain contexts, such
2431 as when there is an assignment in a context where a truth value
2432 is expected, or when operators are nested whose precedence people
2433 often get confused about.  Only the warning for an assignment used as
2434 a truth value is supported when compiling C++; the other warnings are
2435 only supported when compiling C@.
2437 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2438 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2439 interpretation from that of ordinary mathematical notation.
2441 Also warn about constructions where there may be confusion to which
2442 @code{if} statement an @code{else} branch belongs.  Here is an example of
2443 such a case:
2445 @smallexample
2446 @group
2448   if (a)
2449     if (b)
2450       foo ();
2451   else
2452     bar ();
2454 @end group
2455 @end smallexample
2457 In C, every @code{else} branch belongs to the innermost possible @code{if}
2458 statement, which in this example is @code{if (b)}.  This is often not
2459 what the programmer expected, as illustrated in the above example by
2460 indentation the programmer chose.  When there is the potential for this
2461 confusion, GCC will issue a warning when this flag is specified.
2462 To eliminate the warning, add explicit braces around the innermost
2463 @code{if} statement so there is no way the @code{else} could belong to
2464 the enclosing @code{if}.  The resulting code would look like this:
2466 @smallexample
2467 @group
2469   if (a)
2470     @{
2471       if (b)
2472         foo ();
2473       else
2474         bar ();
2475     @}
2477 @end group
2478 @end smallexample
2480 This warning is enabled by @option{-Wall}.
2482 @item -Wsequence-point
2483 @opindex Wsequence-point
2484 Warn about code that may have undefined semantics because of violations
2485 of sequence point rules in the C standard.
2487 The C standard defines the order in which expressions in a C program are
2488 evaluated in terms of @dfn{sequence points}, which represent a partial
2489 ordering between the execution of parts of the program: those executed
2490 before the sequence point, and those executed after it.  These occur
2491 after the evaluation of a full expression (one which is not part of a
2492 larger expression), after the evaluation of the first operand of a
2493 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2494 function is called (but after the evaluation of its arguments and the
2495 expression denoting the called function), and in certain other places.
2496 Other than as expressed by the sequence point rules, the order of
2497 evaluation of subexpressions of an expression is not specified.  All
2498 these rules describe only a partial order rather than a total order,
2499 since, for example, if two functions are called within one expression
2500 with no sequence point between them, the order in which the functions
2501 are called is not specified.  However, the standards committee have
2502 ruled that function calls do not overlap.
2504 It is not specified when between sequence points modifications to the
2505 values of objects take effect.  Programs whose behavior depends on this
2506 have undefined behavior; the C standard specifies that ``Between the
2507 previous and next sequence point an object shall have its stored value
2508 modified at most once by the evaluation of an expression.  Furthermore,
2509 the prior value shall be read only to determine the value to be
2510 stored.''.  If a program breaks these rules, the results on any
2511 particular implementation are entirely unpredictable.
2513 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2514 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2515 diagnosed by this option, and it may give an occasional false positive
2516 result, but in general it has been found fairly effective at detecting
2517 this sort of problem in programs.
2519 The present implementation of this option only works for C programs.  A
2520 future implementation may also work for C++ programs.
2522 The C standard is worded confusingly, therefore there is some debate
2523 over the precise meaning of the sequence point rules in subtle cases.
2524 Links to discussions of the problem, including proposed formal
2525 definitions, may be found on the GCC readings page, at
2526 @w{@uref{http://gcc.gnu.org/readings.html}}.
2528 This warning is enabled by @option{-Wall}.
2530 @item -Wreturn-type
2531 @opindex Wreturn-type
2532 Warn whenever a function is defined with a return-type that defaults to
2533 @code{int}.  Also warn about any @code{return} statement with no
2534 return-value in a function whose return-type is not @code{void}.
2536 For C, also warn if the return type of a function has a type qualifier
2537 such as @code{const}.  Such a type qualifier has no effect, since the
2538 value returned by a function is not an lvalue.  ISO C prohibits
2539 qualified @code{void} return types on function definitions, so such
2540 return types always receive a warning even without this option.
2542 For C++, a function without return type always produces a diagnostic
2543 message, even when @option{-Wno-return-type} is specified.  The only
2544 exceptions are @samp{main} and functions defined in system headers.
2546 This warning is enabled by @option{-Wall}.
2548 @item -Wswitch
2549 @opindex Wswitch
2550 Warn whenever a @code{switch} statement has an index of enumerated type
2551 and lacks a @code{case} for one or more of the named codes of that
2552 enumeration.  (The presence of a @code{default} label prevents this
2553 warning.)  @code{case} labels outside the enumeration range also
2554 provoke warnings when this option is used.
2555 This warning is enabled by @option{-Wall}.
2557 @item -Wswitch-default
2558 @opindex Wswitch-switch
2559 Warn whenever a @code{switch} statement does not have a @code{default}
2560 case.
2562 @item -Wswitch-enum
2563 @opindex Wswitch-enum
2564 Warn whenever a @code{switch} statement has an index of enumerated type
2565 and lacks a @code{case} for one or more of the named codes of that
2566 enumeration.  @code{case} labels outside the enumeration range also
2567 provoke warnings when this option is used.
2569 @item -Wtrigraphs
2570 @opindex Wtrigraphs
2571 Warn if any trigraphs are encountered that might change the meaning of
2572 the program (trigraphs within comments are not warned about).
2573 This warning is enabled by @option{-Wall}.
2575 @item -Wunused-function
2576 @opindex Wunused-function
2577 Warn whenever a static function is declared but not defined or a
2578 non\-inline static function is unused.
2579 This warning is enabled by @option{-Wall}.
2581 @item -Wunused-label
2582 @opindex Wunused-label
2583 Warn whenever a label is declared but not used.
2584 This warning is enabled by @option{-Wall}.
2586 To suppress this warning use the @samp{unused} attribute
2587 (@pxref{Variable Attributes}).
2589 @item -Wunused-parameter
2590 @opindex Wunused-parameter
2591 Warn whenever a function parameter is unused aside from its declaration.
2593 To suppress this warning use the @samp{unused} attribute
2594 (@pxref{Variable Attributes}).
2596 @item -Wunused-variable
2597 @opindex Wunused-variable
2598 Warn whenever a local variable or non-constant static variable is unused
2599 aside from its declaration
2600 This warning is enabled by @option{-Wall}.
2602 To suppress this warning use the @samp{unused} attribute
2603 (@pxref{Variable Attributes}).
2605 @item -Wunused-value
2606 @opindex Wunused-value
2607 Warn whenever a statement computes a result that is explicitly not used.
2608 This warning is enabled by @option{-Wall}.
2610 To suppress this warning cast the expression to @samp{void}.
2612 @item -Wunused
2613 @opindex Wunused
2614 All the above @option{-Wunused} options combined.
2616 In order to get a warning about an unused function parameter, you must
2617 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2618 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2620 @item -Wuninitialized
2621 @opindex Wuninitialized
2622 Warn if an automatic variable is used without first being initialized or
2623 if a variable may be clobbered by a @code{setjmp} call.
2625 These warnings are possible only in optimizing compilation,
2626 because they require data flow information that is computed only
2627 when optimizing.  If you don't specify @option{-O}, you simply won't
2628 get these warnings.
2630 If you want to warn about code which uses the uninitialized value of the
2631 variable in its own initializer, use the @option{-Winit-self} option.
2633 These warnings occur for individual uninitialized or clobbered
2634 elements of structure, union or array variables as well as for
2635 variables which are uninitialized or clobbered as a whole.  They do
2636 not occur for variables or elements declared @code{volatile}.  Because
2637 these warnings depend on optimization, the exact variables or elements
2638 for which there are warnings will depend on the precise optimization
2639 options and version of GCC used.
2641 Note that there may be no warning about a variable that is used only
2642 to compute a value that itself is never used, because such
2643 computations may be deleted by data flow analysis before the warnings
2644 are printed.
2646 These warnings are made optional because GCC is not smart
2647 enough to see all the reasons why the code might be correct
2648 despite appearing to have an error.  Here is one example of how
2649 this can happen:
2651 @smallexample
2652 @group
2654   int x;
2655   switch (y)
2656     @{
2657     case 1: x = 1;
2658       break;
2659     case 2: x = 4;
2660       break;
2661     case 3: x = 5;
2662     @}
2663   foo (x);
2665 @end group
2666 @end smallexample
2668 @noindent
2669 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2670 always initialized, but GCC doesn't know this.  Here is
2671 another common case:
2673 @smallexample
2675   int save_y;
2676   if (change_y) save_y = y, y = new_y;
2677   @dots{}
2678   if (change_y) y = save_y;
2680 @end smallexample
2682 @noindent
2683 This has no bug because @code{save_y} is used only if it is set.
2685 @cindex @code{longjmp} warnings
2686 This option also warns when a non-volatile automatic variable might be
2687 changed by a call to @code{longjmp}.  These warnings as well are possible
2688 only in optimizing compilation.
2690 The compiler sees only the calls to @code{setjmp}.  It cannot know
2691 where @code{longjmp} will be called; in fact, a signal handler could
2692 call it at any point in the code.  As a result, you may get a warning
2693 even when there is in fact no problem because @code{longjmp} cannot
2694 in fact be called at the place which would cause a problem.
2696 Some spurious warnings can be avoided if you declare all the functions
2697 you use that never return as @code{noreturn}.  @xref{Function
2698 Attributes}.
2700 This warning is enabled by @option{-Wall}.
2702 @item -Wunknown-pragmas
2703 @opindex Wunknown-pragmas
2704 @cindex warning for unknown pragmas
2705 @cindex unknown pragmas, warning
2706 @cindex pragmas, warning of unknown
2707 Warn when a #pragma directive is encountered which is not understood by
2708 GCC@.  If this command line option is used, warnings will even be issued
2709 for unknown pragmas in system header files.  This is not the case if
2710 the warnings were only enabled by the @option{-Wall} command line option.
2712 @item -Wstrict-aliasing
2713 @opindex Wstrict-aliasing
2714 This option is only active when @option{-fstrict-aliasing} is active.
2715 It warns about code which might break the strict aliasing rules that the
2716 compiler is using for optimization.  The warning does not catch all
2717 cases, but does attempt to catch the more common pitfalls.  It is
2718 included in @option{-Wall}.
2720 @item -Wstrict-aliasing=2
2721 @opindex Wstrict-aliasing=2
2722 This option is only active when @option{-fstrict-aliasing} is active.
2723 It warns about all code which might break the strict aliasing rules that the
2724 compiler is using for optimization.  This warning catches all cases, but
2725 it will also give a warning for some ambiguous cases that are safe.
2727 @item -Wall
2728 @opindex Wall
2729 All of the above @samp{-W} options combined.  This enables all the
2730 warnings about constructions that some users consider questionable, and
2731 that are easy to avoid (or modify to prevent the warning), even in
2732 conjunction with macros.  This also enables some language-specific
2733 warnings described in @ref{C++ Dialect Options} and
2734 @ref{Objective-C and Objective-C++ Dialect Options}.
2735 @end table
2737 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2738 Some of them warn about constructions that users generally do not
2739 consider questionable, but which occasionally you might wish to check
2740 for; others warn about constructions that are necessary or hard to avoid
2741 in some cases, and there is no simple way to modify the code to suppress
2742 the warning.
2744 @table @gcctabopt
2745 @item -Wextra
2746 @opindex W
2747 @opindex Wextra
2748 (This option used to be called @option{-W}.  The older name is still
2749 supported, but the newer name is more descriptive.)  Print extra warning
2750 messages for these events:
2752 @itemize @bullet
2753 @item
2754 A function can return either with or without a value.  (Falling
2755 off the end of the function body is considered returning without
2756 a value.)  For example, this function would evoke such a
2757 warning:
2759 @smallexample
2760 @group
2761 foo (a)
2763   if (a > 0)
2764     return a;
2766 @end group
2767 @end smallexample
2769 @item
2770 An expression-statement or the left-hand side of a comma expression
2771 contains no side effects.
2772 To suppress the warning, cast the unused expression to void.
2773 For example, an expression such as @samp{x[i,j]} will cause a warning,
2774 but @samp{x[(void)i,j]} will not.
2776 @item
2777 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2779 @item
2780 Storage-class specifiers like @code{static} are not the first things in
2781 a declaration.  According to the C Standard, this usage is obsolescent.
2783 @item
2784 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2785 arguments.
2787 @item
2788 A comparison between signed and unsigned values could produce an
2789 incorrect result when the signed value is converted to unsigned.
2790 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2792 @item
2793 An aggregate has an initializer which does not initialize all members.
2794 This warning can be independently controlled by
2795 @option{-Wmissing-field-initializers}.
2797 @item
2798 A function parameter is declared without a type specifier in K&R-style
2799 functions:
2801 @smallexample
2802 void foo(bar) @{ @}
2803 @end smallexample
2805 @item
2806 An empty body occurs in an @samp{if} or @samp{else} statement.
2808 @item
2809 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2810 @samp{>}, or @samp{>=}.
2812 @item
2813 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2815 @item
2816 Any of several floating-point events that often indicate errors, such as
2817 overflow, underflow, loss of precision, etc.
2819 @item @r{(C++ only)}
2820 An enumerator and a non-enumerator both appear in a conditional expression.
2822 @item @r{(C++ only)}
2823 A non-static reference or non-static @samp{const} member appears in a
2824 class without constructors.
2826 @item @r{(C++ only)}
2827 Ambiguous virtual bases.
2829 @item @r{(C++ only)}
2830 Subscripting an array which has been declared @samp{register}.
2832 @item @r{(C++ only)}
2833 Taking the address of a variable which has been declared @samp{register}.
2835 @item @r{(C++ only)}
2836 A base class is not initialized in a derived class' copy constructor.
2837 @end itemize
2839 @item -Wno-div-by-zero
2840 @opindex Wno-div-by-zero
2841 @opindex Wdiv-by-zero
2842 Do not warn about compile-time integer division by zero.  Floating point
2843 division by zero is not warned about, as it can be a legitimate way of
2844 obtaining infinities and NaNs.
2846 @item -Wsystem-headers
2847 @opindex Wsystem-headers
2848 @cindex warnings from system headers
2849 @cindex system headers, warnings from
2850 Print warning messages for constructs found in system header files.
2851 Warnings from system headers are normally suppressed, on the assumption
2852 that they usually do not indicate real problems and would only make the
2853 compiler output harder to read.  Using this command line option tells
2854 GCC to emit warnings from system headers as if they occurred in user
2855 code.  However, note that using @option{-Wall} in conjunction with this
2856 option will @emph{not} warn about unknown pragmas in system
2857 headers---for that, @option{-Wunknown-pragmas} must also be used.
2859 @item -Wfloat-equal
2860 @opindex Wfloat-equal
2861 Warn if floating point values are used in equality comparisons.
2863 The idea behind this is that sometimes it is convenient (for the
2864 programmer) to consider floating-point values as approximations to
2865 infinitely precise real numbers.  If you are doing this, then you need
2866 to compute (by analyzing the code, or in some other way) the maximum or
2867 likely maximum error that the computation introduces, and allow for it
2868 when performing comparisons (and when producing output, but that's a
2869 different problem).  In particular, instead of testing for equality, you
2870 would check to see whether the two values have ranges that overlap; and
2871 this is done with the relational operators, so equality comparisons are
2872 probably mistaken.
2874 @item -Wtraditional @r{(C only)}
2875 @opindex Wtraditional
2876 Warn about certain constructs that behave differently in traditional and
2877 ISO C@.  Also warn about ISO C constructs that have no traditional C
2878 equivalent, and/or problematic constructs which should be avoided.
2880 @itemize @bullet
2881 @item
2882 Macro parameters that appear within string literals in the macro body.
2883 In traditional C macro replacement takes place within string literals,
2884 but does not in ISO C@.
2886 @item
2887 In traditional C, some preprocessor directives did not exist.
2888 Traditional preprocessors would only consider a line to be a directive
2889 if the @samp{#} appeared in column 1 on the line.  Therefore
2890 @option{-Wtraditional} warns about directives that traditional C
2891 understands but would ignore because the @samp{#} does not appear as the
2892 first character on the line.  It also suggests you hide directives like
2893 @samp{#pragma} not understood by traditional C by indenting them.  Some
2894 traditional implementations would not recognize @samp{#elif}, so it
2895 suggests avoiding it altogether.
2897 @item
2898 A function-like macro that appears without arguments.
2900 @item
2901 The unary plus operator.
2903 @item
2904 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2905 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2906 constants.)  Note, these suffixes appear in macros defined in the system
2907 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2908 Use of these macros in user code might normally lead to spurious
2909 warnings, however GCC's integrated preprocessor has enough context to
2910 avoid warning in these cases.
2912 @item
2913 A function declared external in one block and then used after the end of
2914 the block.
2916 @item
2917 A @code{switch} statement has an operand of type @code{long}.
2919 @item
2920 A non-@code{static} function declaration follows a @code{static} one.
2921 This construct is not accepted by some traditional C compilers.
2923 @item
2924 The ISO type of an integer constant has a different width or
2925 signedness from its traditional type.  This warning is only issued if
2926 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2927 typically represent bit patterns, are not warned about.
2929 @item
2930 Usage of ISO string concatenation is detected.
2932 @item
2933 Initialization of automatic aggregates.
2935 @item
2936 Identifier conflicts with labels.  Traditional C lacks a separate
2937 namespace for labels.
2939 @item
2940 Initialization of unions.  If the initializer is zero, the warning is
2941 omitted.  This is done under the assumption that the zero initializer in
2942 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2943 initializer warnings and relies on default initialization to zero in the
2944 traditional C case.
2946 @item
2947 Conversions by prototypes between fixed/floating point values and vice
2948 versa.  The absence of these prototypes when compiling with traditional
2949 C would cause serious problems.  This is a subset of the possible
2950 conversion warnings, for the full set use @option{-Wconversion}.
2952 @item
2953 Use of ISO C style function definitions.  This warning intentionally is
2954 @emph{not} issued for prototype declarations or variadic functions
2955 because these ISO C features will appear in your code when using
2956 libiberty's traditional C compatibility macros, @code{PARAMS} and
2957 @code{VPARAMS}.  This warning is also bypassed for nested functions
2958 because that feature is already a GCC extension and thus not relevant to
2959 traditional C compatibility.
2960 @end itemize
2962 @item -Wdeclaration-after-statement @r{(C only)}
2963 @opindex Wdeclaration-after-statement
2964 Warn when a declaration is found after a statement in a block.  This
2965 construct, known from C++, was introduced with ISO C99 and is by default
2966 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2967 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2969 @item -Wundef
2970 @opindex Wundef
2971 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2973 @item -Wno-endif-labels
2974 @opindex Wno-endif-labels
2975 @opindex Wendif-labels
2976 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2978 @item -Wshadow
2979 @opindex Wshadow
2980 Warn whenever a local variable shadows another local variable, parameter or
2981 global variable or whenever a built-in function is shadowed.
2983 @item -Wlarger-than-@var{len}
2984 @opindex Wlarger-than
2985 Warn whenever an object of larger than @var{len} bytes is defined.
2987 @item -Wpointer-arith
2988 @opindex Wpointer-arith
2989 Warn about anything that depends on the ``size of'' a function type or
2990 of @code{void}.  GNU C assigns these types a size of 1, for
2991 convenience in calculations with @code{void *} pointers and pointers
2992 to functions.
2994 @item -Wbad-function-cast @r{(C only)}
2995 @opindex Wbad-function-cast
2996 Warn whenever a function call is cast to a non-matching type.
2997 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2999 @item -Wc++-compat
3000 Warn about ISO C constructs that are outside of the common subset of
3001 ISO C and ISO C++, e.g.@: request for implicit conversion from
3002 @code{void *} to a pointer to non-@code{void} type.
3004 @item -Wcast-qual
3005 @opindex Wcast-qual
3006 Warn whenever a pointer is cast so as to remove a type qualifier from
3007 the target type.  For example, warn if a @code{const char *} is cast
3008 to an ordinary @code{char *}.
3010 @item -Wcast-align
3011 @opindex Wcast-align
3012 Warn whenever a pointer is cast such that the required alignment of the
3013 target is increased.  For example, warn if a @code{char *} is cast to
3014 an @code{int *} on machines where integers can only be accessed at
3015 two- or four-byte boundaries.
3017 @item -Wwrite-strings
3018 @opindex Wwrite-strings
3019 When compiling C, give string constants the type @code{const
3020 char[@var{length}]} so that
3021 copying the address of one into a non-@code{const} @code{char *}
3022 pointer will get a warning; when compiling C++, warn about the
3023 deprecated conversion from string constants to @code{char *}.
3024 These warnings will help you find at
3025 compile time code that can try to write into a string constant, but
3026 only if you have been very careful about using @code{const} in
3027 declarations and prototypes.  Otherwise, it will just be a nuisance;
3028 this is why we did not make @option{-Wall} request these warnings.
3030 @item -Wconversion
3031 @opindex Wconversion
3032 Warn if a prototype causes a type conversion that is different from what
3033 would happen to the same argument in the absence of a prototype.  This
3034 includes conversions of fixed point to floating and vice versa, and
3035 conversions changing the width or signedness of a fixed point argument
3036 except when the same as the default promotion.
3038 Also, warn if a negative integer constant expression is implicitly
3039 converted to an unsigned type.  For example, warn about the assignment
3040 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3041 casts like @code{(unsigned) -1}.
3043 @item -Wsign-compare
3044 @opindex Wsign-compare
3045 @cindex warning for comparison of signed and unsigned values
3046 @cindex comparison of signed and unsigned values, warning
3047 @cindex signed and unsigned values, comparison warning
3048 Warn when a comparison between signed and unsigned values could produce
3049 an incorrect result when the signed value is converted to unsigned.
3050 This warning is also enabled by @option{-Wextra}; to get the other warnings
3051 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3053 @item -Waggregate-return
3054 @opindex Waggregate-return
3055 Warn if any functions that return structures or unions are defined or
3056 called.  (In languages where you can return an array, this also elicits
3057 a warning.)
3059 @item -Wno-attributes
3060 @opindex Wno-attributes
3061 @opindex Wattributes
3062 Do not warn if an unexpected @code{__attribute__} is used, such as
3063 unrecognized attributes, function attributes applied to variables,
3064 etc.  This will not stop errors for incorrect use of supported
3065 attributes.
3067 @item -Wstrict-prototypes @r{(C only)}
3068 @opindex Wstrict-prototypes
3069 Warn if a function is declared or defined without specifying the
3070 argument types.  (An old-style function definition is permitted without
3071 a warning if preceded by a declaration which specifies the argument
3072 types.)
3074 @item -Wold-style-definition @r{(C only)}
3075 @opindex Wold-style-definition
3076 Warn if an old-style function definition is used.  A warning is given
3077 even if there is a previous prototype.
3079 @item -Wmissing-prototypes @r{(C only)}
3080 @opindex Wmissing-prototypes
3081 Warn if a global function is defined without a previous prototype
3082 declaration.  This warning is issued even if the definition itself
3083 provides a prototype.  The aim is to detect global functions that fail
3084 to be declared in header files.
3086 @item -Wmissing-declarations @r{(C only)}
3087 @opindex Wmissing-declarations
3088 Warn if a global function is defined without a previous declaration.
3089 Do so even if the definition itself provides a prototype.
3090 Use this option to detect global functions that are not declared in
3091 header files.
3093 @item -Wmissing-field-initializers
3094 @opindex Wmissing-field-initializers
3095 @opindex W
3096 @opindex Wextra
3097 Warn if a structure's initializer has some fields missing.  For
3098 example, the following code would cause such a warning, because
3099 @code{x.h} is implicitly zero:
3101 @smallexample
3102 struct s @{ int f, g, h; @};
3103 struct s x = @{ 3, 4 @};
3104 @end smallexample
3106 This option does not warn about designated initializers, so the following
3107 modification would not trigger a warning:
3109 @smallexample
3110 struct s @{ int f, g, h; @};
3111 struct s x = @{ .f = 3, .g = 4 @};
3112 @end smallexample
3114 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3115 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3117 @item -Wmissing-noreturn
3118 @opindex Wmissing-noreturn
3119 Warn about functions which might be candidates for attribute @code{noreturn}.
3120 Note these are only possible candidates, not absolute ones.  Care should
3121 be taken to manually verify functions actually do not ever return before
3122 adding the @code{noreturn} attribute, otherwise subtle code generation
3123 bugs could be introduced.  You will not get a warning for @code{main} in
3124 hosted C environments.
3126 @item -Wmissing-format-attribute
3127 @opindex Wmissing-format-attribute
3128 @opindex Wformat
3129 If @option{-Wformat} is enabled, also warn about functions which might be
3130 candidates for @code{format} attributes.  Note these are only possible
3131 candidates, not absolute ones.  GCC will guess that @code{format}
3132 attributes might be appropriate for any function that calls a function
3133 like @code{vprintf} or @code{vscanf}, but this might not always be the
3134 case, and some functions for which @code{format} attributes are
3135 appropriate may not be detected.  This option has no effect unless
3136 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3138 @item -Wno-multichar
3139 @opindex Wno-multichar
3140 @opindex Wmultichar
3141 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3142 Usually they indicate a typo in the user's code, as they have
3143 implementation-defined values, and should not be used in portable code.
3145 @item -Wnormalized=<none|id|nfc|nfkc>
3146 @opindex Wnormalized
3147 @cindex NFC
3148 @cindex NFKC
3149 @cindex character set, input normalization
3150 In ISO C and ISO C++, two identifiers are different if they are
3151 different sequences of characters.  However, sometimes when characters
3152 outside the basic ASCII character set are used, you can have two
3153 different character sequences that look the same.  To avoid confusion,
3154 the ISO 10646 standard sets out some @dfn{normalization rules} which
3155 when applied ensure that two sequences that look the same are turned into
3156 the same sequence.  GCC can warn you if you are using identifiers which
3157 have not been normalized; this option controls that warning.
3159 There are four levels of warning that GCC supports.  The default is
3160 @option{-Wnormalized=nfc}, which warns about any identifier which is
3161 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3162 recommended form for most uses.
3164 Unfortunately, there are some characters which ISO C and ISO C++ allow
3165 in identifiers that when turned into NFC aren't allowable as
3166 identifiers.  That is, there's no way to use these symbols in portable
3167 ISO C or C++ and have all your identifiers in NFC.
3168 @option{-Wnormalized=id} suppresses the warning for these characters.
3169 It is hoped that future versions of the standards involved will correct
3170 this, which is why this option is not the default.
3172 You can switch the warning off for all characters by writing
3173 @option{-Wnormalized=none}.  You would only want to do this if you
3174 were using some other normalization scheme (like ``D''), because
3175 otherwise you can easily create bugs that are literally impossible to see.
3177 Some characters in ISO 10646 have distinct meanings but look identical
3178 in some fonts or display methodologies, especially once formatting has
3179 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3180 LETTER N'', will display just like a regular @code{n} which has been
3181 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3182 normalisation scheme to convert all these into a standard form as
3183 well, and GCC will warn if your code is not in NFKC if you use
3184 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3185 about every identifier that contains the letter O because it might be
3186 confused with the digit 0, and so is not the default, but may be
3187 useful as a local coding convention if the programming environment is
3188 unable to be fixed to display these characters distinctly.
3190 @item -Wno-deprecated-declarations
3191 @opindex Wno-deprecated-declarations
3192 Do not warn about uses of functions, variables, and types marked as
3193 deprecated by using the @code{deprecated} attribute.
3194 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3195 @pxref{Type Attributes}.)
3197 @item -Wpacked
3198 @opindex Wpacked
3199 Warn if a structure is given the packed attribute, but the packed
3200 attribute has no effect on the layout or size of the structure.
3201 Such structures may be mis-aligned for little benefit.  For
3202 instance, in this code, the variable @code{f.x} in @code{struct bar}
3203 will be misaligned even though @code{struct bar} does not itself
3204 have the packed attribute:
3206 @smallexample
3207 @group
3208 struct foo @{
3209   int x;
3210   char a, b, c, d;
3211 @} __attribute__((packed));
3212 struct bar @{
3213   char z;
3214   struct foo f;
3216 @end group
3217 @end smallexample
3219 @item -Wpadded
3220 @opindex Wpadded
3221 Warn if padding is included in a structure, either to align an element
3222 of the structure or to align the whole structure.  Sometimes when this
3223 happens it is possible to rearrange the fields of the structure to
3224 reduce the padding and so make the structure smaller.
3226 @item -Wredundant-decls
3227 @opindex Wredundant-decls
3228 Warn if anything is declared more than once in the same scope, even in
3229 cases where multiple declaration is valid and changes nothing.
3231 @item -Wnested-externs @r{(C only)}
3232 @opindex Wnested-externs
3233 Warn if an @code{extern} declaration is encountered within a function.
3235 @item -Wunreachable-code
3236 @opindex Wunreachable-code
3237 Warn if the compiler detects that code will never be executed.
3239 This option is intended to warn when the compiler detects that at
3240 least a whole line of source code will never be executed, because
3241 some condition is never satisfied or because it is after a
3242 procedure that never returns.
3244 It is possible for this option to produce a warning even though there
3245 are circumstances under which part of the affected line can be executed,
3246 so care should be taken when removing apparently-unreachable code.
3248 For instance, when a function is inlined, a warning may mean that the
3249 line is unreachable in only one inlined copy of the function.
3251 This option is not made part of @option{-Wall} because in a debugging
3252 version of a program there is often substantial code which checks
3253 correct functioning of the program and is, hopefully, unreachable
3254 because the program does work.  Another common use of unreachable
3255 code is to provide behavior which is selectable at compile-time.
3257 @item -Winline
3258 @opindex Winline
3259 Warn if a function can not be inlined and it was declared as inline.
3260 Even with this option, the compiler will not warn about failures to
3261 inline functions declared in system headers.
3263 The compiler uses a variety of heuristics to determine whether or not
3264 to inline a function.  For example, the compiler takes into account
3265 the size of the function being inlined and the amount of inlining
3266 that has already been done in the current function.  Therefore,
3267 seemingly insignificant changes in the source program can cause the
3268 warnings produced by @option{-Winline} to appear or disappear.
3270 @item -Wno-invalid-offsetof @r{(C++ only)}
3271 @opindex Wno-invalid-offsetof
3272 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3273 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3274 to a non-POD type is undefined.  In existing C++ implementations,
3275 however, @samp{offsetof} typically gives meaningful results even when
3276 applied to certain kinds of non-POD types. (Such as a simple
3277 @samp{struct} that fails to be a POD type only by virtue of having a
3278 constructor.)  This flag is for users who are aware that they are
3279 writing nonportable code and who have deliberately chosen to ignore the
3280 warning about it.
3282 The restrictions on @samp{offsetof} may be relaxed in a future version
3283 of the C++ standard.
3285 @item -Wno-int-to-pointer-cast @r{(C only)}
3286 @opindex Wno-int-to-pointer-cast
3287 Suppress warnings from casts to pointer type of an integer of a
3288 different size.
3290 @item -Wno-pointer-to-int-cast @r{(C only)}
3291 @opindex Wno-pointer-to-int-cast
3292 Suppress warnings from casts from a pointer to an integer type of a
3293 different size.
3295 @item -Winvalid-pch
3296 @opindex Winvalid-pch
3297 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3298 the search path but can't be used.
3300 @item -Wlong-long
3301 @opindex Wlong-long
3302 @opindex Wno-long-long
3303 Warn if @samp{long long} type is used.  This is default.  To inhibit
3304 the warning messages, use @option{-Wno-long-long}.  Flags
3305 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3306 only when @option{-pedantic} flag is used.
3308 @item -Wvariadic-macros
3309 @opindex Wvariadic-macros
3310 @opindex Wno-variadic-macros
3311 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3312 alternate syntax when in pedantic ISO C99 mode.  This is default.
3313 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3315 @item -Wdisabled-optimization
3316 @opindex Wdisabled-optimization
3317 Warn if a requested optimization pass is disabled.  This warning does
3318 not generally indicate that there is anything wrong with your code; it
3319 merely indicates that GCC's optimizers were unable to handle the code
3320 effectively.  Often, the problem is that your code is too big or too
3321 complex; GCC will refuse to optimize programs when the optimization
3322 itself is likely to take inordinate amounts of time.
3324 @item -Wno-pointer-sign
3325 @opindex Wno-pointer-sign
3326 Don't warn for pointer argument passing or assignment with different signedness.
3327 Only useful in the negative form since this warning is enabled by default.
3328 This option is only supported for C and Objective-C@.
3330 @item -Werror
3331 @opindex Werror
3332 Make all warnings into errors.
3333 @end table
3335 @node Debugging Options
3336 @section Options for Debugging Your Program or GCC
3337 @cindex options, debugging
3338 @cindex debugging information options
3340 GCC has various special options that are used for debugging
3341 either your program or GCC:
3343 @table @gcctabopt
3344 @item -g
3345 @opindex g
3346 Produce debugging information in the operating system's native format
3347 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3348 information.
3350 On most systems that use stabs format, @option{-g} enables use of extra
3351 debugging information that only GDB can use; this extra information
3352 makes debugging work better in GDB but will probably make other debuggers
3353 crash or
3354 refuse to read the program.  If you want to control for certain whether
3355 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3356 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3358 GCC allows you to use @option{-g} with
3359 @option{-O}.  The shortcuts taken by optimized code may occasionally
3360 produce surprising results: some variables you declared may not exist
3361 at all; flow of control may briefly move where you did not expect it;
3362 some statements may not be executed because they compute constant
3363 results or their values were already at hand; some statements may
3364 execute in different places because they were moved out of loops.
3366 Nevertheless it proves possible to debug optimized output.  This makes
3367 it reasonable to use the optimizer for programs that might have bugs.
3369 The following options are useful when GCC is generated with the
3370 capability for more than one debugging format.
3372 @item -ggdb
3373 @opindex ggdb
3374 Produce debugging information for use by GDB@.  This means to use the
3375 most expressive format available (DWARF 2, stabs, or the native format
3376 if neither of those are supported), including GDB extensions if at all
3377 possible.
3379 @item -gstabs
3380 @opindex gstabs
3381 Produce debugging information in stabs format (if that is supported),
3382 without GDB extensions.  This is the format used by DBX on most BSD
3383 systems.  On MIPS, Alpha and System V Release 4 systems this option
3384 produces stabs debugging output which is not understood by DBX or SDB@.
3385 On System V Release 4 systems this option requires the GNU assembler.
3387 @item -feliminate-unused-debug-symbols
3388 @opindex feliminate-unused-debug-symbols
3389 Produce debugging information in stabs format (if that is supported),
3390 for only symbols that are actually used.
3392 @item -gstabs+
3393 @opindex gstabs+
3394 Produce debugging information in stabs format (if that is supported),
3395 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3396 use of these extensions is likely to make other debuggers crash or
3397 refuse to read the program.
3399 @item -gcoff
3400 @opindex gcoff
3401 Produce debugging information in COFF format (if that is supported).
3402 This is the format used by SDB on most System V systems prior to
3403 System V Release 4.
3405 @item -gxcoff
3406 @opindex gxcoff
3407 Produce debugging information in XCOFF format (if that is supported).
3408 This is the format used by the DBX debugger on IBM RS/6000 systems.
3410 @item -gxcoff+
3411 @opindex gxcoff+
3412 Produce debugging information in XCOFF format (if that is supported),
3413 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3414 use of these extensions is likely to make other debuggers crash or
3415 refuse to read the program, and may cause assemblers other than the GNU
3416 assembler (GAS) to fail with an error.
3418 @item -gdwarf-2
3419 @opindex gdwarf-2
3420 Produce debugging information in DWARF version 2 format (if that is
3421 supported).  This is the format used by DBX on IRIX 6.  With this
3422 option, GCC uses features of DWARF version 3 when they are useful;
3423 version 3 is upward compatible with version 2, but may still cause
3424 problems for older debuggers.
3426 @item -gvms
3427 @opindex gvms
3428 Produce debugging information in VMS debug format (if that is
3429 supported).  This is the format used by DEBUG on VMS systems.
3431 @item -g@var{level}
3432 @itemx -ggdb@var{level}
3433 @itemx -gstabs@var{level}
3434 @itemx -gcoff@var{level}
3435 @itemx -gxcoff@var{level}
3436 @itemx -gvms@var{level}
3437 Request debugging information and also use @var{level} to specify how
3438 much information.  The default level is 2.
3440 Level 1 produces minimal information, enough for making backtraces in
3441 parts of the program that you don't plan to debug.  This includes
3442 descriptions of functions and external variables, but no information
3443 about local variables and no line numbers.
3445 Level 3 includes extra information, such as all the macro definitions
3446 present in the program.  Some debuggers support macro expansion when
3447 you use @option{-g3}.
3449 @option{-gdwarf-2} does not accept a concatenated debug level, because
3450 GCC used to support an option @option{-gdwarf} that meant to generate
3451 debug information in version 1 of the DWARF format (which is very
3452 different from version 2), and it would have been too confusing.  That
3453 debug format is long obsolete, but the option cannot be changed now.
3454 Instead use an additional @option{-g@var{level}} option to change the
3455 debug level for DWARF2.
3457 @item -feliminate-dwarf2-dups
3458 @opindex feliminate-dwarf2-dups
3459 Compress DWARF2 debugging information by eliminating duplicated
3460 information about each symbol.  This option only makes sense when
3461 generating DWARF2 debugging information with @option{-gdwarf-2}.
3463 @cindex @command{prof}
3464 @item -p
3465 @opindex p
3466 Generate extra code to write profile information suitable for the
3467 analysis program @command{prof}.  You must use this option when compiling
3468 the source files you want data about, and you must also use it when
3469 linking.
3471 @cindex @command{gprof}
3472 @item -pg
3473 @opindex pg
3474 Generate extra code to write profile information suitable for the
3475 analysis program @command{gprof}.  You must use this option when compiling
3476 the source files you want data about, and you must also use it when
3477 linking.
3479 @item -Q
3480 @opindex Q
3481 Makes the compiler print out each function name as it is compiled, and
3482 print some statistics about each pass when it finishes.
3484 @item -ftime-report
3485 @opindex ftime-report
3486 Makes the compiler print some statistics about the time consumed by each
3487 pass when it finishes.
3489 @item -fmem-report
3490 @opindex fmem-report
3491 Makes the compiler print some statistics about permanent memory
3492 allocation when it finishes.
3494 @item -fprofile-arcs
3495 @opindex fprofile-arcs
3496 Add code so that program flow @dfn{arcs} are instrumented.  During
3497 execution the program records how many times each branch and call is
3498 executed and how many times it is taken or returns.  When the compiled
3499 program exits it saves this data to a file called
3500 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3501 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3502 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3503 @var{auxname} is generated from the name of the output file, if
3504 explicitly specified and it is not the final executable, otherwise it is
3505 the basename of the source file.  In both cases any suffix is removed
3506 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3507 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3508 @xref{Cross-profiling}.
3510 @cindex @command{gcov}
3511 @item --coverage
3512 @opindex coverage
3514 This option is used to compile and link code instrumented for coverage
3515 analysis.  The option is a synonym for @option{-fprofile-arcs}
3516 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3517 linking).  See the documentation for those options for more details.
3519 @itemize
3521 @item
3522 Compile the source files with @option{-fprofile-arcs} plus optimization
3523 and code generation options.  For test coverage analysis, use the
3524 additional @option{-ftest-coverage} option.  You do not need to profile
3525 every source file in a program.
3527 @item
3528 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3529 (the latter implies the former).
3531 @item
3532 Run the program on a representative workload to generate the arc profile
3533 information.  This may be repeated any number of times.  You can run
3534 concurrent instances of your program, and provided that the file system
3535 supports locking, the data files will be correctly updated.  Also
3536 @code{fork} calls are detected and correctly handled (double counting
3537 will not happen).
3539 @item
3540 For profile-directed optimizations, compile the source files again with
3541 the same optimization and code generation options plus
3542 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3543 Control Optimization}).
3545 @item
3546 For test coverage analysis, use @command{gcov} to produce human readable
3547 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3548 @command{gcov} documentation for further information.
3550 @end itemize
3552 With @option{-fprofile-arcs}, for each function of your program GCC
3553 creates a program flow graph, then finds a spanning tree for the graph.
3554 Only arcs that are not on the spanning tree have to be instrumented: the
3555 compiler adds code to count the number of times that these arcs are
3556 executed.  When an arc is the only exit or only entrance to a block, the
3557 instrumentation code can be added to the block; otherwise, a new basic
3558 block must be created to hold the instrumentation code.
3560 @item -ftree-based-profiling
3561 @opindex ftree-based-profiling
3562 This option is used in addition to @option{-fprofile-arcs} or
3563 @option{-fbranch-probabilities} to control whether those optimizations
3564 are performed on a tree-based or rtl-based internal representation.
3565 If you use this option when compiling with @option{-fprofile-arcs},
3566 you must also use it when compiling later with @option{-fbranch-probabilities}.
3567 Currently the tree-based optimization is in an early stage of
3568 development, and this option is recommended only for those people
3569 working on improving it.
3571 @need 2000
3572 @item -ftest-coverage
3573 @opindex ftest-coverage
3574 Produce a notes file that the @command{gcov} code-coverage utility
3575 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3576 show program coverage.  Each source file's note file is called
3577 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3578 above for a description of @var{auxname} and instructions on how to
3579 generate test coverage data.  Coverage data will match the source files
3580 more closely, if you do not optimize.
3582 @item -d@var{letters}
3583 @item -fdump-rtl-@var{pass}
3584 @opindex d
3585 Says to make debugging dumps during compilation at times specified by
3586 @var{letters}.    This is used for debugging the RTL-based passes of the
3587 compiler.  The file names for most of the dumps are made by appending a
3588 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3589 from the name of the output file, if explicitly specified and it is not
3590 an executable, otherwise it is the basename of the source file.
3592 Most debug dumps can be enabled either passing a letter to the @option{-d}
3593 option, or with a long @option{-fdump-rtl} switch; here are the possible
3594 letters for use in @var{letters} and @var{pass}, and their meanings:
3596 @table @gcctabopt
3597 @item -dA
3598 @opindex dA
3599 Annotate the assembler output with miscellaneous debugging information.
3601 @item -db
3602 @itemx -fdump-rtl-bp
3603 @opindex db
3604 @opindex fdump-rtl-bp
3605 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3607 @item -dB
3608 @itemx -fdump-rtl-bbro
3609 @opindex dB
3610 @opindex fdump-rtl-bbro
3611 Dump after block reordering, to @file{@var{file}.30.bbro}.
3613 @item -dc
3614 @itemx -fdump-rtl-combine
3615 @opindex dc
3616 @opindex fdump-rtl-combine
3617 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3619 @item -dC
3620 @itemx -fdump-rtl-ce1
3621 @itemx -fdump-rtl-ce2
3622 @opindex dC
3623 @opindex fdump-rtl-ce1
3624 @opindex fdump-rtl-ce2
3625 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3626 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3627 and @option{-fdump-rtl-ce2} enable dumping after the second if
3628 conversion, to the file @file{@var{file}.18.ce2}.
3630 @item -dd
3631 @itemx -fdump-rtl-btl
3632 @itemx -fdump-rtl-dbr
3633 @opindex dd
3634 @opindex fdump-rtl-btl
3635 @opindex fdump-rtl-dbr
3636 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3637 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3638 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3639 scheduling, to @file{@var{file}.36.dbr}.
3641 @item -dD
3642 @opindex dD
3643 Dump all macro definitions, at the end of preprocessing, in addition to
3644 normal output.
3646 @item -dE
3647 @itemx -fdump-rtl-ce3
3648 @opindex dE
3649 @opindex fdump-rtl-ce3
3650 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3652 @item -df
3653 @itemx -fdump-rtl-cfg
3654 @itemx -fdump-rtl-life
3655 @opindex df
3656 @opindex fdump-rtl-cfg
3657 @opindex fdump-rtl-life
3658 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3659 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3660 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3661 to @file{@var{file}.16.life}.
3663 @item -dg
3664 @itemx -fdump-rtl-greg
3665 @opindex dg
3666 @opindex fdump-rtl-greg
3667 Dump after global register allocation, to @file{@var{file}.23.greg}.
3669 @item -dG
3670 @itemx -fdump-rtl-gcse
3671 @itemx -fdump-rtl-bypass
3672 @opindex dG
3673 @opindex fdump-rtl-gcse
3674 @opindex fdump-rtl-bypass
3675 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3676 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3677 enable dumping after jump bypassing and control flow optimizations, to
3678 @file{@var{file}.07.bypass}.
3680 @item -dh
3681 @itemx -fdump-rtl-eh
3682 @opindex dh
3683 @opindex fdump-rtl-eh
3684 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3686 @item -di
3687 @itemx -fdump-rtl-sibling
3688 @opindex di
3689 @opindex fdump-rtl-sibling
3690 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3692 @item -dj
3693 @itemx -fdump-rtl-jump
3694 @opindex dj
3695 @opindex fdump-rtl-jump
3696 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3698 @item -dk
3699 @itemx -fdump-rtl-stack
3700 @opindex dk
3701 @opindex fdump-rtl-stack
3702 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3704 @item -dl
3705 @itemx -fdump-rtl-lreg
3706 @opindex dl
3707 @opindex fdump-rtl-lreg
3708 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3710 @item -dL
3711 @itemx -fdump-rtl-loop
3712 @itemx -fdump-rtl-loop2
3713 @opindex dL
3714 @opindex fdump-rtl-loop
3715 @opindex fdump-rtl-loop2
3716 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3717 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3718 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3719 @file{@var{file}.13.loop2}.
3721 @item -dm
3722 @itemx -fdump-rtl-sms
3723 @opindex dm
3724 @opindex fdump-rtl-sms
3725 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3727 @item -dM
3728 @itemx -fdump-rtl-mach
3729 @opindex dM
3730 @opindex fdump-rtl-mach
3731 Dump after performing the machine dependent reorganization pass, to
3732 @file{@var{file}.35.mach}.
3734 @item -dn
3735 @itemx -fdump-rtl-rnreg
3736 @opindex dn
3737 @opindex fdump-rtl-rnreg
3738 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3740 @item -dN
3741 @itemx -fdump-rtl-regmove
3742 @opindex dN
3743 @opindex fdump-rtl-regmove
3744 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3746 @item -do
3747 @itemx -fdump-rtl-postreload
3748 @opindex do
3749 @opindex fdump-rtl-postreload
3750 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3752 @item -dr
3753 @itemx -fdump-rtl-expand
3754 @opindex dr
3755 @opindex fdump-rtl-expand
3756 Dump after RTL generation, to @file{@var{file}.00.expand}.
3758 @item -dR
3759 @itemx -fdump-rtl-sched2
3760 @opindex dR
3761 @opindex fdump-rtl-sched2
3762 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3764 @item -ds
3765 @itemx -fdump-rtl-cse
3766 @opindex ds
3767 @opindex fdump-rtl-cse
3768 Dump after CSE (including the jump optimization that sometimes follows
3769 CSE), to @file{@var{file}.04.cse}.
3771 @item -dS
3772 @itemx -fdump-rtl-sched
3773 @opindex dS
3774 @opindex fdump-rtl-sched
3775 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3777 @item -dt
3778 @itemx -fdump-rtl-cse2
3779 @opindex dt
3780 @opindex fdump-rtl-cse2
3781 Dump after the second CSE pass (including the jump optimization that
3782 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3784 @item -dT
3785 @itemx -fdump-rtl-tracer
3786 @opindex dT
3787 @opindex fdump-rtl-tracer
3788 Dump after running tracer, to @file{@var{file}.12.tracer}.
3790 @item -dV
3791 @itemx -fdump-rtl-vpt
3792 @itemx -fdump-rtl-vartrack
3793 @opindex dV
3794 @opindex fdump-rtl-vpt
3795 @opindex fdump-rtl-vartrack
3796 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3797 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3798 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3799 to @file{@var{file}.34.vartrack}.
3801 @item -dw
3802 @itemx -fdump-rtl-flow2
3803 @opindex dw
3804 @opindex fdump-rtl-flow2
3805 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3807 @item -dz
3808 @itemx -fdump-rtl-peephole2
3809 @opindex dz
3810 @opindex fdump-rtl-peephole2
3811 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3813 @item -dZ
3814 @itemx -fdump-rtl-web
3815 @opindex dZ
3816 @opindex fdump-rtl-web
3817 Dump after live range splitting, to @file{@var{file}.14.web}.
3819 @item -da
3820 @itemx -fdump-rtl-all
3821 @opindex da
3822 @opindex fdump-rtl-all
3823 Produce all the dumps listed above.
3825 @item -dH
3826 @opindex dH
3827 Produce a core dump whenever an error occurs.
3829 @item -dm
3830 @opindex dm
3831 Print statistics on memory usage, at the end of the run, to
3832 standard error.
3834 @item -dp
3835 @opindex dp
3836 Annotate the assembler output with a comment indicating which
3837 pattern and alternative was used.  The length of each instruction is
3838 also printed.
3840 @item -dP
3841 @opindex dP
3842 Dump the RTL in the assembler output as a comment before each instruction.
3843 Also turns on @option{-dp} annotation.
3845 @item -dv
3846 @opindex dv
3847 For each of the other indicated dump files (either with @option{-d} or
3848 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3849 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3851 @item -dx
3852 @opindex dx
3853 Just generate RTL for a function instead of compiling it.  Usually used
3854 with @samp{r} (@option{-fdump-rtl-expand}).
3856 @item -dy
3857 @opindex dy
3858 Dump debugging information during parsing, to standard error.
3859 @end table
3861 @item -fdump-unnumbered
3862 @opindex fdump-unnumbered
3863 When doing debugging dumps (see @option{-d} option above), suppress instruction
3864 numbers and line number note output.  This makes it more feasible to
3865 use diff on debugging dumps for compiler invocations with different
3866 options, in particular with and without @option{-g}.
3868 @item -fdump-translation-unit @r{(C++ only)}
3869 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3870 @opindex fdump-translation-unit
3871 Dump a representation of the tree structure for the entire translation
3872 unit to a file.  The file name is made by appending @file{.tu} to the
3873 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3874 controls the details of the dump as described for the
3875 @option{-fdump-tree} options.
3877 @item -fdump-class-hierarchy @r{(C++ only)}
3878 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3879 @opindex fdump-class-hierarchy
3880 Dump a representation of each class's hierarchy and virtual function
3881 table layout to a file.  The file name is made by appending @file{.class}
3882 to the source file name.  If the @samp{-@var{options}} form is used,
3883 @var{options} controls the details of the dump as described for the
3884 @option{-fdump-tree} options.
3886 @item -fdump-ipa-@var{switch}
3887 @opindex fdump-ipa
3888 Control the dumping at various stages of inter-procedural analysis
3889 language tree to a file.  The file name is generated by appending a switch
3890 specific suffix to the source file name.  The following dumps are possible:
3892 @table @samp
3893 @item all
3894 Enables all inter-procedural analysis dumps; currently the only produced
3895 dump is the @samp{cgraph} dump.
3897 @item cgraph
3898 Dumps information about call-graph optimization, unused function removal,
3899 and inlining decisions.
3900 @end table
3902 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3903 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3904 @opindex fdump-tree
3905 Control the dumping at various stages of processing the intermediate
3906 language tree to a file.  The file name is generated by appending a switch
3907 specific suffix to the source file name.  If the @samp{-@var{options}}
3908 form is used, @var{options} is a list of @samp{-} separated options that
3909 control the details of the dump.  Not all options are applicable to all
3910 dumps, those which are not meaningful will be ignored.  The following
3911 options are available
3913 @table @samp
3914 @item address
3915 Print the address of each node.  Usually this is not meaningful as it
3916 changes according to the environment and source file.  Its primary use
3917 is for tying up a dump file with a debug environment.
3918 @item slim
3919 Inhibit dumping of members of a scope or body of a function merely
3920 because that scope has been reached.  Only dump such items when they
3921 are directly reachable by some other path.  When dumping pretty-printed
3922 trees, this option inhibits dumping the bodies of control structures.
3923 @item raw
3924 Print a raw representation of the tree.  By default, trees are
3925 pretty-printed into a C-like representation.
3926 @item details
3927 Enable more detailed dumps (not honored by every dump option).
3928 @item stats
3929 Enable dumping various statistics about the pass (not honored by every dump
3930 option).
3931 @item blocks
3932 Enable showing basic block boundaries (disabled in raw dumps).
3933 @item vops
3934 Enable showing virtual operands for every statement.
3935 @item lineno
3936 Enable showing line numbers for statements.
3937 @item uid
3938 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3939 @item all
3940 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3941 @end table
3943 The following tree dumps are possible:
3944 @table @samp
3946 @item original
3947 Dump before any tree based optimization, to @file{@var{file}.original}.
3949 @item optimized
3950 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3952 @item inlined
3953 Dump after function inlining, to @file{@var{file}.inlined}.
3955 @item gimple
3956 @opindex fdump-tree-gimple
3957 Dump each function before and after the gimplification pass to a file.  The
3958 file name is made by appending @file{.gimple} to the source file name.
3960 @item cfg
3961 @opindex fdump-tree-cfg
3962 Dump the control flow graph of each function to a file.  The file name is
3963 made by appending @file{.cfg} to the source file name.
3965 @item vcg
3966 @opindex fdump-tree-vcg
3967 Dump the control flow graph of each function to a file in VCG format.  The
3968 file name is made by appending @file{.vcg} to the source file name.  Note
3969 that if the file contains more than one function, the generated file cannot
3970 be used directly by VCG@.  You will need to cut and paste each function's
3971 graph into its own separate file first.
3973 @item ch
3974 @opindex fdump-tree-ch
3975 Dump each function after copying loop headers.  The file name is made by
3976 appending @file{.ch} to the source file name.
3978 @item ssa
3979 @opindex fdump-tree-ssa
3980 Dump SSA related information to a file.  The file name is made by appending
3981 @file{.ssa} to the source file name.
3983 @item salias
3984 @opindex fdump-tree-salias
3985 Dump structure aliasing variable information to a file.  This file name
3986 is made by appending @file{.salias} to the source file name.
3988 @item alias
3989 @opindex fdump-tree-alias
3990 Dump aliasing information for each function.  The file name is made by
3991 appending @file{.alias} to the source file name.
3993 @item ccp
3994 @opindex fdump-tree-ccp
3995 Dump each function after CCP@.  The file name is made by appending
3996 @file{.ccp} to the source file name.
3998 @item storeccp
3999 @opindex fdump-tree-storeccp
4000 Dump each function after STORE-CCP.  The file name is made by appending
4001 @file{.storeccp} to the source file name.
4003 @item pre
4004 @opindex fdump-tree-pre
4005 Dump trees after partial redundancy elimination.  The file name is made
4006 by appending @file{.pre} to the source file name.
4008 @item fre
4009 @opindex fdump-tree-fre
4010 Dump trees after full redundancy elimination.  The file name is made
4011 by appending @file{.fre} to the source file name.
4013 @item copyprop
4014 @opindex fdump-tree-copyprop
4015 Dump trees after copy propagation.  The file name is made
4016 by appending @file{.copyprop} to the source file name.
4018 @item store_copyprop
4019 @opindex fdump-tree-store_copyprop
4020 Dump trees after store copy-propagation.  The file name is made
4021 by appending @file{.store_copyprop} to the source file name.
4023 @item dce
4024 @opindex fdump-tree-dce
4025 Dump each function after dead code elimination.  The file name is made by
4026 appending @file{.dce} to the source file name.
4028 @item mudflap
4029 @opindex fdump-tree-mudflap
4030 Dump each function after adding mudflap instrumentation.  The file name is
4031 made by appending @file{.mudflap} to the source file name.
4033 @item sra
4034 @opindex fdump-tree-sra
4035 Dump each function after performing scalar replacement of aggregates.  The
4036 file name is made by appending @file{.sra} to the source file name.
4038 @item sink
4039 @opindex fdump-tree-sink
4040 Dump each function after performing code sinking.  The file name is made
4041 by appending @file{.sink} to the source file name. 
4043 @item dom
4044 @opindex fdump-tree-dom
4045 Dump each function after applying dominator tree optimizations.  The file
4046 name is made by appending @file{.dom} to the source file name.
4048 @item dse
4049 @opindex fdump-tree-dse
4050 Dump each function after applying dead store elimination.  The file
4051 name is made by appending @file{.dse} to the source file name.
4053 @item phiopt
4054 @opindex fdump-tree-phiopt
4055 Dump each function after optimizing PHI nodes into straightline code.  The file
4056 name is made by appending @file{.phiopt} to the source file name.
4058 @item forwprop
4059 @opindex fdump-tree-forwprop
4060 Dump each function after forward propagating single use variables.  The file
4061 name is made by appending @file{.forwprop} to the source file name.
4063 @item copyrename
4064 @opindex fdump-tree-copyrename
4065 Dump each function after applying the copy rename optimization.  The file
4066 name is made by appending @file{.copyrename} to the source file name.
4068 @item nrv
4069 @opindex fdump-tree-nrv
4070 Dump each function after applying the named return value optimization on
4071 generic trees.  The file name is made by appending @file{.nrv} to the source
4072 file name.
4074 @item vect
4075 @opindex fdump-tree-vect
4076 Dump each function after applying vectorization of loops.  The file name is
4077 made by appending @file{.vect} to the source file name.
4079 @item vrp
4080 @opindex fdump-tree-vrp
4081 Dump each function after Value Range Propagation (VRP).  The file name
4082 is made by appending @file{.vrp} to the source file name.
4084 @item all
4085 @opindex fdump-tree-all
4086 Enable all the available tree dumps with the flags provided in this option.
4087 @end table
4089 @item -ftree-vectorizer-verbose=@var{n}
4090 @opindex ftree-vectorizer-verbose
4091 This option controls the amount of debugging output the vectorizer prints.
4092 This information is written to standard error, unless @option{-fdump-tree-all}
4093 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4094 usual dump listing file, @file{.vect}.
4096 @item -frandom-seed=@var{string}
4097 @opindex frandom-string
4098 This option provides a seed that GCC uses when it would otherwise use
4099 random numbers.  It is used to generate certain symbol names
4100 that have to be different in every compiled file.  It is also used to
4101 place unique stamps in coverage data files and the object files that
4102 produce them.  You can use the @option{-frandom-seed} option to produce
4103 reproducibly identical object files.
4105 The @var{string} should be different for every file you compile.
4107 @item -fsched-verbose=@var{n}
4108 @opindex fsched-verbose
4109 On targets that use instruction scheduling, this option controls the
4110 amount of debugging output the scheduler prints.  This information is
4111 written to standard error, unless @option{-dS} or @option{-dR} is
4112 specified, in which case it is output to the usual dump
4113 listing file, @file{.sched} or @file{.sched2} respectively.  However
4114 for @var{n} greater than nine, the output is always printed to standard
4115 error.
4117 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4118 same information as @option{-dRS}.  For @var{n} greater than one, it
4119 also output basic block probabilities, detailed ready list information
4120 and unit/insn info.  For @var{n} greater than two, it includes RTL
4121 at abort point, control-flow and regions info.  And for @var{n} over
4122 four, @option{-fsched-verbose} also includes dependence info.
4124 @item -save-temps
4125 @opindex save-temps
4126 Store the usual ``temporary'' intermediate files permanently; place them
4127 in the current directory and name them based on the source file.  Thus,
4128 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4129 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4130 preprocessed @file{foo.i} output file even though the compiler now
4131 normally uses an integrated preprocessor.
4133 When used in combination with the @option{-x} command line option,
4134 @option{-save-temps} is sensible enough to avoid over writing an
4135 input source file with the same extension as an intermediate file.
4136 The corresponding intermediate file may be obtained by renaming the
4137 source file before using @option{-save-temps}.
4139 @item -time
4140 @opindex time
4141 Report the CPU time taken by each subprocess in the compilation
4142 sequence.  For C source files, this is the compiler proper and assembler
4143 (plus the linker if linking is done).  The output looks like this:
4145 @smallexample
4146 # cc1 0.12 0.01
4147 # as 0.00 0.01
4148 @end smallexample
4150 The first number on each line is the ``user time'', that is time spent
4151 executing the program itself.  The second number is ``system time'',
4152 time spent executing operating system routines on behalf of the program.
4153 Both numbers are in seconds.
4155 @item -fvar-tracking
4156 @opindex fvar-tracking
4157 Run variable tracking pass.  It computes where variables are stored at each
4158 position in code.  Better debugging information is then generated
4159 (if the debugging information format supports this information).
4161 It is enabled by default when compiling with optimization (@option{-Os},
4162 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4163 the debug info format supports it.
4165 @item -print-file-name=@var{library}
4166 @opindex print-file-name
4167 Print the full absolute name of the library file @var{library} that
4168 would be used when linking---and don't do anything else.  With this
4169 option, GCC does not compile or link anything; it just prints the
4170 file name.
4172 @item -print-multi-directory
4173 @opindex print-multi-directory
4174 Print the directory name corresponding to the multilib selected by any
4175 other switches present in the command line.  This directory is supposed
4176 to exist in @env{GCC_EXEC_PREFIX}.
4178 @item -print-multi-lib
4179 @opindex print-multi-lib
4180 Print the mapping from multilib directory names to compiler switches
4181 that enable them.  The directory name is separated from the switches by
4182 @samp{;}, and each switch starts with an @samp{@@} instead of the
4183 @samp{-}, without spaces between multiple switches.  This is supposed to
4184 ease shell-processing.
4186 @item -print-prog-name=@var{program}
4187 @opindex print-prog-name
4188 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4190 @item -print-libgcc-file-name
4191 @opindex print-libgcc-file-name
4192 Same as @option{-print-file-name=libgcc.a}.
4194 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4195 but you do want to link with @file{libgcc.a}.  You can do
4197 @smallexample
4198 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4199 @end smallexample
4201 @item -print-search-dirs
4202 @opindex print-search-dirs
4203 Print the name of the configured installation directory and a list of
4204 program and library directories @command{gcc} will search---and don't do anything else.
4206 This is useful when @command{gcc} prints the error message
4207 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4208 To resolve this you either need to put @file{cpp0} and the other compiler
4209 components where @command{gcc} expects to find them, or you can set the environment
4210 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4211 Don't forget the trailing @samp{/}.
4212 @xref{Environment Variables}.
4214 @item -dumpmachine
4215 @opindex dumpmachine
4216 Print the compiler's target machine (for example,
4217 @samp{i686-pc-linux-gnu})---and don't do anything else.
4219 @item -dumpversion
4220 @opindex dumpversion
4221 Print the compiler version (for example, @samp{3.0})---and don't do
4222 anything else.
4224 @item -dumpspecs
4225 @opindex dumpspecs
4226 Print the compiler's built-in specs---and don't do anything else.  (This
4227 is used when GCC itself is being built.)  @xref{Spec Files}.
4229 @item -feliminate-unused-debug-types
4230 @opindex feliminate-unused-debug-types
4231 Normally, when producing DWARF2 output, GCC will emit debugging
4232 information for all types declared in a compilation
4233 unit, regardless of whether or not they are actually used
4234 in that compilation unit.  Sometimes this is useful, such as
4235 if, in the debugger, you want to cast a value to a type that is
4236 not actually used in your program (but is declared).  More often,
4237 however, this results in a significant amount of wasted space.
4238 With this option, GCC will avoid producing debug symbol output
4239 for types that are nowhere used in the source file being compiled.
4240 @end table
4242 @node Optimize Options
4243 @section Options That Control Optimization
4244 @cindex optimize options
4245 @cindex options, optimization
4247 These options control various sorts of optimizations.
4249 Without any optimization option, the compiler's goal is to reduce the
4250 cost of compilation and to make debugging produce the expected
4251 results.  Statements are independent: if you stop the program with a
4252 breakpoint between statements, you can then assign a new value to any
4253 variable or change the program counter to any other statement in the
4254 function and get exactly the results you would expect from the source
4255 code.
4257 Turning on optimization flags makes the compiler attempt to improve
4258 the performance and/or code size at the expense of compilation time
4259 and possibly the ability to debug the program.
4261 The compiler performs optimization based on the knowledge it has of
4262 the program.  Optimization levels @option{-O2} and above, in
4263 particular, enable @emph{unit-at-a-time} mode, which allows the
4264 compiler to consider information gained from later functions in
4265 the file when compiling a function.  Compiling multiple files at
4266 once to a single output file in @emph{unit-at-a-time} mode allows
4267 the compiler to use information gained from all of the files when
4268 compiling each of them.
4270 Not all optimizations are controlled directly by a flag.  Only
4271 optimizations that have a flag are listed.
4273 @table @gcctabopt
4274 @item -O
4275 @itemx -O1
4276 @opindex O
4277 @opindex O1
4278 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4279 more memory for a large function.
4281 With @option{-O}, the compiler tries to reduce code size and execution
4282 time, without performing any optimizations that take a great deal of
4283 compilation time.
4285 @option{-O} turns on the following optimization flags:
4286 @gccoptlist{-fdefer-pop @gol
4287 -fdelayed-branch @gol
4288 -fguess-branch-probability @gol
4289 -fcprop-registers @gol
4290 -floop-optimize @gol
4291 -fif-conversion @gol
4292 -fif-conversion2 @gol
4293 -ftree-ccp @gol
4294 -ftree-dce @gol
4295 -ftree-dominator-opts @gol
4296 -ftree-dse @gol
4297 -ftree-ter @gol
4298 -ftree-lrs @gol
4299 -ftree-sra @gol
4300 -ftree-copyrename @gol
4301 -ftree-fre @gol
4302 -ftree-ch @gol
4303 -fmerge-constants}
4305 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4306 where doing so does not interfere with debugging.
4308 @item -O2
4309 @opindex O2
4310 Optimize even more.  GCC performs nearly all supported optimizations
4311 that do not involve a space-speed tradeoff.  The compiler does not
4312 perform loop unrolling or function inlining when you specify @option{-O2}.
4313 As compared to @option{-O}, this option increases both compilation time
4314 and the performance of the generated code.
4316 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4317 also turns on the following optimization flags:
4318 @gccoptlist{-fthread-jumps @gol
4319 -fcrossjumping @gol
4320 -foptimize-sibling-calls @gol
4321 -fcse-follow-jumps  -fcse-skip-blocks @gol
4322 -fgcse  -fgcse-lm  @gol
4323 -fexpensive-optimizations @gol
4324 -fstrength-reduce @gol
4325 -frerun-cse-after-loop  -frerun-loop-opt @gol
4326 -fcaller-saves @gol
4327 -fpeephole2 @gol
4328 -fschedule-insns  -fschedule-insns2 @gol
4329 -fsched-interblock  -fsched-spec @gol
4330 -fregmove @gol
4331 -fstrict-aliasing @gol
4332 -fdelete-null-pointer-checks @gol
4333 -freorder-blocks  -freorder-functions @gol
4334 -funit-at-a-time @gol
4335 -falign-functions  -falign-jumps @gol
4336 -falign-loops  -falign-labels @gol
4337 -ftree-vrp @gol
4338 -ftree-pre}
4340 Please note the warning under @option{-fgcse} about
4341 invoking @option{-O2} on programs that use computed gotos.
4343 @item -O3
4344 @opindex O3
4345 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4346 @option{-O2} and also turns on the @option{-finline-functions},
4347 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4349 @item -O0
4350 @opindex O0
4351 Do not optimize.  This is the default.
4353 @item -Os
4354 @opindex Os
4355 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4356 do not typically increase code size.  It also performs further
4357 optimizations designed to reduce code size.
4359 @option{-Os} disables the following optimization flags:
4360 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4361 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4363 If you use multiple @option{-O} options, with or without level numbers,
4364 the last such option is the one that is effective.
4365 @end table
4367 Options of the form @option{-f@var{flag}} specify machine-independent
4368 flags.  Most flags have both positive and negative forms; the negative
4369 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4370 below, only one of the forms is listed---the one you typically will
4371 use.  You can figure out the other form by either removing @samp{no-}
4372 or adding it.
4374 The following options control specific optimizations.  They are either
4375 activated by @option{-O} options or are related to ones that are.  You
4376 can use the following flags in the rare cases when ``fine-tuning'' of
4377 optimizations to be performed is desired.
4379 @table @gcctabopt
4380 @item -fno-default-inline
4381 @opindex fno-default-inline
4382 Do not make member functions inline by default merely because they are
4383 defined inside the class scope (C++ only).  Otherwise, when you specify
4384 @w{@option{-O}}, member functions defined inside class scope are compiled
4385 inline by default; i.e., you don't need to add @samp{inline} in front of
4386 the member function name.
4388 @item -fno-defer-pop
4389 @opindex fno-defer-pop
4390 Always pop the arguments to each function call as soon as that function
4391 returns.  For machines which must pop arguments after a function call,
4392 the compiler normally lets arguments accumulate on the stack for several
4393 function calls and pops them all at once.
4395 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4397 @item -fforce-mem
4398 @opindex fforce-mem
4399 Force memory operands to be copied into registers before doing
4400 arithmetic on them.  This produces better code by making all memory
4401 references potential common subexpressions.  When they are not common
4402 subexpressions, instruction combination should eliminate the separate
4403 register-load. This option is now a nop and will be removed in 4.2.
4405 @item -fforce-addr
4406 @opindex fforce-addr
4407 Force memory address constants to be copied into registers before
4408 doing arithmetic on them.
4410 @item -fomit-frame-pointer
4411 @opindex fomit-frame-pointer
4412 Don't keep the frame pointer in a register for functions that
4413 don't need one.  This avoids the instructions to save, set up and
4414 restore frame pointers; it also makes an extra register available
4415 in many functions.  @strong{It also makes debugging impossible on
4416 some machines.}
4418 On some machines, such as the VAX, this flag has no effect, because
4419 the standard calling sequence automatically handles the frame pointer
4420 and nothing is saved by pretending it doesn't exist.  The
4421 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4422 whether a target machine supports this flag.  @xref{Registers,,Register
4423 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4425 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4427 @item -foptimize-sibling-calls
4428 @opindex foptimize-sibling-calls
4429 Optimize sibling and tail recursive calls.
4431 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4433 @item -fno-inline
4434 @opindex fno-inline
4435 Don't pay attention to the @code{inline} keyword.  Normally this option
4436 is used to keep the compiler from expanding any functions inline.
4437 Note that if you are not optimizing, no functions can be expanded inline.
4439 @item -finline-functions
4440 @opindex finline-functions
4441 Integrate all simple functions into their callers.  The compiler
4442 heuristically decides which functions are simple enough to be worth
4443 integrating in this way.
4445 If all calls to a given function are integrated, and the function is
4446 declared @code{static}, then the function is normally not output as
4447 assembler code in its own right.
4449 Enabled at level @option{-O3}.
4451 @item -fearly-inlining
4452 @opindex fearly-inlining
4453 Inline functions marked by @code{always_inline} and functions whose body seems
4454 smaller than the function call overhead early before doing
4455 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4456 makes profiling significantly cheaper and usually inlining faster on programs
4457 having large chains of nested wrapper functions.
4459 Enabled by default.
4461 @item -finline-limit=@var{n}
4462 @opindex finline-limit
4463 By default, GCC limits the size of functions that can be inlined.  This flag
4464 allows the control of this limit for functions that are explicitly marked as
4465 inline (i.e., marked with the inline keyword or defined within the class
4466 definition in c++).  @var{n} is the size of functions that can be inlined in
4467 number of pseudo instructions (not counting parameter handling).  The default
4468 value of @var{n} is 600.
4469 Increasing this value can result in more inlined code at
4470 the cost of compilation time and memory consumption.  Decreasing usually makes
4471 the compilation faster and less code will be inlined (which presumably
4472 means slower programs).  This option is particularly useful for programs that
4473 use inlining heavily such as those based on recursive templates with C++.
4475 Inlining is actually controlled by a number of parameters, which may be
4476 specified individually by using @option{--param @var{name}=@var{value}}.
4477 The @option{-finline-limit=@var{n}} option sets some of these parameters
4478 as follows:
4480 @table @gcctabopt
4481  @item max-inline-insns-single
4482   is set to @var{n}/2.
4483  @item max-inline-insns-auto
4484   is set to @var{n}/2.
4485  @item min-inline-insns
4486   is set to 130 or @var{n}/4, whichever is smaller.
4487  @item max-inline-insns-rtl
4488   is set to @var{n}.
4489 @end table
4491 See below for a documentation of the individual
4492 parameters controlling inlining.
4494 @emph{Note:} pseudo instruction represents, in this particular context, an
4495 abstract measurement of function's size.  In no way does it represent a count
4496 of assembly instructions and as such its exact meaning might change from one
4497 release to an another.
4499 @item -fkeep-inline-functions
4500 @opindex fkeep-inline-functions
4501 In C, emit @code{static} functions that are declared @code{inline}
4502 into the object file, even if the function has been inlined into all
4503 of its callers.  This switch does not affect functions using the
4504 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4505 inline functions into the object file.
4507 @item -fkeep-static-consts
4508 @opindex fkeep-static-consts
4509 Emit variables declared @code{static const} when optimization isn't turned
4510 on, even if the variables aren't referenced.
4512 GCC enables this option by default.  If you want to force the compiler to
4513 check if the variable was referenced, regardless of whether or not
4514 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4516 @item -fmerge-constants
4517 Attempt to merge identical constants (string constants and floating point
4518 constants) across compilation units.
4520 This option is the default for optimized compilation if the assembler and
4521 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4522 behavior.
4524 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4526 @item -fmerge-all-constants
4527 Attempt to merge identical constants and identical variables.
4529 This option implies @option{-fmerge-constants}.  In addition to
4530 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4531 arrays or initialized constant variables with integral or floating point
4532 types.  Languages like C or C++ require each non-automatic variable to
4533 have distinct location, so using this option will result in non-conforming
4534 behavior.
4536 @item -fmodulo-sched
4537 @opindex fmodulo-sched
4538 Perform swing modulo scheduling immediately before the first scheduling
4539 pass.  This pass looks at innermost loops and reorders their
4540 instructions by overlapping different iterations.
4542 @item -fno-branch-count-reg
4543 @opindex fno-branch-count-reg
4544 Do not use ``decrement and branch'' instructions on a count register,
4545 but instead generate a sequence of instructions that decrement a
4546 register, compare it against zero, then branch based upon the result.
4547 This option is only meaningful on architectures that support such
4548 instructions, which include x86, PowerPC, IA-64 and S/390.
4550 The default is @option{-fbranch-count-reg}, enabled when
4551 @option{-fstrength-reduce} is enabled.
4553 @item -fno-function-cse
4554 @opindex fno-function-cse
4555 Do not put function addresses in registers; make each instruction that
4556 calls a constant function contain the function's address explicitly.
4558 This option results in less efficient code, but some strange hacks
4559 that alter the assembler output may be confused by the optimizations
4560 performed when this option is not used.
4562 The default is @option{-ffunction-cse}
4564 @item -fno-zero-initialized-in-bss
4565 @opindex fno-zero-initialized-in-bss
4566 If the target supports a BSS section, GCC by default puts variables that
4567 are initialized to zero into BSS@.  This can save space in the resulting
4568 code.
4570 This option turns off this behavior because some programs explicitly
4571 rely on variables going to the data section.  E.g., so that the
4572 resulting executable can find the beginning of that section and/or make
4573 assumptions based on that.
4575 The default is @option{-fzero-initialized-in-bss}.
4577 @item -fbounds-check
4578 @opindex fbounds-check
4579 For front-ends that support it, generate additional code to check that
4580 indices used to access arrays are within the declared range.  This is
4581 currently only supported by the Java and Fortran front-ends, where
4582 this option defaults to true and false respectively.
4584 @item -fmudflap -fmudflapth -fmudflapir
4585 @opindex fmudflap
4586 @opindex fmudflapth
4587 @opindex fmudflapir
4588 @cindex bounds checking
4589 @cindex mudflap
4590 For front-ends that support it (C and C++), instrument all risky
4591 pointer/array dereferencing operations, some standard library
4592 string/heap functions, and some other associated constructs with
4593 range/validity tests.  Modules so instrumented should be immune to
4594 buffer overflows, invalid heap use, and some other classes of C/C++
4595 programming errors.  The instrumentation relies on a separate runtime
4596 library (@file{libmudflap}), which will be linked into a program if
4597 @option{-fmudflap} is given at link time.  Run-time behavior of the
4598 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4599 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4600 for its options.
4602 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4603 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4604 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4605 instrumentation should ignore pointer reads.  This produces less
4606 instrumentation (and therefore faster execution) and still provides
4607 some protection against outright memory corrupting writes, but allows
4608 erroneously read data to propagate within a program.
4610 @item -fstrength-reduce
4611 @opindex fstrength-reduce
4612 Perform the optimizations of loop strength reduction and
4613 elimination of iteration variables.
4615 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4617 @item -fthread-jumps
4618 @opindex fthread-jumps
4619 Perform optimizations where we check to see if a jump branches to a
4620 location where another comparison subsumed by the first is found.  If
4621 so, the first branch is redirected to either the destination of the
4622 second branch or a point immediately following it, depending on whether
4623 the condition is known to be true or false.
4625 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4627 @item -fcse-follow-jumps
4628 @opindex fcse-follow-jumps
4629 In common subexpression elimination, scan through jump instructions
4630 when the target of the jump is not reached by any other path.  For
4631 example, when CSE encounters an @code{if} statement with an
4632 @code{else} clause, CSE will follow the jump when the condition
4633 tested is false.
4635 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4637 @item -fcse-skip-blocks
4638 @opindex fcse-skip-blocks
4639 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4640 follow jumps which conditionally skip over blocks.  When CSE
4641 encounters a simple @code{if} statement with no else clause,
4642 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4643 body of the @code{if}.
4645 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4647 @item -frerun-cse-after-loop
4648 @opindex frerun-cse-after-loop
4649 Re-run common subexpression elimination after loop optimizations has been
4650 performed.
4652 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4654 @item -frerun-loop-opt
4655 @opindex frerun-loop-opt
4656 Run the loop optimizer twice.
4658 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4660 @item -fgcse
4661 @opindex fgcse
4662 Perform a global common subexpression elimination pass.
4663 This pass also performs global constant and copy propagation.
4665 @emph{Note:} When compiling a program using computed gotos, a GCC
4666 extension, you may get better runtime performance if you disable
4667 the global common subexpression elimination pass by adding
4668 @option{-fno-gcse} to the command line.
4670 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4672 @item -fgcse-lm
4673 @opindex fgcse-lm
4674 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4675 attempt to move loads which are only killed by stores into themselves.  This
4676 allows a loop containing a load/store sequence to be changed to a load outside
4677 the loop, and a copy/store within the loop.
4679 Enabled by default when gcse is enabled.
4681 @item -fgcse-sm
4682 @opindex fgcse-sm
4683 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4684 global common subexpression elimination.  This pass will attempt to move
4685 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4686 loops containing a load/store sequence can be changed to a load before
4687 the loop and a store after the loop.
4689 Not enabled at any optimization level.
4691 @item -fgcse-las
4692 @opindex fgcse-las
4693 When @option{-fgcse-las} is enabled, the global common subexpression
4694 elimination pass eliminates redundant loads that come after stores to the
4695 same memory location (both partial and full redundancies).
4697 Not enabled at any optimization level.
4699 @item -fgcse-after-reload
4700 @opindex fgcse-after-reload
4701 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4702 pass is performed after reload.  The purpose of this pass is to cleanup
4703 redundant spilling.
4705 @item -floop-optimize
4706 @opindex floop-optimize
4707 Perform loop optimizations: move constant expressions out of loops, simplify
4708 exit test conditions and optionally do strength-reduction as well.
4710 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4712 @item -floop-optimize2
4713 @opindex floop-optimize2
4714 Perform loop optimizations using the new loop optimizer.  The optimizations
4715 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4716 by separate flags.
4718 @item -fcrossjumping
4719 @opindex crossjumping
4720 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4721 resulting code may or may not perform better than without cross-jumping.
4723 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4725 @item -fif-conversion
4726 @opindex if-conversion
4727 Attempt to transform conditional jumps into branch-less equivalents.  This
4728 include use of conditional moves, min, max, set flags and abs instructions, and
4729 some tricks doable by standard arithmetics.  The use of conditional execution
4730 on chips where it is available is controlled by @code{if-conversion2}.
4732 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4734 @item -fif-conversion2
4735 @opindex if-conversion2
4736 Use conditional execution (where available) to transform conditional jumps into
4737 branch-less equivalents.
4739 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4741 @item -fdelete-null-pointer-checks
4742 @opindex fdelete-null-pointer-checks
4743 Use global dataflow analysis to identify and eliminate useless checks
4744 for null pointers.  The compiler assumes that dereferencing a null
4745 pointer would have halted the program.  If a pointer is checked after
4746 it has already been dereferenced, it cannot be null.
4748 In some environments, this assumption is not true, and programs can
4749 safely dereference null pointers.  Use
4750 @option{-fno-delete-null-pointer-checks} to disable this optimization
4751 for programs which depend on that behavior.
4753 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4755 @item -fexpensive-optimizations
4756 @opindex fexpensive-optimizations
4757 Perform a number of minor optimizations that are relatively expensive.
4759 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4761 @item -foptimize-register-move
4762 @itemx -fregmove
4763 @opindex foptimize-register-move
4764 @opindex fregmove
4765 Attempt to reassign register numbers in move instructions and as
4766 operands of other simple instructions in order to maximize the amount of
4767 register tying.  This is especially helpful on machines with two-operand
4768 instructions.
4770 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4771 optimization.
4773 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4775 @item -fdelayed-branch
4776 @opindex fdelayed-branch
4777 If supported for the target machine, attempt to reorder instructions
4778 to exploit instruction slots available after delayed branch
4779 instructions.
4781 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4783 @item -fschedule-insns
4784 @opindex fschedule-insns
4785 If supported for the target machine, attempt to reorder instructions to
4786 eliminate execution stalls due to required data being unavailable.  This
4787 helps machines that have slow floating point or memory load instructions
4788 by allowing other instructions to be issued until the result of the load
4789 or floating point instruction is required.
4791 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4793 @item -fschedule-insns2
4794 @opindex fschedule-insns2
4795 Similar to @option{-fschedule-insns}, but requests an additional pass of
4796 instruction scheduling after register allocation has been done.  This is
4797 especially useful on machines with a relatively small number of
4798 registers and where memory load instructions take more than one cycle.
4800 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4802 @item -fno-sched-interblock
4803 @opindex fno-sched-interblock
4804 Don't schedule instructions across basic blocks.  This is normally
4805 enabled by default when scheduling before register allocation, i.e.@:
4806 with @option{-fschedule-insns} or at @option{-O2} or higher.
4808 @item -fno-sched-spec
4809 @opindex fno-sched-spec
4810 Don't allow speculative motion of non-load instructions.  This is normally
4811 enabled by default when scheduling before register allocation, i.e.@:
4812 with @option{-fschedule-insns} or at @option{-O2} or higher.
4814 @item -fsched-spec-load
4815 @opindex fsched-spec-load
4816 Allow speculative motion of some load instructions.  This only makes
4817 sense when scheduling before register allocation, i.e.@: with
4818 @option{-fschedule-insns} or at @option{-O2} or higher.
4820 @item -fsched-spec-load-dangerous
4821 @opindex fsched-spec-load-dangerous
4822 Allow speculative motion of more load instructions.  This only makes
4823 sense when scheduling before register allocation, i.e.@: with
4824 @option{-fschedule-insns} or at @option{-O2} or higher.
4826 @item -fsched-stalled-insns=@var{n}
4827 @opindex fsched-stalled-insns
4828 Define how many insns (if any) can be moved prematurely from the queue
4829 of stalled insns into the ready list, during the second scheduling pass.
4831 @item -fsched-stalled-insns-dep=@var{n}
4832 @opindex fsched-stalled-insns-dep
4833 Define how many insn groups (cycles) will be examined for a dependency
4834 on a stalled insn that is candidate for premature removal from the queue
4835 of stalled insns.  Has an effect only during the second scheduling pass,
4836 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4838 @item -fsched2-use-superblocks
4839 @opindex fsched2-use-superblocks
4840 When scheduling after register allocation, do use superblock scheduling
4841 algorithm.  Superblock scheduling allows motion across basic block boundaries
4842 resulting on faster schedules.  This option is experimental, as not all machine
4843 descriptions used by GCC model the CPU closely enough to avoid unreliable
4844 results from the algorithm.
4846 This only makes sense when scheduling after register allocation, i.e.@: with
4847 @option{-fschedule-insns2} or at @option{-O2} or higher.
4849 @item -fsched2-use-traces
4850 @opindex fsched2-use-traces
4851 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4852 allocation and additionally perform code duplication in order to increase the
4853 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4854 trace formation.
4856 This mode should produce faster but significantly longer programs.  Also
4857 without @option{-fbranch-probabilities} the traces constructed may not
4858 match the reality and hurt the performance.  This only makes
4859 sense when scheduling after register allocation, i.e.@: with
4860 @option{-fschedule-insns2} or at @option{-O2} or higher.
4862 @item -freschedule-modulo-scheduled-loops
4863 @opindex fscheduling-in-modulo-scheduled-loops
4864 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4865 we may want to prevent the later scheduling passes from changing its schedule, we use this
4866 option to control that.
4868 @item -fcaller-saves
4869 @opindex fcaller-saves
4870 Enable values to be allocated in registers that will be clobbered by
4871 function calls, by emitting extra instructions to save and restore the
4872 registers around such calls.  Such allocation is done only when it
4873 seems to result in better code than would otherwise be produced.
4875 This option is always enabled by default on certain machines, usually
4876 those which have no call-preserved registers to use instead.
4878 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4880 @item -ftree-pre
4881 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4882 enabled by default at @option{-O2} and @option{-O3}.
4884 @item -ftree-fre
4885 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4886 between FRE and PRE is that FRE only considers expressions
4887 that are computed on all paths leading to the redundant computation.
4888 This analysis faster than PRE, though it exposes fewer redundancies.
4889 This flag is enabled by default at @option{-O} and higher.
4891 @item -ftree-copy-prop
4892 Perform copy propagation on trees.  This pass eliminates unnecessary
4893 copy operations.  This flag is enabled by default at @option{-O} and
4894 higher.
4896 @item -ftree-store-copy-prop
4897 Perform copy propagation of memory loads and stores.  This pass
4898 eliminates unnecessary copy operations in memory references
4899 (structures, global variables, arrays, etc).  This flag is enabled by
4900 default at @option{-O2} and higher.
4902 @item -ftree-salias
4903 Perform structural alias analysis on trees.  This flag
4904 is enabled by default at @option{-O} and higher.
4906 @item -ftree-sink
4907 Perform forward store motion  on trees.  This flag is
4908 enabled by default at @option{-O} and higher.
4910 @item -ftree-ccp
4911 Perform sparse conditional constant propagation (CCP) on trees.  This
4912 pass only operates on local scalar variables and is enabled by default
4913 at @option{-O} and higher.
4915 @item -ftree-store-ccp
4916 Perform sparse conditional constant propagation (CCP) on trees.  This
4917 pass operates on both local scalar variables and memory stores and
4918 loads (global variables, structures, arrays, etc).  This flag is
4919 enabled by default at @option{-O2} and higher.
4921 @item -ftree-dce
4922 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4923 default at @option{-O} and higher.
4925 @item -ftree-dominator-opts
4926 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4927 default at @option{-O} and higher.
4929 @item -ftree-ch
4930 Perform loop header copying on trees.  This is beneficial since it increases
4931 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4932 is enabled by default at @option{-O} and higher.  It is not enabled
4933 for @option{-Os}, since it usually increases code size.
4935 @item -ftree-loop-optimize
4936 Perform loop optimizations on trees.  This flag is enabled by default
4937 at @option{-O} and higher.
4939 @item -ftree-loop-linear
4940 Perform linear loop transformations on tree.  This flag can improve cache
4941 performance and allow further loop optimizations to take place.
4943 @item -ftree-loop-im
4944 Perform loop invariant motion on trees.  This pass moves only invariants that
4945 would be hard to handle at RTL level (function calls, operations that expand to
4946 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4947 operands of conditions that are invariant out of the loop, so that we can use
4948 just trivial invariantness analysis in loop unswitching.  The pass also includes
4949 store motion.
4951 @item -ftree-loop-ivcanon
4952 Create a canonical counter for number of iterations in the loop for that
4953 determining number of iterations requires complicated analysis.  Later
4954 optimizations then may determine the number easily.  Useful especially
4955 in connection with unrolling.
4957 @item -fivopts
4958 Perform induction variable optimizations (strength reduction, induction
4959 variable merging and induction variable elimination) on trees.
4961 @item -ftree-sra
4962 Perform scalar replacement of aggregates.  This pass replaces structure
4963 references with scalars to prevent committing structures to memory too
4964 early.  This flag is enabled by default at @option{-O} and higher.
4966 @item -ftree-copyrename
4967 Perform copy renaming on trees.  This pass attempts to rename compiler
4968 temporaries to other variables at copy locations, usually resulting in
4969 variable names which more closely resemble the original variables.  This flag
4970 is enabled by default at @option{-O} and higher.
4972 @item -ftree-ter
4973 Perform temporary expression replacement during the SSA->normal phase.  Single
4974 use/single def temporaries are replaced at their use location with their
4975 defining expression.  This results in non-GIMPLE code, but gives the expanders
4976 much more complex trees to work on resulting in better RTL generation.  This is
4977 enabled by default at @option{-O} and higher.
4979 @item -ftree-lrs
4980 Perform live range splitting during the SSA->normal phase.  Distinct live
4981 ranges of a variable are split into unique variables, allowing for better
4982 optimization later.  This is enabled by default at @option{-O} and higher.
4984 @item -ftree-vectorize
4985 Perform loop vectorization on trees.
4987 @item -ftree-vrp
4988 Perform Value Range Propagation on trees.  This is similar to the
4989 constant propagation pass, but instead of values, ranges of values are
4990 propagated.  This allows the optimizers to remove unnecessary range
4991 checks like array bound checks and null pointer checks.  This is
4992 enabled by default at @option{-O2} and higher.  Null pointer check
4993 elimination is only done if @option{-fdelete-null-pointer-checks} is
4994 enabled.
4996 @item -ftracer
4997 @opindex ftracer
4998 Perform tail duplication to enlarge superblock size.  This transformation
4999 simplifies the control flow of the function allowing other optimizations to do
5000 better job.
5002 @item -funroll-loops
5003 @opindex funroll-loops
5004 Unroll loops whose number of iterations can be determined at compile
5005 time or upon entry to the loop.  @option{-funroll-loops} implies both
5006 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5007 option makes code larger, and may or may not make it run faster.
5009 @item -funroll-all-loops
5010 @opindex funroll-all-loops
5011 Unroll all loops, even if their number of iterations is uncertain when
5012 the loop is entered.  This usually makes programs run more slowly.
5013 @option{-funroll-all-loops} implies the same options as
5014 @option{-funroll-loops},
5016 @item -fsplit-ivs-in-unroller
5017 @opindex -fsplit-ivs-in-unroller
5018 Enables expressing of values of induction variables in later iterations
5019 of the unrolled loop using the value in the first iteration.  This breaks
5020 long dependency chains, thus improving efficiency of the scheduling passes
5021 (for best results, @option{-fweb} should be used as well).
5023 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5024 same effect.  However in cases the loop body is more complicated than
5025 a single basic block, this is not reliable.  It also does not work at all
5026 on some of the architectures due to restrictions in the CSE pass.
5028 This optimization is enabled by default.
5030 @item -fvariable-expansion-in-unroller
5031 @opindex -fvariable-expansion-in-unroller
5032 With this option, the compiler will create multiple copies of some
5033 local variables when unrolling a loop which can result in superior code.
5035 @item -fprefetch-loop-arrays
5036 @opindex fprefetch-loop-arrays
5037 If supported by the target machine, generate instructions to prefetch
5038 memory to improve the performance of loops that access large arrays.
5040 These options may generate better or worse code; results are highly
5041 dependent on the structure of loops within the source code.
5043 @item -fno-peephole
5044 @itemx -fno-peephole2
5045 @opindex fno-peephole
5046 @opindex fno-peephole2
5047 Disable any machine-specific peephole optimizations.  The difference
5048 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5049 are implemented in the compiler; some targets use one, some use the
5050 other, a few use both.
5052 @option{-fpeephole} is enabled by default.
5053 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5055 @item -fno-guess-branch-probability
5056 @opindex fno-guess-branch-probability
5057 Do not guess branch probabilities using heuristics.
5059 GCC will use heuristics to guess branch probabilities if they are
5060 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5061 heuristics are based on the control flow graph.  If some branch probabilities
5062 are specified by @samp{__builtin_expect}, then the heuristics will be
5063 used to guess branch probabilities for the rest of the control flow graph,
5064 taking the @samp{__builtin_expect} info into account.  The interactions
5065 between the heuristics and @samp{__builtin_expect} can be complex, and in
5066 some cases, it may be useful to disable the heuristics so that the effects
5067 of @samp{__builtin_expect} are easier to understand.
5069 The default is @option{-fguess-branch-probability} at levels
5070 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5072 @item -freorder-blocks
5073 @opindex freorder-blocks
5074 Reorder basic blocks in the compiled function in order to reduce number of
5075 taken branches and improve code locality.
5077 Enabled at levels @option{-O2}, @option{-O3}.
5079 @item -freorder-blocks-and-partition
5080 @opindex freorder-blocks-and-partition
5081 In addition to reordering basic blocks in the compiled function, in order
5082 to reduce number of taken branches, partitions hot and cold basic blocks
5083 into separate sections of the assembly and .o files, to improve
5084 paging and cache locality performance.
5086 This optimization is automatically turned off in the presence of
5087 exception handling, for linkonce sections, for functions with a user-defined
5088 section attribute and on any architecture that does not support named
5089 sections.
5091 @item -freorder-functions
5092 @opindex freorder-functions
5093 Reorder functions in the object file in order to
5094 improve code locality.  This is implemented by using special
5095 subsections @code{.text.hot} for most frequently executed functions and
5096 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5097 the linker so object file format must support named sections and linker must
5098 place them in a reasonable way.
5100 Also profile feedback must be available in to make this option effective.  See
5101 @option{-fprofile-arcs} for details.
5103 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5105 @item -fstrict-aliasing
5106 @opindex fstrict-aliasing
5107 Allows the compiler to assume the strictest aliasing rules applicable to
5108 the language being compiled.  For C (and C++), this activates
5109 optimizations based on the type of expressions.  In particular, an
5110 object of one type is assumed never to reside at the same address as an
5111 object of a different type, unless the types are almost the same.  For
5112 example, an @code{unsigned int} can alias an @code{int}, but not a
5113 @code{void*} or a @code{double}.  A character type may alias any other
5114 type.
5116 Pay special attention to code like this:
5117 @smallexample
5118 union a_union @{
5119   int i;
5120   double d;
5123 int f() @{
5124   a_union t;
5125   t.d = 3.0;
5126   return t.i;
5128 @end smallexample
5129 The practice of reading from a different union member than the one most
5130 recently written to (called ``type-punning'') is common.  Even with
5131 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5132 is accessed through the union type.  So, the code above will work as
5133 expected.  However, this code might not:
5134 @smallexample
5135 int f() @{
5136   a_union t;
5137   int* ip;
5138   t.d = 3.0;
5139   ip = &t.i;
5140   return *ip;
5142 @end smallexample
5144 Every language that wishes to perform language-specific alias analysis
5145 should define a function that computes, given an @code{tree}
5146 node, an alias set for the node.  Nodes in different alias sets are not
5147 allowed to alias.  For an example, see the C front-end function
5148 @code{c_get_alias_set}.
5150 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5152 @item -falign-functions
5153 @itemx -falign-functions=@var{n}
5154 @opindex falign-functions
5155 Align the start of functions to the next power-of-two greater than
5156 @var{n}, skipping up to @var{n} bytes.  For instance,
5157 @option{-falign-functions=32} aligns functions to the next 32-byte
5158 boundary, but @option{-falign-functions=24} would align to the next
5159 32-byte boundary only if this can be done by skipping 23 bytes or less.
5161 @option{-fno-align-functions} and @option{-falign-functions=1} are
5162 equivalent and mean that functions will not be aligned.
5164 Some assemblers only support this flag when @var{n} is a power of two;
5165 in that case, it is rounded up.
5167 If @var{n} is not specified or is zero, use a machine-dependent default.
5169 Enabled at levels @option{-O2}, @option{-O3}.
5171 @item -falign-labels
5172 @itemx -falign-labels=@var{n}
5173 @opindex falign-labels
5174 Align all branch targets to a power-of-two boundary, skipping up to
5175 @var{n} bytes like @option{-falign-functions}.  This option can easily
5176 make code slower, because it must insert dummy operations for when the
5177 branch target is reached in the usual flow of the code.
5179 @option{-fno-align-labels} and @option{-falign-labels=1} are
5180 equivalent and mean that labels will not be aligned.
5182 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5183 are greater than this value, then their values are used instead.
5185 If @var{n} is not specified or is zero, use a machine-dependent default
5186 which is very likely to be @samp{1}, meaning no alignment.
5188 Enabled at levels @option{-O2}, @option{-O3}.
5190 @item -falign-loops
5191 @itemx -falign-loops=@var{n}
5192 @opindex falign-loops
5193 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5194 like @option{-falign-functions}.  The hope is that the loop will be
5195 executed many times, which will make up for any execution of the dummy
5196 operations.
5198 @option{-fno-align-loops} and @option{-falign-loops=1} are
5199 equivalent and mean that loops will not be aligned.
5201 If @var{n} is not specified or is zero, use a machine-dependent default.
5203 Enabled at levels @option{-O2}, @option{-O3}.
5205 @item -falign-jumps
5206 @itemx -falign-jumps=@var{n}
5207 @opindex falign-jumps
5208 Align branch targets to a power-of-two boundary, for branch targets
5209 where the targets can only be reached by jumping, skipping up to @var{n}
5210 bytes like @option{-falign-functions}.  In this case, no dummy operations
5211 need be executed.
5213 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5214 equivalent and mean that loops will not be aligned.
5216 If @var{n} is not specified or is zero, use a machine-dependent default.
5218 Enabled at levels @option{-O2}, @option{-O3}.
5220 @item -funit-at-a-time
5221 @opindex funit-at-a-time
5222 Parse the whole compilation unit before starting to produce code.
5223 This allows some extra optimizations to take place but consumes
5224 more memory (in general).  There are some compatibility issues
5225 with @emph{unit-at-at-time} mode:
5226 @itemize @bullet
5227 @item
5228 enabling @emph{unit-at-a-time} mode may change the order
5229 in which functions, variables, and top-level @code{asm} statements
5230 are emitted, and will likely break code relying on some particular
5231 ordering.  The majority of such top-level @code{asm} statements,
5232 though, can be replaced by @code{section} attributes.
5234 @item
5235 @emph{unit-at-a-time} mode removes unreferenced static variables
5236 and functions.  This may result in undefined references
5237 when an @code{asm} statement refers directly to variables or functions
5238 that are otherwise unused.  In that case either the variable/function
5239 shall be listed as an operand of the @code{asm} statement operand or,
5240 in the case of top-level @code{asm} statements the attribute @code{used}
5241 shall be used on the declaration.
5243 @item
5244 Static functions now can use non-standard passing conventions that
5245 may break @code{asm} statements calling functions directly.  Again,
5246 attribute @code{used} will prevent this behavior.
5247 @end itemize
5249 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5250 but this scheme may not be supported by future releases of GCC@.
5252 Enabled at levels @option{-O2}, @option{-O3}.
5254 @item -fweb
5255 @opindex fweb
5256 Constructs webs as commonly used for register allocation purposes and assign
5257 each web individual pseudo register.  This allows the register allocation pass
5258 to operate on pseudos directly, but also strengthens several other optimization
5259 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5260 however, make debugging impossible, since variables will no longer stay in a
5261 ``home register''.
5263 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
5264 on targets where the default format for debugging information supports
5265 variable tracking.
5267 @item -fwhole-program
5268 @opindex fwhole-program
5269 Assume that the current compilation unit represents whole program being
5270 compiled.  All public functions and variables with the exception of @code{main}
5271 and those merged by attribute @code{externally_visible} become static functions
5272 and in a affect gets more aggressively optimized by interprocedural optimizers.
5273 While this option is equivalent to proper use of @code{static} keyword for
5274 programs consisting of single file, in combination with option
5275 @option{--combine} this flag can be used to compile most of smaller scale C
5276 programs since the functions and variables become local for the whole combined
5277 compilation unit, not for the single source file itself.
5280 @item -fno-cprop-registers
5281 @opindex fno-cprop-registers
5282 After register allocation and post-register allocation instruction splitting,
5283 we perform a copy-propagation pass to try to reduce scheduling dependencies
5284 and occasionally eliminate the copy.
5286 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5288 @item -fprofile-generate
5289 @opindex fprofile-generate
5291 Enable options usually used for instrumenting application to produce
5292 profile useful for later recompilation with profile feedback based
5293 optimization.  You must use @option{-fprofile-generate} both when
5294 compiling and when linking your program.
5296 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5298 @item -fprofile-use
5299 @opindex fprofile-use
5300 Enable profile feedback directed optimizations, and optimizations
5301 generally profitable only with profile feedback available.
5303 The following options are enabled: @code{-fbranch-probabilities},
5304 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5306 @end table
5308 The following options control compiler behavior regarding floating
5309 point arithmetic.  These options trade off between speed and
5310 correctness.  All must be specifically enabled.
5312 @table @gcctabopt
5313 @item -ffloat-store
5314 @opindex ffloat-store
5315 Do not store floating point variables in registers, and inhibit other
5316 options that might change whether a floating point value is taken from a
5317 register or memory.
5319 @cindex floating point precision
5320 This option prevents undesirable excess precision on machines such as
5321 the 68000 where the floating registers (of the 68881) keep more
5322 precision than a @code{double} is supposed to have.  Similarly for the
5323 x86 architecture.  For most programs, the excess precision does only
5324 good, but a few programs rely on the precise definition of IEEE floating
5325 point.  Use @option{-ffloat-store} for such programs, after modifying
5326 them to store all pertinent intermediate computations into variables.
5328 @item -ffast-math
5329 @opindex ffast-math
5330 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5331 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5332 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5333 and @option{fcx-limited-range}.
5335 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5337 This option should never be turned on by any @option{-O} option since
5338 it can result in incorrect output for programs which depend on
5339 an exact implementation of IEEE or ISO rules/specifications for
5340 math functions.
5342 @item -fno-math-errno
5343 @opindex fno-math-errno
5344 Do not set ERRNO after calling math functions that are executed
5345 with a single instruction, e.g., sqrt.  A program that relies on
5346 IEEE exceptions for math error handling may want to use this flag
5347 for speed while maintaining IEEE arithmetic compatibility.
5349 This option should never be turned on by any @option{-O} option since
5350 it can result in incorrect output for programs which depend on
5351 an exact implementation of IEEE or ISO rules/specifications for
5352 math functions.
5354 The default is @option{-fmath-errno}.
5356 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5357 no reason for the compiler to consider the possibility that it might,
5358 and @option{-fno-math-errno} is the default.
5360 @item -funsafe-math-optimizations
5361 @opindex funsafe-math-optimizations
5362 Allow optimizations for floating-point arithmetic that (a) assume
5363 that arguments and results are valid and (b) may violate IEEE or
5364 ANSI standards.  When used at link-time, it may include libraries
5365 or startup files that change the default FPU control word or other
5366 similar optimizations.
5368 This option should never be turned on by any @option{-O} option since
5369 it can result in incorrect output for programs which depend on
5370 an exact implementation of IEEE or ISO rules/specifications for
5371 math functions.
5373 The default is @option{-fno-unsafe-math-optimizations}.
5375 @item -ffinite-math-only
5376 @opindex ffinite-math-only
5377 Allow optimizations for floating-point arithmetic that assume
5378 that arguments and results are not NaNs or +-Infs.
5380 This option should never be turned on by any @option{-O} option since
5381 it can result in incorrect output for programs which depend on
5382 an exact implementation of IEEE or ISO rules/specifications.
5384 The default is @option{-fno-finite-math-only}.
5386 @item -fno-trapping-math
5387 @opindex fno-trapping-math
5388 Compile code assuming that floating-point operations cannot generate
5389 user-visible traps.  These traps include division by zero, overflow,
5390 underflow, inexact result and invalid operation.  This option implies
5391 @option{-fno-signaling-nans}.  Setting this option may allow faster
5392 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5394 This option should never be turned on by any @option{-O} option since
5395 it can result in incorrect output for programs which depend on
5396 an exact implementation of IEEE or ISO rules/specifications for
5397 math functions.
5399 The default is @option{-ftrapping-math}.
5401 @item -frounding-math
5402 @opindex frounding-math
5403 Disable transformations and optimizations that assume default floating
5404 point rounding behavior.  This is round-to-zero for all floating point
5405 to integer conversions, and round-to-nearest for all other arithmetic
5406 truncations.  This option should be specified for programs that change
5407 the FP rounding mode dynamically, or that may be executed with a
5408 non-default rounding mode.  This option disables constant folding of
5409 floating point expressions at compile-time (which may be affected by
5410 rounding mode) and arithmetic transformations that are unsafe in the
5411 presence of sign-dependent rounding modes.
5413 The default is @option{-fno-rounding-math}.
5415 This option is experimental and does not currently guarantee to
5416 disable all GCC optimizations that are affected by rounding mode.
5417 Future versions of GCC may provide finer control of this setting
5418 using C99's @code{FENV_ACCESS} pragma.  This command line option
5419 will be used to specify the default state for @code{FENV_ACCESS}.
5421 @item -fsignaling-nans
5422 @opindex fsignaling-nans
5423 Compile code assuming that IEEE signaling NaNs may generate user-visible
5424 traps during floating-point operations.  Setting this option disables
5425 optimizations that may change the number of exceptions visible with
5426 signaling NaNs.  This option implies @option{-ftrapping-math}.
5428 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5429 be defined.
5431 The default is @option{-fno-signaling-nans}.
5433 This option is experimental and does not currently guarantee to
5434 disable all GCC optimizations that affect signaling NaN behavior.
5436 @item -fsingle-precision-constant
5437 @opindex fsingle-precision-constant
5438 Treat floating point constant as single precision constant instead of
5439 implicitly converting it to double precision constant.
5441 @item -fcx-limited-range
5442 @itemx -fno-cx-limited-range
5443 @opindex fcx-limited-range
5444 @opindex fno-cx-limited-range
5445 When enabled, this option states that a range reduction step is not
5446 needed when performing complex division.  The default is
5447 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5449 This option controls the default setting of the ISO C99 
5450 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5451 all languages.
5453 @end table
5455 The following options control optimizations that may improve
5456 performance, but are not enabled by any @option{-O} options.  This
5457 section includes experimental options that may produce broken code.
5459 @table @gcctabopt
5460 @item -fbranch-probabilities
5461 @opindex fbranch-probabilities
5462 After running a program compiled with @option{-fprofile-arcs}
5463 (@pxref{Debugging Options,, Options for Debugging Your Program or
5464 @command{gcc}}), you can compile it a second time using
5465 @option{-fbranch-probabilities}, to improve optimizations based on
5466 the number of times each branch was taken.  When the program
5467 compiled with @option{-fprofile-arcs} exits it saves arc execution
5468 counts to a file called @file{@var{sourcename}.gcda} for each source
5469 file  The information in this data file is very dependent on the
5470 structure of the generated code, so you must use the same source code
5471 and the same optimization options for both compilations.
5473 With @option{-fbranch-probabilities}, GCC puts a
5474 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5475 These can be used to improve optimization.  Currently, they are only
5476 used in one place: in @file{reorg.c}, instead of guessing which path a
5477 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5478 exactly determine which path is taken more often.
5480 @item -fprofile-values
5481 @opindex fprofile-values
5482 If combined with @option{-fprofile-arcs}, it adds code so that some
5483 data about values of expressions in the program is gathered.
5485 With @option{-fbranch-probabilities}, it reads back the data gathered
5486 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5487 notes to instructions for their later usage in optimizations.
5489 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5491 @item -fvpt
5492 @opindex fvpt
5493 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5494 a code to gather information about values of expressions.
5496 With @option{-fbranch-probabilities}, it reads back the data gathered
5497 and actually performs the optimizations based on them.
5498 Currently the optimizations include specialization of division operation
5499 using the knowledge about the value of the denominator.
5501 @item -fspeculative-prefetching
5502 @opindex fspeculative-prefetching
5503 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5504 a code to gather information about addresses of memory references in the
5505 program.
5507 With @option{-fbranch-probabilities}, it reads back the data gathered
5508 and issues prefetch instructions according to them.  In addition to the opportunities
5509 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5510 memory access patterns---for example accesses to the data stored in linked
5511 list whose elements are usually allocated sequentially.
5513 In order to prevent issuing double prefetches, usage of
5514 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5516 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5518 @item -frename-registers
5519 @opindex frename-registers
5520 Attempt to avoid false dependencies in scheduled code by making use
5521 of registers left over after register allocation.  This optimization
5522 will most benefit processors with lots of registers.  Depending on the
5523 debug information format adopted by the target, however, it can
5524 make debugging impossible, since variables will no longer stay in
5525 a ``home register''.
5527 Not enabled by default at any level because it has known bugs.
5529 @item -ftracer
5530 @opindex ftracer
5531 Perform tail duplication to enlarge superblock size.  This transformation
5532 simplifies the control flow of the function allowing other optimizations to do
5533 better job.
5535 Enabled with @option{-fprofile-use}.
5537 @item -funroll-loops
5538 @opindex funroll-loops
5539 Unroll loops whose number of iterations can be determined at compile time or
5540 upon entry to the loop.  @option{-funroll-loops} implies
5541 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5542 (i.e.@: complete removal of loops with small constant number of iterations).
5543 This option makes code larger, and may or may not make it run faster.
5545 Enabled with @option{-fprofile-use}.
5547 @item -funroll-all-loops
5548 @opindex funroll-all-loops
5549 Unroll all loops, even if their number of iterations is uncertain when
5550 the loop is entered.  This usually makes programs run more slowly.
5551 @option{-funroll-all-loops} implies the same options as
5552 @option{-funroll-loops}.
5554 @item -fpeel-loops
5555 @opindex fpeel-loops
5556 Peels the loops for that there is enough information that they do not
5557 roll much (from profile feedback).  It also turns on complete loop peeling
5558 (i.e.@: complete removal of loops with small constant number of iterations).
5560 Enabled with @option{-fprofile-use}.
5562 @item -fmove-loop-invariants
5563 @opindex fmove-loop-invariants
5564 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5565 at level @option{-O1}
5567 @item -funswitch-loops
5568 @opindex funswitch-loops
5569 Move branches with loop invariant conditions out of the loop, with duplicates
5570 of the loop on both branches (modified according to result of the condition).
5572 @item -fprefetch-loop-arrays
5573 @opindex fprefetch-loop-arrays
5574 If supported by the target machine, generate instructions to prefetch
5575 memory to improve the performance of loops that access large arrays.
5577 Disabled at level @option{-Os}.
5579 @item -ffunction-sections
5580 @itemx -fdata-sections
5581 @opindex ffunction-sections
5582 @opindex fdata-sections
5583 Place each function or data item into its own section in the output
5584 file if the target supports arbitrary sections.  The name of the
5585 function or the name of the data item determines the section's name
5586 in the output file.
5588 Use these options on systems where the linker can perform optimizations
5589 to improve locality of reference in the instruction space.  Most systems
5590 using the ELF object format and SPARC processors running Solaris 2 have
5591 linkers with such optimizations.  AIX may have these optimizations in
5592 the future.
5594 Only use these options when there are significant benefits from doing
5595 so.  When you specify these options, the assembler and linker will
5596 create larger object and executable files and will also be slower.
5597 You will not be able to use @code{gprof} on all systems if you
5598 specify this option and you may have problems with debugging if
5599 you specify both this option and @option{-g}.
5601 @item -fbranch-target-load-optimize
5602 @opindex fbranch-target-load-optimize
5603 Perform branch target register load optimization before prologue / epilogue
5604 threading.
5605 The use of target registers can typically be exposed only during reload,
5606 thus hoisting loads out of loops and doing inter-block scheduling needs
5607 a separate optimization pass.
5609 @item -fbranch-target-load-optimize2
5610 @opindex fbranch-target-load-optimize2
5611 Perform branch target register load optimization after prologue / epilogue
5612 threading.
5614 @item -fbtr-bb-exclusive
5615 @opindex fbtr-bb-exclusive
5616 When performing branch target register load optimization, don't reuse
5617 branch target registers in within any basic block.
5619 @item --param @var{name}=@var{value}
5620 @opindex param
5621 In some places, GCC uses various constants to control the amount of
5622 optimization that is done.  For example, GCC will not inline functions
5623 that contain more that a certain number of instructions.  You can
5624 control some of these constants on the command-line using the
5625 @option{--param} option.
5627 The names of specific parameters, and the meaning of the values, are
5628 tied to the internals of the compiler, and are subject to change
5629 without notice in future releases.
5631 In each case, the @var{value} is an integer.  The allowable choices for
5632 @var{name} are given in the following table:
5634 @table @gcctabopt
5635 @item salias-max-implicit-fields
5636 The maximum number of fields in a variable without direct
5637 structure accesses for which structure aliasing will consider trying 
5638 to track each field.  The default is 5
5640 @item sra-max-structure-size
5641 The maximum structure size, in bytes, at which the scalar replacement
5642 of aggregates (SRA) optimization will perform block copies.  The
5643 default value, 0, implies that GCC will select the most appropriate
5644 size itself.
5646 @item sra-field-structure-ratio
5647 The threshold ratio (as a percentage) between instantiated fields and
5648 the complete structure size.  We say that if the ratio of the number
5649 of bytes in instantiated fields to the number of bytes in the complete
5650 structure exceeds this parameter, then block copies are not used.  The
5651 default is 75.
5653 @item max-crossjump-edges
5654 The maximum number of incoming edges to consider for crossjumping.
5655 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5656 the number of edges incoming to each block.  Increasing values mean
5657 more aggressive optimization, making the compile time increase with
5658 probably small improvement in executable size.
5660 @item min-crossjump-insns
5661 The minimum number of instructions which must be matched at the end
5662 of two blocks before crossjumping will be performed on them.  This
5663 value is ignored in the case where all instructions in the block being
5664 crossjumped from are matched.  The default value is 5.
5666 @item max-goto-duplication-insns
5667 The maximum number of instructions to duplicate to a block that jumps
5668 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5669 passes, GCC factors computed gotos early in the compilation process,
5670 and unfactors them as late as possible.  Only computed jumps at the
5671 end of a basic blocks with no more than max-goto-duplication-insns are
5672 unfactored.  The default value is 8.
5674 @item max-delay-slot-insn-search
5675 The maximum number of instructions to consider when looking for an
5676 instruction to fill a delay slot.  If more than this arbitrary number of
5677 instructions is searched, the time savings from filling the delay slot
5678 will be minimal so stop searching.  Increasing values mean more
5679 aggressive optimization, making the compile time increase with probably
5680 small improvement in executable run time.
5682 @item max-delay-slot-live-search
5683 When trying to fill delay slots, the maximum number of instructions to
5684 consider when searching for a block with valid live register
5685 information.  Increasing this arbitrarily chosen value means more
5686 aggressive optimization, increasing the compile time.  This parameter
5687 should be removed when the delay slot code is rewritten to maintain the
5688 control-flow graph.
5690 @item max-gcse-memory
5691 The approximate maximum amount of memory that will be allocated in
5692 order to perform the global common subexpression elimination
5693 optimization.  If more memory than specified is required, the
5694 optimization will not be done.
5696 @item max-gcse-passes
5697 The maximum number of passes of GCSE to run.  The default is 1.
5699 @item max-pending-list-length
5700 The maximum number of pending dependencies scheduling will allow
5701 before flushing the current state and starting over.  Large functions
5702 with few branches or calls can create excessively large lists which
5703 needlessly consume memory and resources.
5705 @item max-inline-insns-single
5706 Several parameters control the tree inliner used in gcc.
5707 This number sets the maximum number of instructions (counted in GCC's
5708 internal representation) in a single function that the tree inliner
5709 will consider for inlining.  This only affects functions declared
5710 inline and methods implemented in a class declaration (C++).
5711 The default value is 450.
5713 @item max-inline-insns-auto
5714 When you use @option{-finline-functions} (included in @option{-O3}),
5715 a lot of functions that would otherwise not be considered for inlining
5716 by the compiler will be investigated.  To those functions, a different
5717 (more restrictive) limit compared to functions declared inline can
5718 be applied.
5719 The default value is 90.
5721 @item large-function-insns
5722 The limit specifying really large functions.  For functions larger than this
5723 limit after inlining inlining is constrained by
5724 @option{--param large-function-growth}.  This parameter is useful primarily
5725 to avoid extreme compilation time caused by non-linear algorithms used by the
5726 backend.
5727 This parameter is ignored when @option{-funit-at-a-time} is not used.
5728 The default value is 2700.
5730 @item large-function-growth
5731 Specifies maximal growth of large function caused by inlining in percents.
5732 This parameter is ignored when @option{-funit-at-a-time} is not used.
5733 The default value is 100 which limits large function growth to 2.0 times
5734 the original size.
5736 @item inline-unit-growth
5737 Specifies maximal overall growth of the compilation unit caused by inlining.
5738 This parameter is ignored when @option{-funit-at-a-time} is not used.
5739 The default value is 50 which limits unit growth to 1.5 times the original
5740 size.
5742 @item max-inline-insns-recursive
5743 @itemx max-inline-insns-recursive-auto
5744 Specifies maximum number of instructions out-of-line copy of self recursive inline
5745 function can grow into by performing recursive inlining.
5747 For functions declared inline @option{--param max-inline-insns-recursive} is
5748 taken into acount.  For function not declared inline, recursive inlining
5749 happens only when @option{-finline-functions} (included in @option{-O3}) is
5750 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5751 default value is 450.
5753 @item max-inline-recursive-depth
5754 @itemx max-inline-recursive-depth-auto
5755 Specifies maximum recursion depth used by the recursive inlining.
5757 For functions declared inline @option{--param max-inline-recursive-depth} is
5758 taken into acount.  For function not declared inline, recursive inlining
5759 happens only when @option{-finline-functions} (included in @option{-O3}) is
5760 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5761 default value is 450.
5763 @item inline-call-cost
5764 Specify cost of call instruction relative to simple arithmetics operations
5765 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5766 functions and at the same time increases size of leaf function that is believed to
5767 reduce function size by being inlined.  In effect it increases amount of
5768 inlining for code having large abstraction penalty (many functions that just
5769 pass the arguments to other functions) and decrease inlining for code with low
5770 abstraction penalty.  The default value is 16.
5772 @item max-unrolled-insns
5773 The maximum number of instructions that a loop should have if that loop
5774 is unrolled, and if the loop is unrolled, it determines how many times
5775 the loop code is unrolled.
5777 @item max-average-unrolled-insns
5778 The maximum number of instructions biased by probabilities of their execution
5779 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5780 it determines how many times the loop code is unrolled.
5782 @item max-unroll-times
5783 The maximum number of unrollings of a single loop.
5785 @item max-peeled-insns
5786 The maximum number of instructions that a loop should have if that loop
5787 is peeled, and if the loop is peeled, it determines how many times
5788 the loop code is peeled.
5790 @item max-peel-times
5791 The maximum number of peelings of a single loop.
5793 @item max-completely-peeled-insns
5794 The maximum number of insns of a completely peeled loop.
5796 @item max-completely-peel-times
5797 The maximum number of iterations of a loop to be suitable for complete peeling.
5799 @item max-unswitch-insns
5800 The maximum number of insns of an unswitched loop.
5802 @item max-unswitch-level
5803 The maximum number of branches unswitched in a single loop.
5805 @item lim-expensive
5806 The minimum cost of an expensive expression in the loop invariant motion.
5808 @item iv-consider-all-candidates-bound
5809 Bound on number of candidates for induction variables below that
5810 all candidates are considered for each use in induction variable
5811 optimizations.  Only the most relevant candidates are considered
5812 if there are more candidates, to avoid quadratic time complexity.
5814 @item iv-max-considered-uses
5815 The induction variable optimizations give up on loops that contain more
5816 induction variable uses.
5818 @item iv-always-prune-cand-set-bound
5819 If number of candidates in the set is smaller than this value,
5820 we always try to remove unnecessary ivs from the set during its
5821 optimization when a new iv is added to the set.
5823 @item scev-max-expr-size
5824 Bound on size of expressions used in the scalar evolutions analyzer.
5825 Large expressions slow the analyzer.
5827 @item max-iterations-to-track
5829 The maximum number of iterations of a loop the brute force algorithm
5830 for analysis of # of iterations of the loop tries to evaluate.
5832 @item hot-bb-count-fraction
5833 Select fraction of the maximal count of repetitions of basic block in program
5834 given basic block needs to have to be considered hot.
5836 @item hot-bb-frequency-fraction
5837 Select fraction of the maximal frequency of executions of basic block in
5838 function given basic block needs to have to be considered hot
5840 @item tracer-dynamic-coverage
5841 @itemx tracer-dynamic-coverage-feedback
5843 This value is used to limit superblock formation once the given percentage of
5844 executed instructions is covered.  This limits unnecessary code size
5845 expansion.
5847 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5848 feedback is available.  The real profiles (as opposed to statically estimated
5849 ones) are much less balanced allowing the threshold to be larger value.
5851 @item tracer-max-code-growth
5852 Stop tail duplication once code growth has reached given percentage.  This is
5853 rather hokey argument, as most of the duplicates will be eliminated later in
5854 cross jumping, so it may be set to much higher values than is the desired code
5855 growth.
5857 @item tracer-min-branch-ratio
5859 Stop reverse growth when the reverse probability of best edge is less than this
5860 threshold (in percent).
5862 @item tracer-min-branch-ratio
5863 @itemx tracer-min-branch-ratio-feedback
5865 Stop forward growth if the best edge do have probability lower than this
5866 threshold.
5868 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5869 compilation for profile feedback and one for compilation without.  The value
5870 for compilation with profile feedback needs to be more conservative (higher) in
5871 order to make tracer effective.
5873 @item max-cse-path-length
5875 Maximum number of basic blocks on path that cse considers.  The default is 10.
5877 @item global-var-threshold
5879 Counts the number of function calls (@var{n}) and the number of
5880 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5881 single artificial variable will be created to represent all the
5882 call-clobbered variables at function call sites.  This artificial
5883 variable will then be made to alias every call-clobbered variable.
5884 (done as @code{int * size_t} on the host machine; beware overflow).
5886 @item max-aliased-vops
5888 Maximum number of virtual operands allowed to represent aliases
5889 before triggering the alias grouping heuristic.  Alias grouping
5890 reduces compile times and memory consumption needed for aliasing at
5891 the expense of precision loss in alias information.
5893 @item ggc-min-expand
5895 GCC uses a garbage collector to manage its own memory allocation.  This
5896 parameter specifies the minimum percentage by which the garbage
5897 collector's heap should be allowed to expand between collections.
5898 Tuning this may improve compilation speed; it has no effect on code
5899 generation.
5901 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5902 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5903 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5904 GCC is not able to calculate RAM on a particular platform, the lower
5905 bound of 30% is used.  Setting this parameter and
5906 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5907 every opportunity.  This is extremely slow, but can be useful for
5908 debugging.
5910 @item ggc-min-heapsize
5912 Minimum size of the garbage collector's heap before it begins bothering
5913 to collect garbage.  The first collection occurs after the heap expands
5914 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5915 tuning this may improve compilation speed, and has no effect on code
5916 generation.
5918 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5919 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5920 with a lower bound of 4096 (four megabytes) and an upper bound of
5921 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5922 particular platform, the lower bound is used.  Setting this parameter
5923 very large effectively disables garbage collection.  Setting this
5924 parameter and @option{ggc-min-expand} to zero causes a full collection
5925 to occur at every opportunity.
5927 @item max-reload-search-insns
5928 The maximum number of instruction reload should look backward for equivalent
5929 register.  Increasing values mean more aggressive optimization, making the
5930 compile time increase with probably slightly better performance.  The default
5931 value is 100.
5933 @item max-cselib-memory-location
5934 The maximum number of memory locations cselib should take into acount.
5935 Increasing values mean more aggressive optimization, making the compile time
5936 increase with probably slightly better performance.  The default value is 500.
5938 @item reorder-blocks-duplicate
5939 @itemx reorder-blocks-duplicate-feedback
5941 Used by basic block reordering pass to decide whether to use unconditional
5942 branch or duplicate the code on its destination.  Code is duplicated when its
5943 estimated size is smaller than this value multiplied by the estimated size of
5944 unconditional jump in the hot spots of the program.
5946 The @option{reorder-block-duplicate-feedback} is used only when profile
5947 feedback is available and may be set to higher values than
5948 @option{reorder-block-duplicate} since information about the hot spots is more
5949 accurate.
5951 @item max-sched-region-blocks
5952 The maximum number of blocks in a region to be considered for
5953 interblock scheduling.  The default value is 10.
5955 @item max-sched-region-insns
5956 The maximum number of insns in a region to be considered for
5957 interblock scheduling.  The default value is 100.
5959 @item max-last-value-rtl
5961 The maximum size measured as number of RTLs that can be recorded in an expression
5962 in combiner for a pseudo register as last known value of that register.  The default
5963 is 10000.
5965 @item integer-share-limit
5966 Small integer constants can use a shared data structure, reducing the
5967 compiler's memory usage and increasing its speed.  This sets the maximum
5968 value of a shared integer constant's.  The default value is 256.
5970 @item min-virtual-mappings
5971 Specifies the minimum number of virtual mappings in the incremental
5972 SSA updater that should be registered to trigger the virtual mappings
5973 heuristic defined by virtual-mappings-ratio.  The default value is
5974 100.
5976 @item virtual-mappings-ratio
5977 If the number of virtual mappings is virtual-mappings-ratio bigger
5978 than the number of virtual symbols to be updated, then the incremental
5979 SSA updater switches to a full update for those symbols.  The default
5980 ratio is 3.
5982 @end table
5983 @end table
5985 @node Preprocessor Options
5986 @section Options Controlling the Preprocessor
5987 @cindex preprocessor options
5988 @cindex options, preprocessor
5990 These options control the C preprocessor, which is run on each C source
5991 file before actual compilation.
5993 If you use the @option{-E} option, nothing is done except preprocessing.
5994 Some of these options make sense only together with @option{-E} because
5995 they cause the preprocessor output to be unsuitable for actual
5996 compilation.
5998 @table @gcctabopt
5999 @opindex Wp
6000 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6001 and pass @var{option} directly through to the preprocessor.  If
6002 @var{option} contains commas, it is split into multiple options at the
6003 commas.  However, many options are modified, translated or interpreted
6004 by the compiler driver before being passed to the preprocessor, and
6005 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6006 interface is undocumented and subject to change, so whenever possible
6007 you should avoid using @option{-Wp} and let the driver handle the
6008 options instead.
6010 @item -Xpreprocessor @var{option}
6011 @opindex preprocessor
6012 Pass @var{option} as an option to the preprocessor.  You can use this to
6013 supply system-specific preprocessor options which GCC does not know how to
6014 recognize.
6016 If you want to pass an option that takes an argument, you must use
6017 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6018 @end table
6020 @include cppopts.texi
6022 @node Assembler Options
6023 @section Passing Options to the Assembler
6025 @c prevent bad page break with this line
6026 You can pass options to the assembler.
6028 @table @gcctabopt
6029 @item -Wa,@var{option}
6030 @opindex Wa
6031 Pass @var{option} as an option to the assembler.  If @var{option}
6032 contains commas, it is split into multiple options at the commas.
6034 @item -Xassembler @var{option}
6035 @opindex Xassembler
6036 Pass @var{option} as an option to the assembler.  You can use this to
6037 supply system-specific assembler options which GCC does not know how to
6038 recognize.
6040 If you want to pass an option that takes an argument, you must use
6041 @option{-Xassembler} twice, once for the option and once for the argument.
6043 @end table
6045 @node Link Options
6046 @section Options for Linking
6047 @cindex link options
6048 @cindex options, linking
6050 These options come into play when the compiler links object files into
6051 an executable output file.  They are meaningless if the compiler is
6052 not doing a link step.
6054 @table @gcctabopt
6055 @cindex file names
6056 @item @var{object-file-name}
6057 A file name that does not end in a special recognized suffix is
6058 considered to name an object file or library.  (Object files are
6059 distinguished from libraries by the linker according to the file
6060 contents.)  If linking is done, these object files are used as input
6061 to the linker.
6063 @item -c
6064 @itemx -S
6065 @itemx -E
6066 @opindex c
6067 @opindex S
6068 @opindex E
6069 If any of these options is used, then the linker is not run, and
6070 object file names should not be used as arguments.  @xref{Overall
6071 Options}.
6073 @cindex Libraries
6074 @item -l@var{library}
6075 @itemx -l @var{library}
6076 @opindex l
6077 Search the library named @var{library} when linking.  (The second
6078 alternative with the library as a separate argument is only for
6079 POSIX compliance and is not recommended.)
6081 It makes a difference where in the command you write this option; the
6082 linker searches and processes libraries and object files in the order they
6083 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6084 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6085 to functions in @samp{z}, those functions may not be loaded.
6087 The linker searches a standard list of directories for the library,
6088 which is actually a file named @file{lib@var{library}.a}.  The linker
6089 then uses this file as if it had been specified precisely by name.
6091 The directories searched include several standard system directories
6092 plus any that you specify with @option{-L}.
6094 Normally the files found this way are library files---archive files
6095 whose members are object files.  The linker handles an archive file by
6096 scanning through it for members which define symbols that have so far
6097 been referenced but not defined.  But if the file that is found is an
6098 ordinary object file, it is linked in the usual fashion.  The only
6099 difference between using an @option{-l} option and specifying a file name
6100 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6101 and searches several directories.
6103 @item -lobjc
6104 @opindex lobjc
6105 You need this special case of the @option{-l} option in order to
6106 link an Objective-C or Objective-C++ program.
6108 @item -nostartfiles
6109 @opindex nostartfiles
6110 Do not use the standard system startup files when linking.
6111 The standard system libraries are used normally, unless @option{-nostdlib}
6112 or @option{-nodefaultlibs} is used.
6114 @item -nodefaultlibs
6115 @opindex nodefaultlibs
6116 Do not use the standard system libraries when linking.
6117 Only the libraries you specify will be passed to the linker.
6118 The standard startup files are used normally, unless @option{-nostartfiles}
6119 is used.  The compiler may generate calls to @code{memcmp},
6120 @code{memset}, @code{memcpy} and @code{memmove}.
6121 These entries are usually resolved by entries in
6122 libc.  These entry points should be supplied through some other
6123 mechanism when this option is specified.
6125 @item -nostdlib
6126 @opindex nostdlib
6127 Do not use the standard system startup files or libraries when linking.
6128 No startup files and only the libraries you specify will be passed to
6129 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6130 @code{memcpy} and @code{memmove}.
6131 These entries are usually resolved by entries in
6132 libc.  These entry points should be supplied through some other
6133 mechanism when this option is specified.
6135 @cindex @option{-lgcc}, use with @option{-nostdlib}
6136 @cindex @option{-nostdlib} and unresolved references
6137 @cindex unresolved references and @option{-nostdlib}
6138 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6139 @cindex @option{-nodefaultlibs} and unresolved references
6140 @cindex unresolved references and @option{-nodefaultlibs}
6141 One of the standard libraries bypassed by @option{-nostdlib} and
6142 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6143 that GCC uses to overcome shortcomings of particular machines, or special
6144 needs for some languages.
6145 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6146 Collection (GCC) Internals},
6147 for more discussion of @file{libgcc.a}.)
6148 In most cases, you need @file{libgcc.a} even when you want to avoid
6149 other standard libraries.  In other words, when you specify @option{-nostdlib}
6150 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6151 This ensures that you have no unresolved references to internal GCC
6152 library subroutines.  (For example, @samp{__main}, used to ensure C++
6153 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6154 GNU Compiler Collection (GCC) Internals}.)
6156 @item -pie
6157 @opindex pie
6158 Produce a position independent executable on targets which support it.
6159 For predictable results, you must also specify the same set of options
6160 that were used to generate code (@option{-fpie}, @option{-fPIE},
6161 or model suboptions) when you specify this option.
6163 @item -s
6164 @opindex s
6165 Remove all symbol table and relocation information from the executable.
6167 @item -static
6168 @opindex static
6169 On systems that support dynamic linking, this prevents linking with the shared
6170 libraries.  On other systems, this option has no effect.
6172 @item -shared
6173 @opindex shared
6174 Produce a shared object which can then be linked with other objects to
6175 form an executable.  Not all systems support this option.  For predictable
6176 results, you must also specify the same set of options that were used to
6177 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6178 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6179 needs to build supplementary stub code for constructors to work.  On
6180 multi-libbed systems, @samp{gcc -shared} must select the correct support
6181 libraries to link against.  Failing to supply the correct flags may lead
6182 to subtle defects.  Supplying them in cases where they are not necessary
6183 is innocuous.}
6185 @item -shared-libgcc
6186 @itemx -static-libgcc
6187 @opindex shared-libgcc
6188 @opindex static-libgcc
6189 On systems that provide @file{libgcc} as a shared library, these options
6190 force the use of either the shared or static version respectively.
6191 If no shared version of @file{libgcc} was built when the compiler was
6192 configured, these options have no effect.
6194 There are several situations in which an application should use the
6195 shared @file{libgcc} instead of the static version.  The most common
6196 of these is when the application wishes to throw and catch exceptions
6197 across different shared libraries.  In that case, each of the libraries
6198 as well as the application itself should use the shared @file{libgcc}.
6200 Therefore, the G++ and GCJ drivers automatically add
6201 @option{-shared-libgcc} whenever you build a shared library or a main
6202 executable, because C++ and Java programs typically use exceptions, so
6203 this is the right thing to do.
6205 If, instead, you use the GCC driver to create shared libraries, you may
6206 find that they will not always be linked with the shared @file{libgcc}.
6207 If GCC finds, at its configuration time, that you have a non-GNU linker
6208 or a GNU linker that does not support option @option{--eh-frame-hdr},
6209 it will link the shared version of @file{libgcc} into shared libraries
6210 by default.  Otherwise, it will take advantage of the linker and optimize
6211 away the linking with the shared version of @file{libgcc}, linking with
6212 the static version of libgcc by default.  This allows exceptions to
6213 propagate through such shared libraries, without incurring relocation
6214 costs at library load time.
6216 However, if a library or main executable is supposed to throw or catch
6217 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6218 for the languages used in the program, or using the option
6219 @option{-shared-libgcc}, such that it is linked with the shared
6220 @file{libgcc}.
6222 @item -symbolic
6223 @opindex symbolic
6224 Bind references to global symbols when building a shared object.  Warn
6225 about any unresolved references (unless overridden by the link editor
6226 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6227 this option.
6229 @item -Xlinker @var{option}
6230 @opindex Xlinker
6231 Pass @var{option} as an option to the linker.  You can use this to
6232 supply system-specific linker options which GCC does not know how to
6233 recognize.
6235 If you want to pass an option that takes an argument, you must use
6236 @option{-Xlinker} twice, once for the option and once for the argument.
6237 For example, to pass @option{-assert definitions}, you must write
6238 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6239 @option{-Xlinker "-assert definitions"}, because this passes the entire
6240 string as a single argument, which is not what the linker expects.
6242 @item -Wl,@var{option}
6243 @opindex Wl
6244 Pass @var{option} as an option to the linker.  If @var{option} contains
6245 commas, it is split into multiple options at the commas.
6247 @item -u @var{symbol}
6248 @opindex u
6249 Pretend the symbol @var{symbol} is undefined, to force linking of
6250 library modules to define it.  You can use @option{-u} multiple times with
6251 different symbols to force loading of additional library modules.
6252 @end table
6254 @node Directory Options
6255 @section Options for Directory Search
6256 @cindex directory options
6257 @cindex options, directory search
6258 @cindex search path
6260 These options specify directories to search for header files, for
6261 libraries and for parts of the compiler:
6263 @table @gcctabopt
6264 @item -I@var{dir}
6265 @opindex I
6266 Add the directory @var{dir} to the head of the list of directories to be
6267 searched for header files.  This can be used to override a system header
6268 file, substituting your own version, since these directories are
6269 searched before the system header file directories.  However, you should
6270 not use this option to add directories that contain vendor-supplied
6271 system header files (use @option{-isystem} for that).  If you use more than
6272 one @option{-I} option, the directories are scanned in left-to-right
6273 order; the standard system directories come after.
6275 If a standard system include directory, or a directory specified with
6276 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6277 option will be ignored.  The directory will still be searched but as a
6278 system directory at its normal position in the system include chain.
6279 This is to ensure that GCC's procedure to fix buggy system headers and
6280 the ordering for the include_next directive are not inadvertently changed.
6281 If you really need to change the search order for system directories,
6282 use the @option{-nostdinc} and/or @option{-isystem} options.
6284 @item -iquote@var{dir}
6285 @opindex iquote
6286 Add the directory @var{dir} to the head of the list of directories to
6287 be searched for header files only for the case of @samp{#include
6288 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6289 otherwise just like @option{-I}.
6291 @item -L@var{dir}
6292 @opindex L
6293 Add directory @var{dir} to the list of directories to be searched
6294 for @option{-l}.
6296 @item -B@var{prefix}
6297 @opindex B
6298 This option specifies where to find the executables, libraries,
6299 include files, and data files of the compiler itself.
6301 The compiler driver program runs one or more of the subprograms
6302 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6303 @var{prefix} as a prefix for each program it tries to run, both with and
6304 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6306 For each subprogram to be run, the compiler driver first tries the
6307 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6308 was not specified, the driver tries two standard prefixes, which are
6309 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6310 those results in a file name that is found, the unmodified program
6311 name is searched for using the directories specified in your
6312 @env{PATH} environment variable.
6314 The compiler will check to see if the path provided by the @option{-B}
6315 refers to a directory, and if necessary it will add a directory
6316 separator character at the end of the path.
6318 @option{-B} prefixes that effectively specify directory names also apply
6319 to libraries in the linker, because the compiler translates these
6320 options into @option{-L} options for the linker.  They also apply to
6321 includes files in the preprocessor, because the compiler translates these
6322 options into @option{-isystem} options for the preprocessor.  In this case,
6323 the compiler appends @samp{include} to the prefix.
6325 The run-time support file @file{libgcc.a} can also be searched for using
6326 the @option{-B} prefix, if needed.  If it is not found there, the two
6327 standard prefixes above are tried, and that is all.  The file is left
6328 out of the link if it is not found by those means.
6330 Another way to specify a prefix much like the @option{-B} prefix is to use
6331 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6332 Variables}.
6334 As a special kludge, if the path provided by @option{-B} is
6335 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6336 9, then it will be replaced by @file{[dir/]include}.  This is to help
6337 with boot-strapping the compiler.
6339 @item -specs=@var{file}
6340 @opindex specs
6341 Process @var{file} after the compiler reads in the standard @file{specs}
6342 file, in order to override the defaults that the @file{gcc} driver
6343 program uses when determining what switches to pass to @file{cc1},
6344 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6345 @option{-specs=@var{file}} can be specified on the command line, and they
6346 are processed in order, from left to right.
6348 @item -I-
6349 @opindex I-
6350 This option has been deprecated.  Please use @option{-iquote} instead for
6351 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6352 Any directories you specify with @option{-I} options before the @option{-I-}
6353 option are searched only for the case of @samp{#include "@var{file}"};
6354 they are not searched for @samp{#include <@var{file}>}.
6356 If additional directories are specified with @option{-I} options after
6357 the @option{-I-}, these directories are searched for all @samp{#include}
6358 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6359 this way.)
6361 In addition, the @option{-I-} option inhibits the use of the current
6362 directory (where the current input file came from) as the first search
6363 directory for @samp{#include "@var{file}"}.  There is no way to
6364 override this effect of @option{-I-}.  With @option{-I.} you can specify
6365 searching the directory which was current when the compiler was
6366 invoked.  That is not exactly the same as what the preprocessor does
6367 by default, but it is often satisfactory.
6369 @option{-I-} does not inhibit the use of the standard system directories
6370 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6371 independent.
6372 @end table
6374 @c man end
6376 @node Spec Files
6377 @section Specifying subprocesses and the switches to pass to them
6378 @cindex Spec Files
6380 @command{gcc} is a driver program.  It performs its job by invoking a
6381 sequence of other programs to do the work of compiling, assembling and
6382 linking.  GCC interprets its command-line parameters and uses these to
6383 deduce which programs it should invoke, and which command-line options
6384 it ought to place on their command lines.  This behavior is controlled
6385 by @dfn{spec strings}.  In most cases there is one spec string for each
6386 program that GCC can invoke, but a few programs have multiple spec
6387 strings to control their behavior.  The spec strings built into GCC can
6388 be overridden by using the @option{-specs=} command-line switch to specify
6389 a spec file.
6391 @dfn{Spec files} are plaintext files that are used to construct spec
6392 strings.  They consist of a sequence of directives separated by blank
6393 lines.  The type of directive is determined by the first non-whitespace
6394 character on the line and it can be one of the following:
6396 @table @code
6397 @item %@var{command}
6398 Issues a @var{command} to the spec file processor.  The commands that can
6399 appear here are:
6401 @table @code
6402 @item %include <@var{file}>
6403 @cindex %include
6404 Search for @var{file} and insert its text at the current point in the
6405 specs file.
6407 @item %include_noerr <@var{file}>
6408 @cindex %include_noerr
6409 Just like @samp{%include}, but do not generate an error message if the include
6410 file cannot be found.
6412 @item %rename @var{old_name} @var{new_name}
6413 @cindex %rename
6414 Rename the spec string @var{old_name} to @var{new_name}.
6416 @end table
6418 @item *[@var{spec_name}]:
6419 This tells the compiler to create, override or delete the named spec
6420 string.  All lines after this directive up to the next directive or
6421 blank line are considered to be the text for the spec string.  If this
6422 results in an empty string then the spec will be deleted.  (Or, if the
6423 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6424 does not currently exist a new spec will be created.  If the spec does
6425 exist then its contents will be overridden by the text of this
6426 directive, unless the first character of that text is the @samp{+}
6427 character, in which case the text will be appended to the spec.
6429 @item [@var{suffix}]:
6430 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6431 and up to the next directive or blank line are considered to make up the
6432 spec string for the indicated suffix.  When the compiler encounters an
6433 input file with the named suffix, it will processes the spec string in
6434 order to work out how to compile that file.  For example:
6436 @smallexample
6437 .ZZ:
6438 z-compile -input %i
6439 @end smallexample
6441 This says that any input file whose name ends in @samp{.ZZ} should be
6442 passed to the program @samp{z-compile}, which should be invoked with the
6443 command-line switch @option{-input} and with the result of performing the
6444 @samp{%i} substitution.  (See below.)
6446 As an alternative to providing a spec string, the text that follows a
6447 suffix directive can be one of the following:
6449 @table @code
6450 @item @@@var{language}
6451 This says that the suffix is an alias for a known @var{language}.  This is
6452 similar to using the @option{-x} command-line switch to GCC to specify a
6453 language explicitly.  For example:
6455 @smallexample
6456 .ZZ:
6457 @@c++
6458 @end smallexample
6460 Says that .ZZ files are, in fact, C++ source files.
6462 @item #@var{name}
6463 This causes an error messages saying:
6465 @smallexample
6466 @var{name} compiler not installed on this system.
6467 @end smallexample
6468 @end table
6470 GCC already has an extensive list of suffixes built into it.
6471 This directive will add an entry to the end of the list of suffixes, but
6472 since the list is searched from the end backwards, it is effectively
6473 possible to override earlier entries using this technique.
6475 @end table
6477 GCC has the following spec strings built into it.  Spec files can
6478 override these strings or create their own.  Note that individual
6479 targets can also add their own spec strings to this list.
6481 @smallexample
6482 asm          Options to pass to the assembler
6483 asm_final    Options to pass to the assembler post-processor
6484 cpp          Options to pass to the C preprocessor
6485 cc1          Options to pass to the C compiler
6486 cc1plus      Options to pass to the C++ compiler
6487 endfile      Object files to include at the end of the link
6488 link         Options to pass to the linker
6489 lib          Libraries to include on the command line to the linker
6490 libgcc       Decides which GCC support library to pass to the linker
6491 linker       Sets the name of the linker
6492 predefines   Defines to be passed to the C preprocessor
6493 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6494              by default
6495 startfile    Object files to include at the start of the link
6496 @end smallexample
6498 Here is a small example of a spec file:
6500 @smallexample
6501 %rename lib                 old_lib
6503 *lib:
6504 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6505 @end smallexample
6507 This example renames the spec called @samp{lib} to @samp{old_lib} and
6508 then overrides the previous definition of @samp{lib} with a new one.
6509 The new definition adds in some extra command-line options before
6510 including the text of the old definition.
6512 @dfn{Spec strings} are a list of command-line options to be passed to their
6513 corresponding program.  In addition, the spec strings can contain
6514 @samp{%}-prefixed sequences to substitute variable text or to
6515 conditionally insert text into the command line.  Using these constructs
6516 it is possible to generate quite complex command lines.
6518 Here is a table of all defined @samp{%}-sequences for spec
6519 strings.  Note that spaces are not generated automatically around the
6520 results of expanding these sequences.  Therefore you can concatenate them
6521 together or combine them with constant text in a single argument.
6523 @table @code
6524 @item %%
6525 Substitute one @samp{%} into the program name or argument.
6527 @item %i
6528 Substitute the name of the input file being processed.
6530 @item %b
6531 Substitute the basename of the input file being processed.
6532 This is the substring up to (and not including) the last period
6533 and not including the directory.
6535 @item %B
6536 This is the same as @samp{%b}, but include the file suffix (text after
6537 the last period).
6539 @item %d
6540 Marks the argument containing or following the @samp{%d} as a
6541 temporary file name, so that that file will be deleted if GCC exits
6542 successfully.  Unlike @samp{%g}, this contributes no text to the
6543 argument.
6545 @item %g@var{suffix}
6546 Substitute a file name that has suffix @var{suffix} and is chosen
6547 once per compilation, and mark the argument in the same way as
6548 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6549 name is now chosen in a way that is hard to predict even when previously
6550 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6551 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6552 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6553 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6554 was simply substituted with a file name chosen once per compilation,
6555 without regard to any appended suffix (which was therefore treated
6556 just like ordinary text), making such attacks more likely to succeed.
6558 @item %u@var{suffix}
6559 Like @samp{%g}, but generates a new temporary file name even if
6560 @samp{%u@var{suffix}} was already seen.
6562 @item %U@var{suffix}
6563 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6564 new one if there is no such last file name.  In the absence of any
6565 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6566 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6567 would involve the generation of two distinct file names, one
6568 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6569 simply substituted with a file name chosen for the previous @samp{%u},
6570 without regard to any appended suffix.
6572 @item %j@var{suffix}
6573 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6574 writable, and if save-temps is off; otherwise, substitute the name
6575 of a temporary file, just like @samp{%u}.  This temporary file is not
6576 meant for communication between processes, but rather as a junk
6577 disposal mechanism.
6579 @item %|@var{suffix}
6580 @itemx %m@var{suffix}
6581 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6582 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6583 all.  These are the two most common ways to instruct a program that it
6584 should read from standard input or write to standard output.  If you
6585 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6586 construct: see for example @file{f/lang-specs.h}.
6588 @item %.@var{SUFFIX}
6589 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6590 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6591 terminated by the next space or %.
6593 @item %w
6594 Marks the argument containing or following the @samp{%w} as the
6595 designated output file of this compilation.  This puts the argument
6596 into the sequence of arguments that @samp{%o} will substitute later.
6598 @item %o
6599 Substitutes the names of all the output files, with spaces
6600 automatically placed around them.  You should write spaces
6601 around the @samp{%o} as well or the results are undefined.
6602 @samp{%o} is for use in the specs for running the linker.
6603 Input files whose names have no recognized suffix are not compiled
6604 at all, but they are included among the output files, so they will
6605 be linked.
6607 @item %O
6608 Substitutes the suffix for object files.  Note that this is
6609 handled specially when it immediately follows @samp{%g, %u, or %U},
6610 because of the need for those to form complete file names.  The
6611 handling is such that @samp{%O} is treated exactly as if it had already
6612 been substituted, except that @samp{%g, %u, and %U} do not currently
6613 support additional @var{suffix} characters following @samp{%O} as they would
6614 following, for example, @samp{.o}.
6616 @item %p
6617 Substitutes the standard macro predefinitions for the
6618 current target machine.  Use this when running @code{cpp}.
6620 @item %P
6621 Like @samp{%p}, but puts @samp{__} before and after the name of each
6622 predefined macro, except for macros that start with @samp{__} or with
6623 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6626 @item %I
6627 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6628 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6629 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6630 as necessary.
6632 @item %s
6633 Current argument is the name of a library or startup file of some sort.
6634 Search for that file in a standard list of directories and substitute
6635 the full name found.
6637 @item %e@var{str}
6638 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6639 Use this when inconsistent options are detected.
6641 @item %(@var{name})
6642 Substitute the contents of spec string @var{name} at this point.
6644 @item %[@var{name}]
6645 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6647 @item %x@{@var{option}@}
6648 Accumulate an option for @samp{%X}.
6650 @item %X
6651 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6652 spec string.
6654 @item %Y
6655 Output the accumulated assembler options specified by @option{-Wa}.
6657 @item %Z
6658 Output the accumulated preprocessor options specified by @option{-Wp}.
6660 @item %a
6661 Process the @code{asm} spec.  This is used to compute the
6662 switches to be passed to the assembler.
6664 @item %A
6665 Process the @code{asm_final} spec.  This is a spec string for
6666 passing switches to an assembler post-processor, if such a program is
6667 needed.
6669 @item %l
6670 Process the @code{link} spec.  This is the spec for computing the
6671 command line passed to the linker.  Typically it will make use of the
6672 @samp{%L %G %S %D and %E} sequences.
6674 @item %D
6675 Dump out a @option{-L} option for each directory that GCC believes might
6676 contain startup files.  If the target supports multilibs then the
6677 current multilib directory will be prepended to each of these paths.
6679 @item %L
6680 Process the @code{lib} spec.  This is a spec string for deciding which
6681 libraries should be included on the command line to the linker.
6683 @item %G
6684 Process the @code{libgcc} spec.  This is a spec string for deciding
6685 which GCC support library should be included on the command line to the linker.
6687 @item %S
6688 Process the @code{startfile} spec.  This is a spec for deciding which
6689 object files should be the first ones passed to the linker.  Typically
6690 this might be a file named @file{crt0.o}.
6692 @item %E
6693 Process the @code{endfile} spec.  This is a spec string that specifies
6694 the last object files that will be passed to the linker.
6696 @item %C
6697 Process the @code{cpp} spec.  This is used to construct the arguments
6698 to be passed to the C preprocessor.
6700 @item %1
6701 Process the @code{cc1} spec.  This is used to construct the options to be
6702 passed to the actual C compiler (@samp{cc1}).
6704 @item %2
6705 Process the @code{cc1plus} spec.  This is used to construct the options to be
6706 passed to the actual C++ compiler (@samp{cc1plus}).
6708 @item %*
6709 Substitute the variable part of a matched option.  See below.
6710 Note that each comma in the substituted string is replaced by
6711 a single space.
6713 @item %<@code{S}
6714 Remove all occurrences of @code{-S} from the command line.  Note---this
6715 command is position dependent.  @samp{%} commands in the spec string
6716 before this one will see @code{-S}, @samp{%} commands in the spec string
6717 after this one will not.
6719 @item %:@var{function}(@var{args})
6720 Call the named function @var{function}, passing it @var{args}.
6721 @var{args} is first processed as a nested spec string, then split
6722 into an argument vector in the usual fashion.  The function returns
6723 a string which is processed as if it had appeared literally as part
6724 of the current spec.
6726 The following built-in spec functions are provided:
6728 @table @code
6729 @item @code{if-exists}
6730 The @code{if-exists} spec function takes one argument, an absolute
6731 pathname to a file.  If the file exists, @code{if-exists} returns the
6732 pathname.  Here is a small example of its usage:
6734 @smallexample
6735 *startfile:
6736 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6737 @end smallexample
6739 @item @code{if-exists-else}
6740 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6741 spec function, except that it takes two arguments.  The first argument is
6742 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6743 returns the pathname.  If it does not exist, it returns the second argument.
6744 This way, @code{if-exists-else} can be used to select one file or another,
6745 based on the existence of the first.  Here is a small example of its usage:
6747 @smallexample
6748 *startfile:
6749 crt0%O%s %:if-exists(crti%O%s) \
6750 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6751 @end smallexample
6753 @item @code{replace-outfile}
6754 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6755 first argument in the outfiles array and replaces it with the second argument.  Here
6756 is a small example of its usage:
6758 @smallexample
6759 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6760 @end smallexample
6762 @end table
6764 @item %@{@code{S}@}
6765 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6766 If that switch was not specified, this substitutes nothing.  Note that
6767 the leading dash is omitted when specifying this option, and it is
6768 automatically inserted if the substitution is performed.  Thus the spec
6769 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6770 and would output the command line option @option{-foo}.
6772 @item %W@{@code{S}@}
6773 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6774 deleted on failure.
6776 @item %@{@code{S}*@}
6777 Substitutes all the switches specified to GCC whose names start
6778 with @code{-S}, but which also take an argument.  This is used for
6779 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6780 GCC considers @option{-o foo} as being
6781 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6782 text, including the space.  Thus two arguments would be generated.
6784 @item %@{@code{S}*&@code{T}*@}
6785 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6786 (the order of @code{S} and @code{T} in the spec is not significant).
6787 There can be any number of ampersand-separated variables; for each the
6788 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6790 @item %@{@code{S}:@code{X}@}
6791 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6793 @item %@{!@code{S}:@code{X}@}
6794 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6796 @item %@{@code{S}*:@code{X}@}
6797 Substitutes @code{X} if one or more switches whose names start with
6798 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6799 once, no matter how many such switches appeared.  However, if @code{%*}
6800 appears somewhere in @code{X}, then @code{X} will be substituted once
6801 for each matching switch, with the @code{%*} replaced by the part of
6802 that switch that matched the @code{*}.
6804 @item %@{.@code{S}:@code{X}@}
6805 Substitutes @code{X}, if processing a file with suffix @code{S}.
6807 @item %@{!.@code{S}:@code{X}@}
6808 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6810 @item %@{@code{S}|@code{P}:@code{X}@}
6811 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6812 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6813 although they have a stronger binding than the @samp{|}.  If @code{%*}
6814 appears in @code{X}, all of the alternatives must be starred, and only
6815 the first matching alternative is substituted.
6817 For example, a spec string like this:
6819 @smallexample
6820 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6821 @end smallexample
6823 will output the following command-line options from the following input
6824 command-line options:
6826 @smallexample
6827 fred.c        -foo -baz
6828 jim.d         -bar -boggle
6829 -d fred.c     -foo -baz -boggle
6830 -d jim.d      -bar -baz -boggle
6831 @end smallexample
6833 @item %@{S:X; T:Y; :D@}
6835 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6836 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6837 be as many clauses as you need.  This may be combined with @code{.},
6838 @code{!}, @code{|}, and @code{*} as needed.
6841 @end table
6843 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6844 construct may contain other nested @samp{%} constructs or spaces, or
6845 even newlines.  They are processed as usual, as described above.
6846 Trailing white space in @code{X} is ignored.  White space may also
6847 appear anywhere on the left side of the colon in these constructs,
6848 except between @code{.} or @code{*} and the corresponding word.
6850 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6851 handled specifically in these constructs.  If another value of
6852 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6853 @option{-W} switch is found later in the command line, the earlier
6854 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6855 just one letter, which passes all matching options.
6857 The character @samp{|} at the beginning of the predicate text is used to
6858 indicate that a command should be piped to the following command, but
6859 only if @option{-pipe} is specified.
6861 It is built into GCC which switches take arguments and which do not.
6862 (You might think it would be useful to generalize this to allow each
6863 compiler's spec to say which switches take arguments.  But this cannot
6864 be done in a consistent fashion.  GCC cannot even decide which input
6865 files have been specified without knowing which switches take arguments,
6866 and it must know which input files to compile in order to tell which
6867 compilers to run).
6869 GCC also knows implicitly that arguments starting in @option{-l} are to be
6870 treated as compiler output files, and passed to the linker in their
6871 proper position among the other output files.
6873 @c man begin OPTIONS
6875 @node Target Options
6876 @section Specifying Target Machine and Compiler Version
6877 @cindex target options
6878 @cindex cross compiling
6879 @cindex specifying machine version
6880 @cindex specifying compiler version and target machine
6881 @cindex compiler version, specifying
6882 @cindex target machine, specifying
6884 The usual way to run GCC is to run the executable called @file{gcc}, or
6885 @file{<machine>-gcc} when cross-compiling, or
6886 @file{<machine>-gcc-<version>} to run a version other than the one that
6887 was installed last.  Sometimes this is inconvenient, so GCC provides
6888 options that will switch to another cross-compiler or version.
6890 @table @gcctabopt
6891 @item -b @var{machine}
6892 @opindex b
6893 The argument @var{machine} specifies the target machine for compilation.
6895 The value to use for @var{machine} is the same as was specified as the
6896 machine type when configuring GCC as a cross-compiler.  For
6897 example, if a cross-compiler was configured with @samp{configure
6898 i386v}, meaning to compile for an 80386 running System V, then you
6899 would specify @option{-b i386v} to run that cross compiler.
6901 @item -V @var{version}
6902 @opindex V
6903 The argument @var{version} specifies which version of GCC to run.
6904 This is useful when multiple versions are installed.  For example,
6905 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6906 @end table
6908 The @option{-V} and @option{-b} options work by running the
6909 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6910 use them if you can just run that directly.
6912 @node Submodel Options
6913 @section Hardware Models and Configurations
6914 @cindex submodel options
6915 @cindex specifying hardware config
6916 @cindex hardware models and configurations, specifying
6917 @cindex machine dependent options
6919 Earlier we discussed the standard option @option{-b} which chooses among
6920 different installed compilers for completely different target
6921 machines, such as VAX vs.@: 68000 vs.@: 80386.
6923 In addition, each of these target machine types can have its own
6924 special options, starting with @samp{-m}, to choose among various
6925 hardware models or configurations---for example, 68010 vs 68020,
6926 floating coprocessor or none.  A single installed version of the
6927 compiler can compile for any model or configuration, according to the
6928 options specified.
6930 Some configurations of the compiler also support additional special
6931 options, usually for compatibility with other compilers on the same
6932 platform.
6934 @c This list is ordered alphanumerically by subsection name.
6935 @c It should be the same order and spelling as these options are listed
6936 @c in Machine Dependent Options
6938 @menu
6939 * ARC Options::
6940 * ARM Options::
6941 * AVR Options::
6942 * Blackfin Options::
6943 * CRIS Options::
6944 * Darwin Options::
6945 * DEC Alpha Options::
6946 * DEC Alpha/VMS Options::
6947 * FRV Options::
6948 * H8/300 Options::
6949 * HPPA Options::
6950 * i386 and x86-64 Options::
6951 * IA-64 Options::
6952 * M32R/D Options::
6953 * M680x0 Options::
6954 * M68hc1x Options::
6955 * MCore Options::
6956 * MIPS Options::
6957 * MMIX Options::
6958 * MN10300 Options::
6959 * NS32K Options::
6960 * PDP-11 Options::
6961 * PowerPC Options::
6962 * RS/6000 and PowerPC Options::
6963 * S/390 and zSeries Options::
6964 * SH Options::
6965 * SPARC Options::
6966 * System V Options::
6967 * TMS320C3x/C4x Options::
6968 * V850 Options::
6969 * VAX Options::
6970 * x86-64 Options::
6971 * Xstormy16 Options::
6972 * Xtensa Options::
6973 * zSeries Options::
6974 @end menu
6976 @node ARC Options
6977 @subsection ARC Options
6978 @cindex ARC Options
6980 These options are defined for ARC implementations:
6982 @table @gcctabopt
6983 @item -EL
6984 @opindex EL
6985 Compile code for little endian mode.  This is the default.
6987 @item -EB
6988 @opindex EB
6989 Compile code for big endian mode.
6991 @item -mmangle-cpu
6992 @opindex mmangle-cpu
6993 Prepend the name of the cpu to all public symbol names.
6994 In multiple-processor systems, there are many ARC variants with different
6995 instruction and register set characteristics.  This flag prevents code
6996 compiled for one cpu to be linked with code compiled for another.
6997 No facility exists for handling variants that are ``almost identical''.
6998 This is an all or nothing option.
7000 @item -mcpu=@var{cpu}
7001 @opindex mcpu
7002 Compile code for ARC variant @var{cpu}.
7003 Which variants are supported depend on the configuration.
7004 All variants support @option{-mcpu=base}, this is the default.
7006 @item -mtext=@var{text-section}
7007 @itemx -mdata=@var{data-section}
7008 @itemx -mrodata=@var{readonly-data-section}
7009 @opindex mtext
7010 @opindex mdata
7011 @opindex mrodata
7012 Put functions, data, and readonly data in @var{text-section},
7013 @var{data-section}, and @var{readonly-data-section} respectively
7014 by default.  This can be overridden with the @code{section} attribute.
7015 @xref{Variable Attributes}.
7017 @end table
7019 @node ARM Options
7020 @subsection ARM Options
7021 @cindex ARM options
7023 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7024 architectures:
7026 @table @gcctabopt
7027 @item -mabi=@var{name}
7028 @opindex mabi
7029 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7030 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
7032 @item -mapcs-frame
7033 @opindex mapcs-frame
7034 Generate a stack frame that is compliant with the ARM Procedure Call
7035 Standard for all functions, even if this is not strictly necessary for
7036 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7037 with this option will cause the stack frames not to be generated for
7038 leaf functions.  The default is @option{-mno-apcs-frame}.
7040 @item -mapcs
7041 @opindex mapcs
7042 This is a synonym for @option{-mapcs-frame}.
7044 @ignore
7045 @c not currently implemented
7046 @item -mapcs-stack-check
7047 @opindex mapcs-stack-check
7048 Generate code to check the amount of stack space available upon entry to
7049 every function (that actually uses some stack space).  If there is
7050 insufficient space available then either the function
7051 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7052 called, depending upon the amount of stack space required.  The run time
7053 system is required to provide these functions.  The default is
7054 @option{-mno-apcs-stack-check}, since this produces smaller code.
7056 @c not currently implemented
7057 @item -mapcs-float
7058 @opindex mapcs-float
7059 Pass floating point arguments using the float point registers.  This is
7060 one of the variants of the APCS@.  This option is recommended if the
7061 target hardware has a floating point unit or if a lot of floating point
7062 arithmetic is going to be performed by the code.  The default is
7063 @option{-mno-apcs-float}, since integer only code is slightly increased in
7064 size if @option{-mapcs-float} is used.
7066 @c not currently implemented
7067 @item -mapcs-reentrant
7068 @opindex mapcs-reentrant
7069 Generate reentrant, position independent code.  The default is
7070 @option{-mno-apcs-reentrant}.
7071 @end ignore
7073 @item -mthumb-interwork
7074 @opindex mthumb-interwork
7075 Generate code which supports calling between the ARM and Thumb
7076 instruction sets.  Without this option the two instruction sets cannot
7077 be reliably used inside one program.  The default is
7078 @option{-mno-thumb-interwork}, since slightly larger code is generated
7079 when @option{-mthumb-interwork} is specified.
7081 @item -mno-sched-prolog
7082 @opindex mno-sched-prolog
7083 Prevent the reordering of instructions in the function prolog, or the
7084 merging of those instruction with the instructions in the function's
7085 body.  This means that all functions will start with a recognizable set
7086 of instructions (or in fact one of a choice from a small set of
7087 different function prologues), and this information can be used to
7088 locate the start if functions inside an executable piece of code.  The
7089 default is @option{-msched-prolog}.
7091 @item -mhard-float
7092 @opindex mhard-float
7093 Generate output containing floating point instructions.  This is the
7094 default.
7096 @item -msoft-float
7097 @opindex msoft-float
7098 Generate output containing library calls for floating point.
7099 @strong{Warning:} the requisite libraries are not available for all ARM
7100 targets.  Normally the facilities of the machine's usual C compiler are
7101 used, but this cannot be done directly in cross-compilation.  You must make
7102 your own arrangements to provide suitable library functions for
7103 cross-compilation.
7105 @option{-msoft-float} changes the calling convention in the output file;
7106 therefore, it is only useful if you compile @emph{all} of a program with
7107 this option.  In particular, you need to compile @file{libgcc.a}, the
7108 library that comes with GCC, with @option{-msoft-float} in order for
7109 this to work.
7111 @item -mfloat-abi=@var{name}
7112 @opindex mfloat-abi
7113 Specifies which ABI to use for floating point values.  Permissible values
7114 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7116 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7117 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7118 of floating point instructions, but still uses the soft-float calling
7119 conventions.
7121 @item -mlittle-endian
7122 @opindex mlittle-endian
7123 Generate code for a processor running in little-endian mode.  This is
7124 the default for all standard configurations.
7126 @item -mbig-endian
7127 @opindex mbig-endian
7128 Generate code for a processor running in big-endian mode; the default is
7129 to compile code for a little-endian processor.
7131 @item -mwords-little-endian
7132 @opindex mwords-little-endian
7133 This option only applies when generating code for big-endian processors.
7134 Generate code for a little-endian word order but a big-endian byte
7135 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7136 option should only be used if you require compatibility with code for
7137 big-endian ARM processors generated by versions of the compiler prior to
7138 2.8.
7140 @item -mcpu=@var{name}
7141 @opindex mcpu
7142 This specifies the name of the target ARM processor.  GCC uses this name
7143 to determine what kind of instructions it can emit when generating
7144 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7145 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7146 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7147 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7148 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7149 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7150 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7151 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7152 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7153 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7154 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7155 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7156 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7157 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7158 @samp{ep9312}.
7160 @itemx -mtune=@var{name}
7161 @opindex mtune
7162 This option is very similar to the @option{-mcpu=} option, except that
7163 instead of specifying the actual target processor type, and hence
7164 restricting which instructions can be used, it specifies that GCC should
7165 tune the performance of the code as if the target were of the type
7166 specified in this option, but still choosing the instructions that it
7167 will generate based on the cpu specified by a @option{-mcpu=} option.
7168 For some ARM implementations better performance can be obtained by using
7169 this option.
7171 @item -march=@var{name}
7172 @opindex march
7173 This specifies the name of the target ARM architecture.  GCC uses this
7174 name to determine what kind of instructions it can emit when generating
7175 assembly code.  This option can be used in conjunction with or instead
7176 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7177 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7178 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7179 @samp{iwmmxt}, @samp{ep9312}.
7181 @item -mfpu=@var{name}
7182 @itemx -mfpe=@var{number}
7183 @itemx -mfp=@var{number}
7184 @opindex mfpu
7185 @opindex mfpe
7186 @opindex mfp
7187 This specifies what floating point hardware (or hardware emulation) is
7188 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7189 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7190 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7191 with older versions of GCC@.
7193 If @option{-msoft-float} is specified this specifies the format of
7194 floating point values.
7196 @item -mstructure-size-boundary=@var{n}
7197 @opindex mstructure-size-boundary
7198 The size of all structures and unions will be rounded up to a multiple
7199 of the number of bits set by this option.  Permissible values are 8, 32
7200 and 64.  The default value varies for different toolchains.  For the COFF
7201 targeted toolchain the default value is 8.  A value of 64 is only allowed
7202 if the underlying ABI supports it.
7204 Specifying the larger number can produce faster, more efficient code, but
7205 can also increase the size of the program.  Different values are potentially
7206 incompatible.  Code compiled with one value cannot necessarily expect to
7207 work with code or libraries compiled with another value, if they exchange
7208 information using structures or unions.
7210 @item -mabort-on-noreturn
7211 @opindex mabort-on-noreturn
7212 Generate a call to the function @code{abort} at the end of a
7213 @code{noreturn} function.  It will be executed if the function tries to
7214 return.
7216 @item -mlong-calls
7217 @itemx -mno-long-calls
7218 @opindex mlong-calls
7219 @opindex mno-long-calls
7220 Tells the compiler to perform function calls by first loading the
7221 address of the function into a register and then performing a subroutine
7222 call on this register.  This switch is needed if the target function
7223 will lie outside of the 64 megabyte addressing range of the offset based
7224 version of subroutine call instruction.
7226 Even if this switch is enabled, not all function calls will be turned
7227 into long calls.  The heuristic is that static functions, functions
7228 which have the @samp{short-call} attribute, functions that are inside
7229 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7230 definitions have already been compiled within the current compilation
7231 unit, will not be turned into long calls.  The exception to this rule is
7232 that weak function definitions, functions with the @samp{long-call}
7233 attribute or the @samp{section} attribute, and functions that are within
7234 the scope of a @samp{#pragma long_calls} directive, will always be
7235 turned into long calls.
7237 This feature is not enabled by default.  Specifying
7238 @option{-mno-long-calls} will restore the default behavior, as will
7239 placing the function calls within the scope of a @samp{#pragma
7240 long_calls_off} directive.  Note these switches have no effect on how
7241 the compiler generates code to handle function calls via function
7242 pointers.
7244 @item -mnop-fun-dllimport
7245 @opindex mnop-fun-dllimport
7246 Disable support for the @code{dllimport} attribute.
7248 @item -msingle-pic-base
7249 @opindex msingle-pic-base
7250 Treat the register used for PIC addressing as read-only, rather than
7251 loading it in the prologue for each function.  The run-time system is
7252 responsible for initializing this register with an appropriate value
7253 before execution begins.
7255 @item -mpic-register=@var{reg}
7256 @opindex mpic-register
7257 Specify the register to be used for PIC addressing.  The default is R10
7258 unless stack-checking is enabled, when R9 is used.
7260 @item -mcirrus-fix-invalid-insns
7261 @opindex mcirrus-fix-invalid-insns
7262 @opindex mno-cirrus-fix-invalid-insns
7263 Insert NOPs into the instruction stream to in order to work around
7264 problems with invalid Maverick instruction combinations.  This option
7265 is only valid if the @option{-mcpu=ep9312} option has been used to
7266 enable generation of instructions for the Cirrus Maverick floating
7267 point co-processor.  This option is not enabled by default, since the
7268 problem is only present in older Maverick implementations.  The default
7269 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7270 switch.
7272 @item -mpoke-function-name
7273 @opindex mpoke-function-name
7274 Write the name of each function into the text section, directly
7275 preceding the function prologue.  The generated code is similar to this:
7277 @smallexample
7278      t0
7279          .ascii "arm_poke_function_name", 0
7280          .align
7281      t1
7282          .word 0xff000000 + (t1 - t0)
7283      arm_poke_function_name
7284          mov     ip, sp
7285          stmfd   sp!, @{fp, ip, lr, pc@}
7286          sub     fp, ip, #4
7287 @end smallexample
7289 When performing a stack backtrace, code can inspect the value of
7290 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7291 location @code{pc - 12} and the top 8 bits are set, then we know that
7292 there is a function name embedded immediately preceding this location
7293 and has length @code{((pc[-3]) & 0xff000000)}.
7295 @item -mthumb
7296 @opindex mthumb
7297 Generate code for the 16-bit Thumb instruction set.  The default is to
7298 use the 32-bit ARM instruction set.
7300 @item -mtpcs-frame
7301 @opindex mtpcs-frame
7302 Generate a stack frame that is compliant with the Thumb Procedure Call
7303 Standard for all non-leaf functions.  (A leaf function is one that does
7304 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7306 @item -mtpcs-leaf-frame
7307 @opindex mtpcs-leaf-frame
7308 Generate a stack frame that is compliant with the Thumb Procedure Call
7309 Standard for all leaf functions.  (A leaf function is one that does
7310 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7312 @item -mcallee-super-interworking
7313 @opindex mcallee-super-interworking
7314 Gives all externally visible functions in the file being compiled an ARM
7315 instruction set header which switches to Thumb mode before executing the
7316 rest of the function.  This allows these functions to be called from
7317 non-interworking code.
7319 @item -mcaller-super-interworking
7320 @opindex mcaller-super-interworking
7321 Allows calls via function pointers (including virtual functions) to
7322 execute correctly regardless of whether the target code has been
7323 compiled for interworking or not.  There is a small overhead in the cost
7324 of executing a function pointer if this option is enabled.
7326 @end table
7328 @node AVR Options
7329 @subsection AVR Options
7330 @cindex AVR Options
7332 These options are defined for AVR implementations:
7334 @table @gcctabopt
7335 @item -mmcu=@var{mcu}
7336 @opindex mmcu
7337 Specify ATMEL AVR instruction set or MCU type.
7339 Instruction set avr1 is for the minimal AVR core, not supported by the C
7340 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7341 attiny11, attiny12, attiny15, attiny28).
7343 Instruction set avr2 (default) is for the classic AVR core with up to
7344 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7345 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7346 at90c8534, at90s8535).
7348 Instruction set avr3 is for the classic AVR core with up to 128K program
7349 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7351 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7352 memory space (MCU types: atmega8, atmega83, atmega85).
7354 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7355 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7356 atmega64, atmega128, at43usb355, at94k).
7358 @item -msize
7359 @opindex msize
7360 Output instruction sizes to the asm file.
7362 @item -minit-stack=@var{N}
7363 @opindex minit-stack
7364 Specify the initial stack address, which may be a symbol or numeric value,
7365 @samp{__stack} is the default.
7367 @item -mno-interrupts
7368 @opindex mno-interrupts
7369 Generated code is not compatible with hardware interrupts.
7370 Code size will be smaller.
7372 @item -mcall-prologues
7373 @opindex mcall-prologues
7374 Functions prologues/epilogues expanded as call to appropriate
7375 subroutines.  Code size will be smaller.
7377 @item -mno-tablejump
7378 @opindex mno-tablejump
7379 Do not generate tablejump insns which sometimes increase code size.
7381 @item -mtiny-stack
7382 @opindex mtiny-stack
7383 Change only the low 8 bits of the stack pointer.
7385 @item -mint8
7386 @opindex mint8
7387 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7388 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7389 and long long will be 4 bytes.  Please note that this option does not
7390 comply to the C standards, but it will provide you with smaller code
7391 size.
7392 @end table
7394 @node Blackfin Options
7395 @subsection Blackfin Options
7396 @cindex Blackfin Options
7398 @table @gcctabopt
7399 @item -momit-leaf-frame-pointer
7400 @opindex momit-leaf-frame-pointer
7401 Don't keep the frame pointer in a register for leaf functions.  This
7402 avoids the instructions to save, set up and restore frame pointers and
7403 makes an extra register available in leaf functions.  The option
7404 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7405 which might make debugging harder.
7407 @item -mspecld-anomaly
7408 @opindex mspecld-anomaly
7409 When enabled, the compiler will ensure that the generated code does not
7410 contain speculative loads after jump instructions.  This option is enabled
7411 by default.
7413 @item -mno-specld-anomaly
7414 @opindex mno-specld-anomaly
7415 Don't generate extra code to prevent speculative loads from occurring.
7417 @item -mcsync-anomaly
7418 @opindex mcsync-anomaly
7419 When enabled, the compiler will ensure that the generated code does not
7420 contain CSYNC or SSYNC instructions too soon after conditional branches.
7421 This option is enabled by default.
7423 @item -mno-csync-anomaly
7424 @opindex mno-csync-anomaly
7425 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7426 occurring too soon after a conditional branch.
7428 @item -mlow-64k
7429 @opindex mlow-64k
7430 When enabled, the compiler is free to take advantage of the knowledge that
7431 the entire program fits into the low 64k of memory.
7433 @item -mno-low-64k
7434 @opindex mno-low-64k
7435 Assume that the program is arbitrarily large.  This is the default.
7437 @item -mid-shared-library
7438 @opindex mid-shared-library
7439 Generate code that supports shared libraries via the library ID method.
7440 This allows for execute in place and shared libraries in an environment
7441 without virtual memory management.  This option implies @option{-fPIC}.
7443 @item -mno-id-shared-library
7444 @opindex mno-id-shared-library
7445 Generate code that doesn't assume ID based shared libraries are being used.
7446 This is the default.
7448 @item -mshared-library-id=n
7449 @opindex mshared-library-id
7450 Specified the identification number of the ID based shared library being
7451 compiled.  Specifying a value of 0 will generate more compact code, specifying
7452 other values will force the allocation of that number to the current
7453 library but is no more space or time efficient than omitting this option.
7455 @item -mlong-calls
7456 @itemx -mno-long-calls
7457 @opindex mlong-calls
7458 @opindex mno-long-calls
7459 Tells the compiler to perform function calls by first loading the
7460 address of the function into a register and then performing a subroutine
7461 call on this register.  This switch is needed if the target function
7462 will lie outside of the 24 bit addressing range of the offset based
7463 version of subroutine call instruction.
7465 This feature is not enabled by default.  Specifying
7466 @option{-mno-long-calls} will restore the default behavior.  Note these
7467 switches have no effect on how the compiler generates code to handle
7468 function calls via function pointers.
7469 @end table
7471 @node CRIS Options
7472 @subsection CRIS Options
7473 @cindex CRIS Options
7475 These options are defined specifically for the CRIS ports.
7477 @table @gcctabopt
7478 @item -march=@var{architecture-type}
7479 @itemx -mcpu=@var{architecture-type}
7480 @opindex march
7481 @opindex mcpu
7482 Generate code for the specified architecture.  The choices for
7483 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7484 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7485 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7486 @samp{v10}.
7488 @item -mtune=@var{architecture-type}
7489 @opindex mtune
7490 Tune to @var{architecture-type} everything applicable about the generated
7491 code, except for the ABI and the set of available instructions.  The
7492 choices for @var{architecture-type} are the same as for
7493 @option{-march=@var{architecture-type}}.
7495 @item -mmax-stack-frame=@var{n}
7496 @opindex mmax-stack-frame
7497 Warn when the stack frame of a function exceeds @var{n} bytes.
7499 @item -melinux-stacksize=@var{n}
7500 @opindex melinux-stacksize
7501 Only available with the @samp{cris-axis-aout} target.  Arranges for
7502 indications in the program to the kernel loader that the stack of the
7503 program should be set to @var{n} bytes.
7505 @item -metrax4
7506 @itemx -metrax100
7507 @opindex metrax4
7508 @opindex metrax100
7509 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7510 @option{-march=v3} and @option{-march=v8} respectively.
7512 @item -mmul-bug-workaround
7513 @itemx -mno-mul-bug-workaround
7514 @opindex mmul-bug-workaround
7515 @opindex mno-mul-bug-workaround
7516 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7517 models where it applies.  This option is active by default.
7519 @item -mpdebug
7520 @opindex mpdebug
7521 Enable CRIS-specific verbose debug-related information in the assembly
7522 code.  This option also has the effect to turn off the @samp{#NO_APP}
7523 formatted-code indicator to the assembler at the beginning of the
7524 assembly file.
7526 @item -mcc-init
7527 @opindex mcc-init
7528 Do not use condition-code results from previous instruction; always emit
7529 compare and test instructions before use of condition codes.
7531 @item -mno-side-effects
7532 @opindex mno-side-effects
7533 Do not emit instructions with side-effects in addressing modes other than
7534 post-increment.
7536 @item -mstack-align
7537 @itemx -mno-stack-align
7538 @itemx -mdata-align
7539 @itemx -mno-data-align
7540 @itemx -mconst-align
7541 @itemx -mno-const-align
7542 @opindex mstack-align
7543 @opindex mno-stack-align
7544 @opindex mdata-align
7545 @opindex mno-data-align
7546 @opindex mconst-align
7547 @opindex mno-const-align
7548 These options (no-options) arranges (eliminate arrangements) for the
7549 stack-frame, individual data and constants to be aligned for the maximum
7550 single data access size for the chosen CPU model.  The default is to
7551 arrange for 32-bit alignment.  ABI details such as structure layout are
7552 not affected by these options.
7554 @item -m32-bit
7555 @itemx -m16-bit
7556 @itemx -m8-bit
7557 @opindex m32-bit
7558 @opindex m16-bit
7559 @opindex m8-bit
7560 Similar to the stack- data- and const-align options above, these options
7561 arrange for stack-frame, writable data and constants to all be 32-bit,
7562 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7564 @item -mno-prologue-epilogue
7565 @itemx -mprologue-epilogue
7566 @opindex mno-prologue-epilogue
7567 @opindex mprologue-epilogue
7568 With @option{-mno-prologue-epilogue}, the normal function prologue and
7569 epilogue that sets up the stack-frame are omitted and no return
7570 instructions or return sequences are generated in the code.  Use this
7571 option only together with visual inspection of the compiled code: no
7572 warnings or errors are generated when call-saved registers must be saved,
7573 or storage for local variable needs to be allocated.
7575 @item -mno-gotplt
7576 @itemx -mgotplt
7577 @opindex mno-gotplt
7578 @opindex mgotplt
7579 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7580 instruction sequences that load addresses for functions from the PLT part
7581 of the GOT rather than (traditional on other architectures) calls to the
7582 PLT@.  The default is @option{-mgotplt}.
7584 @item -maout
7585 @opindex maout
7586 Legacy no-op option only recognized with the cris-axis-aout target.
7588 @item -melf
7589 @opindex melf
7590 Legacy no-op option only recognized with the cris-axis-elf and
7591 cris-axis-linux-gnu targets.
7593 @item -melinux
7594 @opindex melinux
7595 Only recognized with the cris-axis-aout target, where it selects a
7596 GNU/linux-like multilib, include files and instruction set for
7597 @option{-march=v8}.
7599 @item -mlinux
7600 @opindex mlinux
7601 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7603 @item -sim
7604 @opindex sim
7605 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7606 to link with input-output functions from a simulator library.  Code,
7607 initialized data and zero-initialized data are allocated consecutively.
7609 @item -sim2
7610 @opindex sim2
7611 Like @option{-sim}, but pass linker options to locate initialized data at
7612 0x40000000 and zero-initialized data at 0x80000000.
7613 @end table
7615 @node Darwin Options
7616 @subsection Darwin Options
7617 @cindex Darwin options
7619 These options are defined for all architectures running the Darwin operating
7620 system.
7622 FSF GCC on Darwin does not create ``fat'' object files; it will create
7623 an object file for the single architecture that it was built to
7624 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7625 @option{-arch} options are used; it does so by running the compiler or
7626 linker multiple times and joining the results together with
7627 @file{lipo}.
7629 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7630 @samp{i686}) is determined by the flags that specify the ISA
7631 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7632 @option{-force_cpusubtype_ALL} option can be used to override this.
7634 The Darwin tools vary in their behavior when presented with an ISA
7635 mismatch.  The assembler, @file{as}, will only permit instructions to
7636 be used that are valid for the subtype of the file it is generating,
7637 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7638 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7639 and print an error if asked to create a shared library with a less
7640 restrictive subtype than its input files (for instance, trying to put
7641 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7642 for executables, @file{ld}, will quietly give the executable the most
7643 restrictive subtype of any of its input files.
7645 @table @gcctabopt
7646 @item -F@var{dir}
7647 @opindex F
7648 Add the framework directory @var{dir} to the head of the list of
7649 directories to be searched for header files.  These directories are
7650 interleaved with those specified by @option{-I} options and are
7651 scanned in a left-to-right order.
7653 A framework directory is a directory with frameworks in it.  A
7654 framework is a directory with a @samp{"Headers"} and/or
7655 @samp{"PrivateHeaders"} directory contained directly in it that ends
7656 in @samp{".framework"}.  The name of a framework is the name of this
7657 directory excluding the @samp{".framework"}.  Headers associated with
7658 the framework are found in one of those two directories, with
7659 @samp{"Headers"} being searched first.  A subframework is a framework
7660 directory that is in a framework's @samp{"Frameworks"} directory.
7661 Includes of subframework headers can only appear in a header of a
7662 framework that contains the subframework, or in a sibling subframework
7663 header.  Two subframeworks are siblings if they occur in the same
7664 framework.  A subframework should not have the same name as a
7665 framework, a warning will be issued if this is violated.  Currently a
7666 subframework cannot have subframeworks, in the future, the mechanism
7667 may be extended to support this.  The standard frameworks can be found
7668 in @samp{"/System/Library/Frameworks"} and
7669 @samp{"/Library/Frameworks"}.  An example include looks like
7670 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7671 the name of the framework and header.h is found in the
7672 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7674 @item -gused
7675 @opindex -gused
7676 Emit debugging information for symbols that are used.  For STABS
7677 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7678 This is by default ON@.
7680 @item -gfull
7681 @opindex -gfull
7682 Emit debugging information for all symbols and types.
7684 @item -mmacosx-version-min=@var{version}
7685 The earliest version of MacOS X that this executable will run on
7686 is @var{version}.  Typical values of @var{version} include @code{10.1},
7687 @code{10.2}, and @code{10.3.9}.
7689 The default for this option is to make choices that seem to be most
7690 useful.  
7692 @item -mone-byte-bool
7693 @opindex -mone-byte-bool
7694 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7695 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7696 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7697 option has no effect on x86.
7699 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7700 to generate code that is not binary compatible with code generated
7701 without that switch.  Using this switch may require recompiling all
7702 other modules in a program, including system libraries.  Use this
7703 switch to conform to a non-default data model.
7705 @item -mfix-and-continue
7706 @itemx -ffix-and-continue
7707 @itemx -findirect-data
7708 @opindex mfix-and-continue
7709 @opindex ffix-and-continue
7710 @opindex findirect-data
7711 Generate code suitable for fast turn around development.  Needed to
7712 enable gdb to dynamically load @code{.o} files into already running
7713 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7714 are provided for backwards compatibility.
7716 @item -all_load
7717 @opindex all_load
7718 Loads all members of static archive libraries.
7719 See man ld(1) for more information.
7721 @item -arch_errors_fatal
7722 @opindex arch_errors_fatal
7723 Cause the errors having to do with files that have the wrong architecture
7724 to be fatal.
7726 @item -bind_at_load
7727 @opindex bind_at_load
7728 Causes the output file to be marked such that the dynamic linker will
7729 bind all undefined references when the file is loaded or launched.
7731 @item -bundle
7732 @opindex bundle
7733 Produce a Mach-o bundle format file.
7734 See man ld(1) for more information.
7736 @item -bundle_loader @var{executable}
7737 @opindex bundle_loader
7738 This option specifies the @var{executable} that will be loading the build
7739 output file being linked.  See man ld(1) for more information.
7741 @item -dynamiclib
7742 @opindex -dynamiclib
7743 When passed this option, GCC will produce a dynamic library instead of
7744 an executable when linking, using the Darwin @file{libtool} command.
7746 @item -force_cpusubtype_ALL
7747 @opindex -force_cpusubtype_ALL
7748 This causes GCC's output file to have the @var{ALL} subtype, instead of
7749 one controlled by the @option{-mcpu} or @option{-march} option.
7751 @item -allowable_client  @var{client_name}
7752 @itemx -client_name
7753 @itemx -compatibility_version
7754 @itemx -current_version
7755 @itemx -dead_strip
7756 @itemx -dependency-file
7757 @itemx -dylib_file
7758 @itemx -dylinker_install_name
7759 @itemx -dynamic
7760 @itemx -exported_symbols_list
7761 @itemx -filelist
7762 @itemx -flat_namespace
7763 @itemx -force_flat_namespace
7764 @itemx -headerpad_max_install_names
7765 @itemx -image_base
7766 @itemx -init
7767 @itemx -install_name
7768 @itemx -keep_private_externs
7769 @itemx -multi_module
7770 @itemx -multiply_defined
7771 @itemx -multiply_defined_unused
7772 @itemx -noall_load
7773 @itemx -no_dead_strip_inits_and_terms
7774 @itemx -nofixprebinding
7775 @itemx -nomultidefs
7776 @itemx -noprebind
7777 @itemx -noseglinkedit
7778 @itemx -pagezero_size
7779 @itemx -prebind
7780 @itemx -prebind_all_twolevel_modules
7781 @itemx -private_bundle
7782 @itemx -read_only_relocs
7783 @itemx -sectalign
7784 @itemx -sectobjectsymbols
7785 @itemx -whyload
7786 @itemx -seg1addr
7787 @itemx -sectcreate
7788 @itemx -sectobjectsymbols
7789 @itemx -sectorder
7790 @itemx -segaddr
7791 @itemx -segs_read_only_addr
7792 @itemx -segs_read_write_addr
7793 @itemx -seg_addr_table
7794 @itemx -seg_addr_table_filename
7795 @itemx -seglinkedit
7796 @itemx -segprot
7797 @itemx -segs_read_only_addr
7798 @itemx -segs_read_write_addr
7799 @itemx -single_module
7800 @itemx -static
7801 @itemx -sub_library
7802 @itemx -sub_umbrella
7803 @itemx -twolevel_namespace
7804 @itemx -umbrella
7805 @itemx -undefined
7806 @itemx -unexported_symbols_list
7807 @itemx -weak_reference_mismatches
7808 @itemx -whatsloaded
7810 @opindex allowable_client
7811 @opindex client_name
7812 @opindex compatibility_version
7813 @opindex current_version
7814 @opindex dead_strip
7815 @opindex dependency-file
7816 @opindex dylib_file
7817 @opindex dylinker_install_name
7818 @opindex dynamic
7819 @opindex exported_symbols_list
7820 @opindex filelist
7821 @opindex flat_namespace
7822 @opindex force_flat_namespace
7823 @opindex headerpad_max_install_names
7824 @opindex image_base
7825 @opindex init
7826 @opindex install_name
7827 @opindex keep_private_externs
7828 @opindex multi_module
7829 @opindex multiply_defined
7830 @opindex multiply_defined_unused
7831 @opindex noall_load
7832 @opindex no_dead_strip_inits_and_terms
7833 @opindex nofixprebinding
7834 @opindex nomultidefs
7835 @opindex noprebind
7836 @opindex noseglinkedit
7837 @opindex pagezero_size
7838 @opindex prebind
7839 @opindex prebind_all_twolevel_modules
7840 @opindex private_bundle
7841 @opindex read_only_relocs
7842 @opindex sectalign
7843 @opindex sectobjectsymbols
7844 @opindex whyload
7845 @opindex seg1addr
7846 @opindex sectcreate
7847 @opindex sectobjectsymbols
7848 @opindex sectorder
7849 @opindex segaddr
7850 @opindex segs_read_only_addr
7851 @opindex segs_read_write_addr
7852 @opindex seg_addr_table
7853 @opindex seg_addr_table_filename
7854 @opindex seglinkedit
7855 @opindex segprot
7856 @opindex segs_read_only_addr
7857 @opindex segs_read_write_addr
7858 @opindex single_module
7859 @opindex static
7860 @opindex sub_library
7861 @opindex sub_umbrella
7862 @opindex twolevel_namespace
7863 @opindex umbrella
7864 @opindex undefined
7865 @opindex unexported_symbols_list
7866 @opindex weak_reference_mismatches
7867 @opindex whatsloaded
7869 These options are passed to the Darwin linker.  The Darwin linker man page
7870 describes them in detail.
7871 @end table
7873 @node DEC Alpha Options
7874 @subsection DEC Alpha Options
7876 These @samp{-m} options are defined for the DEC Alpha implementations:
7878 @table @gcctabopt
7879 @item -mno-soft-float
7880 @itemx -msoft-float
7881 @opindex mno-soft-float
7882 @opindex msoft-float
7883 Use (do not use) the hardware floating-point instructions for
7884 floating-point operations.  When @option{-msoft-float} is specified,
7885 functions in @file{libgcc.a} will be used to perform floating-point
7886 operations.  Unless they are replaced by routines that emulate the
7887 floating-point operations, or compiled in such a way as to call such
7888 emulations routines, these routines will issue floating-point
7889 operations.   If you are compiling for an Alpha without floating-point
7890 operations, you must ensure that the library is built so as not to call
7891 them.
7893 Note that Alpha implementations without floating-point operations are
7894 required to have floating-point registers.
7896 @item -mfp-reg
7897 @itemx -mno-fp-regs
7898 @opindex mfp-reg
7899 @opindex mno-fp-regs
7900 Generate code that uses (does not use) the floating-point register set.
7901 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7902 register set is not used, floating point operands are passed in integer
7903 registers as if they were integers and floating-point results are passed
7904 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7905 so any function with a floating-point argument or return value called by code
7906 compiled with @option{-mno-fp-regs} must also be compiled with that
7907 option.
7909 A typical use of this option is building a kernel that does not use,
7910 and hence need not save and restore, any floating-point registers.
7912 @item -mieee
7913 @opindex mieee
7914 The Alpha architecture implements floating-point hardware optimized for
7915 maximum performance.  It is mostly compliant with the IEEE floating
7916 point standard.  However, for full compliance, software assistance is
7917 required.  This option generates code fully IEEE compliant code
7918 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7919 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7920 defined during compilation.  The resulting code is less efficient but is
7921 able to correctly support denormalized numbers and exceptional IEEE
7922 values such as not-a-number and plus/minus infinity.  Other Alpha
7923 compilers call this option @option{-ieee_with_no_inexact}.
7925 @item -mieee-with-inexact
7926 @opindex mieee-with-inexact
7927 This is like @option{-mieee} except the generated code also maintains
7928 the IEEE @var{inexact-flag}.  Turning on this option causes the
7929 generated code to implement fully-compliant IEEE math.  In addition to
7930 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7931 macro.  On some Alpha implementations the resulting code may execute
7932 significantly slower than the code generated by default.  Since there is
7933 very little code that depends on the @var{inexact-flag}, you should
7934 normally not specify this option.  Other Alpha compilers call this
7935 option @option{-ieee_with_inexact}.
7937 @item -mfp-trap-mode=@var{trap-mode}
7938 @opindex mfp-trap-mode
7939 This option controls what floating-point related traps are enabled.
7940 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7941 The trap mode can be set to one of four values:
7943 @table @samp
7944 @item n
7945 This is the default (normal) setting.  The only traps that are enabled
7946 are the ones that cannot be disabled in software (e.g., division by zero
7947 trap).
7949 @item u
7950 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7951 as well.
7953 @item su
7954 Like @samp{su}, but the instructions are marked to be safe for software
7955 completion (see Alpha architecture manual for details).
7957 @item sui
7958 Like @samp{su}, but inexact traps are enabled as well.
7959 @end table
7961 @item -mfp-rounding-mode=@var{rounding-mode}
7962 @opindex mfp-rounding-mode
7963 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7964 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7967 @table @samp
7968 @item n
7969 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7970 the nearest machine number or towards the even machine number in case
7971 of a tie.
7973 @item m
7974 Round towards minus infinity.
7976 @item c
7977 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7979 @item d
7980 Dynamic rounding mode.  A field in the floating point control register
7981 (@var{fpcr}, see Alpha architecture reference manual) controls the
7982 rounding mode in effect.  The C library initializes this register for
7983 rounding towards plus infinity.  Thus, unless your program modifies the
7984 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7985 @end table
7987 @item -mtrap-precision=@var{trap-precision}
7988 @opindex mtrap-precision
7989 In the Alpha architecture, floating point traps are imprecise.  This
7990 means without software assistance it is impossible to recover from a
7991 floating trap and program execution normally needs to be terminated.
7992 GCC can generate code that can assist operating system trap handlers
7993 in determining the exact location that caused a floating point trap.
7994 Depending on the requirements of an application, different levels of
7995 precisions can be selected:
7997 @table @samp
7998 @item p
7999 Program precision.  This option is the default and means a trap handler
8000 can only identify which program caused a floating point exception.
8002 @item f
8003 Function precision.  The trap handler can determine the function that
8004 caused a floating point exception.
8006 @item i
8007 Instruction precision.  The trap handler can determine the exact
8008 instruction that caused a floating point exception.
8009 @end table
8011 Other Alpha compilers provide the equivalent options called
8012 @option{-scope_safe} and @option{-resumption_safe}.
8014 @item -mieee-conformant
8015 @opindex mieee-conformant
8016 This option marks the generated code as IEEE conformant.  You must not
8017 use this option unless you also specify @option{-mtrap-precision=i} and either
8018 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8019 is to emit the line @samp{.eflag 48} in the function prologue of the
8020 generated assembly file.  Under DEC Unix, this has the effect that
8021 IEEE-conformant math library routines will be linked in.
8023 @item -mbuild-constants
8024 @opindex mbuild-constants
8025 Normally GCC examines a 32- or 64-bit integer constant to
8026 see if it can construct it from smaller constants in two or three
8027 instructions.  If it cannot, it will output the constant as a literal and
8028 generate code to load it from the data segment at runtime.
8030 Use this option to require GCC to construct @emph{all} integer constants
8031 using code, even if it takes more instructions (the maximum is six).
8033 You would typically use this option to build a shared library dynamic
8034 loader.  Itself a shared library, it must relocate itself in memory
8035 before it can find the variables and constants in its own data segment.
8037 @item -malpha-as
8038 @itemx -mgas
8039 @opindex malpha-as
8040 @opindex mgas
8041 Select whether to generate code to be assembled by the vendor-supplied
8042 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8044 @item -mbwx
8045 @itemx -mno-bwx
8046 @itemx -mcix
8047 @itemx -mno-cix
8048 @itemx -mfix
8049 @itemx -mno-fix
8050 @itemx -mmax
8051 @itemx -mno-max
8052 @opindex mbwx
8053 @opindex mno-bwx
8054 @opindex mcix
8055 @opindex mno-cix
8056 @opindex mfix
8057 @opindex mno-fix
8058 @opindex mmax
8059 @opindex mno-max
8060 Indicate whether GCC should generate code to use the optional BWX,
8061 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8062 sets supported by the CPU type specified via @option{-mcpu=} option or that
8063 of the CPU on which GCC was built if none was specified.
8065 @item -mfloat-vax
8066 @itemx -mfloat-ieee
8067 @opindex mfloat-vax
8068 @opindex mfloat-ieee
8069 Generate code that uses (does not use) VAX F and G floating point
8070 arithmetic instead of IEEE single and double precision.
8072 @item -mexplicit-relocs
8073 @itemx -mno-explicit-relocs
8074 @opindex mexplicit-relocs
8075 @opindex mno-explicit-relocs
8076 Older Alpha assemblers provided no way to generate symbol relocations
8077 except via assembler macros.  Use of these macros does not allow
8078 optimal instruction scheduling.  GNU binutils as of version 2.12
8079 supports a new syntax that allows the compiler to explicitly mark
8080 which relocations should apply to which instructions.  This option
8081 is mostly useful for debugging, as GCC detects the capabilities of
8082 the assembler when it is built and sets the default accordingly.
8084 @item -msmall-data
8085 @itemx -mlarge-data
8086 @opindex msmall-data
8087 @opindex mlarge-data
8088 When @option{-mexplicit-relocs} is in effect, static data is
8089 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8090 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8091 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8092 16-bit relocations off of the @code{$gp} register.  This limits the
8093 size of the small data area to 64KB, but allows the variables to be
8094 directly accessed via a single instruction.
8096 The default is @option{-mlarge-data}.  With this option the data area
8097 is limited to just below 2GB@.  Programs that require more than 2GB of
8098 data must use @code{malloc} or @code{mmap} to allocate the data in the
8099 heap instead of in the program's data segment.
8101 When generating code for shared libraries, @option{-fpic} implies
8102 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8104 @item -msmall-text
8105 @itemx -mlarge-text
8106 @opindex msmall-text
8107 @opindex mlarge-text
8108 When @option{-msmall-text} is used, the compiler assumes that the
8109 code of the entire program (or shared library) fits in 4MB, and is
8110 thus reachable with a branch instruction.  When @option{-msmall-data}
8111 is used, the compiler can assume that all local symbols share the
8112 same @code{$gp} value, and thus reduce the number of instructions
8113 required for a function call from 4 to 1.
8115 The default is @option{-mlarge-text}.
8117 @item -mcpu=@var{cpu_type}
8118 @opindex mcpu
8119 Set the instruction set and instruction scheduling parameters for
8120 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8121 style name or the corresponding chip number.  GCC supports scheduling
8122 parameters for the EV4, EV5 and EV6 family of processors and will
8123 choose the default values for the instruction set from the processor
8124 you specify.  If you do not specify a processor type, GCC will default
8125 to the processor on which the compiler was built.
8127 Supported values for @var{cpu_type} are
8129 @table @samp
8130 @item ev4
8131 @itemx ev45
8132 @itemx 21064
8133 Schedules as an EV4 and has no instruction set extensions.
8135 @item ev5
8136 @itemx 21164
8137 Schedules as an EV5 and has no instruction set extensions.
8139 @item ev56
8140 @itemx 21164a
8141 Schedules as an EV5 and supports the BWX extension.
8143 @item pca56
8144 @itemx 21164pc
8145 @itemx 21164PC
8146 Schedules as an EV5 and supports the BWX and MAX extensions.
8148 @item ev6
8149 @itemx 21264
8150 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8152 @item ev67
8153 @itemx 21264a
8154 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8155 @end table
8157 @item -mtune=@var{cpu_type}
8158 @opindex mtune
8159 Set only the instruction scheduling parameters for machine type
8160 @var{cpu_type}.  The instruction set is not changed.
8162 @item -mmemory-latency=@var{time}
8163 @opindex mmemory-latency
8164 Sets the latency the scheduler should assume for typical memory
8165 references as seen by the application.  This number is highly
8166 dependent on the memory access patterns used by the application
8167 and the size of the external cache on the machine.
8169 Valid options for @var{time} are
8171 @table @samp
8172 @item @var{number}
8173 A decimal number representing clock cycles.
8175 @item L1
8176 @itemx L2
8177 @itemx L3
8178 @itemx main
8179 The compiler contains estimates of the number of clock cycles for
8180 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8181 (also called Dcache, Scache, and Bcache), as well as to main memory.
8182 Note that L3 is only valid for EV5.
8184 @end table
8185 @end table
8187 @node DEC Alpha/VMS Options
8188 @subsection DEC Alpha/VMS Options
8190 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8192 @table @gcctabopt
8193 @item -mvms-return-codes
8194 @opindex mvms-return-codes
8195 Return VMS condition codes from main.  The default is to return POSIX
8196 style condition (e.g.@ error) codes.
8197 @end table
8199 @node FRV Options
8200 @subsection FRV Options
8201 @cindex FRV Options
8203 @table @gcctabopt
8204 @item -mgpr-32
8205 @opindex mgpr-32
8207 Only use the first 32 general purpose registers.
8209 @item -mgpr-64
8210 @opindex mgpr-64
8212 Use all 64 general purpose registers.
8214 @item -mfpr-32
8215 @opindex mfpr-32
8217 Use only the first 32 floating point registers.
8219 @item -mfpr-64
8220 @opindex mfpr-64
8222 Use all 64 floating point registers
8224 @item -mhard-float
8225 @opindex mhard-float
8227 Use hardware instructions for floating point operations.
8229 @item -msoft-float
8230 @opindex msoft-float
8232 Use library routines for floating point operations.
8234 @item -malloc-cc
8235 @opindex malloc-cc
8237 Dynamically allocate condition code registers.
8239 @item -mfixed-cc
8240 @opindex mfixed-cc
8242 Do not try to dynamically allocate condition code registers, only
8243 use @code{icc0} and @code{fcc0}.
8245 @item -mdword
8246 @opindex mdword
8248 Change ABI to use double word insns.
8250 @item -mno-dword
8251 @opindex mno-dword
8253 Do not use double word instructions.
8255 @item -mdouble
8256 @opindex mdouble
8258 Use floating point double instructions.
8260 @item -mno-double
8261 @opindex mno-double
8263 Do not use floating point double instructions.
8265 @item -mmedia
8266 @opindex mmedia
8268 Use media instructions.
8270 @item -mno-media
8271 @opindex mno-media
8273 Do not use media instructions.
8275 @item -mmuladd
8276 @opindex mmuladd
8278 Use multiply and add/subtract instructions.
8280 @item -mno-muladd
8281 @opindex mno-muladd
8283 Do not use multiply and add/subtract instructions.
8285 @item -mfdpic
8286 @opindex mfdpic
8288 Select the FDPIC ABI, that uses function descriptors to represent
8289 pointers to functions.  Without any PIC/PIE-related options, it
8290 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8291 assumes GOT entries and small data are within a 12-bit range from the
8292 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8293 are computed with 32 bits.
8295 @item -minline-plt
8296 @opindex minline-plt
8298 Enable inlining of PLT entries in function calls to functions that are
8299 not known to bind locally.  It has no effect without @option{-mfdpic}.
8300 It's enabled by default if optimizing for speed and compiling for
8301 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8302 optimization option such as @option{-O3} or above is present in the
8303 command line.
8305 @item -mTLS
8306 @opindex TLS
8308 Assume a large TLS segment when generating thread-local code.
8310 @item -mtls
8311 @opindex tls
8313 Do not assume a large TLS segment when generating thread-local code.
8315 @item -mgprel-ro
8316 @opindex mgprel-ro
8318 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8319 that is known to be in read-only sections.  It's enabled by default,
8320 except for @option{-fpic} or @option{-fpie}: even though it may help
8321 make the global offset table smaller, it trades 1 instruction for 4.
8322 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8323 one of which may be shared by multiple symbols, and it avoids the need
8324 for a GOT entry for the referenced symbol, so it's more likely to be a
8325 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8327 @item -multilib-library-pic
8328 @opindex multilib-library-pic
8330 Link with the (library, not FD) pic libraries.  It's implied by
8331 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8332 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8333 it explicitly.
8335 @item -mlinked-fp
8336 @opindex mlinked-fp
8338 Follow the EABI requirement of always creating a frame pointer whenever
8339 a stack frame is allocated.  This option is enabled by default and can
8340 be disabled with @option{-mno-linked-fp}.
8342 @item -mlong-calls
8343 @opindex mlong-calls
8345 Use indirect addressing to call functions outside the current
8346 compilation unit.  This allows the functions to be placed anywhere
8347 within the 32-bit address space.
8349 @item -malign-labels
8350 @opindex malign-labels
8352 Try to align labels to an 8-byte boundary by inserting nops into the
8353 previous packet.  This option only has an effect when VLIW packing
8354 is enabled.  It doesn't create new packets; it merely adds nops to
8355 existing ones.
8357 @item -mlibrary-pic
8358 @opindex mlibrary-pic
8360 Generate position-independent EABI code.
8362 @item -macc-4
8363 @opindex macc-4
8365 Use only the first four media accumulator registers.
8367 @item -macc-8
8368 @opindex macc-8
8370 Use all eight media accumulator registers.
8372 @item -mpack
8373 @opindex mpack
8375 Pack VLIW instructions.
8377 @item -mno-pack
8378 @opindex mno-pack
8380 Do not pack VLIW instructions.
8382 @item -mno-eflags
8383 @opindex mno-eflags
8385 Do not mark ABI switches in e_flags.
8387 @item -mcond-move
8388 @opindex mcond-move
8390 Enable the use of conditional-move instructions (default).
8392 This switch is mainly for debugging the compiler and will likely be removed
8393 in a future version.
8395 @item -mno-cond-move
8396 @opindex mno-cond-move
8398 Disable the use of conditional-move instructions.
8400 This switch is mainly for debugging the compiler and will likely be removed
8401 in a future version.
8403 @item -mscc
8404 @opindex mscc
8406 Enable the use of conditional set instructions (default).
8408 This switch is mainly for debugging the compiler and will likely be removed
8409 in a future version.
8411 @item -mno-scc
8412 @opindex mno-scc
8414 Disable the use of conditional set instructions.
8416 This switch is mainly for debugging the compiler and will likely be removed
8417 in a future version.
8419 @item -mcond-exec
8420 @opindex mcond-exec
8422 Enable the use of conditional execution (default).
8424 This switch is mainly for debugging the compiler and will likely be removed
8425 in a future version.
8427 @item -mno-cond-exec
8428 @opindex mno-cond-exec
8430 Disable the use of conditional execution.
8432 This switch is mainly for debugging the compiler and will likely be removed
8433 in a future version.
8435 @item -mvliw-branch
8436 @opindex mvliw-branch
8438 Run a pass to pack branches into VLIW instructions (default).
8440 This switch is mainly for debugging the compiler and will likely be removed
8441 in a future version.
8443 @item -mno-vliw-branch
8444 @opindex mno-vliw-branch
8446 Do not run a pass to pack branches into VLIW instructions.
8448 This switch is mainly for debugging the compiler and will likely be removed
8449 in a future version.
8451 @item -mmulti-cond-exec
8452 @opindex mmulti-cond-exec
8454 Enable optimization of @code{&&} and @code{||} in conditional execution
8455 (default).
8457 This switch is mainly for debugging the compiler and will likely be removed
8458 in a future version.
8460 @item -mno-multi-cond-exec
8461 @opindex mno-multi-cond-exec
8463 Disable optimization of @code{&&} and @code{||} in conditional execution.
8465 This switch is mainly for debugging the compiler and will likely be removed
8466 in a future version.
8468 @item -mnested-cond-exec
8469 @opindex mnested-cond-exec
8471 Enable nested conditional execution optimizations (default).
8473 This switch is mainly for debugging the compiler and will likely be removed
8474 in a future version.
8476 @item -mno-nested-cond-exec
8477 @opindex mno-nested-cond-exec
8479 Disable nested conditional execution optimizations.
8481 This switch is mainly for debugging the compiler and will likely be removed
8482 in a future version.
8484 @item -mtomcat-stats
8485 @opindex mtomcat-stats
8487 Cause gas to print out tomcat statistics.
8489 @item -mcpu=@var{cpu}
8490 @opindex mcpu
8492 Select the processor type for which to generate code.  Possible values are
8493 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8494 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8496 @end table
8498 @node H8/300 Options
8499 @subsection H8/300 Options
8501 These @samp{-m} options are defined for the H8/300 implementations:
8503 @table @gcctabopt
8504 @item -mrelax
8505 @opindex mrelax
8506 Shorten some address references at link time, when possible; uses the
8507 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8508 ld, Using ld}, for a fuller description.
8510 @item -mh
8511 @opindex mh
8512 Generate code for the H8/300H@.
8514 @item -ms
8515 @opindex ms
8516 Generate code for the H8S@.
8518 @item -mn
8519 @opindex mn
8520 Generate code for the H8S and H8/300H in the normal mode.  This switch
8521 must be used either with @option{-mh} or @option{-ms}.
8523 @item -ms2600
8524 @opindex ms2600
8525 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8527 @item -mint32
8528 @opindex mint32
8529 Make @code{int} data 32 bits by default.
8531 @item -malign-300
8532 @opindex malign-300
8533 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8534 The default for the H8/300H and H8S is to align longs and floats on 4
8535 byte boundaries.
8536 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8537 This option has no effect on the H8/300.
8538 @end table
8540 @node HPPA Options
8541 @subsection HPPA Options
8542 @cindex HPPA Options
8544 These @samp{-m} options are defined for the HPPA family of computers:
8546 @table @gcctabopt
8547 @item -march=@var{architecture-type}
8548 @opindex march
8549 Generate code for the specified architecture.  The choices for
8550 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8551 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8552 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8553 architecture option for your machine.  Code compiled for lower numbered
8554 architectures will run on higher numbered architectures, but not the
8555 other way around.
8557 @item -mpa-risc-1-0
8558 @itemx -mpa-risc-1-1
8559 @itemx -mpa-risc-2-0
8560 @opindex mpa-risc-1-0
8561 @opindex mpa-risc-1-1
8562 @opindex mpa-risc-2-0
8563 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8565 @item -mbig-switch
8566 @opindex mbig-switch
8567 Generate code suitable for big switch tables.  Use this option only if
8568 the assembler/linker complain about out of range branches within a switch
8569 table.
8571 @item -mjump-in-delay
8572 @opindex mjump-in-delay
8573 Fill delay slots of function calls with unconditional jump instructions
8574 by modifying the return pointer for the function call to be the target
8575 of the conditional jump.
8577 @item -mdisable-fpregs
8578 @opindex mdisable-fpregs
8579 Prevent floating point registers from being used in any manner.  This is
8580 necessary for compiling kernels which perform lazy context switching of
8581 floating point registers.  If you use this option and attempt to perform
8582 floating point operations, the compiler will abort.
8584 @item -mdisable-indexing
8585 @opindex mdisable-indexing
8586 Prevent the compiler from using indexing address modes.  This avoids some
8587 rather obscure problems when compiling MIG generated code under MACH@.
8589 @item -mno-space-regs
8590 @opindex mno-space-regs
8591 Generate code that assumes the target has no space registers.  This allows
8592 GCC to generate faster indirect calls and use unscaled index address modes.
8594 Such code is suitable for level 0 PA systems and kernels.
8596 @item -mfast-indirect-calls
8597 @opindex mfast-indirect-calls
8598 Generate code that assumes calls never cross space boundaries.  This
8599 allows GCC to emit code which performs faster indirect calls.
8601 This option will not work in the presence of shared libraries or nested
8602 functions.
8604 @item -mfixed-range=@var{register-range}
8605 @opindex mfixed-range
8606 Generate code treating the given register range as fixed registers.
8607 A fixed register is one that the register allocator can not use.  This is
8608 useful when compiling kernel code.  A register range is specified as
8609 two registers separated by a dash.  Multiple register ranges can be
8610 specified separated by a comma.
8612 @item -mlong-load-store
8613 @opindex mlong-load-store
8614 Generate 3-instruction load and store sequences as sometimes required by
8615 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8616 the HP compilers.
8618 @item -mportable-runtime
8619 @opindex mportable-runtime
8620 Use the portable calling conventions proposed by HP for ELF systems.
8622 @item -mgas
8623 @opindex mgas
8624 Enable the use of assembler directives only GAS understands.
8626 @item -mschedule=@var{cpu-type}
8627 @opindex mschedule
8628 Schedule code according to the constraints for the machine type
8629 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8630 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8631 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8632 proper scheduling option for your machine.  The default scheduling is
8633 @samp{8000}.
8635 @item -mlinker-opt
8636 @opindex mlinker-opt
8637 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8638 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8639 linkers in which they give bogus error messages when linking some programs.
8641 @item -msoft-float
8642 @opindex msoft-float
8643 Generate output containing library calls for floating point.
8644 @strong{Warning:} the requisite libraries are not available for all HPPA
8645 targets.  Normally the facilities of the machine's usual C compiler are
8646 used, but this cannot be done directly in cross-compilation.  You must make
8647 your own arrangements to provide suitable library functions for
8648 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8649 does provide software floating point support.
8651 @option{-msoft-float} changes the calling convention in the output file;
8652 therefore, it is only useful if you compile @emph{all} of a program with
8653 this option.  In particular, you need to compile @file{libgcc.a}, the
8654 library that comes with GCC, with @option{-msoft-float} in order for
8655 this to work.
8657 @item -msio
8658 @opindex msio
8659 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8660 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8661 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8662 options are available under HP-UX and HI-UX@.
8664 @item -mgnu-ld
8665 @opindex gnu-ld
8666 Use GNU ld specific options.  This passes @option{-shared} to ld when
8667 building a shared library.  It is the default when GCC is configured,
8668 explicitly or implicitly, with the GNU linker.  This option does not
8669 have any affect on which ld is called, it only changes what parameters
8670 are passed to that ld.  The ld that is called is determined by the
8671 @option{--with-ld} configure option, GCC's program search path, and
8672 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8673 using @samp{which `gcc -print-prog-name=ld`}.
8675 @item -mhp-ld
8676 @opindex hp-ld
8677 Use HP ld specific options.  This passes @option{-b} to ld when building
8678 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8679 links.  It is the default when GCC is configured, explicitly or
8680 implicitly, with the HP linker.  This option does not have any affect on
8681 which ld is called, it only changes what parameters are passed to that
8682 ld.  The ld that is called is determined by the @option{--with-ld}
8683 configure option, GCC's program search path, and finally by the user's
8684 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8685 `gcc -print-prog-name=ld`}.
8687 @item -mlong-calls
8688 @opindex mno-long-calls
8689 Generate code that uses long call sequences.  This ensures that a call
8690 is always able to reach linker generated stubs.  The default is to generate
8691 long calls only when the distance from the call site to the beginning
8692 of the function or translation unit, as the case may be, exceeds a
8693 predefined limit set by the branch type being used.  The limits for
8694 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8695 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8696 240,000 bytes.
8698 Distances are measured from the beginning of functions when using the
8699 @option{-ffunction-sections} option, or when using the @option{-mgas}
8700 and @option{-mno-portable-runtime} options together under HP-UX with
8701 the SOM linker.
8703 It is normally not desirable to use this option as it will degrade
8704 performance.  However, it may be useful in large applications,
8705 particularly when partial linking is used to build the application.
8707 The types of long calls used depends on the capabilities of the
8708 assembler and linker, and the type of code being generated.  The
8709 impact on systems that support long absolute calls, and long pic
8710 symbol-difference or pc-relative calls should be relatively small.
8711 However, an indirect call is used on 32-bit ELF systems in pic code
8712 and it is quite long.
8714 @item -munix=@var{unix-std}
8715 @opindex march
8716 Generate compiler predefines and select a startfile for the specified
8717 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8718 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8719 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8720 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8721 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8722 and later.
8724 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8725 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8726 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8727 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8728 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8729 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8731 It is @emph{important} to note that this option changes the interfaces
8732 for various library routines.  It also affects the operational behavior
8733 of the C library.  Thus, @emph{extreme} care is needed in using this
8734 option.
8736 Library code that is intended to operate with more than one UNIX
8737 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8738 as appropriate.  Most GNU software doesn't provide this capability.
8740 @item -nolibdld
8741 @opindex nolibdld
8742 Suppress the generation of link options to search libdld.sl when the
8743 @option{-static} option is specified on HP-UX 10 and later.
8745 @item -static
8746 @opindex static
8747 The HP-UX implementation of setlocale in libc has a dependency on
8748 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8749 when the @option{-static} option is specified, special link options
8750 are needed to resolve this dependency.
8752 On HP-UX 10 and later, the GCC driver adds the necessary options to
8753 link with libdld.sl when the @option{-static} option is specified.
8754 This causes the resulting binary to be dynamic.  On the 64-bit port,
8755 the linkers generate dynamic binaries by default in any case.  The
8756 @option{-nolibdld} option can be used to prevent the GCC driver from
8757 adding these link options.
8759 @item -threads
8760 @opindex threads
8761 Add support for multithreading with the @dfn{dce thread} library
8762 under HP-UX@.  This option sets flags for both the preprocessor and
8763 linker.
8764 @end table
8766 @node i386 and x86-64 Options
8767 @subsection Intel 386 and AMD x86-64 Options
8768 @cindex i386 Options
8769 @cindex x86-64 Options
8770 @cindex Intel 386 Options
8771 @cindex AMD x86-64 Options
8773 These @samp{-m} options are defined for the i386 and x86-64 family of
8774 computers:
8776 @table @gcctabopt
8777 @item -mtune=@var{cpu-type}
8778 @opindex mtune
8779 Tune to @var{cpu-type} everything applicable about the generated code, except
8780 for the ABI and the set of available instructions.  The choices for
8781 @var{cpu-type} are:
8782 @table @emph
8783 @item i386
8784 Original Intel's i386 CPU@.
8785 @item i486
8786 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8787 @item i586, pentium
8788 Intel Pentium CPU with no MMX support.
8789 @item pentium-mmx
8790 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8791 @item i686, pentiumpro
8792 Intel PentiumPro CPU@.
8793 @item pentium2
8794 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8795 @item pentium3, pentium3m
8796 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8797 support.
8798 @item pentium-m
8799 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8800 support.  Used by Centrino notebooks.
8801 @item pentium4, pentium4m
8802 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8803 @item prescott
8804 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8805 set support.
8806 @item nocona
8807 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8808 SSE2 and SSE3 instruction set support.
8809 @item k6
8810 AMD K6 CPU with MMX instruction set support.
8811 @item k6-2, k6-3
8812 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8813 @item athlon, athlon-tbird
8814 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8815 support.
8816 @item athlon-4, athlon-xp, athlon-mp
8817 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8818 instruction set support.
8819 @item k8, opteron, athlon64, athlon-fx
8820 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8821 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8822 @item winchip-c6
8823 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8824 set support.
8825 @item winchip2
8826 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8827 instruction set support.
8828 @item c3
8829 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8830 implemented for this chip.)
8831 @item c3-2
8832 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8833 implemented for this chip.)
8834 @end table
8836 While picking a specific @var{cpu-type} will schedule things appropriately
8837 for that particular chip, the compiler will not generate any code that
8838 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8839 being used.
8841 @item -march=@var{cpu-type}
8842 @opindex march
8843 Generate instructions for the machine type @var{cpu-type}.  The choices
8844 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8845 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8847 @item -mcpu=@var{cpu-type}
8848 @opindex mcpu
8849 A deprecated synonym for @option{-mtune}.
8851 @item -m386
8852 @itemx -m486
8853 @itemx -mpentium
8854 @itemx -mpentiumpro
8855 @opindex m386
8856 @opindex m486
8857 @opindex mpentium
8858 @opindex mpentiumpro
8859 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8860 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8861 These synonyms are deprecated.
8863 @item -mfpmath=@var{unit}
8864 @opindex march
8865 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8866 for @var{unit} are:
8868 @table @samp
8869 @item 387
8870 Use the standard 387 floating point coprocessor present majority of chips and
8871 emulated otherwise.  Code compiled with this option will run almost everywhere.
8872 The temporary results are computed in 80bit precision instead of precision
8873 specified by the type resulting in slightly different results compared to most
8874 of other chips.  See @option{-ffloat-store} for more detailed description.
8876 This is the default choice for i386 compiler.
8878 @item sse
8879 Use scalar floating point instructions present in the SSE instruction set.
8880 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8881 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8882 instruction set supports only single precision arithmetics, thus the double and
8883 extended precision arithmetics is still done using 387.  Later version, present
8884 only in Pentium4 and the future AMD x86-64 chips supports double precision
8885 arithmetics too.
8887 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8888 or @option{-msse2} switches to enable SSE extensions and make this option
8889 effective.  For the x86-64 compiler, these extensions are enabled by default.
8891 The resulting code should be considerably faster in the majority of cases and avoid
8892 the numerical instability problems of 387 code, but may break some existing
8893 code that expects temporaries to be 80bit.
8895 This is the default choice for the x86-64 compiler.
8897 @item sse,387
8898 Attempt to utilize both instruction sets at once.  This effectively double the
8899 amount of available registers and on chips with separate execution units for
8900 387 and SSE the execution resources too.  Use this option with care, as it is
8901 still experimental, because the GCC register allocator does not model separate
8902 functional units well resulting in instable performance.
8903 @end table
8905 @item -masm=@var{dialect}
8906 @opindex masm=@var{dialect}
8907 Output asm instructions using selected @var{dialect}.  Supported choices are
8908 @samp{intel} or @samp{att} (the default one).
8910 @item -mieee-fp
8911 @itemx -mno-ieee-fp
8912 @opindex mieee-fp
8913 @opindex mno-ieee-fp
8914 Control whether or not the compiler uses IEEE floating point
8915 comparisons.  These handle correctly the case where the result of a
8916 comparison is unordered.
8918 @item -msoft-float
8919 @opindex msoft-float
8920 Generate output containing library calls for floating point.
8921 @strong{Warning:} the requisite libraries are not part of GCC@.
8922 Normally the facilities of the machine's usual C compiler are used, but
8923 this can't be done directly in cross-compilation.  You must make your
8924 own arrangements to provide suitable library functions for
8925 cross-compilation.
8927 On machines where a function returns floating point results in the 80387
8928 register stack, some floating point opcodes may be emitted even if
8929 @option{-msoft-float} is used.
8931 @item -mno-fp-ret-in-387
8932 @opindex mno-fp-ret-in-387
8933 Do not use the FPU registers for return values of functions.
8935 The usual calling convention has functions return values of types
8936 @code{float} and @code{double} in an FPU register, even if there
8937 is no FPU@.  The idea is that the operating system should emulate
8938 an FPU@.
8940 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8941 in ordinary CPU registers instead.
8943 @item -mno-fancy-math-387
8944 @opindex mno-fancy-math-387
8945 Some 387 emulators do not support the @code{sin}, @code{cos} and
8946 @code{sqrt} instructions for the 387.  Specify this option to avoid
8947 generating those instructions.  This option is the default on FreeBSD,
8948 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8949 indicates that the target cpu will always have an FPU and so the
8950 instruction will not need emulation.  As of revision 2.6.1, these
8951 instructions are not generated unless you also use the
8952 @option{-funsafe-math-optimizations} switch.
8954 @item -malign-double
8955 @itemx -mno-align-double
8956 @opindex malign-double
8957 @opindex mno-align-double
8958 Control whether GCC aligns @code{double}, @code{long double}, and
8959 @code{long long} variables on a two word boundary or a one word
8960 boundary.  Aligning @code{double} variables on a two word boundary will
8961 produce code that runs somewhat faster on a @samp{Pentium} at the
8962 expense of more memory.
8964 @strong{Warning:} if you use the @option{-malign-double} switch,
8965 structures containing the above types will be aligned differently than
8966 the published application binary interface specifications for the 386
8967 and will not be binary compatible with structures in code compiled
8968 without that switch.
8970 @item -m96bit-long-double
8971 @itemx -m128bit-long-double
8972 @opindex m96bit-long-double
8973 @opindex m128bit-long-double
8974 These switches control the size of @code{long double} type.  The i386
8975 application binary interface specifies the size to be 96 bits,
8976 so @option{-m96bit-long-double} is the default in 32 bit mode.
8978 Modern architectures (Pentium and newer) would prefer @code{long double}
8979 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8980 conforming to the ABI, this would not be possible.  So specifying a
8981 @option{-m128bit-long-double} will align @code{long double}
8982 to a 16 byte boundary by padding the @code{long double} with an additional
8983 32 bit zero.
8985 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8986 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8988 Notice that neither of these options enable any extra precision over the x87
8989 standard of 80 bits for a @code{long double}.
8991 @strong{Warning:} if you override the default value for your target ABI, the
8992 structures and arrays containing @code{long double} variables will change
8993 their size as well as function calling convention for function taking
8994 @code{long double} will be modified.  Hence they will not be binary
8995 compatible with arrays or structures in code compiled without that switch.
8998 @item -msvr3-shlib
8999 @itemx -mno-svr3-shlib
9000 @opindex msvr3-shlib
9001 @opindex mno-svr3-shlib
9002 Control whether GCC places uninitialized local variables into the
9003 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9004 into @code{bss}.  These options are meaningful only on System V Release 3.
9006 @item -mrtd
9007 @opindex mrtd
9008 Use a different function-calling convention, in which functions that
9009 take a fixed number of arguments return with the @code{ret} @var{num}
9010 instruction, which pops their arguments while returning.  This saves one
9011 instruction in the caller since there is no need to pop the arguments
9012 there.
9014 You can specify that an individual function is called with this calling
9015 sequence with the function attribute @samp{stdcall}.  You can also
9016 override the @option{-mrtd} option by using the function attribute
9017 @samp{cdecl}.  @xref{Function Attributes}.
9019 @strong{Warning:} this calling convention is incompatible with the one
9020 normally used on Unix, so you cannot use it if you need to call
9021 libraries compiled with the Unix compiler.
9023 Also, you must provide function prototypes for all functions that
9024 take variable numbers of arguments (including @code{printf});
9025 otherwise incorrect code will be generated for calls to those
9026 functions.
9028 In addition, seriously incorrect code will result if you call a
9029 function with too many arguments.  (Normally, extra arguments are
9030 harmlessly ignored.)
9032 @item -mregparm=@var{num}
9033 @opindex mregparm
9034 Control how many registers are used to pass integer arguments.  By
9035 default, no registers are used to pass arguments, and at most 3
9036 registers can be used.  You can control this behavior for a specific
9037 function by using the function attribute @samp{regparm}.
9038 @xref{Function Attributes}.
9040 @strong{Warning:} if you use this switch, and
9041 @var{num} is nonzero, then you must build all modules with the same
9042 value, including any libraries.  This includes the system libraries and
9043 startup modules.
9045 @item -msseregparm
9046 @opindex msseregparm
9047 Use SSE register passing conventions for float and double arguments
9048 and return values.  You can control this behavior for a specific
9049 function by using the function attribute @samp{sseregparm}.
9050 @xref{Function Attributes}.
9052 @strong{Warning:} if you use this switch then you must build all
9053 modules with the same value, including any libraries.  This includes
9054 the system libraries and startup modules.
9056 @item -mpreferred-stack-boundary=@var{num}
9057 @opindex mpreferred-stack-boundary
9058 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9059 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9060 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9061 size (@option{-Os}), in which case the default is the minimum correct
9062 alignment (4 bytes for x86, and 8 bytes for x86-64).
9064 On Pentium and PentiumPro, @code{double} and @code{long double} values
9065 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9066 suffer significant run time performance penalties.  On Pentium III, the
9067 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9068 penalties if it is not 16 byte aligned.
9070 To ensure proper alignment of this values on the stack, the stack boundary
9071 must be as aligned as that required by any value stored on the stack.
9072 Further, every function must be generated such that it keeps the stack
9073 aligned.  Thus calling a function compiled with a higher preferred
9074 stack boundary from a function compiled with a lower preferred stack
9075 boundary will most likely misalign the stack.  It is recommended that
9076 libraries that use callbacks always use the default setting.
9078 This extra alignment does consume extra stack space, and generally
9079 increases code size.  Code that is sensitive to stack space usage, such
9080 as embedded systems and operating system kernels, may want to reduce the
9081 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9083 @item -mmmx
9084 @itemx -mno-mmx
9085 @item -msse
9086 @itemx -mno-sse
9087 @item -msse2
9088 @itemx -mno-sse2
9089 @item -msse3
9090 @itemx -mno-sse3
9091 @item -m3dnow
9092 @itemx -mno-3dnow
9093 @opindex mmmx
9094 @opindex mno-mmx
9095 @opindex msse
9096 @opindex mno-sse
9097 @opindex m3dnow
9098 @opindex mno-3dnow
9099 These switches enable or disable the use of built-in functions that allow
9100 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
9101 instruction set.
9103 @xref{X86 Built-in Functions}, for details of the functions enabled
9104 and disabled by these switches.
9106 To have SSE/SSE2 instructions generated automatically from floating-point
9107 code, see @option{-mfpmath=sse}.
9109 @item -mpush-args
9110 @itemx -mno-push-args
9111 @opindex mpush-args
9112 @opindex mno-push-args
9113 Use PUSH operations to store outgoing parameters.  This method is shorter
9114 and usually equally fast as method using SUB/MOV operations and is enabled
9115 by default.  In some cases disabling it may improve performance because of
9116 improved scheduling and reduced dependencies.
9118 @item -maccumulate-outgoing-args
9119 @opindex maccumulate-outgoing-args
9120 If enabled, the maximum amount of space required for outgoing arguments will be
9121 computed in the function prologue.  This is faster on most modern CPUs
9122 because of reduced dependencies, improved scheduling and reduced stack usage
9123 when preferred stack boundary is not equal to 2.  The drawback is a notable
9124 increase in code size.  This switch implies @option{-mno-push-args}.
9126 @item -mthreads
9127 @opindex mthreads
9128 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9129 on thread-safe exception handling must compile and link all code with the
9130 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9131 @option{-D_MT}; when linking, it links in a special thread helper library
9132 @option{-lmingwthrd} which cleans up per thread exception handling data.
9134 @item -mno-align-stringops
9135 @opindex mno-align-stringops
9136 Do not align destination of inlined string operations.  This switch reduces
9137 code size and improves performance in case the destination is already aligned,
9138 but GCC doesn't know about it.
9140 @item -minline-all-stringops
9141 @opindex minline-all-stringops
9142 By default GCC inlines string operations only when destination is known to be
9143 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9144 size, but may improve performance of code that depends on fast memcpy, strlen
9145 and memset for short lengths.
9147 @item -momit-leaf-frame-pointer
9148 @opindex momit-leaf-frame-pointer
9149 Don't keep the frame pointer in a register for leaf functions.  This
9150 avoids the instructions to save, set up and restore frame pointers and
9151 makes an extra register available in leaf functions.  The option
9152 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9153 which might make debugging harder.
9155 @item -mtls-direct-seg-refs
9156 @itemx -mno-tls-direct-seg-refs
9157 @opindex mtls-direct-seg-refs
9158 Controls whether TLS variables may be accessed with offsets from the
9159 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9160 or whether the thread base pointer must be added.  Whether or not this
9161 is legal depends on the operating system, and whether it maps the
9162 segment to cover the entire TLS area.
9164 For systems that use GNU libc, the default is on.
9165 @end table
9167 These @samp{-m} switches are supported in addition to the above
9168 on AMD x86-64 processors in 64-bit environments.
9170 @table @gcctabopt
9171 @item -m32
9172 @itemx -m64
9173 @opindex m32
9174 @opindex m64
9175 Generate code for a 32-bit or 64-bit environment.
9176 The 32-bit environment sets int, long and pointer to 32 bits and
9177 generates code that runs on any i386 system.
9178 The 64-bit environment sets int to 32 bits and long and pointer
9179 to 64 bits and generates code for AMD's x86-64 architecture.
9181 @item -mno-red-zone
9182 @opindex no-red-zone
9183 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9184 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9185 stack pointer that will not be modified by signal or interrupt handlers
9186 and therefore can be used for temporary data without adjusting the stack
9187 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9189 @item -mcmodel=small
9190 @opindex mcmodel=small
9191 Generate code for the small code model: the program and its symbols must
9192 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9193 Programs can be statically or dynamically linked.  This is the default
9194 code model.
9196 @item -mcmodel=kernel
9197 @opindex mcmodel=kernel
9198 Generate code for the kernel code model.  The kernel runs in the
9199 negative 2 GB of the address space.
9200 This model has to be used for Linux kernel code.
9202 @item -mcmodel=medium
9203 @opindex mcmodel=medium
9204 Generate code for the medium model: The program is linked in the lower 2
9205 GB of the address space but symbols can be located anywhere in the
9206 address space.  Programs can be statically or dynamically linked, but
9207 building of shared libraries are not supported with the medium model.
9209 @item -mcmodel=large
9210 @opindex mcmodel=large
9211 Generate code for the large model: This model makes no assumptions
9212 about addresses and sizes of sections.  Currently GCC does not implement
9213 this model.
9214 @end table
9216 @node IA-64 Options
9217 @subsection IA-64 Options
9218 @cindex IA-64 Options
9220 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9222 @table @gcctabopt
9223 @item -mbig-endian
9224 @opindex mbig-endian
9225 Generate code for a big endian target.  This is the default for HP-UX@.
9227 @item -mlittle-endian
9228 @opindex mlittle-endian
9229 Generate code for a little endian target.  This is the default for AIX5
9230 and GNU/Linux.
9232 @item -mgnu-as
9233 @itemx -mno-gnu-as
9234 @opindex mgnu-as
9235 @opindex mno-gnu-as
9236 Generate (or don't) code for the GNU assembler.  This is the default.
9237 @c Also, this is the default if the configure option @option{--with-gnu-as}
9238 @c is used.
9240 @item -mgnu-ld
9241 @itemx -mno-gnu-ld
9242 @opindex mgnu-ld
9243 @opindex mno-gnu-ld
9244 Generate (or don't) code for the GNU linker.  This is the default.
9245 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9246 @c is used.
9248 @item -mno-pic
9249 @opindex mno-pic
9250 Generate code that does not use a global pointer register.  The result
9251 is not position independent code, and violates the IA-64 ABI@.
9253 @item -mvolatile-asm-stop
9254 @itemx -mno-volatile-asm-stop
9255 @opindex mvolatile-asm-stop
9256 @opindex mno-volatile-asm-stop
9257 Generate (or don't) a stop bit immediately before and after volatile asm
9258 statements.
9260 @item -mregister-names
9261 @itemx -mno-register-names
9262 @opindex mregister-names
9263 @opindex mno-register-names
9264 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9265 the stacked registers.  This may make assembler output more readable.
9267 @item -mno-sdata
9268 @itemx -msdata
9269 @opindex mno-sdata
9270 @opindex msdata
9271 Disable (or enable) optimizations that use the small data section.  This may
9272 be useful for working around optimizer bugs.
9274 @item -mconstant-gp
9275 @opindex mconstant-gp
9276 Generate code that uses a single constant global pointer value.  This is
9277 useful when compiling kernel code.
9279 @item -mauto-pic
9280 @opindex mauto-pic
9281 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9282 This is useful when compiling firmware code.
9284 @item -minline-float-divide-min-latency
9285 @opindex minline-float-divide-min-latency
9286 Generate code for inline divides of floating point values
9287 using the minimum latency algorithm.
9289 @item -minline-float-divide-max-throughput
9290 @opindex minline-float-divide-max-throughput
9291 Generate code for inline divides of floating point values
9292 using the maximum throughput algorithm.
9294 @item -minline-int-divide-min-latency
9295 @opindex minline-int-divide-min-latency
9296 Generate code for inline divides of integer values
9297 using the minimum latency algorithm.
9299 @item -minline-int-divide-max-throughput
9300 @opindex minline-int-divide-max-throughput
9301 Generate code for inline divides of integer values
9302 using the maximum throughput algorithm.
9304 @item -minline-sqrt-min-latency
9305 @opindex minline-sqrt-min-latency
9306 Generate code for inline square roots
9307 using the minimum latency algorithm.
9309 @item -minline-sqrt-max-throughput
9310 @opindex minline-sqrt-max-throughput
9311 Generate code for inline square roots
9312 using the maximum throughput algorithm.
9314 @item -mno-dwarf2-asm
9315 @itemx -mdwarf2-asm
9316 @opindex mno-dwarf2-asm
9317 @opindex mdwarf2-asm
9318 Don't (or do) generate assembler code for the DWARF2 line number debugging
9319 info.  This may be useful when not using the GNU assembler.
9321 @item -mearly-stop-bits
9322 @itemx -mno-early-stop-bits
9323 @opindex mearly-stop-bits
9324 @opindex mno-early-stop-bits
9325 Allow stop bits to be placed earlier than immediately preceding the
9326 instruction that triggered the stop bit.  This can improve instruction
9327 scheduling, but does not always do so.
9329 @item -mfixed-range=@var{register-range}
9330 @opindex mfixed-range
9331 Generate code treating the given register range as fixed registers.
9332 A fixed register is one that the register allocator can not use.  This is
9333 useful when compiling kernel code.  A register range is specified as
9334 two registers separated by a dash.  Multiple register ranges can be
9335 specified separated by a comma.
9337 @item -mtls-size=@var{tls-size}
9338 @opindex mtls-size
9339 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9342 @item -mtune-arch=@var{cpu-type}
9343 @opindex mtune-arch
9344 Tune the instruction scheduling for a particular CPU, Valid values are
9345 itanium, itanium1, merced, itanium2, and mckinley.
9347 @item -mt
9348 @itemx -pthread
9349 @opindex mt
9350 @opindex pthread
9351 Add support for multithreading using the POSIX threads library.  This
9352 option sets flags for both the preprocessor and linker.  It does
9353 not affect the thread safety of object code produced by the compiler or
9354 that of libraries supplied with it.  These are HP-UX specific flags.
9356 @item -milp32
9357 @itemx -mlp64
9358 @opindex milp32
9359 @opindex mlp64
9360 Generate code for a 32-bit or 64-bit environment.
9361 The 32-bit environment sets int, long and pointer to 32 bits.
9362 The 64-bit environment sets int to 32 bits and long and pointer
9363 to 64 bits.  These are HP-UX specific flags.
9365 @end table
9367 @node M32R/D Options
9368 @subsection M32R/D Options
9369 @cindex M32R/D options
9371 These @option{-m} options are defined for Renesas M32R/D architectures:
9373 @table @gcctabopt
9374 @item -m32r2
9375 @opindex m32r2
9376 Generate code for the M32R/2@.
9378 @item -m32rx
9379 @opindex m32rx
9380 Generate code for the M32R/X@.
9382 @item -m32r
9383 @opindex m32r
9384 Generate code for the M32R@.  This is the default.
9386 @item -mmodel=small
9387 @opindex mmodel=small
9388 Assume all objects live in the lower 16MB of memory (so that their addresses
9389 can be loaded with the @code{ld24} instruction), and assume all subroutines
9390 are reachable with the @code{bl} instruction.
9391 This is the default.
9393 The addressability of a particular object can be set with the
9394 @code{model} attribute.
9396 @item -mmodel=medium
9397 @opindex mmodel=medium
9398 Assume objects may be anywhere in the 32-bit address space (the compiler
9399 will generate @code{seth/add3} instructions to load their addresses), and
9400 assume all subroutines are reachable with the @code{bl} instruction.
9402 @item -mmodel=large
9403 @opindex mmodel=large
9404 Assume objects may be anywhere in the 32-bit address space (the compiler
9405 will generate @code{seth/add3} instructions to load their addresses), and
9406 assume subroutines may not be reachable with the @code{bl} instruction
9407 (the compiler will generate the much slower @code{seth/add3/jl}
9408 instruction sequence).
9410 @item -msdata=none
9411 @opindex msdata=none
9412 Disable use of the small data area.  Variables will be put into
9413 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9414 @code{section} attribute has been specified).
9415 This is the default.
9417 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9418 Objects may be explicitly put in the small data area with the
9419 @code{section} attribute using one of these sections.
9421 @item -msdata=sdata
9422 @opindex msdata=sdata
9423 Put small global and static data in the small data area, but do not
9424 generate special code to reference them.
9426 @item -msdata=use
9427 @opindex msdata=use
9428 Put small global and static data in the small data area, and generate
9429 special instructions to reference them.
9431 @item -G @var{num}
9432 @opindex G
9433 @cindex smaller data references
9434 Put global and static objects less than or equal to @var{num} bytes
9435 into the small data or bss sections instead of the normal data or bss
9436 sections.  The default value of @var{num} is 8.
9437 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9438 for this option to have any effect.
9440 All modules should be compiled with the same @option{-G @var{num}} value.
9441 Compiling with different values of @var{num} may or may not work; if it
9442 doesn't the linker will give an error message---incorrect code will not be
9443 generated.
9445 @item -mdebug
9446 @opindex mdebug
9447 Makes the M32R specific code in the compiler display some statistics
9448 that might help in debugging programs.
9450 @item -malign-loops
9451 @opindex malign-loops
9452 Align all loops to a 32-byte boundary.
9454 @item -mno-align-loops
9455 @opindex mno-align-loops
9456 Do not enforce a 32-byte alignment for loops.  This is the default.
9458 @item -missue-rate=@var{number}
9459 @opindex missue-rate=@var{number}
9460 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9461 or 2.
9463 @item -mbranch-cost=@var{number}
9464 @opindex mbranch-cost=@var{number}
9465 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9466 preferred over conditional code, if it is 2, then the opposite will
9467 apply.
9469 @item -mflush-trap=@var{number}
9470 @opindex mflush-trap=@var{number}
9471 Specifies the trap number to use to flush the cache.  The default is
9472 12.  Valid numbers are between 0 and 15 inclusive.
9474 @item -mno-flush-trap
9475 @opindex mno-flush-trap
9476 Specifies that the cache cannot be flushed by using a trap.
9478 @item -mflush-func=@var{name}
9479 @opindex mflush-func=@var{name}
9480 Specifies the name of the operating system function to call to flush
9481 the cache.  The default is @emph{_flush_cache}, but a function call
9482 will only be used if a trap is not available.
9484 @item -mno-flush-func
9485 @opindex mno-flush-func
9486 Indicates that there is no OS function for flushing the cache.
9488 @end table
9490 @node M680x0 Options
9491 @subsection M680x0 Options
9492 @cindex M680x0 options
9494 These are the @samp{-m} options defined for the 68000 series.  The default
9495 values for these options depends on which style of 68000 was selected when
9496 the compiler was configured; the defaults for the most common choices are
9497 given below.
9499 @table @gcctabopt
9500 @item -m68000
9501 @itemx -mc68000
9502 @opindex m68000
9503 @opindex mc68000
9504 Generate output for a 68000.  This is the default
9505 when the compiler is configured for 68000-based systems.
9507 Use this option for microcontrollers with a 68000 or EC000 core,
9508 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9510 @item -m68020
9511 @itemx -mc68020
9512 @opindex m68020
9513 @opindex mc68020
9514 Generate output for a 68020.  This is the default
9515 when the compiler is configured for 68020-based systems.
9517 @item -m68881
9518 @opindex m68881
9519 Generate output containing 68881 instructions for floating point.
9520 This is the default for most 68020 systems unless @option{--nfp} was
9521 specified when the compiler was configured.
9523 @item -m68030
9524 @opindex m68030
9525 Generate output for a 68030.  This is the default when the compiler is
9526 configured for 68030-based systems.
9528 @item -m68040
9529 @opindex m68040
9530 Generate output for a 68040.  This is the default when the compiler is
9531 configured for 68040-based systems.
9533 This option inhibits the use of 68881/68882 instructions that have to be
9534 emulated by software on the 68040.  Use this option if your 68040 does not
9535 have code to emulate those instructions.
9537 @item -m68060
9538 @opindex m68060
9539 Generate output for a 68060.  This is the default when the compiler is
9540 configured for 68060-based systems.
9542 This option inhibits the use of 68020 and 68881/68882 instructions that
9543 have to be emulated by software on the 68060.  Use this option if your 68060
9544 does not have code to emulate those instructions.
9546 @item -mcpu32
9547 @opindex mcpu32
9548 Generate output for a CPU32.  This is the default
9549 when the compiler is configured for CPU32-based systems.
9551 Use this option for microcontrollers with a
9552 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9553 68336, 68340, 68341, 68349 and 68360.
9555 @item -m5200
9556 @opindex m5200
9557 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9558 when the compiler is configured for 520X-based systems.
9560 Use this option for microcontroller with a 5200 core, including
9561 the MCF5202, MCF5203, MCF5204 and MCF5202.
9564 @item -m68020-40
9565 @opindex m68020-40
9566 Generate output for a 68040, without using any of the new instructions.
9567 This results in code which can run relatively efficiently on either a
9568 68020/68881 or a 68030 or a 68040.  The generated code does use the
9569 68881 instructions that are emulated on the 68040.
9571 @item -m68020-60
9572 @opindex m68020-60
9573 Generate output for a 68060, without using any of the new instructions.
9574 This results in code which can run relatively efficiently on either a
9575 68020/68881 or a 68030 or a 68040.  The generated code does use the
9576 68881 instructions that are emulated on the 68060.
9578 @item -msoft-float
9579 @opindex msoft-float
9580 Generate output containing library calls for floating point.
9581 @strong{Warning:} the requisite libraries are not available for all m68k
9582 targets.  Normally the facilities of the machine's usual C compiler are
9583 used, but this can't be done directly in cross-compilation.  You must
9584 make your own arrangements to provide suitable library functions for
9585 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9586 @samp{m68k-*-coff} do provide software floating point support.
9588 @item -mshort
9589 @opindex mshort
9590 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9591 Additionally, parameters passed on the stack are also aligned to a
9592 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9594 @item -mnobitfield
9595 @opindex mnobitfield
9596 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9597 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9599 @item -mbitfield
9600 @opindex mbitfield
9601 Do use the bit-field instructions.  The @option{-m68020} option implies
9602 @option{-mbitfield}.  This is the default if you use a configuration
9603 designed for a 68020.
9605 @item -mrtd
9606 @opindex mrtd
9607 Use a different function-calling convention, in which functions
9608 that take a fixed number of arguments return with the @code{rtd}
9609 instruction, which pops their arguments while returning.  This
9610 saves one instruction in the caller since there is no need to pop
9611 the arguments there.
9613 This calling convention is incompatible with the one normally
9614 used on Unix, so you cannot use it if you need to call libraries
9615 compiled with the Unix compiler.
9617 Also, you must provide function prototypes for all functions that
9618 take variable numbers of arguments (including @code{printf});
9619 otherwise incorrect code will be generated for calls to those
9620 functions.
9622 In addition, seriously incorrect code will result if you call a
9623 function with too many arguments.  (Normally, extra arguments are
9624 harmlessly ignored.)
9626 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9627 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9629 @item -malign-int
9630 @itemx -mno-align-int
9631 @opindex malign-int
9632 @opindex mno-align-int
9633 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9634 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9635 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9636 Aligning variables on 32-bit boundaries produces code that runs somewhat
9637 faster on processors with 32-bit busses at the expense of more memory.
9639 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9640 align structures containing the above types  differently than
9641 most published application binary interface specifications for the m68k.
9643 @item -mpcrel
9644 @opindex mpcrel
9645 Use the pc-relative addressing mode of the 68000 directly, instead of
9646 using a global offset table.  At present, this option implies @option{-fpic},
9647 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9648 not presently supported with @option{-mpcrel}, though this could be supported for
9649 68020 and higher processors.
9651 @item -mno-strict-align
9652 @itemx -mstrict-align
9653 @opindex mno-strict-align
9654 @opindex mstrict-align
9655 Do not (do) assume that unaligned memory references will be handled by
9656 the system.
9658 @item -msep-data
9659 Generate code that allows the data segment to be located in a different
9660 area of memory from the text segment.  This allows for execute in place in
9661 an environment without virtual memory management.  This option implies
9662 @option{-fPIC}.
9664 @item -mno-sep-data
9665 Generate code that assumes that the data segment follows the text segment.
9666 This is the default.
9668 @item -mid-shared-library
9669 Generate code that supports shared libraries via the library ID method.
9670 This allows for execute in place and shared libraries in an environment
9671 without virtual memory management.  This option implies @option{-fPIC}.
9673 @item -mno-id-shared-library
9674 Generate code that doesn't assume ID based shared libraries are being used.
9675 This is the default.
9677 @item -mshared-library-id=n
9678 Specified the identification number of the ID based shared library being
9679 compiled.  Specifying a value of 0 will generate more compact code, specifying
9680 other values will force the allocation of that number to the current
9681 library but is no more space or time efficient than omitting this option.
9683 @end table
9685 @node M68hc1x Options
9686 @subsection M68hc1x Options
9687 @cindex M68hc1x options
9689 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9690 microcontrollers.  The default values for these options depends on
9691 which style of microcontroller was selected when the compiler was configured;
9692 the defaults for the most common choices are given below.
9694 @table @gcctabopt
9695 @item -m6811
9696 @itemx -m68hc11
9697 @opindex m6811
9698 @opindex m68hc11
9699 Generate output for a 68HC11.  This is the default
9700 when the compiler is configured for 68HC11-based systems.
9702 @item -m6812
9703 @itemx -m68hc12
9704 @opindex m6812
9705 @opindex m68hc12
9706 Generate output for a 68HC12.  This is the default
9707 when the compiler is configured for 68HC12-based systems.
9709 @item -m68S12
9710 @itemx -m68hcs12
9711 @opindex m68S12
9712 @opindex m68hcs12
9713 Generate output for a 68HCS12.
9715 @item -mauto-incdec
9716 @opindex mauto-incdec
9717 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9718 addressing modes.
9720 @item -minmax
9721 @itemx -nominmax
9722 @opindex minmax
9723 @opindex mnominmax
9724 Enable the use of 68HC12 min and max instructions.
9726 @item -mlong-calls
9727 @itemx -mno-long-calls
9728 @opindex mlong-calls
9729 @opindex mno-long-calls
9730 Treat all calls as being far away (near).  If calls are assumed to be
9731 far away, the compiler will use the @code{call} instruction to
9732 call a function and the @code{rtc} instruction for returning.
9734 @item -mshort
9735 @opindex mshort
9736 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9738 @item -msoft-reg-count=@var{count}
9739 @opindex msoft-reg-count
9740 Specify the number of pseudo-soft registers which are used for the
9741 code generation.  The maximum number is 32.  Using more pseudo-soft
9742 register may or may not result in better code depending on the program.
9743 The default is 4 for 68HC11 and 2 for 68HC12.
9745 @end table
9747 @node MCore Options
9748 @subsection MCore Options
9749 @cindex MCore options
9751 These are the @samp{-m} options defined for the Motorola M*Core
9752 processors.
9754 @table @gcctabopt
9756 @item -mhardlit
9757 @itemx -mno-hardlit
9758 @opindex mhardlit
9759 @opindex mno-hardlit
9760 Inline constants into the code stream if it can be done in two
9761 instructions or less.
9763 @item -mdiv
9764 @itemx -mno-div
9765 @opindex mdiv
9766 @opindex mno-div
9767 Use the divide instruction.  (Enabled by default).
9769 @item -mrelax-immediate
9770 @itemx -mno-relax-immediate
9771 @opindex mrelax-immediate
9772 @opindex mno-relax-immediate
9773 Allow arbitrary sized immediates in bit operations.
9775 @item -mwide-bitfields
9776 @itemx -mno-wide-bitfields
9777 @opindex mwide-bitfields
9778 @opindex mno-wide-bitfields
9779 Always treat bit-fields as int-sized.
9781 @item -m4byte-functions
9782 @itemx -mno-4byte-functions
9783 @opindex m4byte-functions
9784 @opindex mno-4byte-functions
9785 Force all functions to be aligned to a four byte boundary.
9787 @item -mcallgraph-data
9788 @itemx -mno-callgraph-data
9789 @opindex mcallgraph-data
9790 @opindex mno-callgraph-data
9791 Emit callgraph information.
9793 @item -mslow-bytes
9794 @itemx -mno-slow-bytes
9795 @opindex mslow-bytes
9796 @opindex mno-slow-bytes
9797 Prefer word access when reading byte quantities.
9799 @item -mlittle-endian
9800 @itemx -mbig-endian
9801 @opindex mlittle-endian
9802 @opindex mbig-endian
9803 Generate code for a little endian target.
9805 @item -m210
9806 @itemx -m340
9807 @opindex m210
9808 @opindex m340
9809 Generate code for the 210 processor.
9810 @end table
9812 @node MIPS Options
9813 @subsection MIPS Options
9814 @cindex MIPS options
9816 @table @gcctabopt
9818 @item -EB
9819 @opindex EB
9820 Generate big-endian code.
9822 @item -EL
9823 @opindex EL
9824 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9825 configurations.
9827 @item -march=@var{arch}
9828 @opindex march
9829 Generate code that will run on @var{arch}, which can be the name of a
9830 generic MIPS ISA, or the name of a particular processor.
9831 The ISA names are:
9832 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9833 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9834 The processor names are:
9835 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9836 @samp{m4k},
9837 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9838 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9839 @samp{rm9000},
9840 @samp{orion},
9841 @samp{sb1},
9842 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9843 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9844 The special value @samp{from-abi} selects the
9845 most compatible architecture for the selected ABI (that is,
9846 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9848 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9849 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9850 @samp{vr} may be written @samp{r}.
9852 GCC defines two macros based on the value of this option.  The first
9853 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9854 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9855 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9856 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9857 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9859 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9860 above.  In other words, it will have the full prefix and will not
9861 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9862 the macro names the resolved architecture (either @samp{"mips1"} or
9863 @samp{"mips3"}).  It names the default architecture when no
9864 @option{-march} option is given.
9866 @item -mtune=@var{arch}
9867 @opindex mtune
9868 Optimize for @var{arch}.  Among other things, this option controls
9869 the way instructions are scheduled, and the perceived cost of arithmetic
9870 operations.  The list of @var{arch} values is the same as for
9871 @option{-march}.
9873 When this option is not used, GCC will optimize for the processor
9874 specified by @option{-march}.  By using @option{-march} and
9875 @option{-mtune} together, it is possible to generate code that will
9876 run on a family of processors, but optimize the code for one
9877 particular member of that family.
9879 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9880 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9881 @samp{-march} ones described above.
9883 @item -mips1
9884 @opindex mips1
9885 Equivalent to @samp{-march=mips1}.
9887 @item -mips2
9888 @opindex mips2
9889 Equivalent to @samp{-march=mips2}.
9891 @item -mips3
9892 @opindex mips3
9893 Equivalent to @samp{-march=mips3}.
9895 @item -mips4
9896 @opindex mips4
9897 Equivalent to @samp{-march=mips4}.
9899 @item -mips32
9900 @opindex mips32
9901 Equivalent to @samp{-march=mips32}.
9903 @item -mips32r2
9904 @opindex mips32r2
9905 Equivalent to @samp{-march=mips32r2}.
9907 @item -mips64
9908 @opindex mips64
9909 Equivalent to @samp{-march=mips64}.
9911 @item -mips16
9912 @itemx -mno-mips16
9913 @opindex mips16
9914 @opindex mno-mips16
9915 Generate (do not generate) MIPS16 code.  If GCC is targetting a
9916 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
9918 @item -mabi=32
9919 @itemx -mabi=o64
9920 @itemx -mabi=n32
9921 @itemx -mabi=64
9922 @itemx -mabi=eabi
9923 @opindex mabi=32
9924 @opindex mabi=o64
9925 @opindex mabi=n32
9926 @opindex mabi=64
9927 @opindex mabi=eabi
9928 Generate code for the given ABI@.
9930 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9931 generates 64-bit code when you select a 64-bit architecture, but you
9932 can use @option{-mgp32} to get 32-bit code instead.
9934 For information about the O64 ABI, see
9935 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9937 @item -mabicalls
9938 @itemx -mno-abicalls
9939 @opindex mabicalls
9940 @opindex mno-abicalls
9941 Generate (do not generate) SVR4-style position-independent code.
9942 @option{-mabicalls} is the default for SVR4-based systems.
9944 @item -mxgot
9945 @itemx -mno-xgot
9946 @opindex mxgot
9947 @opindex mno-xgot
9948 Lift (do not lift) the usual restrictions on the size of the global
9949 offset table.
9951 GCC normally uses a single instruction to load values from the GOT@.
9952 While this is relatively efficient, it will only work if the GOT
9953 is smaller than about 64k.  Anything larger will cause the linker
9954 to report an error such as:
9956 @cindex relocation truncated to fit (MIPS)
9957 @smallexample
9958 relocation truncated to fit: R_MIPS_GOT16 foobar
9959 @end smallexample
9961 If this happens, you should recompile your code with @option{-mxgot}.
9962 It should then work with very large GOTs, although it will also be
9963 less efficient, since it will take three instructions to fetch the
9964 value of a global symbol.
9966 Note that some linkers can create multiple GOTs.  If you have such a
9967 linker, you should only need to use @option{-mxgot} when a single object
9968 file accesses more than 64k's worth of GOT entries.  Very few do.
9970 These options have no effect unless GCC is generating position
9971 independent code.
9973 @item -mgp32
9974 @opindex mgp32
9975 Assume that general-purpose registers are 32 bits wide.
9977 @item -mgp64
9978 @opindex mgp64
9979 Assume that general-purpose registers are 64 bits wide.
9981 @item -mfp32
9982 @opindex mfp32
9983 Assume that floating-point registers are 32 bits wide.
9985 @item -mfp64
9986 @opindex mfp64
9987 Assume that floating-point registers are 64 bits wide.
9989 @item -mhard-float
9990 @opindex mhard-float
9991 Use floating-point coprocessor instructions.
9993 @item -msoft-float
9994 @opindex msoft-float
9995 Do not use floating-point coprocessor instructions.  Implement
9996 floating-point calculations using library calls instead.
9998 @item -msingle-float
9999 @opindex msingle-float
10000 Assume that the floating-point coprocessor only supports single-precision
10001 operations.
10003 @itemx -mdouble-float
10004 @opindex mdouble-float
10005 Assume that the floating-point coprocessor supports double-precision
10006 operations.  This is the default.
10008 @itemx -mpaired-single
10009 @itemx -mno-paired-single
10010 @opindex mpaired-single
10011 @opindex mno-paired-single
10012 Use (do not use) paired-single floating-point instructions.
10013 @xref{MIPS Paired-Single Support}.  This option can only be used
10014 when generating 64-bit code and requires hardware floating-point
10015 support to be enabled.
10017 @itemx -mips3d
10018 @itemx -mno-mips3d
10019 @opindex mips3d
10020 @opindex mno-mips3d
10021 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10022 The option @option{-mips3d} implies @option{-mpaired-single}.
10024 @item -mlong64
10025 @opindex mlong64
10026 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10027 an explanation of the default and the way that the pointer size is
10028 determined.
10030 @item -mlong32
10031 @opindex mlong32
10032 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10034 The default size of @code{int}s, @code{long}s and pointers depends on
10035 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10036 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10037 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10038 or the same size as integer registers, whichever is smaller.
10040 @item -msym32
10041 @itemx -mno-sym32
10042 @opindex msym32
10043 @opindex mno-sym32
10044 Assume (do not assume) that all symbols have 32-bit values, regardless
10045 of the selected ABI@.  This option is useful in combination with
10046 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10047 to generate shorter and faster references to symbolic addresses.
10049 @item -G @var{num}
10050 @opindex G
10051 @cindex smaller data references (MIPS)
10052 @cindex gp-relative references (MIPS)
10053 Put global and static items less than or equal to @var{num} bytes into
10054 the small data or bss section instead of the normal data or bss section.
10055 This allows the data to be accessed using a single instruction.
10057 All modules should be compiled with the same @option{-G @var{num}}
10058 value.
10060 @item -membedded-data
10061 @itemx -mno-embedded-data
10062 @opindex membedded-data
10063 @opindex mno-embedded-data
10064 Allocate variables to the read-only data section first if possible, then
10065 next in the small data section if possible, otherwise in data.  This gives
10066 slightly slower code than the default, but reduces the amount of RAM required
10067 when executing, and thus may be preferred for some embedded systems.
10069 @item -muninit-const-in-rodata
10070 @itemx -mno-uninit-const-in-rodata
10071 @opindex muninit-const-in-rodata
10072 @opindex mno-uninit-const-in-rodata
10073 Put uninitialized @code{const} variables in the read-only data section.
10074 This option is only meaningful in conjunction with @option{-membedded-data}.
10076 @item -msplit-addresses
10077 @itemx -mno-split-addresses
10078 @opindex msplit-addresses
10079 @opindex mno-split-addresses
10080 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10081 relocation operators.  This option has been superseded by
10082 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10084 @item -mexplicit-relocs
10085 @itemx -mno-explicit-relocs
10086 @opindex mexplicit-relocs
10087 @opindex mno-explicit-relocs
10088 Use (do not use) assembler relocation operators when dealing with symbolic
10089 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10090 is to use assembler macros instead.
10092 @option{-mexplicit-relocs} is the default if GCC was configured
10093 to use an assembler that supports relocation operators.
10095 @item -mcheck-zero-division
10096 @itemx -mno-check-zero-division
10097 @opindex mcheck-zero-division
10098 @opindex mno-check-zero-division
10099 Trap (do not trap) on integer division by zero.  The default is
10100 @option{-mcheck-zero-division}.
10102 @item -mdivide-traps
10103 @itemx -mdivide-breaks
10104 @opindex mdivide-traps
10105 @opindex mdivide-breaks
10106 MIPS systems check for division by zero by generating either a
10107 conditional trap or a break instruction.  Using traps results in
10108 smaller code, but is only supported on MIPS II and later.  Also, some
10109 versions of the Linux kernel have a bug that prevents trap from
10110 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10111 allow conditional traps on architectures that support them and
10112 @option{-mdivide-breaks} to force the use of breaks.
10114 The default is usually @option{-mdivide-traps}, but this can be
10115 overridden at configure time using @option{--with-divide=breaks}.
10116 Divide-by-zero checks can be completely disabled using
10117 @option{-mno-check-zero-division}.
10119 @item -mmemcpy
10120 @itemx -mno-memcpy
10121 @opindex mmemcpy
10122 @opindex mno-memcpy
10123 Force (do not force) the use of @code{memcpy()} for non-trivial block
10124 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10125 most constant-sized copies.
10127 @item -mlong-calls
10128 @itemx -mno-long-calls
10129 @opindex mlong-calls
10130 @opindex mno-long-calls
10131 Disable (do not disable) use of the @code{jal} instruction.  Calling
10132 functions using @code{jal} is more efficient but requires the caller
10133 and callee to be in the same 256 megabyte segment.
10135 This option has no effect on abicalls code.  The default is
10136 @option{-mno-long-calls}.
10138 @item -mmad
10139 @itemx -mno-mad
10140 @opindex mmad
10141 @opindex mno-mad
10142 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10143 instructions, as provided by the R4650 ISA@.
10145 @item -mfused-madd
10146 @itemx -mno-fused-madd
10147 @opindex mfused-madd
10148 @opindex mno-fused-madd
10149 Enable (disable) use of the floating point multiply-accumulate
10150 instructions, when they are available.  The default is
10151 @option{-mfused-madd}.
10153 When multiply-accumulate instructions are used, the intermediate
10154 product is calculated to infinite precision and is not subject to
10155 the FCSR Flush to Zero bit.  This may be undesirable in some
10156 circumstances.
10158 @item -nocpp
10159 @opindex nocpp
10160 Tell the MIPS assembler to not run its preprocessor over user
10161 assembler files (with a @samp{.s} suffix) when assembling them.
10163 @item -mfix-r4000
10164 @itemx -mno-fix-r4000
10165 @opindex mfix-r4000
10166 @opindex mno-fix-r4000
10167 Work around certain R4000 CPU errata:
10168 @itemize @minus
10169 @item
10170 A double-word or a variable shift may give an incorrect result if executed
10171 immediately after starting an integer division.
10172 @item
10173 A double-word or a variable shift may give an incorrect result if executed
10174 while an integer multiplication is in progress.
10175 @item
10176 An integer division may give an incorrect result if started in a delay slot
10177 of a taken branch or a jump.
10178 @end itemize
10180 @item -mfix-r4400
10181 @itemx -mno-fix-r4400
10182 @opindex mfix-r4400
10183 @opindex mno-fix-r4400
10184 Work around certain R4400 CPU errata:
10185 @itemize @minus
10186 @item
10187 A double-word or a variable shift may give an incorrect result if executed
10188 immediately after starting an integer division.
10189 @end itemize
10191 @item -mfix-vr4120
10192 @itemx -mno-fix-vr4120
10193 @opindex mfix-vr4120
10194 Work around certain VR4120 errata:
10195 @itemize @minus
10196 @item
10197 @code{dmultu} does not always produce the correct result.
10198 @item
10199 @code{div} and @code{ddiv} do not always produce the correct result if one
10200 of the operands is negative.
10201 @end itemize
10202 The workarounds for the division errata rely on special functions in
10203 @file{libgcc.a}.  At present, these functions are only provided by
10204 the @code{mips64vr*-elf} configurations.
10206 Other VR4120 errata require a nop to be inserted between certain pairs of
10207 instructions.  These errata are handled by the assembler, not by GCC itself.
10209 @item -mfix-vr4130
10210 @opindex mfix-vr4130
10211 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10212 workarounds are implemented by the assembler rather than by GCC,
10213 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10214 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10215 instructions are available instead.
10217 @item -mfix-sb1
10218 @itemx -mno-fix-sb1
10219 @opindex mfix-sb1
10220 Work around certain SB-1 CPU core errata.
10221 (This flag currently works around the SB-1 revision 2
10222 ``F1'' and ``F2'' floating point errata.)
10224 @item -mflush-func=@var{func}
10225 @itemx -mno-flush-func
10226 @opindex mflush-func
10227 Specifies the function to call to flush the I and D caches, or to not
10228 call any such function.  If called, the function must take the same
10229 arguments as the common @code{_flush_func()}, that is, the address of the
10230 memory range for which the cache is being flushed, the size of the
10231 memory range, and the number 3 (to flush both caches).  The default
10232 depends on the target GCC was configured for, but commonly is either
10233 @samp{_flush_func} or @samp{__cpu_flush}.
10235 @item -mbranch-likely
10236 @itemx -mno-branch-likely
10237 @opindex mbranch-likely
10238 @opindex mno-branch-likely
10239 Enable or disable use of Branch Likely instructions, regardless of the
10240 default for the selected architecture.  By default, Branch Likely
10241 instructions may be generated if they are supported by the selected
10242 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10243 and processors which implement those architectures; for those, Branch
10244 Likely instructions will not be generated by default because the MIPS32
10245 and MIPS64 architectures specifically deprecate their use.
10247 @item -mfp-exceptions
10248 @itemx -mno-fp-exceptions
10249 @opindex mfp-exceptions
10250 Specifies whether FP exceptions are enabled.  This affects how we schedule
10251 FP instructions for some processors.  The default is that FP exceptions are
10252 enabled.
10254 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10255 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10256 FP pipe.
10258 @item -mvr4130-align
10259 @itemx -mno-vr4130-align
10260 @opindex mvr4130-align
10261 The VR4130 pipeline is two-way superscalar, but can only issue two
10262 instructions together if the first one is 8-byte aligned.  When this
10263 option is enabled, GCC will align pairs of instructions that it
10264 thinks should execute in parallel.
10266 This option only has an effect when optimizing for the VR4130.
10267 It normally makes code faster, but at the expense of making it bigger.
10268 It is enabled by default at optimization level @option{-O3}.
10269 @end table
10271 @node MMIX Options
10272 @subsection MMIX Options
10273 @cindex MMIX Options
10275 These options are defined for the MMIX:
10277 @table @gcctabopt
10278 @item -mlibfuncs
10279 @itemx -mno-libfuncs
10280 @opindex mlibfuncs
10281 @opindex mno-libfuncs
10282 Specify that intrinsic library functions are being compiled, passing all
10283 values in registers, no matter the size.
10285 @item -mepsilon
10286 @itemx -mno-epsilon
10287 @opindex mepsilon
10288 @opindex mno-epsilon
10289 Generate floating-point comparison instructions that compare with respect
10290 to the @code{rE} epsilon register.
10292 @item -mabi=mmixware
10293 @itemx -mabi=gnu
10294 @opindex mabi-mmixware
10295 @opindex mabi=gnu
10296 Generate code that passes function parameters and return values that (in
10297 the called function) are seen as registers @code{$0} and up, as opposed to
10298 the GNU ABI which uses global registers @code{$231} and up.
10300 @item -mzero-extend
10301 @itemx -mno-zero-extend
10302 @opindex mzero-extend
10303 @opindex mno-zero-extend
10304 When reading data from memory in sizes shorter than 64 bits, use (do not
10305 use) zero-extending load instructions by default, rather than
10306 sign-extending ones.
10308 @item -mknuthdiv
10309 @itemx -mno-knuthdiv
10310 @opindex mknuthdiv
10311 @opindex mno-knuthdiv
10312 Make the result of a division yielding a remainder have the same sign as
10313 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10314 remainder follows the sign of the dividend.  Both methods are
10315 arithmetically valid, the latter being almost exclusively used.
10317 @item -mtoplevel-symbols
10318 @itemx -mno-toplevel-symbols
10319 @opindex mtoplevel-symbols
10320 @opindex mno-toplevel-symbols
10321 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10322 code can be used with the @code{PREFIX} assembly directive.
10324 @item -melf
10325 @opindex melf
10326 Generate an executable in the ELF format, rather than the default
10327 @samp{mmo} format used by the @command{mmix} simulator.
10329 @item -mbranch-predict
10330 @itemx -mno-branch-predict
10331 @opindex mbranch-predict
10332 @opindex mno-branch-predict
10333 Use (do not use) the probable-branch instructions, when static branch
10334 prediction indicates a probable branch.
10336 @item -mbase-addresses
10337 @itemx -mno-base-addresses
10338 @opindex mbase-addresses
10339 @opindex mno-base-addresses
10340 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10341 base address automatically generates a request (handled by the assembler
10342 and the linker) for a constant to be set up in a global register.  The
10343 register is used for one or more base address requests within the range 0
10344 to 255 from the value held in the register.  The generally leads to short
10345 and fast code, but the number of different data items that can be
10346 addressed is limited.  This means that a program that uses lots of static
10347 data may require @option{-mno-base-addresses}.
10349 @item -msingle-exit
10350 @itemx -mno-single-exit
10351 @opindex msingle-exit
10352 @opindex mno-single-exit
10353 Force (do not force) generated code to have a single exit point in each
10354 function.
10355 @end table
10357 @node MN10300 Options
10358 @subsection MN10300 Options
10359 @cindex MN10300 options
10361 These @option{-m} options are defined for Matsushita MN10300 architectures:
10363 @table @gcctabopt
10364 @item -mmult-bug
10365 @opindex mmult-bug
10366 Generate code to avoid bugs in the multiply instructions for the MN10300
10367 processors.  This is the default.
10369 @item -mno-mult-bug
10370 @opindex mno-mult-bug
10371 Do not generate code to avoid bugs in the multiply instructions for the
10372 MN10300 processors.
10374 @item -mam33
10375 @opindex mam33
10376 Generate code which uses features specific to the AM33 processor.
10378 @item -mno-am33
10379 @opindex mno-am33
10380 Do not generate code which uses features specific to the AM33 processor.  This
10381 is the default.
10383 @item -mno-crt0
10384 @opindex mno-crt0
10385 Do not link in the C run-time initialization object file.
10387 @item -mrelax
10388 @opindex mrelax
10389 Indicate to the linker that it should perform a relaxation optimization pass
10390 to shorten branches, calls and absolute memory addresses.  This option only
10391 has an effect when used on the command line for the final link step.
10393 This option makes symbolic debugging impossible.
10394 @end table
10396 @node NS32K Options
10397 @subsection NS32K Options
10398 @cindex NS32K options
10400 These are the @samp{-m} options defined for the 32000 series.  The default
10401 values for these options depends on which style of 32000 was selected when
10402 the compiler was configured; the defaults for the most common choices are
10403 given below.
10405 @table @gcctabopt
10406 @item -m32032
10407 @itemx -m32032
10408 @opindex m32032
10409 @opindex m32032
10410 Generate output for a 32032.  This is the default
10411 when the compiler is configured for 32032 and 32016 based systems.
10413 @item -m32332
10414 @itemx -m32332
10415 @opindex m32332
10416 @opindex m32332
10417 Generate output for a 32332.  This is the default
10418 when the compiler is configured for 32332-based systems.
10420 @item -m32532
10421 @itemx -m32532
10422 @opindex m32532
10423 @opindex m32532
10424 Generate output for a 32532.  This is the default
10425 when the compiler is configured for 32532-based systems.
10427 @item -m32081
10428 @opindex m32081
10429 Generate output containing 32081 instructions for floating point.
10430 This is the default for all systems.
10432 @item -m32381
10433 @opindex m32381
10434 Generate output containing 32381 instructions for floating point.  This
10435 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
10436 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
10438 @item -mmulti-add
10439 @opindex mmulti-add
10440 Try and generate multiply-add floating point instructions @code{polyF}
10441 and @code{dotF}.  This option is only available if the @option{-m32381}
10442 option is in effect.  Using these instructions requires changes to
10443 register allocation which generally has a negative impact on
10444 performance.  This option should only be enabled when compiling code
10445 particularly likely to make heavy use of multiply-add instructions.
10447 @item -mnomulti-add
10448 @opindex mnomulti-add
10449 Do not try and generate multiply-add floating point instructions
10450 @code{polyF} and @code{dotF}.  This is the default on all platforms.
10452 @item -msoft-float
10453 @opindex msoft-float
10454 Generate output containing library calls for floating point.
10455 @strong{Warning:} the requisite libraries may not be available.
10457 @item -mieee-compare
10458 @itemx -mno-ieee-compare
10459 @opindex mieee-compare
10460 @opindex mno-ieee-compare
10461 Control whether or not the compiler uses IEEE floating point
10462 comparisons.  These handle correctly the case where the result of a
10463 comparison is unordered.
10464 @strong{Warning:} the requisite kernel support may not be available.
10466 @item -mnobitfield
10467 @opindex mnobitfield
10468 Do not use the bit-field instructions.  On some machines it is faster to
10469 use shifting and masking operations.  This is the default for the pc532.
10471 @item -mbitfield
10472 @opindex mbitfield
10473 Do use the bit-field instructions.  This is the default for all platforms
10474 except the pc532.
10476 @item -mrtd
10477 @opindex mrtd
10478 Use a different function-calling convention, in which functions
10479 that take a fixed number of arguments return pop their
10480 arguments on return with the @code{ret} instruction.
10482 This calling convention is incompatible with the one normally
10483 used on Unix, so you cannot use it if you need to call libraries
10484 compiled with the Unix compiler.
10486 Also, you must provide function prototypes for all functions that
10487 take variable numbers of arguments (including @code{printf});
10488 otherwise incorrect code will be generated for calls to those
10489 functions.
10491 In addition, seriously incorrect code will result if you call a
10492 function with too many arguments.  (Normally, extra arguments are
10493 harmlessly ignored.)
10495 This option takes its name from the 680x0 @code{rtd} instruction.
10498 @item -mregparam
10499 @opindex mregparam
10500 Use a different function-calling convention where the first two arguments
10501 are passed in registers.
10503 This calling convention is incompatible with the one normally
10504 used on Unix, so you cannot use it if you need to call libraries
10505 compiled with the Unix compiler.
10507 @item -mnoregparam
10508 @opindex mnoregparam
10509 Do not pass any arguments in registers.  This is the default for all
10510 targets.
10512 @item -msb
10513 @opindex msb
10514 It is OK to use the sb as an index register which is always loaded with
10515 zero.  This is the default for the pc532-netbsd target.
10517 @item -mnosb
10518 @opindex mnosb
10519 The sb register is not available for use or has not been initialized to
10520 zero by the run time system.  This is the default for all targets except
10521 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10522 @option{-fpic} is set.
10524 @item -mhimem
10525 @opindex mhimem
10526 Many ns32000 series addressing modes use displacements of up to 512MB@.
10527 If an address is above 512MB then displacements from zero can not be used.
10528 This option causes code to be generated which can be loaded above 512MB@.
10529 This may be useful for operating systems or ROM code.
10531 @item -mnohimem
10532 @opindex mnohimem
10533 Assume code will be loaded in the first 512MB of virtual address space.
10534 This is the default for all platforms.
10536 @end table
10538 @node PDP-11 Options
10539 @subsection PDP-11 Options
10540 @cindex PDP-11 Options
10542 These options are defined for the PDP-11:
10544 @table @gcctabopt
10545 @item -mfpu
10546 @opindex mfpu
10547 Use hardware FPP floating point.  This is the default.  (FIS floating
10548 point on the PDP-11/40 is not supported.)
10550 @item -msoft-float
10551 @opindex msoft-float
10552 Do not use hardware floating point.
10554 @item -mac0
10555 @opindex mac0
10556 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10558 @item -mno-ac0
10559 @opindex mno-ac0
10560 Return floating-point results in memory.  This is the default.
10562 @item -m40
10563 @opindex m40
10564 Generate code for a PDP-11/40.
10566 @item -m45
10567 @opindex m45
10568 Generate code for a PDP-11/45.  This is the default.
10570 @item -m10
10571 @opindex m10
10572 Generate code for a PDP-11/10.
10574 @item -mbcopy-builtin
10575 @opindex bcopy-builtin
10576 Use inline @code{movmemhi} patterns for copying memory.  This is the
10577 default.
10579 @item -mbcopy
10580 @opindex mbcopy
10581 Do not use inline @code{movmemhi} patterns for copying memory.
10583 @item -mint16
10584 @itemx -mno-int32
10585 @opindex mint16
10586 @opindex mno-int32
10587 Use 16-bit @code{int}.  This is the default.
10589 @item -mint32
10590 @itemx -mno-int16
10591 @opindex mint32
10592 @opindex mno-int16
10593 Use 32-bit @code{int}.
10595 @item -mfloat64
10596 @itemx -mno-float32
10597 @opindex mfloat64
10598 @opindex mno-float32
10599 Use 64-bit @code{float}.  This is the default.
10601 @item -mfloat32
10602 @itemx -mno-float64
10603 @opindex mfloat32
10604 @opindex mno-float64
10605 Use 32-bit @code{float}.
10607 @item -mabshi
10608 @opindex mabshi
10609 Use @code{abshi2} pattern.  This is the default.
10611 @item -mno-abshi
10612 @opindex mno-abshi
10613 Do not use @code{abshi2} pattern.
10615 @item -mbranch-expensive
10616 @opindex mbranch-expensive
10617 Pretend that branches are expensive.  This is for experimenting with
10618 code generation only.
10620 @item -mbranch-cheap
10621 @opindex mbranch-cheap
10622 Do not pretend that branches are expensive.  This is the default.
10624 @item -msplit
10625 @opindex msplit
10626 Generate code for a system with split I&D@.
10628 @item -mno-split
10629 @opindex mno-split
10630 Generate code for a system without split I&D@.  This is the default.
10632 @item -munix-asm
10633 @opindex munix-asm
10634 Use Unix assembler syntax.  This is the default when configured for
10635 @samp{pdp11-*-bsd}.
10637 @item -mdec-asm
10638 @opindex mdec-asm
10639 Use DEC assembler syntax.  This is the default when configured for any
10640 PDP-11 target other than @samp{pdp11-*-bsd}.
10641 @end table
10643 @node PowerPC Options
10644 @subsection PowerPC Options
10645 @cindex PowerPC options
10647 These are listed under @xref{RS/6000 and PowerPC Options}.
10649 @node RS/6000 and PowerPC Options
10650 @subsection IBM RS/6000 and PowerPC Options
10651 @cindex RS/6000 and PowerPC Options
10652 @cindex IBM RS/6000 and PowerPC Options
10654 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10655 @table @gcctabopt
10656 @item -mpower
10657 @itemx -mno-power
10658 @itemx -mpower2
10659 @itemx -mno-power2
10660 @itemx -mpowerpc
10661 @itemx -mno-powerpc
10662 @itemx -mpowerpc-gpopt
10663 @itemx -mno-powerpc-gpopt
10664 @itemx -mpowerpc-gfxopt
10665 @itemx -mno-powerpc-gfxopt
10666 @itemx -mpowerpc64
10667 @itemx -mno-powerpc64
10668 @opindex mpower
10669 @opindex mno-power
10670 @opindex mpower2
10671 @opindex mno-power2
10672 @opindex mpowerpc
10673 @opindex mno-powerpc
10674 @opindex mpowerpc-gpopt
10675 @opindex mno-powerpc-gpopt
10676 @opindex mpowerpc-gfxopt
10677 @opindex mno-powerpc-gfxopt
10678 @opindex mpowerpc64
10679 @opindex mno-powerpc64
10680 GCC supports two related instruction set architectures for the
10681 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10682 instructions supported by the @samp{rios} chip set used in the original
10683 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10684 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10685 the IBM 4xx microprocessors.
10687 Neither architecture is a subset of the other.  However there is a
10688 large common subset of instructions supported by both.  An MQ
10689 register is included in processors supporting the POWER architecture.
10691 You use these options to specify which instructions are available on the
10692 processor you are using.  The default value of these options is
10693 determined when configuring GCC@.  Specifying the
10694 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10695 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10696 rather than the options listed above.
10698 The @option{-mpower} option allows GCC to generate instructions that
10699 are found only in the POWER architecture and to use the MQ register.
10700 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10701 to generate instructions that are present in the POWER2 architecture but
10702 not the original POWER architecture.
10704 The @option{-mpowerpc} option allows GCC to generate instructions that
10705 are found only in the 32-bit subset of the PowerPC architecture.
10706 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10707 GCC to use the optional PowerPC architecture instructions in the
10708 General Purpose group, including floating-point square root.  Specifying
10709 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10710 use the optional PowerPC architecture instructions in the Graphics
10711 group, including floating-point select.
10713 The @option{-mpowerpc64} option allows GCC to generate the additional
10714 64-bit instructions that are found in the full PowerPC64 architecture
10715 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10716 @option{-mno-powerpc64}.
10718 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10719 will use only the instructions in the common subset of both
10720 architectures plus some special AIX common-mode calls, and will not use
10721 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10722 permits GCC to use any instruction from either architecture and to
10723 allow use of the MQ register; specify this for the Motorola MPC601.
10725 @item -mnew-mnemonics
10726 @itemx -mold-mnemonics
10727 @opindex mnew-mnemonics
10728 @opindex mold-mnemonics
10729 Select which mnemonics to use in the generated assembler code.  With
10730 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10731 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10732 assembler mnemonics defined for the POWER architecture.  Instructions
10733 defined in only one architecture have only one mnemonic; GCC uses that
10734 mnemonic irrespective of which of these options is specified.
10736 GCC defaults to the mnemonics appropriate for the architecture in
10737 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10738 value of these option.  Unless you are building a cross-compiler, you
10739 should normally not specify either @option{-mnew-mnemonics} or
10740 @option{-mold-mnemonics}, but should instead accept the default.
10742 @item -mcpu=@var{cpu_type}
10743 @opindex mcpu
10744 Set architecture type, register usage, choice of mnemonics, and
10745 instruction scheduling parameters for machine type @var{cpu_type}.
10746 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10747 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10748 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10749 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10750 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10751 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10752 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10753 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10754 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10756 @option{-mcpu=common} selects a completely generic processor.  Code
10757 generated under this option will run on any POWER or PowerPC processor.
10758 GCC will use only the instructions in the common subset of both
10759 architectures, and will not use the MQ register.  GCC assumes a generic
10760 processor model for scheduling purposes.
10762 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10763 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10764 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10765 types, with an appropriate, generic processor model assumed for
10766 scheduling purposes.
10768 The other options specify a specific processor.  Code generated under
10769 those options will run best on that processor, and may not run at all on
10770 others.
10772 The @option{-mcpu} options automatically enable or disable the
10773 following options: @option{-maltivec}, @option{-mhard-float},
10774 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10775 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10776 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10777 @option{-mstring}.  The particular options set for any particular CPU
10778 will vary between compiler versions, depending on what setting seems
10779 to produce optimal code for that CPU; it doesn't necessarily reflect
10780 the actual hardware's capabilities.  If you wish to set an individual
10781 option to a particular value, you may specify it after the
10782 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10784 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10785 not enabled or disabled by the @option{-mcpu} option at present, since
10786 AIX does not have full support for these options.  You may still
10787 enable or disable them individually if you're sure it'll work in your
10788 environment.
10790 @item -mtune=@var{cpu_type}
10791 @opindex mtune
10792 Set the instruction scheduling parameters for machine type
10793 @var{cpu_type}, but do not set the architecture type, register usage, or
10794 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10795 values for @var{cpu_type} are used for @option{-mtune} as for
10796 @option{-mcpu}.  If both are specified, the code generated will use the
10797 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10798 scheduling parameters set by @option{-mtune}.
10800 @item -mswdiv
10801 @itemx -mno-swdiv
10802 @opindex mswdiv
10803 @opindex mno-swdiv
10804 Generate code to compute division as reciprocal estimate and iterative
10805 refinement, creating opportunities for increased throughput.  This
10806 feature requires: optional PowerPC Graphics instruction set for single
10807 precision and FRE instruction for double precision, assuming divides
10808 cannot generate user-visible traps, and the domain values not include
10809 Infinities, denormals or zero denominator.
10811 @item -maltivec
10812 @itemx -mno-altivec
10813 @opindex maltivec
10814 @opindex mno-altivec
10815 Generate code that uses (does not use) AltiVec instructions, and also
10816 enable the use of built-in functions that allow more direct access to
10817 the AltiVec instruction set.  You may also need to set
10818 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10819 enhancements.
10821 @item -mvrsave
10822 @item -mno-vrsave
10823 @opindex mvrsave
10824 @opindex mno-vrsave
10825 Generate VRSAVE instructions when generating AltiVec code.
10827 @item -mabi=spe
10828 @opindex mabi=spe
10829 Extend the current ABI with SPE ABI extensions.  This does not change
10830 the default ABI, instead it adds the SPE ABI extensions to the current
10831 ABI@.
10833 @item -mabi=no-spe
10834 @opindex mabi=no-spe
10835 Disable Booke SPE ABI extensions for the current ABI@.
10837 @item -msecure-plt
10838 @opindex msecure-plt
10839 Generate code that allows ld and ld.so to build executables and shared
10840 libraries with non-exec .plt and .got sections.  This is a PowerPC
10841 32-bit SYSV ABI option.
10843 @item -mbss-plt
10844 @opindex mbss-plt
10845 Generate code that uses a BSS .plt section that ld.so fills in, and
10846 requires .plt and .got sections that are both writable and executable.
10847 This is a PowerPC 32-bit SYSV ABI option.
10849 @item -misel
10850 @itemx -mno-isel
10851 @opindex misel
10852 @opindex mno-isel
10853 This switch enables or disables the generation of ISEL instructions.
10855 @item -misel=@var{yes/no}
10856 This switch has been deprecated.  Use @option{-misel} and
10857 @option{-mno-isel} instead.
10859 @item -mspe
10860 @itemx -mno-isel
10861 @opindex mspe
10862 @opindex mno-spe
10863 This switch enables or disables the generation of SPE simd
10864 instructions.
10866 @item -mspe=@var{yes/no}
10867 This option has been deprecated.  Use @option{-mspe} and
10868 @option{-mno-spe} instead.
10870 @item -mfloat-gprs=@var{yes/single/double/no}
10871 @itemx -mfloat-gprs
10872 @opindex mfloat-gprs
10873 This switch enables or disables the generation of floating point
10874 operations on the general purpose registers for architectures that
10875 support it.
10877 The argument @var{yes} or @var{single} enables the use of
10878 single-precision floating point operations.
10880 The argument @var{double} enables the use of single and
10881 double-precision floating point operations.
10883 The argument @var{no} disables floating point operations on the
10884 general purpose registers.
10886 This option is currently only available on the MPC854x.
10888 @item -m32
10889 @itemx -m64
10890 @opindex m32
10891 @opindex m64
10892 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10893 targets (including GNU/Linux).  The 32-bit environment sets int, long
10894 and pointer to 32 bits and generates code that runs on any PowerPC
10895 variant.  The 64-bit environment sets int to 32 bits and long and
10896 pointer to 64 bits, and generates code for PowerPC64, as for
10897 @option{-mpowerpc64}.
10899 @item -mfull-toc
10900 @itemx -mno-fp-in-toc
10901 @itemx -mno-sum-in-toc
10902 @itemx -mminimal-toc
10903 @opindex mfull-toc
10904 @opindex mno-fp-in-toc
10905 @opindex mno-sum-in-toc
10906 @opindex mminimal-toc
10907 Modify generation of the TOC (Table Of Contents), which is created for
10908 every executable file.  The @option{-mfull-toc} option is selected by
10909 default.  In that case, GCC will allocate at least one TOC entry for
10910 each unique non-automatic variable reference in your program.  GCC
10911 will also place floating-point constants in the TOC@.  However, only
10912 16,384 entries are available in the TOC@.
10914 If you receive a linker error message that saying you have overflowed
10915 the available TOC space, you can reduce the amount of TOC space used
10916 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10917 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10918 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10919 generate code to calculate the sum of an address and a constant at
10920 run-time instead of putting that sum into the TOC@.  You may specify one
10921 or both of these options.  Each causes GCC to produce very slightly
10922 slower and larger code at the expense of conserving TOC space.
10924 If you still run out of space in the TOC even when you specify both of
10925 these options, specify @option{-mminimal-toc} instead.  This option causes
10926 GCC to make only one TOC entry for every file.  When you specify this
10927 option, GCC will produce code that is slower and larger but which
10928 uses extremely little TOC space.  You may wish to use this option
10929 only on files that contain less frequently executed code.
10931 @item -maix64
10932 @itemx -maix32
10933 @opindex maix64
10934 @opindex maix32
10935 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10936 @code{long} type, and the infrastructure needed to support them.
10937 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10938 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10939 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10941 @item -mxl-compat
10942 @itemx -mno-xl-compat
10943 @opindex mxl-compat
10944 @opindex mno-xl-compat
10945 Produce code that conforms more closely to IBM XLC semantics when using
10946 AIX-compatible ABI.  Pass floating-point arguments to prototyped
10947 functions beyond the register save area (RSA) on the stack in addition
10948 to argument FPRs.  Do not assume that most significant double in 128
10949 bit long double value is properly rounded when comparing values.
10951 The AIX calling convention was extended but not initially documented to
10952 handle an obscure K&R C case of calling a function that takes the
10953 address of its arguments with fewer arguments than declared.  AIX XL
10954 compilers access floating point arguments which do not fit in the
10955 RSA from the stack when a subroutine is compiled without
10956 optimization.  Because always storing floating-point arguments on the
10957 stack is inefficient and rarely needed, this option is not enabled by
10958 default and only is necessary when calling subroutines compiled by AIX
10959 XL compilers without optimization.
10961 @item -mpe
10962 @opindex mpe
10963 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10964 application written to use message passing with special startup code to
10965 enable the application to run.  The system must have PE installed in the
10966 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10967 must be overridden with the @option{-specs=} option to specify the
10968 appropriate directory location.  The Parallel Environment does not
10969 support threads, so the @option{-mpe} option and the @option{-pthread}
10970 option are incompatible.
10972 @item -malign-natural
10973 @itemx -malign-power
10974 @opindex malign-natural
10975 @opindex malign-power
10976 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
10977 @option{-malign-natural} overrides the ABI-defined alignment of larger
10978 types, such as floating-point doubles, on their natural size-based boundary.
10979 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10980 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
10982 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
10983 is not supported.
10985 @item -msoft-float
10986 @itemx -mhard-float
10987 @opindex msoft-float
10988 @opindex mhard-float
10989 Generate code that does not use (uses) the floating-point register set.
10990 Software floating point emulation is provided if you use the
10991 @option{-msoft-float} option, and pass the option to GCC when linking.
10993 @item -mmultiple
10994 @itemx -mno-multiple
10995 @opindex mmultiple
10996 @opindex mno-multiple
10997 Generate code that uses (does not use) the load multiple word
10998 instructions and the store multiple word instructions.  These
10999 instructions are generated by default on POWER systems, and not
11000 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11001 endian PowerPC systems, since those instructions do not work when the
11002 processor is in little endian mode.  The exceptions are PPC740 and
11003 PPC750 which permit the instructions usage in little endian mode.
11005 @item -mstring
11006 @itemx -mno-string
11007 @opindex mstring
11008 @opindex mno-string
11009 Generate code that uses (does not use) the load string instructions
11010 and the store string word instructions to save multiple registers and
11011 do small block moves.  These instructions are generated by default on
11012 POWER systems, and not generated on PowerPC systems.  Do not use
11013 @option{-mstring} on little endian PowerPC systems, since those
11014 instructions do not work when the processor is in little endian mode.
11015 The exceptions are PPC740 and PPC750 which permit the instructions
11016 usage in little endian mode.
11018 @item -mupdate
11019 @itemx -mno-update
11020 @opindex mupdate
11021 @opindex mno-update
11022 Generate code that uses (does not use) the load or store instructions
11023 that update the base register to the address of the calculated memory
11024 location.  These instructions are generated by default.  If you use
11025 @option{-mno-update}, there is a small window between the time that the
11026 stack pointer is updated and the address of the previous frame is
11027 stored, which means code that walks the stack frame across interrupts or
11028 signals may get corrupted data.
11030 @item -mfused-madd
11031 @itemx -mno-fused-madd
11032 @opindex mfused-madd
11033 @opindex mno-fused-madd
11034 Generate code that uses (does not use) the floating point multiply and
11035 accumulate instructions.  These instructions are generated by default if
11036 hardware floating is used.
11038 @item -mno-bit-align
11039 @itemx -mbit-align
11040 @opindex mno-bit-align
11041 @opindex mbit-align
11042 On System V.4 and embedded PowerPC systems do not (do) force structures
11043 and unions that contain bit-fields to be aligned to the base type of the
11044 bit-field.
11046 For example, by default a structure containing nothing but 8
11047 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11048 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11049 the structure would be aligned to a 1 byte boundary and be one byte in
11050 size.
11052 @item -mno-strict-align
11053 @itemx -mstrict-align
11054 @opindex mno-strict-align
11055 @opindex mstrict-align
11056 On System V.4 and embedded PowerPC systems do not (do) assume that
11057 unaligned memory references will be handled by the system.
11059 @item -mrelocatable
11060 @itemx -mno-relocatable
11061 @opindex mrelocatable
11062 @opindex mno-relocatable
11063 On embedded PowerPC systems generate code that allows (does not allow)
11064 the program to be relocated to a different address at runtime.  If you
11065 use @option{-mrelocatable} on any module, all objects linked together must
11066 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11068 @item -mrelocatable-lib
11069 @itemx -mno-relocatable-lib
11070 @opindex mrelocatable-lib
11071 @opindex mno-relocatable-lib
11072 On embedded PowerPC systems generate code that allows (does not allow)
11073 the program to be relocated to a different address at runtime.  Modules
11074 compiled with @option{-mrelocatable-lib} can be linked with either modules
11075 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11076 with modules compiled with the @option{-mrelocatable} options.
11078 @item -mno-toc
11079 @itemx -mtoc
11080 @opindex mno-toc
11081 @opindex mtoc
11082 On System V.4 and embedded PowerPC systems do not (do) assume that
11083 register 2 contains a pointer to a global area pointing to the addresses
11084 used in the program.
11086 @item -mlittle
11087 @itemx -mlittle-endian
11088 @opindex mlittle
11089 @opindex mlittle-endian
11090 On System V.4 and embedded PowerPC systems compile code for the
11091 processor in little endian mode.  The @option{-mlittle-endian} option is
11092 the same as @option{-mlittle}.
11094 @item -mbig
11095 @itemx -mbig-endian
11096 @opindex mbig
11097 @opindex mbig-endian
11098 On System V.4 and embedded PowerPC systems compile code for the
11099 processor in big endian mode.  The @option{-mbig-endian} option is
11100 the same as @option{-mbig}.
11102 @item -mdynamic-no-pic
11103 @opindex mdynamic-no-pic
11104 On Darwin and Mac OS X systems, compile code so that it is not
11105 relocatable, but that its external references are relocatable.  The
11106 resulting code is suitable for applications, but not shared
11107 libraries.
11109 @item -mprioritize-restricted-insns=@var{priority}
11110 @opindex mprioritize-restricted-insns
11111 This option controls the priority that is assigned to
11112 dispatch-slot restricted instructions during the second scheduling
11113 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11114 @var{no/highest/second-highest} priority to dispatch slot restricted
11115 instructions.
11117 @item -msched-costly-dep=@var{dependence_type}
11118 @opindex msched-costly-dep
11119 This option controls which dependences are considered costly
11120 by the target during instruction scheduling.  The argument
11121 @var{dependence_type} takes one of the following values:
11122 @var{no}: no dependence is costly,
11123 @var{all}: all dependences are costly,
11124 @var{true_store_to_load}: a true dependence from store to load is costly,
11125 @var{store_to_load}: any dependence from store to load is costly,
11126 @var{number}: any dependence which latency >= @var{number} is costly.
11128 @item -minsert-sched-nops=@var{scheme}
11129 @opindex minsert-sched-nops
11130 This option controls which nop insertion scheme will be used during
11131 the second scheduling pass.  The argument @var{scheme} takes one of the
11132 following values:
11133 @var{no}: Don't insert nops.
11134 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11135 according to the scheduler's grouping.
11136 @var{regroup_exact}: Insert nops to force costly dependent insns into
11137 separate groups.  Insert exactly as many nops as needed to force an insn
11138 to a new group, according to the estimated processor grouping.
11139 @var{number}: Insert nops to force costly dependent insns into
11140 separate groups.  Insert @var{number} nops to force an insn to a new group.
11142 @item -mcall-sysv
11143 @opindex mcall-sysv
11144 On System V.4 and embedded PowerPC systems compile code using calling
11145 conventions that adheres to the March 1995 draft of the System V
11146 Application Binary Interface, PowerPC processor supplement.  This is the
11147 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11149 @item -mcall-sysv-eabi
11150 @opindex mcall-sysv-eabi
11151 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11153 @item -mcall-sysv-noeabi
11154 @opindex mcall-sysv-noeabi
11155 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11157 @item -mcall-solaris
11158 @opindex mcall-solaris
11159 On System V.4 and embedded PowerPC systems compile code for the Solaris
11160 operating system.
11162 @item -mcall-linux
11163 @opindex mcall-linux
11164 On System V.4 and embedded PowerPC systems compile code for the
11165 Linux-based GNU system.
11167 @item -mcall-gnu
11168 @opindex mcall-gnu
11169 On System V.4 and embedded PowerPC systems compile code for the
11170 Hurd-based GNU system.
11172 @item -mcall-netbsd
11173 @opindex mcall-netbsd
11174 On System V.4 and embedded PowerPC systems compile code for the
11175 NetBSD operating system.
11177 @item -maix-struct-return
11178 @opindex maix-struct-return
11179 Return all structures in memory (as specified by the AIX ABI)@.
11181 @item -msvr4-struct-return
11182 @opindex msvr4-struct-return
11183 Return structures smaller than 8 bytes in registers (as specified by the
11184 SVR4 ABI)@.
11186 @item -mabi=@var{abi-type}
11187 @opindex mabi
11188 Extend the current ABI with a particular extension, or remove such extension.
11189 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11190 @var{no-spe}@.
11192 @item -mprototype
11193 @itemx -mno-prototype
11194 @opindex mprototype
11195 @opindex mno-prototype
11196 On System V.4 and embedded PowerPC systems assume that all calls to
11197 variable argument functions are properly prototyped.  Otherwise, the
11198 compiler must insert an instruction before every non prototyped call to
11199 set or clear bit 6 of the condition code register (@var{CR}) to
11200 indicate whether floating point values were passed in the floating point
11201 registers in case the function takes a variable arguments.  With
11202 @option{-mprototype}, only calls to prototyped variable argument functions
11203 will set or clear the bit.
11205 @item -msim
11206 @opindex msim
11207 On embedded PowerPC systems, assume that the startup module is called
11208 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11209 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11210 configurations.
11212 @item -mmvme
11213 @opindex mmvme
11214 On embedded PowerPC systems, assume that the startup module is called
11215 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11216 @file{libc.a}.
11218 @item -mads
11219 @opindex mads
11220 On embedded PowerPC systems, assume that the startup module is called
11221 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11222 @file{libc.a}.
11224 @item -myellowknife
11225 @opindex myellowknife
11226 On embedded PowerPC systems, assume that the startup module is called
11227 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11228 @file{libc.a}.
11230 @item -mvxworks
11231 @opindex mvxworks
11232 On System V.4 and embedded PowerPC systems, specify that you are
11233 compiling for a VxWorks system.
11235 @item -mwindiss
11236 @opindex mwindiss
11237 Specify that you are compiling for the WindISS simulation environment.
11239 @item -memb
11240 @opindex memb
11241 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11242 header to indicate that @samp{eabi} extended relocations are used.
11244 @item -meabi
11245 @itemx -mno-eabi
11246 @opindex meabi
11247 @opindex mno-eabi
11248 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11249 Embedded Applications Binary Interface (eabi) which is a set of
11250 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11251 means that the stack is aligned to an 8 byte boundary, a function
11252 @code{__eabi} is called to from @code{main} to set up the eabi
11253 environment, and the @option{-msdata} option can use both @code{r2} and
11254 @code{r13} to point to two separate small data areas.  Selecting
11255 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11256 do not call an initialization function from @code{main}, and the
11257 @option{-msdata} option will only use @code{r13} to point to a single
11258 small data area.  The @option{-meabi} option is on by default if you
11259 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11261 @item -msdata=eabi
11262 @opindex msdata=eabi
11263 On System V.4 and embedded PowerPC systems, put small initialized
11264 @code{const} global and static data in the @samp{.sdata2} section, which
11265 is pointed to by register @code{r2}.  Put small initialized
11266 non-@code{const} global and static data in the @samp{.sdata} section,
11267 which is pointed to by register @code{r13}.  Put small uninitialized
11268 global and static data in the @samp{.sbss} section, which is adjacent to
11269 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11270 incompatible with the @option{-mrelocatable} option.  The
11271 @option{-msdata=eabi} option also sets the @option{-memb} option.
11273 @item -msdata=sysv
11274 @opindex msdata=sysv
11275 On System V.4 and embedded PowerPC systems, put small global and static
11276 data in the @samp{.sdata} section, which is pointed to by register
11277 @code{r13}.  Put small uninitialized global and static data in the
11278 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11279 The @option{-msdata=sysv} option is incompatible with the
11280 @option{-mrelocatable} option.
11282 @item -msdata=default
11283 @itemx -msdata
11284 @opindex msdata=default
11285 @opindex msdata
11286 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11287 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11288 same as @option{-msdata=sysv}.
11290 @item -msdata-data
11291 @opindex msdata-data
11292 On System V.4 and embedded PowerPC systems, put small global and static
11293 data in the @samp{.sdata} section.  Put small uninitialized global and
11294 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11295 to address small data however.  This is the default behavior unless
11296 other @option{-msdata} options are used.
11298 @item -msdata=none
11299 @itemx -mno-sdata
11300 @opindex msdata=none
11301 @opindex mno-sdata
11302 On embedded PowerPC systems, put all initialized global and static data
11303 in the @samp{.data} section, and all uninitialized data in the
11304 @samp{.bss} section.
11306 @item -G @var{num}
11307 @opindex G
11308 @cindex smaller data references (PowerPC)
11309 @cindex .sdata/.sdata2 references (PowerPC)
11310 On embedded PowerPC systems, put global and static items less than or
11311 equal to @var{num} bytes into the small data or bss sections instead of
11312 the normal data or bss section.  By default, @var{num} is 8.  The
11313 @option{-G @var{num}} switch is also passed to the linker.
11314 All modules should be compiled with the same @option{-G @var{num}} value.
11316 @item -mregnames
11317 @itemx -mno-regnames
11318 @opindex mregnames
11319 @opindex mno-regnames
11320 On System V.4 and embedded PowerPC systems do (do not) emit register
11321 names in the assembly language output using symbolic forms.
11323 @item -mlongcall
11324 @itemx -mno-longcall
11325 @opindex mlongcall
11326 @opindex mno-longcall
11327 Default to making all function calls indirectly, using a register, so
11328 that functions which reside further than 32 megabytes (33,554,432
11329 bytes) from the current location can be called.  This setting can be
11330 overridden by the @code{shortcall} function attribute, or by
11331 @code{#pragma longcall(0)}.
11333 Some linkers are capable of detecting out-of-range calls and generating
11334 glue code on the fly.  On these systems, long calls are unnecessary and
11335 generate slower code.  As of this writing, the AIX linker can do this,
11336 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11337 to the GNU linker for 32-bit PowerPC systems as well.
11339 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11340 callee, L42'', plus a ``branch island'' (glue code).  The two target
11341 addresses represent the callee and the ``branch island''.  The
11342 Darwin/PPC linker will prefer the first address and generate a ``bl
11343 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11344 otherwise, the linker will generate ``bl L42'' to call the ``branch
11345 island''.  The ``branch island'' is appended to the body of the
11346 calling function; it computes the full 32-bit address of the callee
11347 and jumps to it.
11349 On Mach-O (Darwin) systems, this option directs the compiler emit to
11350 the glue for every direct call, and the Darwin linker decides whether
11351 to use or discard it.
11353 In the future, we may cause GCC to ignore all longcall specifications
11354 when the linker is known to generate glue.
11356 @item -pthread
11357 @opindex pthread
11358 Adds support for multithreading with the @dfn{pthreads} library.
11359 This option sets flags for both the preprocessor and linker.
11361 @end table
11363 @node S/390 and zSeries Options
11364 @subsection S/390 and zSeries Options
11365 @cindex S/390 and zSeries Options
11367 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11369 @table @gcctabopt
11370 @item -mhard-float
11371 @itemx -msoft-float
11372 @opindex mhard-float
11373 @opindex msoft-float
11374 Use (do not use) the hardware floating-point instructions and registers
11375 for floating-point operations.  When @option{-msoft-float} is specified,
11376 functions in @file{libgcc.a} will be used to perform floating-point
11377 operations.  When @option{-mhard-float} is specified, the compiler
11378 generates IEEE floating-point instructions.  This is the default.
11380 @item -mbackchain
11381 @itemx -mno-backchain
11382 @opindex mbackchain
11383 @opindex mno-backchain
11384 Store (do not store) the address of the caller's frame as backchain pointer
11385 into the callee's stack frame.
11386 A backchain may be needed to allow debugging using tools that do not understand
11387 DWARF-2 call frame information.
11388 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11389 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11390 the backchain is placed into the topmost word of the 96/160 byte register
11391 save area.
11393 In general, code compiled with @option{-mbackchain} is call-compatible with
11394 code compiled with @option{-mmo-backchain}; however, use of the backchain
11395 for debugging purposes usually requires that the whole binary is built with
11396 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11397 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11398 to build a linux kernel use @option{-msoft-float}.
11400 The default is to not maintain the backchain.
11402 @item -mpacked-stack
11403 @item -mno-packed-stack
11404 @opindex mpacked-stack
11405 @opindex mno-packed-stack
11406 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11407 specified, the compiler uses the all fields of the 96/160 byte register save
11408 area only for their default purpose; unused fields still take up stack space.
11409 When @option{-mpacked-stack} is specified, register save slots are densely
11410 packed at the top of the register save area; unused space is reused for other
11411 purposes, allowing for more efficient use of the available stack space.
11412 However, when @option{-mbackchain} is also in effect, the topmost word of
11413 the save area is always used to store the backchain, and the return address
11414 register is always saved two words below the backchain.
11416 As long as the stack frame backchain is not used, code generated with
11417 @option{-mpacked-stack} is call-compatible with code generated with
11418 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11419 S/390 or zSeries generated code that uses the stack frame backchain at run
11420 time, not just for debugging purposes.  Such code is not call-compatible
11421 with code compiled with @option{-mpacked-stack}.  Also, note that the
11422 combination of @option{-mbackchain},
11423 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11424 to build a linux kernel use @option{-msoft-float}.
11426 The default is to not use the packed stack layout.
11428 @item -msmall-exec
11429 @itemx -mno-small-exec
11430 @opindex msmall-exec
11431 @opindex mno-small-exec
11432 Generate (or do not generate) code using the @code{bras} instruction
11433 to do subroutine calls.
11434 This only works reliably if the total executable size does not
11435 exceed 64k.  The default is to use the @code{basr} instruction instead,
11436 which does not have this limitation.
11438 @item -m64
11439 @itemx -m31
11440 @opindex m64
11441 @opindex m31
11442 When @option{-m31} is specified, generate code compliant to the
11443 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11444 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11445 particular to generate 64-bit instructions.  For the @samp{s390}
11446 targets, the default is @option{-m31}, while the @samp{s390x}
11447 targets default to @option{-m64}.
11449 @item -mzarch
11450 @itemx -mesa
11451 @opindex mzarch
11452 @opindex mesa
11453 When @option{-mzarch} is specified, generate code using the
11454 instructions available on z/Architecture.
11455 When @option{-mesa} is specified, generate code using the
11456 instructions available on ESA/390.  Note that @option{-mesa} is
11457 not possible with @option{-m64}.
11458 When generating code compliant to the GNU/Linux for S/390 ABI,
11459 the default is @option{-mesa}.  When generating code compliant
11460 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11462 @item -mmvcle
11463 @itemx -mno-mvcle
11464 @opindex mmvcle
11465 @opindex mno-mvcle
11466 Generate (or do not generate) code using the @code{mvcle} instruction
11467 to perform block moves.  When @option{-mno-mvcle} is specified,
11468 use a @code{mvc} loop instead.  This is the default unless optimizing for
11469 size.
11471 @item -mdebug
11472 @itemx -mno-debug
11473 @opindex mdebug
11474 @opindex mno-debug
11475 Print (or do not print) additional debug information when compiling.
11476 The default is to not print debug information.
11478 @item -march=@var{cpu-type}
11479 @opindex march
11480 Generate code that will run on @var{cpu-type}, which is the name of a system
11481 representing a certain processor type.  Possible values for
11482 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11483 When generating code using the instructions available on z/Architecture,
11484 the default is @option{-march=z900}.  Otherwise, the default is
11485 @option{-march=g5}.
11487 @item -mtune=@var{cpu-type}
11488 @opindex mtune
11489 Tune to @var{cpu-type} everything applicable about the generated code,
11490 except for the ABI and the set of available instructions.
11491 The list of @var{cpu-type} values is the same as for @option{-march}.
11492 The default is the value used for @option{-march}.
11494 @item -mtpf-trace
11495 @itemx -mno-tpf-trace
11496 @opindex mtpf-trace
11497 @opindex mno-tpf-trace
11498 Generate code that adds (does not add) in TPF OS specific branches to trace
11499 routines in the operating system.  This option is off by default, even
11500 when compiling for the TPF OS@.
11502 @item -mfused-madd
11503 @itemx -mno-fused-madd
11504 @opindex mfused-madd
11505 @opindex mno-fused-madd
11506 Generate code that uses (does not use) the floating point multiply and
11507 accumulate instructions.  These instructions are generated by default if
11508 hardware floating point is used.
11510 @item -mwarn-framesize=@var{framesize}
11511 @opindex mwarn-framesize
11512 Emit a warning if the current function exceeds the given frame size.  Because
11513 this is a compile time check it doesn't need to be a real problem when the program
11514 runs.  It is intended to identify functions which most probably cause
11515 a stack overflow.  It is useful to be used in an environment with limited stack
11516 size e.g.@: the linux kernel.
11518 @item -mwarn-dynamicstack
11519 @opindex mwarn-dynamicstack
11520 Emit a warning if the function calls alloca or uses dynamically
11521 sized arrays.  This is generally a bad idea with a limited stack size.
11523 @item -mstack-guard=@var{stack-guard}
11524 @item -mstack-size=@var{stack-size}
11525 @opindex mstack-guard
11526 @opindex mstack-size
11527 These arguments always have to be used in conjunction.  If they are present the s390
11528 back end emits additional instructions in the function prologue which trigger a trap
11529 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11530 (remember that the stack on s390 grows downward).  These options are intended to
11531 be used to help debugging stack overflow problems.  The additionally emitted code
11532 cause only little overhead and hence can also be used in production like systems
11533 without greater performance degradation.  The given values have to be exact
11534 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11535 In order to be efficient the extra code makes the assumption that the stack starts
11536 at an address aligned to the value given by @var{stack-size}.
11537 @end table
11539 @node SH Options
11540 @subsection SH Options
11542 These @samp{-m} options are defined for the SH implementations:
11544 @table @gcctabopt
11545 @item -m1
11546 @opindex m1
11547 Generate code for the SH1.
11549 @item -m2
11550 @opindex m2
11551 Generate code for the SH2.
11553 @item -m2e
11554 Generate code for the SH2e.
11556 @item -m3
11557 @opindex m3
11558 Generate code for the SH3.
11560 @item -m3e
11561 @opindex m3e
11562 Generate code for the SH3e.
11564 @item -m4-nofpu
11565 @opindex m4-nofpu
11566 Generate code for the SH4 without a floating-point unit.
11568 @item -m4-single-only
11569 @opindex m4-single-only
11570 Generate code for the SH4 with a floating-point unit that only
11571 supports single-precision arithmetic.
11573 @item -m4-single
11574 @opindex m4-single
11575 Generate code for the SH4 assuming the floating-point unit is in
11576 single-precision mode by default.
11578 @item -m4
11579 @opindex m4
11580 Generate code for the SH4.
11582 @item -m4a-nofpu
11583 @opindex m4a-nofpu
11584 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11585 floating-point unit is not used.
11587 @item -m4a-single-only
11588 @opindex m4a-single-only
11589 Generate code for the SH4a, in such a way that no double-precision
11590 floating point operations are used.
11592 @item -m4a-single
11593 @opindex m4a-single
11594 Generate code for the SH4a assuming the floating-point unit is in
11595 single-precision mode by default.
11597 @item -m4a
11598 @opindex m4a
11599 Generate code for the SH4a.
11601 @item -m4al
11602 @opindex m4al
11603 Same as @option{-m4a-nofpu}, except that it implicitly passes
11604 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11605 instructions at the moment.
11607 @item -mb
11608 @opindex mb
11609 Compile code for the processor in big endian mode.
11611 @item -ml
11612 @opindex ml
11613 Compile code for the processor in little endian mode.
11615 @item -mdalign
11616 @opindex mdalign
11617 Align doubles at 64-bit boundaries.  Note that this changes the calling
11618 conventions, and thus some functions from the standard C library will
11619 not work unless you recompile it first with @option{-mdalign}.
11621 @item -mrelax
11622 @opindex mrelax
11623 Shorten some address references at link time, when possible; uses the
11624 linker option @option{-relax}.
11626 @item -mbigtable
11627 @opindex mbigtable
11628 Use 32-bit offsets in @code{switch} tables.  The default is to use
11629 16-bit offsets.
11631 @item -mfmovd
11632 @opindex mfmovd
11633 Enable the use of the instruction @code{fmovd}.
11635 @item -mhitachi
11636 @opindex mhitachi
11637 Comply with the calling conventions defined by Renesas.
11639 @item -mrenesas
11640 @opindex mhitachi
11641 Comply with the calling conventions defined by Renesas.
11643 @item -mno-renesas
11644 @opindex mhitachi
11645 Comply with the calling conventions defined for GCC before the Renesas
11646 conventions were available.  This option is the default for all
11647 targets of the SH toolchain except for @samp{sh-symbianelf}.
11649 @item -mnomacsave
11650 @opindex mnomacsave
11651 Mark the @code{MAC} register as call-clobbered, even if
11652 @option{-mhitachi} is given.
11654 @item -mieee
11655 @opindex mieee
11656 Increase IEEE-compliance of floating-point code.
11657 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11658 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11659 comparisons of NANs / infinities incurs extra overhead in every
11660 floating point comparison, therefore the default is set to
11661 @option{-ffinite-math-only}.
11663 @item -misize
11664 @opindex misize
11665 Dump instruction size and location in the assembly code.
11667 @item -mpadstruct
11668 @opindex mpadstruct
11669 This option is deprecated.  It pads structures to multiple of 4 bytes,
11670 which is incompatible with the SH ABI@.
11672 @item -mspace
11673 @opindex mspace
11674 Optimize for space instead of speed.  Implied by @option{-Os}.
11676 @item -mprefergot
11677 @opindex mprefergot
11678 When generating position-independent code, emit function calls using
11679 the Global Offset Table instead of the Procedure Linkage Table.
11681 @item -musermode
11682 @opindex musermode
11683 Generate a library function call to invalidate instruction cache
11684 entries, after fixing up a trampoline.  This library function call
11685 doesn't assume it can write to the whole memory address space.  This
11686 is the default when the target is @code{sh-*-linux*}.
11688 @item -multcost=@var{number}
11689 @opindex multcost=@var{number}
11690 Set the cost to assume for a multiply insn.
11692 @item -mdiv=@var{strategy}
11693 @opindex mdiv=@var{strategy}
11694 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11695 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11696 inv:call2, inv:fp .
11697 "fp" performs the operation in floating point.  This has a very high latency,
11698 but needs only a few instructions, so it might be a good choice if
11699 your code has enough easily exploitable ILP to allow the compiler to
11700 schedule the floating point instructions together with other instructions.
11701 Division by zero causes a floating point exception.
11702 "inv" uses integer operations to calculate the inverse of the divisor,
11703 and then multiplies the dividend with the inverse.  This strategy allows
11704 cse and hoisting of the inverse calculation.  Division by zero calculates
11705 an unspecified result, but does not trap.
11706 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11707 have been found, or if the entire operation has been hoisted to the same
11708 place, the last stages of the inverse calculation are intertwined with the
11709 final multiply to reduce the overall latency, at the expense of using a few
11710 more instructions, and thus offering fewer scheduling opportunities with
11711 other code.
11712 "call" calls a library function that usually implements the inv:minlat
11713 strategy.
11714 This gives high code density for m5-*media-nofpu compilations.
11715 "call2" uses a different entry point of the same library function, where it
11716 assumes that a pointer to a lookup table has already been set up, which
11717 exposes the pointer load to cse / code hoisting optimizations.
11718 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11719 code generation, but if the code stays unoptimized, revert to the "call",
11720 "call2", or "fp" strategies, respectively.  Note that the
11721 potentially-trapping side effect of division by zero is carried by a
11722 separate instruction, so it is possible that all the integer instructions
11723 are hoisted out, but the marker for the side effect stays where it is.
11724 A recombination to fp operations or a call is not possible in that case.
11725 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
11726 that the inverse calculation was nor separated from the multiply, they speed
11727 up division where the dividend fits into 20 bits (plus sign where applicable),
11728 by inserting a test to skip a number of operations in this case; this test
11729 slows down the case of larger dividends.  inv20u assumes the case of a such
11730 a small dividend to be unlikely, and inv20l assumes it to be likely.
11732 @item -mdivsi3_libfunc=@var{name}
11733 @opindex mdivsi3_libfunc=@var{name}
11734 Set the name of the library function used for 32 bit signed division to
11735 @var{name}.  This only affect the name used in the call and inv:call
11736 division strategies, and the compiler will still expect the same
11737 sets of input/output/clobbered registers as if this option was not present.
11739 @item -madjust-unroll
11740 @opindex madjust-unroll
11741 Throttle unrolling to avoid thrashing target registers.
11742 This option only has an effect if the gcc code base supports the
11743 TARGET_ADJUST_UNROLL_MAX target hook.
11745 @item -mindexed-addressing
11746 @opindex mindexed-addressing
11747 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11748 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11749 semantics for the indexed addressing mode.  The architecture allows the
11750 implementation of processors with 64 bit MMU, which the OS could use to
11751 get 32 bit addressing, but since no current hardware implementation supports
11752 this or any other way to make the indexed addressing mode safe to use in
11753 the 32 bit ABI, the default is -mno-indexed-addressing.
11755 @item -mgettrcost=@var{number}
11756 @opindex mgettrcost=@var{number}
11757 Set the cost assumed for the gettr instruction to @var{number}.
11758 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11760 @item -mpt-fixed
11761 @opindex mpt-fixed
11762 Assume pt* instructions won't trap.  This will generally generate better
11763 scheduled code, but is unsafe on current hardware.  The current architecture
11764 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11765 This has the unintentional effect of making it unsafe to schedule ptabs /
11766 ptrel before a branch, or hoist it out of a loop.  For example,
11767 __do_global_ctors, a part of libgcc that runs constructors at program
11768 startup, calls functions in a list which is delimited by -1.  With the
11769 -mpt-fixed option, the ptabs will be done before testing against -1.
11770 That means that all the constructors will be run a bit quicker, but when
11771 the loop comes to the end of the list, the program crashes because ptabs
11772 loads -1 into a target register.  Since this option is unsafe for any
11773 hardware implementing the current architecture specification, the default
11774 is -mno-pt-fixed.  Unless the user specifies a specific cost with
11775 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
11776 this deters register allocation using target registers for storing
11777 ordinary integers.
11779 @item -minvalid-symbols
11780 @opindex minvalid-symbols
11781 Assume symbols might be invalid.  Ordinary function symbols generated by
11782 the compiler will always be valid to load with movi/shori/ptabs or
11783 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
11784 to generate symbols that will cause ptabs / ptrel to trap.
11785 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
11786 It will then prevent cross-basic-block cse, hoisting and most scheduling
11787 of symbol loads.  The default is @option{-mno-invalid-symbols}.
11788 @end table
11790 @node SPARC Options
11791 @subsection SPARC Options
11792 @cindex SPARC options
11794 These @samp{-m} options are supported on the SPARC:
11796 @table @gcctabopt
11797 @item -mno-app-regs
11798 @itemx -mapp-regs
11799 @opindex mno-app-regs
11800 @opindex mapp-regs
11801 Specify @option{-mapp-regs} to generate output using the global registers
11802 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11803 is the default.
11805 To be fully SVR4 ABI compliant at the cost of some performance loss,
11806 specify @option{-mno-app-regs}.  You should compile libraries and system
11807 software with this option.
11809 @item -mfpu
11810 @itemx -mhard-float
11811 @opindex mfpu
11812 @opindex mhard-float
11813 Generate output containing floating point instructions.  This is the
11814 default.
11816 @item -mno-fpu
11817 @itemx -msoft-float
11818 @opindex mno-fpu
11819 @opindex msoft-float
11820 Generate output containing library calls for floating point.
11821 @strong{Warning:} the requisite libraries are not available for all SPARC
11822 targets.  Normally the facilities of the machine's usual C compiler are
11823 used, but this cannot be done directly in cross-compilation.  You must make
11824 your own arrangements to provide suitable library functions for
11825 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11826 @samp{sparclite-*-*} do provide software floating point support.
11828 @option{-msoft-float} changes the calling convention in the output file;
11829 therefore, it is only useful if you compile @emph{all} of a program with
11830 this option.  In particular, you need to compile @file{libgcc.a}, the
11831 library that comes with GCC, with @option{-msoft-float} in order for
11832 this to work.
11834 @item -mhard-quad-float
11835 @opindex mhard-quad-float
11836 Generate output containing quad-word (long double) floating point
11837 instructions.
11839 @item -msoft-quad-float
11840 @opindex msoft-quad-float
11841 Generate output containing library calls for quad-word (long double)
11842 floating point instructions.  The functions called are those specified
11843 in the SPARC ABI@.  This is the default.
11845 As of this writing, there are no SPARC implementations that have hardware
11846 support for the quad-word floating point instructions.  They all invoke
11847 a trap handler for one of these instructions, and then the trap handler
11848 emulates the effect of the instruction.  Because of the trap handler overhead,
11849 this is much slower than calling the ABI library routines.  Thus the
11850 @option{-msoft-quad-float} option is the default.
11852 @item -mno-unaligned-doubles
11853 @itemx -munaligned-doubles
11854 @opindex mno-unaligned-doubles
11855 @opindex munaligned-doubles
11856 Assume that doubles have 8 byte alignment.  This is the default.
11858 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11859 alignment only if they are contained in another type, or if they have an
11860 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11861 Specifying this option avoids some rare compatibility problems with code
11862 generated by other compilers.  It is not the default because it results
11863 in a performance loss, especially for floating point code.
11865 @item -mno-faster-structs
11866 @itemx -mfaster-structs
11867 @opindex mno-faster-structs
11868 @opindex mfaster-structs
11869 With @option{-mfaster-structs}, the compiler assumes that structures
11870 should have 8 byte alignment.  This enables the use of pairs of
11871 @code{ldd} and @code{std} instructions for copies in structure
11872 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11873 However, the use of this changed alignment directly violates the SPARC
11874 ABI@.  Thus, it's intended only for use on targets where the developer
11875 acknowledges that their resulting code will not be directly in line with
11876 the rules of the ABI@.
11878 @item -mimpure-text
11879 @opindex mimpure-text
11880 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11881 the compiler to not pass @option{-z text} to the linker when linking a
11882 shared object.  Using this option, you can link position-dependent
11883 code into a shared object.
11885 @option{-mimpure-text} suppresses the ``relocations remain against
11886 allocatable but non-writable sections'' linker error message.
11887 However, the necessary relocations will trigger copy-on-write, and the
11888 shared object is not actually shared across processes.  Instead of
11889 using @option{-mimpure-text}, you should compile all source code with
11890 @option{-fpic} or @option{-fPIC}.
11892 This option is only available on SunOS and Solaris.
11894 @item -mcpu=@var{cpu_type}
11895 @opindex mcpu
11896 Set the instruction set, register set, and instruction scheduling parameters
11897 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11898 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11899 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11900 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11901 @samp{ultrasparc3}.
11903 Default instruction scheduling parameters are used for values that select
11904 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11905 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11907 Here is a list of each supported architecture and their supported
11908 implementations.
11910 @smallexample
11911     v7:             cypress
11912     v8:             supersparc, hypersparc
11913     sparclite:      f930, f934, sparclite86x
11914     sparclet:       tsc701
11915     v9:             ultrasparc, ultrasparc3
11916 @end smallexample
11918 By default (unless configured otherwise), GCC generates code for the V7
11919 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11920 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11921 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11922 SPARCStation 1, 2, IPX etc.
11924 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11925 architecture.  The only difference from V7 code is that the compiler emits
11926 the integer multiply and integer divide instructions which exist in SPARC-V8
11927 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11928 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11929 2000 series.
11931 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11932 the SPARC architecture.  This adds the integer multiply, integer divide step
11933 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11934 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11935 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
11936 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11937 MB86934 chip, which is the more recent SPARClite with FPU@.
11939 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11940 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11941 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11942 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11943 optimizes it for the TEMIC SPARClet chip.
11945 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11946 architecture.  This adds 64-bit integer and floating-point move instructions,
11947 3 additional floating-point condition code registers and conditional move
11948 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11949 optimizes it for the Sun UltraSPARC I/II chips.  With
11950 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11951 Sun UltraSPARC III chip.
11953 @item -mtune=@var{cpu_type}
11954 @opindex mtune
11955 Set the instruction scheduling parameters for machine type
11956 @var{cpu_type}, but do not set the instruction set or register set that the
11957 option @option{-mcpu=@var{cpu_type}} would.
11959 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11960 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11961 that select a particular cpu implementation.  Those are @samp{cypress},
11962 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11963 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11964 @samp{ultrasparc3}.
11966 @item -mv8plus
11967 @itemx -mno-v8plus
11968 @opindex mv8plus
11969 @opindex mno-v8plus
11970 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
11971 difference from the V8 ABI is that the global and out registers are
11972 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11973 mode for all SPARC-V9 processors.
11975 @item -mvis
11976 @itemx -mno-vis
11977 @opindex mvis
11978 @opindex mno-vis
11979 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11980 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11981 @end table
11983 These @samp{-m} options are supported in addition to the above
11984 on SPARC-V9 processors in 64-bit environments:
11986 @table @gcctabopt
11987 @item -mlittle-endian
11988 @opindex mlittle-endian
11989 Generate code for a processor running in little-endian mode.  It is only
11990 available for a few configurations and most notably not on Solaris and Linux.
11992 @item -m32
11993 @itemx -m64
11994 @opindex m32
11995 @opindex m64
11996 Generate code for a 32-bit or 64-bit environment.
11997 The 32-bit environment sets int, long and pointer to 32 bits.
11998 The 64-bit environment sets int to 32 bits and long and pointer
11999 to 64 bits.
12001 @item -mcmodel=medlow
12002 @opindex mcmodel=medlow
12003 Generate code for the Medium/Low code model: 64-bit addresses, programs
12004 must be linked in the low 32 bits of memory.  Programs can be statically
12005 or dynamically linked.
12007 @item -mcmodel=medmid
12008 @opindex mcmodel=medmid
12009 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12010 must be linked in the low 44 bits of memory, the text and data segments must
12011 be less than 2GB in size and the data segment must be located within 2GB of
12012 the text segment.
12014 @item -mcmodel=medany
12015 @opindex mcmodel=medany
12016 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12017 may be linked anywhere in memory, the text and data segments must be less
12018 than 2GB in size and the data segment must be located within 2GB of the
12019 text segment.
12021 @item -mcmodel=embmedany
12022 @opindex mcmodel=embmedany
12023 Generate code for the Medium/Anywhere code model for embedded systems:
12024 64-bit addresses, the text and data segments must be less than 2GB in
12025 size, both starting anywhere in memory (determined at link time).  The
12026 global register %g4 points to the base of the data segment.  Programs
12027 are statically linked and PIC is not supported.
12029 @item -mstack-bias
12030 @itemx -mno-stack-bias
12031 @opindex mstack-bias
12032 @opindex mno-stack-bias
12033 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12034 frame pointer if present, are offset by @minus{}2047 which must be added back
12035 when making stack frame references.  This is the default in 64-bit mode.
12036 Otherwise, assume no such offset is present.
12037 @end table
12039 These switches are supported in addition to the above on Solaris:
12041 @table @gcctabopt
12042 @item -threads
12043 @opindex threads
12044 Add support for multithreading using the Solaris threads library.  This
12045 option sets flags for both the preprocessor and linker.  This option does
12046 not affect the thread safety of object code produced by the compiler or
12047 that of libraries supplied with it.
12049 @item -pthreads
12050 @opindex pthreads
12051 Add support for multithreading using the POSIX threads library.  This
12052 option sets flags for both the preprocessor and linker.  This option does
12053 not affect the thread safety of object code produced  by the compiler or
12054 that of libraries supplied with it.
12055 @end table
12057 @node System V Options
12058 @subsection Options for System V
12060 These additional options are available on System V Release 4 for
12061 compatibility with other compilers on those systems:
12063 @table @gcctabopt
12064 @item -G
12065 @opindex G
12066 Create a shared object.
12067 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12069 @item -Qy
12070 @opindex Qy
12071 Identify the versions of each tool used by the compiler, in a
12072 @code{.ident} assembler directive in the output.
12074 @item -Qn
12075 @opindex Qn
12076 Refrain from adding @code{.ident} directives to the output file (this is
12077 the default).
12079 @item -YP,@var{dirs}
12080 @opindex YP
12081 Search the directories @var{dirs}, and no others, for libraries
12082 specified with @option{-l}.
12084 @item -Ym,@var{dir}
12085 @opindex Ym
12086 Look in the directory @var{dir} to find the M4 preprocessor.
12087 The assembler uses this option.
12088 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12089 @c the generic assembler that comes with Solaris takes just -Ym.
12090 @end table
12092 @node TMS320C3x/C4x Options
12093 @subsection TMS320C3x/C4x Options
12094 @cindex TMS320C3x/C4x Options
12096 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12098 @table @gcctabopt
12100 @item -mcpu=@var{cpu_type}
12101 @opindex mcpu
12102 Set the instruction set, register set, and instruction scheduling
12103 parameters for machine type @var{cpu_type}.  Supported values for
12104 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12105 @samp{c44}.  The default is @samp{c40} to generate code for the
12106 TMS320C40.
12108 @item -mbig-memory
12109 @itemx -mbig
12110 @itemx -msmall-memory
12111 @itemx -msmall
12112 @opindex mbig-memory
12113 @opindex mbig
12114 @opindex msmall-memory
12115 @opindex msmall
12116 Generates code for the big or small memory model.  The small memory
12117 model assumed that all data fits into one 64K word page.  At run-time
12118 the data page (DP) register must be set to point to the 64K page
12119 containing the .bss and .data program sections.  The big memory model is
12120 the default and requires reloading of the DP register for every direct
12121 memory access.
12123 @item -mbk
12124 @itemx -mno-bk
12125 @opindex mbk
12126 @opindex mno-bk
12127 Allow (disallow) allocation of general integer operands into the block
12128 count register BK@.
12130 @item -mdb
12131 @itemx -mno-db
12132 @opindex mdb
12133 @opindex mno-db
12134 Enable (disable) generation of code using decrement and branch,
12135 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12136 on the safe side, this is disabled for the C3x, since the maximum
12137 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12138 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12139 that it can utilize the decrement and branch instruction, but will give
12140 up if there is more than one memory reference in the loop.  Thus a loop
12141 where the loop counter is decremented can generate slightly more
12142 efficient code, in cases where the RPTB instruction cannot be utilized.
12144 @item -mdp-isr-reload
12145 @itemx -mparanoid
12146 @opindex mdp-isr-reload
12147 @opindex mparanoid
12148 Force the DP register to be saved on entry to an interrupt service
12149 routine (ISR), reloaded to point to the data section, and restored on
12150 exit from the ISR@.  This should not be required unless someone has
12151 violated the small memory model by modifying the DP register, say within
12152 an object library.
12154 @item -mmpyi
12155 @itemx -mno-mpyi
12156 @opindex mmpyi
12157 @opindex mno-mpyi
12158 For the C3x use the 24-bit MPYI instruction for integer multiplies
12159 instead of a library call to guarantee 32-bit results.  Note that if one
12160 of the operands is a constant, then the multiplication will be performed
12161 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12162 then squaring operations are performed inline instead of a library call.
12164 @item -mfast-fix
12165 @itemx -mno-fast-fix
12166 @opindex mfast-fix
12167 @opindex mno-fast-fix
12168 The C3x/C4x FIX instruction to convert a floating point value to an
12169 integer value chooses the nearest integer less than or equal to the
12170 floating point value rather than to the nearest integer.  Thus if the
12171 floating point number is negative, the result will be incorrectly
12172 truncated an additional code is necessary to detect and correct this
12173 case.  This option can be used to disable generation of the additional
12174 code required to correct the result.
12176 @item -mrptb
12177 @itemx -mno-rptb
12178 @opindex mrptb
12179 @opindex mno-rptb
12180 Enable (disable) generation of repeat block sequences using the RPTB
12181 instruction for zero overhead looping.  The RPTB construct is only used
12182 for innermost loops that do not call functions or jump across the loop
12183 boundaries.  There is no advantage having nested RPTB loops due to the
12184 overhead required to save and restore the RC, RS, and RE registers.
12185 This is enabled by default with @option{-O2}.
12187 @item -mrpts=@var{count}
12188 @itemx -mno-rpts
12189 @opindex mrpts
12190 @opindex mno-rpts
12191 Enable (disable) the use of the single instruction repeat instruction
12192 RPTS@.  If a repeat block contains a single instruction, and the loop
12193 count can be guaranteed to be less than the value @var{count}, GCC will
12194 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12195 then a RPTS will be emitted even if the loop count cannot be determined
12196 at compile time.  Note that the repeated instruction following RPTS does
12197 not have to be reloaded from memory each iteration, thus freeing up the
12198 CPU buses for operands.  However, since interrupts are blocked by this
12199 instruction, it is disabled by default.
12201 @item -mloop-unsigned
12202 @itemx -mno-loop-unsigned
12203 @opindex mloop-unsigned
12204 @opindex mno-loop-unsigned
12205 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12206 is @math{2^{31} + 1} since these instructions test if the iteration count is
12207 negative to terminate the loop.  If the iteration count is unsigned
12208 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12209 exceeded.  This switch allows an unsigned iteration count.
12211 @item -mti
12212 @opindex mti
12213 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12214 with.  This also enforces compatibility with the API employed by the TI
12215 C3x C compiler.  For example, long doubles are passed as structures
12216 rather than in floating point registers.
12218 @item -mregparm
12219 @itemx -mmemparm
12220 @opindex mregparm
12221 @opindex mmemparm
12222 Generate code that uses registers (stack) for passing arguments to functions.
12223 By default, arguments are passed in registers where possible rather
12224 than by pushing arguments on to the stack.
12226 @item -mparallel-insns
12227 @itemx -mno-parallel-insns
12228 @opindex mparallel-insns
12229 @opindex mno-parallel-insns
12230 Allow the generation of parallel instructions.  This is enabled by
12231 default with @option{-O2}.
12233 @item -mparallel-mpy
12234 @itemx -mno-parallel-mpy
12235 @opindex mparallel-mpy
12236 @opindex mno-parallel-mpy
12237 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12238 provided @option{-mparallel-insns} is also specified.  These instructions have
12239 tight register constraints which can pessimize the code generation
12240 of large functions.
12242 @end table
12244 @node V850 Options
12245 @subsection V850 Options
12246 @cindex V850 Options
12248 These @samp{-m} options are defined for V850 implementations:
12250 @table @gcctabopt
12251 @item -mlong-calls
12252 @itemx -mno-long-calls
12253 @opindex mlong-calls
12254 @opindex mno-long-calls
12255 Treat all calls as being far away (near).  If calls are assumed to be
12256 far away, the compiler will always load the functions address up into a
12257 register, and call indirect through the pointer.
12259 @item -mno-ep
12260 @itemx -mep
12261 @opindex mno-ep
12262 @opindex mep
12263 Do not optimize (do optimize) basic blocks that use the same index
12264 pointer 4 or more times to copy pointer into the @code{ep} register, and
12265 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12266 option is on by default if you optimize.
12268 @item -mno-prolog-function
12269 @itemx -mprolog-function
12270 @opindex mno-prolog-function
12271 @opindex mprolog-function
12272 Do not use (do use) external functions to save and restore registers
12273 at the prologue and epilogue of a function.  The external functions
12274 are slower, but use less code space if more than one function saves
12275 the same number of registers.  The @option{-mprolog-function} option
12276 is on by default if you optimize.
12278 @item -mspace
12279 @opindex mspace
12280 Try to make the code as small as possible.  At present, this just turns
12281 on the @option{-mep} and @option{-mprolog-function} options.
12283 @item -mtda=@var{n}
12284 @opindex mtda
12285 Put static or global variables whose size is @var{n} bytes or less into
12286 the tiny data area that register @code{ep} points to.  The tiny data
12287 area can hold up to 256 bytes in total (128 bytes for byte references).
12289 @item -msda=@var{n}
12290 @opindex msda
12291 Put static or global variables whose size is @var{n} bytes or less into
12292 the small data area that register @code{gp} points to.  The small data
12293 area can hold up to 64 kilobytes.
12295 @item -mzda=@var{n}
12296 @opindex mzda
12297 Put static or global variables whose size is @var{n} bytes or less into
12298 the first 32 kilobytes of memory.
12300 @item -mv850
12301 @opindex mv850
12302 Specify that the target processor is the V850.
12304 @item -mbig-switch
12305 @opindex mbig-switch
12306 Generate code suitable for big switch tables.  Use this option only if
12307 the assembler/linker complain about out of range branches within a switch
12308 table.
12310 @item -mapp-regs
12311 @opindex mapp-regs
12312 This option will cause r2 and r5 to be used in the code generated by
12313 the compiler.  This setting is the default.
12315 @item -mno-app-regs
12316 @opindex mno-app-regs
12317 This option will cause r2 and r5 to be treated as fixed registers.
12319 @item -mv850e1
12320 @opindex mv850e1
12321 Specify that the target processor is the V850E1.  The preprocessor
12322 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12323 this option is used.
12325 @item -mv850e
12326 @opindex mv850e
12327 Specify that the target processor is the V850E@.  The preprocessor
12328 constant @samp{__v850e__} will be defined if this option is used.
12330 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12331 are defined then a default target processor will be chosen and the
12332 relevant @samp{__v850*__} preprocessor constant will be defined.
12334 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12335 defined, regardless of which processor variant is the target.
12337 @item -mdisable-callt
12338 @opindex mdisable-callt
12339 This option will suppress generation of the CALLT instruction for the
12340 v850e and v850e1 flavors of the v850 architecture.  The default is
12341 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12343 @end table
12345 @node VAX Options
12346 @subsection VAX Options
12347 @cindex VAX options
12349 These @samp{-m} options are defined for the VAX:
12351 @table @gcctabopt
12352 @item -munix
12353 @opindex munix
12354 Do not output certain jump instructions (@code{aobleq} and so on)
12355 that the Unix assembler for the VAX cannot handle across long
12356 ranges.
12358 @item -mgnu
12359 @opindex mgnu
12360 Do output those jump instructions, on the assumption that you
12361 will assemble with the GNU assembler.
12363 @item -mg
12364 @opindex mg
12365 Output code for g-format floating point numbers instead of d-format.
12366 @end table
12368 @node x86-64 Options
12369 @subsection x86-64 Options
12370 @cindex x86-64 options
12372 These are listed under @xref{i386 and x86-64 Options}.
12374 @node Xstormy16 Options
12375 @subsection Xstormy16 Options
12376 @cindex Xstormy16 Options
12378 These options are defined for Xstormy16:
12380 @table @gcctabopt
12381 @item -msim
12382 @opindex msim
12383 Choose startup files and linker script suitable for the simulator.
12384 @end table
12386 @node Xtensa Options
12387 @subsection Xtensa Options
12388 @cindex Xtensa Options
12390 These options are supported for Xtensa targets:
12392 @table @gcctabopt
12393 @item -mconst16
12394 @itemx -mno-const16
12395 @opindex mconst16
12396 @opindex mno-const16
12397 Enable or disable use of @code{CONST16} instructions for loading
12398 constant values.  The @code{CONST16} instruction is currently not a
12399 standard option from Tensilica.  When enabled, @code{CONST16}
12400 instructions are always used in place of the standard @code{L32R}
12401 instructions.  The use of @code{CONST16} is enabled by default only if
12402 the @code{L32R} instruction is not available.
12404 @item -mfused-madd
12405 @itemx -mno-fused-madd
12406 @opindex mfused-madd
12407 @opindex mno-fused-madd
12408 Enable or disable use of fused multiply/add and multiply/subtract
12409 instructions in the floating-point option.  This has no effect if the
12410 floating-point option is not also enabled.  Disabling fused multiply/add
12411 and multiply/subtract instructions forces the compiler to use separate
12412 instructions for the multiply and add/subtract operations.  This may be
12413 desirable in some cases where strict IEEE 754-compliant results are
12414 required: the fused multiply add/subtract instructions do not round the
12415 intermediate result, thereby producing results with @emph{more} bits of
12416 precision than specified by the IEEE standard.  Disabling fused multiply
12417 add/subtract instructions also ensures that the program output is not
12418 sensitive to the compiler's ability to combine multiply and add/subtract
12419 operations.
12421 @item -mtext-section-literals
12422 @itemx -mno-text-section-literals
12423 @opindex mtext-section-literals
12424 @opindex mno-text-section-literals
12425 Control the treatment of literal pools.  The default is
12426 @option{-mno-text-section-literals}, which places literals in a separate
12427 section in the output file.  This allows the literal pool to be placed
12428 in a data RAM/ROM, and it also allows the linker to combine literal
12429 pools from separate object files to remove redundant literals and
12430 improve code size.  With @option{-mtext-section-literals}, the literals
12431 are interspersed in the text section in order to keep them as close as
12432 possible to their references.  This may be necessary for large assembly
12433 files.
12435 @item -mtarget-align
12436 @itemx -mno-target-align
12437 @opindex mtarget-align
12438 @opindex mno-target-align
12439 When this option is enabled, GCC instructs the assembler to
12440 automatically align instructions to reduce branch penalties at the
12441 expense of some code density.  The assembler attempts to widen density
12442 instructions to align branch targets and the instructions following call
12443 instructions.  If there are not enough preceding safe density
12444 instructions to align a target, no widening will be performed.  The
12445 default is @option{-mtarget-align}.  These options do not affect the
12446 treatment of auto-aligned instructions like @code{LOOP}, which the
12447 assembler will always align, either by widening density instructions or
12448 by inserting no-op instructions.
12450 @item -mlongcalls
12451 @itemx -mno-longcalls
12452 @opindex mlongcalls
12453 @opindex mno-longcalls
12454 When this option is enabled, GCC instructs the assembler to translate
12455 direct calls to indirect calls unless it can determine that the target
12456 of a direct call is in the range allowed by the call instruction.  This
12457 translation typically occurs for calls to functions in other source
12458 files.  Specifically, the assembler translates a direct @code{CALL}
12459 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12460 The default is @option{-mno-longcalls}.  This option should be used in
12461 programs where the call target can potentially be out of range.  This
12462 option is implemented in the assembler, not the compiler, so the
12463 assembly code generated by GCC will still show direct call
12464 instructions---look at the disassembled object code to see the actual
12465 instructions.  Note that the assembler will use an indirect call for
12466 every cross-file call, not just those that really will be out of range.
12467 @end table
12469 @node zSeries Options
12470 @subsection zSeries Options
12471 @cindex zSeries options
12473 These are listed under @xref{S/390 and zSeries Options}.
12475 @node Code Gen Options
12476 @section Options for Code Generation Conventions
12477 @cindex code generation conventions
12478 @cindex options, code generation
12479 @cindex run-time options
12481 These machine-independent options control the interface conventions
12482 used in code generation.
12484 Most of them have both positive and negative forms; the negative form
12485 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12486 one of the forms is listed---the one which is not the default.  You
12487 can figure out the other form by either removing @samp{no-} or adding
12490 @table @gcctabopt
12491 @item -fbounds-check
12492 @opindex fbounds-check
12493 For front-ends that support it, generate additional code to check that
12494 indices used to access arrays are within the declared range.  This is
12495 currently only supported by the Java and Fortran 77 front-ends, where
12496 this option defaults to true and false respectively.
12498 @item -ftrapv
12499 @opindex ftrapv
12500 This option generates traps for signed overflow on addition, subtraction,
12501 multiplication operations.
12503 @item -fwrapv
12504 @opindex fwrapv
12505 This option instructs the compiler to assume that signed arithmetic
12506 overflow of addition, subtraction and multiplication wraps around
12507 using twos-complement representation.  This flag enables some optimizations
12508 and disables other.  This option is enabled by default for the Java
12509 front-end, as required by the Java language specification.
12511 @item -fexceptions
12512 @opindex fexceptions
12513 Enable exception handling.  Generates extra code needed to propagate
12514 exceptions.  For some targets, this implies GCC will generate frame
12515 unwind information for all functions, which can produce significant data
12516 size overhead, although it does not affect execution.  If you do not
12517 specify this option, GCC will enable it by default for languages like
12518 C++ which normally require exception handling, and disable it for
12519 languages like C that do not normally require it.  However, you may need
12520 to enable this option when compiling C code that needs to interoperate
12521 properly with exception handlers written in C++.  You may also wish to
12522 disable this option if you are compiling older C++ programs that don't
12523 use exception handling.
12525 @item -fnon-call-exceptions
12526 @opindex fnon-call-exceptions
12527 Generate code that allows trapping instructions to throw exceptions.
12528 Note that this requires platform-specific runtime support that does
12529 not exist everywhere.  Moreover, it only allows @emph{trapping}
12530 instructions to throw exceptions, i.e.@: memory references or floating
12531 point instructions.  It does not allow exceptions to be thrown from
12532 arbitrary signal handlers such as @code{SIGALRM}.
12534 @item -funwind-tables
12535 @opindex funwind-tables
12536 Similar to @option{-fexceptions}, except that it will just generate any needed
12537 static data, but will not affect the generated code in any other way.
12538 You will normally not enable this option; instead, a language processor
12539 that needs this handling would enable it on your behalf.
12541 @item -fasynchronous-unwind-tables
12542 @opindex fasynchronous-unwind-tables
12543 Generate unwind table in dwarf2 format, if supported by target machine.  The
12544 table is exact at each instruction boundary, so it can be used for stack
12545 unwinding from asynchronous events (such as debugger or garbage collector).
12547 @item -fpcc-struct-return
12548 @opindex fpcc-struct-return
12549 Return ``short'' @code{struct} and @code{union} values in memory like
12550 longer ones, rather than in registers.  This convention is less
12551 efficient, but it has the advantage of allowing intercallability between
12552 GCC-compiled files and files compiled with other compilers, particularly
12553 the Portable C Compiler (pcc).
12555 The precise convention for returning structures in memory depends
12556 on the target configuration macros.
12558 Short structures and unions are those whose size and alignment match
12559 that of some integer type.
12561 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12562 switch is not binary compatible with code compiled with the
12563 @option{-freg-struct-return} switch.
12564 Use it to conform to a non-default application binary interface.
12566 @item -freg-struct-return
12567 @opindex freg-struct-return
12568 Return @code{struct} and @code{union} values in registers when possible.
12569 This is more efficient for small structures than
12570 @option{-fpcc-struct-return}.
12572 If you specify neither @option{-fpcc-struct-return} nor
12573 @option{-freg-struct-return}, GCC defaults to whichever convention is
12574 standard for the target.  If there is no standard convention, GCC
12575 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12576 the principal compiler.  In those cases, we can choose the standard, and
12577 we chose the more efficient register return alternative.
12579 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12580 switch is not binary compatible with code compiled with the
12581 @option{-fpcc-struct-return} switch.
12582 Use it to conform to a non-default application binary interface.
12584 @item -fshort-enums
12585 @opindex fshort-enums
12586 Allocate to an @code{enum} type only as many bytes as it needs for the
12587 declared range of possible values.  Specifically, the @code{enum} type
12588 will be equivalent to the smallest integer type which has enough room.
12590 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12591 code that is not binary compatible with code generated without that switch.
12592 Use it to conform to a non-default application binary interface.
12594 @item -fshort-double
12595 @opindex fshort-double
12596 Use the same size for @code{double} as for @code{float}.
12598 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12599 code that is not binary compatible with code generated without that switch.
12600 Use it to conform to a non-default application binary interface.
12602 @item -fshort-wchar
12603 @opindex fshort-wchar
12604 Override the underlying type for @samp{wchar_t} to be @samp{short
12605 unsigned int} instead of the default for the target.  This option is
12606 useful for building programs to run under WINE@.
12608 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12609 code that is not binary compatible with code generated without that switch.
12610 Use it to conform to a non-default application binary interface.
12612 @item -fshared-data
12613 @opindex fshared-data
12614 Requests that the data and non-@code{const} variables of this
12615 compilation be shared data rather than private data.  The distinction
12616 makes sense only on certain operating systems, where shared data is
12617 shared between processes running the same program, while private data
12618 exists in one copy per process.
12620 @item -fno-common
12621 @opindex fno-common
12622 In C, allocate even uninitialized global variables in the data section of the
12623 object file, rather than generating them as common blocks.  This has the
12624 effect that if the same variable is declared (without @code{extern}) in
12625 two different compilations, you will get an error when you link them.
12626 The only reason this might be useful is if you wish to verify that the
12627 program will work on other systems which always work this way.
12629 @item -fno-ident
12630 @opindex fno-ident
12631 Ignore the @samp{#ident} directive.
12633 @item -finhibit-size-directive
12634 @opindex finhibit-size-directive
12635 Don't output a @code{.size} assembler directive, or anything else that
12636 would cause trouble if the function is split in the middle, and the
12637 two halves are placed at locations far apart in memory.  This option is
12638 used when compiling @file{crtstuff.c}; you should not need to use it
12639 for anything else.
12641 @item -fverbose-asm
12642 @opindex fverbose-asm
12643 Put extra commentary information in the generated assembly code to
12644 make it more readable.  This option is generally only of use to those
12645 who actually need to read the generated assembly code (perhaps while
12646 debugging the compiler itself).
12648 @option{-fno-verbose-asm}, the default, causes the
12649 extra information to be omitted and is useful when comparing two assembler
12650 files.
12652 @item -fpic
12653 @opindex fpic
12654 @cindex global offset table
12655 @cindex PIC
12656 Generate position-independent code (PIC) suitable for use in a shared
12657 library, if supported for the target machine.  Such code accesses all
12658 constant addresses through a global offset table (GOT)@.  The dynamic
12659 loader resolves the GOT entries when the program starts (the dynamic
12660 loader is not part of GCC; it is part of the operating system).  If
12661 the GOT size for the linked executable exceeds a machine-specific
12662 maximum size, you get an error message from the linker indicating that
12663 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12664 instead.  (These maximums are 8k on the SPARC and 32k
12665 on the m68k and RS/6000.  The 386 has no such limit.)
12667 Position-independent code requires special support, and therefore works
12668 only on certain machines.  For the 386, GCC supports PIC for System V
12669 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12670 position-independent.
12672 @item -fPIC
12673 @opindex fPIC
12674 If supported for the target machine, emit position-independent code,
12675 suitable for dynamic linking and avoiding any limit on the size of the
12676 global offset table.  This option makes a difference on the m68k,
12677 PowerPC and SPARC@.
12679 Position-independent code requires special support, and therefore works
12680 only on certain machines.
12682 @item -fpie
12683 @itemx -fPIE
12684 @opindex fpie
12685 @opindex fPIE
12686 These options are similar to @option{-fpic} and @option{-fPIC}, but
12687 generated position independent code can be only linked into executables.
12688 Usually these options are used when @option{-pie} GCC option will be
12689 used during linking.
12691 @item -fno-jump-tables
12692 @opindex fno-jump-tables
12693 Do not use jump tables for switch statements even where it would be
12694 more efficient than other code generation strategies.  This option is
12695 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12696 building code which forms part of a dynamic linker and cannot
12697 reference the address of a jump table.  On some targets, jump tables
12698 do not require a GOT and this option is not needed.
12700 @item -ffixed-@var{reg}
12701 @opindex ffixed
12702 Treat the register named @var{reg} as a fixed register; generated code
12703 should never refer to it (except perhaps as a stack pointer, frame
12704 pointer or in some other fixed role).
12706 @var{reg} must be the name of a register.  The register names accepted
12707 are machine-specific and are defined in the @code{REGISTER_NAMES}
12708 macro in the machine description macro file.
12710 This flag does not have a negative form, because it specifies a
12711 three-way choice.
12713 @item -fcall-used-@var{reg}
12714 @opindex fcall-used
12715 Treat the register named @var{reg} as an allocable register that is
12716 clobbered by function calls.  It may be allocated for temporaries or
12717 variables that do not live across a call.  Functions compiled this way
12718 will not save and restore the register @var{reg}.
12720 It is an error to used this flag with the frame pointer or stack pointer.
12721 Use of this flag for other registers that have fixed pervasive roles in
12722 the machine's execution model will produce disastrous results.
12724 This flag does not have a negative form, because it specifies a
12725 three-way choice.
12727 @item -fcall-saved-@var{reg}
12728 @opindex fcall-saved
12729 Treat the register named @var{reg} as an allocable register saved by
12730 functions.  It may be allocated even for temporaries or variables that
12731 live across a call.  Functions compiled this way will save and restore
12732 the register @var{reg} if they use it.
12734 It is an error to used this flag with the frame pointer or stack pointer.
12735 Use of this flag for other registers that have fixed pervasive roles in
12736 the machine's execution model will produce disastrous results.
12738 A different sort of disaster will result from the use of this flag for
12739 a register in which function values may be returned.
12741 This flag does not have a negative form, because it specifies a
12742 three-way choice.
12744 @item -fpack-struct[=@var{n}]
12745 @opindex fpack-struct
12746 Without a value specified, pack all structure members together without
12747 holes.  When a value is specified (which must be a small power of two), pack
12748 structure members according to this value, representing the maximum
12749 alignment (that is, objects with default alignment requirements larger than
12750 this will be output potentially unaligned at the next fitting location.
12752 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12753 code that is not binary compatible with code generated without that switch.
12754 Additionally, it makes the code suboptimal.
12755 Use it to conform to a non-default application binary interface.
12757 @item -finstrument-functions
12758 @opindex finstrument-functions
12759 Generate instrumentation calls for entry and exit to functions.  Just
12760 after function entry and just before function exit, the following
12761 profiling functions will be called with the address of the current
12762 function and its call site.  (On some platforms,
12763 @code{__builtin_return_address} does not work beyond the current
12764 function, so the call site information may not be available to the
12765 profiling functions otherwise.)
12767 @smallexample
12768 void __cyg_profile_func_enter (void *this_fn,
12769                                void *call_site);
12770 void __cyg_profile_func_exit  (void *this_fn,
12771                                void *call_site);
12772 @end smallexample
12774 The first argument is the address of the start of the current function,
12775 which may be looked up exactly in the symbol table.
12777 This instrumentation is also done for functions expanded inline in other
12778 functions.  The profiling calls will indicate where, conceptually, the
12779 inline function is entered and exited.  This means that addressable
12780 versions of such functions must be available.  If all your uses of a
12781 function are expanded inline, this may mean an additional expansion of
12782 code size.  If you use @samp{extern inline} in your C code, an
12783 addressable version of such functions must be provided.  (This is
12784 normally the case anyways, but if you get lucky and the optimizer always
12785 expands the functions inline, you might have gotten away without
12786 providing static copies.)
12788 A function may be given the attribute @code{no_instrument_function}, in
12789 which case this instrumentation will not be done.  This can be used, for
12790 example, for the profiling functions listed above, high-priority
12791 interrupt routines, and any functions from which the profiling functions
12792 cannot safely be called (perhaps signal handlers, if the profiling
12793 routines generate output or allocate memory).
12795 @item -fstack-check
12796 @opindex fstack-check
12797 Generate code to verify that you do not go beyond the boundary of the
12798 stack.  You should specify this flag if you are running in an
12799 environment with multiple threads, but only rarely need to specify it in
12800 a single-threaded environment since stack overflow is automatically
12801 detected on nearly all systems if there is only one stack.
12803 Note that this switch does not actually cause checking to be done; the
12804 operating system must do that.  The switch causes generation of code
12805 to ensure that the operating system sees the stack being extended.
12807 @item -fstack-limit-register=@var{reg}
12808 @itemx -fstack-limit-symbol=@var{sym}
12809 @itemx -fno-stack-limit
12810 @opindex fstack-limit-register
12811 @opindex fstack-limit-symbol
12812 @opindex fno-stack-limit
12813 Generate code to ensure that the stack does not grow beyond a certain value,
12814 either the value of a register or the address of a symbol.  If the stack
12815 would grow beyond the value, a signal is raised.  For most targets,
12816 the signal is raised before the stack overruns the boundary, so
12817 it is possible to catch the signal without taking special precautions.
12819 For instance, if the stack starts at absolute address @samp{0x80000000}
12820 and grows downwards, you can use the flags
12821 @option{-fstack-limit-symbol=__stack_limit} and
12822 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12823 of 128KB@.  Note that this may only work with the GNU linker.
12825 @cindex aliasing of parameters
12826 @cindex parameters, aliased
12827 @item -fargument-alias
12828 @itemx -fargument-noalias
12829 @itemx -fargument-noalias-global
12830 @opindex fargument-alias
12831 @opindex fargument-noalias
12832 @opindex fargument-noalias-global
12833 Specify the possible relationships among parameters and between
12834 parameters and global data.
12836 @option{-fargument-alias} specifies that arguments (parameters) may
12837 alias each other and may alias global storage.@*
12838 @option{-fargument-noalias} specifies that arguments do not alias
12839 each other, but may alias global storage.@*
12840 @option{-fargument-noalias-global} specifies that arguments do not
12841 alias each other and do not alias global storage.
12843 Each language will automatically use whatever option is required by
12844 the language standard.  You should not need to use these options yourself.
12846 @item -fleading-underscore
12847 @opindex fleading-underscore
12848 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12849 change the way C symbols are represented in the object file.  One use
12850 is to help link with legacy assembly code.
12852 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12853 generate code that is not binary compatible with code generated without that
12854 switch.  Use it to conform to a non-default application binary interface.
12855 Not all targets provide complete support for this switch.
12857 @item -ftls-model=@var{model}
12858 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12859 The @var{model} argument should be one of @code{global-dynamic},
12860 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12862 The default without @option{-fpic} is @code{initial-exec}; with
12863 @option{-fpic} the default is @code{global-dynamic}.
12865 @item -fvisibility=@var{default|internal|hidden|protected}
12866 @opindex fvisibility
12867 Set the default ELF image symbol visibility to the specified option---all
12868 symbols will be marked with this unless overridden within the code.
12869 Using this feature can very substantially improve linking and
12870 load times of shared object libraries, produce more optimized
12871 code, provide near-perfect API export and prevent symbol clashes.
12872 It is @strong{strongly} recommended that you use this in any shared objects
12873 you distribute.
12875 Despite the nomenclature, @code{default} always means public ie;
12876 available to be linked against from outside the shared object.
12877 @code{protected} and @code{internal} are pretty useless in real-world
12878 usage so the only other commonly used option will be @code{hidden}.
12879 The default if @option{-fvisibility} isn't specified is
12880 @code{default}, i.e., make every
12881 symbol public---this causes the same behavior as previous versions of
12882 GCC@.
12884 A good explanation of the benefits offered by ensuring ELF
12885 symbols have the correct visibility is given by ``How To Write
12886 Shared Libraries'' by Ulrich Drepper (which can be found at
12887 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12888 solution made possible by this option to marking things hidden when
12889 the default is public is to make the default hidden and mark things
12890 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12891 and @code{__attribute__ ((visibility("default")))} instead of
12892 @code{__declspec(dllexport)} you get almost identical semantics with
12893 identical syntax.  This is a great boon to those working with
12894 cross-platform projects.
12896 For those adding visibility support to existing code, you may find
12897 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12898 the declarations you wish to set visibility for with (for example)
12899 @samp{#pragma GCC visibility push(hidden)} and
12900 @samp{#pragma GCC visibility pop}.
12901 Bear in mind that symbol visibility should be viewed @strong{as
12902 part of the API interface contract} and thus all new code should
12903 always specify visibility when it is not the default ie; declarations
12904 only for use within the local DSO should @strong{always} be marked explicitly
12905 as hidden as so to avoid PLT indirection overheads---making this
12906 abundantly clear also aids readability and self-documentation of the code.
12907 Note that due to ISO C++ specification requirements, operator new and
12908 operator delete must always be of default visibility.
12910 An overview of these techniques, their benefits and how to use them
12911 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
12913 @end table
12915 @c man end
12917 @node Environment Variables
12918 @section Environment Variables Affecting GCC
12919 @cindex environment variables
12921 @c man begin ENVIRONMENT
12922 This section describes several environment variables that affect how GCC
12923 operates.  Some of them work by specifying directories or prefixes to use
12924 when searching for various kinds of files.  Some are used to specify other
12925 aspects of the compilation environment.
12927 Note that you can also specify places to search using options such as
12928 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12929 take precedence over places specified using environment variables, which
12930 in turn take precedence over those specified by the configuration of GCC@.
12931 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12932 GNU Compiler Collection (GCC) Internals}.
12934 @table @env
12935 @item LANG
12936 @itemx LC_CTYPE
12937 @c @itemx LC_COLLATE
12938 @itemx LC_MESSAGES
12939 @c @itemx LC_MONETARY
12940 @c @itemx LC_NUMERIC
12941 @c @itemx LC_TIME
12942 @itemx LC_ALL
12943 @findex LANG
12944 @findex LC_CTYPE
12945 @c @findex LC_COLLATE
12946 @findex LC_MESSAGES
12947 @c @findex LC_MONETARY
12948 @c @findex LC_NUMERIC
12949 @c @findex LC_TIME
12950 @findex LC_ALL
12951 @cindex locale
12952 These environment variables control the way that GCC uses
12953 localization information that allow GCC to work with different
12954 national conventions.  GCC inspects the locale categories
12955 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12956 so.  These locale categories can be set to any value supported by your
12957 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12958 Kingdom encoded in UTF-8.
12960 The @env{LC_CTYPE} environment variable specifies character
12961 classification.  GCC uses it to determine the character boundaries in
12962 a string; this is needed for some multibyte encodings that contain quote
12963 and escape characters that would otherwise be interpreted as a string
12964 end or escape.
12966 The @env{LC_MESSAGES} environment variable specifies the language to
12967 use in diagnostic messages.
12969 If the @env{LC_ALL} environment variable is set, it overrides the value
12970 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12971 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12972 environment variable.  If none of these variables are set, GCC
12973 defaults to traditional C English behavior.
12975 @item TMPDIR
12976 @findex TMPDIR
12977 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12978 files.  GCC uses temporary files to hold the output of one stage of
12979 compilation which is to be used as input to the next stage: for example,
12980 the output of the preprocessor, which is the input to the compiler
12981 proper.
12983 @item GCC_EXEC_PREFIX
12984 @findex GCC_EXEC_PREFIX
12985 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12986 names of the subprograms executed by the compiler.  No slash is added
12987 when this prefix is combined with the name of a subprogram, but you can
12988 specify a prefix that ends with a slash if you wish.
12990 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12991 an appropriate prefix to use based on the pathname it was invoked with.
12993 If GCC cannot find the subprogram using the specified prefix, it
12994 tries looking in the usual places for the subprogram.
12996 The default value of @env{GCC_EXEC_PREFIX} is
12997 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12998 of @code{prefix} when you ran the @file{configure} script.
13000 Other prefixes specified with @option{-B} take precedence over this prefix.
13002 This prefix is also used for finding files such as @file{crt0.o} that are
13003 used for linking.
13005 In addition, the prefix is used in an unusual way in finding the
13006 directories to search for header files.  For each of the standard
13007 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13008 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13009 replacing that beginning with the specified prefix to produce an
13010 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13011 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13012 These alternate directories are searched first; the standard directories
13013 come next.
13015 @item COMPILER_PATH
13016 @findex COMPILER_PATH
13017 The value of @env{COMPILER_PATH} is a colon-separated list of
13018 directories, much like @env{PATH}.  GCC tries the directories thus
13019 specified when searching for subprograms, if it can't find the
13020 subprograms using @env{GCC_EXEC_PREFIX}.
13022 @item LIBRARY_PATH
13023 @findex LIBRARY_PATH
13024 The value of @env{LIBRARY_PATH} is a colon-separated list of
13025 directories, much like @env{PATH}.  When configured as a native compiler,
13026 GCC tries the directories thus specified when searching for special
13027 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13028 using GCC also uses these directories when searching for ordinary
13029 libraries for the @option{-l} option (but directories specified with
13030 @option{-L} come first).
13032 @item LANG
13033 @findex LANG
13034 @cindex locale definition
13035 This variable is used to pass locale information to the compiler.  One way in
13036 which this information is used is to determine the character set to be used
13037 when character literals, string literals and comments are parsed in C and C++.
13038 When the compiler is configured to allow multibyte characters,
13039 the following values for @env{LANG} are recognized:
13041 @table @samp
13042 @item C-JIS
13043 Recognize JIS characters.
13044 @item C-SJIS
13045 Recognize SJIS characters.
13046 @item C-EUCJP
13047 Recognize EUCJP characters.
13048 @end table
13050 If @env{LANG} is not defined, or if it has some other value, then the
13051 compiler will use mblen and mbtowc as defined by the default locale to
13052 recognize and translate multibyte characters.
13053 @end table
13055 @noindent
13056 Some additional environments variables affect the behavior of the
13057 preprocessor.
13059 @include cppenv.texi
13061 @c man end
13063 @node Precompiled Headers
13064 @section Using Precompiled Headers
13065 @cindex precompiled headers
13066 @cindex speed of compilation
13068 Often large projects have many header files that are included in every
13069 source file.  The time the compiler takes to process these header files
13070 over and over again can account for nearly all of the time required to
13071 build the project.  To make builds faster, GCC allows users to
13072 `precompile' a header file; then, if builds can use the precompiled
13073 header file they will be much faster.
13075 To create a precompiled header file, simply compile it as you would any
13076 other file, if necessary using the @option{-x} option to make the driver
13077 treat it as a C or C++ header file.  You will probably want to use a
13078 tool like @command{make} to keep the precompiled header up-to-date when
13079 the headers it contains change.
13081 A precompiled header file will be searched for when @code{#include} is
13082 seen in the compilation.  As it searches for the included file
13083 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13084 compiler looks for a precompiled header in each directory just before it
13085 looks for the include file in that directory.  The name searched for is
13086 the name specified in the @code{#include} with @samp{.gch} appended.  If
13087 the precompiled header file can't be used, it is ignored.
13089 For instance, if you have @code{#include "all.h"}, and you have
13090 @file{all.h.gch} in the same directory as @file{all.h}, then the
13091 precompiled header file will be used if possible, and the original
13092 header will be used otherwise.
13094 Alternatively, you might decide to put the precompiled header file in a
13095 directory and use @option{-I} to ensure that directory is searched
13096 before (or instead of) the directory containing the original header.
13097 Then, if you want to check that the precompiled header file is always
13098 used, you can put a file of the same name as the original header in this
13099 directory containing an @code{#error} command.
13101 This also works with @option{-include}.  So yet another way to use
13102 precompiled headers, good for projects not designed with precompiled
13103 header files in mind, is to simply take most of the header files used by
13104 a project, include them from another header file, precompile that header
13105 file, and @option{-include} the precompiled header.  If the header files
13106 have guards against multiple inclusion, they will be skipped because
13107 they've already been included (in the precompiled header).
13109 If you need to precompile the same header file for different
13110 languages, targets, or compiler options, you can instead make a
13111 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13112 header in the directory, perhaps using @option{-o}.  It doesn't matter
13113 what you call the files in the directory, every precompiled header in
13114 the directory will be considered.  The first precompiled header
13115 encountered in the directory that is valid for this compilation will
13116 be used; they're searched in no particular order.
13118 There are many other possibilities, limited only by your imagination,
13119 good sense, and the constraints of your build system.
13121 A precompiled header file can be used only when these conditions apply:
13123 @itemize
13124 @item
13125 Only one precompiled header can be used in a particular compilation.
13127 @item
13128 A precompiled header can't be used once the first C token is seen.  You
13129 can have preprocessor directives before a precompiled header; you can
13130 even include a precompiled header from inside another header, so long as
13131 there are no C tokens before the @code{#include}.
13133 @item
13134 The precompiled header file must be produced for the same language as
13135 the current compilation.  You can't use a C precompiled header for a C++
13136 compilation.
13138 @item
13139 The precompiled header file must have been produced by the same compiler
13140 binary as the current compilation is using.
13142 @item
13143 Any macros defined before the precompiled header is included must
13144 either be defined in the same way as when the precompiled header was
13145 generated, or must not affect the precompiled header, which usually
13146 means that they don't appear in the precompiled header at all.
13148 The @option{-D} option is one way to define a macro before a
13149 precompiled header is included; using a @code{#define} can also do it.
13150 There are also some options that define macros implicitly, like
13151 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13152 defined this way.
13154 @item If debugging information is output when using the precompiled
13155 header, using @option{-g} or similar, the same kind of debugging information
13156 must have been output when building the precompiled header.  However,
13157 a precompiled header built using @option{-g} can be used in a compilation
13158 when no debugging information is being output.
13160 @item The same @option{-m} options must generally be used when building
13161 and using the precompiled header.  @xref{Submodel Options},
13162 for any cases where this rule is relaxed.
13164 @item Each of the following options must be the same when building and using
13165 the precompiled header:
13167 @gccoptlist{-fexceptions -funit-at-a-time}
13169 @item
13170 Some other command-line options starting with @option{-f},
13171 @option{-p}, or @option{-O} must be defined in the same way as when
13172 the precompiled header was generated.  At present, it's not clear
13173 which options are safe to change and which are not; the safest choice
13174 is to use exactly the same options when generating and using the
13175 precompiled header.  The following are known to be safe:
13177 @gccoptlist{-fpreprocessed
13178 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13179 -fsched-verbose=<number> -fschedule-insns
13180 -pedantic-errors}
13182 @end itemize
13184 For all of these except the last, the compiler will automatically
13185 ignore the precompiled header if the conditions aren't met.  If you
13186 find an option combination that doesn't work and doesn't cause the
13187 precompiled header to be ignored, please consider filing a bug report,
13188 see @ref{Bugs}.
13190 If you do use differing options when generating and using the
13191 precompiled header, the actual behavior will be a mixture of the
13192 behavior for the options.  For instance, if you use @option{-g} to
13193 generate the precompiled header but not when using it, you may or may
13194 not get debugging information for routines in the precompiled header.
13196 @node Running Protoize
13197 @section Running Protoize
13199 The program @code{protoize} is an optional part of GCC@.  You can use
13200 it to add prototypes to a program, thus converting the program to ISO
13201 C in one respect.  The companion program @code{unprotoize} does the
13202 reverse: it removes argument types from any prototypes that are found.
13204 When you run these programs, you must specify a set of source files as
13205 command line arguments.  The conversion programs start out by compiling
13206 these files to see what functions they define.  The information gathered
13207 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13209 After scanning comes actual conversion.  The specified files are all
13210 eligible to be converted; any files they include (whether sources or
13211 just headers) are eligible as well.
13213 But not all the eligible files are converted.  By default,
13214 @code{protoize} and @code{unprotoize} convert only source and header
13215 files in the current directory.  You can specify additional directories
13216 whose files should be converted with the @option{-d @var{directory}}
13217 option.  You can also specify particular files to exclude with the
13218 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13219 directory name matches one of the specified directory names, and its
13220 name within the directory has not been excluded.
13222 Basic conversion with @code{protoize} consists of rewriting most
13223 function definitions and function declarations to specify the types of
13224 the arguments.  The only ones not rewritten are those for varargs
13225 functions.
13227 @code{protoize} optionally inserts prototype declarations at the
13228 beginning of the source file, to make them available for any calls that
13229 precede the function's definition.  Or it can insert prototype
13230 declarations with block scope in the blocks where undeclared functions
13231 are called.
13233 Basic conversion with @code{unprotoize} consists of rewriting most
13234 function declarations to remove any argument types, and rewriting
13235 function definitions to the old-style pre-ISO form.
13237 Both conversion programs print a warning for any function declaration or
13238 definition that they can't convert.  You can suppress these warnings
13239 with @option{-q}.
13241 The output from @code{protoize} or @code{unprotoize} replaces the
13242 original source file.  The original file is renamed to a name ending
13243 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13244 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13245 for DOS) file already exists, then the source file is simply discarded.
13247 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13248 scan the program and collect information about the functions it uses.
13249 So neither of these programs will work until GCC is installed.
13251 Here is a table of the options you can use with @code{protoize} and
13252 @code{unprotoize}.  Each option works with both programs unless
13253 otherwise stated.
13255 @table @code
13256 @item -B @var{directory}
13257 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13258 usual directory (normally @file{/usr/local/lib}).  This file contains
13259 prototype information about standard system functions.  This option
13260 applies only to @code{protoize}.
13262 @item -c @var{compilation-options}
13263 Use @var{compilation-options} as the options when running @command{gcc} to
13264 produce the @samp{.X} files.  The special option @option{-aux-info} is
13265 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13267 Note that the compilation options must be given as a single argument to
13268 @code{protoize} or @code{unprotoize}.  If you want to specify several
13269 @command{gcc} options, you must quote the entire set of compilation options
13270 to make them a single word in the shell.
13272 There are certain @command{gcc} arguments that you cannot use, because they
13273 would produce the wrong kind of output.  These include @option{-g},
13274 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13275 the @var{compilation-options}, they are ignored.
13277 @item -C
13278 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13279 systems) instead of @samp{.c}.  This is convenient if you are converting
13280 a C program to C++.  This option applies only to @code{protoize}.
13282 @item -g
13283 Add explicit global declarations.  This means inserting explicit
13284 declarations at the beginning of each source file for each function
13285 that is called in the file and was not declared.  These declarations
13286 precede the first function definition that contains a call to an
13287 undeclared function.  This option applies only to @code{protoize}.
13289 @item -i @var{string}
13290 Indent old-style parameter declarations with the string @var{string}.
13291 This option applies only to @code{protoize}.
13293 @code{unprotoize} converts prototyped function definitions to old-style
13294 function definitions, where the arguments are declared between the
13295 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13296 uses five spaces as the indentation.  If you want to indent with just
13297 one space instead, use @option{-i " "}.
13299 @item -k
13300 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13301 is finished.
13303 @item -l
13304 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13305 a prototype declaration for each function in each block which calls the
13306 function without any declaration.  This option applies only to
13307 @code{protoize}.
13309 @item -n
13310 Make no real changes.  This mode just prints information about the conversions
13311 that would have been done without @option{-n}.
13313 @item -N
13314 Make no @samp{.save} files.  The original files are simply deleted.
13315 Use this option with caution.
13317 @item -p @var{program}
13318 Use the program @var{program} as the compiler.  Normally, the name
13319 @file{gcc} is used.
13321 @item -q
13322 Work quietly.  Most warnings are suppressed.
13324 @item -v
13325 Print the version number, just like @option{-v} for @command{gcc}.
13326 @end table
13328 If you need special compiler options to compile one of your program's
13329 source files, then you should generate that file's @samp{.X} file
13330 specially, by running @command{gcc} on that source file with the
13331 appropriate options and the option @option{-aux-info}.  Then run
13332 @code{protoize} on the entire set of files.  @code{protoize} will use
13333 the existing @samp{.X} file because it is newer than the source file.
13334 For example:
13336 @smallexample
13337 gcc -Dfoo=bar file1.c -aux-info file1.X
13338 protoize *.c
13339 @end smallexample
13341 @noindent
13342 You need to include the special files along with the rest in the
13343 @code{protoize} command, even though their @samp{.X} files already
13344 exist, because otherwise they won't get converted.
13346 @xref{Protoize Caveats}, for more information on how to use
13347 @code{protoize} successfully.