Sync usage with man page.
[netbsd-mini2440.git] / gnu / dist / gcc4 / gcc / doc / invoke.texi
blobc4a60387596a2bd4f2f282492b2e3f95ff0557d0
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}  -fgnu89-inline @gol
164 -aux-info @var{filename} @gol
165 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
166 -fhosted  -ffreestanding  -fms-extensions @gol
167 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
168 -fallow-single-precision  -fcond-mismatch @gol
169 -fsigned-bitfields  -fsigned-char @gol
170 -funsigned-bitfields  -funsigned-char}
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -ffriend-injection  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs @gol
178 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
179 -fno-implicit-templates @gol
180 -fno-implicit-inline-templates @gol
181 -fno-implement-inlines  -fms-extensions @gol
182 -fno-nonansi-builtins  -fno-operator-names @gol
183 -fno-optional-diags  -fpermissive @gol
184 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
185 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
186 -fno-default-inline  -fvisibility-inlines-hidden @gol
187 -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo}
194 @item Objective-C and Objective-C++ Language Options
195 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
196 Objective-C and Objective-C++ Dialects}.
197 @gccoptlist{
198 -fconstant-string-class=@var{class-name} @gol
199 -fgnu-runtime  -fnext-runtime @gol
200 -fno-nil-receivers @gol
201 -fobjc-call-cxx-cdtors @gol
202 -fobjc-direct-dispatch @gol
203 -fobjc-exceptions @gol
204 -fobjc-gc @gol
205 -freplace-objc-classes @gol
206 -fzero-link @gol
207 -gen-decls @gol
208 -Wassign-intercept @gol
209 -Wno-protocol  -Wselector @gol
210 -Wstrict-selector-match @gol
211 -Wundeclared-selector}
213 @item Language Independent Options
214 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
215 @gccoptlist{-fmessage-length=@var{n}  @gol
216 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]} @gol
217 -fdiagnostics-show-options}
219 @item Warning Options
220 @xref{Warning Options,,Options to Request or Suppress Warnings}.
221 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
222 -w  -Wextra  -Wall  -Waggregate-return -Wno-attributes @gol
223 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
224 -Wconversion  -Wno-deprecated-declarations @gol
225 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
226 -Werror  -Werror-implicit-function-declaration @gol
227 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
228 -Wno-format-extra-args -Wformat-nonliteral @gol
229 -Wformat-security  -Wformat-y2k @gol
230 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
231 -Wimport  -Wno-import  -Winit-self  -Winline @gol
232 -Wno-int-to-pointer-cast @gol
233 -Wno-invalid-offsetof  -Winvalid-pch @gol
234 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
235 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
236 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
237 -Wmissing-noreturn @gol
238 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
239 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
240 -Wredundant-decls @gol
241 -Wreturn-type  -Wsequence-point  -Wshadow @gol
242 -Wsign-compare  -Wstack-protector @gol
243 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
244 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
245 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
246 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
247 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
248 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
249 -Wvolatile-register-var  -Wwrite-strings}
251 @item C-only Warning Options
252 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
253 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
254 -Wstrict-prototypes  -Wtraditional @gol
255 -Wdeclaration-after-statement -Wpointer-sign}
257 @item Debugging Options
258 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
259 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
260 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
261 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
262 -fdump-ipa-all -fdump-ipa-cgraph @gol
263 -fdump-tree-all @gol
264 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
265 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
267 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
268 -fdump-tree-ch @gol
269 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
276 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
277 -fdump-tree-nrv -fdump-tree-vect @gol
278 -fdump-tree-sink @gol
279 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-salias @gol
281 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
282 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
283 -ftree-vectorizer-verbose=@var{n} @gol
284 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
285 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
286 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
287 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
288 -ftest-coverage  -ftime-report -fvar-tracking @gol
289 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
290 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
291 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
292 -print-multi-directory  -print-multi-lib @gol
293 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
294 -save-temps  -time}
296 @item Optimization Options
297 @xref{Optimize Options,,Options that Control Optimization}.
298 @gccoptlist{-falign-functions[=@var{n}]  -falign-jumps[=@var{n}] @gol
299 -falign-labels[=@var{n}]  -falign-loops[=@var{n}]  @gol
300 -fmudflap -fmudflapth -fmudflapir @gol
301 -fbranch-probabilities -fprofile-values -fvpt @gol
302 -fbranch-target-load-optimize @gol
303 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
304 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
305 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
306 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
307 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
308 -fforce-addr  -ffunction-sections @gol
309 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
310 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
311 -finline-functions  -finline-functions-called-once @gol
312 -finline-limit=@var{n}  -fkeep-inline-functions @gol
313 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
314 -fmodulo-sched -fno-branch-count-reg @gol
315 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
316 -fno-function-cse  -fno-guess-branch-probability @gol
317 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
318 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
319 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
320 -fomit-frame-pointer  -foptimize-register-move @gol
321 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
322 -fprofile-generate -fprofile-use @gol
323 -fregmove  -frename-registers @gol
324 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
325 -frerun-cse-after-loop  -frerun-loop-opt @gol
326 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
327 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
328 -fsched-spec-load-dangerous  @gol
329 -fsched-stalled-insns[=@var{n}] -fsched-stalled-insns-dep[=@var{n}] @gol
330 -fsched2-use-superblocks @gol
331 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
332 -fsignaling-nans -fsingle-precision-constant  @gol
333 -fstack-protector  -fstack-protector-all @gol
334 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
335 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
336 -fsplit-ivs-in-unroller -funswitch-loops @gol
337 -fvariable-expansion-in-unroller @gol
338 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
339 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
340 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
341 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
342 -ftree-vect-loop-version -ftree-salias -fweb @gol
343 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -ftree-vrp @gol
344 -funit-at-a-time -fwhole-program @gol
345 --param @var{name}=@var{value}
346 -O  -O0  -O1  -O2  -O3  -Os}
348 @item Preprocessor Options
349 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
350 @gccoptlist{-A@var{question}=@var{answer} @gol
351 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
352 -C  -dD  -dI  -dM  -dN @gol
353 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
354 -idirafter @var{dir} @gol
355 -include @var{file}  -imacros @var{file} @gol
356 -iprefix @var{file}  -iwithprefix @var{dir} @gol
357 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
358 -cxx-isystem @var{dir} @gol
359 -isysroot @var{dir} @gol
360 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
361 -P  -fworking-directory  -remap @gol
362 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
363 -Xpreprocessor @var{option}}
365 @item Assembler Option
366 @xref{Assembler Options,,Passing Options to the Assembler}.
367 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
369 @item Linker Options
370 @xref{Link Options,,Options for Linking}.
371 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
372 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
373 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
374 -Wl,@var{option}  -Xlinker @var{option} @gol
375 -u @var{symbol}}
377 @item Directory Options
378 @xref{Directory Options,,Options for Directory Search}.
379 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  
380 -iremap@var{src}:@var{dst}  -L@var{dir}
381 -specs=@var{file}  -I- --sysroot=@var{dir}}
383 @item Target Options
384 @c I wrote this xref this way to avoid overfull hbox. -- rms
385 @xref{Target Options}.
386 @gccoptlist{-V @var{version}  -b @var{machine}}
388 @item Machine Dependent Options
389 @xref{Submodel Options,,Hardware Models and Configurations}.
390 @c This list is ordered alphanumerically by subsection name.
391 @c Try and put the significant identifier (CPU or system) first,
392 @c so users have a clue at guessing where the ones they want will be.
394 @emph{ARC Options}
395 @gccoptlist{-EB  -EL @gol
396 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
397 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
399 @emph{ARM Options}
400 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
401 -mabi=@var{name} @gol
402 -mapcs-stack-check  -mno-apcs-stack-check @gol
403 -mapcs-float  -mno-apcs-float @gol
404 -mapcs-reentrant  -mno-apcs-reentrant @gol
405 -msched-prolog  -mno-sched-prolog @gol
406 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
407 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
408 -mthumb-interwork  -mno-thumb-interwork @gol
409 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
410 -mstructure-size-boundary=@var{n} @gol
411 -mabort-on-noreturn @gol
412 -mlong-calls  -mno-long-calls @gol
413 -msingle-pic-base  -mno-single-pic-base @gol
414 -mpic-register=@var{reg} @gol
415 -mnop-fun-dllimport @gol
416 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
417 -mpoke-function-name @gol
418 -mthumb  -marm @gol
419 -mtpcs-frame  -mtpcs-leaf-frame @gol
420 -mcaller-super-interworking  -mcallee-super-interworking @gol
421 -mtp=@var{name}}
423 @emph{AVR Options}
424 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
425 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
427 @emph{Blackfin Options}
428 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
429 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
430 -mlow-64k -mno-low64k -mid-shared-library @gol
431 -mno-id-shared-library -mshared-library-id=@var{n} @gol
432 -mlong-calls  -mno-long-calls}
434 @emph{CRIS Options}
435 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
436 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
437 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
438 -mstack-align  -mdata-align  -mconst-align @gol
439 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
440 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
441 -mmul-bug-workaround  -mno-mul-bug-workaround}
443 @emph{CRX Options}
444 @gccoptlist{-mmac -mpush-args}
446 @emph{Darwin Options}
447 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
448 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
449 -client_name  -compatibility_version  -current_version @gol
450 -dead_strip @gol
451 -dependency-file  -dylib_file  -dylinker_install_name @gol
452 -dynamic  -dynamiclib  -exported_symbols_list @gol
453 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
454 -force_flat_namespace  -headerpad_max_install_names @gol
455 -image_base  -init  -install_name  -keep_private_externs @gol
456 -multi_module  -multiply_defined  -multiply_defined_unused @gol
457 -noall_load   -no_dead_strip_inits_and_terms @gol
458 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
459 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
460 -private_bundle  -read_only_relocs  -sectalign @gol
461 -sectobjectsymbols  -whyload  -seg1addr @gol
462 -sectcreate  -sectobjectsymbols  -sectorder @gol
463 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
464 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
465 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
466 -single_module  -static  -sub_library  -sub_umbrella @gol
467 -twolevel_namespace  -umbrella  -undefined @gol
468 -unexported_symbols_list  -weak_reference_mismatches @gol
469 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
470 -mone-byte-bool}
472 @emph{DEC Alpha Options}
473 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
474 -mieee  -mieee-with-inexact  -mieee-conformant @gol
475 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
476 -mtrap-precision=@var{mode}  -mbuild-constants @gol
477 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
478 -mbwx  -mmax  -mfix  -mcix @gol
479 -mfloat-vax  -mfloat-ieee @gol
480 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
481 -msmall-text  -mlarge-text @gol
482 -mmemory-latency=@var{time}}
484 @emph{DEC Alpha/VMS Options}
485 @gccoptlist{-mvms-return-codes}
487 @emph{FRV Options}
488 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
489 -mhard-float  -msoft-float @gol
490 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
491 -mdouble  -mno-double @gol
492 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
493 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
494 -mlinked-fp  -mlong-calls  -malign-labels @gol
495 -mlibrary-pic  -macc-4  -macc-8 @gol
496 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
497 -moptimize-membar -mno-optimize-membar @gol
498 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
499 -mvliw-branch  -mno-vliw-branch @gol
500 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
501 -mno-nested-cond-exec  -mtomcat-stats @gol
502 -mTLS -mtls @gol
503 -mcpu=@var{cpu}}
505 @emph{H8/300 Options}
506 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
508 @emph{HPPA Options}
509 @gccoptlist{-march=@var{architecture-type} @gol
510 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
511 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
512 -mfixed-range=@var{register-range} @gol
513 -mjump-in-delay -mlinker-opt -mlong-calls @gol
514 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
515 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
516 -mno-jump-in-delay  -mno-long-load-store @gol
517 -mno-portable-runtime  -mno-soft-float @gol
518 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
519 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
520 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
521 -munix=@var{unix-std}  -nolibdld  -static  -threads}
523 @emph{i386 and x86-64 Options}
524 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
525 -mfpmath=@var{unit} @gol
526 -masm=@var{dialect}  -mno-fancy-math-387 @gol
527 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
528 -mno-wide-multiply  -mrtd  -malign-double @gol
529 -mpreferred-stack-boundary=@var{num} @gol
530 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
531 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
532 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
533 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
534 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
535 -mcmodel=@var{code-model} @gol
536 -m32  -m64 -mlarge-data-threshold=@var{num}}
538 @emph{IA-64 Options}
539 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
540 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
541 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
542 -minline-float-divide-max-throughput @gol
543 -minline-int-divide-min-latency @gol
544 -minline-int-divide-max-throughput  @gol
545 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
546 -mno-dwarf2-asm -mearly-stop-bits @gol
547 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
548 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
550 @emph{M32R/D Options}
551 @gccoptlist{-m32r2 -m32rx -m32r @gol
552 -mdebug @gol
553 -malign-loops -mno-align-loops @gol
554 -missue-rate=@var{number} @gol
555 -mbranch-cost=@var{number} @gol
556 -mmodel=@var{code-size-model-type} @gol
557 -msdata=@var{sdata-type} @gol
558 -mno-flush-func -mflush-func=@var{name} @gol
559 -mno-flush-trap -mflush-trap=@var{number} @gol
560 -G @var{num}}
562 @emph{M32C Options}
563 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
565 @emph{M680x0 Options}
566 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
567 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
568 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
569 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
570 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
572 @emph{M68hc1x Options}
573 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
574 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
575 -msoft-reg-count=@var{count}}
577 @emph{MCore Options}
578 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
579 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
580 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
581 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
582 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
584 @emph{MIPS Options}
585 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
586 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
587 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
588 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
589 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
590 -mdsp  -mpaired-single  -mips3d @gol
591 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
592 -G@var{num}  -membedded-data  -mno-embedded-data @gol
593 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
594 -msplit-addresses  -mno-split-addresses  @gol
595 -mexplicit-relocs  -mno-explicit-relocs  @gol
596 -mcheck-zero-division  -mno-check-zero-division @gol
597 -mdivide-traps  -mdivide-breaks @gol
598 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
599 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
600 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
601 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
602 -mfix-sb1  -mno-fix-sb1 @gol
603 -mflush-func=@var{func}  -mno-flush-func @gol
604 -mbranch-likely  -mno-branch-likely @gol
605 -mfp-exceptions -mno-fp-exceptions @gol
606 -mvr4130-align -mno-vr4130-align}
608 @emph{MMIX Options}
609 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
610 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
611 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
612 -mno-base-addresses  -msingle-exit  -mno-single-exit}
614 @emph{MN10300 Options}
615 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
616 -mam33  -mno-am33 @gol
617 -mam33-2  -mno-am33-2 @gol
618 -mreturn-pointer-on-d0 @gol
619 -mno-crt0  -mrelax}
621 @emph{MT Options}
622 @gccoptlist{-mno-crt0 -mbacc -msim @gol
623 -march=@var{cpu-type} }
625 @emph{PDP-11 Options}
626 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
627 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
628 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
629 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
630 -mbranch-expensive  -mbranch-cheap @gol
631 -msplit  -mno-split  -munix-asm  -mdec-asm}
633 @emph{PowerPC Options}
634 See RS/6000 and PowerPC Options.
636 @emph{RS/6000 and PowerPC Options}
637 @gccoptlist{-mcpu=@var{cpu-type} @gol
638 -mtune=@var{cpu-type} @gol
639 -mpower  -mno-power  -mpower2  -mno-power2 @gol
640 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
641 -maltivec  -mno-altivec @gol
642 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
643 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
644 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
645 -mnew-mnemonics  -mold-mnemonics @gol
646 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
647 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
648 -malign-power  -malign-natural @gol
649 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
650 -mstring  -mno-string  -mupdate  -mno-update @gol
651 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
652 -mstrict-align  -mno-strict-align  -mrelocatable @gol
653 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
654 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
655 -mdynamic-no-pic  -maltivec  -mswdiv @gol
656 -mprioritize-restricted-insns=@var{priority} @gol
657 -msched-costly-dep=@var{dependence_type} @gol
658 -minsert-sched-nops=@var{scheme} @gol
659 -mcall-sysv  -mcall-netbsd @gol
660 -maix-struct-return  -msvr4-struct-return @gol
661 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
662 -misel -mno-isel @gol
663 -misel=yes  -misel=no @gol
664 -mspe -mno-spe @gol
665 -mspe=yes  -mspe=no @gol
666 -mvrsave -mno-vrsave @gol
667 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
668 -mprototype  -mno-prototype @gol
669 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
670 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
672 @emph{S/390 and zSeries Options}
673 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
674 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
675 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
676 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
677 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
678 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
679 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
681 @emph{SH Options}
682 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
683 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
684 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
685 -m5-64media  -m5-64media-nofpu @gol
686 -m5-32media  -m5-32media-nofpu @gol
687 -m5-compact  -m5-compact-nofpu @gol
688 -mb  -ml  -mdalign  -mrelax @gol
689 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
690 -mieee  -misize  -mpadstruct  -mspace @gol
691 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
692 -mdivsi3_libfunc=@var{name}  @gol
693 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
694  -minvalid-symbols}
696 @emph{SPARC Options}
697 @gccoptlist{-mcpu=@var{cpu-type} @gol
698 -mtune=@var{cpu-type} @gol
699 -mcmodel=@var{code-model} @gol
700 -m32  -m64  -mapp-regs  -mno-app-regs @gol
701 -mfaster-structs  -mno-faster-structs @gol
702 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
703 -mhard-quad-float  -msoft-quad-float @gol
704 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
705 -mstack-bias  -mno-stack-bias @gol
706 -munaligned-doubles  -mno-unaligned-doubles @gol
707 -mv8plus  -mno-v8plus  -mvis  -mno-vis
708 -threads -pthreads -pthread}
710 @emph{System V Options}
711 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
713 @emph{TMS320C3x/C4x Options}
714 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
715 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
716 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
717 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
719 @emph{V850 Options}
720 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
721 -mprolog-function  -mno-prolog-function  -mspace @gol
722 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
723 -mapp-regs  -mno-app-regs @gol
724 -mdisable-callt  -mno-disable-callt @gol
725 -mv850e1 @gol
726 -mv850e @gol
727 -mv850  -mbig-switch}
729 @emph{VAX Options}
730 @gccoptlist{-mg  -mgnu  -munix}
732 @emph{x86-64 Options}
733 See i386 and x86-64 Options.
735 @emph{Xstormy16 Options}
736 @gccoptlist{-msim}
738 @emph{Xtensa Options}
739 @gccoptlist{-mconst16 -mno-const16 @gol
740 -mfused-madd  -mno-fused-madd @gol
741 -mtext-section-literals  -mno-text-section-literals @gol
742 -mtarget-align  -mno-target-align @gol
743 -mlongcalls  -mno-longcalls}
745 @emph{zSeries Options}
746 See S/390 and zSeries Options.
748 @item Code Generation Options
749 @xref{Code Gen Options,,Options for Code Generation Conventions}.
750 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
751 -ffixed-@var{reg}  -fexceptions @gol
752 -fnon-call-exceptions  -funwind-tables @gol
753 -fasynchronous-unwind-tables @gol
754 -finhibit-size-directive  -finstrument-functions @gol
755 -fno-common  -fno-ident @gol
756 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
757 -fno-jump-tables @gol
758 -freg-struct-return  -fshared-data  -fshort-enums @gol
759 -fshort-double  -fshort-wchar @gol
760 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
761 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
762 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
763 -fargument-noalias-global  -fleading-underscore @gol
764 -ftls-model=@var{model} @gol
765 -ftrapv  -fwrapv  -fbounds-check @gol
766 -fvisibility}
767 @end table
769 @menu
770 * Overall Options::     Controlling the kind of output:
771                         an executable, object files, assembler files,
772                         or preprocessed source.
773 * C Dialect Options::   Controlling the variant of C language compiled.
774 * C++ Dialect Options:: Variations on C++.
775 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
776                         and Objective-C++.
777 * Language Independent Options:: Controlling how diagnostics should be
778                         formatted.
779 * Warning Options::     How picky should the compiler be?
780 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
781 * Optimize Options::    How much optimization?
782 * Preprocessor Options:: Controlling header files and macro definitions.
783                          Also, getting dependency information for Make.
784 * Assembler Options::   Passing options to the assembler.
785 * Link Options::        Specifying libraries and so on.
786 * Directory Options::   Where to find header files and libraries.
787                         Where to find the compiler executable files.
788 * Spec Files::          How to pass switches to sub-processes.
789 * Target Options::      Running a cross-compiler, or an old version of GCC.
790 @end menu
792 @node Overall Options
793 @section Options Controlling the Kind of Output
795 Compilation can involve up to four stages: preprocessing, compilation
796 proper, assembly and linking, always in that order.  GCC is capable of
797 preprocessing and compiling several files either into several
798 assembler input files, or into one assembler input file; then each
799 assembler input file produces an object file, and linking combines all
800 the object files (those newly compiled, and those specified as input)
801 into an executable file.
803 @cindex file name suffix
804 For any given input file, the file name suffix determines what kind of
805 compilation is done:
807 @table @gcctabopt
808 @item @var{file}.c
809 C source code which must be preprocessed.
811 @item @var{file}.i
812 C source code which should not be preprocessed.
814 @item @var{file}.ii
815 C++ source code which should not be preprocessed.
817 @item @var{file}.m
818 Objective-C source code.  Note that you must link with the @file{libobjc}
819 library to make an Objective-C program work.
821 @item @var{file}.mi
822 Objective-C source code which should not be preprocessed.
824 @item @var{file}.mm
825 @itemx @var{file}.M
826 Objective-C++ source code.  Note that you must link with the @file{libobjc}
827 library to make an Objective-C++ program work.  Note that @samp{.M} refers
828 to a literal capital M@.
830 @item @var{file}.mii
831 Objective-C++ source code which should not be preprocessed.
833 @item @var{file}.h
834 C, C++, Objective-C or Objective-C++ header file to be turned into a
835 precompiled header.
837 @item @var{file}.cc
838 @itemx @var{file}.cp
839 @itemx @var{file}.cxx
840 @itemx @var{file}.cpp
841 @itemx @var{file}.CPP
842 @itemx @var{file}.c++
843 @itemx @var{file}.C
844 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
845 the last two letters must both be literally @samp{x}.  Likewise,
846 @samp{.C} refers to a literal capital C@.
848 @item @var{file}.mm
849 @itemx @var{file}.M
850 Objective-C++ source code which must be preprocessed.
852 @item @var{file}.mii
853 Objective-C++ source code which should not be preprocessed.
855 @item @var{file}.hh
856 @itemx @var{file}.H
857 C++ header file to be turned into a precompiled header.
859 @item @var{file}.f
860 @itemx @var{file}.for
861 @itemx @var{file}.FOR
862 Fixed form Fortran source code which should not be preprocessed.
864 @item @var{file}.F
865 @itemx @var{file}.fpp
866 @itemx @var{file}.FPP
867 Fixed form Fortran source code which must be preprocessed (with the traditional
868 preprocessor).
870 @item @var{file}.f90
871 @itemx @var{file}.f95
872 Free form Fortran source code which should not be preprocessed.
874 @item @var{file}.F90
875 @itemx @var{file}.F95
876 Free form Fortran source code which must be preprocessed (with the
877 traditional preprocessor).
879 @c FIXME: Descriptions of Java file types.
880 @c @var{file}.java
881 @c @var{file}.class
882 @c @var{file}.zip
883 @c @var{file}.jar
885 @item @var{file}.ads
886 Ada source code file which contains a library unit declaration (a
887 declaration of a package, subprogram, or generic, or a generic
888 instantiation), or a library unit renaming declaration (a package,
889 generic, or subprogram renaming declaration).  Such files are also
890 called @dfn{specs}.
892 @itemx @var{file}.adb
893 Ada source code file containing a library unit body (a subprogram or
894 package body).  Such files are also called @dfn{bodies}.
896 @c GCC also knows about some suffixes for languages not yet included:
897 @c Pascal:
898 @c @var{file}.p
899 @c @var{file}.pas
900 @c Ratfor:
901 @c @var{file}.r
903 @item @var{file}.s
904 Assembler code.
906 @item @var{file}.S
907 Assembler code which must be preprocessed.
909 @item @var{other}
910 An object file to be fed straight into linking.
911 Any file name with no recognized suffix is treated this way.
912 @end table
914 @opindex x
915 You can specify the input language explicitly with the @option{-x} option:
917 @table @gcctabopt
918 @item -x @var{language}
919 Specify explicitly the @var{language} for the following input files
920 (rather than letting the compiler choose a default based on the file
921 name suffix).  This option applies to all following input files until
922 the next @option{-x} option.  Possible values for @var{language} are:
923 @smallexample
924 c  c-header  c-cpp-output
925 c++  c++-header  c++-cpp-output
926 objective-c  objective-c-header  objective-c-cpp-output
927 objective-c++ objective-c++-header objective-c++-cpp-output
928 assembler  assembler-with-cpp
930 f95  f95-cpp-input
931 java
932 treelang
933 @end smallexample
935 @item -x none
936 Turn off any specification of a language, so that subsequent files are
937 handled according to their file name suffixes (as they are if @option{-x}
938 has not been used at all).
940 @item -pass-exit-codes
941 @opindex pass-exit-codes
942 Normally the @command{gcc} program will exit with the code of 1 if any
943 phase of the compiler returns a non-success return code.  If you specify
944 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
945 numerically highest error produced by any phase that returned an error
946 indication.
947 @end table
949 If you only want some of the stages of compilation, you can use
950 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
951 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
952 @command{gcc} is to stop.  Note that some combinations (for example,
953 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
955 @table @gcctabopt
956 @item -c
957 @opindex c
958 Compile or assemble the source files, but do not link.  The linking
959 stage simply is not done.  The ultimate output is in the form of an
960 object file for each source file.
962 By default, the object file name for a source file is made by replacing
963 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
965 Unrecognized input files, not requiring compilation or assembly, are
966 ignored.
968 @item -S
969 @opindex S
970 Stop after the stage of compilation proper; do not assemble.  The output
971 is in the form of an assembler code file for each non-assembler input
972 file specified.
974 By default, the assembler file name for a source file is made by
975 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
977 Input files that don't require compilation are ignored.
979 @item -E
980 @opindex E
981 Stop after the preprocessing stage; do not run the compiler proper.  The
982 output is in the form of preprocessed source code, which is sent to the
983 standard output.
985 Input files which don't require preprocessing are ignored.
987 @cindex output file option
988 @item -o @var{file}
989 @opindex o
990 Place output in file @var{file}.  This applies regardless to whatever
991 sort of output is being produced, whether it be an executable file,
992 an object file, an assembler file or preprocessed C code.
994 If @option{-o} is not specified, the default is to put an executable
995 file in @file{a.out}, the object file for
996 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
997 assembler file in @file{@var{source}.s}, a precompiled header file in
998 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
999 standard output.
1001 @item -v
1002 @opindex v
1003 Print (on standard error output) the commands executed to run the stages
1004 of compilation.  Also print the version number of the compiler driver
1005 program and of the preprocessor and the compiler proper.
1007 @item -###
1008 @opindex ###
1009 Like @option{-v} except the commands are not executed and all command
1010 arguments are quoted.  This is useful for shell scripts to capture the
1011 driver-generated command lines.
1013 @item -pipe
1014 @opindex pipe
1015 Use pipes rather than temporary files for communication between the
1016 various stages of compilation.  This fails to work on some systems where
1017 the assembler is unable to read from a pipe; but the GNU assembler has
1018 no trouble.
1020 @item -combine
1021 @opindex combine
1022 If you are compiling multiple source files, this option tells the driver
1023 to pass all the source files to the compiler at once (for those
1024 languages for which the compiler can handle this).  This will allow
1025 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1026 language for which this is supported is C@.  If you pass source files for
1027 multiple languages to the driver, using this option, the driver will invoke
1028 the compiler(s) that support IMA once each, passing each compiler all the
1029 source files appropriate for it.  For those languages that do not support
1030 IMA this option will be ignored, and the compiler will be invoked once for
1031 each source file in that language.  If you use this option in conjunction
1032 with @option{-save-temps}, the compiler will generate multiple
1033 pre-processed files
1034 (one for each source file), but only one (combined) @file{.o} or
1035 @file{.s} file.
1037 @item --help
1038 @opindex help
1039 Print (on the standard output) a description of the command line options
1040 understood by @command{gcc}.  If the @option{-v} option is also specified
1041 then @option{--help} will also be passed on to the various processes
1042 invoked by @command{gcc}, so that they can display the command line options
1043 they accept.  If the @option{-Wextra} option is also specified then command
1044 line options which have no documentation associated with them will also
1045 be displayed.
1047 @item --target-help
1048 @opindex target-help
1049 Print (on the standard output) a description of target specific command
1050 line options for each tool.
1052 @item --version
1053 @opindex version
1054 Display the version number and copyrights of the invoked GCC@.
1055 @end table
1057 @node Invoking G++
1058 @section Compiling C++ Programs
1060 @cindex suffixes for C++ source
1061 @cindex C++ source file suffixes
1062 C++ source files conventionally use one of the suffixes @samp{.C},
1063 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1064 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1065 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1066 files with these names and compiles them as C++ programs even if you
1067 call the compiler the same way as for compiling C programs (usually
1068 with the name @command{gcc}).
1070 @findex g++
1071 @findex c++
1072 However, C++ programs often require class libraries as well as a
1073 compiler that understands the C++ language---and under some
1074 circumstances, you might want to compile programs or header files from
1075 standard input, or otherwise without a suffix that flags them as C++
1076 programs.  You might also like to precompile a C header file with a
1077 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1078 program that calls GCC with the default language set to C++, and
1079 automatically specifies linking against the C++ library.  On many
1080 systems, @command{g++} is also installed with the name @command{c++}.
1082 @cindex invoking @command{g++}
1083 When you compile C++ programs, you may specify many of the same
1084 command-line options that you use for compiling programs in any
1085 language; or command-line options meaningful for C and related
1086 languages; or options that are meaningful only for C++ programs.
1087 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1088 explanations of options for languages related to C@.
1089 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1090 explanations of options that are meaningful only for C++ programs.
1092 @node C Dialect Options
1093 @section Options Controlling C Dialect
1094 @cindex dialect options
1095 @cindex language dialect options
1096 @cindex options, dialect
1098 The following options control the dialect of C (or languages derived
1099 from C, such as C++, Objective-C and Objective-C++) that the compiler
1100 accepts:
1102 @table @gcctabopt
1103 @cindex ANSI support
1104 @cindex ISO support
1105 @item -ansi
1106 @opindex ansi
1107 In C mode, support all ISO C90 programs.  In C++ mode,
1108 remove GNU extensions that conflict with ISO C++.
1110 This turns off certain features of GCC that are incompatible with ISO
1111 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1112 such as the @code{asm} and @code{typeof} keywords, and
1113 predefined macros such as @code{unix} and @code{vax} that identify the
1114 type of system you are using.  It also enables the undesirable and
1115 rarely used ISO trigraph feature.  For the C compiler,
1116 it disables recognition of C++ style @samp{//} comments as well as
1117 the @code{inline} keyword.
1119 The alternate keywords @code{__asm__}, @code{__extension__},
1120 @code{__inline__} and @code{__typeof__} continue to work despite
1121 @option{-ansi}.  You would not want to use them in an ISO C program, of
1122 course, but it is useful to put them in header files that might be included
1123 in compilations done with @option{-ansi}.  Alternate predefined macros
1124 such as @code{__unix__} and @code{__vax__} are also available, with or
1125 without @option{-ansi}.
1127 The @option{-ansi} option does not cause non-ISO programs to be
1128 rejected gratuitously.  For that, @option{-pedantic} is required in
1129 addition to @option{-ansi}.  @xref{Warning Options}.
1131 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1132 option is used.  Some header files may notice this macro and refrain
1133 from declaring certain functions or defining certain macros that the
1134 ISO standard doesn't call for; this is to avoid interfering with any
1135 programs that might use these names for other things.
1137 Functions which would normally be built in but do not have semantics
1138 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1139 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1140 built-in functions provided by GCC}, for details of the functions
1141 affected.
1143 @item -std=
1144 @opindex std
1145 Determine the language standard.  This option is currently only
1146 supported when compiling C or C++.  A value for this option must be
1147 provided; possible values are
1149 @table @samp
1150 @item c89
1151 @itemx iso9899:1990
1152 ISO C90 (same as @option{-ansi}).
1154 @item iso9899:199409
1155 ISO C90 as modified in amendment 1.
1157 @item c99
1158 @itemx c9x
1159 @itemx iso9899:1999
1160 @itemx iso9899:199x
1161 ISO C99.  Note that this standard is not yet fully supported; see
1162 @w{@uref{http://gcc.gnu.org/gcc-4.1/c99status.html}} for more information.  The
1163 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1165 @item gnu89
1166 Default, ISO C90 plus GNU extensions (including some C99 features).
1168 @item gnu99
1169 @itemx gnu9x
1170 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1171 this will become the default.  The name @samp{gnu9x} is deprecated.
1173 @item c++98
1174 The 1998 ISO C++ standard plus amendments.
1176 @item gnu++98
1177 The same as @option{-std=c++98} plus GNU extensions.  This is the
1178 default for C++ code.
1179 @end table
1181 Even when this option is not specified, you can still use some of the
1182 features of newer standards in so far as they do not conflict with
1183 previous C standards.  For example, you may use @code{__restrict__} even
1184 when @option{-std=c99} is not specified.
1186 The @option{-std} options specifying some version of ISO C have the same
1187 effects as @option{-ansi}, except that features that were not in ISO C90
1188 but are in the specified version (for example, @samp{//} comments and
1189 the @code{inline} keyword in ISO C99) are not disabled.
1191 @xref{Standards,,Language Standards Supported by GCC}, for details of
1192 these standard versions.
1194 @item -fgnu89-inline
1195 @opindex fgnu89-inline
1196 The option @option{-fgnu89-inline} tells GCC to use the traditional
1197 GNU semantics for @code{inline} functions when in C99 mode.
1198 @xref{Inline,,An Inline Function is As Fast As a Macro}.  Using this
1199 option is roughly equivalent to adding the @code{gnu_inline} function
1200 attribute to all inline functions (@pxref{Function Attributes}).
1202 This option is accepted by GCC versions 4.1.3 and up.  In GCC versions
1203 prior to 4.3, C99 inline semantics are not supported, and thus this
1204 option is effectively assumed to be present regardless of whether or not
1205 it is specified; the only effect of specifying it explicitly is to
1206 disable warnings about using inline functions in C99 mode.  Likewise,
1207 the option @option{-fno-gnu89-inline} is not supported in versions of
1208 GCC before 4.3.  It will be supported only in C99 or gnu99 mode, not in
1209 C89 or gnu89 mode.
1211 The preprocesor macros @code{__GNUC_GNU_INLINE__} and
1212 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1213 in effect for @code{inline} functions.  @xref{Common Predefined
1214 Macros,,,cpp,The C Preprocessor}.
1216 @item -aux-info @var{filename}
1217 @opindex aux-info
1218 Output to the given filename prototyped declarations for all functions
1219 declared and/or defined in a translation unit, including those in header
1220 files.  This option is silently ignored in any language other than C@.
1222 Besides declarations, the file indicates, in comments, the origin of
1223 each declaration (source file and line), whether the declaration was
1224 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1225 @samp{O} for old, respectively, in the first character after the line
1226 number and the colon), and whether it came from a declaration or a
1227 definition (@samp{C} or @samp{F}, respectively, in the following
1228 character).  In the case of function definitions, a K&R-style list of
1229 arguments followed by their declarations is also provided, inside
1230 comments, after the declaration.
1232 @item -fno-asm
1233 @opindex fno-asm
1234 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1235 keyword, so that code can use these words as identifiers.  You can use
1236 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1237 instead.  @option{-ansi} implies @option{-fno-asm}.
1239 In C++, this switch only affects the @code{typeof} keyword, since
1240 @code{asm} and @code{inline} are standard keywords.  You may want to
1241 use the @option{-fno-gnu-keywords} flag instead, which has the same
1242 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1243 switch only affects the @code{asm} and @code{typeof} keywords, since
1244 @code{inline} is a standard keyword in ISO C99.
1246 @item -fno-builtin
1247 @itemx -fno-builtin-@var{function}
1248 @opindex fno-builtin
1249 @cindex built-in functions
1250 Don't recognize built-in functions that do not begin with
1251 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1252 functions provided by GCC}, for details of the functions affected,
1253 including those which are not built-in functions when @option{-ansi} or
1254 @option{-std} options for strict ISO C conformance are used because they
1255 do not have an ISO standard meaning.
1257 GCC normally generates special code to handle certain built-in functions
1258 more efficiently; for instance, calls to @code{alloca} may become single
1259 instructions that adjust the stack directly, and calls to @code{memcpy}
1260 may become inline copy loops.  The resulting code is often both smaller
1261 and faster, but since the function calls no longer appear as such, you
1262 cannot set a breakpoint on those calls, nor can you change the behavior
1263 of the functions by linking with a different library.  In addition,
1264 when a function is recognized as a built-in function, GCC may use
1265 information about that function to warn about problems with calls to
1266 that function, or to generate more efficient code, even if the
1267 resulting code still contains calls to that function.  For example,
1268 warnings are given with @option{-Wformat} for bad calls to
1269 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1270 known not to modify global memory.
1272 With the @option{-fno-builtin-@var{function}} option
1273 only the built-in function @var{function} is
1274 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1275 function is named this is not built-in in this version of GCC, this
1276 option is ignored.  There is no corresponding
1277 @option{-fbuiltin-@var{function}} option; if you wish to enable
1278 built-in functions selectively when using @option{-fno-builtin} or
1279 @option{-ffreestanding}, you may define macros such as:
1281 @smallexample
1282 #define abs(n)          __builtin_abs ((n))
1283 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1284 @end smallexample
1286 @item -fhosted
1287 @opindex fhosted
1288 @cindex hosted environment
1290 Assert that compilation takes place in a hosted environment.  This implies
1291 @option{-fbuiltin}.  A hosted environment is one in which the
1292 entire standard library is available, and in which @code{main} has a return
1293 type of @code{int}.  Examples are nearly everything except a kernel.
1294 This is equivalent to @option{-fno-freestanding}.
1296 @item -ffreestanding
1297 @opindex ffreestanding
1298 @cindex hosted environment
1300 Assert that compilation takes place in a freestanding environment.  This
1301 implies @option{-fno-builtin}.  A freestanding environment
1302 is one in which the standard library may not exist, and program startup may
1303 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1304 This is equivalent to @option{-fno-hosted}.
1306 @xref{Standards,,Language Standards Supported by GCC}, for details of
1307 freestanding and hosted environments.
1309 @item -fms-extensions
1310 @opindex fms-extensions
1311 Accept some non-standard constructs used in Microsoft header files.
1313 Some cases of unnamed fields in structures and unions are only
1314 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1315 fields within structs/unions}, for details.
1317 @item -trigraphs
1318 @opindex trigraphs
1319 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1320 options for strict ISO C conformance) implies @option{-trigraphs}.
1322 @item -no-integrated-cpp
1323 @opindex no-integrated-cpp
1324 Performs a compilation in two passes: preprocessing and compiling.  This
1325 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1326 @option{-B} option.  The user supplied compilation step can then add in
1327 an additional preprocessing step after normal preprocessing but before
1328 compiling.  The default is to use the integrated cpp (internal cpp)
1330 The semantics of this option will change if "cc1", "cc1plus", and
1331 "cc1obj" are merged.
1333 @cindex traditional C language
1334 @cindex C language, traditional
1335 @item -traditional
1336 @itemx -traditional-cpp
1337 @opindex traditional-cpp
1338 @opindex traditional
1339 Formerly, these options caused GCC to attempt to emulate a pre-standard
1340 C compiler.  They are now only supported with the @option{-E} switch.
1341 The preprocessor continues to support a pre-standard mode.  See the GNU
1342 CPP manual for details.
1344 @item -fcond-mismatch
1345 @opindex fcond-mismatch
1346 Allow conditional expressions with mismatched types in the second and
1347 third arguments.  The value of such an expression is void.  This option
1348 is not supported for C++.
1350 @item -funsigned-char
1351 @opindex funsigned-char
1352 Let the type @code{char} be unsigned, like @code{unsigned char}.
1354 Each kind of machine has a default for what @code{char} should
1355 be.  It is either like @code{unsigned char} by default or like
1356 @code{signed char} by default.
1358 Ideally, a portable program should always use @code{signed char} or
1359 @code{unsigned char} when it depends on the signedness of an object.
1360 But many programs have been written to use plain @code{char} and
1361 expect it to be signed, or expect it to be unsigned, depending on the
1362 machines they were written for.  This option, and its inverse, let you
1363 make such a program work with the opposite default.
1365 The type @code{char} is always a distinct type from each of
1366 @code{signed char} or @code{unsigned char}, even though its behavior
1367 is always just like one of those two.
1369 @item -fsigned-char
1370 @opindex fsigned-char
1371 Let the type @code{char} be signed, like @code{signed char}.
1373 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1374 the negative form of @option{-funsigned-char}.  Likewise, the option
1375 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1377 @item -fsigned-bitfields
1378 @itemx -funsigned-bitfields
1379 @itemx -fno-signed-bitfields
1380 @itemx -fno-unsigned-bitfields
1381 @opindex fsigned-bitfields
1382 @opindex funsigned-bitfields
1383 @opindex fno-signed-bitfields
1384 @opindex fno-unsigned-bitfields
1385 These options control whether a bit-field is signed or unsigned, when the
1386 declaration does not use either @code{signed} or @code{unsigned}.  By
1387 default, such a bit-field is signed, because this is consistent: the
1388 basic integer types such as @code{int} are signed types.
1389 @end table
1391 @node C++ Dialect Options
1392 @section Options Controlling C++ Dialect
1394 @cindex compiler options, C++
1395 @cindex C++ options, command line
1396 @cindex options, C++
1397 This section describes the command-line options that are only meaningful
1398 for C++ programs; but you can also use most of the GNU compiler options
1399 regardless of what language your program is in.  For example, you
1400 might compile a file @code{firstClass.C} like this:
1402 @smallexample
1403 g++ -g -frepo -O -c firstClass.C
1404 @end smallexample
1406 @noindent
1407 In this example, only @option{-frepo} is an option meant
1408 only for C++ programs; you can use the other options with any
1409 language supported by GCC@.
1411 Here is a list of options that are @emph{only} for compiling C++ programs:
1413 @table @gcctabopt
1415 @item -fabi-version=@var{n}
1416 @opindex fabi-version
1417 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1418 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1419 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1420 the version that conforms most closely to the C++ ABI specification.
1421 Therefore, the ABI obtained using version 0 will change as ABI bugs
1422 are fixed.
1424 The default is version 2.
1426 @item -fno-access-control
1427 @opindex fno-access-control
1428 Turn off all access checking.  This switch is mainly useful for working
1429 around bugs in the access control code.
1431 @item -fcheck-new
1432 @opindex fcheck-new
1433 Check that the pointer returned by @code{operator new} is non-null
1434 before attempting to modify the storage allocated.  This check is
1435 normally unnecessary because the C++ standard specifies that
1436 @code{operator new} will only return @code{0} if it is declared
1437 @samp{throw()}, in which case the compiler will always check the
1438 return value even without this option.  In all other cases, when
1439 @code{operator new} has a non-empty exception specification, memory
1440 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1441 @samp{new (nothrow)}.
1443 @item -fconserve-space
1444 @opindex fconserve-space
1445 Put uninitialized or runtime-initialized global variables into the
1446 common segment, as C does.  This saves space in the executable at the
1447 cost of not diagnosing duplicate definitions.  If you compile with this
1448 flag and your program mysteriously crashes after @code{main()} has
1449 completed, you may have an object that is being destroyed twice because
1450 two definitions were merged.
1452 This option is no longer useful on most targets, now that support has
1453 been added for putting variables into BSS without making them common.
1455 @item -ffriend-injection
1456 @opindex ffriend-injection
1457 Inject friend functions into the enclosing namespace, so that they are
1458 visible outside the scope of the class in which they are declared.
1459 Friend functions were documented to work this way in the old Annotated
1460 C++ Reference Manual, and versions of G++ before 4.1 always worked
1461 that way.  However, in ISO C++ a friend function which is not declared
1462 in an enclosing scope can only be found using argument dependent
1463 lookup.  This option causes friends to be injected as they were in
1464 earlier releases.
1466 This option is for compatibility, and may be removed in a future
1467 release of G++.
1469 @item -fno-const-strings
1470 @opindex fno-const-strings
1471 Give string constants type @code{char *} instead of type @code{const
1472 char *}.  By default, G++ uses type @code{const char *} as required by
1473 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1474 actually modify the value of a string constant.
1476 This option might be removed in a future release of G++.  For maximum
1477 portability, you should structure your code so that it works with
1478 string constants that have type @code{const char *}.
1480 @item -fno-elide-constructors
1481 @opindex fno-elide-constructors
1482 The C++ standard allows an implementation to omit creating a temporary
1483 which is only used to initialize another object of the same type.
1484 Specifying this option disables that optimization, and forces G++ to
1485 call the copy constructor in all cases.
1487 @item -fno-enforce-eh-specs
1488 @opindex fno-enforce-eh-specs
1489 Don't generate code to check for violation of exception specifications
1490 at runtime.  This option violates the C++ standard, but may be useful
1491 for reducing code size in production builds, much like defining
1492 @samp{NDEBUG}.  This does not give user code permission to throw
1493 exceptions in violation of the exception specifications; the compiler
1494 will still optimize based on the specifications, so throwing an
1495 unexpected exception will result in undefined behavior.
1497 @item -ffor-scope
1498 @itemx -fno-for-scope
1499 @opindex ffor-scope
1500 @opindex fno-for-scope
1501 If @option{-ffor-scope} is specified, the scope of variables declared in
1502 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1503 as specified by the C++ standard.
1504 If @option{-fno-for-scope} is specified, the scope of variables declared in
1505 a @i{for-init-statement} extends to the end of the enclosing scope,
1506 as was the case in old versions of G++, and other (traditional)
1507 implementations of C++.
1509 The default if neither flag is given to follow the standard,
1510 but to allow and give a warning for old-style code that would
1511 otherwise be invalid, or have different behavior.
1513 @item -fno-gnu-keywords
1514 @opindex fno-gnu-keywords
1515 Do not recognize @code{typeof} as a keyword, so that code can use this
1516 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1517 @option{-ansi} implies @option{-fno-gnu-keywords}.
1519 @item -fno-implicit-templates
1520 @opindex fno-implicit-templates
1521 Never emit code for non-inline templates which are instantiated
1522 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1523 @xref{Template Instantiation}, for more information.
1525 @item -fno-implicit-inline-templates
1526 @opindex fno-implicit-inline-templates
1527 Don't emit code for implicit instantiations of inline templates, either.
1528 The default is to handle inlines differently so that compiles with and
1529 without optimization will need the same set of explicit instantiations.
1531 @item -fno-implement-inlines
1532 @opindex fno-implement-inlines
1533 To save space, do not emit out-of-line copies of inline functions
1534 controlled by @samp{#pragma implementation}.  This will cause linker
1535 errors if these functions are not inlined everywhere they are called.
1537 @item -fms-extensions
1538 @opindex fms-extensions
1539 Disable pedantic warnings about constructs used in MFC, such as implicit
1540 int and getting a pointer to member function via non-standard syntax.
1542 @item -fno-nonansi-builtins
1543 @opindex fno-nonansi-builtins
1544 Disable built-in declarations of functions that are not mandated by
1545 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1546 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1548 @item -fno-operator-names
1549 @opindex fno-operator-names
1550 Do not treat the operator name keywords @code{and}, @code{bitand},
1551 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1552 synonyms as keywords.
1554 @item -fno-optional-diags
1555 @opindex fno-optional-diags
1556 Disable diagnostics that the standard says a compiler does not need to
1557 issue.  Currently, the only such diagnostic issued by G++ is the one for
1558 a name having multiple meanings within a class.
1560 @item -fpermissive
1561 @opindex fpermissive
1562 Downgrade some diagnostics about nonconformant code from errors to
1563 warnings.  Thus, using @option{-fpermissive} will allow some
1564 nonconforming code to compile.
1566 @item -frepo
1567 @opindex frepo
1568 Enable automatic template instantiation at link time.  This option also
1569 implies @option{-fno-implicit-templates}.  @xref{Template
1570 Instantiation}, for more information.
1572 @item -fno-rtti
1573 @opindex fno-rtti
1574 Disable generation of information about every class with virtual
1575 functions for use by the C++ runtime type identification features
1576 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1577 of the language, you can save some space by using this flag.  Note that
1578 exception handling uses the same information, but it will generate it as
1579 needed.
1581 @item -fstats
1582 @opindex fstats
1583 Emit statistics about front-end processing at the end of the compilation.
1584 This information is generally only useful to the G++ development team.
1586 @item -ftemplate-depth-@var{n}
1587 @opindex ftemplate-depth
1588 Set the maximum instantiation depth for template classes to @var{n}.
1589 A limit on the template instantiation depth is needed to detect
1590 endless recursions during template class instantiation.  ANSI/ISO C++
1591 conforming programs must not rely on a maximum depth greater than 17.
1593 @item -fno-threadsafe-statics
1594 @opindex fno-threadsafe-statics
1595 Do not emit the extra code to use the routines specified in the C++
1596 ABI for thread-safe initialization of local statics.  You can use this
1597 option to reduce code size slightly in code that doesn't need to be
1598 thread-safe.
1600 @item -fuse-cxa-atexit
1601 @opindex fuse-cxa-atexit
1602 Register destructors for objects with static storage duration with the
1603 @code{__cxa_atexit} function rather than the @code{atexit} function.
1604 This option is required for fully standards-compliant handling of static
1605 destructors, but will only work if your C library supports
1606 @code{__cxa_atexit}.
1608 @item -fvisibility-inlines-hidden
1609 @opindex fvisibility-inlines-hidden
1610 Causes all inlined methods to be marked with
1611 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1612 appear in the export table of a DSO and do not require a PLT indirection
1613 when used within the DSO@.  Enabling this option can have a dramatic effect
1614 on load and link times of a DSO as it massively reduces the size of the
1615 dynamic export table when the library makes heavy use of templates.  While
1616 it can cause bloating through duplication of code within each DSO where
1617 it is used, often the wastage is less than the considerable space occupied
1618 by a long symbol name in the export table which is typical when using
1619 templates and namespaces.  For even more savings, combine with the
1620 @option{-fvisibility=hidden} switch.
1622 @item -fno-weak
1623 @opindex fno-weak
1624 Do not use weak symbol support, even if it is provided by the linker.
1625 By default, G++ will use weak symbols if they are available.  This
1626 option exists only for testing, and should not be used by end-users;
1627 it will result in inferior code and has no benefits.  This option may
1628 be removed in a future release of G++.
1630 @item -nostdinc++
1631 @opindex nostdinc++
1632 Do not search for header files in the standard directories specific to
1633 C++, but do still search the other standard directories.  (This option
1634 is used when building the C++ library.)
1635 @end table
1637 In addition, these optimization, warning, and code generation options
1638 have meanings only for C++ programs:
1640 @table @gcctabopt
1641 @item -fno-default-inline
1642 @opindex fno-default-inline
1643 Do not assume @samp{inline} for functions defined inside a class scope.
1644 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1645 functions will have linkage like inline functions; they just won't be
1646 inlined by default.
1648 @item -Wabi @r{(C++ only)}
1649 @opindex Wabi
1650 Warn when G++ generates code that is probably not compatible with the
1651 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1652 all such cases, there are probably some cases that are not warned about,
1653 even though G++ is generating incompatible code.  There may also be
1654 cases where warnings are emitted even though the code that is generated
1655 will be compatible.
1657 You should rewrite your code to avoid these warnings if you are
1658 concerned about the fact that code generated by G++ may not be binary
1659 compatible with code generated by other compilers.
1661 The known incompatibilities at this point include:
1663 @itemize @bullet
1665 @item
1666 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1667 pack data into the same byte as a base class.  For example:
1669 @smallexample
1670 struct A @{ virtual void f(); int f1 : 1; @};
1671 struct B : public A @{ int f2 : 1; @};
1672 @end smallexample
1674 @noindent
1675 In this case, G++ will place @code{B::f2} into the same byte
1676 as@code{A::f1}; other compilers will not.  You can avoid this problem
1677 by explicitly padding @code{A} so that its size is a multiple of the
1678 byte size on your platform; that will cause G++ and other compilers to
1679 layout @code{B} identically.
1681 @item
1682 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1683 tail padding when laying out virtual bases.  For example:
1685 @smallexample
1686 struct A @{ virtual void f(); char c1; @};
1687 struct B @{ B(); char c2; @};
1688 struct C : public A, public virtual B @{@};
1689 @end smallexample
1691 @noindent
1692 In this case, G++ will not place @code{B} into the tail-padding for
1693 @code{A}; other compilers will.  You can avoid this problem by
1694 explicitly padding @code{A} so that its size is a multiple of its
1695 alignment (ignoring virtual base classes); that will cause G++ and other
1696 compilers to layout @code{C} identically.
1698 @item
1699 Incorrect handling of bit-fields with declared widths greater than that
1700 of their underlying types, when the bit-fields appear in a union.  For
1701 example:
1703 @smallexample
1704 union U @{ int i : 4096; @};
1705 @end smallexample
1707 @noindent
1708 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1709 union too small by the number of bits in an @code{int}.
1711 @item
1712 Empty classes can be placed at incorrect offsets.  For example:
1714 @smallexample
1715 struct A @{@};
1717 struct B @{
1718   A a;
1719   virtual void f ();
1722 struct C : public B, public A @{@};
1723 @end smallexample
1725 @noindent
1726 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1727 it should be placed at offset zero.  G++ mistakenly believes that the
1728 @code{A} data member of @code{B} is already at offset zero.
1730 @item
1731 Names of template functions whose types involve @code{typename} or
1732 template template parameters can be mangled incorrectly.
1734 @smallexample
1735 template <typename Q>
1736 void f(typename Q::X) @{@}
1738 template <template <typename> class Q>
1739 void f(typename Q<int>::X) @{@}
1740 @end smallexample
1742 @noindent
1743 Instantiations of these templates may be mangled incorrectly.
1745 @end itemize
1747 @item -Wctor-dtor-privacy @r{(C++ only)}
1748 @opindex Wctor-dtor-privacy
1749 Warn when a class seems unusable because all the constructors or
1750 destructors in that class are private, and it has neither friends nor
1751 public static member functions.
1753 @item -Wnon-virtual-dtor @r{(C++ only)}
1754 @opindex Wnon-virtual-dtor
1755 Warn when a class appears to be polymorphic, thereby requiring a virtual
1756 destructor, yet it declares a non-virtual one.
1757 This warning is enabled by @option{-Wall}.
1759 @item -Wreorder @r{(C++ only)}
1760 @opindex Wreorder
1761 @cindex reordering, warning
1762 @cindex warning for reordering of member initializers
1763 Warn when the order of member initializers given in the code does not
1764 match the order in which they must be executed.  For instance:
1766 @smallexample
1767 struct A @{
1768   int i;
1769   int j;
1770   A(): j (0), i (1) @{ @}
1772 @end smallexample
1774 The compiler will rearrange the member initializers for @samp{i}
1775 and @samp{j} to match the declaration order of the members, emitting
1776 a warning to that effect.  This warning is enabled by @option{-Wall}.
1777 @end table
1779 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1781 @table @gcctabopt
1782 @item -Weffc++ @r{(C++ only)}
1783 @opindex Weffc++
1784 Warn about violations of the following style guidelines from Scott Meyers'
1785 @cite{Effective C++} book:
1787 @itemize @bullet
1788 @item
1789 Item 11:  Define a copy constructor and an assignment operator for classes
1790 with dynamically allocated memory.
1792 @item
1793 Item 12:  Prefer initialization to assignment in constructors.
1795 @item
1796 Item 14:  Make destructors virtual in base classes.
1798 @item
1799 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1801 @item
1802 Item 23:  Don't try to return a reference when you must return an object.
1804 @end itemize
1806 Also warn about violations of the following style guidelines from
1807 Scott Meyers' @cite{More Effective C++} book:
1809 @itemize @bullet
1810 @item
1811 Item 6:  Distinguish between prefix and postfix forms of increment and
1812 decrement operators.
1814 @item
1815 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1817 @end itemize
1819 When selecting this option, be aware that the standard library
1820 headers do not obey all of these guidelines; use @samp{grep -v}
1821 to filter out those warnings.
1823 @item -Wno-deprecated @r{(C++ only)}
1824 @opindex Wno-deprecated
1825 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1827 @item -Wstrict-null-sentinel @r{(C++ only)}
1828 @opindex Wstrict-null-sentinel
1829 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1830 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1831 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1832 it is guaranteed to of the same size as a pointer.  But this use is
1833 not portable across different compilers.
1835 @item -Wno-non-template-friend @r{(C++ only)}
1836 @opindex Wno-non-template-friend
1837 Disable warnings when non-templatized friend functions are declared
1838 within a template.  Since the advent of explicit template specification
1839 support in G++, if the name of the friend is an unqualified-id (i.e.,
1840 @samp{friend foo(int)}), the C++ language specification demands that the
1841 friend declare or define an ordinary, nontemplate function.  (Section
1842 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1843 could be interpreted as a particular specialization of a templatized
1844 function.  Because this non-conforming behavior is no longer the default
1845 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1846 check existing code for potential trouble spots and is on by default.
1847 This new compiler behavior can be turned off with
1848 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1849 but disables the helpful warning.
1851 @item -Wold-style-cast @r{(C++ only)}
1852 @opindex Wold-style-cast
1853 Warn if an old-style (C-style) cast to a non-void type is used within
1854 a C++ program.  The new-style casts (@samp{dynamic_cast},
1855 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1856 less vulnerable to unintended effects and much easier to search for.
1858 @item -Woverloaded-virtual @r{(C++ only)}
1859 @opindex Woverloaded-virtual
1860 @cindex overloaded virtual fn, warning
1861 @cindex warning for overloaded virtual fn
1862 Warn when a function declaration hides virtual functions from a
1863 base class.  For example, in:
1865 @smallexample
1866 struct A @{
1867   virtual void f();
1870 struct B: public A @{
1871   void f(int);
1873 @end smallexample
1875 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1876 like:
1878 @smallexample
1879 B* b;
1880 b->f();
1881 @end smallexample
1883 will fail to compile.
1885 @item -Wno-pmf-conversions @r{(C++ only)}
1886 @opindex Wno-pmf-conversions
1887 Disable the diagnostic for converting a bound pointer to member function
1888 to a plain pointer.
1890 @item -Wsign-promo @r{(C++ only)}
1891 @opindex Wsign-promo
1892 Warn when overload resolution chooses a promotion from unsigned or
1893 enumerated type to a signed type, over a conversion to an unsigned type of
1894 the same size.  Previous versions of G++ would try to preserve
1895 unsignedness, but the standard mandates the current behavior.
1897 @smallexample
1898 struct A @{
1899   operator int ();
1900   A& operator = (int);
1903 main ()
1905   A a,b;
1906   a = b;
1908 @end smallexample
1910 In this example, G++ will synthesize a default @samp{A& operator =
1911 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1912 @end table
1914 @node Objective-C and Objective-C++ Dialect Options
1915 @section Options Controlling Objective-C and Objective-C++ Dialects
1917 @cindex compiler options, Objective-C and Objective-C++
1918 @cindex Objective-C and Objective-C++ options, command line
1919 @cindex options, Objective-C and Objective-C++
1920 (NOTE: This manual does not describe the Objective-C and Objective-C++
1921 languages themselves.  See @xref{Standards,,Language Standards
1922 Supported by GCC}, for references.)
1924 This section describes the command-line options that are only meaningful
1925 for Objective-C and Objective-C++ programs, but you can also use most of
1926 the language-independent GNU compiler options.
1927 For example, you might compile a file @code{some_class.m} like this:
1929 @smallexample
1930 gcc -g -fgnu-runtime -O -c some_class.m
1931 @end smallexample
1933 @noindent
1934 In this example, @option{-fgnu-runtime} is an option meant only for
1935 Objective-C and Objective-C++ programs; you can use the other options with
1936 any language supported by GCC@.
1938 Note that since Objective-C is an extension of the C language, Objective-C
1939 compilations may also use options specific to the C front-end (e.g.,
1940 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1941 C++-specific options (e.g., @option{-Wabi}).
1943 Here is a list of options that are @emph{only} for compiling Objective-C
1944 and Objective-C++ programs:
1946 @table @gcctabopt
1947 @item -fconstant-string-class=@var{class-name}
1948 @opindex fconstant-string-class
1949 Use @var{class-name} as the name of the class to instantiate for each
1950 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1951 class name is @code{NXConstantString} if the GNU runtime is being used, and
1952 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1953 @option{-fconstant-cfstrings} option, if also present, will override the
1954 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1955 to be laid out as constant CoreFoundation strings.
1957 @item -fgnu-runtime
1958 @opindex fgnu-runtime
1959 Generate object code compatible with the standard GNU Objective-C
1960 runtime.  This is the default for most types of systems.
1962 @item -fnext-runtime
1963 @opindex fnext-runtime
1964 Generate output compatible with the NeXT runtime.  This is the default
1965 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1966 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1967 used.
1969 @item -fno-nil-receivers
1970 @opindex fno-nil-receivers
1971 Assume that all Objective-C message dispatches (e.g.,
1972 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1973 is not @code{nil}.  This allows for more efficient entry points in the runtime
1974 to be used.  Currently, this option is only available in conjunction with
1975 the NeXT runtime on Mac OS X 10.3 and later.
1977 @item -fobjc-call-cxx-cdtors
1978 @opindex fobjc-call-cxx-cdtors
1979 For each Objective-C class, check if any of its instance variables is a
1980 C++ object with a non-trivial default constructor.  If so, synthesize a
1981 special @code{- (id) .cxx_construct} instance method that will run
1982 non-trivial default constructors on any such instance variables, in order,
1983 and then return @code{self}.  Similarly, check if any instance variable
1984 is a C++ object with a non-trivial destructor, and if so, synthesize a
1985 special @code{- (void) .cxx_destruct} method that will run
1986 all such default destructors, in reverse order.
1988 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1989 thusly generated will only operate on instance variables declared in the
1990 current Objective-C class, and not those inherited from superclasses.  It
1991 is the responsibility of the Objective-C runtime to invoke all such methods
1992 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1993 will be invoked by the runtime immediately after a new object
1994 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1995 be invoked immediately before the runtime deallocates an object instance.
1997 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1998 support for invoking the @code{- (id) .cxx_construct} and
1999 @code{- (void) .cxx_destruct} methods.
2001 @item -fobjc-direct-dispatch
2002 @opindex fobjc-direct-dispatch
2003 Allow fast jumps to the message dispatcher.  On Darwin this is
2004 accomplished via the comm page.
2006 @item -fobjc-exceptions
2007 @opindex fobjc-exceptions
2008 Enable syntactic support for structured exception handling in Objective-C,
2009 similar to what is offered by C++ and Java.  Currently, this option is only
2010 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
2012 @smallexample
2013   @@try @{
2014     @dots{}
2015        @@throw expr;
2016     @dots{}
2017   @}
2018   @@catch (AnObjCClass *exc) @{
2019     @dots{}
2020       @@throw expr;
2021     @dots{}
2022       @@throw;
2023     @dots{}
2024   @}
2025   @@catch (AnotherClass *exc) @{
2026     @dots{}
2027   @}
2028   @@catch (id allOthers) @{
2029     @dots{}
2030   @}
2031   @@finally @{
2032     @dots{}
2033       @@throw expr;
2034     @dots{}
2035   @}
2036 @end smallexample
2038 The @code{@@throw} statement may appear anywhere in an Objective-C or
2039 Objective-C++ program; when used inside of a @code{@@catch} block, the
2040 @code{@@throw} may appear without an argument (as shown above), in which case
2041 the object caught by the @code{@@catch} will be rethrown.
2043 Note that only (pointers to) Objective-C objects may be thrown and
2044 caught using this scheme.  When an object is thrown, it will be caught
2045 by the nearest @code{@@catch} clause capable of handling objects of that type,
2046 analogously to how @code{catch} blocks work in C++ and Java.  A
2047 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2048 any and all Objective-C exceptions not caught by previous @code{@@catch}
2049 clauses (if any).
2051 The @code{@@finally} clause, if present, will be executed upon exit from the
2052 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2053 regardless of whether any exceptions are thrown, caught or rethrown
2054 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2055 of the @code{finally} clause in Java.
2057 There are several caveats to using the new exception mechanism:
2059 @itemize @bullet
2060 @item
2061 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2062 idioms provided by the @code{NSException} class, the new
2063 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2064 systems, due to additional functionality needed in the (NeXT) Objective-C
2065 runtime.
2067 @item
2068 As mentioned above, the new exceptions do not support handling
2069 types other than Objective-C objects.   Furthermore, when used from
2070 Objective-C++, the Objective-C exception model does not interoperate with C++
2071 exceptions at this time.  This means you cannot @code{@@throw} an exception
2072 from Objective-C and @code{catch} it in C++, or vice versa
2073 (i.e., @code{throw @dots{} @@catch}).
2074 @end itemize
2076 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2077 blocks for thread-safe execution:
2079 @smallexample
2080   @@synchronized (ObjCClass *guard) @{
2081     @dots{}
2082   @}
2083 @end smallexample
2085 Upon entering the @code{@@synchronized} block, a thread of execution shall
2086 first check whether a lock has been placed on the corresponding @code{guard}
2087 object by another thread.  If it has, the current thread shall wait until
2088 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2089 the current thread will place its own lock on it, execute the code contained in
2090 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2091 making @code{guard} available to other threads).
2093 Unlike Java, Objective-C does not allow for entire methods to be marked
2094 @code{@@synchronized}.  Note that throwing exceptions out of
2095 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2096 to be unlocked properly.
2098 @item -fobjc-gc
2099 @opindex fobjc-gc
2100 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2102 @item -freplace-objc-classes
2103 @opindex freplace-objc-classes
2104 Emit a special marker instructing @command{ld(1)} not to statically link in
2105 the resulting object file, and allow @command{dyld(1)} to load it in at
2106 run time instead.  This is used in conjunction with the Fix-and-Continue
2107 debugging mode, where the object file in question may be recompiled and
2108 dynamically reloaded in the course of program execution, without the need
2109 to restart the program itself.  Currently, Fix-and-Continue functionality
2110 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2111 and later.
2113 @item -fzero-link
2114 @opindex fzero-link
2115 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2116 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2117 compile time) with static class references that get initialized at load time,
2118 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2119 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2120 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2121 for individual class implementations to be modified during program execution.
2123 @item -gen-decls
2124 @opindex gen-decls
2125 Dump interface declarations for all classes seen in the source file to a
2126 file named @file{@var{sourcename}.decl}.
2128 @item -Wassign-intercept
2129 @opindex Wassign-intercept
2130 Warn whenever an Objective-C assignment is being intercepted by the
2131 garbage collector.
2133 @item -Wno-protocol
2134 @opindex Wno-protocol
2135 If a class is declared to implement a protocol, a warning is issued for
2136 every method in the protocol that is not implemented by the class.  The
2137 default behavior is to issue a warning for every method not explicitly
2138 implemented in the class, even if a method implementation is inherited
2139 from the superclass.  If you use the @option{-Wno-protocol} option, then
2140 methods inherited from the superclass are considered to be implemented,
2141 and no warning is issued for them.
2143 @item -Wselector
2144 @opindex Wselector
2145 Warn if multiple methods of different types for the same selector are
2146 found during compilation.  The check is performed on the list of methods
2147 in the final stage of compilation.  Additionally, a check is performed
2148 for each selector appearing in a @code{@@selector(@dots{})}
2149 expression, and a corresponding method for that selector has been found
2150 during compilation.  Because these checks scan the method table only at
2151 the end of compilation, these warnings are not produced if the final
2152 stage of compilation is not reached, for example because an error is
2153 found during compilation, or because the @option{-fsyntax-only} option is
2154 being used.
2156 @item -Wstrict-selector-match
2157 @opindex Wstrict-selector-match
2158 Warn if multiple methods with differing argument and/or return types are
2159 found for a given selector when attempting to send a message using this
2160 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2161 is off (which is the default behavior), the compiler will omit such warnings
2162 if any differences found are confined to types which share the same size
2163 and alignment.
2165 @item -Wundeclared-selector
2166 @opindex Wundeclared-selector
2167 Warn if a @code{@@selector(@dots{})} expression referring to an
2168 undeclared selector is found.  A selector is considered undeclared if no
2169 method with that name has been declared before the
2170 @code{@@selector(@dots{})} expression, either explicitly in an
2171 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2172 an @code{@@implementation} section.  This option always performs its
2173 checks as soon as a @code{@@selector(@dots{})} expression is found,
2174 while @option{-Wselector} only performs its checks in the final stage of
2175 compilation.  This also enforces the coding style convention
2176 that methods and selectors must be declared before being used.
2178 @item -print-objc-runtime-info
2179 @opindex print-objc-runtime-info
2180 Generate C header describing the largest structure that is passed by
2181 value, if any.
2183 @end table
2185 @node Language Independent Options
2186 @section Options to Control Diagnostic Messages Formatting
2187 @cindex options to control diagnostics formatting
2188 @cindex diagnostic messages
2189 @cindex message formatting
2191 Traditionally, diagnostic messages have been formatted irrespective of
2192 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2193 below can be used to control the diagnostic messages formatting
2194 algorithm, e.g.@: how many characters per line, how often source location
2195 information should be reported.  Right now, only the C++ front end can
2196 honor these options.  However it is expected, in the near future, that
2197 the remaining front ends would be able to digest them correctly.
2199 @table @gcctabopt
2200 @item -fmessage-length=@var{n}
2201 @opindex fmessage-length
2202 Try to format error messages so that they fit on lines of about @var{n}
2203 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2204 the front ends supported by GCC@.  If @var{n} is zero, then no
2205 line-wrapping will be done; each error message will appear on a single
2206 line.
2208 @opindex fdiagnostics-show-location
2209 @item -fdiagnostics-show-location=once
2210 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2211 reporter to emit @emph{once} source location information; that is, in
2212 case the message is too long to fit on a single physical line and has to
2213 be wrapped, the source location won't be emitted (as prefix) again,
2214 over and over, in subsequent continuation lines.  This is the default
2215 behavior.
2217 @item -fdiagnostics-show-location=every-line
2218 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2219 messages reporter to emit the same source location information (as
2220 prefix) for physical lines that result from the process of breaking
2221 a message which is too long to fit on a single line.
2223 @item -fdiagnostics-show-options
2224 @opindex fdiagnostics-show-options
2225 This option instructs the diagnostic machinery to add text to each
2226 diagnostic emitted, which indicates which command line option directly
2227 controls that diagnostic, when such an option is known to the
2228 diagnostic machinery.
2230 @end table
2232 @node Warning Options
2233 @section Options to Request or Suppress Warnings
2234 @cindex options to control warnings
2235 @cindex warning messages
2236 @cindex messages, warning
2237 @cindex suppressing warnings
2239 Warnings are diagnostic messages that report constructions which
2240 are not inherently erroneous but which are risky or suggest there
2241 may have been an error.
2243 You can request many specific warnings with options beginning @samp{-W},
2244 for example @option{-Wimplicit} to request warnings on implicit
2245 declarations.  Each of these specific warning options also has a
2246 negative form beginning @samp{-Wno-} to turn off warnings;
2247 for example, @option{-Wno-implicit}.  This manual lists only one of the
2248 two forms, whichever is not the default.
2250 The following options control the amount and kinds of warnings produced
2251 by GCC; for further, language-specific options also refer to
2252 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2253 Options}.
2255 @table @gcctabopt
2256 @cindex syntax checking
2257 @item -fsyntax-only
2258 @opindex fsyntax-only
2259 Check the code for syntax errors, but don't do anything beyond that.
2261 @item -pedantic
2262 @opindex pedantic
2263 Issue all the warnings demanded by strict ISO C and ISO C++;
2264 reject all programs that use forbidden extensions, and some other
2265 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2266 version of the ISO C standard specified by any @option{-std} option used.
2268 Valid ISO C and ISO C++ programs should compile properly with or without
2269 this option (though a rare few will require @option{-ansi} or a
2270 @option{-std} option specifying the required version of ISO C)@.  However,
2271 without this option, certain GNU extensions and traditional C and C++
2272 features are supported as well.  With this option, they are rejected.
2274 @option{-pedantic} does not cause warning messages for use of the
2275 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2276 warnings are also disabled in the expression that follows
2277 @code{__extension__}.  However, only system header files should use
2278 these escape routes; application programs should avoid them.
2279 @xref{Alternate Keywords}.
2281 Some users try to use @option{-pedantic} to check programs for strict ISO
2282 C conformance.  They soon find that it does not do quite what they want:
2283 it finds some non-ISO practices, but not all---only those for which
2284 ISO C @emph{requires} a diagnostic, and some others for which
2285 diagnostics have been added.
2287 A feature to report any failure to conform to ISO C might be useful in
2288 some instances, but would require considerable additional work and would
2289 be quite different from @option{-pedantic}.  We don't have plans to
2290 support such a feature in the near future.
2292 Where the standard specified with @option{-std} represents a GNU
2293 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2294 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2295 extended dialect is based.  Warnings from @option{-pedantic} are given
2296 where they are required by the base standard.  (It would not make sense
2297 for such warnings to be given only for features not in the specified GNU
2298 C dialect, since by definition the GNU dialects of C include all
2299 features the compiler supports with the given option, and there would be
2300 nothing to warn about.)
2302 @item -pedantic-errors
2303 @opindex pedantic-errors
2304 Like @option{-pedantic}, except that errors are produced rather than
2305 warnings.
2307 @item -w
2308 @opindex w
2309 Inhibit all warning messages.
2311 @item -Wno-import
2312 @opindex Wno-import
2313 Inhibit warning messages about the use of @samp{#import}.
2315 @item -Wchar-subscripts
2316 @opindex Wchar-subscripts
2317 Warn if an array subscript has type @code{char}.  This is a common cause
2318 of error, as programmers often forget that this type is signed on some
2319 machines.
2320 This warning is enabled by @option{-Wall}.
2322 @item -Wcomment
2323 @opindex Wcomment
2324 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2325 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2326 This warning is enabled by @option{-Wall}.
2328 @item -Wfatal-errors
2329 @opindex Wfatal-errors
2330 This option causes the compiler to abort compilation on the first error
2331 occurred rather than trying to keep going and printing further error
2332 messages.
2334 @item -Wformat
2335 @opindex Wformat
2336 @opindex ffreestanding
2337 @opindex fno-builtin
2338 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2339 the arguments supplied have types appropriate to the format string
2340 specified, and that the conversions specified in the format string make
2341 sense.  This includes standard functions, and others specified by format
2342 attributes (@pxref{Function Attributes}), in the @code{printf},
2343 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2344 not in the C standard) families (or other target-specific families).
2345 Which functions are checked without format attributes having been
2346 specified depends on the standard version selected, and such checks of
2347 functions without the attribute specified are disabled by
2348 @option{-ffreestanding} or @option{-fno-builtin}.
2350 The formats are checked against the format features supported by GNU
2351 libc version 2.2.  These include all ISO C90 and C99 features, as well
2352 as features from the Single Unix Specification and some BSD and GNU
2353 extensions.  Other library implementations may not support all these
2354 features; GCC does not support warning about features that go beyond a
2355 particular library's limitations.  However, if @option{-pedantic} is used
2356 with @option{-Wformat}, warnings will be given about format features not
2357 in the selected standard version (but not for @code{strfmon} formats,
2358 since those are not in any version of the C standard).  @xref{C Dialect
2359 Options,,Options Controlling C Dialect}.
2361 Since @option{-Wformat} also checks for null format arguments for
2362 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2364 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2365 aspects of format checking, the options @option{-Wformat-y2k},
2366 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2367 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2368 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2370 @item -Wformat-y2k
2371 @opindex Wformat-y2k
2372 If @option{-Wformat} is specified, also warn about @code{strftime}
2373 formats which may yield only a two-digit year.
2375 @item -Wno-format-extra-args
2376 @opindex Wno-format-extra-args
2377 If @option{-Wformat} is specified, do not warn about excess arguments to a
2378 @code{printf} or @code{scanf} format function.  The C standard specifies
2379 that such arguments are ignored.
2381 Where the unused arguments lie between used arguments that are
2382 specified with @samp{$} operand number specifications, normally
2383 warnings are still given, since the implementation could not know what
2384 type to pass to @code{va_arg} to skip the unused arguments.  However,
2385 in the case of @code{scanf} formats, this option will suppress the
2386 warning if the unused arguments are all pointers, since the Single
2387 Unix Specification says that such unused arguments are allowed.
2389 @item -Wno-format-zero-length
2390 @opindex Wno-format-zero-length
2391 If @option{-Wformat} is specified, do not warn about zero-length formats.
2392 The C standard specifies that zero-length formats are allowed.
2394 @item -Wformat-nonliteral
2395 @opindex Wformat-nonliteral
2396 If @option{-Wformat} is specified, also warn if the format string is not a
2397 string literal and so cannot be checked, unless the format function
2398 takes its format arguments as a @code{va_list}.
2400 @item -Wformat-security
2401 @opindex Wformat-security
2402 If @option{-Wformat} is specified, also warn about uses of format
2403 functions that represent possible security problems.  At present, this
2404 warns about calls to @code{printf} and @code{scanf} functions where the
2405 format string is not a string literal and there are no format arguments,
2406 as in @code{printf (foo);}.  This may be a security hole if the format
2407 string came from untrusted input and contains @samp{%n}.  (This is
2408 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2409 in future warnings may be added to @option{-Wformat-security} that are not
2410 included in @option{-Wformat-nonliteral}.)
2412 @item -Wformat=2
2413 @opindex Wformat=2
2414 Enable @option{-Wformat} plus format checks not included in
2415 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2416 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2418 @item -Wnonnull
2419 @opindex Wnonnull
2420 Warn about passing a null pointer for arguments marked as
2421 requiring a non-null value by the @code{nonnull} function attribute.
2423 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2424 can be disabled with the @option{-Wno-nonnull} option.
2426 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2427 @opindex Winit-self
2428 Warn about uninitialized variables which are initialized with themselves.
2429 Note this option can only be used with the @option{-Wuninitialized} option,
2430 which in turn only works with @option{-O1} and above.
2432 For example, GCC will warn about @code{i} being uninitialized in the
2433 following snippet only when @option{-Winit-self} has been specified:
2434 @smallexample
2435 @group
2436 int f()
2438   int i = i;
2439   return i;
2441 @end group
2442 @end smallexample
2444 @item -Wimplicit-int
2445 @opindex Wimplicit-int
2446 Warn when a declaration does not specify a type.
2447 This warning is enabled by @option{-Wall}.
2449 @item -Wimplicit-function-declaration
2450 @itemx -Werror-implicit-function-declaration
2451 @opindex Wimplicit-function-declaration
2452 @opindex Werror-implicit-function-declaration
2453 Give a warning (or error) whenever a function is used before being
2454 declared.  The form @option{-Wno-error-implicit-function-declaration}
2455 is not supported.
2456 This warning is enabled by @option{-Wall} (as a warning, not an error).
2458 @item -Wimplicit
2459 @opindex Wimplicit
2460 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2461 This warning is enabled by @option{-Wall}.
2463 @item -Wmain
2464 @opindex Wmain
2465 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2466 function with external linkage, returning int, taking either zero
2467 arguments, two, or three arguments of appropriate types.
2468 This warning is enabled by @option{-Wall}.
2470 @item -Wmissing-braces
2471 @opindex Wmissing-braces
2472 Warn if an aggregate or union initializer is not fully bracketed.  In
2473 the following example, the initializer for @samp{a} is not fully
2474 bracketed, but that for @samp{b} is fully bracketed.
2476 @smallexample
2477 int a[2][2] = @{ 0, 1, 2, 3 @};
2478 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2479 @end smallexample
2481 This warning is enabled by @option{-Wall}.
2483 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2484 @opindex Wmissing-include-dirs
2485 Warn if a user-supplied include directory does not exist.
2487 @item -Wparentheses
2488 @opindex Wparentheses
2489 Warn if parentheses are omitted in certain contexts, such
2490 as when there is an assignment in a context where a truth value
2491 is expected, or when operators are nested whose precedence people
2492 often get confused about.  Only the warning for an assignment used as
2493 a truth value is supported when compiling C++; the other warnings are
2494 only supported when compiling C@.
2496 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2497 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2498 interpretation from that of ordinary mathematical notation.
2500 Also warn about constructions where there may be confusion to which
2501 @code{if} statement an @code{else} branch belongs.  Here is an example of
2502 such a case:
2504 @smallexample
2505 @group
2507   if (a)
2508     if (b)
2509       foo ();
2510   else
2511     bar ();
2513 @end group
2514 @end smallexample
2516 In C, every @code{else} branch belongs to the innermost possible @code{if}
2517 statement, which in this example is @code{if (b)}.  This is often not
2518 what the programmer expected, as illustrated in the above example by
2519 indentation the programmer chose.  When there is the potential for this
2520 confusion, GCC will issue a warning when this flag is specified.
2521 To eliminate the warning, add explicit braces around the innermost
2522 @code{if} statement so there is no way the @code{else} could belong to
2523 the enclosing @code{if}.  The resulting code would look like this:
2525 @smallexample
2526 @group
2528   if (a)
2529     @{
2530       if (b)
2531         foo ();
2532       else
2533         bar ();
2534     @}
2536 @end group
2537 @end smallexample
2539 This warning is enabled by @option{-Wall}.
2541 @item -Wsequence-point
2542 @opindex Wsequence-point
2543 Warn about code that may have undefined semantics because of violations
2544 of sequence point rules in the C standard.
2546 The C standard defines the order in which expressions in a C program are
2547 evaluated in terms of @dfn{sequence points}, which represent a partial
2548 ordering between the execution of parts of the program: those executed
2549 before the sequence point, and those executed after it.  These occur
2550 after the evaluation of a full expression (one which is not part of a
2551 larger expression), after the evaluation of the first operand of a
2552 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2553 function is called (but after the evaluation of its arguments and the
2554 expression denoting the called function), and in certain other places.
2555 Other than as expressed by the sequence point rules, the order of
2556 evaluation of subexpressions of an expression is not specified.  All
2557 these rules describe only a partial order rather than a total order,
2558 since, for example, if two functions are called within one expression
2559 with no sequence point between them, the order in which the functions
2560 are called is not specified.  However, the standards committee have
2561 ruled that function calls do not overlap.
2563 It is not specified when between sequence points modifications to the
2564 values of objects take effect.  Programs whose behavior depends on this
2565 have undefined behavior; the C standard specifies that ``Between the
2566 previous and next sequence point an object shall have its stored value
2567 modified at most once by the evaluation of an expression.  Furthermore,
2568 the prior value shall be read only to determine the value to be
2569 stored.''.  If a program breaks these rules, the results on any
2570 particular implementation are entirely unpredictable.
2572 Examples of code with undefined behavior are @code{a = a++;},
2573 @code{a[n] = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases
2574 are not diagnosed by this option, and it may give an occasional false
2575 positive result, but in general it has been found fairly effective at
2576 detecting this sort of problem in programs.
2578 The present implementation of this option only works for C programs.  A
2579 future implementation may also work for C++ programs.
2581 The C standard is worded confusingly, therefore there is some debate
2582 over the precise meaning of the sequence point rules in subtle cases.
2583 Links to discussions of the problem, including proposed formal
2584 definitions, may be found on the GCC readings page, at
2585 @w{@uref{http://gcc.gnu.org/readings.html}}.
2587 This warning is enabled by @option{-Wall}.
2589 @item -Wreturn-type
2590 @opindex Wreturn-type
2591 Warn whenever a function is defined with a return-type that defaults to
2592 @code{int}.  Also warn about any @code{return} statement with no
2593 return-value in a function whose return-type is not @code{void}.
2595 For C, also warn if the return type of a function has a type qualifier
2596 such as @code{const}.  Such a type qualifier has no effect, since the
2597 value returned by a function is not an lvalue.  ISO C prohibits
2598 qualified @code{void} return types on function definitions, so such
2599 return types always receive a warning even without this option.
2601 For C++, a function without return type always produces a diagnostic
2602 message, even when @option{-Wno-return-type} is specified.  The only
2603 exceptions are @samp{main} and functions defined in system headers.
2605 This warning is enabled by @option{-Wall}.
2607 @item -Wswitch
2608 @opindex Wswitch
2609 Warn whenever a @code{switch} statement has an index of enumerated type
2610 and lacks a @code{case} for one or more of the named codes of that
2611 enumeration.  (The presence of a @code{default} label prevents this
2612 warning.)  @code{case} labels outside the enumeration range also
2613 provoke warnings when this option is used.
2614 This warning is enabled by @option{-Wall}.
2616 @item -Wswitch-default
2617 @opindex Wswitch-switch
2618 Warn whenever a @code{switch} statement does not have a @code{default}
2619 case.
2621 @item -Wswitch-enum
2622 @opindex Wswitch-enum
2623 Warn whenever a @code{switch} statement has an index of enumerated type
2624 and lacks a @code{case} for one or more of the named codes of that
2625 enumeration.  @code{case} labels outside the enumeration range also
2626 provoke warnings when this option is used.
2628 @item -Wtrigraphs
2629 @opindex Wtrigraphs
2630 Warn if any trigraphs are encountered that might change the meaning of
2631 the program (trigraphs within comments are not warned about).
2632 This warning is enabled by @option{-Wall}.
2634 @item -Wunused-function
2635 @opindex Wunused-function
2636 Warn whenever a static function is declared but not defined or a
2637 non-inline static function is unused.
2638 This warning is enabled by @option{-Wall}.
2640 @item -Wunused-label
2641 @opindex Wunused-label
2642 Warn whenever a label is declared but not used.
2643 This warning is enabled by @option{-Wall}.
2645 To suppress this warning use the @samp{unused} attribute
2646 (@pxref{Variable Attributes}).
2648 @item -Wunused-parameter
2649 @opindex Wunused-parameter
2650 Warn whenever a function parameter is unused aside from its declaration.
2652 To suppress this warning use the @samp{unused} attribute
2653 (@pxref{Variable Attributes}).
2655 @item -Wunused-variable
2656 @opindex Wunused-variable
2657 Warn whenever a local variable or non-constant static variable is unused
2658 aside from its declaration.
2659 This warning is enabled by @option{-Wall}.
2661 To suppress this warning use the @samp{unused} attribute
2662 (@pxref{Variable Attributes}).
2664 @item -Wunused-value
2665 @opindex Wunused-value
2666 Warn whenever a statement computes a result that is explicitly not used.
2667 This warning is enabled by @option{-Wall}.
2669 To suppress this warning cast the expression to @samp{void}.
2671 @item -Wunused
2672 @opindex Wunused
2673 All the above @option{-Wunused} options combined.
2675 In order to get a warning about an unused function parameter, you must
2676 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2677 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2679 @item -Wuninitialized
2680 @opindex Wuninitialized
2681 Warn if an automatic variable is used without first being initialized or
2682 if a variable may be clobbered by a @code{setjmp} call.
2684 These warnings are possible only in optimizing compilation,
2685 because they require data flow information that is computed only
2686 when optimizing.  If you don't specify @option{-O}, you simply won't
2687 get these warnings.
2689 If you want to warn about code which uses the uninitialized value of the
2690 variable in its own initializer, use the @option{-Winit-self} option.
2692 These warnings occur for individual uninitialized or clobbered
2693 elements of structure, union or array variables as well as for
2694 variables which are uninitialized or clobbered as a whole.  They do
2695 not occur for variables or elements declared @code{volatile}.  Because
2696 these warnings depend on optimization, the exact variables or elements
2697 for which there are warnings will depend on the precise optimization
2698 options and version of GCC used.
2700 Note that there may be no warning about a variable that is used only
2701 to compute a value that itself is never used, because such
2702 computations may be deleted by data flow analysis before the warnings
2703 are printed.
2705 These warnings are made optional because GCC is not smart
2706 enough to see all the reasons why the code might be correct
2707 despite appearing to have an error.  Here is one example of how
2708 this can happen:
2710 @smallexample
2711 @group
2713   int x;
2714   switch (y)
2715     @{
2716     case 1: x = 1;
2717       break;
2718     case 2: x = 4;
2719       break;
2720     case 3: x = 5;
2721     @}
2722   foo (x);
2724 @end group
2725 @end smallexample
2727 @noindent
2728 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2729 always initialized, but GCC doesn't know this.  Here is
2730 another common case:
2732 @smallexample
2734   int save_y;
2735   if (change_y) save_y = y, y = new_y;
2736   @dots{}
2737   if (change_y) y = save_y;
2739 @end smallexample
2741 @noindent
2742 This has no bug because @code{save_y} is used only if it is set.
2744 @cindex @code{longjmp} warnings
2745 This option also warns when a non-volatile automatic variable might be
2746 changed by a call to @code{longjmp}.  These warnings as well are possible
2747 only in optimizing compilation.
2749 The compiler sees only the calls to @code{setjmp}.  It cannot know
2750 where @code{longjmp} will be called; in fact, a signal handler could
2751 call it at any point in the code.  As a result, you may get a warning
2752 even when there is in fact no problem because @code{longjmp} cannot
2753 in fact be called at the place which would cause a problem.
2755 Some spurious warnings can be avoided if you declare all the functions
2756 you use that never return as @code{noreturn}.  @xref{Function
2757 Attributes}.
2759 This warning is enabled by @option{-Wall}.
2761 @item -Wunknown-pragmas
2762 @opindex Wunknown-pragmas
2763 @cindex warning for unknown pragmas
2764 @cindex unknown pragmas, warning
2765 @cindex pragmas, warning of unknown
2766 Warn when a #pragma directive is encountered which is not understood by
2767 GCC@.  If this command line option is used, warnings will even be issued
2768 for unknown pragmas in system header files.  This is not the case if
2769 the warnings were only enabled by the @option{-Wall} command line option.
2771 @item -Wno-pragmas
2772 @opindex Wno-pragmas
2773 @opindex Wpragmas
2774 Do not warn about misuses of pragmas, such as incorrect parameters,
2775 invalid syntax, or conflicts between pragmas.  See also
2776 @samp{-Wunknown-pragmas}.
2778 @item -Wstrict-aliasing
2779 @opindex Wstrict-aliasing
2780 This option is only active when @option{-fstrict-aliasing} is active.
2781 It warns about code which might break the strict aliasing rules that the
2782 compiler is using for optimization.  The warning does not catch all
2783 cases, but does attempt to catch the more common pitfalls.  It is
2784 included in @option{-Wall}.
2786 @item -Wstrict-aliasing=2
2787 @opindex Wstrict-aliasing=2
2788 This option is only active when @option{-fstrict-aliasing} is active.
2789 It warns about code which might break the strict aliasing rules that the
2790 compiler is using for optimization.  This warning catches more cases than
2791 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2792 cases that are safe.
2794 @item -Wall
2795 @opindex Wall
2796 All of the above @samp{-W} options combined.  This enables all the
2797 warnings about constructions that some users consider questionable, and
2798 that are easy to avoid (or modify to prevent the warning), even in
2799 conjunction with macros.  This also enables some language-specific
2800 warnings described in @ref{C++ Dialect Options} and
2801 @ref{Objective-C and Objective-C++ Dialect Options}.
2802 @end table
2804 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2805 Some of them warn about constructions that users generally do not
2806 consider questionable, but which occasionally you might wish to check
2807 for; others warn about constructions that are necessary or hard to avoid
2808 in some cases, and there is no simple way to modify the code to suppress
2809 the warning.
2811 @table @gcctabopt
2812 @item -Wextra
2813 @opindex W
2814 @opindex Wextra
2815 (This option used to be called @option{-W}.  The older name is still
2816 supported, but the newer name is more descriptive.)  Print extra warning
2817 messages for these events:
2819 @itemize @bullet
2820 @item
2821 A function can return either with or without a value.  (Falling
2822 off the end of the function body is considered returning without
2823 a value.)  For example, this function would evoke such a
2824 warning:
2826 @smallexample
2827 @group
2828 foo (a)
2830   if (a > 0)
2831     return a;
2833 @end group
2834 @end smallexample
2836 @item
2837 An expression-statement or the left-hand side of a comma expression
2838 contains no side effects.
2839 To suppress the warning, cast the unused expression to void.
2840 For example, an expression such as @samp{x[i,j]} will cause a warning,
2841 but @samp{x[(void)i,j]} will not.
2843 @item
2844 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2846 @item
2847 Storage-class specifiers like @code{static} are not the first things in
2848 a declaration.  According to the C Standard, this usage is obsolescent.
2850 @item
2851 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2852 arguments.
2854 @item
2855 A comparison between signed and unsigned values could produce an
2856 incorrect result when the signed value is converted to unsigned.
2857 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2859 @item
2860 An aggregate has an initializer which does not initialize all members.
2861 This warning can be independently controlled by
2862 @option{-Wmissing-field-initializers}.
2864 @item
2865 A function parameter is declared without a type specifier in K&R-style
2866 functions:
2868 @smallexample
2869 void foo(bar) @{ @}
2870 @end smallexample
2872 @item
2873 An empty body occurs in an @samp{if} or @samp{else} statement.
2875 @item
2876 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2877 @samp{>}, or @samp{>=}.
2879 @item
2880 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2882 @item
2883 Any of several floating-point events that often indicate errors, such as
2884 overflow, underflow, loss of precision, etc.
2886 @item @r{(C++ only)}
2887 An enumerator and a non-enumerator both appear in a conditional expression.
2889 @item @r{(C++ only)}
2890 A non-static reference or non-static @samp{const} member appears in a
2891 class without constructors.
2893 @item @r{(C++ only)}
2894 Ambiguous virtual bases.
2896 @item @r{(C++ only)}
2897 Subscripting an array which has been declared @samp{register}.
2899 @item @r{(C++ only)}
2900 Taking the address of a variable which has been declared @samp{register}.
2902 @item @r{(C++ only)}
2903 A base class is not initialized in a derived class' copy constructor.
2904 @end itemize
2906 @item -Wno-div-by-zero
2907 @opindex Wno-div-by-zero
2908 @opindex Wdiv-by-zero
2909 Do not warn about compile-time integer division by zero.  Floating point
2910 division by zero is not warned about, as it can be a legitimate way of
2911 obtaining infinities and NaNs.
2913 @item -Wsystem-headers
2914 @opindex Wsystem-headers
2915 @cindex warnings from system headers
2916 @cindex system headers, warnings from
2917 Print warning messages for constructs found in system header files.
2918 Warnings from system headers are normally suppressed, on the assumption
2919 that they usually do not indicate real problems and would only make the
2920 compiler output harder to read.  Using this command line option tells
2921 GCC to emit warnings from system headers as if they occurred in user
2922 code.  However, note that using @option{-Wall} in conjunction with this
2923 option will @emph{not} warn about unknown pragmas in system
2924 headers---for that, @option{-Wunknown-pragmas} must also be used.
2926 @item -Wfloat-equal
2927 @opindex Wfloat-equal
2928 Warn if floating point values are used in equality comparisons.
2930 The idea behind this is that sometimes it is convenient (for the
2931 programmer) to consider floating-point values as approximations to
2932 infinitely precise real numbers.  If you are doing this, then you need
2933 to compute (by analyzing the code, or in some other way) the maximum or
2934 likely maximum error that the computation introduces, and allow for it
2935 when performing comparisons (and when producing output, but that's a
2936 different problem).  In particular, instead of testing for equality, you
2937 would check to see whether the two values have ranges that overlap; and
2938 this is done with the relational operators, so equality comparisons are
2939 probably mistaken.
2941 @item -Wtraditional @r{(C only)}
2942 @opindex Wtraditional
2943 Warn about certain constructs that behave differently in traditional and
2944 ISO C@.  Also warn about ISO C constructs that have no traditional C
2945 equivalent, and/or problematic constructs which should be avoided.
2947 @itemize @bullet
2948 @item
2949 Macro parameters that appear within string literals in the macro body.
2950 In traditional C macro replacement takes place within string literals,
2951 but does not in ISO C@.
2953 @item
2954 In traditional C, some preprocessor directives did not exist.
2955 Traditional preprocessors would only consider a line to be a directive
2956 if the @samp{#} appeared in column 1 on the line.  Therefore
2957 @option{-Wtraditional} warns about directives that traditional C
2958 understands but would ignore because the @samp{#} does not appear as the
2959 first character on the line.  It also suggests you hide directives like
2960 @samp{#pragma} not understood by traditional C by indenting them.  Some
2961 traditional implementations would not recognize @samp{#elif}, so it
2962 suggests avoiding it altogether.
2964 @item
2965 A function-like macro that appears without arguments.
2967 @item
2968 The unary plus operator.
2970 @item
2971 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2972 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2973 constants.)  Note, these suffixes appear in macros defined in the system
2974 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2975 Use of these macros in user code might normally lead to spurious
2976 warnings, however GCC's integrated preprocessor has enough context to
2977 avoid warning in these cases.
2979 @item
2980 A function declared external in one block and then used after the end of
2981 the block.
2983 @item
2984 A @code{switch} statement has an operand of type @code{long}.
2986 @item
2987 A non-@code{static} function declaration follows a @code{static} one.
2988 This construct is not accepted by some traditional C compilers.
2990 @item
2991 The ISO type of an integer constant has a different width or
2992 signedness from its traditional type.  This warning is only issued if
2993 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2994 typically represent bit patterns, are not warned about.
2996 @item
2997 Usage of ISO string concatenation is detected.
2999 @item
3000 Initialization of automatic aggregates.
3002 @item
3003 Identifier conflicts with labels.  Traditional C lacks a separate
3004 namespace for labels.
3006 @item
3007 Initialization of unions.  If the initializer is zero, the warning is
3008 omitted.  This is done under the assumption that the zero initializer in
3009 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3010 initializer warnings and relies on default initialization to zero in the
3011 traditional C case.
3013 @item
3014 Conversions by prototypes between fixed/floating point values and vice
3015 versa.  The absence of these prototypes when compiling with traditional
3016 C would cause serious problems.  This is a subset of the possible
3017 conversion warnings, for the full set use @option{-Wconversion}.
3019 @item
3020 Use of ISO C style function definitions.  This warning intentionally is
3021 @emph{not} issued for prototype declarations or variadic functions
3022 because these ISO C features will appear in your code when using
3023 libiberty's traditional C compatibility macros, @code{PARAMS} and
3024 @code{VPARAMS}.  This warning is also bypassed for nested functions
3025 because that feature is already a GCC extension and thus not relevant to
3026 traditional C compatibility.
3027 @end itemize
3029 @item -Wdeclaration-after-statement @r{(C only)}
3030 @opindex Wdeclaration-after-statement
3031 Warn when a declaration is found after a statement in a block.  This
3032 construct, known from C++, was introduced with ISO C99 and is by default
3033 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3034 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3036 @item -Wundef
3037 @opindex Wundef
3038 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3040 @item -Wno-endif-labels
3041 @opindex Wno-endif-labels
3042 @opindex Wendif-labels
3043 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3045 @item -Wshadow
3046 @opindex Wshadow
3047 Warn whenever a local variable shadows another local variable, parameter or
3048 global variable or whenever a built-in function is shadowed.
3050 @item -Wlarger-than-@var{len}
3051 @opindex Wlarger-than
3052 Warn whenever an object of larger than @var{len} bytes is defined.
3054 @item -Wunsafe-loop-optimizations
3055 @opindex Wunsafe-loop-optimizations
3056 Warn if the loop cannot be optimized because the compiler could not
3057 assume anything on the bounds of the loop indices.  With
3058 @option{-funsafe-loop-optimizations} warn if the compiler made
3059 such assumptions.
3061 @item -Wpointer-arith
3062 @opindex Wpointer-arith
3063 Warn about anything that depends on the ``size of'' a function type or
3064 of @code{void}.  GNU C assigns these types a size of 1, for
3065 convenience in calculations with @code{void *} pointers and pointers
3066 to functions.
3068 @item -Wbad-function-cast @r{(C only)}
3069 @opindex Wbad-function-cast
3070 Warn whenever a function call is cast to a non-matching type.
3071 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3073 @item -Wc++-compat
3074 Warn about ISO C constructs that are outside of the common subset of
3075 ISO C and ISO C++, e.g.@: request for implicit conversion from
3076 @code{void *} to a pointer to non-@code{void} type.
3078 @item -Wcast-qual
3079 @opindex Wcast-qual
3080 Warn whenever a pointer is cast so as to remove a type qualifier from
3081 the target type.  For example, warn if a @code{const char *} is cast
3082 to an ordinary @code{char *}.
3084 @item -Wcast-align
3085 @opindex Wcast-align
3086 Warn whenever a pointer is cast such that the required alignment of the
3087 target is increased.  For example, warn if a @code{char *} is cast to
3088 an @code{int *} on machines where integers can only be accessed at
3089 two- or four-byte boundaries.
3091 @item -Wwrite-strings
3092 @opindex Wwrite-strings
3093 When compiling C, give string constants the type @code{const
3094 char[@var{length}]} so that
3095 copying the address of one into a non-@code{const} @code{char *}
3096 pointer will get a warning; when compiling C++, warn about the
3097 deprecated conversion from string constants to @code{char *}.
3098 These warnings will help you find at
3099 compile time code that can try to write into a string constant, but
3100 only if you have been very careful about using @code{const} in
3101 declarations and prototypes.  Otherwise, it will just be a nuisance;
3102 this is why we did not make @option{-Wall} request these warnings.
3104 @item -Wconversion
3105 @opindex Wconversion
3106 Warn if a prototype causes a type conversion that is different from what
3107 would happen to the same argument in the absence of a prototype.  This
3108 includes conversions of fixed point to floating and vice versa, and
3109 conversions changing the width or signedness of a fixed point argument
3110 except when the same as the default promotion.
3112 Also, warn if a negative integer constant expression is implicitly
3113 converted to an unsigned type.  For example, warn about the assignment
3114 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3115 casts like @code{(unsigned) -1}.
3117 @item -Wsign-compare
3118 @opindex Wsign-compare
3119 @cindex warning for comparison of signed and unsigned values
3120 @cindex comparison of signed and unsigned values, warning
3121 @cindex signed and unsigned values, comparison warning
3122 Warn when a comparison between signed and unsigned values could produce
3123 an incorrect result when the signed value is converted to unsigned.
3124 This warning is also enabled by @option{-Wextra}; to get the other warnings
3125 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3127 @item -Waggregate-return
3128 @opindex Waggregate-return
3129 Warn if any functions that return structures or unions are defined or
3130 called.  (In languages where you can return an array, this also elicits
3131 a warning.)
3133 @item -Wno-attributes
3134 @opindex Wno-attributes
3135 @opindex Wattributes
3136 Do not warn if an unexpected @code{__attribute__} is used, such as
3137 unrecognized attributes, function attributes applied to variables,
3138 etc.  This will not stop errors for incorrect use of supported
3139 attributes.
3141 @item -Wstrict-prototypes @r{(C only)}
3142 @opindex Wstrict-prototypes
3143 Warn if a function is declared or defined without specifying the
3144 argument types.  (An old-style function definition is permitted without
3145 a warning if preceded by a declaration which specifies the argument
3146 types.)
3148 @item -Wold-style-definition @r{(C only)}
3149 @opindex Wold-style-definition
3150 Warn if an old-style function definition is used.  A warning is given
3151 even if there is a previous prototype.
3153 @item -Wmissing-prototypes @r{(C only)}
3154 @opindex Wmissing-prototypes
3155 Warn if a global function is defined without a previous prototype
3156 declaration.  This warning is issued even if the definition itself
3157 provides a prototype.  The aim is to detect global functions that fail
3158 to be declared in header files.
3160 @item -Wmissing-declarations @r{(C only)}
3161 @opindex Wmissing-declarations
3162 Warn if a global function is defined without a previous declaration.
3163 Do so even if the definition itself provides a prototype.
3164 Use this option to detect global functions that are not declared in
3165 header files.
3167 @item -Wmissing-field-initializers
3168 @opindex Wmissing-field-initializers
3169 @opindex W
3170 @opindex Wextra
3171 Warn if a structure's initializer has some fields missing.  For
3172 example, the following code would cause such a warning, because
3173 @code{x.h} is implicitly zero:
3175 @smallexample
3176 struct s @{ int f, g, h; @};
3177 struct s x = @{ 3, 4 @};
3178 @end smallexample
3180 This option does not warn about designated initializers, so the following
3181 modification would not trigger a warning:
3183 @smallexample
3184 struct s @{ int f, g, h; @};
3185 struct s x = @{ .f = 3, .g = 4 @};
3186 @end smallexample
3188 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3189 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3191 @item -Wmissing-noreturn
3192 @opindex Wmissing-noreturn
3193 Warn about functions which might be candidates for attribute @code{noreturn}.
3194 Note these are only possible candidates, not absolute ones.  Care should
3195 be taken to manually verify functions actually do not ever return before
3196 adding the @code{noreturn} attribute, otherwise subtle code generation
3197 bugs could be introduced.  You will not get a warning for @code{main} in
3198 hosted C environments.
3200 @item -Wmissing-format-attribute
3201 @opindex Wmissing-format-attribute
3202 @opindex Wformat
3203 Warn about function pointers which might be candidates for @code{format}
3204 attributes.  Note these are only possible candidates, not absolute ones.
3205 GCC will guess that function pointers with @code{format} attributes that
3206 are used in assignment, initialization, parameter passing or return
3207 statements should have a corresponding @code{format} attribute in the
3208 resulting type.  I.e.@: the left-hand side of the assignment or
3209 initialization, the type of the parameter variable, or the return type
3210 of the containing function respectively should also have a @code{format}
3211 attribute to avoid the warning.
3213 GCC will also warn about function definitions which might be
3214 candidates for @code{format} attributes.  Again, these are only
3215 possible candidates.  GCC will guess that @code{format} attributes
3216 might be appropriate for any function that calls a function like
3217 @code{vprintf} or @code{vscanf}, but this might not always be the
3218 case, and some functions for which @code{format} attributes are
3219 appropriate may not be detected.
3221 @item -Wno-multichar
3222 @opindex Wno-multichar
3223 @opindex Wmultichar
3224 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3225 Usually they indicate a typo in the user's code, as they have
3226 implementation-defined values, and should not be used in portable code.
3228 @item -Wnormalized=<none|id|nfc|nfkc>
3229 @opindex Wnormalized
3230 @cindex NFC
3231 @cindex NFKC
3232 @cindex character set, input normalization
3233 In ISO C and ISO C++, two identifiers are different if they are
3234 different sequences of characters.  However, sometimes when characters
3235 outside the basic ASCII character set are used, you can have two
3236 different character sequences that look the same.  To avoid confusion,
3237 the ISO 10646 standard sets out some @dfn{normalization rules} which
3238 when applied ensure that two sequences that look the same are turned into
3239 the same sequence.  GCC can warn you if you are using identifiers which
3240 have not been normalized; this option controls that warning.
3242 There are four levels of warning that GCC supports.  The default is
3243 @option{-Wnormalized=nfc}, which warns about any identifier which is
3244 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3245 recommended form for most uses.
3247 Unfortunately, there are some characters which ISO C and ISO C++ allow
3248 in identifiers that when turned into NFC aren't allowable as
3249 identifiers.  That is, there's no way to use these symbols in portable
3250 ISO C or C++ and have all your identifiers in NFC.
3251 @option{-Wnormalized=id} suppresses the warning for these characters.
3252 It is hoped that future versions of the standards involved will correct
3253 this, which is why this option is not the default.
3255 You can switch the warning off for all characters by writing
3256 @option{-Wnormalized=none}.  You would only want to do this if you
3257 were using some other normalization scheme (like ``D''), because
3258 otherwise you can easily create bugs that are literally impossible to see.
3260 Some characters in ISO 10646 have distinct meanings but look identical
3261 in some fonts or display methodologies, especially once formatting has
3262 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3263 LETTER N'', will display just like a regular @code{n} which has been
3264 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3265 normalisation scheme to convert all these into a standard form as
3266 well, and GCC will warn if your code is not in NFKC if you use
3267 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3268 about every identifier that contains the letter O because it might be
3269 confused with the digit 0, and so is not the default, but may be
3270 useful as a local coding convention if the programming environment is
3271 unable to be fixed to display these characters distinctly.
3273 @item -Wno-deprecated-declarations
3274 @opindex Wno-deprecated-declarations
3275 Do not warn about uses of functions, variables, and types marked as
3276 deprecated by using the @code{deprecated} attribute.
3277 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3278 @pxref{Type Attributes}.)
3280 @item -Wpacked
3281 @opindex Wpacked
3282 Warn if a structure is given the packed attribute, but the packed
3283 attribute has no effect on the layout or size of the structure.
3284 Such structures may be mis-aligned for little benefit.  For
3285 instance, in this code, the variable @code{f.x} in @code{struct bar}
3286 will be misaligned even though @code{struct bar} does not itself
3287 have the packed attribute:
3289 @smallexample
3290 @group
3291 struct foo @{
3292   int x;
3293   char a, b, c, d;
3294 @} __attribute__((packed));
3295 struct bar @{
3296   char z;
3297   struct foo f;
3299 @end group
3300 @end smallexample
3302 @item -Wpadded
3303 @opindex Wpadded
3304 Warn if padding is included in a structure, either to align an element
3305 of the structure or to align the whole structure.  Sometimes when this
3306 happens it is possible to rearrange the fields of the structure to
3307 reduce the padding and so make the structure smaller.
3309 @item -Wredundant-decls
3310 @opindex Wredundant-decls
3311 Warn if anything is declared more than once in the same scope, even in
3312 cases where multiple declaration is valid and changes nothing.
3314 @item -Wnested-externs @r{(C only)}
3315 @opindex Wnested-externs
3316 Warn if an @code{extern} declaration is encountered within a function.
3318 @item -Wunreachable-code
3319 @opindex Wunreachable-code
3320 Warn if the compiler detects that code will never be executed.
3322 This option is intended to warn when the compiler detects that at
3323 least a whole line of source code will never be executed, because
3324 some condition is never satisfied or because it is after a
3325 procedure that never returns.
3327 It is possible for this option to produce a warning even though there
3328 are circumstances under which part of the affected line can be executed,
3329 so care should be taken when removing apparently-unreachable code.
3331 For instance, when a function is inlined, a warning may mean that the
3332 line is unreachable in only one inlined copy of the function.
3334 This option is not made part of @option{-Wall} because in a debugging
3335 version of a program there is often substantial code which checks
3336 correct functioning of the program and is, hopefully, unreachable
3337 because the program does work.  Another common use of unreachable
3338 code is to provide behavior which is selectable at compile-time.
3340 @item -Winline
3341 @opindex Winline
3342 Warn if a function can not be inlined and it was declared as inline.
3343 Even with this option, the compiler will not warn about failures to
3344 inline functions declared in system headers.
3346 The compiler uses a variety of heuristics to determine whether or not
3347 to inline a function.  For example, the compiler takes into account
3348 the size of the function being inlined and the amount of inlining
3349 that has already been done in the current function.  Therefore,
3350 seemingly insignificant changes in the source program can cause the
3351 warnings produced by @option{-Winline} to appear or disappear.
3353 @item -Wno-invalid-offsetof @r{(C++ only)}
3354 @opindex Wno-invalid-offsetof
3355 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3356 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3357 to a non-POD type is undefined.  In existing C++ implementations,
3358 however, @samp{offsetof} typically gives meaningful results even when
3359 applied to certain kinds of non-POD types. (Such as a simple
3360 @samp{struct} that fails to be a POD type only by virtue of having a
3361 constructor.)  This flag is for users who are aware that they are
3362 writing nonportable code and who have deliberately chosen to ignore the
3363 warning about it.
3365 The restrictions on @samp{offsetof} may be relaxed in a future version
3366 of the C++ standard.
3368 @item -Wno-int-to-pointer-cast @r{(C only)}
3369 @opindex Wno-int-to-pointer-cast
3370 Suppress warnings from casts to pointer type of an integer of a
3371 different size.
3373 @item -Wno-pointer-to-int-cast @r{(C only)}
3374 @opindex Wno-pointer-to-int-cast
3375 Suppress warnings from casts from a pointer to an integer type of a
3376 different size.
3378 @item -Winvalid-pch
3379 @opindex Winvalid-pch
3380 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3381 the search path but can't be used.
3383 @item -Wlong-long
3384 @opindex Wlong-long
3385 @opindex Wno-long-long
3386 Warn if @samp{long long} type is used.  This is default.  To inhibit
3387 the warning messages, use @option{-Wno-long-long}.  Flags
3388 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3389 only when @option{-pedantic} flag is used.
3391 @item -Wvariadic-macros
3392 @opindex Wvariadic-macros
3393 @opindex Wno-variadic-macros
3394 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3395 alternate syntax when in pedantic ISO C99 mode.  This is default.
3396 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3398 @item -Wvolatile-register-var
3399 @opindex Wvolatile-register-var
3400 @opindex Wno-volatile-register-var
3401 Warn if a register variable is declared volatile.  The volatile
3402 modifier does not inhibit all optimizations that may eliminate reads
3403 and/or writes to register variables.
3405 @item -Wdisabled-optimization
3406 @opindex Wdisabled-optimization
3407 Warn if a requested optimization pass is disabled.  This warning does
3408 not generally indicate that there is anything wrong with your code; it
3409 merely indicates that GCC's optimizers were unable to handle the code
3410 effectively.  Often, the problem is that your code is too big or too
3411 complex; GCC will refuse to optimize programs when the optimization
3412 itself is likely to take inordinate amounts of time.
3414 @item -Wpointer-sign
3415 @opindex Wpointer-sign
3416 @opindex Wno-pointer-sign
3417 Warn for pointer argument passing or assignment with different signedness.
3418 This option is only supported for C and Objective-C@.  It is implied by
3419 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3420 @option{-Wno-pointer-sign}.
3422 @item -Werror
3423 @opindex Werror
3424 Make all warnings into errors.
3426 @item -Wstack-protector
3427 This option is only active when @option{-fstack-protector} is active.  It
3428 warns about functions that will not be protected against stack smashing.
3430 @end table
3432 @node Debugging Options
3433 @section Options for Debugging Your Program or GCC
3434 @cindex options, debugging
3435 @cindex debugging information options
3437 GCC has various special options that are used for debugging
3438 either your program or GCC:
3440 @table @gcctabopt
3441 @item -g
3442 @opindex g
3443 Produce debugging information in the operating system's native format
3444 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3445 information.
3447 On most systems that use stabs format, @option{-g} enables use of extra
3448 debugging information that only GDB can use; this extra information
3449 makes debugging work better in GDB but will probably make other debuggers
3450 crash or
3451 refuse to read the program.  If you want to control for certain whether
3452 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3453 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3455 GCC allows you to use @option{-g} with
3456 @option{-O}.  The shortcuts taken by optimized code may occasionally
3457 produce surprising results: some variables you declared may not exist
3458 at all; flow of control may briefly move where you did not expect it;
3459 some statements may not be executed because they compute constant
3460 results or their values were already at hand; some statements may
3461 execute in different places because they were moved out of loops.
3463 Nevertheless it proves possible to debug optimized output.  This makes
3464 it reasonable to use the optimizer for programs that might have bugs.
3466 The following options are useful when GCC is generated with the
3467 capability for more than one debugging format.
3469 @item -ggdb
3470 @opindex ggdb
3471 Produce debugging information for use by GDB@.  This means to use the
3472 most expressive format available (DWARF 2, stabs, or the native format
3473 if neither of those are supported), including GDB extensions if at all
3474 possible.
3476 @item -gstabs
3477 @opindex gstabs
3478 Produce debugging information in stabs format (if that is supported),
3479 without GDB extensions.  This is the format used by DBX on most BSD
3480 systems.  On MIPS, Alpha and System V Release 4 systems this option
3481 produces stabs debugging output which is not understood by DBX or SDB@.
3482 On System V Release 4 systems this option requires the GNU assembler.
3484 @item -feliminate-unused-debug-symbols
3485 @opindex feliminate-unused-debug-symbols
3486 Produce debugging information in stabs format (if that is supported),
3487 for only symbols that are actually used.
3489 @item -gstabs+
3490 @opindex gstabs+
3491 Produce debugging information in stabs format (if that is supported),
3492 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3493 use of these extensions is likely to make other debuggers crash or
3494 refuse to read the program.
3496 @item -gcoff
3497 @opindex gcoff
3498 Produce debugging information in COFF format (if that is supported).
3499 This is the format used by SDB on most System V systems prior to
3500 System V Release 4.
3502 @item -gxcoff
3503 @opindex gxcoff
3504 Produce debugging information in XCOFF format (if that is supported).
3505 This is the format used by the DBX debugger on IBM RS/6000 systems.
3507 @item -gxcoff+
3508 @opindex gxcoff+
3509 Produce debugging information in XCOFF format (if that is supported),
3510 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3511 use of these extensions is likely to make other debuggers crash or
3512 refuse to read the program, and may cause assemblers other than the GNU
3513 assembler (GAS) to fail with an error.
3515 @item -gdwarf-2
3516 @opindex gdwarf-2
3517 Produce debugging information in DWARF version 2 format (if that is
3518 supported).  This is the format used by DBX on IRIX 6.  With this
3519 option, GCC uses features of DWARF version 3 when they are useful;
3520 version 3 is upward compatible with version 2, but may still cause
3521 problems for older debuggers.
3523 @item -gvms
3524 @opindex gvms
3525 Produce debugging information in VMS debug format (if that is
3526 supported).  This is the format used by DEBUG on VMS systems.
3528 @item -g@var{level}
3529 @itemx -ggdb@var{level}
3530 @itemx -gstabs@var{level}
3531 @itemx -gcoff@var{level}
3532 @itemx -gxcoff@var{level}
3533 @itemx -gvms@var{level}
3534 Request debugging information and also use @var{level} to specify how
3535 much information.  The default level is 2.
3537 Level 1 produces minimal information, enough for making backtraces in
3538 parts of the program that you don't plan to debug.  This includes
3539 descriptions of functions and external variables, but no information
3540 about local variables and no line numbers.
3542 Level 3 includes extra information, such as all the macro definitions
3543 present in the program.  Some debuggers support macro expansion when
3544 you use @option{-g3}.
3546 @option{-gdwarf-2} does not accept a concatenated debug level, because
3547 GCC used to support an option @option{-gdwarf} that meant to generate
3548 debug information in version 1 of the DWARF format (which is very
3549 different from version 2), and it would have been too confusing.  That
3550 debug format is long obsolete, but the option cannot be changed now.
3551 Instead use an additional @option{-g@var{level}} option to change the
3552 debug level for DWARF2.
3554 @item -feliminate-dwarf2-dups
3555 @opindex feliminate-dwarf2-dups
3556 Compress DWARF2 debugging information by eliminating duplicated
3557 information about each symbol.  This option only makes sense when
3558 generating DWARF2 debugging information with @option{-gdwarf-2}.
3560 @cindex @command{prof}
3561 @item -p
3562 @opindex p
3563 Generate extra code to write profile information suitable for the
3564 analysis program @command{prof}.  You must use this option when compiling
3565 the source files you want data about, and you must also use it when
3566 linking.
3568 @cindex @command{gprof}
3569 @item -pg
3570 @opindex pg
3571 Generate extra code to write profile information suitable for the
3572 analysis program @command{gprof}.  You must use this option when compiling
3573 the source files you want data about, and you must also use it when
3574 linking.
3576 @item -Q
3577 @opindex Q
3578 Makes the compiler print out each function name as it is compiled, and
3579 print some statistics about each pass when it finishes.
3581 @item -ftime-report
3582 @opindex ftime-report
3583 Makes the compiler print some statistics about the time consumed by each
3584 pass when it finishes.
3586 @item -fmem-report
3587 @opindex fmem-report
3588 Makes the compiler print some statistics about permanent memory
3589 allocation when it finishes.
3591 @item -fprofile-arcs
3592 @opindex fprofile-arcs
3593 Add code so that program flow @dfn{arcs} are instrumented.  During
3594 execution the program records how many times each branch and call is
3595 executed and how many times it is taken or returns.  When the compiled
3596 program exits it saves this data to a file called
3597 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3598 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3599 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3600 @var{auxname} is generated from the name of the output file, if
3601 explicitly specified and it is not the final executable, otherwise it is
3602 the basename of the source file.  In both cases any suffix is removed
3603 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3604 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3605 @xref{Cross-profiling}.
3607 @cindex @command{gcov}
3608 @item --coverage
3609 @opindex coverage
3611 This option is used to compile and link code instrumented for coverage
3612 analysis.  The option is a synonym for @option{-fprofile-arcs}
3613 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3614 linking).  See the documentation for those options for more details.
3616 @itemize
3618 @item
3619 Compile the source files with @option{-fprofile-arcs} plus optimization
3620 and code generation options.  For test coverage analysis, use the
3621 additional @option{-ftest-coverage} option.  You do not need to profile
3622 every source file in a program.
3624 @item
3625 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3626 (the latter implies the former).
3628 @item
3629 Run the program on a representative workload to generate the arc profile
3630 information.  This may be repeated any number of times.  You can run
3631 concurrent instances of your program, and provided that the file system
3632 supports locking, the data files will be correctly updated.  Also
3633 @code{fork} calls are detected and correctly handled (double counting
3634 will not happen).
3636 @item
3637 For profile-directed optimizations, compile the source files again with
3638 the same optimization and code generation options plus
3639 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3640 Control Optimization}).
3642 @item
3643 For test coverage analysis, use @command{gcov} to produce human readable
3644 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3645 @command{gcov} documentation for further information.
3647 @end itemize
3649 With @option{-fprofile-arcs}, for each function of your program GCC
3650 creates a program flow graph, then finds a spanning tree for the graph.
3651 Only arcs that are not on the spanning tree have to be instrumented: the
3652 compiler adds code to count the number of times that these arcs are
3653 executed.  When an arc is the only exit or only entrance to a block, the
3654 instrumentation code can be added to the block; otherwise, a new basic
3655 block must be created to hold the instrumentation code.
3657 @need 2000
3658 @item -ftest-coverage
3659 @opindex ftest-coverage
3660 Produce a notes file that the @command{gcov} code-coverage utility
3661 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3662 show program coverage.  Each source file's note file is called
3663 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3664 above for a description of @var{auxname} and instructions on how to
3665 generate test coverage data.  Coverage data will match the source files
3666 more closely, if you do not optimize.
3668 @item -d@var{letters}
3669 @item -fdump-rtl-@var{pass}
3670 @opindex d
3671 Says to make debugging dumps during compilation at times specified by
3672 @var{letters}.    This is used for debugging the RTL-based passes of the
3673 compiler.  The file names for most of the dumps are made by appending a
3674 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3675 from the name of the output file, if explicitly specified and it is not
3676 an executable, otherwise it is the basename of the source file.
3678 Most debug dumps can be enabled either passing a letter to the @option{-d}
3679 option, or with a long @option{-fdump-rtl} switch; here are the possible
3680 letters for use in @var{letters} and @var{pass}, and their meanings:
3682 @table @gcctabopt
3683 @item -dA
3684 @opindex dA
3685 Annotate the assembler output with miscellaneous debugging information.
3687 @item -db
3688 @itemx -fdump-rtl-bp
3689 @opindex db
3690 @opindex fdump-rtl-bp
3691 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3693 @item -dB
3694 @itemx -fdump-rtl-bbro
3695 @opindex dB
3696 @opindex fdump-rtl-bbro
3697 Dump after block reordering, to @file{@var{file}.30.bbro}.
3699 @item -dc
3700 @itemx -fdump-rtl-combine
3701 @opindex dc
3702 @opindex fdump-rtl-combine
3703 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3705 @item -dC
3706 @itemx -fdump-rtl-ce1
3707 @itemx -fdump-rtl-ce2
3708 @opindex dC
3709 @opindex fdump-rtl-ce1
3710 @opindex fdump-rtl-ce2
3711 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3712 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3713 and @option{-fdump-rtl-ce2} enable dumping after the second if
3714 conversion, to the file @file{@var{file}.18.ce2}.
3716 @item -dd
3717 @itemx -fdump-rtl-btl
3718 @itemx -fdump-rtl-dbr
3719 @opindex dd
3720 @opindex fdump-rtl-btl
3721 @opindex fdump-rtl-dbr
3722 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3723 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3724 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3725 scheduling, to @file{@var{file}.36.dbr}.
3727 @item -dD
3728 @opindex dD
3729 Dump all macro definitions, at the end of preprocessing, in addition to
3730 normal output.
3732 @item -dE
3733 @itemx -fdump-rtl-ce3
3734 @opindex dE
3735 @opindex fdump-rtl-ce3
3736 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3738 @item -df
3739 @itemx -fdump-rtl-cfg
3740 @itemx -fdump-rtl-life
3741 @opindex df
3742 @opindex fdump-rtl-cfg
3743 @opindex fdump-rtl-life
3744 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3745 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3746 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3747 to @file{@var{file}.16.life}.
3749 @item -dg
3750 @itemx -fdump-rtl-greg
3751 @opindex dg
3752 @opindex fdump-rtl-greg
3753 Dump after global register allocation, to @file{@var{file}.23.greg}.
3755 @item -dG
3756 @itemx -fdump-rtl-gcse
3757 @itemx -fdump-rtl-bypass
3758 @opindex dG
3759 @opindex fdump-rtl-gcse
3760 @opindex fdump-rtl-bypass
3761 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3762 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3763 enable dumping after jump bypassing and control flow optimizations, to
3764 @file{@var{file}.07.bypass}.
3766 @item -dh
3767 @itemx -fdump-rtl-eh
3768 @opindex dh
3769 @opindex fdump-rtl-eh
3770 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3772 @item -di
3773 @itemx -fdump-rtl-sibling
3774 @opindex di
3775 @opindex fdump-rtl-sibling
3776 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3778 @item -dj
3779 @itemx -fdump-rtl-jump
3780 @opindex dj
3781 @opindex fdump-rtl-jump
3782 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3784 @item -dk
3785 @itemx -fdump-rtl-stack
3786 @opindex dk
3787 @opindex fdump-rtl-stack
3788 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3790 @item -dl
3791 @itemx -fdump-rtl-lreg
3792 @opindex dl
3793 @opindex fdump-rtl-lreg
3794 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3796 @item -dL
3797 @itemx -fdump-rtl-loop
3798 @itemx -fdump-rtl-loop2
3799 @opindex dL
3800 @opindex fdump-rtl-loop
3801 @opindex fdump-rtl-loop2
3802 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3803 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3804 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3805 @file{@var{file}.13.loop2}.
3807 @item -dm
3808 @itemx -fdump-rtl-sms
3809 @opindex dm
3810 @opindex fdump-rtl-sms
3811 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3813 @item -dM
3814 @itemx -fdump-rtl-mach
3815 @opindex dM
3816 @opindex fdump-rtl-mach
3817 Dump after performing the machine dependent reorganization pass, to
3818 @file{@var{file}.35.mach}.
3820 @item -dn
3821 @itemx -fdump-rtl-rnreg
3822 @opindex dn
3823 @opindex fdump-rtl-rnreg
3824 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3826 @item -dN
3827 @itemx -fdump-rtl-regmove
3828 @opindex dN
3829 @opindex fdump-rtl-regmove
3830 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3832 @item -do
3833 @itemx -fdump-rtl-postreload
3834 @opindex do
3835 @opindex fdump-rtl-postreload
3836 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3838 @item -dr
3839 @itemx -fdump-rtl-expand
3840 @opindex dr
3841 @opindex fdump-rtl-expand
3842 Dump after RTL generation, to @file{@var{file}.00.expand}.
3844 @item -dR
3845 @itemx -fdump-rtl-sched2
3846 @opindex dR
3847 @opindex fdump-rtl-sched2
3848 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3850 @item -ds
3851 @itemx -fdump-rtl-cse
3852 @opindex ds
3853 @opindex fdump-rtl-cse
3854 Dump after CSE (including the jump optimization that sometimes follows
3855 CSE), to @file{@var{file}.04.cse}.
3857 @item -dS
3858 @itemx -fdump-rtl-sched
3859 @opindex dS
3860 @opindex fdump-rtl-sched
3861 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3863 @item -dt
3864 @itemx -fdump-rtl-cse2
3865 @opindex dt
3866 @opindex fdump-rtl-cse2
3867 Dump after the second CSE pass (including the jump optimization that
3868 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3870 @item -dT
3871 @itemx -fdump-rtl-tracer
3872 @opindex dT
3873 @opindex fdump-rtl-tracer
3874 Dump after running tracer, to @file{@var{file}.12.tracer}.
3876 @item -dV
3877 @itemx -fdump-rtl-vpt
3878 @itemx -fdump-rtl-vartrack
3879 @opindex dV
3880 @opindex fdump-rtl-vpt
3881 @opindex fdump-rtl-vartrack
3882 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3883 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3884 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3885 to @file{@var{file}.34.vartrack}.
3887 @item -dw
3888 @itemx -fdump-rtl-flow2
3889 @opindex dw
3890 @opindex fdump-rtl-flow2
3891 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3893 @item -dz
3894 @itemx -fdump-rtl-peephole2
3895 @opindex dz
3896 @opindex fdump-rtl-peephole2
3897 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3899 @item -dZ
3900 @itemx -fdump-rtl-web
3901 @opindex dZ
3902 @opindex fdump-rtl-web
3903 Dump after live range splitting, to @file{@var{file}.14.web}.
3905 @item -da
3906 @itemx -fdump-rtl-all
3907 @opindex da
3908 @opindex fdump-rtl-all
3909 Produce all the dumps listed above.
3911 @item -dH
3912 @opindex dH
3913 Produce a core dump whenever an error occurs.
3915 @item -dm
3916 @opindex dm
3917 Print statistics on memory usage, at the end of the run, to
3918 standard error.
3920 @item -dp
3921 @opindex dp
3922 Annotate the assembler output with a comment indicating which
3923 pattern and alternative was used.  The length of each instruction is
3924 also printed.
3926 @item -dP
3927 @opindex dP
3928 Dump the RTL in the assembler output as a comment before each instruction.
3929 Also turns on @option{-dp} annotation.
3931 @item -dv
3932 @opindex dv
3933 For each of the other indicated dump files (either with @option{-d} or
3934 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3935 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3937 @item -dx
3938 @opindex dx
3939 Just generate RTL for a function instead of compiling it.  Usually used
3940 with @samp{r} (@option{-fdump-rtl-expand}).
3942 @item -dy
3943 @opindex dy
3944 Dump debugging information during parsing, to standard error.
3945 @end table
3947 @item -fdump-unnumbered
3948 @opindex fdump-unnumbered
3949 When doing debugging dumps (see @option{-d} option above), suppress instruction
3950 numbers and line number note output.  This makes it more feasible to
3951 use diff on debugging dumps for compiler invocations with different
3952 options, in particular with and without @option{-g}.
3954 @item -fdump-translation-unit @r{(C++ only)}
3955 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3956 @opindex fdump-translation-unit
3957 Dump a representation of the tree structure for the entire translation
3958 unit to a file.  The file name is made by appending @file{.tu} to the
3959 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3960 controls the details of the dump as described for the
3961 @option{-fdump-tree} options.
3963 @item -fdump-class-hierarchy @r{(C++ only)}
3964 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3965 @opindex fdump-class-hierarchy
3966 Dump a representation of each class's hierarchy and virtual function
3967 table layout to a file.  The file name is made by appending @file{.class}
3968 to the source file name.  If the @samp{-@var{options}} form is used,
3969 @var{options} controls the details of the dump as described for the
3970 @option{-fdump-tree} options.
3972 @item -fdump-ipa-@var{switch}
3973 @opindex fdump-ipa
3974 Control the dumping at various stages of inter-procedural analysis
3975 language tree to a file.  The file name is generated by appending a switch
3976 specific suffix to the source file name.  The following dumps are possible:
3978 @table @samp
3979 @item all
3980 Enables all inter-procedural analysis dumps; currently the only produced
3981 dump is the @samp{cgraph} dump.
3983 @item cgraph
3984 Dumps information about call-graph optimization, unused function removal,
3985 and inlining decisions.
3986 @end table
3988 @item -fdump-tree-@var{switch}
3989 @itemx -fdump-tree-@var{switch}-@var{options}
3990 @opindex fdump-tree
3991 Control the dumping at various stages of processing the intermediate
3992 language tree to a file.  The file name is generated by appending a switch
3993 specific suffix to the source file name.  If the @samp{-@var{options}}
3994 form is used, @var{options} is a list of @samp{-} separated options that
3995 control the details of the dump.  Not all options are applicable to all
3996 dumps, those which are not meaningful will be ignored.  The following
3997 options are available
3999 @table @samp
4000 @item address
4001 Print the address of each node.  Usually this is not meaningful as it
4002 changes according to the environment and source file.  Its primary use
4003 is for tying up a dump file with a debug environment.
4004 @item slim
4005 Inhibit dumping of members of a scope or body of a function merely
4006 because that scope has been reached.  Only dump such items when they
4007 are directly reachable by some other path.  When dumping pretty-printed
4008 trees, this option inhibits dumping the bodies of control structures.
4009 @item raw
4010 Print a raw representation of the tree.  By default, trees are
4011 pretty-printed into a C-like representation.
4012 @item details
4013 Enable more detailed dumps (not honored by every dump option).
4014 @item stats
4015 Enable dumping various statistics about the pass (not honored by every dump
4016 option).
4017 @item blocks
4018 Enable showing basic block boundaries (disabled in raw dumps).
4019 @item vops
4020 Enable showing virtual operands for every statement.
4021 @item lineno
4022 Enable showing line numbers for statements.
4023 @item uid
4024 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4025 @item all
4026 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4027 @end table
4029 The following tree dumps are possible:
4030 @table @samp
4032 @item original
4033 Dump before any tree based optimization, to @file{@var{file}.original}.
4035 @item optimized
4036 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4038 @item inlined
4039 Dump after function inlining, to @file{@var{file}.inlined}.
4041 @item gimple
4042 @opindex fdump-tree-gimple
4043 Dump each function before and after the gimplification pass to a file.  The
4044 file name is made by appending @file{.gimple} to the source file name.
4046 @item cfg
4047 @opindex fdump-tree-cfg
4048 Dump the control flow graph of each function to a file.  The file name is
4049 made by appending @file{.cfg} to the source file name.
4051 @item vcg
4052 @opindex fdump-tree-vcg
4053 Dump the control flow graph of each function to a file in VCG format.  The
4054 file name is made by appending @file{.vcg} to the source file name.  Note
4055 that if the file contains more than one function, the generated file cannot
4056 be used directly by VCG@.  You will need to cut and paste each function's
4057 graph into its own separate file first.
4059 @item ch
4060 @opindex fdump-tree-ch
4061 Dump each function after copying loop headers.  The file name is made by
4062 appending @file{.ch} to the source file name.
4064 @item ssa
4065 @opindex fdump-tree-ssa
4066 Dump SSA related information to a file.  The file name is made by appending
4067 @file{.ssa} to the source file name.
4069 @item salias
4070 @opindex fdump-tree-salias
4071 Dump structure aliasing variable information to a file.  This file name
4072 is made by appending @file{.salias} to the source file name.
4074 @item alias
4075 @opindex fdump-tree-alias
4076 Dump aliasing information for each function.  The file name is made by
4077 appending @file{.alias} to the source file name.
4079 @item ccp
4080 @opindex fdump-tree-ccp
4081 Dump each function after CCP@.  The file name is made by appending
4082 @file{.ccp} to the source file name.
4084 @item storeccp
4085 @opindex fdump-tree-storeccp
4086 Dump each function after STORE-CCP.  The file name is made by appending
4087 @file{.storeccp} to the source file name.
4089 @item pre
4090 @opindex fdump-tree-pre
4091 Dump trees after partial redundancy elimination.  The file name is made
4092 by appending @file{.pre} to the source file name.
4094 @item fre
4095 @opindex fdump-tree-fre
4096 Dump trees after full redundancy elimination.  The file name is made
4097 by appending @file{.fre} to the source file name.
4099 @item copyprop
4100 @opindex fdump-tree-copyprop
4101 Dump trees after copy propagation.  The file name is made
4102 by appending @file{.copyprop} to the source file name.
4104 @item store_copyprop
4105 @opindex fdump-tree-store_copyprop
4106 Dump trees after store copy-propagation.  The file name is made
4107 by appending @file{.store_copyprop} to the source file name.
4109 @item dce
4110 @opindex fdump-tree-dce
4111 Dump each function after dead code elimination.  The file name is made by
4112 appending @file{.dce} to the source file name.
4114 @item mudflap
4115 @opindex fdump-tree-mudflap
4116 Dump each function after adding mudflap instrumentation.  The file name is
4117 made by appending @file{.mudflap} to the source file name.
4119 @item sra
4120 @opindex fdump-tree-sra
4121 Dump each function after performing scalar replacement of aggregates.  The
4122 file name is made by appending @file{.sra} to the source file name.
4124 @item sink
4125 @opindex fdump-tree-sink
4126 Dump each function after performing code sinking.  The file name is made
4127 by appending @file{.sink} to the source file name. 
4129 @item dom
4130 @opindex fdump-tree-dom
4131 Dump each function after applying dominator tree optimizations.  The file
4132 name is made by appending @file{.dom} to the source file name.
4134 @item dse
4135 @opindex fdump-tree-dse
4136 Dump each function after applying dead store elimination.  The file
4137 name is made by appending @file{.dse} to the source file name.
4139 @item phiopt
4140 @opindex fdump-tree-phiopt
4141 Dump each function after optimizing PHI nodes into straightline code.  The file
4142 name is made by appending @file{.phiopt} to the source file name.
4144 @item forwprop
4145 @opindex fdump-tree-forwprop
4146 Dump each function after forward propagating single use variables.  The file
4147 name is made by appending @file{.forwprop} to the source file name.
4149 @item copyrename
4150 @opindex fdump-tree-copyrename
4151 Dump each function after applying the copy rename optimization.  The file
4152 name is made by appending @file{.copyrename} to the source file name.
4154 @item nrv
4155 @opindex fdump-tree-nrv
4156 Dump each function after applying the named return value optimization on
4157 generic trees.  The file name is made by appending @file{.nrv} to the source
4158 file name.
4160 @item vect
4161 @opindex fdump-tree-vect
4162 Dump each function after applying vectorization of loops.  The file name is
4163 made by appending @file{.vect} to the source file name.
4165 @item vrp
4166 @opindex fdump-tree-vrp
4167 Dump each function after Value Range Propagation (VRP).  The file name
4168 is made by appending @file{.vrp} to the source file name.
4170 @item all
4171 @opindex fdump-tree-all
4172 Enable all the available tree dumps with the flags provided in this option.
4173 @end table
4175 @item -ftree-vectorizer-verbose=@var{n}
4176 @opindex ftree-vectorizer-verbose
4177 This option controls the amount of debugging output the vectorizer prints.
4178 This information is written to standard error, unless @option{-fdump-tree-all}
4179 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4180 usual dump listing file, @file{.vect}.
4182 @item -frandom-seed=@var{string}
4183 @opindex frandom-string
4184 This option provides a seed that GCC uses when it would otherwise use
4185 random numbers.  It is used to generate certain symbol names
4186 that have to be different in every compiled file.  It is also used to
4187 place unique stamps in coverage data files and the object files that
4188 produce them.  You can use the @option{-frandom-seed} option to produce
4189 reproducibly identical object files.
4191 The @var{string} should be different for every file you compile.
4193 @item -fsched-verbose=@var{n}
4194 @opindex fsched-verbose
4195 On targets that use instruction scheduling, this option controls the
4196 amount of debugging output the scheduler prints.  This information is
4197 written to standard error, unless @option{-dS} or @option{-dR} is
4198 specified, in which case it is output to the usual dump
4199 listing file, @file{.sched} or @file{.sched2} respectively.  However
4200 for @var{n} greater than nine, the output is always printed to standard
4201 error.
4203 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4204 same information as @option{-dRS}.  For @var{n} greater than one, it
4205 also output basic block probabilities, detailed ready list information
4206 and unit/insn info.  For @var{n} greater than two, it includes RTL
4207 at abort point, control-flow and regions info.  And for @var{n} over
4208 four, @option{-fsched-verbose} also includes dependence info.
4210 @item -save-temps
4211 @opindex save-temps
4212 Store the usual ``temporary'' intermediate files permanently; place them
4213 in the current directory and name them based on the source file.  Thus,
4214 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4215 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4216 preprocessed @file{foo.i} output file even though the compiler now
4217 normally uses an integrated preprocessor.
4219 When used in combination with the @option{-x} command line option,
4220 @option{-save-temps} is sensible enough to avoid over writing an
4221 input source file with the same extension as an intermediate file.
4222 The corresponding intermediate file may be obtained by renaming the
4223 source file before using @option{-save-temps}.
4225 @item -time
4226 @opindex time
4227 Report the CPU time taken by each subprocess in the compilation
4228 sequence.  For C source files, this is the compiler proper and assembler
4229 (plus the linker if linking is done).  The output looks like this:
4231 @smallexample
4232 # cc1 0.12 0.01
4233 # as 0.00 0.01
4234 @end smallexample
4236 The first number on each line is the ``user time'', that is time spent
4237 executing the program itself.  The second number is ``system time'',
4238 time spent executing operating system routines on behalf of the program.
4239 Both numbers are in seconds.
4241 @item -fvar-tracking
4242 @opindex fvar-tracking
4243 Run variable tracking pass.  It computes where variables are stored at each
4244 position in code.  Better debugging information is then generated
4245 (if the debugging information format supports this information).
4247 It is enabled by default when compiling with optimization (@option{-Os},
4248 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4249 the debug info format supports it.
4251 @item -print-file-name=@var{library}
4252 @opindex print-file-name
4253 Print the full absolute name of the library file @var{library} that
4254 would be used when linking---and don't do anything else.  With this
4255 option, GCC does not compile or link anything; it just prints the
4256 file name.
4258 @item -print-multi-directory
4259 @opindex print-multi-directory
4260 Print the directory name corresponding to the multilib selected by any
4261 other switches present in the command line.  This directory is supposed
4262 to exist in @env{GCC_EXEC_PREFIX}.
4264 @item -print-multi-lib
4265 @opindex print-multi-lib
4266 Print the mapping from multilib directory names to compiler switches
4267 that enable them.  The directory name is separated from the switches by
4268 @samp{;}, and each switch starts with an @samp{@@} instead of the
4269 @samp{-}, without spaces between multiple switches.  This is supposed to
4270 ease shell-processing.
4272 @item -print-prog-name=@var{program}
4273 @opindex print-prog-name
4274 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4276 @item -print-libgcc-file-name
4277 @opindex print-libgcc-file-name
4278 Same as @option{-print-file-name=libgcc.a}.
4280 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4281 but you do want to link with @file{libgcc.a}.  You can do
4283 @smallexample
4284 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4285 @end smallexample
4287 @item -print-search-dirs
4288 @opindex print-search-dirs
4289 Print the name of the configured installation directory and a list of
4290 program and library directories @command{gcc} will search---and don't do anything else.
4292 This is useful when @command{gcc} prints the error message
4293 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4294 To resolve this you either need to put @file{cpp0} and the other compiler
4295 components where @command{gcc} expects to find them, or you can set the environment
4296 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4297 Don't forget the trailing @samp{/}.
4298 @xref{Environment Variables}.
4300 @item -dumpmachine
4301 @opindex dumpmachine
4302 Print the compiler's target machine (for example,
4303 @samp{i686-pc-linux-gnu})---and don't do anything else.
4305 @item -dumpversion
4306 @opindex dumpversion
4307 Print the compiler version (for example, @samp{3.0})---and don't do
4308 anything else.
4310 @item -dumpspecs
4311 @opindex dumpspecs
4312 Print the compiler's built-in specs---and don't do anything else.  (This
4313 is used when GCC itself is being built.)  @xref{Spec Files}.
4315 @item -feliminate-unused-debug-types
4316 @opindex feliminate-unused-debug-types
4317 Normally, when producing DWARF2 output, GCC will emit debugging
4318 information for all types declared in a compilation
4319 unit, regardless of whether or not they are actually used
4320 in that compilation unit.  Sometimes this is useful, such as
4321 if, in the debugger, you want to cast a value to a type that is
4322 not actually used in your program (but is declared).  More often,
4323 however, this results in a significant amount of wasted space.
4324 With this option, GCC will avoid producing debug symbol output
4325 for types that are nowhere used in the source file being compiled.
4326 @end table
4328 @node Optimize Options
4329 @section Options That Control Optimization
4330 @cindex optimize options
4331 @cindex options, optimization
4333 These options control various sorts of optimizations.
4335 Without any optimization option, the compiler's goal is to reduce the
4336 cost of compilation and to make debugging produce the expected
4337 results.  Statements are independent: if you stop the program with a
4338 breakpoint between statements, you can then assign a new value to any
4339 variable or change the program counter to any other statement in the
4340 function and get exactly the results you would expect from the source
4341 code.
4343 Turning on optimization flags makes the compiler attempt to improve
4344 the performance and/or code size at the expense of compilation time
4345 and possibly the ability to debug the program.
4347 The compiler performs optimization based on the knowledge it has of
4348 the program.  Optimization levels @option{-O} and above, in
4349 particular, enable @emph{unit-at-a-time} mode, which allows the
4350 compiler to consider information gained from later functions in
4351 the file when compiling a function.  Compiling multiple files at
4352 once to a single output file in @emph{unit-at-a-time} mode allows
4353 the compiler to use information gained from all of the files when
4354 compiling each of them.
4356 Not all optimizations are controlled directly by a flag.  Only
4357 optimizations that have a flag are listed.
4359 @table @gcctabopt
4360 @item -O
4361 @itemx -O1
4362 @opindex O
4363 @opindex O1
4364 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4365 more memory for a large function.
4367 With @option{-O}, the compiler tries to reduce code size and execution
4368 time, without performing any optimizations that take a great deal of
4369 compilation time.
4371 @option{-O} turns on the following optimization flags:
4372 @gccoptlist{-fdefer-pop @gol
4373 -fdelayed-branch @gol
4374 -fguess-branch-probability @gol
4375 -fcprop-registers @gol
4376 -floop-optimize @gol
4377 -fif-conversion @gol
4378 -fif-conversion2 @gol
4379 -ftree-ccp @gol
4380 -ftree-dce @gol
4381 -ftree-dominator-opts @gol
4382 -ftree-dse @gol
4383 -ftree-ter @gol
4384 -ftree-lrs @gol
4385 -ftree-sra @gol
4386 -ftree-copyrename @gol
4387 -ftree-fre @gol
4388 -ftree-ch @gol
4389 -funit-at-a-time @gol
4390 -fmerge-constants}
4392 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4393 where doing so does not interfere with debugging.
4395 @option{-O} doesn't turn on @option{-ftree-sra} for the Ada compiler.
4396 This option must be explicitly specified on the command line to be
4397 enabled for the Ada compiler.
4399 @item -O2
4400 @opindex O2
4401 Optimize even more.  GCC performs nearly all supported optimizations
4402 that do not involve a space-speed tradeoff.  The compiler does not
4403 perform loop unrolling or function inlining when you specify @option{-O2}.
4404 As compared to @option{-O}, this option increases both compilation time
4405 and the performance of the generated code.
4407 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4408 also turns on the following optimization flags:
4409 @gccoptlist{-fthread-jumps @gol
4410 -fcrossjumping @gol
4411 -foptimize-sibling-calls @gol
4412 -fcse-follow-jumps  -fcse-skip-blocks @gol
4413 -fgcse  -fgcse-lm  @gol
4414 -fexpensive-optimizations @gol
4415 -fstrength-reduce @gol
4416 -frerun-cse-after-loop  -frerun-loop-opt @gol
4417 -fcaller-saves @gol
4418 -fpeephole2 @gol
4419 -fschedule-insns  -fschedule-insns2 @gol
4420 -fsched-interblock  -fsched-spec @gol
4421 -fregmove @gol
4422 -fstrict-aliasing @gol
4423 -fdelete-null-pointer-checks @gol
4424 -freorder-blocks  -freorder-functions @gol
4425 -falign-functions  -falign-jumps @gol
4426 -falign-loops  -falign-labels @gol
4427 -ftree-vrp @gol
4428 -ftree-pre}
4430 Please note the warning under @option{-fgcse} about
4431 invoking @option{-O2} on programs that use computed gotos.
4433 @item -O3
4434 @opindex O3
4435 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4436 @option{-O2} and also turns on the @option{-finline-functions},
4437 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4439 @item -O0
4440 @opindex O0
4441 Do not optimize.  This is the default.
4443 @item -Os
4444 @opindex Os
4445 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4446 do not typically increase code size.  It also performs further
4447 optimizations designed to reduce code size.
4449 @option{-Os} disables the following optimization flags:
4450 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4451 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4452 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4454 If you use multiple @option{-O} options, with or without level numbers,
4455 the last such option is the one that is effective.
4456 @end table
4458 Options of the form @option{-f@var{flag}} specify machine-independent
4459 flags.  Most flags have both positive and negative forms; the negative
4460 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4461 below, only one of the forms is listed---the one you typically will
4462 use.  You can figure out the other form by either removing @samp{no-}
4463 or adding it.
4465 The following options control specific optimizations.  They are either
4466 activated by @option{-O} options or are related to ones that are.  You
4467 can use the following flags in the rare cases when ``fine-tuning'' of
4468 optimizations to be performed is desired.
4470 @table @gcctabopt
4471 @item -fno-default-inline
4472 @opindex fno-default-inline
4473 Do not make member functions inline by default merely because they are
4474 defined inside the class scope (C++ only).  Otherwise, when you specify
4475 @w{@option{-O}}, member functions defined inside class scope are compiled
4476 inline by default; i.e., you don't need to add @samp{inline} in front of
4477 the member function name.
4479 @item -fno-defer-pop
4480 @opindex fno-defer-pop
4481 Always pop the arguments to each function call as soon as that function
4482 returns.  For machines which must pop arguments after a function call,
4483 the compiler normally lets arguments accumulate on the stack for several
4484 function calls and pops them all at once.
4486 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4488 @item -fforce-mem
4489 @opindex fforce-mem
4490 Force memory operands to be copied into registers before doing
4491 arithmetic on them.  This produces better code by making all memory
4492 references potential common subexpressions.  When they are not common
4493 subexpressions, instruction combination should eliminate the separate
4494 register-load.  This option is now a nop and will be removed in 4.2.
4496 @item -fforce-addr
4497 @opindex fforce-addr
4498 Force memory address constants to be copied into registers before
4499 doing arithmetic on them.
4501 @item -fomit-frame-pointer
4502 @opindex fomit-frame-pointer
4503 Don't keep the frame pointer in a register for functions that
4504 don't need one.  This avoids the instructions to save, set up and
4505 restore frame pointers; it also makes an extra register available
4506 in many functions.  @strong{It also makes debugging impossible on
4507 some machines.}
4509 On some machines, such as the VAX, this flag has no effect, because
4510 the standard calling sequence automatically handles the frame pointer
4511 and nothing is saved by pretending it doesn't exist.  The
4512 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4513 whether a target machine supports this flag.  @xref{Registers,,Register
4514 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4516 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4518 @item -foptimize-sibling-calls
4519 @opindex foptimize-sibling-calls
4520 Optimize sibling and tail recursive calls.
4522 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4524 @item -fno-inline
4525 @opindex fno-inline
4526 Don't pay attention to the @code{inline} keyword.  Normally this option
4527 is used to keep the compiler from expanding any functions inline.
4528 Note that if you are not optimizing, no functions can be expanded inline.
4530 @item -finline-functions
4531 @opindex finline-functions
4532 Integrate all simple functions into their callers.  The compiler
4533 heuristically decides which functions are simple enough to be worth
4534 integrating in this way.
4536 If all calls to a given function are integrated, and the function is
4537 declared @code{static}, then the function is normally not output as
4538 assembler code in its own right.
4540 Enabled at level @option{-O3}.
4542 @item -finline-functions-called-once
4543 @opindex finline-functions-called-once
4544 Consider all @code{static} functions called once for inlining into their
4545 caller even if they are not marked @code{inline}.  If a call to a given
4546 function is integrated, then the function is not output as assembler code
4547 in its own right.
4549 Enabled if @option{-funit-at-a-time} is enabled.
4551 @item -fearly-inlining
4552 @opindex fearly-inlining
4553 Inline functions marked by @code{always_inline} and functions whose body seems
4554 smaller than the function call overhead early before doing
4555 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4556 makes profiling significantly cheaper and usually inlining faster on programs
4557 having large chains of nested wrapper functions.
4559 Enabled by default.
4561 @item -finline-limit=@var{n}
4562 @opindex finline-limit
4563 By default, GCC limits the size of functions that can be inlined.  This flag
4564 allows the control of this limit for functions that are explicitly marked as
4565 inline (i.e., marked with the inline keyword or defined within the class
4566 definition in c++).  @var{n} is the size of functions that can be inlined in
4567 number of pseudo instructions (not counting parameter handling).  The default
4568 value of @var{n} is 600.
4569 Increasing this value can result in more inlined code at
4570 the cost of compilation time and memory consumption.  Decreasing usually makes
4571 the compilation faster and less code will be inlined (which presumably
4572 means slower programs).  This option is particularly useful for programs that
4573 use inlining heavily such as those based on recursive templates with C++.
4575 Inlining is actually controlled by a number of parameters, which may be
4576 specified individually by using @option{--param @var{name}=@var{value}}.
4577 The @option{-finline-limit=@var{n}} option sets some of these parameters
4578 as follows:
4580 @table @gcctabopt
4581 @item max-inline-insns-single
4582  is set to @var{n}/2.
4583 @item max-inline-insns-auto
4584  is set to @var{n}/2.
4585 @item min-inline-insns
4586  is set to 130 or @var{n}/4, whichever is smaller.
4587 @item max-inline-insns-rtl
4588  is set to @var{n}.
4589 @end table
4591 See below for a documentation of the individual
4592 parameters controlling inlining.
4594 @emph{Note:} pseudo instruction represents, in this particular context, an
4595 abstract measurement of function's size.  In no way does it represent a count
4596 of assembly instructions and as such its exact meaning might change from one
4597 release to an another.
4599 @item -fkeep-inline-functions
4600 @opindex fkeep-inline-functions
4601 In C, emit @code{static} functions that are declared @code{inline}
4602 into the object file, even if the function has been inlined into all
4603 of its callers.  This switch does not affect functions using the
4604 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4605 inline functions into the object file.
4607 @item -fkeep-static-consts
4608 @opindex fkeep-static-consts
4609 Emit variables declared @code{static const} when optimization isn't turned
4610 on, even if the variables aren't referenced.
4612 GCC enables this option by default.  If you want to force the compiler to
4613 check if the variable was referenced, regardless of whether or not
4614 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4616 @item -fmerge-constants
4617 @opindex fmerge-constants
4618 Attempt to merge identical constants (string constants and floating point
4619 constants) across compilation units.
4621 This option is the default for optimized compilation if the assembler and
4622 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4623 behavior.
4625 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4627 @item -fmerge-all-constants
4628 @opindex fmerge-all-constants
4629 Attempt to merge identical constants and identical variables.
4631 This option implies @option{-fmerge-constants}.  In addition to
4632 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4633 arrays or initialized constant variables with integral or floating point
4634 types.  Languages like C or C++ require each non-automatic variable to
4635 have distinct location, so using this option will result in non-conforming
4636 behavior.
4638 @item -fmodulo-sched
4639 @opindex fmodulo-sched
4640 Perform swing modulo scheduling immediately before the first scheduling
4641 pass.  This pass looks at innermost loops and reorders their
4642 instructions by overlapping different iterations.
4644 @item -fno-branch-count-reg
4645 @opindex fno-branch-count-reg
4646 Do not use ``decrement and branch'' instructions on a count register,
4647 but instead generate a sequence of instructions that decrement a
4648 register, compare it against zero, then branch based upon the result.
4649 This option is only meaningful on architectures that support such
4650 instructions, which include x86, PowerPC, IA-64 and S/390.
4652 The default is @option{-fbranch-count-reg}, enabled when
4653 @option{-fstrength-reduce} is enabled.
4655 @item -fno-function-cse
4656 @opindex fno-function-cse
4657 Do not put function addresses in registers; make each instruction that
4658 calls a constant function contain the function's address explicitly.
4660 This option results in less efficient code, but some strange hacks
4661 that alter the assembler output may be confused by the optimizations
4662 performed when this option is not used.
4664 The default is @option{-ffunction-cse}
4666 @item -fno-zero-initialized-in-bss
4667 @opindex fno-zero-initialized-in-bss
4668 If the target supports a BSS section, GCC by default puts variables that
4669 are initialized to zero into BSS@.  This can save space in the resulting
4670 code.
4672 This option turns off this behavior because some programs explicitly
4673 rely on variables going to the data section.  E.g., so that the
4674 resulting executable can find the beginning of that section and/or make
4675 assumptions based on that.
4677 The default is @option{-fzero-initialized-in-bss}.
4679 @item -fmudflap -fmudflapth -fmudflapir
4680 @opindex fmudflap
4681 @opindex fmudflapth
4682 @opindex fmudflapir
4683 @cindex bounds checking
4684 @cindex mudflap
4685 For front-ends that support it (C and C++), instrument all risky
4686 pointer/array dereferencing operations, some standard library
4687 string/heap functions, and some other associated constructs with
4688 range/validity tests.  Modules so instrumented should be immune to
4689 buffer overflows, invalid heap use, and some other classes of C/C++
4690 programming errors.  The instrumentation relies on a separate runtime
4691 library (@file{libmudflap}), which will be linked into a program if
4692 @option{-fmudflap} is given at link time.  Run-time behavior of the
4693 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4694 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4695 for its options.
4697 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4698 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4699 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4700 instrumentation should ignore pointer reads.  This produces less
4701 instrumentation (and therefore faster execution) and still provides
4702 some protection against outright memory corrupting writes, but allows
4703 erroneously read data to propagate within a program.
4705 @item -fstrength-reduce
4706 @opindex fstrength-reduce
4707 Perform the optimizations of loop strength reduction and
4708 elimination of iteration variables.
4710 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4712 @item -fthread-jumps
4713 @opindex fthread-jumps
4714 Perform optimizations where we check to see if a jump branches to a
4715 location where another comparison subsumed by the first is found.  If
4716 so, the first branch is redirected to either the destination of the
4717 second branch or a point immediately following it, depending on whether
4718 the condition is known to be true or false.
4720 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4722 @item -fcse-follow-jumps
4723 @opindex fcse-follow-jumps
4724 In common subexpression elimination, scan through jump instructions
4725 when the target of the jump is not reached by any other path.  For
4726 example, when CSE encounters an @code{if} statement with an
4727 @code{else} clause, CSE will follow the jump when the condition
4728 tested is false.
4730 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4732 @item -fcse-skip-blocks
4733 @opindex fcse-skip-blocks
4734 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4735 follow jumps which conditionally skip over blocks.  When CSE
4736 encounters a simple @code{if} statement with no else clause,
4737 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4738 body of the @code{if}.
4740 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4742 @item -frerun-cse-after-loop
4743 @opindex frerun-cse-after-loop
4744 Re-run common subexpression elimination after loop optimizations has been
4745 performed.
4747 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4749 @item -frerun-loop-opt
4750 @opindex frerun-loop-opt
4751 Run the loop optimizer twice.
4753 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4755 @item -fgcse
4756 @opindex fgcse
4757 Perform a global common subexpression elimination pass.
4758 This pass also performs global constant and copy propagation.
4760 @emph{Note:} When compiling a program using computed gotos, a GCC
4761 extension, you may get better runtime performance if you disable
4762 the global common subexpression elimination pass by adding
4763 @option{-fno-gcse} to the command line.
4765 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4767 @item -fgcse-lm
4768 @opindex fgcse-lm
4769 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4770 attempt to move loads which are only killed by stores into themselves.  This
4771 allows a loop containing a load/store sequence to be changed to a load outside
4772 the loop, and a copy/store within the loop.
4774 Enabled by default when gcse is enabled.
4776 @item -fgcse-sm
4777 @opindex fgcse-sm
4778 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4779 global common subexpression elimination.  This pass will attempt to move
4780 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4781 loops containing a load/store sequence can be changed to a load before
4782 the loop and a store after the loop.
4784 Not enabled at any optimization level.
4786 @item -fgcse-las
4787 @opindex fgcse-las
4788 When @option{-fgcse-las} is enabled, the global common subexpression
4789 elimination pass eliminates redundant loads that come after stores to the
4790 same memory location (both partial and full redundancies).
4792 Not enabled at any optimization level.
4794 @item -fgcse-after-reload
4795 @opindex fgcse-after-reload
4796 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4797 pass is performed after reload.  The purpose of this pass is to cleanup
4798 redundant spilling.
4800 @item -floop-optimize
4801 @opindex floop-optimize
4802 Perform loop optimizations: move constant expressions out of loops, simplify
4803 exit test conditions and optionally do strength-reduction as well.
4805 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4807 @item -floop-optimize2
4808 @opindex floop-optimize2
4809 Perform loop optimizations using the new loop optimizer.  The optimizations
4810 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4811 by separate flags.
4813 @item -funsafe-loop-optimizations
4814 @opindex funsafe-loop-optimizations
4815 If given, the loop optimizer will assume that loop indices do not
4816 overflow, and that the loops with nontrivial exit condition are not
4817 infinite.  This enables a wider range of loop optimizations even if
4818 the loop optimizer itself cannot prove that these assumptions are valid.
4819 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4820 if it finds this kind of loop.
4822 @item -fcrossjumping
4823 @opindex fcrossjumping
4824 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4825 resulting code may or may not perform better than without cross-jumping.
4827 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4829 @item -fif-conversion
4830 @opindex fif-conversion
4831 Attempt to transform conditional jumps into branch-less equivalents.  This
4832 include use of conditional moves, min, max, set flags and abs instructions, and
4833 some tricks doable by standard arithmetics.  The use of conditional execution
4834 on chips where it is available is controlled by @code{if-conversion2}.
4836 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4838 @item -fif-conversion2
4839 @opindex fif-conversion2
4840 Use conditional execution (where available) to transform conditional jumps into
4841 branch-less equivalents.
4843 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4845 @item -fdelete-null-pointer-checks
4846 @opindex fdelete-null-pointer-checks
4847 Use global dataflow analysis to identify and eliminate useless checks
4848 for null pointers.  The compiler assumes that dereferencing a null
4849 pointer would have halted the program.  If a pointer is checked after
4850 it has already been dereferenced, it cannot be null.
4852 In some environments, this assumption is not true, and programs can
4853 safely dereference null pointers.  Use
4854 @option{-fno-delete-null-pointer-checks} to disable this optimization
4855 for programs which depend on that behavior.
4857 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4859 @item -fexpensive-optimizations
4860 @opindex fexpensive-optimizations
4861 Perform a number of minor optimizations that are relatively expensive.
4863 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4865 @item -foptimize-register-move
4866 @itemx -fregmove
4867 @opindex foptimize-register-move
4868 @opindex fregmove
4869 Attempt to reassign register numbers in move instructions and as
4870 operands of other simple instructions in order to maximize the amount of
4871 register tying.  This is especially helpful on machines with two-operand
4872 instructions.
4874 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4875 optimization.
4877 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4879 @item -fdelayed-branch
4880 @opindex fdelayed-branch
4881 If supported for the target machine, attempt to reorder instructions
4882 to exploit instruction slots available after delayed branch
4883 instructions.
4885 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4887 @item -fschedule-insns
4888 @opindex fschedule-insns
4889 If supported for the target machine, attempt to reorder instructions to
4890 eliminate execution stalls due to required data being unavailable.  This
4891 helps machines that have slow floating point or memory load instructions
4892 by allowing other instructions to be issued until the result of the load
4893 or floating point instruction is required.
4895 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4897 @item -fschedule-insns2
4898 @opindex fschedule-insns2
4899 Similar to @option{-fschedule-insns}, but requests an additional pass of
4900 instruction scheduling after register allocation has been done.  This is
4901 especially useful on machines with a relatively small number of
4902 registers and where memory load instructions take more than one cycle.
4904 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4906 @item -fno-sched-interblock
4907 @opindex fno-sched-interblock
4908 Don't schedule instructions across basic blocks.  This is normally
4909 enabled by default when scheduling before register allocation, i.e.@:
4910 with @option{-fschedule-insns} or at @option{-O2} or higher.
4912 @item -fno-sched-spec
4913 @opindex fno-sched-spec
4914 Don't allow speculative motion of non-load instructions.  This is normally
4915 enabled by default when scheduling before register allocation, i.e.@:
4916 with @option{-fschedule-insns} or at @option{-O2} or higher.
4918 @item -fsched-spec-load
4919 @opindex fsched-spec-load
4920 Allow speculative motion of some load instructions.  This only makes
4921 sense when scheduling before register allocation, i.e.@: with
4922 @option{-fschedule-insns} or at @option{-O2} or higher.
4924 @item -fsched-spec-load-dangerous
4925 @opindex fsched-spec-load-dangerous
4926 Allow speculative motion of more load instructions.  This only makes
4927 sense when scheduling before register allocation, i.e.@: with
4928 @option{-fschedule-insns} or at @option{-O2} or higher.
4930 @item -fsched-stalled-insns
4931 @itemx -fsched-stalled-insns=@var{n}
4932 @opindex fsched-stalled-insns
4933 Define how many insns (if any) can be moved prematurely from the queue
4934 of stalled insns into the ready list, during the second scheduling pass.
4935 @option{-fno-fsched-stalled-insns} and @option{-fsched-stalled-insns=0}
4936 are equivalent and mean that no insns will be moved prematurely.
4937 If @var{n} is unspecified then there is no limit on how many queued
4938 insns can be moved prematurely.
4940 @item -fsched-stalled-insns-dep
4941 @itemx -fsched-stalled-insns-dep=@var{n}
4942 @opindex fsched-stalled-insns-dep
4943 Define how many insn groups (cycles) will be examined for a dependency
4944 on a stalled insn that is candidate for premature removal from the queue
4945 of stalled insns.  This has an effect only during the second scheduling pass,
4946 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4947 +@option{-fno-sched-stalled-insns-dep} is equivalent to
4948 +@option{-fsched-stalled-insns-dep=0}.
4949 +@option{-fsched-stalled-insns-dep} without a value is equivalent to
4950 +@option{-fsched-stalled-insns-dep=1}.
4952 @item -fsched2-use-superblocks
4953 @opindex fsched2-use-superblocks
4954 When scheduling after register allocation, do use superblock scheduling
4955 algorithm.  Superblock scheduling allows motion across basic block boundaries
4956 resulting on faster schedules.  This option is experimental, as not all machine
4957 descriptions used by GCC model the CPU closely enough to avoid unreliable
4958 results from the algorithm.
4960 This only makes sense when scheduling after register allocation, i.e.@: with
4961 @option{-fschedule-insns2} or at @option{-O2} or higher.
4963 @item -fsched2-use-traces
4964 @opindex fsched2-use-traces
4965 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4966 allocation and additionally perform code duplication in order to increase the
4967 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4968 trace formation.
4970 This mode should produce faster but significantly longer programs.  Also
4971 without @option{-fbranch-probabilities} the traces constructed may not
4972 match the reality and hurt the performance.  This only makes
4973 sense when scheduling after register allocation, i.e.@: with
4974 @option{-fschedule-insns2} or at @option{-O2} or higher.
4976 @item -freschedule-modulo-scheduled-loops
4977 @opindex freschedule-modulo-scheduled-loops
4978 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4979 we may want to prevent the later scheduling passes from changing its schedule, we use this
4980 option to control that.
4982 @item -fcaller-saves
4983 @opindex fcaller-saves
4984 Enable values to be allocated in registers that will be clobbered by
4985 function calls, by emitting extra instructions to save and restore the
4986 registers around such calls.  Such allocation is done only when it
4987 seems to result in better code than would otherwise be produced.
4989 This option is always enabled by default on certain machines, usually
4990 those which have no call-preserved registers to use instead.
4992 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4994 @item -ftree-pre
4995 @opindex ftree-pre
4996 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4997 enabled by default at @option{-O2} and @option{-O3}.
4999 @item -ftree-fre
5000 @opindex ftree-fre
5001 Perform Full Redundancy Elimination (FRE) on trees.  The difference
5002 between FRE and PRE is that FRE only considers expressions
5003 that are computed on all paths leading to the redundant computation.
5004 This analysis faster than PRE, though it exposes fewer redundancies.
5005 This flag is enabled by default at @option{-O} and higher.
5007 @item -ftree-copy-prop
5008 @opindex ftree-copy-prop
5009 Perform copy propagation on trees.  This pass eliminates unnecessary
5010 copy operations.  This flag is enabled by default at @option{-O} and
5011 higher.
5013 @item -ftree-store-copy-prop
5014 @opindex ftree-store-copy-prop
5015 Perform copy propagation of memory loads and stores.  This pass
5016 eliminates unnecessary copy operations in memory references
5017 (structures, global variables, arrays, etc).  This flag is enabled by
5018 default at @option{-O2} and higher.
5020 @item -ftree-salias
5021 @opindex ftree-salias
5022 Perform structural alias analysis on trees.  This flag
5023 is enabled by default at @option{-O} and higher.
5025 @item -ftree-sink
5026 @opindex ftree-sink
5027 Perform forward store motion  on trees.  This flag is
5028 enabled by default at @option{-O} and higher.
5030 @item -ftree-ccp
5031 @opindex ftree-ccp
5032 Perform sparse conditional constant propagation (CCP) on trees.  This
5033 pass only operates on local scalar variables and is enabled by default
5034 at @option{-O} and higher.
5036 @item -ftree-store-ccp
5037 @opindex ftree-store-ccp
5038 Perform sparse conditional constant propagation (CCP) on trees.  This
5039 pass operates on both local scalar variables and memory stores and
5040 loads (global variables, structures, arrays, etc).  This flag is
5041 enabled by default at @option{-O2} and higher.
5043 @item -ftree-dce
5044 @opindex ftree-dce
5045 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5046 default at @option{-O} and higher.
5048 @item -ftree-dominator-opts
5049 @opindex ftree-dominator-opts
5050 Perform a variety of simple scalar cleanups (constant/copy
5051 propagation, redundancy elimination, range propagation and expression
5052 simplification) based on a dominator tree traversal.  This also
5053 performs jump threading (to reduce jumps to jumps).  This flag is
5054 enabled by default at @option{-O} and higher.
5056 @item -ftree-ch
5057 @opindex ftree-ch
5058 Perform loop header copying on trees.  This is beneficial since it increases
5059 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5060 is enabled by default at @option{-O} and higher.  It is not enabled
5061 for @option{-Os}, since it usually increases code size.
5063 @item -ftree-loop-optimize
5064 @opindex ftree-loop-optimize
5065 Perform loop optimizations on trees.  This flag is enabled by default
5066 at @option{-O} and higher.
5068 @item -ftree-loop-linear
5069 @opindex ftree-loop-linear
5070 Perform linear loop transformations on tree.  This flag can improve cache
5071 performance and allow further loop optimizations to take place.
5073 @item -ftree-loop-im
5074 @opindex ftree-loop-im
5075 Perform loop invariant motion on trees.  This pass moves only invariants that
5076 would be hard to handle at RTL level (function calls, operations that expand to
5077 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5078 operands of conditions that are invariant out of the loop, so that we can use
5079 just trivial invariantness analysis in loop unswitching.  The pass also includes
5080 store motion.
5082 @item -ftree-loop-ivcanon
5083 @opindex ftree-loop-ivcanon
5084 Create a canonical counter for number of iterations in the loop for that
5085 determining number of iterations requires complicated analysis.  Later
5086 optimizations then may determine the number easily.  Useful especially
5087 in connection with unrolling.
5089 @item -fivopts
5090 @opindex fivopts
5091 Perform induction variable optimizations (strength reduction, induction
5092 variable merging and induction variable elimination) on trees.
5094 @item -ftree-sra
5095 @opindex ftree-sra
5096 Perform scalar replacement of aggregates.  This pass replaces structure
5097 references with scalars to prevent committing structures to memory too
5098 early.  This flag is enabled by default at @option{-O} and higher.
5100 @item -ftree-copyrename
5101 @opindex ftree-copyrename
5102 Perform copy renaming on trees.  This pass attempts to rename compiler
5103 temporaries to other variables at copy locations, usually resulting in
5104 variable names which more closely resemble the original variables.  This flag
5105 is enabled by default at @option{-O} and higher.
5107 @item -ftree-ter
5108 @opindex ftree-ter
5109 Perform temporary expression replacement during the SSA->normal phase.  Single
5110 use/single def temporaries are replaced at their use location with their
5111 defining expression.  This results in non-GIMPLE code, but gives the expanders
5112 much more complex trees to work on resulting in better RTL generation.  This is
5113 enabled by default at @option{-O} and higher.
5115 @item -ftree-lrs
5116 @opindex ftree-lrs
5117 Perform live range splitting during the SSA->normal phase.  Distinct live
5118 ranges of a variable are split into unique variables, allowing for better
5119 optimization later.  This is enabled by default at @option{-O} and higher.
5121 @item -ftree-vectorize
5122 @opindex ftree-vectorize
5123 Perform loop vectorization on trees.
5125 @item -ftree-vect-loop-version
5126 @opindex ftree-vect-loop-version
5127 Perform loop versioning when doing loop vectorization on trees.  When a loop
5128 appears to be vectorizable except that data alignment or data dependence cannot
5129 be determined at compile time then vectorized and non-vectorized versions of
5130 the loop are generated along with runtime checks for alignment or dependence
5131 to control which version is executed.  This option is enabled by default
5132 except at level @option{-Os} where it is disabled.
5134 @item -ftree-vrp
5135 @opindex ftree-vrp
5136 Perform Value Range Propagation on trees.  This is similar to the
5137 constant propagation pass, but instead of values, ranges of values are
5138 propagated.  This allows the optimizers to remove unnecessary range
5139 checks like array bound checks and null pointer checks.  This is
5140 enabled by default at @option{-O2} and higher.  Null pointer check
5141 elimination is only done if @option{-fdelete-null-pointer-checks} is
5142 enabled.
5144 @item -ftracer
5145 @opindex ftracer
5146 Perform tail duplication to enlarge superblock size.  This transformation
5147 simplifies the control flow of the function allowing other optimizations to do
5148 better job.
5150 @item -funroll-loops
5151 @opindex funroll-loops
5152 Unroll loops whose number of iterations can be determined at compile
5153 time or upon entry to the loop.  @option{-funroll-loops} implies both
5154 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5155 option makes code larger, and may or may not make it run faster.
5157 @item -funroll-all-loops
5158 @opindex funroll-all-loops
5159 Unroll all loops, even if their number of iterations is uncertain when
5160 the loop is entered.  This usually makes programs run more slowly.
5161 @option{-funroll-all-loops} implies the same options as
5162 @option{-funroll-loops},
5164 @item -fsplit-ivs-in-unroller
5165 @opindex fsplit-ivs-in-unroller
5166 Enables expressing of values of induction variables in later iterations
5167 of the unrolled loop using the value in the first iteration.  This breaks
5168 long dependency chains, thus improving efficiency of the scheduling passes.
5170 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5171 same effect.  However in cases the loop body is more complicated than
5172 a single basic block, this is not reliable.  It also does not work at all
5173 on some of the architectures due to restrictions in the CSE pass.
5175 This optimization is enabled by default.
5177 @item -fvariable-expansion-in-unroller
5178 @opindex fvariable-expansion-in-unroller
5179 With this option, the compiler will create multiple copies of some
5180 local variables when unrolling a loop which can result in superior code.
5182 @item -fprefetch-loop-arrays
5183 @opindex fprefetch-loop-arrays
5184 If supported by the target machine, generate instructions to prefetch
5185 memory to improve the performance of loops that access large arrays.
5187 These options may generate better or worse code; results are highly
5188 dependent on the structure of loops within the source code.
5190 @item -fno-peephole
5191 @itemx -fno-peephole2
5192 @opindex fno-peephole
5193 @opindex fno-peephole2
5194 Disable any machine-specific peephole optimizations.  The difference
5195 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5196 are implemented in the compiler; some targets use one, some use the
5197 other, a few use both.
5199 @option{-fpeephole} is enabled by default.
5200 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5202 @item -fno-guess-branch-probability
5203 @opindex fno-guess-branch-probability
5204 Do not guess branch probabilities using heuristics.
5206 GCC will use heuristics to guess branch probabilities if they are
5207 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5208 heuristics are based on the control flow graph.  If some branch probabilities
5209 are specified by @samp{__builtin_expect}, then the heuristics will be
5210 used to guess branch probabilities for the rest of the control flow graph,
5211 taking the @samp{__builtin_expect} info into account.  The interactions
5212 between the heuristics and @samp{__builtin_expect} can be complex, and in
5213 some cases, it may be useful to disable the heuristics so that the effects
5214 of @samp{__builtin_expect} are easier to understand.
5216 The default is @option{-fguess-branch-probability} at levels
5217 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5219 @item -freorder-blocks
5220 @opindex freorder-blocks
5221 Reorder basic blocks in the compiled function in order to reduce number of
5222 taken branches and improve code locality.
5224 Enabled at levels @option{-O2}, @option{-O3}.
5226 @item -freorder-blocks-and-partition
5227 @opindex freorder-blocks-and-partition
5228 In addition to reordering basic blocks in the compiled function, in order
5229 to reduce number of taken branches, partitions hot and cold basic blocks
5230 into separate sections of the assembly and .o files, to improve
5231 paging and cache locality performance.
5233 This optimization is automatically turned off in the presence of
5234 exception handling, for linkonce sections, for functions with a user-defined
5235 section attribute and on any architecture that does not support named
5236 sections.
5238 @item -freorder-functions
5239 @opindex freorder-functions
5240 Reorder functions in the object file in order to
5241 improve code locality.  This is implemented by using special
5242 subsections @code{.text.hot} for most frequently executed functions and
5243 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5244 the linker so object file format must support named sections and linker must
5245 place them in a reasonable way.
5247 Also profile feedback must be available in to make this option effective.  See
5248 @option{-fprofile-arcs} for details.
5250 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5252 @item -fstrict-aliasing
5253 @opindex fstrict-aliasing
5254 Allows the compiler to assume the strictest aliasing rules applicable to
5255 the language being compiled.  For C (and C++), this activates
5256 optimizations based on the type of expressions.  In particular, an
5257 object of one type is assumed never to reside at the same address as an
5258 object of a different type, unless the types are almost the same.  For
5259 example, an @code{unsigned int} can alias an @code{int}, but not a
5260 @code{void*} or a @code{double}.  A character type may alias any other
5261 type.
5263 Pay special attention to code like this:
5264 @smallexample
5265 union a_union @{
5266   int i;
5267   double d;
5270 int f() @{
5271   a_union t;
5272   t.d = 3.0;
5273   return t.i;
5275 @end smallexample
5276 The practice of reading from a different union member than the one most
5277 recently written to (called ``type-punning'') is common.  Even with
5278 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5279 is accessed through the union type.  So, the code above will work as
5280 expected.  However, this code might not:
5281 @smallexample
5282 int f() @{
5283   a_union t;
5284   int* ip;
5285   t.d = 3.0;
5286   ip = &t.i;
5287   return *ip;
5289 @end smallexample
5291 Every language that wishes to perform language-specific alias analysis
5292 should define a function that computes, given an @code{tree}
5293 node, an alias set for the node.  Nodes in different alias sets are not
5294 allowed to alias.  For an example, see the C front-end function
5295 @code{c_get_alias_set}.
5297 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5299 @item -falign-functions
5300 @itemx -falign-functions=@var{n}
5301 @opindex falign-functions
5302 Align the start of functions to the next power-of-two greater than
5303 @var{n}, skipping up to @var{n} bytes.  For instance,
5304 @option{-falign-functions=32} aligns functions to the next 32-byte
5305 boundary, but @option{-falign-functions=24} would align to the next
5306 32-byte boundary only if this can be done by skipping 23 bytes or less.
5308 @option{-fno-align-functions} and @option{-falign-functions=1} are
5309 equivalent and mean that functions will not be aligned.
5311 Some assemblers only support this flag when @var{n} is a power of two;
5312 in that case, it is rounded up.
5314 If @var{n} is not specified or is zero, use a machine-dependent default.
5316 Enabled at levels @option{-O2}, @option{-O3}.
5318 @item -falign-labels
5319 @itemx -falign-labels=@var{n}
5320 @opindex falign-labels
5321 Align all branch targets to a power-of-two boundary, skipping up to
5322 @var{n} bytes like @option{-falign-functions}.  This option can easily
5323 make code slower, because it must insert dummy operations for when the
5324 branch target is reached in the usual flow of the code.
5326 @option{-fno-align-labels} and @option{-falign-labels=1} are
5327 equivalent and mean that labels will not be aligned.
5329 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5330 are greater than this value, then their values are used instead.
5332 If @var{n} is not specified or is zero, use a machine-dependent default
5333 which is very likely to be @samp{1}, meaning no alignment.
5335 Enabled at levels @option{-O2}, @option{-O3}.
5337 @item -falign-loops
5338 @itemx -falign-loops=@var{n}
5339 @opindex falign-loops
5340 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5341 like @option{-falign-functions}.  The hope is that the loop will be
5342 executed many times, which will make up for any execution of the dummy
5343 operations.
5345 @option{-fno-align-loops} and @option{-falign-loops=1} are
5346 equivalent and mean that loops will not be aligned.
5348 If @var{n} is not specified or is zero, use a machine-dependent default.
5350 Enabled at levels @option{-O2}, @option{-O3}.
5352 @item -falign-jumps
5353 @itemx -falign-jumps=@var{n}
5354 @opindex falign-jumps
5355 Align branch targets to a power-of-two boundary, for branch targets
5356 where the targets can only be reached by jumping, skipping up to @var{n}
5357 bytes like @option{-falign-functions}.  In this case, no dummy operations
5358 need be executed.
5360 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5361 equivalent and mean that loops will not be aligned.
5363 If @var{n} is not specified or is zero, use a machine-dependent default.
5365 Enabled at levels @option{-O2}, @option{-O3}.
5367 @item -funit-at-a-time
5368 @opindex funit-at-a-time
5369 Parse the whole compilation unit before starting to produce code.
5370 This allows some extra optimizations to take place but consumes
5371 more memory (in general).  There are some compatibility issues
5372 with @emph{unit-at-at-time} mode:
5373 @itemize @bullet
5374 @item
5375 enabling @emph{unit-at-a-time} mode may change the order
5376 in which functions, variables, and top-level @code{asm} statements
5377 are emitted, and will likely break code relying on some particular
5378 ordering.  The majority of such top-level @code{asm} statements,
5379 though, can be replaced by @code{section} attributes.
5381 @item
5382 @emph{unit-at-a-time} mode removes unreferenced static variables
5383 and functions.  This may result in undefined references
5384 when an @code{asm} statement refers directly to variables or functions
5385 that are otherwise unused.  In that case either the variable/function
5386 shall be listed as an operand of the @code{asm} statement operand or,
5387 in the case of top-level @code{asm} statements the attribute @code{used}
5388 shall be used on the declaration.
5390 @item
5391 Static functions now can use non-standard passing conventions that
5392 may break @code{asm} statements calling functions directly.  Again,
5393 attribute @code{used} will prevent this behavior.
5394 @end itemize
5396 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5397 but this scheme may not be supported by future releases of GCC@.
5399 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5401 @item -fweb
5402 @opindex fweb
5403 Constructs webs as commonly used for register allocation purposes and assign
5404 each web individual pseudo register.  This allows the register allocation pass
5405 to operate on pseudos directly, but also strengthens several other optimization
5406 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5407 however, make debugging impossible, since variables will no longer stay in a
5408 ``home register''.
5410 Enabled by default with @option{-funroll-loops}.
5412 @item -fwhole-program
5413 @opindex fwhole-program
5414 Assume that the current compilation unit represents whole program being
5415 compiled.  All public functions and variables with the exception of @code{main}
5416 and those merged by attribute @code{externally_visible} become static functions
5417 and in a affect gets more aggressively optimized by interprocedural optimizers.
5418 While this option is equivalent to proper use of @code{static} keyword for
5419 programs consisting of single file, in combination with option
5420 @option{--combine} this flag can be used to compile most of smaller scale C
5421 programs since the functions and variables become local for the whole combined
5422 compilation unit, not for the single source file itself.
5425 @item -fcprop-registers
5426 @opindex fcprop-registers
5427 After register allocation and post-register allocation instruction splitting,
5428 we perform a copy-propagation pass to try to reduce scheduling dependencies
5429 and occasionally eliminate the copy.
5431 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5433 @item -fprofile-generate
5434 @opindex fprofile-generate
5436 Enable options usually used for instrumenting application to produce
5437 profile useful for later recompilation with profile feedback based
5438 optimization.  You must use @option{-fprofile-generate} both when
5439 compiling and when linking your program.
5441 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5443 @item -fprofile-use
5444 @opindex fprofile-use
5445 Enable profile feedback directed optimizations, and optimizations
5446 generally profitable only with profile feedback available.
5448 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5449 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5450 @code{-fno-loop-optimize}.
5452 @end table
5454 The following options control compiler behavior regarding floating
5455 point arithmetic.  These options trade off between speed and
5456 correctness.  All must be specifically enabled.
5458 @table @gcctabopt
5459 @item -ffloat-store
5460 @opindex ffloat-store
5461 Do not store floating point variables in registers, and inhibit other
5462 options that might change whether a floating point value is taken from a
5463 register or memory.
5465 @cindex floating point precision
5466 This option prevents undesirable excess precision on machines such as
5467 the 68000 where the floating registers (of the 68881) keep more
5468 precision than a @code{double} is supposed to have.  Similarly for the
5469 x86 architecture.  For most programs, the excess precision does only
5470 good, but a few programs rely on the precise definition of IEEE floating
5471 point.  Use @option{-ffloat-store} for such programs, after modifying
5472 them to store all pertinent intermediate computations into variables.
5474 @item -ffast-math
5475 @opindex ffast-math
5476 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5477 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5478 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5479 and @option{fcx-limited-range}.
5481 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5483 This option should never be turned on by any @option{-O} option since
5484 it can result in incorrect output for programs which depend on
5485 an exact implementation of IEEE or ISO rules/specifications for
5486 math functions.
5488 @item -fno-math-errno
5489 @opindex fno-math-errno
5490 Do not set ERRNO after calling math functions that are executed
5491 with a single instruction, e.g., sqrt.  A program that relies on
5492 IEEE exceptions for math error handling may want to use this flag
5493 for speed while maintaining IEEE arithmetic compatibility.
5495 This option should never be turned on by any @option{-O} option since
5496 it can result in incorrect output for programs which depend on
5497 an exact implementation of IEEE or ISO rules/specifications for
5498 math functions.
5500 The default is @option{-fmath-errno}.
5502 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5503 no reason for the compiler to consider the possibility that it might,
5504 and @option{-fno-math-errno} is the default.
5506 @item -funsafe-math-optimizations
5507 @opindex funsafe-math-optimizations
5508 Allow optimizations for floating-point arithmetic that (a) assume
5509 that arguments and results are valid and (b) may violate IEEE or
5510 ANSI standards.  When used at link-time, it may include libraries
5511 or startup files that change the default FPU control word or other
5512 similar optimizations.
5514 This option should never be turned on by any @option{-O} option since
5515 it can result in incorrect output for programs which depend on
5516 an exact implementation of IEEE or ISO rules/specifications for
5517 math functions.
5519 The default is @option{-fno-unsafe-math-optimizations}.
5521 @item -ffinite-math-only
5522 @opindex ffinite-math-only
5523 Allow optimizations for floating-point arithmetic that assume
5524 that arguments and results are not NaNs or +-Infs.
5526 This option should never be turned on by any @option{-O} option since
5527 it can result in incorrect output for programs which depend on
5528 an exact implementation of IEEE or ISO rules/specifications.
5530 The default is @option{-fno-finite-math-only}.
5532 @item -fno-trapping-math
5533 @opindex fno-trapping-math
5534 Compile code assuming that floating-point operations cannot generate
5535 user-visible traps.  These traps include division by zero, overflow,
5536 underflow, inexact result and invalid operation.  This option implies
5537 @option{-fno-signaling-nans}.  Setting this option may allow faster
5538 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5540 This option should never be turned on by any @option{-O} option since
5541 it can result in incorrect output for programs which depend on
5542 an exact implementation of IEEE or ISO rules/specifications for
5543 math functions.
5545 The default is @option{-ftrapping-math}.
5547 @item -frounding-math
5548 @opindex frounding-math
5549 Disable transformations and optimizations that assume default floating
5550 point rounding behavior.  This is round-to-zero for all floating point
5551 to integer conversions, and round-to-nearest for all other arithmetic
5552 truncations.  This option should be specified for programs that change
5553 the FP rounding mode dynamically, or that may be executed with a
5554 non-default rounding mode.  This option disables constant folding of
5555 floating point expressions at compile-time (which may be affected by
5556 rounding mode) and arithmetic transformations that are unsafe in the
5557 presence of sign-dependent rounding modes.
5559 The default is @option{-fno-rounding-math}.
5561 This option is experimental and does not currently guarantee to
5562 disable all GCC optimizations that are affected by rounding mode.
5563 Future versions of GCC may provide finer control of this setting
5564 using C99's @code{FENV_ACCESS} pragma.  This command line option
5565 will be used to specify the default state for @code{FENV_ACCESS}.
5567 @item -fsignaling-nans
5568 @opindex fsignaling-nans
5569 Compile code assuming that IEEE signaling NaNs may generate user-visible
5570 traps during floating-point operations.  Setting this option disables
5571 optimizations that may change the number of exceptions visible with
5572 signaling NaNs.  This option implies @option{-ftrapping-math}.
5574 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5575 be defined.
5577 The default is @option{-fno-signaling-nans}.
5579 This option is experimental and does not currently guarantee to
5580 disable all GCC optimizations that affect signaling NaN behavior.
5582 @item -fsingle-precision-constant
5583 @opindex fsingle-precision-constant
5584 Treat floating point constant as single precision constant instead of
5585 implicitly converting it to double precision constant.
5587 @item -fcx-limited-range
5588 @opindex fcx-limited-range
5589 When enabled, this option states that a range reduction step is not
5590 needed when performing complex division.  The default is
5591 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5593 This option controls the default setting of the ISO C99 
5594 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5595 all languages.
5597 @end table
5599 The following options control optimizations that may improve
5600 performance, but are not enabled by any @option{-O} options.  This
5601 section includes experimental options that may produce broken code.
5603 @table @gcctabopt
5604 @item -fbranch-probabilities
5605 @opindex fbranch-probabilities
5606 After running a program compiled with @option{-fprofile-arcs}
5607 (@pxref{Debugging Options,, Options for Debugging Your Program or
5608 @command{gcc}}), you can compile it a second time using
5609 @option{-fbranch-probabilities}, to improve optimizations based on
5610 the number of times each branch was taken.  When the program
5611 compiled with @option{-fprofile-arcs} exits it saves arc execution
5612 counts to a file called @file{@var{sourcename}.gcda} for each source
5613 file  The information in this data file is very dependent on the
5614 structure of the generated code, so you must use the same source code
5615 and the same optimization options for both compilations.
5617 With @option{-fbranch-probabilities}, GCC puts a
5618 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5619 These can be used to improve optimization.  Currently, they are only
5620 used in one place: in @file{reorg.c}, instead of guessing which path a
5621 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5622 exactly determine which path is taken more often.
5624 @item -fprofile-values
5625 @opindex fprofile-values
5626 If combined with @option{-fprofile-arcs}, it adds code so that some
5627 data about values of expressions in the program is gathered.
5629 With @option{-fbranch-probabilities}, it reads back the data gathered
5630 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5631 notes to instructions for their later usage in optimizations.
5633 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5635 @item -fvpt
5636 @opindex fvpt
5637 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5638 a code to gather information about values of expressions.
5640 With @option{-fbranch-probabilities}, it reads back the data gathered
5641 and actually performs the optimizations based on them.
5642 Currently the optimizations include specialization of division operation
5643 using the knowledge about the value of the denominator.
5645 @item -frename-registers
5646 @opindex frename-registers
5647 Attempt to avoid false dependencies in scheduled code by making use
5648 of registers left over after register allocation.  This optimization
5649 will most benefit processors with lots of registers.  Depending on the
5650 debug information format adopted by the target, however, it can
5651 make debugging impossible, since variables will no longer stay in
5652 a ``home register''.
5654 Enabled by default with @option{-funroll-loops}.
5656 @item -ftracer
5657 @opindex ftracer
5658 Perform tail duplication to enlarge superblock size.  This transformation
5659 simplifies the control flow of the function allowing other optimizations to do
5660 better job.
5662 Enabled with @option{-fprofile-use}.
5664 @item -funroll-loops
5665 @opindex funroll-loops
5666 Unroll loops whose number of iterations can be determined at compile time or
5667 upon entry to the loop.  @option{-funroll-loops} implies
5668 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5669 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5670 small constant number of iterations).  This option makes code larger, and may
5671 or may not make it run faster.
5673 Enabled with @option{-fprofile-use}.
5675 @item -funroll-all-loops
5676 @opindex funroll-all-loops
5677 Unroll all loops, even if their number of iterations is uncertain when
5678 the loop is entered.  This usually makes programs run more slowly.
5679 @option{-funroll-all-loops} implies the same options as
5680 @option{-funroll-loops}.
5682 @item -fpeel-loops
5683 @opindex fpeel-loops
5684 Peels the loops for that there is enough information that they do not
5685 roll much (from profile feedback).  It also turns on complete loop peeling
5686 (i.e.@: complete removal of loops with small constant number of iterations).
5688 Enabled with @option{-fprofile-use}.
5690 @item -fmove-loop-invariants
5691 @opindex fmove-loop-invariants
5692 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5693 at level @option{-O1}
5695 @item -funswitch-loops
5696 @opindex funswitch-loops
5697 Move branches with loop invariant conditions out of the loop, with duplicates
5698 of the loop on both branches (modified according to result of the condition).
5700 @item -fprefetch-loop-arrays
5701 @opindex fprefetch-loop-arrays
5702 If supported by the target machine, generate instructions to prefetch
5703 memory to improve the performance of loops that access large arrays.
5705 Disabled at level @option{-Os}.
5707 @item -ffunction-sections
5708 @itemx -fdata-sections
5709 @opindex ffunction-sections
5710 @opindex fdata-sections
5711 Place each function or data item into its own section in the output
5712 file if the target supports arbitrary sections.  The name of the
5713 function or the name of the data item determines the section's name
5714 in the output file.
5716 Use these options on systems where the linker can perform optimizations
5717 to improve locality of reference in the instruction space.  Most systems
5718 using the ELF object format and SPARC processors running Solaris 2 have
5719 linkers with such optimizations.  AIX may have these optimizations in
5720 the future.
5722 Only use these options when there are significant benefits from doing
5723 so.  When you specify these options, the assembler and linker will
5724 create larger object and executable files and will also be slower.
5725 You will not be able to use @code{gprof} on all systems if you
5726 specify this option and you may have problems with debugging if
5727 you specify both this option and @option{-g}.
5729 @item -fbranch-target-load-optimize
5730 @opindex fbranch-target-load-optimize
5731 Perform branch target register load optimization before prologue / epilogue
5732 threading.
5733 The use of target registers can typically be exposed only during reload,
5734 thus hoisting loads out of loops and doing inter-block scheduling needs
5735 a separate optimization pass.
5737 @item -fbranch-target-load-optimize2
5738 @opindex fbranch-target-load-optimize2
5739 Perform branch target register load optimization after prologue / epilogue
5740 threading.
5742 @item -fbtr-bb-exclusive
5743 @opindex fbtr-bb-exclusive
5744 When performing branch target register load optimization, don't reuse
5745 branch target registers in within any basic block.
5747 @item -fstack-protector
5748 @opindex fstack-protector
5749 Emit extra code to check for buffer overflows, such as stack smashing
5750 attacks.  This is done by adding a guard variable to functions with
5751 vulnerable objects.  This includes functions that call alloca, and
5752 functions with buffers larger than 8 bytes.  The guards are initialized
5753 when a function is entered and then checked when the function exits.
5754 If a guard check fails, an error message is printed and the program exits.
5756 @item -fstack-protector-all
5757 @opindex fstack-protector-all
5758 Like @option{-fstack-protector} except that all functions are protected.
5760 @item --param @var{name}=@var{value}
5761 @opindex param
5762 In some places, GCC uses various constants to control the amount of
5763 optimization that is done.  For example, GCC will not inline functions
5764 that contain more that a certain number of instructions.  You can
5765 control some of these constants on the command-line using the
5766 @option{--param} option.
5768 The names of specific parameters, and the meaning of the values, are
5769 tied to the internals of the compiler, and are subject to change
5770 without notice in future releases.
5772 In each case, the @var{value} is an integer.  The allowable choices for
5773 @var{name} are given in the following table:
5775 @table @gcctabopt
5776 @item salias-max-implicit-fields
5777 The maximum number of fields in a variable without direct
5778 structure accesses for which structure aliasing will consider trying 
5779 to track each field.  The default is 5
5781 @item sra-max-structure-size
5782 The maximum structure size, in bytes, at which the scalar replacement
5783 of aggregates (SRA) optimization will perform block copies.  The
5784 default value, 0, implies that GCC will select the most appropriate
5785 size itself.
5787 @item sra-field-structure-ratio
5788 The threshold ratio (as a percentage) between instantiated fields and
5789 the complete structure size.  We say that if the ratio of the number
5790 of bytes in instantiated fields to the number of bytes in the complete
5791 structure exceeds this parameter, then block copies are not used.  The
5792 default is 75.
5794 @item max-crossjump-edges
5795 The maximum number of incoming edges to consider for crossjumping.
5796 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5797 the number of edges incoming to each block.  Increasing values mean
5798 more aggressive optimization, making the compile time increase with
5799 probably small improvement in executable size.
5801 @item min-crossjump-insns
5802 The minimum number of instructions which must be matched at the end
5803 of two blocks before crossjumping will be performed on them.  This
5804 value is ignored in the case where all instructions in the block being
5805 crossjumped from are matched.  The default value is 5.
5807 @item max-grow-copy-bb-insns
5808 The maximum code size expansion factor when copying basic blocks
5809 instead of jumping.  The expansion is relative to a jump instruction.
5810 The default value is 8.
5812 @item max-goto-duplication-insns
5813 The maximum number of instructions to duplicate to a block that jumps
5814 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5815 passes, GCC factors computed gotos early in the compilation process,
5816 and unfactors them as late as possible.  Only computed jumps at the
5817 end of a basic blocks with no more than max-goto-duplication-insns are
5818 unfactored.  The default value is 8.
5820 @item max-delay-slot-insn-search
5821 The maximum number of instructions to consider when looking for an
5822 instruction to fill a delay slot.  If more than this arbitrary number of
5823 instructions is searched, the time savings from filling the delay slot
5824 will be minimal so stop searching.  Increasing values mean more
5825 aggressive optimization, making the compile time increase with probably
5826 small improvement in executable run time.
5828 @item max-delay-slot-live-search
5829 When trying to fill delay slots, the maximum number of instructions to
5830 consider when searching for a block with valid live register
5831 information.  Increasing this arbitrarily chosen value means more
5832 aggressive optimization, increasing the compile time.  This parameter
5833 should be removed when the delay slot code is rewritten to maintain the
5834 control-flow graph.
5836 @item max-gcse-memory
5837 The approximate maximum amount of memory that will be allocated in
5838 order to perform the global common subexpression elimination
5839 optimization.  If more memory than specified is required, the
5840 optimization will not be done.
5842 @item max-gcse-passes
5843 The maximum number of passes of GCSE to run.  The default is 1.
5845 @item max-pending-list-length
5846 The maximum number of pending dependencies scheduling will allow
5847 before flushing the current state and starting over.  Large functions
5848 with few branches or calls can create excessively large lists which
5849 needlessly consume memory and resources.
5851 @item max-inline-insns-single
5852 Several parameters control the tree inliner used in gcc.
5853 This number sets the maximum number of instructions (counted in GCC's
5854 internal representation) in a single function that the tree inliner
5855 will consider for inlining.  This only affects functions declared
5856 inline and methods implemented in a class declaration (C++).
5857 The default value is 450.
5859 @item max-inline-insns-auto
5860 When you use @option{-finline-functions} (included in @option{-O3}),
5861 a lot of functions that would otherwise not be considered for inlining
5862 by the compiler will be investigated.  To those functions, a different
5863 (more restrictive) limit compared to functions declared inline can
5864 be applied.
5865 The default value is 90.
5867 @item large-function-insns
5868 The limit specifying really large functions.  For functions larger than this
5869 limit after inlining inlining is constrained by
5870 @option{--param large-function-growth}.  This parameter is useful primarily
5871 to avoid extreme compilation time caused by non-linear algorithms used by the
5872 backend.
5873 This parameter is ignored when @option{-funit-at-a-time} is not used.
5874 The default value is 2700.
5876 @item large-function-growth
5877 Specifies maximal growth of large function caused by inlining in percents.
5878 This parameter is ignored when @option{-funit-at-a-time} is not used.
5879 The default value is 100 which limits large function growth to 2.0 times
5880 the original size.
5882 @item large-unit-insns
5883 The limit specifying large translation unit.  Growth caused by inlining of
5884 units larger than this limit is limited by @option{--param inline-unit-growth}.
5885 For small units this might be too tight (consider unit consisting of function A
5886 that is inline and B that just calls A three time.  If B is small relative to
5887 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
5888 large units consisting of small inlininable functions however the overall unit
5889 growth limit is needed to avoid exponential explosion of code size.  Thus for
5890 smaller units, the size is increased to @option{--param large-unit-insns}
5891 before aplying @option{--param inline-unit-growth}.  The default is 10000
5893 @item inline-unit-growth
5894 Specifies maximal overall growth of the compilation unit caused by inlining.
5895 This parameter is ignored when @option{-funit-at-a-time} is not used.
5896 The default value is 50 which limits unit growth to 1.5 times the original
5897 size.
5899 @item max-inline-insns-recursive
5900 @itemx max-inline-insns-recursive-auto
5901 Specifies maximum number of instructions out-of-line copy of self recursive inline
5902 function can grow into by performing recursive inlining.
5904 For functions declared inline @option{--param max-inline-insns-recursive} is
5905 taken into account.  For function not declared inline, recursive inlining
5906 happens only when @option{-finline-functions} (included in @option{-O3}) is
5907 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5908 default value is 450.
5910 @item max-inline-recursive-depth
5911 @itemx max-inline-recursive-depth-auto
5912 Specifies maximum recursion depth used by the recursive inlining.
5914 For functions declared inline @option{--param max-inline-recursive-depth} is
5915 taken into account.  For function not declared inline, recursive inlining
5916 happens only when @option{-finline-functions} (included in @option{-O3}) is
5917 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5918 default value is 450.
5920 @item min-inline-recursive-probability
5921 Recursive inlining is profitable only for function having deep recursion
5922 in average and can hurt for function having little recursion depth by
5923 increasing the prologue size or complexity of function body to other
5924 optimizers.
5926 When profile feedback is available (see @option{-fprofile-generate}) the actual
5927 recursion depth can be guessed from probability that function will recurse via
5928 given call expression.  This parameter limits inlining only to call expression
5929 whose probability exceeds given threshold (in percents).  The default value is
5932 @item inline-call-cost
5933 Specify cost of call instruction relative to simple arithmetics operations
5934 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5935 functions and at the same time increases size of leaf function that is believed to
5936 reduce function size by being inlined.  In effect it increases amount of
5937 inlining for code having large abstraction penalty (many functions that just
5938 pass the arguments to other functions) and decrease inlining for code with low
5939 abstraction penalty.  The default value is 16.
5941 @item max-unrolled-insns
5942 The maximum number of instructions that a loop should have if that loop
5943 is unrolled, and if the loop is unrolled, it determines how many times
5944 the loop code is unrolled.
5946 @item max-average-unrolled-insns
5947 The maximum number of instructions biased by probabilities of their execution
5948 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5949 it determines how many times the loop code is unrolled.
5951 @item max-unroll-times
5952 The maximum number of unrollings of a single loop.
5954 @item max-peeled-insns
5955 The maximum number of instructions that a loop should have if that loop
5956 is peeled, and if the loop is peeled, it determines how many times
5957 the loop code is peeled.
5959 @item max-peel-times
5960 The maximum number of peelings of a single loop.
5962 @item max-completely-peeled-insns
5963 The maximum number of insns of a completely peeled loop.
5965 @item max-completely-peel-times
5966 The maximum number of iterations of a loop to be suitable for complete peeling.
5968 @item max-unswitch-insns
5969 The maximum number of insns of an unswitched loop.
5971 @item max-unswitch-level
5972 The maximum number of branches unswitched in a single loop.
5974 @item lim-expensive
5975 The minimum cost of an expensive expression in the loop invariant motion.
5977 @item iv-consider-all-candidates-bound
5978 Bound on number of candidates for induction variables below that
5979 all candidates are considered for each use in induction variable
5980 optimizations.  Only the most relevant candidates are considered
5981 if there are more candidates, to avoid quadratic time complexity.
5983 @item iv-max-considered-uses
5984 The induction variable optimizations give up on loops that contain more
5985 induction variable uses.
5987 @item iv-always-prune-cand-set-bound
5988 If number of candidates in the set is smaller than this value,
5989 we always try to remove unnecessary ivs from the set during its
5990 optimization when a new iv is added to the set.
5992 @item scev-max-expr-size
5993 Bound on size of expressions used in the scalar evolutions analyzer.
5994 Large expressions slow the analyzer.
5996 @item vect-max-version-checks
5997 The maximum number of runtime checks that can be performed when doing
5998 loop versioning in the vectorizer.  See option ftree-vect-loop-version
5999 for more information.
6001 @item max-iterations-to-track
6003 The maximum number of iterations of a loop the brute force algorithm
6004 for analysis of # of iterations of the loop tries to evaluate.
6006 @item hot-bb-count-fraction
6007 Select fraction of the maximal count of repetitions of basic block in program
6008 given basic block needs to have to be considered hot.
6010 @item hot-bb-frequency-fraction
6011 Select fraction of the maximal frequency of executions of basic block in
6012 function given basic block needs to have to be considered hot
6014 @item max-predicted-iterations
6015 The maximum number of loop iterations we predict statically.  This is useful
6016 in cases where function contain single loop with known bound and other loop
6017 with unknown.  We predict the known number of iterations correctly, while
6018 the unknown number of iterations average to roughly 10.  This means that the
6019 loop without bounds would appear artificially cold relative to the other one.
6021 @item tracer-dynamic-coverage
6022 @itemx tracer-dynamic-coverage-feedback
6024 This value is used to limit superblock formation once the given percentage of
6025 executed instructions is covered.  This limits unnecessary code size
6026 expansion.
6028 The @option{tracer-dynamic-coverage-feedback} is used only when profile
6029 feedback is available.  The real profiles (as opposed to statically estimated
6030 ones) are much less balanced allowing the threshold to be larger value.
6032 @item tracer-max-code-growth
6033 Stop tail duplication once code growth has reached given percentage.  This is
6034 rather hokey argument, as most of the duplicates will be eliminated later in
6035 cross jumping, so it may be set to much higher values than is the desired code
6036 growth.
6038 @item tracer-min-branch-ratio
6040 Stop reverse growth when the reverse probability of best edge is less than this
6041 threshold (in percent).
6043 @item tracer-min-branch-ratio
6044 @itemx tracer-min-branch-ratio-feedback
6046 Stop forward growth if the best edge do have probability lower than this
6047 threshold.
6049 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6050 compilation for profile feedback and one for compilation without.  The value
6051 for compilation with profile feedback needs to be more conservative (higher) in
6052 order to make tracer effective.
6054 @item max-cse-path-length
6056 Maximum number of basic blocks on path that cse considers.  The default is 10.
6058 @item max-cse-insns
6059 The maximum instructions CSE process before flushing.  The default is 1000.
6061 @item global-var-threshold
6063 Counts the number of function calls (@var{n}) and the number of
6064 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
6065 single artificial variable will be created to represent all the
6066 call-clobbered variables at function call sites.  This artificial
6067 variable will then be made to alias every call-clobbered variable.
6068 (done as @code{int * size_t} on the host machine; beware overflow).
6070 @item max-aliased-vops
6072 Maximum number of virtual operands allowed to represent aliases
6073 before triggering the alias grouping heuristic.  Alias grouping
6074 reduces compile times and memory consumption needed for aliasing at
6075 the expense of precision loss in alias information.
6077 @item ggc-min-expand
6079 GCC uses a garbage collector to manage its own memory allocation.  This
6080 parameter specifies the minimum percentage by which the garbage
6081 collector's heap should be allowed to expand between collections.
6082 Tuning this may improve compilation speed; it has no effect on code
6083 generation.
6085 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6086 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6087 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6088 GCC is not able to calculate RAM on a particular platform, the lower
6089 bound of 30% is used.  Setting this parameter and
6090 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6091 every opportunity.  This is extremely slow, but can be useful for
6092 debugging.
6094 @item ggc-min-heapsize
6096 Minimum size of the garbage collector's heap before it begins bothering
6097 to collect garbage.  The first collection occurs after the heap expands
6098 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6099 tuning this may improve compilation speed, and has no effect on code
6100 generation.
6102 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6103 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6104 with a lower bound of 4096 (four megabytes) and an upper bound of
6105 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6106 particular platform, the lower bound is used.  Setting this parameter
6107 very large effectively disables garbage collection.  Setting this
6108 parameter and @option{ggc-min-expand} to zero causes a full collection
6109 to occur at every opportunity.
6111 @item max-reload-search-insns
6112 The maximum number of instruction reload should look backward for equivalent
6113 register.  Increasing values mean more aggressive optimization, making the
6114 compile time increase with probably slightly better performance.  The default
6115 value is 100.
6117 @item max-cselib-memory-location
6118 The maximum number of memory locations cselib should take into account.
6119 Increasing values mean more aggressive optimization, making the compile time
6120 increase with probably slightly better performance.  The default value is 500.
6122 @item max-flow-memory-location
6123 Similar as @option{max-cselib-memory-location} but for dataflow liveness.
6124 The default value is 100.
6126 @item reorder-blocks-duplicate
6127 @itemx reorder-blocks-duplicate-feedback
6129 Used by basic block reordering pass to decide whether to use unconditional
6130 branch or duplicate the code on its destination.  Code is duplicated when its
6131 estimated size is smaller than this value multiplied by the estimated size of
6132 unconditional jump in the hot spots of the program.
6134 The @option{reorder-block-duplicate-feedback} is used only when profile
6135 feedback is available and may be set to higher values than
6136 @option{reorder-block-duplicate} since information about the hot spots is more
6137 accurate.
6139 @item max-sched-ready-insns
6140 The maximum number of instructions ready to be issued the scheduler should
6141 consider at any given time during the first scheduling pass.  Increasing
6142 values mean more thorough searches, making the compilation time increase
6143 with probably little benefit.  The default value is 100.
6145 @item max-sched-region-blocks
6146 The maximum number of blocks in a region to be considered for
6147 interblock scheduling.  The default value is 10.
6149 @item max-sched-region-insns
6150 The maximum number of insns in a region to be considered for
6151 interblock scheduling.  The default value is 100.
6153 @item min-sched-prob
6154 The minimum probability of reaching a source block for interblock
6155 speculative scheduling.  The default value is 40.
6157 @item max-last-value-rtl
6159 The maximum size measured as number of RTLs that can be recorded in an expression
6160 in combiner for a pseudo register as last known value of that register.  The default
6161 is 10000.
6163 @item integer-share-limit
6164 Small integer constants can use a shared data structure, reducing the
6165 compiler's memory usage and increasing its speed.  This sets the maximum
6166 value of a shared integer constant's.  The default value is 256.
6168 @item min-virtual-mappings
6169 Specifies the minimum number of virtual mappings in the incremental
6170 SSA updater that should be registered to trigger the virtual mappings
6171 heuristic defined by virtual-mappings-ratio.  The default value is
6172 100.
6174 @item virtual-mappings-ratio
6175 If the number of virtual mappings is virtual-mappings-ratio bigger
6176 than the number of virtual symbols to be updated, then the incremental
6177 SSA updater switches to a full update for those symbols.  The default
6178 ratio is 3.
6180 @item ssp-buffer-size
6181 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6182 protection when @option{-fstack-protection} is used.
6184 @item max-jump-thread-duplication-stmts
6185 Maximum number of statements allowed in a block that needs to be
6186 duplicated when threading jumps.
6188 @item max-fields-for-field-sensitive
6189 Maximum number of fields in a structure we will treat in
6190 a field sensitive manner during pointer analysis.
6192 @end table
6193 @end table
6195 @node Preprocessor Options
6196 @section Options Controlling the Preprocessor
6197 @cindex preprocessor options
6198 @cindex options, preprocessor
6200 These options control the C preprocessor, which is run on each C source
6201 file before actual compilation.
6203 If you use the @option{-E} option, nothing is done except preprocessing.
6204 Some of these options make sense only together with @option{-E} because
6205 they cause the preprocessor output to be unsuitable for actual
6206 compilation.
6208 @table @gcctabopt
6209 @item -Wp,@var{option}
6210 @opindex Wp
6211 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6212 and pass @var{option} directly through to the preprocessor.  If
6213 @var{option} contains commas, it is split into multiple options at the
6214 commas.  However, many options are modified, translated or interpreted
6215 by the compiler driver before being passed to the preprocessor, and
6216 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6217 interface is undocumented and subject to change, so whenever possible
6218 you should avoid using @option{-Wp} and let the driver handle the
6219 options instead.
6221 @item -Xpreprocessor @var{option}
6222 @opindex preprocessor
6223 Pass @var{option} as an option to the preprocessor.  You can use this to
6224 supply system-specific preprocessor options which GCC does not know how to
6225 recognize.
6227 If you want to pass an option that takes an argument, you must use
6228 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6229 @end table
6231 @include cppopts.texi
6233 @node Assembler Options
6234 @section Passing Options to the Assembler
6236 @c prevent bad page break with this line
6237 You can pass options to the assembler.
6239 @table @gcctabopt
6240 @item -Wa,@var{option}
6241 @opindex Wa
6242 Pass @var{option} as an option to the assembler.  If @var{option}
6243 contains commas, it is split into multiple options at the commas.
6245 @item -Xassembler @var{option}
6246 @opindex Xassembler
6247 Pass @var{option} as an option to the assembler.  You can use this to
6248 supply system-specific assembler options which GCC does not know how to
6249 recognize.
6251 If you want to pass an option that takes an argument, you must use
6252 @option{-Xassembler} twice, once for the option and once for the argument.
6254 @end table
6256 @node Link Options
6257 @section Options for Linking
6258 @cindex link options
6259 @cindex options, linking
6261 These options come into play when the compiler links object files into
6262 an executable output file.  They are meaningless if the compiler is
6263 not doing a link step.
6265 @table @gcctabopt
6266 @cindex file names
6267 @item @var{object-file-name}
6268 A file name that does not end in a special recognized suffix is
6269 considered to name an object file or library.  (Object files are
6270 distinguished from libraries by the linker according to the file
6271 contents.)  If linking is done, these object files are used as input
6272 to the linker.
6274 @item -c
6275 @itemx -S
6276 @itemx -E
6277 @opindex c
6278 @opindex S
6279 @opindex E
6280 If any of these options is used, then the linker is not run, and
6281 object file names should not be used as arguments.  @xref{Overall
6282 Options}.
6284 @cindex Libraries
6285 @item -l@var{library}
6286 @itemx -l @var{library}
6287 @opindex l
6288 Search the library named @var{library} when linking.  (The second
6289 alternative with the library as a separate argument is only for
6290 POSIX compliance and is not recommended.)
6292 It makes a difference where in the command you write this option; the
6293 linker searches and processes libraries and object files in the order they
6294 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6295 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6296 to functions in @samp{z}, those functions may not be loaded.
6298 The linker searches a standard list of directories for the library,
6299 which is actually a file named @file{lib@var{library}.a}.  The linker
6300 then uses this file as if it had been specified precisely by name.
6302 The directories searched include several standard system directories
6303 plus any that you specify with @option{-L}.
6305 Normally the files found this way are library files---archive files
6306 whose members are object files.  The linker handles an archive file by
6307 scanning through it for members which define symbols that have so far
6308 been referenced but not defined.  But if the file that is found is an
6309 ordinary object file, it is linked in the usual fashion.  The only
6310 difference between using an @option{-l} option and specifying a file name
6311 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6312 and searches several directories.
6314 @item -lobjc
6315 @opindex lobjc
6316 You need this special case of the @option{-l} option in order to
6317 link an Objective-C or Objective-C++ program.
6319 @item -nostartfiles
6320 @opindex nostartfiles
6321 Do not use the standard system startup files when linking.
6322 The standard system libraries are used normally, unless @option{-nostdlib}
6323 or @option{-nodefaultlibs} is used.
6325 @item -nodefaultlibs
6326 @opindex nodefaultlibs
6327 Do not use the standard system libraries when linking.
6328 Only the libraries you specify will be passed to the linker.
6329 The standard startup files are used normally, unless @option{-nostartfiles}
6330 is used.  The compiler may generate calls to @code{memcmp},
6331 @code{memset}, @code{memcpy} and @code{memmove}.
6332 These entries are usually resolved by entries in
6333 libc.  These entry points should be supplied through some other
6334 mechanism when this option is specified.
6336 @item -nostdlib
6337 @opindex nostdlib
6338 Do not use the standard system startup files or libraries when linking.
6339 No startup files and only the libraries you specify will be passed to
6340 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6341 @code{memcpy} and @code{memmove}.
6342 These entries are usually resolved by entries in
6343 libc.  These entry points should be supplied through some other
6344 mechanism when this option is specified.
6346 @cindex @option{-lgcc}, use with @option{-nostdlib}
6347 @cindex @option{-nostdlib} and unresolved references
6348 @cindex unresolved references and @option{-nostdlib}
6349 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6350 @cindex @option{-nodefaultlibs} and unresolved references
6351 @cindex unresolved references and @option{-nodefaultlibs}
6352 One of the standard libraries bypassed by @option{-nostdlib} and
6353 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6354 that GCC uses to overcome shortcomings of particular machines, or special
6355 needs for some languages.
6356 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6357 Collection (GCC) Internals},
6358 for more discussion of @file{libgcc.a}.)
6359 In most cases, you need @file{libgcc.a} even when you want to avoid
6360 other standard libraries.  In other words, when you specify @option{-nostdlib}
6361 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6362 This ensures that you have no unresolved references to internal GCC
6363 library subroutines.  (For example, @samp{__main}, used to ensure C++
6364 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6365 GNU Compiler Collection (GCC) Internals}.)
6367 @item -pie
6368 @opindex pie
6369 Produce a position independent executable on targets which support it.
6370 For predictable results, you must also specify the same set of options
6371 that were used to generate code (@option{-fpie}, @option{-fPIE},
6372 or model suboptions) when you specify this option.
6374 @item -rdynamic
6375 @opindex rdynamic
6376 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6377 that support it.  This instructs the linker to add all symbols, not
6378 only used ones, to the dynamic symbol table.  This option is needed
6379 for some uses of @code{dlopen} or to allow obtaining backtraces
6380 from within a program.
6382 @item -s
6383 @opindex s
6384 Remove all symbol table and relocation information from the executable.
6386 @item -static
6387 @opindex static
6388 On systems that support dynamic linking, this prevents linking with the shared
6389 libraries.  On other systems, this option has no effect.
6391 @item -shared
6392 @opindex shared
6393 Produce a shared object which can then be linked with other objects to
6394 form an executable.  Not all systems support this option.  For predictable
6395 results, you must also specify the same set of options that were used to
6396 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6397 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6398 needs to build supplementary stub code for constructors to work.  On
6399 multi-libbed systems, @samp{gcc -shared} must select the correct support
6400 libraries to link against.  Failing to supply the correct flags may lead
6401 to subtle defects.  Supplying them in cases where they are not necessary
6402 is innocuous.}
6404 @item -shared-libgcc
6405 @itemx -static-libgcc
6406 @opindex shared-libgcc
6407 @opindex static-libgcc
6408 On systems that provide @file{libgcc} as a shared library, these options
6409 force the use of either the shared or static version respectively.
6410 If no shared version of @file{libgcc} was built when the compiler was
6411 configured, these options have no effect.
6413 There are several situations in which an application should use the
6414 shared @file{libgcc} instead of the static version.  The most common
6415 of these is when the application wishes to throw and catch exceptions
6416 across different shared libraries.  In that case, each of the libraries
6417 as well as the application itself should use the shared @file{libgcc}.
6419 Therefore, the G++ and GCJ drivers automatically add
6420 @option{-shared-libgcc} whenever you build a shared library or a main
6421 executable, because C++ and Java programs typically use exceptions, so
6422 this is the right thing to do.
6424 If, instead, you use the GCC driver to create shared libraries, you may
6425 find that they will not always be linked with the shared @file{libgcc}.
6426 If GCC finds, at its configuration time, that you have a non-GNU linker
6427 or a GNU linker that does not support option @option{--eh-frame-hdr},
6428 it will link the shared version of @file{libgcc} into shared libraries
6429 by default.  Otherwise, it will take advantage of the linker and optimize
6430 away the linking with the shared version of @file{libgcc}, linking with
6431 the static version of libgcc by default.  This allows exceptions to
6432 propagate through such shared libraries, without incurring relocation
6433 costs at library load time.
6435 However, if a library or main executable is supposed to throw or catch
6436 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6437 for the languages used in the program, or using the option
6438 @option{-shared-libgcc}, such that it is linked with the shared
6439 @file{libgcc}.
6441 @item -symbolic
6442 @opindex symbolic
6443 Bind references to global symbols when building a shared object.  Warn
6444 about any unresolved references (unless overridden by the link editor
6445 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6446 this option.
6448 @item -Xlinker @var{option}
6449 @opindex Xlinker
6450 Pass @var{option} as an option to the linker.  You can use this to
6451 supply system-specific linker options which GCC does not know how to
6452 recognize.
6454 If you want to pass an option that takes an argument, you must use
6455 @option{-Xlinker} twice, once for the option and once for the argument.
6456 For example, to pass @option{-assert definitions}, you must write
6457 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6458 @option{-Xlinker "-assert definitions"}, because this passes the entire
6459 string as a single argument, which is not what the linker expects.
6461 @item -Wl,@var{option}
6462 @opindex Wl
6463 Pass @var{option} as an option to the linker.  If @var{option} contains
6464 commas, it is split into multiple options at the commas.
6466 @item -u @var{symbol}
6467 @opindex u
6468 Pretend the symbol @var{symbol} is undefined, to force linking of
6469 library modules to define it.  You can use @option{-u} multiple times with
6470 different symbols to force loading of additional library modules.
6471 @end table
6473 @node Directory Options
6474 @section Options for Directory Search
6475 @cindex directory options
6476 @cindex options, directory search
6477 @cindex search path
6479 These options specify directories to search for header files, for
6480 libraries and for parts of the compiler:
6482 @table @gcctabopt
6483 @item -I@var{dir}
6484 @opindex I
6485 Add the directory @var{dir} to the head of the list of directories to be
6486 searched for header files.  This can be used to override a system header
6487 file, substituting your own version, since these directories are
6488 searched before the system header file directories.  However, you should
6489 not use this option to add directories that contain vendor-supplied
6490 system header files (use @option{-isystem} for that).  If you use more than
6491 one @option{-I} option, the directories are scanned in left-to-right
6492 order; the standard system directories come after.
6494 If a standard system include directory, or a directory specified with
6495 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6496 option will be ignored.  The directory will still be searched but as a
6497 system directory at its normal position in the system include chain.
6498 This is to ensure that GCC's procedure to fix buggy system headers and
6499 the ordering for the include_next directive are not inadvertently changed.
6500 If you really need to change the search order for system directories,
6501 use the @option{-nostdinc} and/or @option{-isystem} options.
6503 @item -iquote@var{dir}
6504 @opindex iquote
6505 Add the directory @var{dir} to the head of the list of directories to
6506 be searched for header files only for the case of @samp{#include
6507 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6508 otherwise just like @option{-I}.
6510 @item -iremap @var{src}:@var{dst}
6511 @opindex iremap
6512 Replace the prefix @var{src} in __FILE__ with @var{dst} at expansion time.
6513 This option can be specified more than once.  Processing stops at the first
6514 match.
6516 @item -L@var{dir}
6517 @opindex L
6518 Add directory @var{dir} to the list of directories to be searched
6519 for @option{-l}.
6521 @item -B@var{prefix}
6522 @opindex B
6523 This option specifies where to find the executables, libraries,
6524 include files, and data files of the compiler itself.
6526 The compiler driver program runs one or more of the subprograms
6527 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6528 @var{prefix} as a prefix for each program it tries to run, both with and
6529 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6531 For each subprogram to be run, the compiler driver first tries the
6532 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6533 was not specified, the driver tries two standard prefixes, which are
6534 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6535 those results in a file name that is found, the unmodified program
6536 name is searched for using the directories specified in your
6537 @env{PATH} environment variable.
6539 The compiler will check to see if the path provided by the @option{-B}
6540 refers to a directory, and if necessary it will add a directory
6541 separator character at the end of the path.
6543 @option{-B} prefixes that effectively specify directory names also apply
6544 to libraries in the linker, because the compiler translates these
6545 options into @option{-L} options for the linker.  They also apply to
6546 includes files in the preprocessor, because the compiler translates these
6547 options into @option{-isystem} options for the preprocessor.  In this case,
6548 the compiler appends @samp{include} to the prefix.
6550 The run-time support file @file{libgcc.a} can also be searched for using
6551 the @option{-B} prefix, if needed.  If it is not found there, the two
6552 standard prefixes above are tried, and that is all.  The file is left
6553 out of the link if it is not found by those means.
6555 Another way to specify a prefix much like the @option{-B} prefix is to use
6556 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6557 Variables}.
6559 As a special kludge, if the path provided by @option{-B} is
6560 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6561 9, then it will be replaced by @file{[dir/]include}.  This is to help
6562 with boot-strapping the compiler.
6564 @item -specs=@var{file}
6565 @opindex specs
6566 Process @var{file} after the compiler reads in the standard @file{specs}
6567 file, in order to override the defaults that the @file{gcc} driver
6568 program uses when determining what switches to pass to @file{cc1},
6569 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6570 @option{-specs=@var{file}} can be specified on the command line, and they
6571 are processed in order, from left to right.
6573 @item --sysroot=@var{dir}
6574 @opindex sysroot
6575 Use @var{dir} as the logical root directory for headers and libraries.
6576 For example, if the compiler would normally search for headers in
6577 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6578 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6580 If you use both this option and the @option{-isysroot} option, then
6581 the @option{--sysroot} option will apply to libraries, but the
6582 @option{-isysroot} option will apply to header files.
6584 The GNU linker (beginning with version 2.16) has the necessary support
6585 for this option.  If your linker does not support this option, the
6586 header file aspect of @option{--sysroot} will still work, but the
6587 library aspect will not.
6589 @item -I-
6590 @opindex I-
6591 This option has been deprecated.  Please use @option{-iquote} instead for
6592 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6593 Any directories you specify with @option{-I} options before the @option{-I-}
6594 option are searched only for the case of @samp{#include "@var{file}"};
6595 they are not searched for @samp{#include <@var{file}>}.
6597 If additional directories are specified with @option{-I} options after
6598 the @option{-I-}, these directories are searched for all @samp{#include}
6599 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6600 this way.)
6602 In addition, the @option{-I-} option inhibits the use of the current
6603 directory (where the current input file came from) as the first search
6604 directory for @samp{#include "@var{file}"}.  There is no way to
6605 override this effect of @option{-I-}.  With @option{-I.} you can specify
6606 searching the directory which was current when the compiler was
6607 invoked.  That is not exactly the same as what the preprocessor does
6608 by default, but it is often satisfactory.
6610 @option{-I-} does not inhibit the use of the standard system directories
6611 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6612 independent.
6613 @end table
6615 @c man end
6617 @node Spec Files
6618 @section Specifying subprocesses and the switches to pass to them
6619 @cindex Spec Files
6621 @command{gcc} is a driver program.  It performs its job by invoking a
6622 sequence of other programs to do the work of compiling, assembling and
6623 linking.  GCC interprets its command-line parameters and uses these to
6624 deduce which programs it should invoke, and which command-line options
6625 it ought to place on their command lines.  This behavior is controlled
6626 by @dfn{spec strings}.  In most cases there is one spec string for each
6627 program that GCC can invoke, but a few programs have multiple spec
6628 strings to control their behavior.  The spec strings built into GCC can
6629 be overridden by using the @option{-specs=} command-line switch to specify
6630 a spec file.
6632 @dfn{Spec files} are plaintext files that are used to construct spec
6633 strings.  They consist of a sequence of directives separated by blank
6634 lines.  The type of directive is determined by the first non-whitespace
6635 character on the line and it can be one of the following:
6637 @table @code
6638 @item %@var{command}
6639 Issues a @var{command} to the spec file processor.  The commands that can
6640 appear here are:
6642 @table @code
6643 @item %include <@var{file}>
6644 @cindex %include
6645 Search for @var{file} and insert its text at the current point in the
6646 specs file.
6648 @item %include_noerr <@var{file}>
6649 @cindex %include_noerr
6650 Just like @samp{%include}, but do not generate an error message if the include
6651 file cannot be found.
6653 @item %rename @var{old_name} @var{new_name}
6654 @cindex %rename
6655 Rename the spec string @var{old_name} to @var{new_name}.
6657 @end table
6659 @item *[@var{spec_name}]:
6660 This tells the compiler to create, override or delete the named spec
6661 string.  All lines after this directive up to the next directive or
6662 blank line are considered to be the text for the spec string.  If this
6663 results in an empty string then the spec will be deleted.  (Or, if the
6664 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6665 does not currently exist a new spec will be created.  If the spec does
6666 exist then its contents will be overridden by the text of this
6667 directive, unless the first character of that text is the @samp{+}
6668 character, in which case the text will be appended to the spec.
6670 @item [@var{suffix}]:
6671 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6672 and up to the next directive or blank line are considered to make up the
6673 spec string for the indicated suffix.  When the compiler encounters an
6674 input file with the named suffix, it will processes the spec string in
6675 order to work out how to compile that file.  For example:
6677 @smallexample
6678 .ZZ:
6679 z-compile -input %i
6680 @end smallexample
6682 This says that any input file whose name ends in @samp{.ZZ} should be
6683 passed to the program @samp{z-compile}, which should be invoked with the
6684 command-line switch @option{-input} and with the result of performing the
6685 @samp{%i} substitution.  (See below.)
6687 As an alternative to providing a spec string, the text that follows a
6688 suffix directive can be one of the following:
6690 @table @code
6691 @item @@@var{language}
6692 This says that the suffix is an alias for a known @var{language}.  This is
6693 similar to using the @option{-x} command-line switch to GCC to specify a
6694 language explicitly.  For example:
6696 @smallexample
6697 .ZZ:
6698 @@c++
6699 @end smallexample
6701 Says that .ZZ files are, in fact, C++ source files.
6703 @item #@var{name}
6704 This causes an error messages saying:
6706 @smallexample
6707 @var{name} compiler not installed on this system.
6708 @end smallexample
6709 @end table
6711 GCC already has an extensive list of suffixes built into it.
6712 This directive will add an entry to the end of the list of suffixes, but
6713 since the list is searched from the end backwards, it is effectively
6714 possible to override earlier entries using this technique.
6716 @end table
6718 GCC has the following spec strings built into it.  Spec files can
6719 override these strings or create their own.  Note that individual
6720 targets can also add their own spec strings to this list.
6722 @smallexample
6723 asm          Options to pass to the assembler
6724 asm_final    Options to pass to the assembler post-processor
6725 cpp          Options to pass to the C preprocessor
6726 cc1          Options to pass to the C compiler
6727 cc1plus      Options to pass to the C++ compiler
6728 endfile      Object files to include at the end of the link
6729 link         Options to pass to the linker
6730 lib          Libraries to include on the command line to the linker
6731 libgcc       Decides which GCC support library to pass to the linker
6732 linker       Sets the name of the linker
6733 predefines   Defines to be passed to the C preprocessor
6734 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6735              by default
6736 startfile    Object files to include at the start of the link
6737 @end smallexample
6739 Here is a small example of a spec file:
6741 @smallexample
6742 %rename lib                 old_lib
6744 *lib:
6745 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6746 @end smallexample
6748 This example renames the spec called @samp{lib} to @samp{old_lib} and
6749 then overrides the previous definition of @samp{lib} with a new one.
6750 The new definition adds in some extra command-line options before
6751 including the text of the old definition.
6753 @dfn{Spec strings} are a list of command-line options to be passed to their
6754 corresponding program.  In addition, the spec strings can contain
6755 @samp{%}-prefixed sequences to substitute variable text or to
6756 conditionally insert text into the command line.  Using these constructs
6757 it is possible to generate quite complex command lines.
6759 Here is a table of all defined @samp{%}-sequences for spec
6760 strings.  Note that spaces are not generated automatically around the
6761 results of expanding these sequences.  Therefore you can concatenate them
6762 together or combine them with constant text in a single argument.
6764 @table @code
6765 @item %%
6766 Substitute one @samp{%} into the program name or argument.
6768 @item %i
6769 Substitute the name of the input file being processed.
6771 @item %b
6772 Substitute the basename of the input file being processed.
6773 This is the substring up to (and not including) the last period
6774 and not including the directory.
6776 @item %B
6777 This is the same as @samp{%b}, but include the file suffix (text after
6778 the last period).
6780 @item %d
6781 Marks the argument containing or following the @samp{%d} as a
6782 temporary file name, so that that file will be deleted if GCC exits
6783 successfully.  Unlike @samp{%g}, this contributes no text to the
6784 argument.
6786 @item %g@var{suffix}
6787 Substitute a file name that has suffix @var{suffix} and is chosen
6788 once per compilation, and mark the argument in the same way as
6789 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6790 name is now chosen in a way that is hard to predict even when previously
6791 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6792 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6793 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6794 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6795 was simply substituted with a file name chosen once per compilation,
6796 without regard to any appended suffix (which was therefore treated
6797 just like ordinary text), making such attacks more likely to succeed.
6799 @item %u@var{suffix}
6800 Like @samp{%g}, but generates a new temporary file name even if
6801 @samp{%u@var{suffix}} was already seen.
6803 @item %U@var{suffix}
6804 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6805 new one if there is no such last file name.  In the absence of any
6806 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6807 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6808 would involve the generation of two distinct file names, one
6809 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6810 simply substituted with a file name chosen for the previous @samp{%u},
6811 without regard to any appended suffix.
6813 @item %j@var{suffix}
6814 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6815 writable, and if save-temps is off; otherwise, substitute the name
6816 of a temporary file, just like @samp{%u}.  This temporary file is not
6817 meant for communication between processes, but rather as a junk
6818 disposal mechanism.
6820 @item %|@var{suffix}
6821 @itemx %m@var{suffix}
6822 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6823 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6824 all.  These are the two most common ways to instruct a program that it
6825 should read from standard input or write to standard output.  If you
6826 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6827 construct: see for example @file{f/lang-specs.h}.
6829 @item %.@var{SUFFIX}
6830 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6831 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6832 terminated by the next space or %.
6834 @item %w
6835 Marks the argument containing or following the @samp{%w} as the
6836 designated output file of this compilation.  This puts the argument
6837 into the sequence of arguments that @samp{%o} will substitute later.
6839 @item %o
6840 Substitutes the names of all the output files, with spaces
6841 automatically placed around them.  You should write spaces
6842 around the @samp{%o} as well or the results are undefined.
6843 @samp{%o} is for use in the specs for running the linker.
6844 Input files whose names have no recognized suffix are not compiled
6845 at all, but they are included among the output files, so they will
6846 be linked.
6848 @item %O
6849 Substitutes the suffix for object files.  Note that this is
6850 handled specially when it immediately follows @samp{%g, %u, or %U},
6851 because of the need for those to form complete file names.  The
6852 handling is such that @samp{%O} is treated exactly as if it had already
6853 been substituted, except that @samp{%g, %u, and %U} do not currently
6854 support additional @var{suffix} characters following @samp{%O} as they would
6855 following, for example, @samp{.o}.
6857 @item %p
6858 Substitutes the standard macro predefinitions for the
6859 current target machine.  Use this when running @code{cpp}.
6861 @item %P
6862 Like @samp{%p}, but puts @samp{__} before and after the name of each
6863 predefined macro, except for macros that start with @samp{__} or with
6864 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6867 @item %I
6868 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6869 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6870 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6871 as necessary.
6873 @item %s
6874 Current argument is the name of a library or startup file of some sort.
6875 Search for that file in a standard list of directories and substitute
6876 the full name found.
6878 @item %e@var{str}
6879 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6880 Use this when inconsistent options are detected.
6882 @item %(@var{name})
6883 Substitute the contents of spec string @var{name} at this point.
6885 @item %[@var{name}]
6886 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6888 @item %x@{@var{option}@}
6889 Accumulate an option for @samp{%X}.
6891 @item %X
6892 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6893 spec string.
6895 @item %Y
6896 Output the accumulated assembler options specified by @option{-Wa}.
6898 @item %Z
6899 Output the accumulated preprocessor options specified by @option{-Wp}.
6901 @item %a
6902 Process the @code{asm} spec.  This is used to compute the
6903 switches to be passed to the assembler.
6905 @item %A
6906 Process the @code{asm_final} spec.  This is a spec string for
6907 passing switches to an assembler post-processor, if such a program is
6908 needed.
6910 @item %l
6911 Process the @code{link} spec.  This is the spec for computing the
6912 command line passed to the linker.  Typically it will make use of the
6913 @samp{%L %G %S %D and %E} sequences.
6915 @item %D
6916 Dump out a @option{-L} option for each directory that GCC believes might
6917 contain startup files.  If the target supports multilibs then the
6918 current multilib directory will be prepended to each of these paths.
6920 @item %L
6921 Process the @code{lib} spec.  This is a spec string for deciding which
6922 libraries should be included on the command line to the linker.
6924 @item %G
6925 Process the @code{libgcc} spec.  This is a spec string for deciding
6926 which GCC support library should be included on the command line to the linker.
6928 @item %S
6929 Process the @code{startfile} spec.  This is a spec for deciding which
6930 object files should be the first ones passed to the linker.  Typically
6931 this might be a file named @file{crt0.o}.
6933 @item %E
6934 Process the @code{endfile} spec.  This is a spec string that specifies
6935 the last object files that will be passed to the linker.
6937 @item %C
6938 Process the @code{cpp} spec.  This is used to construct the arguments
6939 to be passed to the C preprocessor.
6941 @item %1
6942 Process the @code{cc1} spec.  This is used to construct the options to be
6943 passed to the actual C compiler (@samp{cc1}).
6945 @item %2
6946 Process the @code{cc1plus} spec.  This is used to construct the options to be
6947 passed to the actual C++ compiler (@samp{cc1plus}).
6949 @item %*
6950 Substitute the variable part of a matched option.  See below.
6951 Note that each comma in the substituted string is replaced by
6952 a single space.
6954 @item %<@code{S}
6955 Remove all occurrences of @code{-S} from the command line.  Note---this
6956 command is position dependent.  @samp{%} commands in the spec string
6957 before this one will see @code{-S}, @samp{%} commands in the spec string
6958 after this one will not.
6960 @item %:@var{function}(@var{args})
6961 Call the named function @var{function}, passing it @var{args}.
6962 @var{args} is first processed as a nested spec string, then split
6963 into an argument vector in the usual fashion.  The function returns
6964 a string which is processed as if it had appeared literally as part
6965 of the current spec.
6967 The following built-in spec functions are provided:
6969 @table @code
6970 @item @code{if-exists}
6971 The @code{if-exists} spec function takes one argument, an absolute
6972 pathname to a file.  If the file exists, @code{if-exists} returns the
6973 pathname.  Here is a small example of its usage:
6975 @smallexample
6976 *startfile:
6977 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6978 @end smallexample
6980 @item @code{if-exists-else}
6981 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6982 spec function, except that it takes two arguments.  The first argument is
6983 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6984 returns the pathname.  If it does not exist, it returns the second argument.
6985 This way, @code{if-exists-else} can be used to select one file or another,
6986 based on the existence of the first.  Here is a small example of its usage:
6988 @smallexample
6989 *startfile:
6990 crt0%O%s %:if-exists(crti%O%s) \
6991 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6992 @end smallexample
6994 @item @code{replace-outfile}
6995 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6996 first argument in the outfiles array and replaces it with the second argument.  Here
6997 is a small example of its usage:
6999 @smallexample
7000 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
7001 @end smallexample
7003 @end table
7005 @item %@{@code{S}@}
7006 Substitutes the @code{-S} switch, if that switch was given to GCC@.
7007 If that switch was not specified, this substitutes nothing.  Note that
7008 the leading dash is omitted when specifying this option, and it is
7009 automatically inserted if the substitution is performed.  Thus the spec
7010 string @samp{%@{foo@}} would match the command-line option @option{-foo}
7011 and would output the command line option @option{-foo}.
7013 @item %W@{@code{S}@}
7014 Like %@{@code{S}@} but mark last argument supplied within as a file to be
7015 deleted on failure.
7017 @item %@{@code{S}*@}
7018 Substitutes all the switches specified to GCC whose names start
7019 with @code{-S}, but which also take an argument.  This is used for
7020 switches like @option{-o}, @option{-D}, @option{-I}, etc.
7021 GCC considers @option{-o foo} as being
7022 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
7023 text, including the space.  Thus two arguments would be generated.
7025 @item %@{@code{S}*&@code{T}*@}
7026 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7027 (the order of @code{S} and @code{T} in the spec is not significant).
7028 There can be any number of ampersand-separated variables; for each the
7029 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
7031 @item %@{@code{S}:@code{X}@}
7032 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7034 @item %@{!@code{S}:@code{X}@}
7035 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7037 @item %@{@code{S}*:@code{X}@}
7038 Substitutes @code{X} if one or more switches whose names start with
7039 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
7040 once, no matter how many such switches appeared.  However, if @code{%*}
7041 appears somewhere in @code{X}, then @code{X} will be substituted once
7042 for each matching switch, with the @code{%*} replaced by the part of
7043 that switch that matched the @code{*}.
7045 @item %@{.@code{S}:@code{X}@}
7046 Substitutes @code{X}, if processing a file with suffix @code{S}.
7048 @item %@{!.@code{S}:@code{X}@}
7049 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7051 @item %@{@code{S}|@code{P}:@code{X}@}
7052 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7053 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7054 although they have a stronger binding than the @samp{|}.  If @code{%*}
7055 appears in @code{X}, all of the alternatives must be starred, and only
7056 the first matching alternative is substituted.
7058 For example, a spec string like this:
7060 @smallexample
7061 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7062 @end smallexample
7064 will output the following command-line options from the following input
7065 command-line options:
7067 @smallexample
7068 fred.c        -foo -baz
7069 jim.d         -bar -boggle
7070 -d fred.c     -foo -baz -boggle
7071 -d jim.d      -bar -baz -boggle
7072 @end smallexample
7074 @item %@{S:X; T:Y; :D@}
7076 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7077 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7078 be as many clauses as you need.  This may be combined with @code{.},
7079 @code{!}, @code{|}, and @code{*} as needed.
7082 @end table
7084 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7085 construct may contain other nested @samp{%} constructs or spaces, or
7086 even newlines.  They are processed as usual, as described above.
7087 Trailing white space in @code{X} is ignored.  White space may also
7088 appear anywhere on the left side of the colon in these constructs,
7089 except between @code{.} or @code{*} and the corresponding word.
7091 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7092 handled specifically in these constructs.  If another value of
7093 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7094 @option{-W} switch is found later in the command line, the earlier
7095 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7096 just one letter, which passes all matching options.
7098 The character @samp{|} at the beginning of the predicate text is used to
7099 indicate that a command should be piped to the following command, but
7100 only if @option{-pipe} is specified.
7102 It is built into GCC which switches take arguments and which do not.
7103 (You might think it would be useful to generalize this to allow each
7104 compiler's spec to say which switches take arguments.  But this cannot
7105 be done in a consistent fashion.  GCC cannot even decide which input
7106 files have been specified without knowing which switches take arguments,
7107 and it must know which input files to compile in order to tell which
7108 compilers to run).
7110 GCC also knows implicitly that arguments starting in @option{-l} are to be
7111 treated as compiler output files, and passed to the linker in their
7112 proper position among the other output files.
7114 @c man begin OPTIONS
7116 @node Target Options
7117 @section Specifying Target Machine and Compiler Version
7118 @cindex target options
7119 @cindex cross compiling
7120 @cindex specifying machine version
7121 @cindex specifying compiler version and target machine
7122 @cindex compiler version, specifying
7123 @cindex target machine, specifying
7125 The usual way to run GCC is to run the executable called @file{gcc}, or
7126 @file{<machine>-gcc} when cross-compiling, or
7127 @file{<machine>-gcc-<version>} to run a version other than the one that
7128 was installed last.  Sometimes this is inconvenient, so GCC provides
7129 options that will switch to another cross-compiler or version.
7131 @table @gcctabopt
7132 @item -b @var{machine}
7133 @opindex b
7134 The argument @var{machine} specifies the target machine for compilation.
7136 The value to use for @var{machine} is the same as was specified as the
7137 machine type when configuring GCC as a cross-compiler.  For
7138 example, if a cross-compiler was configured with @samp{configure
7139 arm-elf}, meaning to compile for an arm processor with elf binaries,
7140 then you would specify @option{-b arm-elf} to run that cross compiler.
7141 Because there are other options beginning with @option{-b}, the
7142 configuration must contain a hyphen. 
7144 @item -V @var{version}
7145 @opindex V
7146 The argument @var{version} specifies which version of GCC to run.
7147 This is useful when multiple versions are installed.  For example,
7148 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7149 @end table
7151 The @option{-V} and @option{-b} options work by running the
7152 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7153 use them if you can just run that directly.
7155 @node Submodel Options
7156 @section Hardware Models and Configurations
7157 @cindex submodel options
7158 @cindex specifying hardware config
7159 @cindex hardware models and configurations, specifying
7160 @cindex machine dependent options
7162 Earlier we discussed the standard option @option{-b} which chooses among
7163 different installed compilers for completely different target
7164 machines, such as VAX vs.@: 68000 vs.@: 80386.
7166 In addition, each of these target machine types can have its own
7167 special options, starting with @samp{-m}, to choose among various
7168 hardware models or configurations---for example, 68010 vs 68020,
7169 floating coprocessor or none.  A single installed version of the
7170 compiler can compile for any model or configuration, according to the
7171 options specified.
7173 Some configurations of the compiler also support additional special
7174 options, usually for compatibility with other compilers on the same
7175 platform.
7177 @c This list is ordered alphanumerically by subsection name.
7178 @c It should be the same order and spelling as these options are listed
7179 @c in Machine Dependent Options
7181 @menu
7182 * ARC Options::
7183 * ARM Options::
7184 * AVR Options::
7185 * Blackfin Options::
7186 * CRIS Options::
7187 * CRX Options::
7188 * Darwin Options::
7189 * DEC Alpha Options::
7190 * DEC Alpha/VMS Options::
7191 * FRV Options::
7192 * H8/300 Options::
7193 * HPPA Options::
7194 * i386 and x86-64 Options::
7195 * IA-64 Options::
7196 * M32C Options::
7197 * M32R/D Options::
7198 * M680x0 Options::
7199 * M68hc1x Options::
7200 * MCore Options::
7201 * MIPS Options::
7202 * MMIX Options::
7203 * MN10300 Options::
7204 * MT Options::
7205 * PDP-11 Options::
7206 * PowerPC Options::
7207 * RS/6000 and PowerPC Options::
7208 * S/390 and zSeries Options::
7209 * SH Options::
7210 * SPARC Options::
7211 * System V Options::
7212 * TMS320C3x/C4x Options::
7213 * V850 Options::
7214 * VAX Options::
7215 * x86-64 Options::
7216 * Xstormy16 Options::
7217 * Xtensa Options::
7218 * zSeries Options::
7219 @end menu
7221 @node ARC Options
7222 @subsection ARC Options
7223 @cindex ARC Options
7225 These options are defined for ARC implementations:
7227 @table @gcctabopt
7228 @item -EL
7229 @opindex EL
7230 Compile code for little endian mode.  This is the default.
7232 @item -EB
7233 @opindex EB
7234 Compile code for big endian mode.
7236 @item -mmangle-cpu
7237 @opindex mmangle-cpu
7238 Prepend the name of the cpu to all public symbol names.
7239 In multiple-processor systems, there are many ARC variants with different
7240 instruction and register set characteristics.  This flag prevents code
7241 compiled for one cpu to be linked with code compiled for another.
7242 No facility exists for handling variants that are ``almost identical''.
7243 This is an all or nothing option.
7245 @item -mcpu=@var{cpu}
7246 @opindex mcpu
7247 Compile code for ARC variant @var{cpu}.
7248 Which variants are supported depend on the configuration.
7249 All variants support @option{-mcpu=base}, this is the default.
7251 @item -mtext=@var{text-section}
7252 @itemx -mdata=@var{data-section}
7253 @itemx -mrodata=@var{readonly-data-section}
7254 @opindex mtext
7255 @opindex mdata
7256 @opindex mrodata
7257 Put functions, data, and readonly data in @var{text-section},
7258 @var{data-section}, and @var{readonly-data-section} respectively
7259 by default.  This can be overridden with the @code{section} attribute.
7260 @xref{Variable Attributes}.
7262 @end table
7264 @node ARM Options
7265 @subsection ARM Options
7266 @cindex ARM options
7268 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7269 architectures:
7271 @table @gcctabopt
7272 @item -mabi=@var{name}
7273 @opindex mabi
7274 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7275 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7277 @item -mapcs-frame
7278 @opindex mapcs-frame
7279 Generate a stack frame that is compliant with the ARM Procedure Call
7280 Standard for all functions, even if this is not strictly necessary for
7281 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7282 with this option will cause the stack frames not to be generated for
7283 leaf functions.  The default is @option{-mno-apcs-frame}.
7285 @item -mapcs
7286 @opindex mapcs
7287 This is a synonym for @option{-mapcs-frame}.
7289 @ignore
7290 @c not currently implemented
7291 @item -mapcs-stack-check
7292 @opindex mapcs-stack-check
7293 Generate code to check the amount of stack space available upon entry to
7294 every function (that actually uses some stack space).  If there is
7295 insufficient space available then either the function
7296 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7297 called, depending upon the amount of stack space required.  The run time
7298 system is required to provide these functions.  The default is
7299 @option{-mno-apcs-stack-check}, since this produces smaller code.
7301 @c not currently implemented
7302 @item -mapcs-float
7303 @opindex mapcs-float
7304 Pass floating point arguments using the float point registers.  This is
7305 one of the variants of the APCS@.  This option is recommended if the
7306 target hardware has a floating point unit or if a lot of floating point
7307 arithmetic is going to be performed by the code.  The default is
7308 @option{-mno-apcs-float}, since integer only code is slightly increased in
7309 size if @option{-mapcs-float} is used.
7311 @c not currently implemented
7312 @item -mapcs-reentrant
7313 @opindex mapcs-reentrant
7314 Generate reentrant, position independent code.  The default is
7315 @option{-mno-apcs-reentrant}.
7316 @end ignore
7318 @item -mthumb-interwork
7319 @opindex mthumb-interwork
7320 Generate code which supports calling between the ARM and Thumb
7321 instruction sets.  Without this option the two instruction sets cannot
7322 be reliably used inside one program.  The default is
7323 @option{-mno-thumb-interwork}, since slightly larger code is generated
7324 when @option{-mthumb-interwork} is specified.
7326 @item -mno-sched-prolog
7327 @opindex mno-sched-prolog
7328 Prevent the reordering of instructions in the function prolog, or the
7329 merging of those instruction with the instructions in the function's
7330 body.  This means that all functions will start with a recognizable set
7331 of instructions (or in fact one of a choice from a small set of
7332 different function prologues), and this information can be used to
7333 locate the start if functions inside an executable piece of code.  The
7334 default is @option{-msched-prolog}.
7336 @item -mhard-float
7337 @opindex mhard-float
7338 Generate output containing floating point instructions.  This is the
7339 default.
7341 @item -msoft-float
7342 @opindex msoft-float
7343 Generate output containing library calls for floating point.
7344 @strong{Warning:} the requisite libraries are not available for all ARM
7345 targets.  Normally the facilities of the machine's usual C compiler are
7346 used, but this cannot be done directly in cross-compilation.  You must make
7347 your own arrangements to provide suitable library functions for
7348 cross-compilation.
7350 @option{-msoft-float} changes the calling convention in the output file;
7351 therefore, it is only useful if you compile @emph{all} of a program with
7352 this option.  In particular, you need to compile @file{libgcc.a}, the
7353 library that comes with GCC, with @option{-msoft-float} in order for
7354 this to work.
7356 @item -mfloat-abi=@var{name}
7357 @opindex mfloat-abi
7358 Specifies which ABI to use for floating point values.  Permissible values
7359 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7361 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7362 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7363 of floating point instructions, but still uses the soft-float calling
7364 conventions.
7366 @item -mlittle-endian
7367 @opindex mlittle-endian
7368 Generate code for a processor running in little-endian mode.  This is
7369 the default for all standard configurations.
7371 @item -mbig-endian
7372 @opindex mbig-endian
7373 Generate code for a processor running in big-endian mode; the default is
7374 to compile code for a little-endian processor.
7376 @item -mwords-little-endian
7377 @opindex mwords-little-endian
7378 This option only applies when generating code for big-endian processors.
7379 Generate code for a little-endian word order but a big-endian byte
7380 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7381 option should only be used if you require compatibility with code for
7382 big-endian ARM processors generated by versions of the compiler prior to
7383 2.8.
7385 @item -mcpu=@var{name}
7386 @opindex mcpu
7387 This specifies the name of the target ARM processor.  GCC uses this name
7388 to determine what kind of instructions it can emit when generating
7389 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7390 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7391 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7392 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7393 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7394 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7395 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7396 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7397 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7398 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7399 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7400 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7401 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7402 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7403 @samp{ep9312}.
7405 @itemx -mtune=@var{name}
7406 @opindex mtune
7407 This option is very similar to the @option{-mcpu=} option, except that
7408 instead of specifying the actual target processor type, and hence
7409 restricting which instructions can be used, it specifies that GCC should
7410 tune the performance of the code as if the target were of the type
7411 specified in this option, but still choosing the instructions that it
7412 will generate based on the cpu specified by a @option{-mcpu=} option.
7413 For some ARM implementations better performance can be obtained by using
7414 this option.
7416 @item -march=@var{name}
7417 @opindex march
7418 This specifies the name of the target ARM architecture.  GCC uses this
7419 name to determine what kind of instructions it can emit when generating
7420 assembly code.  This option can be used in conjunction with or instead
7421 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7422 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7423 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7424 @samp{iwmmxt}, @samp{ep9312}.
7426 @item -mfpu=@var{name}
7427 @itemx -mfpe=@var{number}
7428 @itemx -mfp=@var{number}
7429 @opindex mfpu
7430 @opindex mfpe
7431 @opindex mfp
7432 This specifies what floating point hardware (or hardware emulation) is
7433 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7434 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7435 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7436 with older versions of GCC@.
7438 If @option{-msoft-float} is specified this specifies the format of
7439 floating point values.
7441 @item -mstructure-size-boundary=@var{n}
7442 @opindex mstructure-size-boundary
7443 The size of all structures and unions will be rounded up to a multiple
7444 of the number of bits set by this option.  Permissible values are 8, 32
7445 and 64.  The default value varies for different toolchains.  For the COFF
7446 targeted toolchain the default value is 8.  A value of 64 is only allowed
7447 if the underlying ABI supports it.
7449 Specifying the larger number can produce faster, more efficient code, but
7450 can also increase the size of the program.  Different values are potentially
7451 incompatible.  Code compiled with one value cannot necessarily expect to
7452 work with code or libraries compiled with another value, if they exchange
7453 information using structures or unions.
7455 @item -mabort-on-noreturn
7456 @opindex mabort-on-noreturn
7457 Generate a call to the function @code{abort} at the end of a
7458 @code{noreturn} function.  It will be executed if the function tries to
7459 return.
7461 @item -mlong-calls
7462 @itemx -mno-long-calls
7463 @opindex mlong-calls
7464 @opindex mno-long-calls
7465 Tells the compiler to perform function calls by first loading the
7466 address of the function into a register and then performing a subroutine
7467 call on this register.  This switch is needed if the target function
7468 will lie outside of the 64 megabyte addressing range of the offset based
7469 version of subroutine call instruction.
7471 Even if this switch is enabled, not all function calls will be turned
7472 into long calls.  The heuristic is that static functions, functions
7473 which have the @samp{short-call} attribute, functions that are inside
7474 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7475 definitions have already been compiled within the current compilation
7476 unit, will not be turned into long calls.  The exception to this rule is
7477 that weak function definitions, functions with the @samp{long-call}
7478 attribute or the @samp{section} attribute, and functions that are within
7479 the scope of a @samp{#pragma long_calls} directive, will always be
7480 turned into long calls.
7482 This feature is not enabled by default.  Specifying
7483 @option{-mno-long-calls} will restore the default behavior, as will
7484 placing the function calls within the scope of a @samp{#pragma
7485 long_calls_off} directive.  Note these switches have no effect on how
7486 the compiler generates code to handle function calls via function
7487 pointers.
7489 @item -mnop-fun-dllimport
7490 @opindex mnop-fun-dllimport
7491 Disable support for the @code{dllimport} attribute.
7493 @item -msingle-pic-base
7494 @opindex msingle-pic-base
7495 Treat the register used for PIC addressing as read-only, rather than
7496 loading it in the prologue for each function.  The run-time system is
7497 responsible for initializing this register with an appropriate value
7498 before execution begins.
7500 @item -mpic-register=@var{reg}
7501 @opindex mpic-register
7502 Specify the register to be used for PIC addressing.  The default is R10
7503 unless stack-checking is enabled, when R9 is used.
7505 @item -mcirrus-fix-invalid-insns
7506 @opindex mcirrus-fix-invalid-insns
7507 @opindex mno-cirrus-fix-invalid-insns
7508 Insert NOPs into the instruction stream to in order to work around
7509 problems with invalid Maverick instruction combinations.  This option
7510 is only valid if the @option{-mcpu=ep9312} option has been used to
7511 enable generation of instructions for the Cirrus Maverick floating
7512 point co-processor.  This option is not enabled by default, since the
7513 problem is only present in older Maverick implementations.  The default
7514 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7515 switch.
7517 @item -mpoke-function-name
7518 @opindex mpoke-function-name
7519 Write the name of each function into the text section, directly
7520 preceding the function prologue.  The generated code is similar to this:
7522 @smallexample
7523      t0
7524          .ascii "arm_poke_function_name", 0
7525          .align
7526      t1
7527          .word 0xff000000 + (t1 - t0)
7528      arm_poke_function_name
7529          mov     ip, sp
7530          stmfd   sp!, @{fp, ip, lr, pc@}
7531          sub     fp, ip, #4
7532 @end smallexample
7534 When performing a stack backtrace, code can inspect the value of
7535 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7536 location @code{pc - 12} and the top 8 bits are set, then we know that
7537 there is a function name embedded immediately preceding this location
7538 and has length @code{((pc[-3]) & 0xff000000)}.
7540 @item -mthumb
7541 @opindex mthumb
7542 Generate code for the 16-bit Thumb instruction set.  The default is to
7543 use the 32-bit ARM instruction set.
7545 @item -mtpcs-frame
7546 @opindex mtpcs-frame
7547 Generate a stack frame that is compliant with the Thumb Procedure Call
7548 Standard for all non-leaf functions.  (A leaf function is one that does
7549 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7551 @item -mtpcs-leaf-frame
7552 @opindex mtpcs-leaf-frame
7553 Generate a stack frame that is compliant with the Thumb Procedure Call
7554 Standard for all leaf functions.  (A leaf function is one that does
7555 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7557 @item -mcallee-super-interworking
7558 @opindex mcallee-super-interworking
7559 Gives all externally visible functions in the file being compiled an ARM
7560 instruction set header which switches to Thumb mode before executing the
7561 rest of the function.  This allows these functions to be called from
7562 non-interworking code.
7564 @item -mcaller-super-interworking
7565 @opindex mcaller-super-interworking
7566 Allows calls via function pointers (including virtual functions) to
7567 execute correctly regardless of whether the target code has been
7568 compiled for interworking or not.  There is a small overhead in the cost
7569 of executing a function pointer if this option is enabled.
7571 @item -mtp=@var{name}
7572 @opindex mtp
7573 Specify the access model for the thread local storage pointer.  The valid
7574 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7575 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7576 (supported in the arm6k architecture), and @option{auto}, which uses the
7577 best available method for the selected processor.  The default setting is
7578 @option{auto}.
7580 @end table
7582 @node AVR Options
7583 @subsection AVR Options
7584 @cindex AVR Options
7586 These options are defined for AVR implementations:
7588 @table @gcctabopt
7589 @item -mmcu=@var{mcu}
7590 @opindex mmcu
7591 Specify ATMEL AVR instruction set or MCU type.
7593 Instruction set avr1 is for the minimal AVR core, not supported by the C
7594 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7595 attiny11, attiny12, attiny15, attiny28).
7597 Instruction set avr2 (default) is for the classic AVR core with up to
7598 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7599 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7600 at90c8534, at90s8535).
7602 Instruction set avr3 is for the classic AVR core with up to 128K program
7603 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7605 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7606 memory space (MCU types: atmega8, atmega83, atmega85).
7608 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7609 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7610 atmega64, atmega128, at43usb355, at94k).
7612 @item -msize
7613 @opindex msize
7614 Output instruction sizes to the asm file.
7616 @item -minit-stack=@var{N}
7617 @opindex minit-stack
7618 Specify the initial stack address, which may be a symbol or numeric value,
7619 @samp{__stack} is the default.
7621 @item -mno-interrupts
7622 @opindex mno-interrupts
7623 Generated code is not compatible with hardware interrupts.
7624 Code size will be smaller.
7626 @item -mcall-prologues
7627 @opindex mcall-prologues
7628 Functions prologues/epilogues expanded as call to appropriate
7629 subroutines.  Code size will be smaller.
7631 @item -mno-tablejump
7632 @opindex mno-tablejump
7633 Do not generate tablejump insns which sometimes increase code size.
7635 @item -mtiny-stack
7636 @opindex mtiny-stack
7637 Change only the low 8 bits of the stack pointer.
7639 @item -mint8
7640 @opindex mint8
7641 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7642 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7643 and long long will be 4 bytes.  Please note that this option does not
7644 comply to the C standards, but it will provide you with smaller code
7645 size.
7646 @end table
7648 @node Blackfin Options
7649 @subsection Blackfin Options
7650 @cindex Blackfin Options
7652 @table @gcctabopt
7653 @item -momit-leaf-frame-pointer
7654 @opindex momit-leaf-frame-pointer
7655 Don't keep the frame pointer in a register for leaf functions.  This
7656 avoids the instructions to save, set up and restore frame pointers and
7657 makes an extra register available in leaf functions.  The option
7658 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7659 which might make debugging harder.
7661 @item -mspecld-anomaly
7662 @opindex mspecld-anomaly
7663 When enabled, the compiler will ensure that the generated code does not
7664 contain speculative loads after jump instructions.  This option is enabled
7665 by default.
7667 @item -mno-specld-anomaly
7668 @opindex mno-specld-anomaly
7669 Don't generate extra code to prevent speculative loads from occurring.
7671 @item -mcsync-anomaly
7672 @opindex mcsync-anomaly
7673 When enabled, the compiler will ensure that the generated code does not
7674 contain CSYNC or SSYNC instructions too soon after conditional branches.
7675 This option is enabled by default.
7677 @item -mno-csync-anomaly
7678 @opindex mno-csync-anomaly
7679 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7680 occurring too soon after a conditional branch.
7682 @item -mlow-64k
7683 @opindex mlow-64k
7684 When enabled, the compiler is free to take advantage of the knowledge that
7685 the entire program fits into the low 64k of memory.
7687 @item -mno-low-64k
7688 @opindex mno-low-64k
7689 Assume that the program is arbitrarily large.  This is the default.
7691 @item -mid-shared-library
7692 @opindex mid-shared-library
7693 Generate code that supports shared libraries via the library ID method.
7694 This allows for execute in place and shared libraries in an environment
7695 without virtual memory management.  This option implies @option{-fPIC}.
7697 @item -mno-id-shared-library
7698 @opindex mno-id-shared-library
7699 Generate code that doesn't assume ID based shared libraries are being used.
7700 This is the default.
7702 @item -mshared-library-id=n
7703 @opindex mshared-library-id
7704 Specified the identification number of the ID based shared library being
7705 compiled.  Specifying a value of 0 will generate more compact code, specifying
7706 other values will force the allocation of that number to the current
7707 library but is no more space or time efficient than omitting this option.
7709 @item -mlong-calls
7710 @itemx -mno-long-calls
7711 @opindex mlong-calls
7712 @opindex mno-long-calls
7713 Tells the compiler to perform function calls by first loading the
7714 address of the function into a register and then performing a subroutine
7715 call on this register.  This switch is needed if the target function
7716 will lie outside of the 24 bit addressing range of the offset based
7717 version of subroutine call instruction.
7719 This feature is not enabled by default.  Specifying
7720 @option{-mno-long-calls} will restore the default behavior.  Note these
7721 switches have no effect on how the compiler generates code to handle
7722 function calls via function pointers.
7723 @end table
7725 @node CRIS Options
7726 @subsection CRIS Options
7727 @cindex CRIS Options
7729 These options are defined specifically for the CRIS ports.
7731 @table @gcctabopt
7732 @item -march=@var{architecture-type}
7733 @itemx -mcpu=@var{architecture-type}
7734 @opindex march
7735 @opindex mcpu
7736 Generate code for the specified architecture.  The choices for
7737 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7738 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7739 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7740 @samp{v10}.
7742 @item -mtune=@var{architecture-type}
7743 @opindex mtune
7744 Tune to @var{architecture-type} everything applicable about the generated
7745 code, except for the ABI and the set of available instructions.  The
7746 choices for @var{architecture-type} are the same as for
7747 @option{-march=@var{architecture-type}}.
7749 @item -mmax-stack-frame=@var{n}
7750 @opindex mmax-stack-frame
7751 Warn when the stack frame of a function exceeds @var{n} bytes.
7753 @item -melinux-stacksize=@var{n}
7754 @opindex melinux-stacksize
7755 Only available with the @samp{cris-axis-aout} target.  Arranges for
7756 indications in the program to the kernel loader that the stack of the
7757 program should be set to @var{n} bytes.
7759 @item -metrax4
7760 @itemx -metrax100
7761 @opindex metrax4
7762 @opindex metrax100
7763 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7764 @option{-march=v3} and @option{-march=v8} respectively.
7766 @item -mmul-bug-workaround
7767 @itemx -mno-mul-bug-workaround
7768 @opindex mmul-bug-workaround
7769 @opindex mno-mul-bug-workaround
7770 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7771 models where it applies.  This option is active by default.
7773 @item -mpdebug
7774 @opindex mpdebug
7775 Enable CRIS-specific verbose debug-related information in the assembly
7776 code.  This option also has the effect to turn off the @samp{#NO_APP}
7777 formatted-code indicator to the assembler at the beginning of the
7778 assembly file.
7780 @item -mcc-init
7781 @opindex mcc-init
7782 Do not use condition-code results from previous instruction; always emit
7783 compare and test instructions before use of condition codes.
7785 @item -mno-side-effects
7786 @opindex mno-side-effects
7787 Do not emit instructions with side-effects in addressing modes other than
7788 post-increment.
7790 @item -mstack-align
7791 @itemx -mno-stack-align
7792 @itemx -mdata-align
7793 @itemx -mno-data-align
7794 @itemx -mconst-align
7795 @itemx -mno-const-align
7796 @opindex mstack-align
7797 @opindex mno-stack-align
7798 @opindex mdata-align
7799 @opindex mno-data-align
7800 @opindex mconst-align
7801 @opindex mno-const-align
7802 These options (no-options) arranges (eliminate arrangements) for the
7803 stack-frame, individual data and constants to be aligned for the maximum
7804 single data access size for the chosen CPU model.  The default is to
7805 arrange for 32-bit alignment.  ABI details such as structure layout are
7806 not affected by these options.
7808 @item -m32-bit
7809 @itemx -m16-bit
7810 @itemx -m8-bit
7811 @opindex m32-bit
7812 @opindex m16-bit
7813 @opindex m8-bit
7814 Similar to the stack- data- and const-align options above, these options
7815 arrange for stack-frame, writable data and constants to all be 32-bit,
7816 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7818 @item -mno-prologue-epilogue
7819 @itemx -mprologue-epilogue
7820 @opindex mno-prologue-epilogue
7821 @opindex mprologue-epilogue
7822 With @option{-mno-prologue-epilogue}, the normal function prologue and
7823 epilogue that sets up the stack-frame are omitted and no return
7824 instructions or return sequences are generated in the code.  Use this
7825 option only together with visual inspection of the compiled code: no
7826 warnings or errors are generated when call-saved registers must be saved,
7827 or storage for local variable needs to be allocated.
7829 @item -mno-gotplt
7830 @itemx -mgotplt
7831 @opindex mno-gotplt
7832 @opindex mgotplt
7833 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7834 instruction sequences that load addresses for functions from the PLT part
7835 of the GOT rather than (traditional on other architectures) calls to the
7836 PLT@.  The default is @option{-mgotplt}.
7838 @item -maout
7839 @opindex maout
7840 Legacy no-op option only recognized with the cris-axis-aout target.
7842 @item -melf
7843 @opindex melf
7844 Legacy no-op option only recognized with the cris-axis-elf and
7845 cris-axis-linux-gnu targets.
7847 @item -melinux
7848 @opindex melinux
7849 Only recognized with the cris-axis-aout target, where it selects a
7850 GNU/linux-like multilib, include files and instruction set for
7851 @option{-march=v8}.
7853 @item -mlinux
7854 @opindex mlinux
7855 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7857 @item -sim
7858 @opindex sim
7859 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7860 to link with input-output functions from a simulator library.  Code,
7861 initialized data and zero-initialized data are allocated consecutively.
7863 @item -sim2
7864 @opindex sim2
7865 Like @option{-sim}, but pass linker options to locate initialized data at
7866 0x40000000 and zero-initialized data at 0x80000000.
7867 @end table
7869 @node CRX Options
7870 @subsection CRX Options
7871 @cindex CRX Options
7873 These options are defined specifically for the CRX ports.
7875 @table @gcctabopt
7877 @item -mmac
7878 @opindex mmac
7879 Enable the use of multiply-accumulate instructions.  Disabled by default.
7881 @item -mpush-args
7882 @opindex mpush-args
7883 Push instructions will be used to pass outgoing arguments when functions
7884 are called.  Enabled by default.
7885 @end table
7887 @node Darwin Options
7888 @subsection Darwin Options
7889 @cindex Darwin options
7891 These options are defined for all architectures running the Darwin operating
7892 system.
7894 FSF GCC on Darwin does not create ``fat'' object files; it will create
7895 an object file for the single architecture that it was built to
7896 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7897 @option{-arch} options are used; it does so by running the compiler or
7898 linker multiple times and joining the results together with
7899 @file{lipo}.
7901 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7902 @samp{i686}) is determined by the flags that specify the ISA
7903 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7904 @option{-force_cpusubtype_ALL} option can be used to override this.
7906 The Darwin tools vary in their behavior when presented with an ISA
7907 mismatch.  The assembler, @file{as}, will only permit instructions to
7908 be used that are valid for the subtype of the file it is generating,
7909 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7910 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7911 and print an error if asked to create a shared library with a less
7912 restrictive subtype than its input files (for instance, trying to put
7913 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7914 for executables, @file{ld}, will quietly give the executable the most
7915 restrictive subtype of any of its input files.
7917 @table @gcctabopt
7918 @item -F@var{dir}
7919 @opindex F
7920 Add the framework directory @var{dir} to the head of the list of
7921 directories to be searched for header files.  These directories are
7922 interleaved with those specified by @option{-I} options and are
7923 scanned in a left-to-right order.
7925 A framework directory is a directory with frameworks in it.  A
7926 framework is a directory with a @samp{"Headers"} and/or
7927 @samp{"PrivateHeaders"} directory contained directly in it that ends
7928 in @samp{".framework"}.  The name of a framework is the name of this
7929 directory excluding the @samp{".framework"}.  Headers associated with
7930 the framework are found in one of those two directories, with
7931 @samp{"Headers"} being searched first.  A subframework is a framework
7932 directory that is in a framework's @samp{"Frameworks"} directory.
7933 Includes of subframework headers can only appear in a header of a
7934 framework that contains the subframework, or in a sibling subframework
7935 header.  Two subframeworks are siblings if they occur in the same
7936 framework.  A subframework should not have the same name as a
7937 framework, a warning will be issued if this is violated.  Currently a
7938 subframework cannot have subframeworks, in the future, the mechanism
7939 may be extended to support this.  The standard frameworks can be found
7940 in @samp{"/System/Library/Frameworks"} and
7941 @samp{"/Library/Frameworks"}.  An example include looks like
7942 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7943 the name of the framework and header.h is found in the
7944 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7946 @item -gused
7947 @opindex -gused
7948 Emit debugging information for symbols that are used.  For STABS
7949 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7950 This is by default ON@.
7952 @item -gfull
7953 @opindex -gfull
7954 Emit debugging information for all symbols and types.
7956 @item -mmacosx-version-min=@var{version}
7957 The earliest version of MacOS X that this executable will run on
7958 is @var{version}.  Typical values of @var{version} include @code{10.1},
7959 @code{10.2}, and @code{10.3.9}.
7961 The default for this option is to make choices that seem to be most
7962 useful.  
7964 @item -mone-byte-bool
7965 @opindex -mone-byte-bool
7966 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7967 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7968 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7969 option has no effect on x86.
7971 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7972 to generate code that is not binary compatible with code generated
7973 without that switch.  Using this switch may require recompiling all
7974 other modules in a program, including system libraries.  Use this
7975 switch to conform to a non-default data model.
7977 @item -mfix-and-continue
7978 @itemx -ffix-and-continue
7979 @itemx -findirect-data
7980 @opindex mfix-and-continue
7981 @opindex ffix-and-continue
7982 @opindex findirect-data
7983 Generate code suitable for fast turn around development.  Needed to
7984 enable gdb to dynamically load @code{.o} files into already running
7985 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7986 are provided for backwards compatibility.
7988 @item -all_load
7989 @opindex all_load
7990 Loads all members of static archive libraries.
7991 See man ld(1) for more information.
7993 @item -arch_errors_fatal
7994 @opindex arch_errors_fatal
7995 Cause the errors having to do with files that have the wrong architecture
7996 to be fatal.
7998 @item -bind_at_load
7999 @opindex bind_at_load
8000 Causes the output file to be marked such that the dynamic linker will
8001 bind all undefined references when the file is loaded or launched.
8003 @item -bundle
8004 @opindex bundle
8005 Produce a Mach-o bundle format file.
8006 See man ld(1) for more information.
8008 @item -bundle_loader @var{executable}
8009 @opindex bundle_loader
8010 This option specifies the @var{executable} that will be loading the build
8011 output file being linked.  See man ld(1) for more information.
8013 @item -dynamiclib
8014 @opindex -dynamiclib
8015 When passed this option, GCC will produce a dynamic library instead of
8016 an executable when linking, using the Darwin @file{libtool} command.
8018 @item -force_cpusubtype_ALL
8019 @opindex -force_cpusubtype_ALL
8020 This causes GCC's output file to have the @var{ALL} subtype, instead of
8021 one controlled by the @option{-mcpu} or @option{-march} option.
8023 @item -allowable_client  @var{client_name}
8024 @itemx -client_name
8025 @itemx -compatibility_version
8026 @itemx -current_version
8027 @itemx -dead_strip
8028 @itemx -dependency-file
8029 @itemx -dylib_file
8030 @itemx -dylinker_install_name
8031 @itemx -dynamic
8032 @itemx -exported_symbols_list
8033 @itemx -filelist
8034 @itemx -flat_namespace
8035 @itemx -force_flat_namespace
8036 @itemx -headerpad_max_install_names
8037 @itemx -image_base
8038 @itemx -init
8039 @itemx -install_name
8040 @itemx -keep_private_externs
8041 @itemx -multi_module
8042 @itemx -multiply_defined
8043 @itemx -multiply_defined_unused
8044 @itemx -noall_load
8045 @itemx -no_dead_strip_inits_and_terms
8046 @itemx -nofixprebinding
8047 @itemx -nomultidefs
8048 @itemx -noprebind
8049 @itemx -noseglinkedit
8050 @itemx -pagezero_size
8051 @itemx -prebind
8052 @itemx -prebind_all_twolevel_modules
8053 @itemx -private_bundle
8054 @itemx -read_only_relocs
8055 @itemx -sectalign
8056 @itemx -sectobjectsymbols
8057 @itemx -whyload
8058 @itemx -seg1addr
8059 @itemx -sectcreate
8060 @itemx -sectobjectsymbols
8061 @itemx -sectorder
8062 @itemx -segaddr
8063 @itemx -segs_read_only_addr
8064 @itemx -segs_read_write_addr
8065 @itemx -seg_addr_table
8066 @itemx -seg_addr_table_filename
8067 @itemx -seglinkedit
8068 @itemx -segprot
8069 @itemx -segs_read_only_addr
8070 @itemx -segs_read_write_addr
8071 @itemx -single_module
8072 @itemx -static
8073 @itemx -sub_library
8074 @itemx -sub_umbrella
8075 @itemx -twolevel_namespace
8076 @itemx -umbrella
8077 @itemx -undefined
8078 @itemx -unexported_symbols_list
8079 @itemx -weak_reference_mismatches
8080 @itemx -whatsloaded
8082 @opindex allowable_client
8083 @opindex client_name
8084 @opindex compatibility_version
8085 @opindex current_version
8086 @opindex dead_strip
8087 @opindex dependency-file
8088 @opindex dylib_file
8089 @opindex dylinker_install_name
8090 @opindex dynamic
8091 @opindex exported_symbols_list
8092 @opindex filelist
8093 @opindex flat_namespace
8094 @opindex force_flat_namespace
8095 @opindex headerpad_max_install_names
8096 @opindex image_base
8097 @opindex init
8098 @opindex install_name
8099 @opindex keep_private_externs
8100 @opindex multi_module
8101 @opindex multiply_defined
8102 @opindex multiply_defined_unused
8103 @opindex noall_load
8104 @opindex no_dead_strip_inits_and_terms
8105 @opindex nofixprebinding
8106 @opindex nomultidefs
8107 @opindex noprebind
8108 @opindex noseglinkedit
8109 @opindex pagezero_size
8110 @opindex prebind
8111 @opindex prebind_all_twolevel_modules
8112 @opindex private_bundle
8113 @opindex read_only_relocs
8114 @opindex sectalign
8115 @opindex sectobjectsymbols
8116 @opindex whyload
8117 @opindex seg1addr
8118 @opindex sectcreate
8119 @opindex sectobjectsymbols
8120 @opindex sectorder
8121 @opindex segaddr
8122 @opindex segs_read_only_addr
8123 @opindex segs_read_write_addr
8124 @opindex seg_addr_table
8125 @opindex seg_addr_table_filename
8126 @opindex seglinkedit
8127 @opindex segprot
8128 @opindex segs_read_only_addr
8129 @opindex segs_read_write_addr
8130 @opindex single_module
8131 @opindex static
8132 @opindex sub_library
8133 @opindex sub_umbrella
8134 @opindex twolevel_namespace
8135 @opindex umbrella
8136 @opindex undefined
8137 @opindex unexported_symbols_list
8138 @opindex weak_reference_mismatches
8139 @opindex whatsloaded
8141 These options are passed to the Darwin linker.  The Darwin linker man page
8142 describes them in detail.
8143 @end table
8145 @node DEC Alpha Options
8146 @subsection DEC Alpha Options
8148 These @samp{-m} options are defined for the DEC Alpha implementations:
8150 @table @gcctabopt
8151 @item -mno-soft-float
8152 @itemx -msoft-float
8153 @opindex mno-soft-float
8154 @opindex msoft-float
8155 Use (do not use) the hardware floating-point instructions for
8156 floating-point operations.  When @option{-msoft-float} is specified,
8157 functions in @file{libgcc.a} will be used to perform floating-point
8158 operations.  Unless they are replaced by routines that emulate the
8159 floating-point operations, or compiled in such a way as to call such
8160 emulations routines, these routines will issue floating-point
8161 operations.   If you are compiling for an Alpha without floating-point
8162 operations, you must ensure that the library is built so as not to call
8163 them.
8165 Note that Alpha implementations without floating-point operations are
8166 required to have floating-point registers.
8168 @item -mfp-reg
8169 @itemx -mno-fp-regs
8170 @opindex mfp-reg
8171 @opindex mno-fp-regs
8172 Generate code that uses (does not use) the floating-point register set.
8173 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8174 register set is not used, floating point operands are passed in integer
8175 registers as if they were integers and floating-point results are passed
8176 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8177 so any function with a floating-point argument or return value called by code
8178 compiled with @option{-mno-fp-regs} must also be compiled with that
8179 option.
8181 A typical use of this option is building a kernel that does not use,
8182 and hence need not save and restore, any floating-point registers.
8184 @item -mieee
8185 @opindex mieee
8186 The Alpha architecture implements floating-point hardware optimized for
8187 maximum performance.  It is mostly compliant with the IEEE floating
8188 point standard.  However, for full compliance, software assistance is
8189 required.  This option generates code fully IEEE compliant code
8190 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8191 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8192 defined during compilation.  The resulting code is less efficient but is
8193 able to correctly support denormalized numbers and exceptional IEEE
8194 values such as not-a-number and plus/minus infinity.  Other Alpha
8195 compilers call this option @option{-ieee_with_no_inexact}.
8197 @item -mieee-with-inexact
8198 @opindex mieee-with-inexact
8199 This is like @option{-mieee} except the generated code also maintains
8200 the IEEE @var{inexact-flag}.  Turning on this option causes the
8201 generated code to implement fully-compliant IEEE math.  In addition to
8202 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8203 macro.  On some Alpha implementations the resulting code may execute
8204 significantly slower than the code generated by default.  Since there is
8205 very little code that depends on the @var{inexact-flag}, you should
8206 normally not specify this option.  Other Alpha compilers call this
8207 option @option{-ieee_with_inexact}.
8209 @item -mfp-trap-mode=@var{trap-mode}
8210 @opindex mfp-trap-mode
8211 This option controls what floating-point related traps are enabled.
8212 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8213 The trap mode can be set to one of four values:
8215 @table @samp
8216 @item n
8217 This is the default (normal) setting.  The only traps that are enabled
8218 are the ones that cannot be disabled in software (e.g., division by zero
8219 trap).
8221 @item u
8222 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8223 as well.
8225 @item su
8226 Like @samp{su}, but the instructions are marked to be safe for software
8227 completion (see Alpha architecture manual for details).
8229 @item sui
8230 Like @samp{su}, but inexact traps are enabled as well.
8231 @end table
8233 @item -mfp-rounding-mode=@var{rounding-mode}
8234 @opindex mfp-rounding-mode
8235 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8236 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8239 @table @samp
8240 @item n
8241 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8242 the nearest machine number or towards the even machine number in case
8243 of a tie.
8245 @item m
8246 Round towards minus infinity.
8248 @item c
8249 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8251 @item d
8252 Dynamic rounding mode.  A field in the floating point control register
8253 (@var{fpcr}, see Alpha architecture reference manual) controls the
8254 rounding mode in effect.  The C library initializes this register for
8255 rounding towards plus infinity.  Thus, unless your program modifies the
8256 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8257 @end table
8259 @item -mtrap-precision=@var{trap-precision}
8260 @opindex mtrap-precision
8261 In the Alpha architecture, floating point traps are imprecise.  This
8262 means without software assistance it is impossible to recover from a
8263 floating trap and program execution normally needs to be terminated.
8264 GCC can generate code that can assist operating system trap handlers
8265 in determining the exact location that caused a floating point trap.
8266 Depending on the requirements of an application, different levels of
8267 precisions can be selected:
8269 @table @samp
8270 @item p
8271 Program precision.  This option is the default and means a trap handler
8272 can only identify which program caused a floating point exception.
8274 @item f
8275 Function precision.  The trap handler can determine the function that
8276 caused a floating point exception.
8278 @item i
8279 Instruction precision.  The trap handler can determine the exact
8280 instruction that caused a floating point exception.
8281 @end table
8283 Other Alpha compilers provide the equivalent options called
8284 @option{-scope_safe} and @option{-resumption_safe}.
8286 @item -mieee-conformant
8287 @opindex mieee-conformant
8288 This option marks the generated code as IEEE conformant.  You must not
8289 use this option unless you also specify @option{-mtrap-precision=i} and either
8290 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8291 is to emit the line @samp{.eflag 48} in the function prologue of the
8292 generated assembly file.  Under DEC Unix, this has the effect that
8293 IEEE-conformant math library routines will be linked in.
8295 @item -mbuild-constants
8296 @opindex mbuild-constants
8297 Normally GCC examines a 32- or 64-bit integer constant to
8298 see if it can construct it from smaller constants in two or three
8299 instructions.  If it cannot, it will output the constant as a literal and
8300 generate code to load it from the data segment at runtime.
8302 Use this option to require GCC to construct @emph{all} integer constants
8303 using code, even if it takes more instructions (the maximum is six).
8305 You would typically use this option to build a shared library dynamic
8306 loader.  Itself a shared library, it must relocate itself in memory
8307 before it can find the variables and constants in its own data segment.
8309 @item -malpha-as
8310 @itemx -mgas
8311 @opindex malpha-as
8312 @opindex mgas
8313 Select whether to generate code to be assembled by the vendor-supplied
8314 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8316 @item -mbwx
8317 @itemx -mno-bwx
8318 @itemx -mcix
8319 @itemx -mno-cix
8320 @itemx -mfix
8321 @itemx -mno-fix
8322 @itemx -mmax
8323 @itemx -mno-max
8324 @opindex mbwx
8325 @opindex mno-bwx
8326 @opindex mcix
8327 @opindex mno-cix
8328 @opindex mfix
8329 @opindex mno-fix
8330 @opindex mmax
8331 @opindex mno-max
8332 Indicate whether GCC should generate code to use the optional BWX,
8333 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8334 sets supported by the CPU type specified via @option{-mcpu=} option or that
8335 of the CPU on which GCC was built if none was specified.
8337 @item -mfloat-vax
8338 @itemx -mfloat-ieee
8339 @opindex mfloat-vax
8340 @opindex mfloat-ieee
8341 Generate code that uses (does not use) VAX F and G floating point
8342 arithmetic instead of IEEE single and double precision.
8344 @item -mexplicit-relocs
8345 @itemx -mno-explicit-relocs
8346 @opindex mexplicit-relocs
8347 @opindex mno-explicit-relocs
8348 Older Alpha assemblers provided no way to generate symbol relocations
8349 except via assembler macros.  Use of these macros does not allow
8350 optimal instruction scheduling.  GNU binutils as of version 2.12
8351 supports a new syntax that allows the compiler to explicitly mark
8352 which relocations should apply to which instructions.  This option
8353 is mostly useful for debugging, as GCC detects the capabilities of
8354 the assembler when it is built and sets the default accordingly.
8356 @item -msmall-data
8357 @itemx -mlarge-data
8358 @opindex msmall-data
8359 @opindex mlarge-data
8360 When @option{-mexplicit-relocs} is in effect, static data is
8361 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8362 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8363 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8364 16-bit relocations off of the @code{$gp} register.  This limits the
8365 size of the small data area to 64KB, but allows the variables to be
8366 directly accessed via a single instruction.
8368 The default is @option{-mlarge-data}.  With this option the data area
8369 is limited to just below 2GB@.  Programs that require more than 2GB of
8370 data must use @code{malloc} or @code{mmap} to allocate the data in the
8371 heap instead of in the program's data segment.
8373 When generating code for shared libraries, @option{-fpic} implies
8374 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8376 @item -msmall-text
8377 @itemx -mlarge-text
8378 @opindex msmall-text
8379 @opindex mlarge-text
8380 When @option{-msmall-text} is used, the compiler assumes that the
8381 code of the entire program (or shared library) fits in 4MB, and is
8382 thus reachable with a branch instruction.  When @option{-msmall-data}
8383 is used, the compiler can assume that all local symbols share the
8384 same @code{$gp} value, and thus reduce the number of instructions
8385 required for a function call from 4 to 1.
8387 The default is @option{-mlarge-text}.
8389 @item -mcpu=@var{cpu_type}
8390 @opindex mcpu
8391 Set the instruction set and instruction scheduling parameters for
8392 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8393 style name or the corresponding chip number.  GCC supports scheduling
8394 parameters for the EV4, EV5 and EV6 family of processors and will
8395 choose the default values for the instruction set from the processor
8396 you specify.  If you do not specify a processor type, GCC will default
8397 to the processor on which the compiler was built.
8399 Supported values for @var{cpu_type} are
8401 @table @samp
8402 @item ev4
8403 @itemx ev45
8404 @itemx 21064
8405 Schedules as an EV4 and has no instruction set extensions.
8407 @item ev5
8408 @itemx 21164
8409 Schedules as an EV5 and has no instruction set extensions.
8411 @item ev56
8412 @itemx 21164a
8413 Schedules as an EV5 and supports the BWX extension.
8415 @item pca56
8416 @itemx 21164pc
8417 @itemx 21164PC
8418 Schedules as an EV5 and supports the BWX and MAX extensions.
8420 @item ev6
8421 @itemx 21264
8422 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8424 @item ev67
8425 @itemx 21264a
8426 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8427 @end table
8429 @item -mtune=@var{cpu_type}
8430 @opindex mtune
8431 Set only the instruction scheduling parameters for machine type
8432 @var{cpu_type}.  The instruction set is not changed.
8434 @item -mmemory-latency=@var{time}
8435 @opindex mmemory-latency
8436 Sets the latency the scheduler should assume for typical memory
8437 references as seen by the application.  This number is highly
8438 dependent on the memory access patterns used by the application
8439 and the size of the external cache on the machine.
8441 Valid options for @var{time} are
8443 @table @samp
8444 @item @var{number}
8445 A decimal number representing clock cycles.
8447 @item L1
8448 @itemx L2
8449 @itemx L3
8450 @itemx main
8451 The compiler contains estimates of the number of clock cycles for
8452 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8453 (also called Dcache, Scache, and Bcache), as well as to main memory.
8454 Note that L3 is only valid for EV5.
8456 @end table
8457 @end table
8459 @node DEC Alpha/VMS Options
8460 @subsection DEC Alpha/VMS Options
8462 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8464 @table @gcctabopt
8465 @item -mvms-return-codes
8466 @opindex mvms-return-codes
8467 Return VMS condition codes from main.  The default is to return POSIX
8468 style condition (e.g.@ error) codes.
8469 @end table
8471 @node FRV Options
8472 @subsection FRV Options
8473 @cindex FRV Options
8475 @table @gcctabopt
8476 @item -mgpr-32
8477 @opindex mgpr-32
8479 Only use the first 32 general purpose registers.
8481 @item -mgpr-64
8482 @opindex mgpr-64
8484 Use all 64 general purpose registers.
8486 @item -mfpr-32
8487 @opindex mfpr-32
8489 Use only the first 32 floating point registers.
8491 @item -mfpr-64
8492 @opindex mfpr-64
8494 Use all 64 floating point registers
8496 @item -mhard-float
8497 @opindex mhard-float
8499 Use hardware instructions for floating point operations.
8501 @item -msoft-float
8502 @opindex msoft-float
8504 Use library routines for floating point operations.
8506 @item -malloc-cc
8507 @opindex malloc-cc
8509 Dynamically allocate condition code registers.
8511 @item -mfixed-cc
8512 @opindex mfixed-cc
8514 Do not try to dynamically allocate condition code registers, only
8515 use @code{icc0} and @code{fcc0}.
8517 @item -mdword
8518 @opindex mdword
8520 Change ABI to use double word insns.
8522 @item -mno-dword
8523 @opindex mno-dword
8525 Do not use double word instructions.
8527 @item -mdouble
8528 @opindex mdouble
8530 Use floating point double instructions.
8532 @item -mno-double
8533 @opindex mno-double
8535 Do not use floating point double instructions.
8537 @item -mmedia
8538 @opindex mmedia
8540 Use media instructions.
8542 @item -mno-media
8543 @opindex mno-media
8545 Do not use media instructions.
8547 @item -mmuladd
8548 @opindex mmuladd
8550 Use multiply and add/subtract instructions.
8552 @item -mno-muladd
8553 @opindex mno-muladd
8555 Do not use multiply and add/subtract instructions.
8557 @item -mfdpic
8558 @opindex mfdpic
8560 Select the FDPIC ABI, that uses function descriptors to represent
8561 pointers to functions.  Without any PIC/PIE-related options, it
8562 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8563 assumes GOT entries and small data are within a 12-bit range from the
8564 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8565 are computed with 32 bits.
8567 @item -minline-plt
8568 @opindex minline-plt
8570 Enable inlining of PLT entries in function calls to functions that are
8571 not known to bind locally.  It has no effect without @option{-mfdpic}.
8572 It's enabled by default if optimizing for speed and compiling for
8573 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8574 optimization option such as @option{-O3} or above is present in the
8575 command line.
8577 @item -mTLS
8578 @opindex TLS
8580 Assume a large TLS segment when generating thread-local code.
8582 @item -mtls
8583 @opindex tls
8585 Do not assume a large TLS segment when generating thread-local code.
8587 @item -mgprel-ro
8588 @opindex mgprel-ro
8590 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8591 that is known to be in read-only sections.  It's enabled by default,
8592 except for @option{-fpic} or @option{-fpie}: even though it may help
8593 make the global offset table smaller, it trades 1 instruction for 4.
8594 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8595 one of which may be shared by multiple symbols, and it avoids the need
8596 for a GOT entry for the referenced symbol, so it's more likely to be a
8597 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8599 @item -multilib-library-pic
8600 @opindex multilib-library-pic
8602 Link with the (library, not FD) pic libraries.  It's implied by
8603 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8604 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8605 it explicitly.
8607 @item -mlinked-fp
8608 @opindex mlinked-fp
8610 Follow the EABI requirement of always creating a frame pointer whenever
8611 a stack frame is allocated.  This option is enabled by default and can
8612 be disabled with @option{-mno-linked-fp}.
8614 @item -mlong-calls
8615 @opindex mlong-calls
8617 Use indirect addressing to call functions outside the current
8618 compilation unit.  This allows the functions to be placed anywhere
8619 within the 32-bit address space.
8621 @item -malign-labels
8622 @opindex malign-labels
8624 Try to align labels to an 8-byte boundary by inserting nops into the
8625 previous packet.  This option only has an effect when VLIW packing
8626 is enabled.  It doesn't create new packets; it merely adds nops to
8627 existing ones.
8629 @item -mlibrary-pic
8630 @opindex mlibrary-pic
8632 Generate position-independent EABI code.
8634 @item -macc-4
8635 @opindex macc-4
8637 Use only the first four media accumulator registers.
8639 @item -macc-8
8640 @opindex macc-8
8642 Use all eight media accumulator registers.
8644 @item -mpack
8645 @opindex mpack
8647 Pack VLIW instructions.
8649 @item -mno-pack
8650 @opindex mno-pack
8652 Do not pack VLIW instructions.
8654 @item -mno-eflags
8655 @opindex mno-eflags
8657 Do not mark ABI switches in e_flags.
8659 @item -mcond-move
8660 @opindex mcond-move
8662 Enable the use of conditional-move instructions (default).
8664 This switch is mainly for debugging the compiler and will likely be removed
8665 in a future version.
8667 @item -mno-cond-move
8668 @opindex mno-cond-move
8670 Disable the use of conditional-move instructions.
8672 This switch is mainly for debugging the compiler and will likely be removed
8673 in a future version.
8675 @item -mscc
8676 @opindex mscc
8678 Enable the use of conditional set instructions (default).
8680 This switch is mainly for debugging the compiler and will likely be removed
8681 in a future version.
8683 @item -mno-scc
8684 @opindex mno-scc
8686 Disable the use of conditional set instructions.
8688 This switch is mainly for debugging the compiler and will likely be removed
8689 in a future version.
8691 @item -mcond-exec
8692 @opindex mcond-exec
8694 Enable the use of conditional execution (default).
8696 This switch is mainly for debugging the compiler and will likely be removed
8697 in a future version.
8699 @item -mno-cond-exec
8700 @opindex mno-cond-exec
8702 Disable the use of conditional execution.
8704 This switch is mainly for debugging the compiler and will likely be removed
8705 in a future version.
8707 @item -mvliw-branch
8708 @opindex mvliw-branch
8710 Run a pass to pack branches into VLIW instructions (default).
8712 This switch is mainly for debugging the compiler and will likely be removed
8713 in a future version.
8715 @item -mno-vliw-branch
8716 @opindex mno-vliw-branch
8718 Do not run a pass to pack branches into VLIW instructions.
8720 This switch is mainly for debugging the compiler and will likely be removed
8721 in a future version.
8723 @item -mmulti-cond-exec
8724 @opindex mmulti-cond-exec
8726 Enable optimization of @code{&&} and @code{||} in conditional execution
8727 (default).
8729 This switch is mainly for debugging the compiler and will likely be removed
8730 in a future version.
8732 @item -mno-multi-cond-exec
8733 @opindex mno-multi-cond-exec
8735 Disable optimization of @code{&&} and @code{||} in conditional execution.
8737 This switch is mainly for debugging the compiler and will likely be removed
8738 in a future version.
8740 @item -mnested-cond-exec
8741 @opindex mnested-cond-exec
8743 Enable nested conditional execution optimizations (default).
8745 This switch is mainly for debugging the compiler and will likely be removed
8746 in a future version.
8748 @item -mno-nested-cond-exec
8749 @opindex mno-nested-cond-exec
8751 Disable nested conditional execution optimizations.
8753 This switch is mainly for debugging the compiler and will likely be removed
8754 in a future version.
8756 @item -moptimize-membar
8757 @opindex moptimize-membar
8759 This switch removes redundant @code{membar} instructions from the
8760 compiler generated code.  It is enabled by default.
8762 @item -mno-optimize-membar
8763 @opindex mno-optimize-membar
8765 This switch disables the automatic removal of redundant @code{membar}
8766 instructions from the generated code.
8768 @item -mtomcat-stats
8769 @opindex mtomcat-stats
8771 Cause gas to print out tomcat statistics.
8773 @item -mcpu=@var{cpu}
8774 @opindex mcpu
8776 Select the processor type for which to generate code.  Possible values are
8777 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8778 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8780 @end table
8782 @node H8/300 Options
8783 @subsection H8/300 Options
8785 These @samp{-m} options are defined for the H8/300 implementations:
8787 @table @gcctabopt
8788 @item -mrelax
8789 @opindex mrelax
8790 Shorten some address references at link time, when possible; uses the
8791 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8792 ld, Using ld}, for a fuller description.
8794 @item -mh
8795 @opindex mh
8796 Generate code for the H8/300H@.
8798 @item -ms
8799 @opindex ms
8800 Generate code for the H8S@.
8802 @item -mn
8803 @opindex mn
8804 Generate code for the H8S and H8/300H in the normal mode.  This switch
8805 must be used either with @option{-mh} or @option{-ms}.
8807 @item -ms2600
8808 @opindex ms2600
8809 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8811 @item -mint32
8812 @opindex mint32
8813 Make @code{int} data 32 bits by default.
8815 @item -malign-300
8816 @opindex malign-300
8817 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8818 The default for the H8/300H and H8S is to align longs and floats on 4
8819 byte boundaries.
8820 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8821 This option has no effect on the H8/300.
8822 @end table
8824 @node HPPA Options
8825 @subsection HPPA Options
8826 @cindex HPPA Options
8828 These @samp{-m} options are defined for the HPPA family of computers:
8830 @table @gcctabopt
8831 @item -march=@var{architecture-type}
8832 @opindex march
8833 Generate code for the specified architecture.  The choices for
8834 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8835 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8836 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8837 architecture option for your machine.  Code compiled for lower numbered
8838 architectures will run on higher numbered architectures, but not the
8839 other way around.
8841 @item -mpa-risc-1-0
8842 @itemx -mpa-risc-1-1
8843 @itemx -mpa-risc-2-0
8844 @opindex mpa-risc-1-0
8845 @opindex mpa-risc-1-1
8846 @opindex mpa-risc-2-0
8847 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8849 @item -mbig-switch
8850 @opindex mbig-switch
8851 Generate code suitable for big switch tables.  Use this option only if
8852 the assembler/linker complain about out of range branches within a switch
8853 table.
8855 @item -mjump-in-delay
8856 @opindex mjump-in-delay
8857 Fill delay slots of function calls with unconditional jump instructions
8858 by modifying the return pointer for the function call to be the target
8859 of the conditional jump.
8861 @item -mdisable-fpregs
8862 @opindex mdisable-fpregs
8863 Prevent floating point registers from being used in any manner.  This is
8864 necessary for compiling kernels which perform lazy context switching of
8865 floating point registers.  If you use this option and attempt to perform
8866 floating point operations, the compiler will abort.
8868 @item -mdisable-indexing
8869 @opindex mdisable-indexing
8870 Prevent the compiler from using indexing address modes.  This avoids some
8871 rather obscure problems when compiling MIG generated code under MACH@.
8873 @item -mno-space-regs
8874 @opindex mno-space-regs
8875 Generate code that assumes the target has no space registers.  This allows
8876 GCC to generate faster indirect calls and use unscaled index address modes.
8878 Such code is suitable for level 0 PA systems and kernels.
8880 @item -mfast-indirect-calls
8881 @opindex mfast-indirect-calls
8882 Generate code that assumes calls never cross space boundaries.  This
8883 allows GCC to emit code which performs faster indirect calls.
8885 This option will not work in the presence of shared libraries or nested
8886 functions.
8888 @item -mfixed-range=@var{register-range}
8889 @opindex mfixed-range
8890 Generate code treating the given register range as fixed registers.
8891 A fixed register is one that the register allocator can not use.  This is
8892 useful when compiling kernel code.  A register range is specified as
8893 two registers separated by a dash.  Multiple register ranges can be
8894 specified separated by a comma.
8896 @item -mlong-load-store
8897 @opindex mlong-load-store
8898 Generate 3-instruction load and store sequences as sometimes required by
8899 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8900 the HP compilers.
8902 @item -mportable-runtime
8903 @opindex mportable-runtime
8904 Use the portable calling conventions proposed by HP for ELF systems.
8906 @item -mgas
8907 @opindex mgas
8908 Enable the use of assembler directives only GAS understands.
8910 @item -mschedule=@var{cpu-type}
8911 @opindex mschedule
8912 Schedule code according to the constraints for the machine type
8913 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8914 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8915 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8916 proper scheduling option for your machine.  The default scheduling is
8917 @samp{8000}.
8919 @item -mlinker-opt
8920 @opindex mlinker-opt
8921 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8922 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8923 linkers in which they give bogus error messages when linking some programs.
8925 @item -msoft-float
8926 @opindex msoft-float
8927 Generate output containing library calls for floating point.
8928 @strong{Warning:} the requisite libraries are not available for all HPPA
8929 targets.  Normally the facilities of the machine's usual C compiler are
8930 used, but this cannot be done directly in cross-compilation.  You must make
8931 your own arrangements to provide suitable library functions for
8932 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8933 does provide software floating point support.
8935 @option{-msoft-float} changes the calling convention in the output file;
8936 therefore, it is only useful if you compile @emph{all} of a program with
8937 this option.  In particular, you need to compile @file{libgcc.a}, the
8938 library that comes with GCC, with @option{-msoft-float} in order for
8939 this to work.
8941 @item -msio
8942 @opindex msio
8943 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8944 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8945 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8946 options are available under HP-UX and HI-UX@.
8948 @item -mgnu-ld
8949 @opindex gnu-ld
8950 Use GNU ld specific options.  This passes @option{-shared} to ld when
8951 building a shared library.  It is the default when GCC is configured,
8952 explicitly or implicitly, with the GNU linker.  This option does not
8953 have any affect on which ld is called, it only changes what parameters
8954 are passed to that ld.  The ld that is called is determined by the
8955 @option{--with-ld} configure option, GCC's program search path, and
8956 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8957 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
8958 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8960 @item -mhp-ld
8961 @opindex hp-ld
8962 Use HP ld specific options.  This passes @option{-b} to ld when building
8963 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8964 links.  It is the default when GCC is configured, explicitly or
8965 implicitly, with the HP linker.  This option does not have any affect on
8966 which ld is called, it only changes what parameters are passed to that
8967 ld.  The ld that is called is determined by the @option{--with-ld}
8968 configure option, GCC's program search path, and finally by the user's
8969 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8970 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
8971 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8973 @item -mlong-calls
8974 @opindex mno-long-calls
8975 Generate code that uses long call sequences.  This ensures that a call
8976 is always able to reach linker generated stubs.  The default is to generate
8977 long calls only when the distance from the call site to the beginning
8978 of the function or translation unit, as the case may be, exceeds a
8979 predefined limit set by the branch type being used.  The limits for
8980 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8981 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8982 240,000 bytes.
8984 Distances are measured from the beginning of functions when using the
8985 @option{-ffunction-sections} option, or when using the @option{-mgas}
8986 and @option{-mno-portable-runtime} options together under HP-UX with
8987 the SOM linker.
8989 It is normally not desirable to use this option as it will degrade
8990 performance.  However, it may be useful in large applications,
8991 particularly when partial linking is used to build the application.
8993 The types of long calls used depends on the capabilities of the
8994 assembler and linker, and the type of code being generated.  The
8995 impact on systems that support long absolute calls, and long pic
8996 symbol-difference or pc-relative calls should be relatively small.
8997 However, an indirect call is used on 32-bit ELF systems in pic code
8998 and it is quite long.
9000 @item -munix=@var{unix-std}
9001 @opindex march
9002 Generate compiler predefines and select a startfile for the specified
9003 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
9004 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
9005 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
9006 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
9007 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9008 and later.
9010 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9011 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9012 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9013 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9014 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9015 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9017 It is @emph{important} to note that this option changes the interfaces
9018 for various library routines.  It also affects the operational behavior
9019 of the C library.  Thus, @emph{extreme} care is needed in using this
9020 option.
9022 Library code that is intended to operate with more than one UNIX
9023 standard must test, set and restore the variable @var{__xpg4_extended_mask}
9024 as appropriate.  Most GNU software doesn't provide this capability.
9026 @item -nolibdld
9027 @opindex nolibdld
9028 Suppress the generation of link options to search libdld.sl when the
9029 @option{-static} option is specified on HP-UX 10 and later.
9031 @item -static
9032 @opindex static
9033 The HP-UX implementation of setlocale in libc has a dependency on
9034 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
9035 when the @option{-static} option is specified, special link options
9036 are needed to resolve this dependency.
9038 On HP-UX 10 and later, the GCC driver adds the necessary options to
9039 link with libdld.sl when the @option{-static} option is specified.
9040 This causes the resulting binary to be dynamic.  On the 64-bit port,
9041 the linkers generate dynamic binaries by default in any case.  The
9042 @option{-nolibdld} option can be used to prevent the GCC driver from
9043 adding these link options.
9045 @item -threads
9046 @opindex threads
9047 Add support for multithreading with the @dfn{dce thread} library
9048 under HP-UX@.  This option sets flags for both the preprocessor and
9049 linker.
9050 @end table
9052 @node i386 and x86-64 Options
9053 @subsection Intel 386 and AMD x86-64 Options
9054 @cindex i386 Options
9055 @cindex x86-64 Options
9056 @cindex Intel 386 Options
9057 @cindex AMD x86-64 Options
9059 These @samp{-m} options are defined for the i386 and x86-64 family of
9060 computers:
9062 @table @gcctabopt
9063 @item -mtune=@var{cpu-type}
9064 @opindex mtune
9065 Tune to @var{cpu-type} everything applicable about the generated code, except
9066 for the ABI and the set of available instructions.  The choices for
9067 @var{cpu-type} are:
9068 @table @emph
9069 @item i386
9070 Original Intel's i386 CPU@.
9071 @item i486
9072 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
9073 @item i586, pentium
9074 Intel Pentium CPU with no MMX support.
9075 @item pentium-mmx
9076 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9077 @item i686, pentiumpro
9078 Intel PentiumPro CPU@.
9079 @item pentium2
9080 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9081 @item pentium3, pentium3m
9082 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9083 support.
9084 @item pentium-m
9085 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9086 support.  Used by Centrino notebooks.
9087 @item pentium4, pentium4m
9088 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9089 @item prescott
9090 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9091 set support.
9092 @item nocona
9093 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9094 SSE2 and SSE3 instruction set support.
9095 @item k6
9096 AMD K6 CPU with MMX instruction set support.
9097 @item k6-2, k6-3
9098 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9099 @item athlon, athlon-tbird
9100 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9101 support.
9102 @item athlon-4, athlon-xp, athlon-mp
9103 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9104 instruction set support.
9105 @item k8, opteron, athlon64, athlon-fx
9106 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9107 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9108 @item winchip-c6
9109 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9110 set support.
9111 @item winchip2
9112 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9113 instruction set support.
9114 @item c3
9115 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9116 implemented for this chip.)
9117 @item c3-2
9118 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9119 implemented for this chip.)
9120 @end table
9122 While picking a specific @var{cpu-type} will schedule things appropriately
9123 for that particular chip, the compiler will not generate any code that
9124 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9125 being used.
9127 @item -march=@var{cpu-type}
9128 @opindex march
9129 Generate instructions for the machine type @var{cpu-type}.  The choices
9130 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9131 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9133 @item -mcpu=@var{cpu-type}
9134 @opindex mcpu
9135 A deprecated synonym for @option{-mtune}.
9137 @item -m386
9138 @itemx -m486
9139 @itemx -mpentium
9140 @itemx -mpentiumpro
9141 @opindex m386
9142 @opindex m486
9143 @opindex mpentium
9144 @opindex mpentiumpro
9145 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9146 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9147 These synonyms are deprecated.
9149 @item -mfpmath=@var{unit}
9150 @opindex march
9151 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9152 for @var{unit} are:
9154 @table @samp
9155 @item 387
9156 Use the standard 387 floating point coprocessor present majority of chips and
9157 emulated otherwise.  Code compiled with this option will run almost everywhere.
9158 The temporary results are computed in 80bit precision instead of precision
9159 specified by the type resulting in slightly different results compared to most
9160 of other chips.  See @option{-ffloat-store} for more detailed description.
9162 This is the default choice for i386 compiler.
9164 @item sse
9165 Use scalar floating point instructions present in the SSE instruction set.
9166 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9167 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9168 instruction set supports only single precision arithmetics, thus the double and
9169 extended precision arithmetics is still done using 387.  Later version, present
9170 only in Pentium4 and the future AMD x86-64 chips supports double precision
9171 arithmetics too.
9173 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9174 or @option{-msse2} switches to enable SSE extensions and make this option
9175 effective.  For the x86-64 compiler, these extensions are enabled by default.
9177 The resulting code should be considerably faster in the majority of cases and avoid
9178 the numerical instability problems of 387 code, but may break some existing
9179 code that expects temporaries to be 80bit.
9181 This is the default choice for the x86-64 compiler.
9183 @item sse,387
9184 Attempt to utilize both instruction sets at once.  This effectively double the
9185 amount of available registers and on chips with separate execution units for
9186 387 and SSE the execution resources too.  Use this option with care, as it is
9187 still experimental, because the GCC register allocator does not model separate
9188 functional units well resulting in instable performance.
9189 @end table
9191 @item -masm=@var{dialect}
9192 @opindex masm=@var{dialect}
9193 Output asm instructions using selected @var{dialect}.  Supported
9194 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9195 not support @samp{intel}.
9197 @item -mieee-fp
9198 @itemx -mno-ieee-fp
9199 @opindex mieee-fp
9200 @opindex mno-ieee-fp
9201 Control whether or not the compiler uses IEEE floating point
9202 comparisons.  These handle correctly the case where the result of a
9203 comparison is unordered.
9205 @item -msoft-float
9206 @opindex msoft-float
9207 Generate output containing library calls for floating point.
9208 @strong{Warning:} the requisite libraries are not part of GCC@.
9209 Normally the facilities of the machine's usual C compiler are used, but
9210 this can't be done directly in cross-compilation.  You must make your
9211 own arrangements to provide suitable library functions for
9212 cross-compilation.
9214 On machines where a function returns floating point results in the 80387
9215 register stack, some floating point opcodes may be emitted even if
9216 @option{-msoft-float} is used.
9218 @item -mno-fp-ret-in-387
9219 @opindex mno-fp-ret-in-387
9220 Do not use the FPU registers for return values of functions.
9222 The usual calling convention has functions return values of types
9223 @code{float} and @code{double} in an FPU register, even if there
9224 is no FPU@.  The idea is that the operating system should emulate
9225 an FPU@.
9227 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9228 in ordinary CPU registers instead.
9230 @item -mno-fancy-math-387
9231 @opindex mno-fancy-math-387
9232 Some 387 emulators do not support the @code{sin}, @code{cos} and
9233 @code{sqrt} instructions for the 387.  Specify this option to avoid
9234 generating those instructions.  This option is the default on FreeBSD,
9235 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9236 indicates that the target cpu will always have an FPU and so the
9237 instruction will not need emulation.  As of revision 2.6.1, these
9238 instructions are not generated unless you also use the
9239 @option{-funsafe-math-optimizations} switch.
9241 @item -malign-double
9242 @itemx -mno-align-double
9243 @opindex malign-double
9244 @opindex mno-align-double
9245 Control whether GCC aligns @code{double}, @code{long double}, and
9246 @code{long long} variables on a two word boundary or a one word
9247 boundary.  Aligning @code{double} variables on a two word boundary will
9248 produce code that runs somewhat faster on a @samp{Pentium} at the
9249 expense of more memory.
9251 On x86-64, @option{-malign-double} is enabled by default.
9253 @strong{Warning:} if you use the @option{-malign-double} switch,
9254 structures containing the above types will be aligned differently than
9255 the published application binary interface specifications for the 386
9256 and will not be binary compatible with structures in code compiled
9257 without that switch.
9259 @item -m96bit-long-double
9260 @itemx -m128bit-long-double
9261 @opindex m96bit-long-double
9262 @opindex m128bit-long-double
9263 These switches control the size of @code{long double} type.  The i386
9264 application binary interface specifies the size to be 96 bits,
9265 so @option{-m96bit-long-double} is the default in 32 bit mode.
9267 Modern architectures (Pentium and newer) would prefer @code{long double}
9268 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9269 conforming to the ABI, this would not be possible.  So specifying a
9270 @option{-m128bit-long-double} will align @code{long double}
9271 to a 16 byte boundary by padding the @code{long double} with an additional
9272 32 bit zero.
9274 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9275 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9277 Notice that neither of these options enable any extra precision over the x87
9278 standard of 80 bits for a @code{long double}.
9280 @strong{Warning:} if you override the default value for your target ABI, the
9281 structures and arrays containing @code{long double} variables will change
9282 their size as well as function calling convention for function taking
9283 @code{long double} will be modified.  Hence they will not be binary
9284 compatible with arrays or structures in code compiled without that switch.
9286 @item -mmlarge-data-threshold=@var{number}
9287 @opindex mlarge-data-threshold=@var{number}
9288 When @option{-mcmodel=medium} is specified, the data greater than
9289 @var{threshold} are placed in large data section.  This value must be the
9290 same across all object linked into the binary and defaults to 65535.
9292 @item -msvr3-shlib
9293 @itemx -mno-svr3-shlib
9294 @opindex msvr3-shlib
9295 @opindex mno-svr3-shlib
9296 Control whether GCC places uninitialized local variables into the
9297 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9298 into @code{bss}.  These options are meaningful only on System V Release 3.
9300 @item -mrtd
9301 @opindex mrtd
9302 Use a different function-calling convention, in which functions that
9303 take a fixed number of arguments return with the @code{ret} @var{num}
9304 instruction, which pops their arguments while returning.  This saves one
9305 instruction in the caller since there is no need to pop the arguments
9306 there.
9308 You can specify that an individual function is called with this calling
9309 sequence with the function attribute @samp{stdcall}.  You can also
9310 override the @option{-mrtd} option by using the function attribute
9311 @samp{cdecl}.  @xref{Function Attributes}.
9313 @strong{Warning:} this calling convention is incompatible with the one
9314 normally used on Unix, so you cannot use it if you need to call
9315 libraries compiled with the Unix compiler.
9317 Also, you must provide function prototypes for all functions that
9318 take variable numbers of arguments (including @code{printf});
9319 otherwise incorrect code will be generated for calls to those
9320 functions.
9322 In addition, seriously incorrect code will result if you call a
9323 function with too many arguments.  (Normally, extra arguments are
9324 harmlessly ignored.)
9326 @item -mregparm=@var{num}
9327 @opindex mregparm
9328 Control how many registers are used to pass integer arguments.  By
9329 default, no registers are used to pass arguments, and at most 3
9330 registers can be used.  You can control this behavior for a specific
9331 function by using the function attribute @samp{regparm}.
9332 @xref{Function Attributes}.
9334 @strong{Warning:} if you use this switch, and
9335 @var{num} is nonzero, then you must build all modules with the same
9336 value, including any libraries.  This includes the system libraries and
9337 startup modules.
9339 @item -msseregparm
9340 @opindex msseregparm
9341 Use SSE register passing conventions for float and double arguments
9342 and return values.  You can control this behavior for a specific
9343 function by using the function attribute @samp{sseregparm}.
9344 @xref{Function Attributes}.
9346 @strong{Warning:} if you use this switch then you must build all
9347 modules with the same value, including any libraries.  This includes
9348 the system libraries and startup modules.
9350 @item -mpreferred-stack-boundary=@var{num}
9351 @opindex mpreferred-stack-boundary
9352 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9353 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9354 the default is 4 (16 bytes or 128 bits).
9356 On Pentium and PentiumPro, @code{double} and @code{long double} values
9357 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9358 suffer significant run time performance penalties.  On Pentium III, the
9359 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
9360 properly if it is not 16 byte aligned.
9362 To ensure proper alignment of this values on the stack, the stack boundary
9363 must be as aligned as that required by any value stored on the stack.
9364 Further, every function must be generated such that it keeps the stack
9365 aligned.  Thus calling a function compiled with a higher preferred
9366 stack boundary from a function compiled with a lower preferred stack
9367 boundary will most likely misalign the stack.  It is recommended that
9368 libraries that use callbacks always use the default setting.
9370 This extra alignment does consume extra stack space, and generally
9371 increases code size.  Code that is sensitive to stack space usage, such
9372 as embedded systems and operating system kernels, may want to reduce the
9373 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9375 @item -mmmx
9376 @itemx -mno-mmx
9377 @item -msse
9378 @itemx -mno-sse
9379 @item -msse2
9380 @itemx -mno-sse2
9381 @item -msse3
9382 @itemx -mno-sse3
9383 @item -m3dnow
9384 @itemx -mno-3dnow
9385 @opindex mmmx
9386 @opindex mno-mmx
9387 @opindex msse
9388 @opindex mno-sse
9389 @opindex m3dnow
9390 @opindex mno-3dnow
9391 These switches enable or disable the use of instructions in the MMX,
9392 SSE, SSE2 or 3DNow! extended instruction sets.  These extensions are
9393 also available as built-in functions: see @ref{X86 Built-in Functions},
9394 for details of the functions enabled and disabled by these switches.
9396 To have SSE/SSE2 instructions generated automatically from floating-point
9397 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9399 These options will enable GCC to use these extended instructions in
9400 generated code, even without @option{-mfpmath=sse}.  Applications which
9401 perform runtime CPU detection must compile separate files for each
9402 supported architecture, using the appropriate flags.  In particular,
9403 the file containing the CPU detection code should be compiled without
9404 these options.
9406 @item -mpush-args
9407 @itemx -mno-push-args
9408 @opindex mpush-args
9409 @opindex mno-push-args
9410 Use PUSH operations to store outgoing parameters.  This method is shorter
9411 and usually equally fast as method using SUB/MOV operations and is enabled
9412 by default.  In some cases disabling it may improve performance because of
9413 improved scheduling and reduced dependencies.
9415 @item -maccumulate-outgoing-args
9416 @opindex maccumulate-outgoing-args
9417 If enabled, the maximum amount of space required for outgoing arguments will be
9418 computed in the function prologue.  This is faster on most modern CPUs
9419 because of reduced dependencies, improved scheduling and reduced stack usage
9420 when preferred stack boundary is not equal to 2.  The drawback is a notable
9421 increase in code size.  This switch implies @option{-mno-push-args}.
9423 @item -mthreads
9424 @opindex mthreads
9425 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9426 on thread-safe exception handling must compile and link all code with the
9427 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9428 @option{-D_MT}; when linking, it links in a special thread helper library
9429 @option{-lmingwthrd} which cleans up per thread exception handling data.
9431 @item -mno-align-stringops
9432 @opindex mno-align-stringops
9433 Do not align destination of inlined string operations.  This switch reduces
9434 code size and improves performance in case the destination is already aligned,
9435 but GCC doesn't know about it.
9437 @item -minline-all-stringops
9438 @opindex minline-all-stringops
9439 By default GCC inlines string operations only when destination is known to be
9440 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9441 size, but may improve performance of code that depends on fast memcpy, strlen
9442 and memset for short lengths.
9444 @item -momit-leaf-frame-pointer
9445 @opindex momit-leaf-frame-pointer
9446 Don't keep the frame pointer in a register for leaf functions.  This
9447 avoids the instructions to save, set up and restore frame pointers and
9448 makes an extra register available in leaf functions.  The option
9449 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9450 which might make debugging harder.
9452 @item -mtls-direct-seg-refs
9453 @itemx -mno-tls-direct-seg-refs
9454 @opindex mtls-direct-seg-refs
9455 Controls whether TLS variables may be accessed with offsets from the
9456 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9457 or whether the thread base pointer must be added.  Whether or not this
9458 is legal depends on the operating system, and whether it maps the
9459 segment to cover the entire TLS area.
9461 For systems that use GNU libc, the default is on.
9462 @end table
9464 These @samp{-m} switches are supported in addition to the above
9465 on AMD x86-64 processors in 64-bit environments.
9467 @table @gcctabopt
9468 @item -m32
9469 @itemx -m64
9470 @opindex m32
9471 @opindex m64
9472 Generate code for a 32-bit or 64-bit environment.
9473 The 32-bit environment sets int, long and pointer to 32 bits and
9474 generates code that runs on any i386 system.
9475 The 64-bit environment sets int to 32 bits and long and pointer
9476 to 64 bits and generates code for AMD's x86-64 architecture.
9478 @item -mno-red-zone
9479 @opindex no-red-zone
9480 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9481 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9482 stack pointer that will not be modified by signal or interrupt handlers
9483 and therefore can be used for temporary data without adjusting the stack
9484 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9486 @item -mcmodel=small
9487 @opindex mcmodel=small
9488 Generate code for the small code model: the program and its symbols must
9489 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9490 Programs can be statically or dynamically linked.  This is the default
9491 code model.
9493 @item -mcmodel=kernel
9494 @opindex mcmodel=kernel
9495 Generate code for the kernel code model.  The kernel runs in the
9496 negative 2 GB of the address space.
9497 This model has to be used for Linux kernel code.
9499 @item -mcmodel=medium
9500 @opindex mcmodel=medium
9501 Generate code for the medium model: The program is linked in the lower 2
9502 GB of the address space but symbols can be located anywhere in the
9503 address space.  Programs can be statically or dynamically linked, but
9504 building of shared libraries are not supported with the medium model.
9506 @item -mcmodel=large
9507 @opindex mcmodel=large
9508 Generate code for the large model: This model makes no assumptions
9509 about addresses and sizes of sections.  Currently GCC does not implement
9510 this model.
9511 @end table
9513 @node IA-64 Options
9514 @subsection IA-64 Options
9515 @cindex IA-64 Options
9517 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9519 @table @gcctabopt
9520 @item -mbig-endian
9521 @opindex mbig-endian
9522 Generate code for a big endian target.  This is the default for HP-UX@.
9524 @item -mlittle-endian
9525 @opindex mlittle-endian
9526 Generate code for a little endian target.  This is the default for AIX5
9527 and GNU/Linux.
9529 @item -mgnu-as
9530 @itemx -mno-gnu-as
9531 @opindex mgnu-as
9532 @opindex mno-gnu-as
9533 Generate (or don't) code for the GNU assembler.  This is the default.
9534 @c Also, this is the default if the configure option @option{--with-gnu-as}
9535 @c is used.
9537 @item -mgnu-ld
9538 @itemx -mno-gnu-ld
9539 @opindex mgnu-ld
9540 @opindex mno-gnu-ld
9541 Generate (or don't) code for the GNU linker.  This is the default.
9542 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9543 @c is used.
9545 @item -mno-pic
9546 @opindex mno-pic
9547 Generate code that does not use a global pointer register.  The result
9548 is not position independent code, and violates the IA-64 ABI@.
9550 @item -mvolatile-asm-stop
9551 @itemx -mno-volatile-asm-stop
9552 @opindex mvolatile-asm-stop
9553 @opindex mno-volatile-asm-stop
9554 Generate (or don't) a stop bit immediately before and after volatile asm
9555 statements.
9557 @item -mregister-names
9558 @itemx -mno-register-names
9559 @opindex mregister-names
9560 @opindex mno-register-names
9561 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9562 the stacked registers.  This may make assembler output more readable.
9564 @item -mno-sdata
9565 @itemx -msdata
9566 @opindex mno-sdata
9567 @opindex msdata
9568 Disable (or enable) optimizations that use the small data section.  This may
9569 be useful for working around optimizer bugs.
9571 @item -mconstant-gp
9572 @opindex mconstant-gp
9573 Generate code that uses a single constant global pointer value.  This is
9574 useful when compiling kernel code.
9576 @item -mauto-pic
9577 @opindex mauto-pic
9578 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9579 This is useful when compiling firmware code.
9581 @item -minline-float-divide-min-latency
9582 @opindex minline-float-divide-min-latency
9583 Generate code for inline divides of floating point values
9584 using the minimum latency algorithm.
9586 @item -minline-float-divide-max-throughput
9587 @opindex minline-float-divide-max-throughput
9588 Generate code for inline divides of floating point values
9589 using the maximum throughput algorithm.
9591 @item -minline-int-divide-min-latency
9592 @opindex minline-int-divide-min-latency
9593 Generate code for inline divides of integer values
9594 using the minimum latency algorithm.
9596 @item -minline-int-divide-max-throughput
9597 @opindex minline-int-divide-max-throughput
9598 Generate code for inline divides of integer values
9599 using the maximum throughput algorithm.
9601 @item -minline-sqrt-min-latency
9602 @opindex minline-sqrt-min-latency
9603 Generate code for inline square roots
9604 using the minimum latency algorithm.
9606 @item -minline-sqrt-max-throughput
9607 @opindex minline-sqrt-max-throughput
9608 Generate code for inline square roots
9609 using the maximum throughput algorithm.
9611 @item -mno-dwarf2-asm
9612 @itemx -mdwarf2-asm
9613 @opindex mno-dwarf2-asm
9614 @opindex mdwarf2-asm
9615 Don't (or do) generate assembler code for the DWARF2 line number debugging
9616 info.  This may be useful when not using the GNU assembler.
9618 @item -mearly-stop-bits
9619 @itemx -mno-early-stop-bits
9620 @opindex mearly-stop-bits
9621 @opindex mno-early-stop-bits
9622 Allow stop bits to be placed earlier than immediately preceding the
9623 instruction that triggered the stop bit.  This can improve instruction
9624 scheduling, but does not always do so.
9626 @item -mfixed-range=@var{register-range}
9627 @opindex mfixed-range
9628 Generate code treating the given register range as fixed registers.
9629 A fixed register is one that the register allocator can not use.  This is
9630 useful when compiling kernel code.  A register range is specified as
9631 two registers separated by a dash.  Multiple register ranges can be
9632 specified separated by a comma.
9634 @item -mtls-size=@var{tls-size}
9635 @opindex mtls-size
9636 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9639 @item -mtune=@var{cpu-type}
9640 @opindex mtune
9641 Tune the instruction scheduling for a particular CPU, Valid values are
9642 itanium, itanium1, merced, itanium2, and mckinley.
9644 @item -mt
9645 @itemx -pthread
9646 @opindex mt
9647 @opindex pthread
9648 Add support for multithreading using the POSIX threads library.  This
9649 option sets flags for both the preprocessor and linker.  It does
9650 not affect the thread safety of object code produced by the compiler or
9651 that of libraries supplied with it.  These are HP-UX specific flags.
9653 @item -milp32
9654 @itemx -mlp64
9655 @opindex milp32
9656 @opindex mlp64
9657 Generate code for a 32-bit or 64-bit environment.
9658 The 32-bit environment sets int, long and pointer to 32 bits.
9659 The 64-bit environment sets int to 32 bits and long and pointer
9660 to 64 bits.  These are HP-UX specific flags.
9662 @end table
9664 @node M32C Options
9665 @subsection M32C Options
9666 @cindex M32C options
9668 @table @gcctabopt
9669 @item -mcpu=@var{name}
9670 @opindex mcpu=
9671 Select the CPU for which code is generated.  @var{name} may be one of
9672 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9673 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9674 the M32C/80 series.
9676 @item -msim
9677 @opindex msim
9678 Specifies that the program will be run on the simulator.  This causes
9679 an alternate runtime library to be linked in which supports, for
9680 example, file I/O.  You must not use this option when generating
9681 programs that will run on real hardware; you must provide your own
9682 runtime library for whatever I/O functions are needed.
9684 @item -memregs=@var{number}
9685 @opindex memregs=
9686 Specifies the number of memory-based pseudo-registers GCC will use
9687 during code generation.  These pseudo-registers will be used like real
9688 registers, so there is a tradeoff between GCC's ability to fit the
9689 code into available registers, and the performance penalty of using
9690 memory instead of registers.  Note that all modules in a program must
9691 be compiled with the same value for this option.  Because of that, you
9692 must not use this option with the default runtime libraries gcc
9693 builds.
9695 @end table
9697 @node M32R/D Options
9698 @subsection M32R/D Options
9699 @cindex M32R/D options
9701 These @option{-m} options are defined for Renesas M32R/D architectures:
9703 @table @gcctabopt
9704 @item -m32r2
9705 @opindex m32r2
9706 Generate code for the M32R/2@.
9708 @item -m32rx
9709 @opindex m32rx
9710 Generate code for the M32R/X@.
9712 @item -m32r
9713 @opindex m32r
9714 Generate code for the M32R@.  This is the default.
9716 @item -mmodel=small
9717 @opindex mmodel=small
9718 Assume all objects live in the lower 16MB of memory (so that their addresses
9719 can be loaded with the @code{ld24} instruction), and assume all subroutines
9720 are reachable with the @code{bl} instruction.
9721 This is the default.
9723 The addressability of a particular object can be set with the
9724 @code{model} attribute.
9726 @item -mmodel=medium
9727 @opindex mmodel=medium
9728 Assume objects may be anywhere in the 32-bit address space (the compiler
9729 will generate @code{seth/add3} instructions to load their addresses), and
9730 assume all subroutines are reachable with the @code{bl} instruction.
9732 @item -mmodel=large
9733 @opindex mmodel=large
9734 Assume objects may be anywhere in the 32-bit address space (the compiler
9735 will generate @code{seth/add3} instructions to load their addresses), and
9736 assume subroutines may not be reachable with the @code{bl} instruction
9737 (the compiler will generate the much slower @code{seth/add3/jl}
9738 instruction sequence).
9740 @item -msdata=none
9741 @opindex msdata=none
9742 Disable use of the small data area.  Variables will be put into
9743 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9744 @code{section} attribute has been specified).
9745 This is the default.
9747 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9748 Objects may be explicitly put in the small data area with the
9749 @code{section} attribute using one of these sections.
9751 @item -msdata=sdata
9752 @opindex msdata=sdata
9753 Put small global and static data in the small data area, but do not
9754 generate special code to reference them.
9756 @item -msdata=use
9757 @opindex msdata=use
9758 Put small global and static data in the small data area, and generate
9759 special instructions to reference them.
9761 @item -G @var{num}
9762 @opindex G
9763 @cindex smaller data references
9764 Put global and static objects less than or equal to @var{num} bytes
9765 into the small data or bss sections instead of the normal data or bss
9766 sections.  The default value of @var{num} is 8.
9767 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9768 for this option to have any effect.
9770 All modules should be compiled with the same @option{-G @var{num}} value.
9771 Compiling with different values of @var{num} may or may not work; if it
9772 doesn't the linker will give an error message---incorrect code will not be
9773 generated.
9775 @item -mdebug
9776 @opindex mdebug
9777 Makes the M32R specific code in the compiler display some statistics
9778 that might help in debugging programs.
9780 @item -malign-loops
9781 @opindex malign-loops
9782 Align all loops to a 32-byte boundary.
9784 @item -mno-align-loops
9785 @opindex mno-align-loops
9786 Do not enforce a 32-byte alignment for loops.  This is the default.
9788 @item -missue-rate=@var{number}
9789 @opindex missue-rate=@var{number}
9790 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9791 or 2.
9793 @item -mbranch-cost=@var{number}
9794 @opindex mbranch-cost=@var{number}
9795 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9796 preferred over conditional code, if it is 2, then the opposite will
9797 apply.
9799 @item -mflush-trap=@var{number}
9800 @opindex mflush-trap=@var{number}
9801 Specifies the trap number to use to flush the cache.  The default is
9802 12.  Valid numbers are between 0 and 15 inclusive.
9804 @item -mno-flush-trap
9805 @opindex mno-flush-trap
9806 Specifies that the cache cannot be flushed by using a trap.
9808 @item -mflush-func=@var{name}
9809 @opindex mflush-func=@var{name}
9810 Specifies the name of the operating system function to call to flush
9811 the cache.  The default is @emph{_flush_cache}, but a function call
9812 will only be used if a trap is not available.
9814 @item -mno-flush-func
9815 @opindex mno-flush-func
9816 Indicates that there is no OS function for flushing the cache.
9818 @end table
9820 @node M680x0 Options
9821 @subsection M680x0 Options
9822 @cindex M680x0 options
9824 These are the @samp{-m} options defined for the 68000 series.  The default
9825 values for these options depends on which style of 68000 was selected when
9826 the compiler was configured; the defaults for the most common choices are
9827 given below.
9829 @table @gcctabopt
9830 @item -m68000
9831 @itemx -mc68000
9832 @opindex m68000
9833 @opindex mc68000
9834 Generate output for a 68000.  This is the default
9835 when the compiler is configured for 68000-based systems.
9837 Use this option for microcontrollers with a 68000 or EC000 core,
9838 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9840 @item -m68020
9841 @itemx -mc68020
9842 @opindex m68020
9843 @opindex mc68020
9844 Generate output for a 68020.  This is the default
9845 when the compiler is configured for 68020-based systems.
9847 @item -m68881
9848 @opindex m68881
9849 Generate output containing 68881 instructions for floating point.
9850 This is the default for most 68020 systems unless @option{--nfp} was
9851 specified when the compiler was configured.
9853 @item -m68030
9854 @opindex m68030
9855 Generate output for a 68030.  This is the default when the compiler is
9856 configured for 68030-based systems.
9858 @item -m68040
9859 @opindex m68040
9860 Generate output for a 68040.  This is the default when the compiler is
9861 configured for 68040-based systems.
9863 This option inhibits the use of 68881/68882 instructions that have to be
9864 emulated by software on the 68040.  Use this option if your 68040 does not
9865 have code to emulate those instructions.
9867 @item -m68060
9868 @opindex m68060
9869 Generate output for a 68060.  This is the default when the compiler is
9870 configured for 68060-based systems.
9872 This option inhibits the use of 68020 and 68881/68882 instructions that
9873 have to be emulated by software on the 68060.  Use this option if your 68060
9874 does not have code to emulate those instructions.
9876 @item -mcpu32
9877 @opindex mcpu32
9878 Generate output for a CPU32.  This is the default
9879 when the compiler is configured for CPU32-based systems.
9881 Use this option for microcontrollers with a
9882 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9883 68336, 68340, 68341, 68349 and 68360.
9885 @item -m5200
9886 @opindex m5200
9887 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9888 when the compiler is configured for 520X-based systems.
9890 Use this option for microcontroller with a 5200 core, including
9891 the MCF5202, MCF5203, MCF5204 and MCF5202.
9894 @item -m68020-40
9895 @opindex m68020-40
9896 Generate output for a 68040, without using any of the new instructions.
9897 This results in code which can run relatively efficiently on either a
9898 68020/68881 or a 68030 or a 68040.  The generated code does use the
9899 68881 instructions that are emulated on the 68040.
9901 @item -m68020-60
9902 @opindex m68020-60
9903 Generate output for a 68060, without using any of the new instructions.
9904 This results in code which can run relatively efficiently on either a
9905 68020/68881 or a 68030 or a 68040.  The generated code does use the
9906 68881 instructions that are emulated on the 68060.
9908 @item -msoft-float
9909 @opindex msoft-float
9910 Generate output containing library calls for floating point.
9911 @strong{Warning:} the requisite libraries are not available for all m68k
9912 targets.  Normally the facilities of the machine's usual C compiler are
9913 used, but this can't be done directly in cross-compilation.  You must
9914 make your own arrangements to provide suitable library functions for
9915 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9916 @samp{m68k-*-coff} do provide software floating point support.
9918 @item -mshort
9919 @opindex mshort
9920 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9921 Additionally, parameters passed on the stack are also aligned to a
9922 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9924 @item -mnobitfield
9925 @opindex mnobitfield
9926 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9927 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9929 @item -mbitfield
9930 @opindex mbitfield
9931 Do use the bit-field instructions.  The @option{-m68020} option implies
9932 @option{-mbitfield}.  This is the default if you use a configuration
9933 designed for a 68020.
9935 @item -mrtd
9936 @opindex mrtd
9937 Use a different function-calling convention, in which functions
9938 that take a fixed number of arguments return with the @code{rtd}
9939 instruction, which pops their arguments while returning.  This
9940 saves one instruction in the caller since there is no need to pop
9941 the arguments there.
9943 This calling convention is incompatible with the one normally
9944 used on Unix, so you cannot use it if you need to call libraries
9945 compiled with the Unix compiler.
9947 Also, you must provide function prototypes for all functions that
9948 take variable numbers of arguments (including @code{printf});
9949 otherwise incorrect code will be generated for calls to those
9950 functions.
9952 In addition, seriously incorrect code will result if you call a
9953 function with too many arguments.  (Normally, extra arguments are
9954 harmlessly ignored.)
9956 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9957 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9959 @item -malign-int
9960 @itemx -mno-align-int
9961 @opindex malign-int
9962 @opindex mno-align-int
9963 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9964 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9965 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9966 Aligning variables on 32-bit boundaries produces code that runs somewhat
9967 faster on processors with 32-bit busses at the expense of more memory.
9969 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9970 align structures containing the above types  differently than
9971 most published application binary interface specifications for the m68k.
9973 @item -mpcrel
9974 @opindex mpcrel
9975 Use the pc-relative addressing mode of the 68000 directly, instead of
9976 using a global offset table.  At present, this option implies @option{-fpic},
9977 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9978 not presently supported with @option{-mpcrel}, though this could be supported for
9979 68020 and higher processors.
9981 @item -mno-strict-align
9982 @itemx -mstrict-align
9983 @opindex mno-strict-align
9984 @opindex mstrict-align
9985 Do not (do) assume that unaligned memory references will be handled by
9986 the system.
9988 @item -msep-data
9989 Generate code that allows the data segment to be located in a different
9990 area of memory from the text segment.  This allows for execute in place in
9991 an environment without virtual memory management.  This option implies
9992 @option{-fPIC}.
9994 @item -mno-sep-data
9995 Generate code that assumes that the data segment follows the text segment.
9996 This is the default.
9998 @item -mid-shared-library
9999 Generate code that supports shared libraries via the library ID method.
10000 This allows for execute in place and shared libraries in an environment
10001 without virtual memory management.  This option implies @option{-fPIC}.
10003 @item -mno-id-shared-library
10004 Generate code that doesn't assume ID based shared libraries are being used.
10005 This is the default.
10007 @item -mshared-library-id=n
10008 Specified the identification number of the ID based shared library being
10009 compiled.  Specifying a value of 0 will generate more compact code, specifying
10010 other values will force the allocation of that number to the current
10011 library but is no more space or time efficient than omitting this option.
10013 @end table
10015 @node M68hc1x Options
10016 @subsection M68hc1x Options
10017 @cindex M68hc1x options
10019 These are the @samp{-m} options defined for the 68hc11 and 68hc12
10020 microcontrollers.  The default values for these options depends on
10021 which style of microcontroller was selected when the compiler was configured;
10022 the defaults for the most common choices are given below.
10024 @table @gcctabopt
10025 @item -m6811
10026 @itemx -m68hc11
10027 @opindex m6811
10028 @opindex m68hc11
10029 Generate output for a 68HC11.  This is the default
10030 when the compiler is configured for 68HC11-based systems.
10032 @item -m6812
10033 @itemx -m68hc12
10034 @opindex m6812
10035 @opindex m68hc12
10036 Generate output for a 68HC12.  This is the default
10037 when the compiler is configured for 68HC12-based systems.
10039 @item -m68S12
10040 @itemx -m68hcs12
10041 @opindex m68S12
10042 @opindex m68hcs12
10043 Generate output for a 68HCS12.
10045 @item -mauto-incdec
10046 @opindex mauto-incdec
10047 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10048 addressing modes.
10050 @item -minmax
10051 @itemx -nominmax
10052 @opindex minmax
10053 @opindex mnominmax
10054 Enable the use of 68HC12 min and max instructions.
10056 @item -mlong-calls
10057 @itemx -mno-long-calls
10058 @opindex mlong-calls
10059 @opindex mno-long-calls
10060 Treat all calls as being far away (near).  If calls are assumed to be
10061 far away, the compiler will use the @code{call} instruction to
10062 call a function and the @code{rtc} instruction for returning.
10064 @item -mshort
10065 @opindex mshort
10066 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10068 @item -msoft-reg-count=@var{count}
10069 @opindex msoft-reg-count
10070 Specify the number of pseudo-soft registers which are used for the
10071 code generation.  The maximum number is 32.  Using more pseudo-soft
10072 register may or may not result in better code depending on the program.
10073 The default is 4 for 68HC11 and 2 for 68HC12.
10075 @end table
10077 @node MCore Options
10078 @subsection MCore Options
10079 @cindex MCore options
10081 These are the @samp{-m} options defined for the Motorola M*Core
10082 processors.
10084 @table @gcctabopt
10086 @item -mhardlit
10087 @itemx -mno-hardlit
10088 @opindex mhardlit
10089 @opindex mno-hardlit
10090 Inline constants into the code stream if it can be done in two
10091 instructions or less.
10093 @item -mdiv
10094 @itemx -mno-div
10095 @opindex mdiv
10096 @opindex mno-div
10097 Use the divide instruction.  (Enabled by default).
10099 @item -mrelax-immediate
10100 @itemx -mno-relax-immediate
10101 @opindex mrelax-immediate
10102 @opindex mno-relax-immediate
10103 Allow arbitrary sized immediates in bit operations.
10105 @item -mwide-bitfields
10106 @itemx -mno-wide-bitfields
10107 @opindex mwide-bitfields
10108 @opindex mno-wide-bitfields
10109 Always treat bit-fields as int-sized.
10111 @item -m4byte-functions
10112 @itemx -mno-4byte-functions
10113 @opindex m4byte-functions
10114 @opindex mno-4byte-functions
10115 Force all functions to be aligned to a four byte boundary.
10117 @item -mcallgraph-data
10118 @itemx -mno-callgraph-data
10119 @opindex mcallgraph-data
10120 @opindex mno-callgraph-data
10121 Emit callgraph information.
10123 @item -mslow-bytes
10124 @itemx -mno-slow-bytes
10125 @opindex mslow-bytes
10126 @opindex mno-slow-bytes
10127 Prefer word access when reading byte quantities.
10129 @item -mlittle-endian
10130 @itemx -mbig-endian
10131 @opindex mlittle-endian
10132 @opindex mbig-endian
10133 Generate code for a little endian target.
10135 @item -m210
10136 @itemx -m340
10137 @opindex m210
10138 @opindex m340
10139 Generate code for the 210 processor.
10140 @end table
10142 @node MIPS Options
10143 @subsection MIPS Options
10144 @cindex MIPS options
10146 @table @gcctabopt
10148 @item -EB
10149 @opindex EB
10150 Generate big-endian code.
10152 @item -EL
10153 @opindex EL
10154 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10155 configurations.
10157 @item -march=@var{arch}
10158 @opindex march
10159 Generate code that will run on @var{arch}, which can be the name of a
10160 generic MIPS ISA, or the name of a particular processor.
10161 The ISA names are:
10162 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10163 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10164 The processor names are:
10165 @samp{4kc}, @samp{4km}, @samp{4kp},
10166 @samp{5kc}, @samp{5kf},
10167 @samp{20kc},
10168 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10169 @samp{m4k},
10170 @samp{orion},
10171 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10172 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10173 @samp{rm7000}, @samp{rm9000},
10174 @samp{sb1},
10175 @samp{sr71000},
10176 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10177 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10178 The special value @samp{from-abi} selects the
10179 most compatible architecture for the selected ABI (that is,
10180 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10182 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10183 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10184 @samp{vr} may be written @samp{r}.
10186 GCC defines two macros based on the value of this option.  The first
10187 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10188 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10189 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10190 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10191 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10193 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10194 above.  In other words, it will have the full prefix and will not
10195 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10196 the macro names the resolved architecture (either @samp{"mips1"} or
10197 @samp{"mips3"}).  It names the default architecture when no
10198 @option{-march} option is given.
10200 @item -mtune=@var{arch}
10201 @opindex mtune
10202 Optimize for @var{arch}.  Among other things, this option controls
10203 the way instructions are scheduled, and the perceived cost of arithmetic
10204 operations.  The list of @var{arch} values is the same as for
10205 @option{-march}.
10207 When this option is not used, GCC will optimize for the processor
10208 specified by @option{-march}.  By using @option{-march} and
10209 @option{-mtune} together, it is possible to generate code that will
10210 run on a family of processors, but optimize the code for one
10211 particular member of that family.
10213 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10214 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10215 @samp{-march} ones described above.
10217 @item -mips1
10218 @opindex mips1
10219 Equivalent to @samp{-march=mips1}.
10221 @item -mips2
10222 @opindex mips2
10223 Equivalent to @samp{-march=mips2}.
10225 @item -mips3
10226 @opindex mips3
10227 Equivalent to @samp{-march=mips3}.
10229 @item -mips4
10230 @opindex mips4
10231 Equivalent to @samp{-march=mips4}.
10233 @item -mips32
10234 @opindex mips32
10235 Equivalent to @samp{-march=mips32}.
10237 @item -mips32r2
10238 @opindex mips32r2
10239 Equivalent to @samp{-march=mips32r2}.
10241 @item -mips64
10242 @opindex mips64
10243 Equivalent to @samp{-march=mips64}.
10245 @item -mips16
10246 @itemx -mno-mips16
10247 @opindex mips16
10248 @opindex mno-mips16
10249 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10250 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10252 @item -mabi=32
10253 @itemx -mabi=o64
10254 @itemx -mabi=n32
10255 @itemx -mabi=64
10256 @itemx -mabi=eabi
10257 @opindex mabi=32
10258 @opindex mabi=o64
10259 @opindex mabi=n32
10260 @opindex mabi=64
10261 @opindex mabi=eabi
10262 Generate code for the given ABI@.
10264 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10265 generates 64-bit code when you select a 64-bit architecture, but you
10266 can use @option{-mgp32} to get 32-bit code instead.
10268 For information about the O64 ABI, see
10269 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10271 @item -mabicalls
10272 @itemx -mno-abicalls
10273 @opindex mabicalls
10274 @opindex mno-abicalls
10275 Generate (do not generate) SVR4-style position-independent code.
10276 @option{-mabicalls} is the default for SVR4-based systems.
10278 @item -mxgot
10279 @itemx -mno-xgot
10280 @opindex mxgot
10281 @opindex mno-xgot
10282 Lift (do not lift) the usual restrictions on the size of the global
10283 offset table.
10285 GCC normally uses a single instruction to load values from the GOT@.
10286 While this is relatively efficient, it will only work if the GOT
10287 is smaller than about 64k.  Anything larger will cause the linker
10288 to report an error such as:
10290 @cindex relocation truncated to fit (MIPS)
10291 @smallexample
10292 relocation truncated to fit: R_MIPS_GOT16 foobar
10293 @end smallexample
10295 If this happens, you should recompile your code with @option{-mxgot}.
10296 It should then work with very large GOTs, although it will also be
10297 less efficient, since it will take three instructions to fetch the
10298 value of a global symbol.
10300 Note that some linkers can create multiple GOTs.  If you have such a
10301 linker, you should only need to use @option{-mxgot} when a single object
10302 file accesses more than 64k's worth of GOT entries.  Very few do.
10304 These options have no effect unless GCC is generating position
10305 independent code.
10307 @item -mgp32
10308 @opindex mgp32
10309 Assume that general-purpose registers are 32 bits wide.
10311 @item -mgp64
10312 @opindex mgp64
10313 Assume that general-purpose registers are 64 bits wide.
10315 @item -mfp32
10316 @opindex mfp32
10317 Assume that floating-point registers are 32 bits wide.
10319 @item -mfp64
10320 @opindex mfp64
10321 Assume that floating-point registers are 64 bits wide.
10323 @item -mhard-float
10324 @opindex mhard-float
10325 Use floating-point coprocessor instructions.
10327 @item -msoft-float
10328 @opindex msoft-float
10329 Do not use floating-point coprocessor instructions.  Implement
10330 floating-point calculations using library calls instead.
10332 @item -msingle-float
10333 @opindex msingle-float
10334 Assume that the floating-point coprocessor only supports single-precision
10335 operations.
10337 @itemx -mdouble-float
10338 @opindex mdouble-float
10339 Assume that the floating-point coprocessor supports double-precision
10340 operations.  This is the default.
10342 @itemx -mdsp
10343 @itemx -mno-dsp
10344 @opindex mdsp
10345 @opindex mno-dsp
10346 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10348 @itemx -mpaired-single
10349 @itemx -mno-paired-single
10350 @opindex mpaired-single
10351 @opindex mno-paired-single
10352 Use (do not use) paired-single floating-point instructions.
10353 @xref{MIPS Paired-Single Support}.  This option can only be used
10354 when generating 64-bit code and requires hardware floating-point
10355 support to be enabled.
10357 @itemx -mips3d
10358 @itemx -mno-mips3d
10359 @opindex mips3d
10360 @opindex mno-mips3d
10361 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10362 The option @option{-mips3d} implies @option{-mpaired-single}.
10364 @item -mlong64
10365 @opindex mlong64
10366 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10367 an explanation of the default and the way that the pointer size is
10368 determined.
10370 @item -mlong32
10371 @opindex mlong32
10372 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10374 The default size of @code{int}s, @code{long}s and pointers depends on
10375 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10376 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10377 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10378 or the same size as integer registers, whichever is smaller.
10380 @item -msym32
10381 @itemx -mno-sym32
10382 @opindex msym32
10383 @opindex mno-sym32
10384 Assume (do not assume) that all symbols have 32-bit values, regardless
10385 of the selected ABI@.  This option is useful in combination with
10386 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10387 to generate shorter and faster references to symbolic addresses.
10389 @item -G @var{num}
10390 @opindex G
10391 @cindex smaller data references (MIPS)
10392 @cindex gp-relative references (MIPS)
10393 Put global and static items less than or equal to @var{num} bytes into
10394 the small data or bss section instead of the normal data or bss section.
10395 This allows the data to be accessed using a single instruction.
10397 All modules should be compiled with the same @option{-G @var{num}}
10398 value.
10400 @item -membedded-data
10401 @itemx -mno-embedded-data
10402 @opindex membedded-data
10403 @opindex mno-embedded-data
10404 Allocate variables to the read-only data section first if possible, then
10405 next in the small data section if possible, otherwise in data.  This gives
10406 slightly slower code than the default, but reduces the amount of RAM required
10407 when executing, and thus may be preferred for some embedded systems.
10409 @item -muninit-const-in-rodata
10410 @itemx -mno-uninit-const-in-rodata
10411 @opindex muninit-const-in-rodata
10412 @opindex mno-uninit-const-in-rodata
10413 Put uninitialized @code{const} variables in the read-only data section.
10414 This option is only meaningful in conjunction with @option{-membedded-data}.
10416 @item -msplit-addresses
10417 @itemx -mno-split-addresses
10418 @opindex msplit-addresses
10419 @opindex mno-split-addresses
10420 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10421 relocation operators.  This option has been superseded by
10422 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10424 @item -mexplicit-relocs
10425 @itemx -mno-explicit-relocs
10426 @opindex mexplicit-relocs
10427 @opindex mno-explicit-relocs
10428 Use (do not use) assembler relocation operators when dealing with symbolic
10429 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10430 is to use assembler macros instead.
10432 @option{-mexplicit-relocs} is the default if GCC was configured
10433 to use an assembler that supports relocation operators.
10435 @item -mcheck-zero-division
10436 @itemx -mno-check-zero-division
10437 @opindex mcheck-zero-division
10438 @opindex mno-check-zero-division
10439 Trap (do not trap) on integer division by zero.  The default is
10440 @option{-mcheck-zero-division}.
10442 @item -mdivide-traps
10443 @itemx -mdivide-breaks
10444 @opindex mdivide-traps
10445 @opindex mdivide-breaks
10446 MIPS systems check for division by zero by generating either a
10447 conditional trap or a break instruction.  Using traps results in
10448 smaller code, but is only supported on MIPS II and later.  Also, some
10449 versions of the Linux kernel have a bug that prevents trap from
10450 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10451 allow conditional traps on architectures that support them and
10452 @option{-mdivide-breaks} to force the use of breaks.
10454 The default is usually @option{-mdivide-traps}, but this can be
10455 overridden at configure time using @option{--with-divide=breaks}.
10456 Divide-by-zero checks can be completely disabled using
10457 @option{-mno-check-zero-division}.
10459 @item -mmemcpy
10460 @itemx -mno-memcpy
10461 @opindex mmemcpy
10462 @opindex mno-memcpy
10463 Force (do not force) the use of @code{memcpy()} for non-trivial block
10464 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10465 most constant-sized copies.
10467 @item -mlong-calls
10468 @itemx -mno-long-calls
10469 @opindex mlong-calls
10470 @opindex mno-long-calls
10471 Disable (do not disable) use of the @code{jal} instruction.  Calling
10472 functions using @code{jal} is more efficient but requires the caller
10473 and callee to be in the same 256 megabyte segment.
10475 This option has no effect on abicalls code.  The default is
10476 @option{-mno-long-calls}.
10478 @item -mmad
10479 @itemx -mno-mad
10480 @opindex mmad
10481 @opindex mno-mad
10482 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10483 instructions, as provided by the R4650 ISA@.
10485 @item -mfused-madd
10486 @itemx -mno-fused-madd
10487 @opindex mfused-madd
10488 @opindex mno-fused-madd
10489 Enable (disable) use of the floating point multiply-accumulate
10490 instructions, when they are available.  The default is
10491 @option{-mfused-madd}.
10493 When multiply-accumulate instructions are used, the intermediate
10494 product is calculated to infinite precision and is not subject to
10495 the FCSR Flush to Zero bit.  This may be undesirable in some
10496 circumstances.
10498 @item -nocpp
10499 @opindex nocpp
10500 Tell the MIPS assembler to not run its preprocessor over user
10501 assembler files (with a @samp{.s} suffix) when assembling them.
10503 @item -mfix-r4000
10504 @itemx -mno-fix-r4000
10505 @opindex mfix-r4000
10506 @opindex mno-fix-r4000
10507 Work around certain R4000 CPU errata:
10508 @itemize @minus
10509 @item
10510 A double-word or a variable shift may give an incorrect result if executed
10511 immediately after starting an integer division.
10512 @item
10513 A double-word or a variable shift may give an incorrect result if executed
10514 while an integer multiplication is in progress.
10515 @item
10516 An integer division may give an incorrect result if started in a delay slot
10517 of a taken branch or a jump.
10518 @end itemize
10520 @item -mfix-r4400
10521 @itemx -mno-fix-r4400
10522 @opindex mfix-r4400
10523 @opindex mno-fix-r4400
10524 Work around certain R4400 CPU errata:
10525 @itemize @minus
10526 @item
10527 A double-word or a variable shift may give an incorrect result if executed
10528 immediately after starting an integer division.
10529 @end itemize
10531 @item -mfix-vr4120
10532 @itemx -mno-fix-vr4120
10533 @opindex mfix-vr4120
10534 Work around certain VR4120 errata:
10535 @itemize @minus
10536 @item
10537 @code{dmultu} does not always produce the correct result.
10538 @item
10539 @code{div} and @code{ddiv} do not always produce the correct result if one
10540 of the operands is negative.
10541 @end itemize
10542 The workarounds for the division errata rely on special functions in
10543 @file{libgcc.a}.  At present, these functions are only provided by
10544 the @code{mips64vr*-elf} configurations.
10546 Other VR4120 errata require a nop to be inserted between certain pairs of
10547 instructions.  These errata are handled by the assembler, not by GCC itself.
10549 @item -mfix-vr4130
10550 @opindex mfix-vr4130
10551 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10552 workarounds are implemented by the assembler rather than by GCC,
10553 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10554 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10555 instructions are available instead.
10557 @item -mfix-sb1
10558 @itemx -mno-fix-sb1
10559 @opindex mfix-sb1
10560 Work around certain SB-1 CPU core errata.
10561 (This flag currently works around the SB-1 revision 2
10562 ``F1'' and ``F2'' floating point errata.)
10564 @item -mflush-func=@var{func}
10565 @itemx -mno-flush-func
10566 @opindex mflush-func
10567 Specifies the function to call to flush the I and D caches, or to not
10568 call any such function.  If called, the function must take the same
10569 arguments as the common @code{_flush_func()}, that is, the address of the
10570 memory range for which the cache is being flushed, the size of the
10571 memory range, and the number 3 (to flush both caches).  The default
10572 depends on the target GCC was configured for, but commonly is either
10573 @samp{_flush_func} or @samp{__cpu_flush}.
10575 @item -mbranch-likely
10576 @itemx -mno-branch-likely
10577 @opindex mbranch-likely
10578 @opindex mno-branch-likely
10579 Enable or disable use of Branch Likely instructions, regardless of the
10580 default for the selected architecture.  By default, Branch Likely
10581 instructions may be generated if they are supported by the selected
10582 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10583 and processors which implement those architectures; for those, Branch
10584 Likely instructions will not be generated by default because the MIPS32
10585 and MIPS64 architectures specifically deprecate their use.
10587 @item -mfp-exceptions
10588 @itemx -mno-fp-exceptions
10589 @opindex mfp-exceptions
10590 Specifies whether FP exceptions are enabled.  This affects how we schedule
10591 FP instructions for some processors.  The default is that FP exceptions are
10592 enabled.
10594 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10595 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10596 FP pipe.
10598 @item -mvr4130-align
10599 @itemx -mno-vr4130-align
10600 @opindex mvr4130-align
10601 The VR4130 pipeline is two-way superscalar, but can only issue two
10602 instructions together if the first one is 8-byte aligned.  When this
10603 option is enabled, GCC will align pairs of instructions that it
10604 thinks should execute in parallel.
10606 This option only has an effect when optimizing for the VR4130.
10607 It normally makes code faster, but at the expense of making it bigger.
10608 It is enabled by default at optimization level @option{-O3}.
10609 @end table
10611 @node MMIX Options
10612 @subsection MMIX Options
10613 @cindex MMIX Options
10615 These options are defined for the MMIX:
10617 @table @gcctabopt
10618 @item -mlibfuncs
10619 @itemx -mno-libfuncs
10620 @opindex mlibfuncs
10621 @opindex mno-libfuncs
10622 Specify that intrinsic library functions are being compiled, passing all
10623 values in registers, no matter the size.
10625 @item -mepsilon
10626 @itemx -mno-epsilon
10627 @opindex mepsilon
10628 @opindex mno-epsilon
10629 Generate floating-point comparison instructions that compare with respect
10630 to the @code{rE} epsilon register.
10632 @item -mabi=mmixware
10633 @itemx -mabi=gnu
10634 @opindex mabi-mmixware
10635 @opindex mabi=gnu
10636 Generate code that passes function parameters and return values that (in
10637 the called function) are seen as registers @code{$0} and up, as opposed to
10638 the GNU ABI which uses global registers @code{$231} and up.
10640 @item -mzero-extend
10641 @itemx -mno-zero-extend
10642 @opindex mzero-extend
10643 @opindex mno-zero-extend
10644 When reading data from memory in sizes shorter than 64 bits, use (do not
10645 use) zero-extending load instructions by default, rather than
10646 sign-extending ones.
10648 @item -mknuthdiv
10649 @itemx -mno-knuthdiv
10650 @opindex mknuthdiv
10651 @opindex mno-knuthdiv
10652 Make the result of a division yielding a remainder have the same sign as
10653 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10654 remainder follows the sign of the dividend.  Both methods are
10655 arithmetically valid, the latter being almost exclusively used.
10657 @item -mtoplevel-symbols
10658 @itemx -mno-toplevel-symbols
10659 @opindex mtoplevel-symbols
10660 @opindex mno-toplevel-symbols
10661 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10662 code can be used with the @code{PREFIX} assembly directive.
10664 @item -melf
10665 @opindex melf
10666 Generate an executable in the ELF format, rather than the default
10667 @samp{mmo} format used by the @command{mmix} simulator.
10669 @item -mbranch-predict
10670 @itemx -mno-branch-predict
10671 @opindex mbranch-predict
10672 @opindex mno-branch-predict
10673 Use (do not use) the probable-branch instructions, when static branch
10674 prediction indicates a probable branch.
10676 @item -mbase-addresses
10677 @itemx -mno-base-addresses
10678 @opindex mbase-addresses
10679 @opindex mno-base-addresses
10680 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10681 base address automatically generates a request (handled by the assembler
10682 and the linker) for a constant to be set up in a global register.  The
10683 register is used for one or more base address requests within the range 0
10684 to 255 from the value held in the register.  The generally leads to short
10685 and fast code, but the number of different data items that can be
10686 addressed is limited.  This means that a program that uses lots of static
10687 data may require @option{-mno-base-addresses}.
10689 @item -msingle-exit
10690 @itemx -mno-single-exit
10691 @opindex msingle-exit
10692 @opindex mno-single-exit
10693 Force (do not force) generated code to have a single exit point in each
10694 function.
10695 @end table
10697 @node MN10300 Options
10698 @subsection MN10300 Options
10699 @cindex MN10300 options
10701 These @option{-m} options are defined for Matsushita MN10300 architectures:
10703 @table @gcctabopt
10704 @item -mmult-bug
10705 @opindex mmult-bug
10706 Generate code to avoid bugs in the multiply instructions for the MN10300
10707 processors.  This is the default.
10709 @item -mno-mult-bug
10710 @opindex mno-mult-bug
10711 Do not generate code to avoid bugs in the multiply instructions for the
10712 MN10300 processors.
10714 @item -mam33
10715 @opindex mam33
10716 Generate code which uses features specific to the AM33 processor.
10718 @item -mno-am33
10719 @opindex mno-am33
10720 Do not generate code which uses features specific to the AM33 processor.  This
10721 is the default.
10723 @item -mreturn-pointer-on-d0
10724 @opindex mreturn-pointer-on-d0
10725 When generating a function which returns a pointer, return the pointer
10726 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
10727 only in a0, and attempts to call such functions without a prototype
10728 would result in errors.  Note that this option is on by default; use
10729 @option{-mno-return-pointer-on-d0} to disable it.
10731 @item -mno-crt0
10732 @opindex mno-crt0
10733 Do not link in the C run-time initialization object file.
10735 @item -mrelax
10736 @opindex mrelax
10737 Indicate to the linker that it should perform a relaxation optimization pass
10738 to shorten branches, calls and absolute memory addresses.  This option only
10739 has an effect when used on the command line for the final link step.
10741 This option makes symbolic debugging impossible.
10742 @end table
10744 @node MT Options
10745 @subsection MT Options
10746 @cindex MT options
10748 These @option{-m} options are defined for Morpho MT architectures:
10750 @table @gcctabopt
10752 @item -march=@var{cpu-type}
10753 @opindex march
10754 Generate code that will run on @var{cpu-type}, which is the name of a system
10755 representing a certain processor type.  Possible values for
10756 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
10757 @samp{ms1-16-003} and @samp{ms2}.
10759 When this option is not used, the default is @option{-march=ms1-16-002}.
10761 @item -mbacc
10762 @opindex mbacc
10763 Use byte loads and stores when generating code.
10765 @item -mno-bacc
10766 @opindex mno-bacc
10767 Do not use byte loads and stores when generating code.
10769 @item -msim
10770 @opindex msim
10771 Use simulator runtime
10773 @item -mno-crt0
10774 @opindex mno-crt0
10775 Do not link in the C run-time initialization object file
10776 @file{crti.o}.  Other run-time initialization and termination files
10777 such as @file{startup.o} and @file{exit.o} are still included on the
10778 linker command line.
10780 @end table
10782 @node PDP-11 Options
10783 @subsection PDP-11 Options
10784 @cindex PDP-11 Options
10786 These options are defined for the PDP-11:
10788 @table @gcctabopt
10789 @item -mfpu
10790 @opindex mfpu
10791 Use hardware FPP floating point.  This is the default.  (FIS floating
10792 point on the PDP-11/40 is not supported.)
10794 @item -msoft-float
10795 @opindex msoft-float
10796 Do not use hardware floating point.
10798 @item -mac0
10799 @opindex mac0
10800 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10802 @item -mno-ac0
10803 @opindex mno-ac0
10804 Return floating-point results in memory.  This is the default.
10806 @item -m40
10807 @opindex m40
10808 Generate code for a PDP-11/40.
10810 @item -m45
10811 @opindex m45
10812 Generate code for a PDP-11/45.  This is the default.
10814 @item -m10
10815 @opindex m10
10816 Generate code for a PDP-11/10.
10818 @item -mbcopy-builtin
10819 @opindex bcopy-builtin
10820 Use inline @code{movmemhi} patterns for copying memory.  This is the
10821 default.
10823 @item -mbcopy
10824 @opindex mbcopy
10825 Do not use inline @code{movmemhi} patterns for copying memory.
10827 @item -mint16
10828 @itemx -mno-int32
10829 @opindex mint16
10830 @opindex mno-int32
10831 Use 16-bit @code{int}.  This is the default.
10833 @item -mint32
10834 @itemx -mno-int16
10835 @opindex mint32
10836 @opindex mno-int16
10837 Use 32-bit @code{int}.
10839 @item -mfloat64
10840 @itemx -mno-float32
10841 @opindex mfloat64
10842 @opindex mno-float32
10843 Use 64-bit @code{float}.  This is the default.
10845 @item -mfloat32
10846 @itemx -mno-float64
10847 @opindex mfloat32
10848 @opindex mno-float64
10849 Use 32-bit @code{float}.
10851 @item -mabshi
10852 @opindex mabshi
10853 Use @code{abshi2} pattern.  This is the default.
10855 @item -mno-abshi
10856 @opindex mno-abshi
10857 Do not use @code{abshi2} pattern.
10859 @item -mbranch-expensive
10860 @opindex mbranch-expensive
10861 Pretend that branches are expensive.  This is for experimenting with
10862 code generation only.
10864 @item -mbranch-cheap
10865 @opindex mbranch-cheap
10866 Do not pretend that branches are expensive.  This is the default.
10868 @item -msplit
10869 @opindex msplit
10870 Generate code for a system with split I&D@.
10872 @item -mno-split
10873 @opindex mno-split
10874 Generate code for a system without split I&D@.  This is the default.
10876 @item -munix-asm
10877 @opindex munix-asm
10878 Use Unix assembler syntax.  This is the default when configured for
10879 @samp{pdp11-*-bsd}.
10881 @item -mdec-asm
10882 @opindex mdec-asm
10883 Use DEC assembler syntax.  This is the default when configured for any
10884 PDP-11 target other than @samp{pdp11-*-bsd}.
10885 @end table
10887 @node PowerPC Options
10888 @subsection PowerPC Options
10889 @cindex PowerPC options
10891 These are listed under @xref{RS/6000 and PowerPC Options}.
10893 @node RS/6000 and PowerPC Options
10894 @subsection IBM RS/6000 and PowerPC Options
10895 @cindex RS/6000 and PowerPC Options
10896 @cindex IBM RS/6000 and PowerPC Options
10898 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10899 @table @gcctabopt
10900 @item -mpower
10901 @itemx -mno-power
10902 @itemx -mpower2
10903 @itemx -mno-power2
10904 @itemx -mpowerpc
10905 @itemx -mno-powerpc
10906 @itemx -mpowerpc-gpopt
10907 @itemx -mno-powerpc-gpopt
10908 @itemx -mpowerpc-gfxopt
10909 @itemx -mno-powerpc-gfxopt
10910 @itemx -mpowerpc64
10911 @itemx -mno-powerpc64
10912 @itemx -mmfcrf
10913 @itemx -mno-mfcrf
10914 @itemx -mpopcntb
10915 @itemx -mno-popcntb
10916 @itemx -mfprnd
10917 @itemx -mno-fprnd
10918 @opindex mpower
10919 @opindex mno-power
10920 @opindex mpower2
10921 @opindex mno-power2
10922 @opindex mpowerpc
10923 @opindex mno-powerpc
10924 @opindex mpowerpc-gpopt
10925 @opindex mno-powerpc-gpopt
10926 @opindex mpowerpc-gfxopt
10927 @opindex mno-powerpc-gfxopt
10928 @opindex mpowerpc64
10929 @opindex mno-powerpc64
10930 @opindex mmfcrf
10931 @opindex mno-mfcrf
10932 @opindex mpopcntb
10933 @opindex mno-popcntb
10934 @opindex mfprnd
10935 @opindex mno-fprnd
10936 GCC supports two related instruction set architectures for the
10937 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10938 instructions supported by the @samp{rios} chip set used in the original
10939 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10940 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
10941 the IBM 4xx, 6xx, and follow-on microprocessors.
10943 Neither architecture is a subset of the other.  However there is a
10944 large common subset of instructions supported by both.  An MQ
10945 register is included in processors supporting the POWER architecture.
10947 You use these options to specify which instructions are available on the
10948 processor you are using.  The default value of these options is
10949 determined when configuring GCC@.  Specifying the
10950 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10951 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10952 rather than the options listed above.
10954 The @option{-mpower} option allows GCC to generate instructions that
10955 are found only in the POWER architecture and to use the MQ register.
10956 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10957 to generate instructions that are present in the POWER2 architecture but
10958 not the original POWER architecture.
10960 The @option{-mpowerpc} option allows GCC to generate instructions that
10961 are found only in the 32-bit subset of the PowerPC architecture.
10962 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10963 GCC to use the optional PowerPC architecture instructions in the
10964 General Purpose group, including floating-point square root.  Specifying
10965 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10966 use the optional PowerPC architecture instructions in the Graphics
10967 group, including floating-point select.
10969 The @option{-mmfcrf} option allows GCC to generate the move from
10970 condition register field instruction implemented on the POWER4
10971 processor and other processors that support the PowerPC V2.01
10972 architecture.
10973 The @option{-mpopcntb} option allows GCC to generate the popcount and
10974 double precision FP reciprocal estimate instruction implemented on the
10975 POWER5 processor and other processors that support the PowerPC V2.02
10976 architecture.
10977 The @option{-mfprnd} option allows GCC to generate the FP round to
10978 integer instructions implemented on the POWER5+ processor and other
10979 processors that support the PowerPC V2.03 architecture.
10981 The @option{-mpowerpc64} option allows GCC to generate the additional
10982 64-bit instructions that are found in the full PowerPC64 architecture
10983 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10984 @option{-mno-powerpc64}.
10986 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10987 will use only the instructions in the common subset of both
10988 architectures plus some special AIX common-mode calls, and will not use
10989 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10990 permits GCC to use any instruction from either architecture and to
10991 allow use of the MQ register; specify this for the Motorola MPC601.
10993 @item -mnew-mnemonics
10994 @itemx -mold-mnemonics
10995 @opindex mnew-mnemonics
10996 @opindex mold-mnemonics
10997 Select which mnemonics to use in the generated assembler code.  With
10998 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10999 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
11000 assembler mnemonics defined for the POWER architecture.  Instructions
11001 defined in only one architecture have only one mnemonic; GCC uses that
11002 mnemonic irrespective of which of these options is specified.
11004 GCC defaults to the mnemonics appropriate for the architecture in
11005 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
11006 value of these option.  Unless you are building a cross-compiler, you
11007 should normally not specify either @option{-mnew-mnemonics} or
11008 @option{-mold-mnemonics}, but should instead accept the default.
11010 @item -mcpu=@var{cpu_type}
11011 @opindex mcpu
11012 Set architecture type, register usage, choice of mnemonics, and
11013 instruction scheduling parameters for machine type @var{cpu_type}.
11014 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
11015 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
11016 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
11017 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
11018 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
11019 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
11020 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
11021 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
11022 @samp{common}, @samp{powerpc}, @samp{powerpc64},
11023 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
11025 @option{-mcpu=common} selects a completely generic processor.  Code
11026 generated under this option will run on any POWER or PowerPC processor.
11027 GCC will use only the instructions in the common subset of both
11028 architectures, and will not use the MQ register.  GCC assumes a generic
11029 processor model for scheduling purposes.
11031 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11032 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11033 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11034 types, with an appropriate, generic processor model assumed for
11035 scheduling purposes.
11037 The other options specify a specific processor.  Code generated under
11038 those options will run best on that processor, and may not run at all on
11039 others.
11041 The @option{-mcpu} options automatically enable or disable the
11042 following options: @option{-maltivec}, @option{-mfprnd},
11043 @option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
11044 @option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
11045 @option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
11046 @option{-mpowerpc-gfxopt}, @option{-mstring}.  The particular options
11047 set for any particular CPU will vary between compiler versions,
11048 depending on what setting seems to produce optimal code for that CPU;
11049 it doesn't necessarily reflect the actual hardware's capabilities.  If
11050 you wish to set an individual option to a particular value, you may
11051 specify it after the @option{-mcpu} option, like @samp{-mcpu=970
11052 -mno-altivec}.
11054 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
11055 not enabled or disabled by the @option{-mcpu} option at present because
11056 AIX does not have full support for these options.  You may still
11057 enable or disable them individually if you're sure it'll work in your
11058 environment.
11060 @item -mtune=@var{cpu_type}
11061 @opindex mtune
11062 Set the instruction scheduling parameters for machine type
11063 @var{cpu_type}, but do not set the architecture type, register usage, or
11064 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
11065 values for @var{cpu_type} are used for @option{-mtune} as for
11066 @option{-mcpu}.  If both are specified, the code generated will use the
11067 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11068 scheduling parameters set by @option{-mtune}.
11070 @item -mswdiv
11071 @itemx -mno-swdiv
11072 @opindex mswdiv
11073 @opindex mno-swdiv
11074 Generate code to compute division as reciprocal estimate and iterative
11075 refinement, creating opportunities for increased throughput.  This
11076 feature requires: optional PowerPC Graphics instruction set for single
11077 precision and FRE instruction for double precision, assuming divides
11078 cannot generate user-visible traps, and the domain values not include
11079 Infinities, denormals or zero denominator.
11081 @item -maltivec
11082 @itemx -mno-altivec
11083 @opindex maltivec
11084 @opindex mno-altivec
11085 Generate code that uses (does not use) AltiVec instructions, and also
11086 enable the use of built-in functions that allow more direct access to
11087 the AltiVec instruction set.  You may also need to set
11088 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11089 enhancements.
11091 @item -mvrsave
11092 @item -mno-vrsave
11093 @opindex mvrsave
11094 @opindex mno-vrsave
11095 Generate VRSAVE instructions when generating AltiVec code.
11097 @item -msecure-plt
11098 @opindex msecure-plt
11099 Generate code that allows ld and ld.so to build executables and shared
11100 libraries with non-exec .plt and .got sections.  This is a PowerPC
11101 32-bit SYSV ABI option.
11103 @item -mbss-plt
11104 @opindex mbss-plt
11105 Generate code that uses a BSS .plt section that ld.so fills in, and
11106 requires .plt and .got sections that are both writable and executable.
11107 This is a PowerPC 32-bit SYSV ABI option.
11109 @item -misel
11110 @itemx -mno-isel
11111 @opindex misel
11112 @opindex mno-isel
11113 This switch enables or disables the generation of ISEL instructions.
11115 @item -misel=@var{yes/no}
11116 This switch has been deprecated.  Use @option{-misel} and
11117 @option{-mno-isel} instead.
11119 @item -mspe
11120 @itemx -mno-isel
11121 @opindex mspe
11122 @opindex mno-spe
11123 This switch enables or disables the generation of SPE simd
11124 instructions.
11126 @item -mspe=@var{yes/no}
11127 This option has been deprecated.  Use @option{-mspe} and
11128 @option{-mno-spe} instead.
11130 @item -mfloat-gprs=@var{yes/single/double/no}
11131 @itemx -mfloat-gprs
11132 @opindex mfloat-gprs
11133 This switch enables or disables the generation of floating point
11134 operations on the general purpose registers for architectures that
11135 support it.
11137 The argument @var{yes} or @var{single} enables the use of
11138 single-precision floating point operations.
11140 The argument @var{double} enables the use of single and
11141 double-precision floating point operations.
11143 The argument @var{no} disables floating point operations on the
11144 general purpose registers.
11146 This option is currently only available on the MPC854x.
11148 @item -m32
11149 @itemx -m64
11150 @opindex m32
11151 @opindex m64
11152 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11153 targets (including GNU/Linux).  The 32-bit environment sets int, long
11154 and pointer to 32 bits and generates code that runs on any PowerPC
11155 variant.  The 64-bit environment sets int to 32 bits and long and
11156 pointer to 64 bits, and generates code for PowerPC64, as for
11157 @option{-mpowerpc64}.
11159 @item -mfull-toc
11160 @itemx -mno-fp-in-toc
11161 @itemx -mno-sum-in-toc
11162 @itemx -mminimal-toc
11163 @opindex mfull-toc
11164 @opindex mno-fp-in-toc
11165 @opindex mno-sum-in-toc
11166 @opindex mminimal-toc
11167 Modify generation of the TOC (Table Of Contents), which is created for
11168 every executable file.  The @option{-mfull-toc} option is selected by
11169 default.  In that case, GCC will allocate at least one TOC entry for
11170 each unique non-automatic variable reference in your program.  GCC
11171 will also place floating-point constants in the TOC@.  However, only
11172 16,384 entries are available in the TOC@.
11174 If you receive a linker error message that saying you have overflowed
11175 the available TOC space, you can reduce the amount of TOC space used
11176 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11177 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11178 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11179 generate code to calculate the sum of an address and a constant at
11180 run-time instead of putting that sum into the TOC@.  You may specify one
11181 or both of these options.  Each causes GCC to produce very slightly
11182 slower and larger code at the expense of conserving TOC space.
11184 If you still run out of space in the TOC even when you specify both of
11185 these options, specify @option{-mminimal-toc} instead.  This option causes
11186 GCC to make only one TOC entry for every file.  When you specify this
11187 option, GCC will produce code that is slower and larger but which
11188 uses extremely little TOC space.  You may wish to use this option
11189 only on files that contain less frequently executed code.
11191 @item -maix64
11192 @itemx -maix32
11193 @opindex maix64
11194 @opindex maix32
11195 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11196 @code{long} type, and the infrastructure needed to support them.
11197 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11198 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11199 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11201 @item -mxl-compat
11202 @itemx -mno-xl-compat
11203 @opindex mxl-compat
11204 @opindex mno-xl-compat
11205 Produce code that conforms more closely to IBM XL compiler semantics
11206 when using AIX-compatible ABI.  Pass floating-point arguments to
11207 prototyped functions beyond the register save area (RSA) on the stack
11208 in addition to argument FPRs.  Do not assume that most significant
11209 double in 128-bit long double value is properly rounded when comparing
11210 values and converting to double.  Use XL symbol names for long double
11211 support routines.
11213 The AIX calling convention was extended but not initially documented to
11214 handle an obscure K&R C case of calling a function that takes the
11215 address of its arguments with fewer arguments than declared.  IBM XL
11216 compilers access floating point arguments which do not fit in the
11217 RSA from the stack when a subroutine is compiled without
11218 optimization.  Because always storing floating-point arguments on the
11219 stack is inefficient and rarely needed, this option is not enabled by
11220 default and only is necessary when calling subroutines compiled by IBM
11221 XL compilers without optimization.
11223 @item -mpe
11224 @opindex mpe
11225 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11226 application written to use message passing with special startup code to
11227 enable the application to run.  The system must have PE installed in the
11228 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11229 must be overridden with the @option{-specs=} option to specify the
11230 appropriate directory location.  The Parallel Environment does not
11231 support threads, so the @option{-mpe} option and the @option{-pthread}
11232 option are incompatible.
11234 @item -malign-natural
11235 @itemx -malign-power
11236 @opindex malign-natural
11237 @opindex malign-power
11238 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11239 @option{-malign-natural} overrides the ABI-defined alignment of larger
11240 types, such as floating-point doubles, on their natural size-based boundary.
11241 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11242 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11244 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11245 is not supported.
11247 @item -msoft-float
11248 @itemx -mhard-float
11249 @opindex msoft-float
11250 @opindex mhard-float
11251 Generate code that does not use (uses) the floating-point register set.
11252 Software floating point emulation is provided if you use the
11253 @option{-msoft-float} option, and pass the option to GCC when linking.
11255 @item -mmultiple
11256 @itemx -mno-multiple
11257 @opindex mmultiple
11258 @opindex mno-multiple
11259 Generate code that uses (does not use) the load multiple word
11260 instructions and the store multiple word instructions.  These
11261 instructions are generated by default on POWER systems, and not
11262 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11263 endian PowerPC systems, since those instructions do not work when the
11264 processor is in little endian mode.  The exceptions are PPC740 and
11265 PPC750 which permit the instructions usage in little endian mode.
11267 @item -mstring
11268 @itemx -mno-string
11269 @opindex mstring
11270 @opindex mno-string
11271 Generate code that uses (does not use) the load string instructions
11272 and the store string word instructions to save multiple registers and
11273 do small block moves.  These instructions are generated by default on
11274 POWER systems, and not generated on PowerPC systems.  Do not use
11275 @option{-mstring} on little endian PowerPC systems, since those
11276 instructions do not work when the processor is in little endian mode.
11277 The exceptions are PPC740 and PPC750 which permit the instructions
11278 usage in little endian mode.
11280 @item -mupdate
11281 @itemx -mno-update
11282 @opindex mupdate
11283 @opindex mno-update
11284 Generate code that uses (does not use) the load or store instructions
11285 that update the base register to the address of the calculated memory
11286 location.  These instructions are generated by default.  If you use
11287 @option{-mno-update}, there is a small window between the time that the
11288 stack pointer is updated and the address of the previous frame is
11289 stored, which means code that walks the stack frame across interrupts or
11290 signals may get corrupted data.
11292 @item -mfused-madd
11293 @itemx -mno-fused-madd
11294 @opindex mfused-madd
11295 @opindex mno-fused-madd
11296 Generate code that uses (does not use) the floating point multiply and
11297 accumulate instructions.  These instructions are generated by default if
11298 hardware floating is used.
11300 @item -mno-bit-align
11301 @itemx -mbit-align
11302 @opindex mno-bit-align
11303 @opindex mbit-align
11304 On System V.4 and embedded PowerPC systems do not (do) force structures
11305 and unions that contain bit-fields to be aligned to the base type of the
11306 bit-field.
11308 For example, by default a structure containing nothing but 8
11309 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11310 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11311 the structure would be aligned to a 1 byte boundary and be one byte in
11312 size.
11314 @item -mno-strict-align
11315 @itemx -mstrict-align
11316 @opindex mno-strict-align
11317 @opindex mstrict-align
11318 On System V.4 and embedded PowerPC systems do not (do) assume that
11319 unaligned memory references will be handled by the system.
11321 @item -mrelocatable
11322 @itemx -mno-relocatable
11323 @opindex mrelocatable
11324 @opindex mno-relocatable
11325 On embedded PowerPC systems generate code that allows (does not allow)
11326 the program to be relocated to a different address at runtime.  If you
11327 use @option{-mrelocatable} on any module, all objects linked together must
11328 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11330 @item -mrelocatable-lib
11331 @itemx -mno-relocatable-lib
11332 @opindex mrelocatable-lib
11333 @opindex mno-relocatable-lib
11334 On embedded PowerPC systems generate code that allows (does not allow)
11335 the program to be relocated to a different address at runtime.  Modules
11336 compiled with @option{-mrelocatable-lib} can be linked with either modules
11337 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11338 with modules compiled with the @option{-mrelocatable} options.
11340 @item -mno-toc
11341 @itemx -mtoc
11342 @opindex mno-toc
11343 @opindex mtoc
11344 On System V.4 and embedded PowerPC systems do not (do) assume that
11345 register 2 contains a pointer to a global area pointing to the addresses
11346 used in the program.
11348 @item -mlittle
11349 @itemx -mlittle-endian
11350 @opindex mlittle
11351 @opindex mlittle-endian
11352 On System V.4 and embedded PowerPC systems compile code for the
11353 processor in little endian mode.  The @option{-mlittle-endian} option is
11354 the same as @option{-mlittle}.
11356 @item -mbig
11357 @itemx -mbig-endian
11358 @opindex mbig
11359 @opindex mbig-endian
11360 On System V.4 and embedded PowerPC systems compile code for the
11361 processor in big endian mode.  The @option{-mbig-endian} option is
11362 the same as @option{-mbig}.
11364 @item -mdynamic-no-pic
11365 @opindex mdynamic-no-pic
11366 On Darwin and Mac OS X systems, compile code so that it is not
11367 relocatable, but that its external references are relocatable.  The
11368 resulting code is suitable for applications, but not shared
11369 libraries.
11371 @item -mprioritize-restricted-insns=@var{priority}
11372 @opindex mprioritize-restricted-insns
11373 This option controls the priority that is assigned to
11374 dispatch-slot restricted instructions during the second scheduling
11375 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11376 @var{no/highest/second-highest} priority to dispatch slot restricted
11377 instructions.
11379 @item -msched-costly-dep=@var{dependence_type}
11380 @opindex msched-costly-dep
11381 This option controls which dependences are considered costly
11382 by the target during instruction scheduling.  The argument
11383 @var{dependence_type} takes one of the following values:
11384 @var{no}: no dependence is costly,
11385 @var{all}: all dependences are costly,
11386 @var{true_store_to_load}: a true dependence from store to load is costly,
11387 @var{store_to_load}: any dependence from store to load is costly,
11388 @var{number}: any dependence which latency >= @var{number} is costly.
11390 @item -minsert-sched-nops=@var{scheme}
11391 @opindex minsert-sched-nops
11392 This option controls which nop insertion scheme will be used during
11393 the second scheduling pass.  The argument @var{scheme} takes one of the
11394 following values:
11395 @var{no}: Don't insert nops.
11396 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11397 according to the scheduler's grouping.
11398 @var{regroup_exact}: Insert nops to force costly dependent insns into
11399 separate groups.  Insert exactly as many nops as needed to force an insn
11400 to a new group, according to the estimated processor grouping.
11401 @var{number}: Insert nops to force costly dependent insns into
11402 separate groups.  Insert @var{number} nops to force an insn to a new group.
11404 @item -mcall-sysv
11405 @opindex mcall-sysv
11406 On System V.4 and embedded PowerPC systems compile code using calling
11407 conventions that adheres to the March 1995 draft of the System V
11408 Application Binary Interface, PowerPC processor supplement.  This is the
11409 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11411 @item -mcall-sysv-eabi
11412 @opindex mcall-sysv-eabi
11413 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11415 @item -mcall-sysv-noeabi
11416 @opindex mcall-sysv-noeabi
11417 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11419 @item -mcall-solaris
11420 @opindex mcall-solaris
11421 On System V.4 and embedded PowerPC systems compile code for the Solaris
11422 operating system.
11424 @item -mcall-linux
11425 @opindex mcall-linux
11426 On System V.4 and embedded PowerPC systems compile code for the
11427 Linux-based GNU system.
11429 @item -mcall-gnu
11430 @opindex mcall-gnu
11431 On System V.4 and embedded PowerPC systems compile code for the
11432 Hurd-based GNU system.
11434 @item -mcall-netbsd
11435 @opindex mcall-netbsd
11436 On System V.4 and embedded PowerPC systems compile code for the
11437 NetBSD operating system.
11439 @item -maix-struct-return
11440 @opindex maix-struct-return
11441 Return all structures in memory (as specified by the AIX ABI)@.
11443 @item -msvr4-struct-return
11444 @opindex msvr4-struct-return
11445 Return structures smaller than 8 bytes in registers (as specified by the
11446 SVR4 ABI)@.
11448 @item -mabi=@var{abi-type}
11449 @opindex mabi
11450 Extend the current ABI with a particular extension, or remove such extension.
11451 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11452 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
11454 @item -mabi=spe
11455 @opindex mabi=spe
11456 Extend the current ABI with SPE ABI extensions.  This does not change
11457 the default ABI, instead it adds the SPE ABI extensions to the current
11458 ABI@.
11460 @item -mabi=no-spe
11461 @opindex mabi=no-spe
11462 Disable Booke SPE ABI extensions for the current ABI@.
11464 @item -mabi=ibmlongdouble
11465 @opindex mabi=ibmlongdouble
11466 Change the current ABI to use IBM extended precision long double.
11467 This is a PowerPC 32-bit SYSV ABI option.
11469 @item -mabi=ieeelongdouble
11470 @opindex mabi=ieeelongdouble
11471 Change the current ABI to use IEEE extended precision long double.
11472 This is a PowerPC 32-bit Linux ABI option.
11474 @item -mprototype
11475 @itemx -mno-prototype
11476 @opindex mprototype
11477 @opindex mno-prototype
11478 On System V.4 and embedded PowerPC systems assume that all calls to
11479 variable argument functions are properly prototyped.  Otherwise, the
11480 compiler must insert an instruction before every non prototyped call to
11481 set or clear bit 6 of the condition code register (@var{CR}) to
11482 indicate whether floating point values were passed in the floating point
11483 registers in case the function takes a variable arguments.  With
11484 @option{-mprototype}, only calls to prototyped variable argument functions
11485 will set or clear the bit.
11487 @item -msim
11488 @opindex msim
11489 On embedded PowerPC systems, assume that the startup module is called
11490 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11491 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11492 configurations.
11494 @item -mmvme
11495 @opindex mmvme
11496 On embedded PowerPC systems, assume that the startup module is called
11497 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11498 @file{libc.a}.
11500 @item -mads
11501 @opindex mads
11502 On embedded PowerPC systems, assume that the startup module is called
11503 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11504 @file{libc.a}.
11506 @item -myellowknife
11507 @opindex myellowknife
11508 On embedded PowerPC systems, assume that the startup module is called
11509 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11510 @file{libc.a}.
11512 @item -mvxworks
11513 @opindex mvxworks
11514 On System V.4 and embedded PowerPC systems, specify that you are
11515 compiling for a VxWorks system.
11517 @item -mwindiss
11518 @opindex mwindiss
11519 Specify that you are compiling for the WindISS simulation environment.
11521 @item -memb
11522 @opindex memb
11523 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11524 header to indicate that @samp{eabi} extended relocations are used.
11526 @item -meabi
11527 @itemx -mno-eabi
11528 @opindex meabi
11529 @opindex mno-eabi
11530 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11531 Embedded Applications Binary Interface (eabi) which is a set of
11532 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11533 means that the stack is aligned to an 8 byte boundary, a function
11534 @code{__eabi} is called to from @code{main} to set up the eabi
11535 environment, and the @option{-msdata} option can use both @code{r2} and
11536 @code{r13} to point to two separate small data areas.  Selecting
11537 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11538 do not call an initialization function from @code{main}, and the
11539 @option{-msdata} option will only use @code{r13} to point to a single
11540 small data area.  The @option{-meabi} option is on by default if you
11541 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11543 @item -msdata=eabi
11544 @opindex msdata=eabi
11545 On System V.4 and embedded PowerPC systems, put small initialized
11546 @code{const} global and static data in the @samp{.sdata2} section, which
11547 is pointed to by register @code{r2}.  Put small initialized
11548 non-@code{const} global and static data in the @samp{.sdata} section,
11549 which is pointed to by register @code{r13}.  Put small uninitialized
11550 global and static data in the @samp{.sbss} section, which is adjacent to
11551 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11552 incompatible with the @option{-mrelocatable} option.  The
11553 @option{-msdata=eabi} option also sets the @option{-memb} option.
11555 @item -msdata=sysv
11556 @opindex msdata=sysv
11557 On System V.4 and embedded PowerPC systems, put small global and static
11558 data in the @samp{.sdata} section, which is pointed to by register
11559 @code{r13}.  Put small uninitialized global and static data in the
11560 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11561 The @option{-msdata=sysv} option is incompatible with the
11562 @option{-mrelocatable} option.
11564 @item -msdata=default
11565 @itemx -msdata
11566 @opindex msdata=default
11567 @opindex msdata
11568 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11569 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11570 same as @option{-msdata=sysv}.
11572 @item -msdata-data
11573 @opindex msdata-data
11574 On System V.4 and embedded PowerPC systems, put small global and static
11575 data in the @samp{.sdata} section.  Put small uninitialized global and
11576 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11577 to address small data however.  This is the default behavior unless
11578 other @option{-msdata} options are used.
11580 @item -msdata=none
11581 @itemx -mno-sdata
11582 @opindex msdata=none
11583 @opindex mno-sdata
11584 On embedded PowerPC systems, put all initialized global and static data
11585 in the @samp{.data} section, and all uninitialized data in the
11586 @samp{.bss} section.
11588 @item -G @var{num}
11589 @opindex G
11590 @cindex smaller data references (PowerPC)
11591 @cindex .sdata/.sdata2 references (PowerPC)
11592 On embedded PowerPC systems, put global and static items less than or
11593 equal to @var{num} bytes into the small data or bss sections instead of
11594 the normal data or bss section.  By default, @var{num} is 8.  The
11595 @option{-G @var{num}} switch is also passed to the linker.
11596 All modules should be compiled with the same @option{-G @var{num}} value.
11598 @item -mregnames
11599 @itemx -mno-regnames
11600 @opindex mregnames
11601 @opindex mno-regnames
11602 On System V.4 and embedded PowerPC systems do (do not) emit register
11603 names in the assembly language output using symbolic forms.
11605 @item -mlongcall
11606 @itemx -mno-longcall
11607 @opindex mlongcall
11608 @opindex mno-longcall
11609 Default to making all function calls indirectly, using a register, so
11610 that functions which reside further than 32 megabytes (33,554,432
11611 bytes) from the current location can be called.  This setting can be
11612 overridden by the @code{shortcall} function attribute, or by
11613 @code{#pragma longcall(0)}.
11615 Some linkers are capable of detecting out-of-range calls and generating
11616 glue code on the fly.  On these systems, long calls are unnecessary and
11617 generate slower code.  As of this writing, the AIX linker can do this,
11618 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11619 to the GNU linker for 32-bit PowerPC systems as well.
11621 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11622 callee, L42'', plus a ``branch island'' (glue code).  The two target
11623 addresses represent the callee and the ``branch island''.  The
11624 Darwin/PPC linker will prefer the first address and generate a ``bl
11625 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11626 otherwise, the linker will generate ``bl L42'' to call the ``branch
11627 island''.  The ``branch island'' is appended to the body of the
11628 calling function; it computes the full 32-bit address of the callee
11629 and jumps to it.
11631 On Mach-O (Darwin) systems, this option directs the compiler emit to
11632 the glue for every direct call, and the Darwin linker decides whether
11633 to use or discard it.
11635 In the future, we may cause GCC to ignore all longcall specifications
11636 when the linker is known to generate glue.
11638 @item -pthread
11639 @opindex pthread
11640 Adds support for multithreading with the @dfn{pthreads} library.
11641 This option sets flags for both the preprocessor and linker.
11643 @end table
11645 @node S/390 and zSeries Options
11646 @subsection S/390 and zSeries Options
11647 @cindex S/390 and zSeries Options
11649 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11651 @table @gcctabopt
11652 @item -mhard-float
11653 @itemx -msoft-float
11654 @opindex mhard-float
11655 @opindex msoft-float
11656 Use (do not use) the hardware floating-point instructions and registers
11657 for floating-point operations.  When @option{-msoft-float} is specified,
11658 functions in @file{libgcc.a} will be used to perform floating-point
11659 operations.  When @option{-mhard-float} is specified, the compiler
11660 generates IEEE floating-point instructions.  This is the default.
11662 @item -mlong-double-64
11663 @itemx -mlong-double-128
11664 @opindex mlong-double-64
11665 @opindex mlong-double-128
11666 These switches control the size of @code{long double} type.  A size
11667 of 64bit makes the @code{long double} type equivalent to the @code{double}
11668 type.  This is the default.
11670 @item -mbackchain
11671 @itemx -mno-backchain
11672 @opindex mbackchain
11673 @opindex mno-backchain
11674 Store (do not store) the address of the caller's frame as backchain pointer
11675 into the callee's stack frame.
11676 A backchain may be needed to allow debugging using tools that do not understand
11677 DWARF-2 call frame information.
11678 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11679 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11680 the backchain is placed into the topmost word of the 96/160 byte register
11681 save area.
11683 In general, code compiled with @option{-mbackchain} is call-compatible with
11684 code compiled with @option{-mmo-backchain}; however, use of the backchain
11685 for debugging purposes usually requires that the whole binary is built with
11686 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11687 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11688 to build a linux kernel use @option{-msoft-float}.
11690 The default is to not maintain the backchain.
11692 @item -mpacked-stack
11693 @item -mno-packed-stack
11694 @opindex mpacked-stack
11695 @opindex mno-packed-stack
11696 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11697 specified, the compiler uses the all fields of the 96/160 byte register save
11698 area only for their default purpose; unused fields still take up stack space.
11699 When @option{-mpacked-stack} is specified, register save slots are densely
11700 packed at the top of the register save area; unused space is reused for other
11701 purposes, allowing for more efficient use of the available stack space.
11702 However, when @option{-mbackchain} is also in effect, the topmost word of
11703 the save area is always used to store the backchain, and the return address
11704 register is always saved two words below the backchain.
11706 As long as the stack frame backchain is not used, code generated with
11707 @option{-mpacked-stack} is call-compatible with code generated with
11708 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11709 S/390 or zSeries generated code that uses the stack frame backchain at run
11710 time, not just for debugging purposes.  Such code is not call-compatible
11711 with code compiled with @option{-mpacked-stack}.  Also, note that the
11712 combination of @option{-mbackchain},
11713 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11714 to build a linux kernel use @option{-msoft-float}.
11716 The default is to not use the packed stack layout.
11718 @item -msmall-exec
11719 @itemx -mno-small-exec
11720 @opindex msmall-exec
11721 @opindex mno-small-exec
11722 Generate (or do not generate) code using the @code{bras} instruction
11723 to do subroutine calls.
11724 This only works reliably if the total executable size does not
11725 exceed 64k.  The default is to use the @code{basr} instruction instead,
11726 which does not have this limitation.
11728 @item -m64
11729 @itemx -m31
11730 @opindex m64
11731 @opindex m31
11732 When @option{-m31} is specified, generate code compliant to the
11733 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11734 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11735 particular to generate 64-bit instructions.  For the @samp{s390}
11736 targets, the default is @option{-m31}, while the @samp{s390x}
11737 targets default to @option{-m64}.
11739 @item -mzarch
11740 @itemx -mesa
11741 @opindex mzarch
11742 @opindex mesa
11743 When @option{-mzarch} is specified, generate code using the
11744 instructions available on z/Architecture.
11745 When @option{-mesa} is specified, generate code using the
11746 instructions available on ESA/390.  Note that @option{-mesa} is
11747 not possible with @option{-m64}.
11748 When generating code compliant to the GNU/Linux for S/390 ABI,
11749 the default is @option{-mesa}.  When generating code compliant
11750 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11752 @item -mmvcle
11753 @itemx -mno-mvcle
11754 @opindex mmvcle
11755 @opindex mno-mvcle
11756 Generate (or do not generate) code using the @code{mvcle} instruction
11757 to perform block moves.  When @option{-mno-mvcle} is specified,
11758 use a @code{mvc} loop instead.  This is the default unless optimizing for
11759 size.
11761 @item -mdebug
11762 @itemx -mno-debug
11763 @opindex mdebug
11764 @opindex mno-debug
11765 Print (or do not print) additional debug information when compiling.
11766 The default is to not print debug information.
11768 @item -march=@var{cpu-type}
11769 @opindex march
11770 Generate code that will run on @var{cpu-type}, which is the name of a system
11771 representing a certain processor type.  Possible values for
11772 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11773 When generating code using the instructions available on z/Architecture,
11774 the default is @option{-march=z900}.  Otherwise, the default is
11775 @option{-march=g5}.
11777 @item -mtune=@var{cpu-type}
11778 @opindex mtune
11779 Tune to @var{cpu-type} everything applicable about the generated code,
11780 except for the ABI and the set of available instructions.
11781 The list of @var{cpu-type} values is the same as for @option{-march}.
11782 The default is the value used for @option{-march}.
11784 @item -mtpf-trace
11785 @itemx -mno-tpf-trace
11786 @opindex mtpf-trace
11787 @opindex mno-tpf-trace
11788 Generate code that adds (does not add) in TPF OS specific branches to trace
11789 routines in the operating system.  This option is off by default, even
11790 when compiling for the TPF OS@.
11792 @item -mfused-madd
11793 @itemx -mno-fused-madd
11794 @opindex mfused-madd
11795 @opindex mno-fused-madd
11796 Generate code that uses (does not use) the floating point multiply and
11797 accumulate instructions.  These instructions are generated by default if
11798 hardware floating point is used.
11800 @item -mwarn-framesize=@var{framesize}
11801 @opindex mwarn-framesize
11802 Emit a warning if the current function exceeds the given frame size.  Because
11803 this is a compile time check it doesn't need to be a real problem when the program
11804 runs.  It is intended to identify functions which most probably cause
11805 a stack overflow.  It is useful to be used in an environment with limited stack
11806 size e.g.@: the linux kernel.
11808 @item -mwarn-dynamicstack
11809 @opindex mwarn-dynamicstack
11810 Emit a warning if the function calls alloca or uses dynamically
11811 sized arrays.  This is generally a bad idea with a limited stack size.
11813 @item -mstack-guard=@var{stack-guard}
11814 @item -mstack-size=@var{stack-size}
11815 @opindex mstack-guard
11816 @opindex mstack-size
11817 These arguments always have to be used in conjunction.  If they are present the s390
11818 back end emits additional instructions in the function prologue which trigger a trap
11819 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11820 (remember that the stack on s390 grows downward).  These options are intended to
11821 be used to help debugging stack overflow problems.  The additionally emitted code
11822 causes only little overhead and hence can also be used in production like systems
11823 without greater performance degradation.  The given values have to be exact
11824 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
11825 exceeding 64k.
11826 In order to be efficient the extra code makes the assumption that the stack starts
11827 at an address aligned to the value given by @var{stack-size}.
11828 @end table
11830 @node SH Options
11831 @subsection SH Options
11833 These @samp{-m} options are defined for the SH implementations:
11835 @table @gcctabopt
11836 @item -m1
11837 @opindex m1
11838 Generate code for the SH1.
11840 @item -m2
11841 @opindex m2
11842 Generate code for the SH2.
11844 @item -m2e
11845 Generate code for the SH2e.
11847 @item -m3
11848 @opindex m3
11849 Generate code for the SH3.
11851 @item -m3e
11852 @opindex m3e
11853 Generate code for the SH3e.
11855 @item -m4-nofpu
11856 @opindex m4-nofpu
11857 Generate code for the SH4 without a floating-point unit.
11859 @item -m4-single-only
11860 @opindex m4-single-only
11861 Generate code for the SH4 with a floating-point unit that only
11862 supports single-precision arithmetic.
11864 @item -m4-single
11865 @opindex m4-single
11866 Generate code for the SH4 assuming the floating-point unit is in
11867 single-precision mode by default.
11869 @item -m4
11870 @opindex m4
11871 Generate code for the SH4.
11873 @item -m4a-nofpu
11874 @opindex m4a-nofpu
11875 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11876 floating-point unit is not used.
11878 @item -m4a-single-only
11879 @opindex m4a-single-only
11880 Generate code for the SH4a, in such a way that no double-precision
11881 floating point operations are used.
11883 @item -m4a-single
11884 @opindex m4a-single
11885 Generate code for the SH4a assuming the floating-point unit is in
11886 single-precision mode by default.
11888 @item -m4a
11889 @opindex m4a
11890 Generate code for the SH4a.
11892 @item -m4al
11893 @opindex m4al
11894 Same as @option{-m4a-nofpu}, except that it implicitly passes
11895 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11896 instructions at the moment.
11898 @item -mb
11899 @opindex mb
11900 Compile code for the processor in big endian mode.
11902 @item -ml
11903 @opindex ml
11904 Compile code for the processor in little endian mode.
11906 @item -mdalign
11907 @opindex mdalign
11908 Align doubles at 64-bit boundaries.  Note that this changes the calling
11909 conventions, and thus some functions from the standard C library will
11910 not work unless you recompile it first with @option{-mdalign}.
11912 @item -mrelax
11913 @opindex mrelax
11914 Shorten some address references at link time, when possible; uses the
11915 linker option @option{-relax}.
11917 @item -mbigtable
11918 @opindex mbigtable
11919 Use 32-bit offsets in @code{switch} tables.  The default is to use
11920 16-bit offsets.
11922 @item -mfmovd
11923 @opindex mfmovd
11924 Enable the use of the instruction @code{fmovd}.
11926 @item -mhitachi
11927 @opindex mhitachi
11928 Comply with the calling conventions defined by Renesas.
11930 @item -mrenesas
11931 @opindex mhitachi
11932 Comply with the calling conventions defined by Renesas.
11934 @item -mno-renesas
11935 @opindex mhitachi
11936 Comply with the calling conventions defined for GCC before the Renesas
11937 conventions were available.  This option is the default for all
11938 targets of the SH toolchain except for @samp{sh-symbianelf}.
11940 @item -mnomacsave
11941 @opindex mnomacsave
11942 Mark the @code{MAC} register as call-clobbered, even if
11943 @option{-mhitachi} is given.
11945 @item -mieee
11946 @opindex mieee
11947 Increase IEEE-compliance of floating-point code.
11948 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11949 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11950 comparisons of NANs / infinities incurs extra overhead in every
11951 floating point comparison, therefore the default is set to
11952 @option{-ffinite-math-only}.
11954 @item -misize
11955 @opindex misize
11956 Dump instruction size and location in the assembly code.
11958 @item -mpadstruct
11959 @opindex mpadstruct
11960 This option is deprecated.  It pads structures to multiple of 4 bytes,
11961 which is incompatible with the SH ABI@.
11963 @item -mspace
11964 @opindex mspace
11965 Optimize for space instead of speed.  Implied by @option{-Os}.
11967 @item -mprefergot
11968 @opindex mprefergot
11969 When generating position-independent code, emit function calls using
11970 the Global Offset Table instead of the Procedure Linkage Table.
11972 @item -musermode
11973 @opindex musermode
11974 Generate a library function call to invalidate instruction cache
11975 entries, after fixing up a trampoline.  This library function call
11976 doesn't assume it can write to the whole memory address space.  This
11977 is the default when the target is @code{sh-*-linux*}.
11979 @item -multcost=@var{number}
11980 @opindex multcost=@var{number}
11981 Set the cost to assume for a multiply insn.
11983 @item -mdiv=@var{strategy}
11984 @opindex mdiv=@var{strategy}
11985 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11986 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11987 inv:call2, inv:fp .
11988 "fp" performs the operation in floating point.  This has a very high latency,
11989 but needs only a few instructions, so it might be a good choice if
11990 your code has enough easily exploitable ILP to allow the compiler to
11991 schedule the floating point instructions together with other instructions.
11992 Division by zero causes a floating point exception.
11993 "inv" uses integer operations to calculate the inverse of the divisor,
11994 and then multiplies the dividend with the inverse.  This strategy allows
11995 cse and hoisting of the inverse calculation.  Division by zero calculates
11996 an unspecified result, but does not trap.
11997 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11998 have been found, or if the entire operation has been hoisted to the same
11999 place, the last stages of the inverse calculation are intertwined with the
12000 final multiply to reduce the overall latency, at the expense of using a few
12001 more instructions, and thus offering fewer scheduling opportunities with
12002 other code.
12003 "call" calls a library function that usually implements the inv:minlat
12004 strategy.
12005 This gives high code density for m5-*media-nofpu compilations.
12006 "call2" uses a different entry point of the same library function, where it
12007 assumes that a pointer to a lookup table has already been set up, which
12008 exposes the pointer load to cse / code hoisting optimizations.
12009 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
12010 code generation, but if the code stays unoptimized, revert to the "call",
12011 "call2", or "fp" strategies, respectively.  Note that the
12012 potentially-trapping side effect of division by zero is carried by a
12013 separate instruction, so it is possible that all the integer instructions
12014 are hoisted out, but the marker for the side effect stays where it is.
12015 A recombination to fp operations or a call is not possible in that case.
12016 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
12017 that the inverse calculation was nor separated from the multiply, they speed
12018 up division where the dividend fits into 20 bits (plus sign where applicable),
12019 by inserting a test to skip a number of operations in this case; this test
12020 slows down the case of larger dividends.  inv20u assumes the case of a such
12021 a small dividend to be unlikely, and inv20l assumes it to be likely.
12023 @item -mdivsi3_libfunc=@var{name}
12024 @opindex mdivsi3_libfunc=@var{name}
12025 Set the name of the library function used for 32 bit signed division to
12026 @var{name}.  This only affect the name used in the call and inv:call
12027 division strategies, and the compiler will still expect the same
12028 sets of input/output/clobbered registers as if this option was not present.
12030 @item -madjust-unroll
12031 @opindex madjust-unroll
12032 Throttle unrolling to avoid thrashing target registers.
12033 This option only has an effect if the gcc code base supports the
12034 TARGET_ADJUST_UNROLL_MAX target hook.
12036 @item -mindexed-addressing
12037 @opindex mindexed-addressing
12038 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12039 This is only safe if the hardware and/or OS implement 32 bit wrap-around
12040 semantics for the indexed addressing mode.  The architecture allows the
12041 implementation of processors with 64 bit MMU, which the OS could use to
12042 get 32 bit addressing, but since no current hardware implementation supports
12043 this or any other way to make the indexed addressing mode safe to use in
12044 the 32 bit ABI, the default is -mno-indexed-addressing.
12046 @item -mgettrcost=@var{number}
12047 @opindex mgettrcost=@var{number}
12048 Set the cost assumed for the gettr instruction to @var{number}.
12049 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12051 @item -mpt-fixed
12052 @opindex mpt-fixed
12053 Assume pt* instructions won't trap.  This will generally generate better
12054 scheduled code, but is unsafe on current hardware.  The current architecture
12055 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12056 This has the unintentional effect of making it unsafe to schedule ptabs /
12057 ptrel before a branch, or hoist it out of a loop.  For example,
12058 __do_global_ctors, a part of libgcc that runs constructors at program
12059 startup, calls functions in a list which is delimited by -1.  With the
12060 -mpt-fixed option, the ptabs will be done before testing against -1.
12061 That means that all the constructors will be run a bit quicker, but when
12062 the loop comes to the end of the list, the program crashes because ptabs
12063 loads -1 into a target register.  Since this option is unsafe for any
12064 hardware implementing the current architecture specification, the default
12065 is -mno-pt-fixed.  Unless the user specifies a specific cost with
12066 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12067 this deters register allocation using target registers for storing
12068 ordinary integers.
12070 @item -minvalid-symbols
12071 @opindex minvalid-symbols
12072 Assume symbols might be invalid.  Ordinary function symbols generated by
12073 the compiler will always be valid to load with movi/shori/ptabs or
12074 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12075 to generate symbols that will cause ptabs / ptrel to trap.
12076 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12077 It will then prevent cross-basic-block cse, hoisting and most scheduling
12078 of symbol loads.  The default is @option{-mno-invalid-symbols}.
12079 @end table
12081 @node SPARC Options
12082 @subsection SPARC Options
12083 @cindex SPARC options
12085 These @samp{-m} options are supported on the SPARC:
12087 @table @gcctabopt
12088 @item -mno-app-regs
12089 @itemx -mapp-regs
12090 @opindex mno-app-regs
12091 @opindex mapp-regs
12092 Specify @option{-mapp-regs} to generate output using the global registers
12093 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12094 is the default.
12096 To be fully SVR4 ABI compliant at the cost of some performance loss,
12097 specify @option{-mno-app-regs}.  You should compile libraries and system
12098 software with this option.
12100 @item -mfpu
12101 @itemx -mhard-float
12102 @opindex mfpu
12103 @opindex mhard-float
12104 Generate output containing floating point instructions.  This is the
12105 default.
12107 @item -mno-fpu
12108 @itemx -msoft-float
12109 @opindex mno-fpu
12110 @opindex msoft-float
12111 Generate output containing library calls for floating point.
12112 @strong{Warning:} the requisite libraries are not available for all SPARC
12113 targets.  Normally the facilities of the machine's usual C compiler are
12114 used, but this cannot be done directly in cross-compilation.  You must make
12115 your own arrangements to provide suitable library functions for
12116 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12117 @samp{sparclite-*-*} do provide software floating point support.
12119 @option{-msoft-float} changes the calling convention in the output file;
12120 therefore, it is only useful if you compile @emph{all} of a program with
12121 this option.  In particular, you need to compile @file{libgcc.a}, the
12122 library that comes with GCC, with @option{-msoft-float} in order for
12123 this to work.
12125 @item -mhard-quad-float
12126 @opindex mhard-quad-float
12127 Generate output containing quad-word (long double) floating point
12128 instructions.
12130 @item -msoft-quad-float
12131 @opindex msoft-quad-float
12132 Generate output containing library calls for quad-word (long double)
12133 floating point instructions.  The functions called are those specified
12134 in the SPARC ABI@.  This is the default.
12136 As of this writing, there are no SPARC implementations that have hardware
12137 support for the quad-word floating point instructions.  They all invoke
12138 a trap handler for one of these instructions, and then the trap handler
12139 emulates the effect of the instruction.  Because of the trap handler overhead,
12140 this is much slower than calling the ABI library routines.  Thus the
12141 @option{-msoft-quad-float} option is the default.
12143 @item -mno-unaligned-doubles
12144 @itemx -munaligned-doubles
12145 @opindex mno-unaligned-doubles
12146 @opindex munaligned-doubles
12147 Assume that doubles have 8 byte alignment.  This is the default.
12149 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12150 alignment only if they are contained in another type, or if they have an
12151 absolute address.  Otherwise, it assumes they have 4 byte alignment.
12152 Specifying this option avoids some rare compatibility problems with code
12153 generated by other compilers.  It is not the default because it results
12154 in a performance loss, especially for floating point code.
12156 @item -mno-faster-structs
12157 @itemx -mfaster-structs
12158 @opindex mno-faster-structs
12159 @opindex mfaster-structs
12160 With @option{-mfaster-structs}, the compiler assumes that structures
12161 should have 8 byte alignment.  This enables the use of pairs of
12162 @code{ldd} and @code{std} instructions for copies in structure
12163 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12164 However, the use of this changed alignment directly violates the SPARC
12165 ABI@.  Thus, it's intended only for use on targets where the developer
12166 acknowledges that their resulting code will not be directly in line with
12167 the rules of the ABI@.
12169 @item -mimpure-text
12170 @opindex mimpure-text
12171 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12172 the compiler to not pass @option{-z text} to the linker when linking a
12173 shared object.  Using this option, you can link position-dependent
12174 code into a shared object.
12176 @option{-mimpure-text} suppresses the ``relocations remain against
12177 allocatable but non-writable sections'' linker error message.
12178 However, the necessary relocations will trigger copy-on-write, and the
12179 shared object is not actually shared across processes.  Instead of
12180 using @option{-mimpure-text}, you should compile all source code with
12181 @option{-fpic} or @option{-fPIC}.
12183 This option is only available on SunOS and Solaris.
12185 @item -mcpu=@var{cpu_type}
12186 @opindex mcpu
12187 Set the instruction set, register set, and instruction scheduling parameters
12188 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12189 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12190 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12191 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
12192 @samp{ultrasparc3}.
12194 Default instruction scheduling parameters are used for values that select
12195 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12196 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12198 Here is a list of each supported architecture and their supported
12199 implementations.
12201 @smallexample
12202     v7:             cypress
12203     v8:             supersparc, hypersparc
12204     sparclite:      f930, f934, sparclite86x
12205     sparclet:       tsc701
12206     v9:             ultrasparc, ultrasparc3
12207 @end smallexample
12209 By default (unless configured otherwise), GCC generates code for the V7
12210 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
12211 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12212 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12213 SPARCStation 1, 2, IPX etc.
12215 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12216 architecture.  The only difference from V7 code is that the compiler emits
12217 the integer multiply and integer divide instructions which exist in SPARC-V8
12218 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12219 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12220 2000 series.
12222 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12223 the SPARC architecture.  This adds the integer multiply, integer divide step
12224 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12225 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12226 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12227 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12228 MB86934 chip, which is the more recent SPARClite with FPU@.
12230 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12231 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12232 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12233 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12234 optimizes it for the TEMIC SPARClet chip.
12236 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12237 architecture.  This adds 64-bit integer and floating-point move instructions,
12238 3 additional floating-point condition code registers and conditional move
12239 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12240 optimizes it for the Sun UltraSPARC I/II chips.  With
12241 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12242 Sun UltraSPARC III chip.
12244 @item -mtune=@var{cpu_type}
12245 @opindex mtune
12246 Set the instruction scheduling parameters for machine type
12247 @var{cpu_type}, but do not set the instruction set or register set that the
12248 option @option{-mcpu=@var{cpu_type}} would.
12250 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12251 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12252 that select a particular cpu implementation.  Those are @samp{cypress},
12253 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12254 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
12255 @samp{ultrasparc3}.
12257 @item -mv8plus
12258 @itemx -mno-v8plus
12259 @opindex mv8plus
12260 @opindex mno-v8plus
12261 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12262 difference from the V8 ABI is that the global and out registers are
12263 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12264 mode for all SPARC-V9 processors.
12266 @item -mvis
12267 @itemx -mno-vis
12268 @opindex mvis
12269 @opindex mno-vis
12270 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12271 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12272 @end table
12274 These @samp{-m} options are supported in addition to the above
12275 on SPARC-V9 processors in 64-bit environments:
12277 @table @gcctabopt
12278 @item -mlittle-endian
12279 @opindex mlittle-endian
12280 Generate code for a processor running in little-endian mode.  It is only
12281 available for a few configurations and most notably not on Solaris and Linux.
12283 @item -m32
12284 @itemx -m64
12285 @opindex m32
12286 @opindex m64
12287 Generate code for a 32-bit or 64-bit environment.
12288 The 32-bit environment sets int, long and pointer to 32 bits.
12289 The 64-bit environment sets int to 32 bits and long and pointer
12290 to 64 bits.
12292 @item -mcmodel=medlow
12293 @opindex mcmodel=medlow
12294 Generate code for the Medium/Low code model: 64-bit addresses, programs
12295 must be linked in the low 32 bits of memory.  Programs can be statically
12296 or dynamically linked.
12298 @item -mcmodel=medmid
12299 @opindex mcmodel=medmid
12300 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12301 must be linked in the low 44 bits of memory, the text and data segments must
12302 be less than 2GB in size and the data segment must be located within 2GB of
12303 the text segment.
12305 @item -mcmodel=medany
12306 @opindex mcmodel=medany
12307 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12308 may be linked anywhere in memory, the text and data segments must be less
12309 than 2GB in size and the data segment must be located within 2GB of the
12310 text segment.
12312 @item -mcmodel=embmedany
12313 @opindex mcmodel=embmedany
12314 Generate code for the Medium/Anywhere code model for embedded systems:
12315 64-bit addresses, the text and data segments must be less than 2GB in
12316 size, both starting anywhere in memory (determined at link time).  The
12317 global register %g4 points to the base of the data segment.  Programs
12318 are statically linked and PIC is not supported.
12320 @item -mstack-bias
12321 @itemx -mno-stack-bias
12322 @opindex mstack-bias
12323 @opindex mno-stack-bias
12324 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12325 frame pointer if present, are offset by @minus{}2047 which must be added back
12326 when making stack frame references.  This is the default in 64-bit mode.
12327 Otherwise, assume no such offset is present.
12328 @end table
12330 These switches are supported in addition to the above on Solaris:
12332 @table @gcctabopt
12333 @item -threads
12334 @opindex threads
12335 Add support for multithreading using the Solaris threads library.  This
12336 option sets flags for both the preprocessor and linker.  This option does
12337 not affect the thread safety of object code produced by the compiler or
12338 that of libraries supplied with it.
12340 @item -pthreads
12341 @opindex pthreads
12342 Add support for multithreading using the POSIX threads library.  This
12343 option sets flags for both the preprocessor and linker.  This option does
12344 not affect the thread safety of object code produced  by the compiler or
12345 that of libraries supplied with it.
12347 @item -pthread
12348 @opindex pthread
12349 This is a synonym for @option{-pthreads}.
12350 @end table
12352 @node System V Options
12353 @subsection Options for System V
12355 These additional options are available on System V Release 4 for
12356 compatibility with other compilers on those systems:
12358 @table @gcctabopt
12359 @item -G
12360 @opindex G
12361 Create a shared object.
12362 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12364 @item -Qy
12365 @opindex Qy
12366 Identify the versions of each tool used by the compiler, in a
12367 @code{.ident} assembler directive in the output.
12369 @item -Qn
12370 @opindex Qn
12371 Refrain from adding @code{.ident} directives to the output file (this is
12372 the default).
12374 @item -YP,@var{dirs}
12375 @opindex YP
12376 Search the directories @var{dirs}, and no others, for libraries
12377 specified with @option{-l}.
12379 @item -Ym,@var{dir}
12380 @opindex Ym
12381 Look in the directory @var{dir} to find the M4 preprocessor.
12382 The assembler uses this option.
12383 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12384 @c the generic assembler that comes with Solaris takes just -Ym.
12385 @end table
12387 @node TMS320C3x/C4x Options
12388 @subsection TMS320C3x/C4x Options
12389 @cindex TMS320C3x/C4x Options
12391 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12393 @table @gcctabopt
12395 @item -mcpu=@var{cpu_type}
12396 @opindex mcpu
12397 Set the instruction set, register set, and instruction scheduling
12398 parameters for machine type @var{cpu_type}.  Supported values for
12399 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12400 @samp{c44}.  The default is @samp{c40} to generate code for the
12401 TMS320C40.
12403 @item -mbig-memory
12404 @itemx -mbig
12405 @itemx -msmall-memory
12406 @itemx -msmall
12407 @opindex mbig-memory
12408 @opindex mbig
12409 @opindex msmall-memory
12410 @opindex msmall
12411 Generates code for the big or small memory model.  The small memory
12412 model assumed that all data fits into one 64K word page.  At run-time
12413 the data page (DP) register must be set to point to the 64K page
12414 containing the .bss and .data program sections.  The big memory model is
12415 the default and requires reloading of the DP register for every direct
12416 memory access.
12418 @item -mbk
12419 @itemx -mno-bk
12420 @opindex mbk
12421 @opindex mno-bk
12422 Allow (disallow) allocation of general integer operands into the block
12423 count register BK@.
12425 @item -mdb
12426 @itemx -mno-db
12427 @opindex mdb
12428 @opindex mno-db
12429 Enable (disable) generation of code using decrement and branch,
12430 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12431 on the safe side, this is disabled for the C3x, since the maximum
12432 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12433 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12434 that it can utilize the decrement and branch instruction, but will give
12435 up if there is more than one memory reference in the loop.  Thus a loop
12436 where the loop counter is decremented can generate slightly more
12437 efficient code, in cases where the RPTB instruction cannot be utilized.
12439 @item -mdp-isr-reload
12440 @itemx -mparanoid
12441 @opindex mdp-isr-reload
12442 @opindex mparanoid
12443 Force the DP register to be saved on entry to an interrupt service
12444 routine (ISR), reloaded to point to the data section, and restored on
12445 exit from the ISR@.  This should not be required unless someone has
12446 violated the small memory model by modifying the DP register, say within
12447 an object library.
12449 @item -mmpyi
12450 @itemx -mno-mpyi
12451 @opindex mmpyi
12452 @opindex mno-mpyi
12453 For the C3x use the 24-bit MPYI instruction for integer multiplies
12454 instead of a library call to guarantee 32-bit results.  Note that if one
12455 of the operands is a constant, then the multiplication will be performed
12456 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12457 then squaring operations are performed inline instead of a library call.
12459 @item -mfast-fix
12460 @itemx -mno-fast-fix
12461 @opindex mfast-fix
12462 @opindex mno-fast-fix
12463 The C3x/C4x FIX instruction to convert a floating point value to an
12464 integer value chooses the nearest integer less than or equal to the
12465 floating point value rather than to the nearest integer.  Thus if the
12466 floating point number is negative, the result will be incorrectly
12467 truncated an additional code is necessary to detect and correct this
12468 case.  This option can be used to disable generation of the additional
12469 code required to correct the result.
12471 @item -mrptb
12472 @itemx -mno-rptb
12473 @opindex mrptb
12474 @opindex mno-rptb
12475 Enable (disable) generation of repeat block sequences using the RPTB
12476 instruction for zero overhead looping.  The RPTB construct is only used
12477 for innermost loops that do not call functions or jump across the loop
12478 boundaries.  There is no advantage having nested RPTB loops due to the
12479 overhead required to save and restore the RC, RS, and RE registers.
12480 This is enabled by default with @option{-O2}.
12482 @item -mrpts=@var{count}
12483 @itemx -mno-rpts
12484 @opindex mrpts
12485 @opindex mno-rpts
12486 Enable (disable) the use of the single instruction repeat instruction
12487 RPTS@.  If a repeat block contains a single instruction, and the loop
12488 count can be guaranteed to be less than the value @var{count}, GCC will
12489 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12490 then a RPTS will be emitted even if the loop count cannot be determined
12491 at compile time.  Note that the repeated instruction following RPTS does
12492 not have to be reloaded from memory each iteration, thus freeing up the
12493 CPU buses for operands.  However, since interrupts are blocked by this
12494 instruction, it is disabled by default.
12496 @item -mloop-unsigned
12497 @itemx -mno-loop-unsigned
12498 @opindex mloop-unsigned
12499 @opindex mno-loop-unsigned
12500 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12501 is @math{2^{31} + 1} since these instructions test if the iteration count is
12502 negative to terminate the loop.  If the iteration count is unsigned
12503 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12504 exceeded.  This switch allows an unsigned iteration count.
12506 @item -mti
12507 @opindex mti
12508 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12509 with.  This also enforces compatibility with the API employed by the TI
12510 C3x C compiler.  For example, long doubles are passed as structures
12511 rather than in floating point registers.
12513 @item -mregparm
12514 @itemx -mmemparm
12515 @opindex mregparm
12516 @opindex mmemparm
12517 Generate code that uses registers (stack) for passing arguments to functions.
12518 By default, arguments are passed in registers where possible rather
12519 than by pushing arguments on to the stack.
12521 @item -mparallel-insns
12522 @itemx -mno-parallel-insns
12523 @opindex mparallel-insns
12524 @opindex mno-parallel-insns
12525 Allow the generation of parallel instructions.  This is enabled by
12526 default with @option{-O2}.
12528 @item -mparallel-mpy
12529 @itemx -mno-parallel-mpy
12530 @opindex mparallel-mpy
12531 @opindex mno-parallel-mpy
12532 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12533 provided @option{-mparallel-insns} is also specified.  These instructions have
12534 tight register constraints which can pessimize the code generation
12535 of large functions.
12537 @end table
12539 @node V850 Options
12540 @subsection V850 Options
12541 @cindex V850 Options
12543 These @samp{-m} options are defined for V850 implementations:
12545 @table @gcctabopt
12546 @item -mlong-calls
12547 @itemx -mno-long-calls
12548 @opindex mlong-calls
12549 @opindex mno-long-calls
12550 Treat all calls as being far away (near).  If calls are assumed to be
12551 far away, the compiler will always load the functions address up into a
12552 register, and call indirect through the pointer.
12554 @item -mno-ep
12555 @itemx -mep
12556 @opindex mno-ep
12557 @opindex mep
12558 Do not optimize (do optimize) basic blocks that use the same index
12559 pointer 4 or more times to copy pointer into the @code{ep} register, and
12560 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12561 option is on by default if you optimize.
12563 @item -mno-prolog-function
12564 @itemx -mprolog-function
12565 @opindex mno-prolog-function
12566 @opindex mprolog-function
12567 Do not use (do use) external functions to save and restore registers
12568 at the prologue and epilogue of a function.  The external functions
12569 are slower, but use less code space if more than one function saves
12570 the same number of registers.  The @option{-mprolog-function} option
12571 is on by default if you optimize.
12573 @item -mspace
12574 @opindex mspace
12575 Try to make the code as small as possible.  At present, this just turns
12576 on the @option{-mep} and @option{-mprolog-function} options.
12578 @item -mtda=@var{n}
12579 @opindex mtda
12580 Put static or global variables whose size is @var{n} bytes or less into
12581 the tiny data area that register @code{ep} points to.  The tiny data
12582 area can hold up to 256 bytes in total (128 bytes for byte references).
12584 @item -msda=@var{n}
12585 @opindex msda
12586 Put static or global variables whose size is @var{n} bytes or less into
12587 the small data area that register @code{gp} points to.  The small data
12588 area can hold up to 64 kilobytes.
12590 @item -mzda=@var{n}
12591 @opindex mzda
12592 Put static or global variables whose size is @var{n} bytes or less into
12593 the first 32 kilobytes of memory.
12595 @item -mv850
12596 @opindex mv850
12597 Specify that the target processor is the V850.
12599 @item -mbig-switch
12600 @opindex mbig-switch
12601 Generate code suitable for big switch tables.  Use this option only if
12602 the assembler/linker complain about out of range branches within a switch
12603 table.
12605 @item -mapp-regs
12606 @opindex mapp-regs
12607 This option will cause r2 and r5 to be used in the code generated by
12608 the compiler.  This setting is the default.
12610 @item -mno-app-regs
12611 @opindex mno-app-regs
12612 This option will cause r2 and r5 to be treated as fixed registers.
12614 @item -mv850e1
12615 @opindex mv850e1
12616 Specify that the target processor is the V850E1.  The preprocessor
12617 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12618 this option is used.
12620 @item -mv850e
12621 @opindex mv850e
12622 Specify that the target processor is the V850E@.  The preprocessor
12623 constant @samp{__v850e__} will be defined if this option is used.
12625 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12626 are defined then a default target processor will be chosen and the
12627 relevant @samp{__v850*__} preprocessor constant will be defined.
12629 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12630 defined, regardless of which processor variant is the target.
12632 @item -mdisable-callt
12633 @opindex mdisable-callt
12634 This option will suppress generation of the CALLT instruction for the
12635 v850e and v850e1 flavors of the v850 architecture.  The default is
12636 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12638 @end table
12640 @node VAX Options
12641 @subsection VAX Options
12642 @cindex VAX options
12644 These @samp{-m} options are defined for the VAX:
12646 @table @gcctabopt
12647 @item -munix
12648 @opindex munix
12649 Do not output certain jump instructions (@code{aobleq} and so on)
12650 that the Unix assembler for the VAX cannot handle across long
12651 ranges.
12653 @item -mgnu
12654 @opindex mgnu
12655 Do output those jump instructions, on the assumption that you
12656 will assemble with the GNU assembler.
12658 @item -mg
12659 @opindex mg
12660 Output code for g-format floating point numbers instead of d-format.
12661 @end table
12663 @node x86-64 Options
12664 @subsection x86-64 Options
12665 @cindex x86-64 options
12667 These are listed under @xref{i386 and x86-64 Options}.
12669 @node Xstormy16 Options
12670 @subsection Xstormy16 Options
12671 @cindex Xstormy16 Options
12673 These options are defined for Xstormy16:
12675 @table @gcctabopt
12676 @item -msim
12677 @opindex msim
12678 Choose startup files and linker script suitable for the simulator.
12679 @end table
12681 @node Xtensa Options
12682 @subsection Xtensa Options
12683 @cindex Xtensa Options
12685 These options are supported for Xtensa targets:
12687 @table @gcctabopt
12688 @item -mconst16
12689 @itemx -mno-const16
12690 @opindex mconst16
12691 @opindex mno-const16
12692 Enable or disable use of @code{CONST16} instructions for loading
12693 constant values.  The @code{CONST16} instruction is currently not a
12694 standard option from Tensilica.  When enabled, @code{CONST16}
12695 instructions are always used in place of the standard @code{L32R}
12696 instructions.  The use of @code{CONST16} is enabled by default only if
12697 the @code{L32R} instruction is not available.
12699 @item -mfused-madd
12700 @itemx -mno-fused-madd
12701 @opindex mfused-madd
12702 @opindex mno-fused-madd
12703 Enable or disable use of fused multiply/add and multiply/subtract
12704 instructions in the floating-point option.  This has no effect if the
12705 floating-point option is not also enabled.  Disabling fused multiply/add
12706 and multiply/subtract instructions forces the compiler to use separate
12707 instructions for the multiply and add/subtract operations.  This may be
12708 desirable in some cases where strict IEEE 754-compliant results are
12709 required: the fused multiply add/subtract instructions do not round the
12710 intermediate result, thereby producing results with @emph{more} bits of
12711 precision than specified by the IEEE standard.  Disabling fused multiply
12712 add/subtract instructions also ensures that the program output is not
12713 sensitive to the compiler's ability to combine multiply and add/subtract
12714 operations.
12716 @item -mtext-section-literals
12717 @itemx -mno-text-section-literals
12718 @opindex mtext-section-literals
12719 @opindex mno-text-section-literals
12720 Control the treatment of literal pools.  The default is
12721 @option{-mno-text-section-literals}, which places literals in a separate
12722 section in the output file.  This allows the literal pool to be placed
12723 in a data RAM/ROM, and it also allows the linker to combine literal
12724 pools from separate object files to remove redundant literals and
12725 improve code size.  With @option{-mtext-section-literals}, the literals
12726 are interspersed in the text section in order to keep them as close as
12727 possible to their references.  This may be necessary for large assembly
12728 files.
12730 @item -mtarget-align
12731 @itemx -mno-target-align
12732 @opindex mtarget-align
12733 @opindex mno-target-align
12734 When this option is enabled, GCC instructs the assembler to
12735 automatically align instructions to reduce branch penalties at the
12736 expense of some code density.  The assembler attempts to widen density
12737 instructions to align branch targets and the instructions following call
12738 instructions.  If there are not enough preceding safe density
12739 instructions to align a target, no widening will be performed.  The
12740 default is @option{-mtarget-align}.  These options do not affect the
12741 treatment of auto-aligned instructions like @code{LOOP}, which the
12742 assembler will always align, either by widening density instructions or
12743 by inserting no-op instructions.
12745 @item -mlongcalls
12746 @itemx -mno-longcalls
12747 @opindex mlongcalls
12748 @opindex mno-longcalls
12749 When this option is enabled, GCC instructs the assembler to translate
12750 direct calls to indirect calls unless it can determine that the target
12751 of a direct call is in the range allowed by the call instruction.  This
12752 translation typically occurs for calls to functions in other source
12753 files.  Specifically, the assembler translates a direct @code{CALL}
12754 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12755 The default is @option{-mno-longcalls}.  This option should be used in
12756 programs where the call target can potentially be out of range.  This
12757 option is implemented in the assembler, not the compiler, so the
12758 assembly code generated by GCC will still show direct call
12759 instructions---look at the disassembled object code to see the actual
12760 instructions.  Note that the assembler will use an indirect call for
12761 every cross-file call, not just those that really will be out of range.
12762 @end table
12764 @node zSeries Options
12765 @subsection zSeries Options
12766 @cindex zSeries options
12768 These are listed under @xref{S/390 and zSeries Options}.
12770 @node Code Gen Options
12771 @section Options for Code Generation Conventions
12772 @cindex code generation conventions
12773 @cindex options, code generation
12774 @cindex run-time options
12776 These machine-independent options control the interface conventions
12777 used in code generation.
12779 Most of them have both positive and negative forms; the negative form
12780 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12781 one of the forms is listed---the one which is not the default.  You
12782 can figure out the other form by either removing @samp{no-} or adding
12785 @table @gcctabopt
12786 @item -fbounds-check
12787 @opindex fbounds-check
12788 For front-ends that support it, generate additional code to check that
12789 indices used to access arrays are within the declared range.  This is
12790 currently only supported by the Java and Fortran front-ends, where
12791 this option defaults to true and false respectively.
12793 @item -ftrapv
12794 @opindex ftrapv
12795 This option generates traps for signed overflow on addition, subtraction,
12796 multiplication operations.
12798 @item -fwrapv
12799 @opindex fwrapv
12800 This option instructs the compiler to assume that signed arithmetic
12801 overflow of addition, subtraction and multiplication wraps around
12802 using twos-complement representation.  This flag enables some optimizations
12803 and disables others.  This option is enabled by default for the Java
12804 front-end, as required by the Java language specification.
12806 @item -fexceptions
12807 @opindex fexceptions
12808 Enable exception handling.  Generates extra code needed to propagate
12809 exceptions.  For some targets, this implies GCC will generate frame
12810 unwind information for all functions, which can produce significant data
12811 size overhead, although it does not affect execution.  If you do not
12812 specify this option, GCC will enable it by default for languages like
12813 C++ which normally require exception handling, and disable it for
12814 languages like C that do not normally require it.  However, you may need
12815 to enable this option when compiling C code that needs to interoperate
12816 properly with exception handlers written in C++.  You may also wish to
12817 disable this option if you are compiling older C++ programs that don't
12818 use exception handling.
12820 @item -fnon-call-exceptions
12821 @opindex fnon-call-exceptions
12822 Generate code that allows trapping instructions to throw exceptions.
12823 Note that this requires platform-specific runtime support that does
12824 not exist everywhere.  Moreover, it only allows @emph{trapping}
12825 instructions to throw exceptions, i.e.@: memory references or floating
12826 point instructions.  It does not allow exceptions to be thrown from
12827 arbitrary signal handlers such as @code{SIGALRM}.
12829 @item -funwind-tables
12830 @opindex funwind-tables
12831 Similar to @option{-fexceptions}, except that it will just generate any needed
12832 static data, but will not affect the generated code in any other way.
12833 You will normally not enable this option; instead, a language processor
12834 that needs this handling would enable it on your behalf.
12836 @item -fasynchronous-unwind-tables
12837 @opindex fasynchronous-unwind-tables
12838 Generate unwind table in dwarf2 format, if supported by target machine.  The
12839 table is exact at each instruction boundary, so it can be used for stack
12840 unwinding from asynchronous events (such as debugger or garbage collector).
12842 @item -fpcc-struct-return
12843 @opindex fpcc-struct-return
12844 Return ``short'' @code{struct} and @code{union} values in memory like
12845 longer ones, rather than in registers.  This convention is less
12846 efficient, but it has the advantage of allowing intercallability between
12847 GCC-compiled files and files compiled with other compilers, particularly
12848 the Portable C Compiler (pcc).
12850 The precise convention for returning structures in memory depends
12851 on the target configuration macros.
12853 Short structures and unions are those whose size and alignment match
12854 that of some integer type.
12856 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12857 switch is not binary compatible with code compiled with the
12858 @option{-freg-struct-return} switch.
12859 Use it to conform to a non-default application binary interface.
12861 @item -freg-struct-return
12862 @opindex freg-struct-return
12863 Return @code{struct} and @code{union} values in registers when possible.
12864 This is more efficient for small structures than
12865 @option{-fpcc-struct-return}.
12867 If you specify neither @option{-fpcc-struct-return} nor
12868 @option{-freg-struct-return}, GCC defaults to whichever convention is
12869 standard for the target.  If there is no standard convention, GCC
12870 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12871 the principal compiler.  In those cases, we can choose the standard, and
12872 we chose the more efficient register return alternative.
12874 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12875 switch is not binary compatible with code compiled with the
12876 @option{-fpcc-struct-return} switch.
12877 Use it to conform to a non-default application binary interface.
12879 @item -fshort-enums
12880 @opindex fshort-enums
12881 Allocate to an @code{enum} type only as many bytes as it needs for the
12882 declared range of possible values.  Specifically, the @code{enum} type
12883 will be equivalent to the smallest integer type which has enough room.
12885 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12886 code that is not binary compatible with code generated without that switch.
12887 Use it to conform to a non-default application binary interface.
12889 @item -fshort-double
12890 @opindex fshort-double
12891 Use the same size for @code{double} as for @code{float}.
12893 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12894 code that is not binary compatible with code generated without that switch.
12895 Use it to conform to a non-default application binary interface.
12897 @item -fshort-wchar
12898 @opindex fshort-wchar
12899 Override the underlying type for @samp{wchar_t} to be @samp{short
12900 unsigned int} instead of the default for the target.  This option is
12901 useful for building programs to run under WINE@.
12903 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12904 code that is not binary compatible with code generated without that switch.
12905 Use it to conform to a non-default application binary interface.
12907 @item -fshared-data
12908 @opindex fshared-data
12909 Requests that the data and non-@code{const} variables of this
12910 compilation be shared data rather than private data.  The distinction
12911 makes sense only on certain operating systems, where shared data is
12912 shared between processes running the same program, while private data
12913 exists in one copy per process.
12915 @item -fno-common
12916 @opindex fno-common
12917 In C, allocate even uninitialized global variables in the data section of the
12918 object file, rather than generating them as common blocks.  This has the
12919 effect that if the same variable is declared (without @code{extern}) in
12920 two different compilations, you will get an error when you link them.
12921 The only reason this might be useful is if you wish to verify that the
12922 program will work on other systems which always work this way.
12924 @item -fno-ident
12925 @opindex fno-ident
12926 Ignore the @samp{#ident} directive.
12928 @item -finhibit-size-directive
12929 @opindex finhibit-size-directive
12930 Don't output a @code{.size} assembler directive, or anything else that
12931 would cause trouble if the function is split in the middle, and the
12932 two halves are placed at locations far apart in memory.  This option is
12933 used when compiling @file{crtstuff.c}; you should not need to use it
12934 for anything else.
12936 @item -fverbose-asm
12937 @opindex fverbose-asm
12938 Put extra commentary information in the generated assembly code to
12939 make it more readable.  This option is generally only of use to those
12940 who actually need to read the generated assembly code (perhaps while
12941 debugging the compiler itself).
12943 @option{-fno-verbose-asm}, the default, causes the
12944 extra information to be omitted and is useful when comparing two assembler
12945 files.
12947 @item -fpic
12948 @opindex fpic
12949 @cindex global offset table
12950 @cindex PIC
12951 Generate position-independent code (PIC) suitable for use in a shared
12952 library, if supported for the target machine.  Such code accesses all
12953 constant addresses through a global offset table (GOT)@.  The dynamic
12954 loader resolves the GOT entries when the program starts (the dynamic
12955 loader is not part of GCC; it is part of the operating system).  If
12956 the GOT size for the linked executable exceeds a machine-specific
12957 maximum size, you get an error message from the linker indicating that
12958 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12959 instead.  (These maximums are 8k on the SPARC and 32k
12960 on the m68k and RS/6000.  The 386 has no such limit.)
12962 Position-independent code requires special support, and therefore works
12963 only on certain machines.  For the 386, GCC supports PIC for System V
12964 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12965 position-independent.
12967 @item -fPIC
12968 @opindex fPIC
12969 If supported for the target machine, emit position-independent code,
12970 suitable for dynamic linking and avoiding any limit on the size of the
12971 global offset table.  This option makes a difference on the m68k,
12972 PowerPC and SPARC@.
12974 Position-independent code requires special support, and therefore works
12975 only on certain machines.
12977 @item -fpie
12978 @itemx -fPIE
12979 @opindex fpie
12980 @opindex fPIE
12981 These options are similar to @option{-fpic} and @option{-fPIC}, but
12982 generated position independent code can be only linked into executables.
12983 Usually these options are used when @option{-pie} GCC option will be
12984 used during linking.
12986 @item -fno-jump-tables
12987 @opindex fno-jump-tables
12988 Do not use jump tables for switch statements even where it would be
12989 more efficient than other code generation strategies.  This option is
12990 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12991 building code which forms part of a dynamic linker and cannot
12992 reference the address of a jump table.  On some targets, jump tables
12993 do not require a GOT and this option is not needed.
12995 @item -ffixed-@var{reg}
12996 @opindex ffixed
12997 Treat the register named @var{reg} as a fixed register; generated code
12998 should never refer to it (except perhaps as a stack pointer, frame
12999 pointer or in some other fixed role).
13001 @var{reg} must be the name of a register.  The register names accepted
13002 are machine-specific and are defined in the @code{REGISTER_NAMES}
13003 macro in the machine description macro file.
13005 This flag does not have a negative form, because it specifies a
13006 three-way choice.
13008 @item -fcall-used-@var{reg}
13009 @opindex fcall-used
13010 Treat the register named @var{reg} as an allocable register that is
13011 clobbered by function calls.  It may be allocated for temporaries or
13012 variables that do not live across a call.  Functions compiled this way
13013 will not save and restore the register @var{reg}.
13015 It is an error to used this flag with the frame pointer or stack pointer.
13016 Use of this flag for other registers that have fixed pervasive roles in
13017 the machine's execution model will produce disastrous results.
13019 This flag does not have a negative form, because it specifies a
13020 three-way choice.
13022 @item -fcall-saved-@var{reg}
13023 @opindex fcall-saved
13024 Treat the register named @var{reg} as an allocable register saved by
13025 functions.  It may be allocated even for temporaries or variables that
13026 live across a call.  Functions compiled this way will save and restore
13027 the register @var{reg} if they use it.
13029 It is an error to used this flag with the frame pointer or stack pointer.
13030 Use of this flag for other registers that have fixed pervasive roles in
13031 the machine's execution model will produce disastrous results.
13033 A different sort of disaster will result from the use of this flag for
13034 a register in which function values may be returned.
13036 This flag does not have a negative form, because it specifies a
13037 three-way choice.
13039 @item -fpack-struct[=@var{n}]
13040 @opindex fpack-struct
13041 Without a value specified, pack all structure members together without
13042 holes.  When a value is specified (which must be a small power of two), pack
13043 structure members according to this value, representing the maximum
13044 alignment (that is, objects with default alignment requirements larger than
13045 this will be output potentially unaligned at the next fitting location.
13047 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13048 code that is not binary compatible with code generated without that switch.
13049 Additionally, it makes the code suboptimal.
13050 Use it to conform to a non-default application binary interface.
13052 @item -finstrument-functions
13053 @opindex finstrument-functions
13054 Generate instrumentation calls for entry and exit to functions.  Just
13055 after function entry and just before function exit, the following
13056 profiling functions will be called with the address of the current
13057 function and its call site.  (On some platforms,
13058 @code{__builtin_return_address} does not work beyond the current
13059 function, so the call site information may not be available to the
13060 profiling functions otherwise.)
13062 @smallexample
13063 void __cyg_profile_func_enter (void *this_fn,
13064                                void *call_site);
13065 void __cyg_profile_func_exit  (void *this_fn,
13066                                void *call_site);
13067 @end smallexample
13069 The first argument is the address of the start of the current function,
13070 which may be looked up exactly in the symbol table.
13072 This instrumentation is also done for functions expanded inline in other
13073 functions.  The profiling calls will indicate where, conceptually, the
13074 inline function is entered and exited.  This means that addressable
13075 versions of such functions must be available.  If all your uses of a
13076 function are expanded inline, this may mean an additional expansion of
13077 code size.  If you use @samp{extern inline} in your C code, an
13078 addressable version of such functions must be provided.  (This is
13079 normally the case anyways, but if you get lucky and the optimizer always
13080 expands the functions inline, you might have gotten away without
13081 providing static copies.)
13083 A function may be given the attribute @code{no_instrument_function}, in
13084 which case this instrumentation will not be done.  This can be used, for
13085 example, for the profiling functions listed above, high-priority
13086 interrupt routines, and any functions from which the profiling functions
13087 cannot safely be called (perhaps signal handlers, if the profiling
13088 routines generate output or allocate memory).
13090 @item -fstack-check
13091 @opindex fstack-check
13092 Generate code to verify that you do not go beyond the boundary of the
13093 stack.  You should specify this flag if you are running in an
13094 environment with multiple threads, but only rarely need to specify it in
13095 a single-threaded environment since stack overflow is automatically
13096 detected on nearly all systems if there is only one stack.
13098 Note that this switch does not actually cause checking to be done; the
13099 operating system must do that.  The switch causes generation of code
13100 to ensure that the operating system sees the stack being extended.
13102 @item -fstack-limit-register=@var{reg}
13103 @itemx -fstack-limit-symbol=@var{sym}
13104 @itemx -fno-stack-limit
13105 @opindex fstack-limit-register
13106 @opindex fstack-limit-symbol
13107 @opindex fno-stack-limit
13108 Generate code to ensure that the stack does not grow beyond a certain value,
13109 either the value of a register or the address of a symbol.  If the stack
13110 would grow beyond the value, a signal is raised.  For most targets,
13111 the signal is raised before the stack overruns the boundary, so
13112 it is possible to catch the signal without taking special precautions.
13114 For instance, if the stack starts at absolute address @samp{0x80000000}
13115 and grows downwards, you can use the flags
13116 @option{-fstack-limit-symbol=__stack_limit} and
13117 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13118 of 128KB@.  Note that this may only work with the GNU linker.
13120 @cindex aliasing of parameters
13121 @cindex parameters, aliased
13122 @item -fargument-alias
13123 @itemx -fargument-noalias
13124 @itemx -fargument-noalias-global
13125 @opindex fargument-alias
13126 @opindex fargument-noalias
13127 @opindex fargument-noalias-global
13128 Specify the possible relationships among parameters and between
13129 parameters and global data.
13131 @option{-fargument-alias} specifies that arguments (parameters) may
13132 alias each other and may alias global storage.@*
13133 @option{-fargument-noalias} specifies that arguments do not alias
13134 each other, but may alias global storage.@*
13135 @option{-fargument-noalias-global} specifies that arguments do not
13136 alias each other and do not alias global storage.
13138 Each language will automatically use whatever option is required by
13139 the language standard.  You should not need to use these options yourself.
13141 @item -fleading-underscore
13142 @opindex fleading-underscore
13143 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13144 change the way C symbols are represented in the object file.  One use
13145 is to help link with legacy assembly code.
13147 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13148 generate code that is not binary compatible with code generated without that
13149 switch.  Use it to conform to a non-default application binary interface.
13150 Not all targets provide complete support for this switch.
13152 @item -ftls-model=@var{model}
13153 @opindex ftls-model=@var{model}
13154 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13155 The @var{model} argument should be one of @code{global-dynamic},
13156 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13158 The default without @option{-fpic} is @code{initial-exec}; with
13159 @option{-fpic} the default is @code{global-dynamic}.
13161 @item -fvisibility=@var{default|internal|hidden|protected}
13162 @opindex fvisibility
13163 Set the default ELF image symbol visibility to the specified option---all
13164 symbols will be marked with this unless overridden within the code.
13165 Using this feature can very substantially improve linking and
13166 load times of shared object libraries, produce more optimized
13167 code, provide near-perfect API export and prevent symbol clashes.
13168 It is @strong{strongly} recommended that you use this in any shared objects
13169 you distribute.
13171 Despite the nomenclature, @code{default} always means public ie;
13172 available to be linked against from outside the shared object.
13173 @code{protected} and @code{internal} are pretty useless in real-world
13174 usage so the only other commonly used option will be @code{hidden}.
13175 The default if @option{-fvisibility} isn't specified is
13176 @code{default}, i.e., make every
13177 symbol public---this causes the same behavior as previous versions of
13178 GCC@.
13180 A good explanation of the benefits offered by ensuring ELF
13181 symbols have the correct visibility is given by ``How To Write
13182 Shared Libraries'' by Ulrich Drepper (which can be found at
13183 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13184 solution made possible by this option to marking things hidden when
13185 the default is public is to make the default hidden and mark things
13186 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13187 and @code{__attribute__ ((visibility("default")))} instead of
13188 @code{__declspec(dllexport)} you get almost identical semantics with
13189 identical syntax.  This is a great boon to those working with
13190 cross-platform projects.
13192 For those adding visibility support to existing code, you may find
13193 @samp{#pragma GCC visibility} of use.  This works by you enclosing
13194 the declarations you wish to set visibility for with (for example)
13195 @samp{#pragma GCC visibility push(hidden)} and
13196 @samp{#pragma GCC visibility pop}.
13197 Bear in mind that symbol visibility should be viewed @strong{as
13198 part of the API interface contract} and thus all new code should
13199 always specify visibility when it is not the default ie; declarations
13200 only for use within the local DSO should @strong{always} be marked explicitly
13201 as hidden as so to avoid PLT indirection overheads---making this
13202 abundantly clear also aids readability and self-documentation of the code.
13203 Note that due to ISO C++ specification requirements, operator new and
13204 operator delete must always be of default visibility.
13206 An overview of these techniques, their benefits and how to use them
13207 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13209 @end table
13211 @c man end
13213 @node Environment Variables
13214 @section Environment Variables Affecting GCC
13215 @cindex environment variables
13217 @c man begin ENVIRONMENT
13218 This section describes several environment variables that affect how GCC
13219 operates.  Some of them work by specifying directories or prefixes to use
13220 when searching for various kinds of files.  Some are used to specify other
13221 aspects of the compilation environment.
13223 Note that you can also specify places to search using options such as
13224 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13225 take precedence over places specified using environment variables, which
13226 in turn take precedence over those specified by the configuration of GCC@.
13227 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13228 GNU Compiler Collection (GCC) Internals}.
13230 @table @env
13231 @item LANG
13232 @itemx LC_CTYPE
13233 @c @itemx LC_COLLATE
13234 @itemx LC_MESSAGES
13235 @c @itemx LC_MONETARY
13236 @c @itemx LC_NUMERIC
13237 @c @itemx LC_TIME
13238 @itemx LC_ALL
13239 @findex LANG
13240 @findex LC_CTYPE
13241 @c @findex LC_COLLATE
13242 @findex LC_MESSAGES
13243 @c @findex LC_MONETARY
13244 @c @findex LC_NUMERIC
13245 @c @findex LC_TIME
13246 @findex LC_ALL
13247 @cindex locale
13248 These environment variables control the way that GCC uses
13249 localization information that allow GCC to work with different
13250 national conventions.  GCC inspects the locale categories
13251 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13252 so.  These locale categories can be set to any value supported by your
13253 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13254 Kingdom encoded in UTF-8.
13256 The @env{LC_CTYPE} environment variable specifies character
13257 classification.  GCC uses it to determine the character boundaries in
13258 a string; this is needed for some multibyte encodings that contain quote
13259 and escape characters that would otherwise be interpreted as a string
13260 end or escape.
13262 The @env{LC_MESSAGES} environment variable specifies the language to
13263 use in diagnostic messages.
13265 If the @env{LC_ALL} environment variable is set, it overrides the value
13266 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13267 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13268 environment variable.  If none of these variables are set, GCC
13269 defaults to traditional C English behavior.
13271 @item TMPDIR
13272 @findex TMPDIR
13273 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13274 files.  GCC uses temporary files to hold the output of one stage of
13275 compilation which is to be used as input to the next stage: for example,
13276 the output of the preprocessor, which is the input to the compiler
13277 proper.
13279 @item GCC_EXEC_PREFIX
13280 @findex GCC_EXEC_PREFIX
13281 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13282 names of the subprograms executed by the compiler.  No slash is added
13283 when this prefix is combined with the name of a subprogram, but you can
13284 specify a prefix that ends with a slash if you wish.
13286 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13287 an appropriate prefix to use based on the pathname it was invoked with.
13289 If GCC cannot find the subprogram using the specified prefix, it
13290 tries looking in the usual places for the subprogram.
13292 The default value of @env{GCC_EXEC_PREFIX} is
13293 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13294 of @code{prefix} when you ran the @file{configure} script.
13296 Other prefixes specified with @option{-B} take precedence over this prefix.
13298 This prefix is also used for finding files such as @file{crt0.o} that are
13299 used for linking.
13301 In addition, the prefix is used in an unusual way in finding the
13302 directories to search for header files.  For each of the standard
13303 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13304 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13305 replacing that beginning with the specified prefix to produce an
13306 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13307 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13308 These alternate directories are searched first; the standard directories
13309 come next.
13311 @item COMPILER_PATH
13312 @findex COMPILER_PATH
13313 The value of @env{COMPILER_PATH} is a colon-separated list of
13314 directories, much like @env{PATH}.  GCC tries the directories thus
13315 specified when searching for subprograms, if it can't find the
13316 subprograms using @env{GCC_EXEC_PREFIX}.
13318 @item LIBRARY_PATH
13319 @findex LIBRARY_PATH
13320 The value of @env{LIBRARY_PATH} is a colon-separated list of
13321 directories, much like @env{PATH}.  When configured as a native compiler,
13322 GCC tries the directories thus specified when searching for special
13323 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13324 using GCC also uses these directories when searching for ordinary
13325 libraries for the @option{-l} option (but directories specified with
13326 @option{-L} come first).
13328 @item LANG
13329 @findex LANG
13330 @cindex locale definition
13331 This variable is used to pass locale information to the compiler.  One way in
13332 which this information is used is to determine the character set to be used
13333 when character literals, string literals and comments are parsed in C and C++.
13334 When the compiler is configured to allow multibyte characters,
13335 the following values for @env{LANG} are recognized:
13337 @table @samp
13338 @item C-JIS
13339 Recognize JIS characters.
13340 @item C-SJIS
13341 Recognize SJIS characters.
13342 @item C-EUCJP
13343 Recognize EUCJP characters.
13344 @end table
13346 If @env{LANG} is not defined, or if it has some other value, then the
13347 compiler will use mblen and mbtowc as defined by the default locale to
13348 recognize and translate multibyte characters.
13349 @end table
13351 @noindent
13352 Some additional environments variables affect the behavior of the
13353 preprocessor.
13355 @include cppenv.texi
13357 @c man end
13359 @node Precompiled Headers
13360 @section Using Precompiled Headers
13361 @cindex precompiled headers
13362 @cindex speed of compilation
13364 Often large projects have many header files that are included in every
13365 source file.  The time the compiler takes to process these header files
13366 over and over again can account for nearly all of the time required to
13367 build the project.  To make builds faster, GCC allows users to
13368 `precompile' a header file; then, if builds can use the precompiled
13369 header file they will be much faster.
13371 To create a precompiled header file, simply compile it as you would any
13372 other file, if necessary using the @option{-x} option to make the driver
13373 treat it as a C or C++ header file.  You will probably want to use a
13374 tool like @command{make} to keep the precompiled header up-to-date when
13375 the headers it contains change.
13377 A precompiled header file will be searched for when @code{#include} is
13378 seen in the compilation.  As it searches for the included file
13379 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13380 compiler looks for a precompiled header in each directory just before it
13381 looks for the include file in that directory.  The name searched for is
13382 the name specified in the @code{#include} with @samp{.gch} appended.  If
13383 the precompiled header file can't be used, it is ignored.
13385 For instance, if you have @code{#include "all.h"}, and you have
13386 @file{all.h.gch} in the same directory as @file{all.h}, then the
13387 precompiled header file will be used if possible, and the original
13388 header will be used otherwise.
13390 Alternatively, you might decide to put the precompiled header file in a
13391 directory and use @option{-I} to ensure that directory is searched
13392 before (or instead of) the directory containing the original header.
13393 Then, if you want to check that the precompiled header file is always
13394 used, you can put a file of the same name as the original header in this
13395 directory containing an @code{#error} command.
13397 This also works with @option{-include}.  So yet another way to use
13398 precompiled headers, good for projects not designed with precompiled
13399 header files in mind, is to simply take most of the header files used by
13400 a project, include them from another header file, precompile that header
13401 file, and @option{-include} the precompiled header.  If the header files
13402 have guards against multiple inclusion, they will be skipped because
13403 they've already been included (in the precompiled header).
13405 If you need to precompile the same header file for different
13406 languages, targets, or compiler options, you can instead make a
13407 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13408 header in the directory, perhaps using @option{-o}.  It doesn't matter
13409 what you call the files in the directory, every precompiled header in
13410 the directory will be considered.  The first precompiled header
13411 encountered in the directory that is valid for this compilation will
13412 be used; they're searched in no particular order.
13414 There are many other possibilities, limited only by your imagination,
13415 good sense, and the constraints of your build system.
13417 A precompiled header file can be used only when these conditions apply:
13419 @itemize
13420 @item
13421 Only one precompiled header can be used in a particular compilation.
13423 @item
13424 A precompiled header can't be used once the first C token is seen.  You
13425 can have preprocessor directives before a precompiled header; you can
13426 even include a precompiled header from inside another header, so long as
13427 there are no C tokens before the @code{#include}.
13429 @item
13430 The precompiled header file must be produced for the same language as
13431 the current compilation.  You can't use a C precompiled header for a C++
13432 compilation.
13434 @item
13435 The precompiled header file must have been produced by the same compiler
13436 binary as the current compilation is using.
13438 @item
13439 Any macros defined before the precompiled header is included must
13440 either be defined in the same way as when the precompiled header was
13441 generated, or must not affect the precompiled header, which usually
13442 means that they don't appear in the precompiled header at all.
13444 The @option{-D} option is one way to define a macro before a
13445 precompiled header is included; using a @code{#define} can also do it.
13446 There are also some options that define macros implicitly, like
13447 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13448 defined this way.
13450 @item If debugging information is output when using the precompiled
13451 header, using @option{-g} or similar, the same kind of debugging information
13452 must have been output when building the precompiled header.  However,
13453 a precompiled header built using @option{-g} can be used in a compilation
13454 when no debugging information is being output.
13456 @item The same @option{-m} options must generally be used when building
13457 and using the precompiled header.  @xref{Submodel Options},
13458 for any cases where this rule is relaxed.
13460 @item Each of the following options must be the same when building and using
13461 the precompiled header:
13463 @gccoptlist{-fexceptions -funit-at-a-time}
13465 @item
13466 Some other command-line options starting with @option{-f},
13467 @option{-p}, or @option{-O} must be defined in the same way as when
13468 the precompiled header was generated.  At present, it's not clear
13469 which options are safe to change and which are not; the safest choice
13470 is to use exactly the same options when generating and using the
13471 precompiled header.  The following are known to be safe:
13473 @gccoptlist{-fmessage-length= -fpreprocessed
13474 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13475 -fsched-verbose=<number> -fschedule-insns -fvisibility=
13476 -pedantic-errors}
13478 @end itemize
13480 For all of these except the last, the compiler will automatically
13481 ignore the precompiled header if the conditions aren't met.  If you
13482 find an option combination that doesn't work and doesn't cause the
13483 precompiled header to be ignored, please consider filing a bug report,
13484 see @ref{Bugs}.
13486 If you do use differing options when generating and using the
13487 precompiled header, the actual behavior will be a mixture of the
13488 behavior for the options.  For instance, if you use @option{-g} to
13489 generate the precompiled header but not when using it, you may or may
13490 not get debugging information for routines in the precompiled header.
13492 @node Running Protoize
13493 @section Running Protoize
13495 The program @code{protoize} is an optional part of GCC@.  You can use
13496 it to add prototypes to a program, thus converting the program to ISO
13497 C in one respect.  The companion program @code{unprotoize} does the
13498 reverse: it removes argument types from any prototypes that are found.
13500 When you run these programs, you must specify a set of source files as
13501 command line arguments.  The conversion programs start out by compiling
13502 these files to see what functions they define.  The information gathered
13503 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13505 After scanning comes actual conversion.  The specified files are all
13506 eligible to be converted; any files they include (whether sources or
13507 just headers) are eligible as well.
13509 But not all the eligible files are converted.  By default,
13510 @code{protoize} and @code{unprotoize} convert only source and header
13511 files in the current directory.  You can specify additional directories
13512 whose files should be converted with the @option{-d @var{directory}}
13513 option.  You can also specify particular files to exclude with the
13514 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13515 directory name matches one of the specified directory names, and its
13516 name within the directory has not been excluded.
13518 Basic conversion with @code{protoize} consists of rewriting most
13519 function definitions and function declarations to specify the types of
13520 the arguments.  The only ones not rewritten are those for varargs
13521 functions.
13523 @code{protoize} optionally inserts prototype declarations at the
13524 beginning of the source file, to make them available for any calls that
13525 precede the function's definition.  Or it can insert prototype
13526 declarations with block scope in the blocks where undeclared functions
13527 are called.
13529 Basic conversion with @code{unprotoize} consists of rewriting most
13530 function declarations to remove any argument types, and rewriting
13531 function definitions to the old-style pre-ISO form.
13533 Both conversion programs print a warning for any function declaration or
13534 definition that they can't convert.  You can suppress these warnings
13535 with @option{-q}.
13537 The output from @code{protoize} or @code{unprotoize} replaces the
13538 original source file.  The original file is renamed to a name ending
13539 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13540 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13541 for DOS) file already exists, then the source file is simply discarded.
13543 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13544 scan the program and collect information about the functions it uses.
13545 So neither of these programs will work until GCC is installed.
13547 Here is a table of the options you can use with @code{protoize} and
13548 @code{unprotoize}.  Each option works with both programs unless
13549 otherwise stated.
13551 @table @code
13552 @item -B @var{directory}
13553 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13554 usual directory (normally @file{/usr/local/lib}).  This file contains
13555 prototype information about standard system functions.  This option
13556 applies only to @code{protoize}.
13558 @item -c @var{compilation-options}
13559 Use @var{compilation-options} as the options when running @command{gcc} to
13560 produce the @samp{.X} files.  The special option @option{-aux-info} is
13561 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13563 Note that the compilation options must be given as a single argument to
13564 @code{protoize} or @code{unprotoize}.  If you want to specify several
13565 @command{gcc} options, you must quote the entire set of compilation options
13566 to make them a single word in the shell.
13568 There are certain @command{gcc} arguments that you cannot use, because they
13569 would produce the wrong kind of output.  These include @option{-g},
13570 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13571 the @var{compilation-options}, they are ignored.
13573 @item -C
13574 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13575 systems) instead of @samp{.c}.  This is convenient if you are converting
13576 a C program to C++.  This option applies only to @code{protoize}.
13578 @item -g
13579 Add explicit global declarations.  This means inserting explicit
13580 declarations at the beginning of each source file for each function
13581 that is called in the file and was not declared.  These declarations
13582 precede the first function definition that contains a call to an
13583 undeclared function.  This option applies only to @code{protoize}.
13585 @item -i @var{string}
13586 Indent old-style parameter declarations with the string @var{string}.
13587 This option applies only to @code{protoize}.
13589 @code{unprotoize} converts prototyped function definitions to old-style
13590 function definitions, where the arguments are declared between the
13591 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13592 uses five spaces as the indentation.  If you want to indent with just
13593 one space instead, use @option{-i " "}.
13595 @item -k
13596 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13597 is finished.
13599 @item -l
13600 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13601 a prototype declaration for each function in each block which calls the
13602 function without any declaration.  This option applies only to
13603 @code{protoize}.
13605 @item -n
13606 Make no real changes.  This mode just prints information about the conversions
13607 that would have been done without @option{-n}.
13609 @item -N
13610 Make no @samp{.save} files.  The original files are simply deleted.
13611 Use this option with caution.
13613 @item -p @var{program}
13614 Use the program @var{program} as the compiler.  Normally, the name
13615 @file{gcc} is used.
13617 @item -q
13618 Work quietly.  Most warnings are suppressed.
13620 @item -v
13621 Print the version number, just like @option{-v} for @command{gcc}.
13622 @end table
13624 If you need special compiler options to compile one of your program's
13625 source files, then you should generate that file's @samp{.X} file
13626 specially, by running @command{gcc} on that source file with the
13627 appropriate options and the option @option{-aux-info}.  Then run
13628 @code{protoize} on the entire set of files.  @code{protoize} will use
13629 the existing @samp{.X} file because it is newer than the source file.
13630 For example:
13632 @smallexample
13633 gcc -Dfoo=bar file1.c -aux-info file1.X
13634 protoize *.c
13635 @end smallexample
13637 @noindent
13638 You need to include the special files along with the rest in the
13639 @code{protoize} command, even though their @samp{.X} files already
13640 exist, because otherwise they won't get converted.
13642 @xref{Protoize Caveats}, for more information on how to use
13643 @code{protoize} successfully.