invoke.texi (-fkeep-inline-functions): Change "GNU C" to "GNU C89".
[official-gcc.git] / gcc / doc / invoke.texi
bloba77f9f2dc4326867b5c2df764a6de934b82293ad
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005, 2006 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 INCLUDE
8 @include gcc-vers.texi
9 @c man end
11 @c man begin COPYRIGHT
12 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
13 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
15 Permission is granted to copy, distribute and/or modify this document
16 under the terms of the GNU Free Documentation License, Version 1.2 or
17 any later version published by the Free Software Foundation; with the
18 Invariant Sections being ``GNU General Public License'' and ``Funding
19 Free Software'', the Front-Cover texts being (a) (see below), and with
20 the Back-Cover Texts being (b) (see below).  A copy of the license is
21 included in the gfdl(7) man page.
23 (a) The FSF's Front-Cover Text is:
25      A GNU Manual
27 (b) The FSF's Back-Cover Text is:
29      You have freedom to copy and modify this GNU Manual, like GNU
30      software.  Copies published by the Free Software Foundation raise
31      funds for GNU development.
32 @c man end
33 @c Set file name and title for the man page.
34 @setfilename gcc
35 @settitle GNU project C and C++ compiler
36 @c man begin SYNOPSIS
37 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
38     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
39     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
40     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
41     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
42     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
43     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
45 Only the most useful options are listed here; see below for the
46 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
47 @c man end
48 @c man begin SEEALSO
49 gpl(7), gfdl(7), fsf-funding(7),
50 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
51 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
52 @file{ld}, @file{binutils} and @file{gdb}.
53 @c man end
54 @c man begin BUGS
55 For instructions on reporting bugs, see
56 @w{@uref{http://gcc.gnu.org/bugs.html}}.
57 @c man end
58 @c man begin AUTHOR
59 See the Info entry for @command{gcc}, or
60 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
61 for contributors to GCC@.
62 @c man end
63 @end ignore
65 @node Invoking GCC
66 @chapter GCC Command Options
67 @cindex GCC command options
68 @cindex command options
69 @cindex options, GCC command
71 @c man begin DESCRIPTION
72 When you invoke GCC, it normally does preprocessing, compilation,
73 assembly and linking.  The ``overall options'' allow you to stop this
74 process at an intermediate stage.  For example, the @option{-c} option
75 says not to run the linker.  Then the output consists of object files
76 output by the assembler.
78 Other options are passed on to one stage of processing.  Some options
79 control the preprocessor and others the compiler itself.  Yet other
80 options control the assembler and linker; most of these are not
81 documented here, since you rarely need to use any of them.
83 @cindex C compilation options
84 Most of the command line options that you can use with GCC are useful
85 for C programs; when an option is only useful with another language
86 (usually C++), the explanation says so explicitly.  If the description
87 for a particular option does not mention a source language, you can use
88 that option with all supported languages.
90 @cindex C++ compilation options
91 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
92 options for compiling C++ programs.
94 @cindex grouping options
95 @cindex options, grouping
96 The @command{gcc} program accepts options and file names as operands.  Many
97 options have multi-letter names; therefore multiple single-letter options
98 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
99 -r}}.
101 @cindex order of options
102 @cindex options, order
103 You can mix options and other arguments.  For the most part, the order
104 you use doesn't matter.  Order does matter when you use several options
105 of the same kind; for example, if you specify @option{-L} more than once,
106 the directories are searched in the order specified.
108 Many options have long names starting with @samp{-f} or with
109 @samp{-W}---for example, 
110 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
111 these have both positive and negative forms; the negative form of
112 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
113 only one of these two forms, whichever one is not the default.
115 @c man end
117 @xref{Option Index}, for an index to GCC's options.
119 @menu
120 * Option Summary::      Brief list of all options, without explanations.
121 * Overall Options::     Controlling the kind of output:
122                         an executable, object files, assembler files,
123                         or preprocessed source.
124 * Invoking G++::        Compiling C++ programs.
125 * C Dialect Options::   Controlling the variant of C language compiled.
126 * C++ Dialect Options:: Variations on C++.
127 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
128                         and Objective-C++.
129 * Language Independent Options:: Controlling how diagnostics should be
130                         formatted.
131 * Warning Options::     How picky should the compiler be?
132 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
133 * Optimize Options::    How much optimization?
134 * Preprocessor Options:: Controlling header files and macro definitions.
135                          Also, getting dependency information for Make.
136 * Assembler Options::   Passing options to the assembler.
137 * Link Options::        Specifying libraries and so on.
138 * Directory Options::   Where to find header files and libraries.
139                         Where to find the compiler executable files.
140 * Spec Files::          How to pass switches to sub-processes.
141 * Target Options::      Running a cross-compiler, or an old version of GCC.
142 * Submodel Options::    Specifying minor hardware or convention variations,
143                         such as 68010 vs 68020.
144 * Code Gen Options::    Specifying conventions for function calls, data layout
145                         and register usage.
146 * Environment Variables:: Env vars that affect GCC.
147 * Precompiled Headers:: Compiling a header once, and using it many times.
148 * Running Protoize::    Automatically adding or removing function prototypes.
149 @end menu
151 @c man begin OPTIONS
153 @node Option Summary
154 @section Option Summary
156 Here is a summary of all the options, grouped by type.  Explanations are
157 in the following sections.
159 @table @emph
160 @item Overall Options
161 @xref{Overall Options,,Options Controlling the Kind of Output}.
162 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
163 -x @var{language}  -v  -###  --help  --target-help  --version @@@var{file}}
165 @item C Language Options
166 @xref{C Dialect Options,,Options Controlling C Dialect}.
167 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
168 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
169 -fhosted  -ffreestanding -fopenmp -fms-extensions @gol
170 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
171 -fallow-single-precision  -fcond-mismatch @gol
172 -fsigned-bitfields  -fsigned-char @gol
173 -funsigned-bitfields  -funsigned-char}
175 @item C++ Language Options
176 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
177 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
178 -fconserve-space  -ffriend-injection @gol
179 -fno-elide-constructors @gol
180 -fno-enforce-eh-specs @gol
181 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
182 -fno-implicit-templates @gol
183 -fno-implicit-inline-templates @gol
184 -fno-implement-inlines  -fms-extensions @gol
185 -fno-nonansi-builtins  -fno-operator-names @gol
186 -fno-optional-diags  -fpermissive @gol
187 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
188 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
189 -fno-default-inline  -fvisibility-inlines-hidden @gol
190 -Wabi  -Wctor-dtor-privacy @gol
191 -Wnon-virtual-dtor  -Wreorder @gol
192 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
193 -Wno-non-template-friend  -Wold-style-cast @gol
194 -Woverloaded-virtual  -Wno-pmf-conversions @gol
195 -Wsign-promo}
197 @item Objective-C and Objective-C++ Language Options
198 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
199 Objective-C and Objective-C++ Dialects}.
200 @gccoptlist{
201 -fconstant-string-class=@var{class-name} @gol
202 -fgnu-runtime  -fnext-runtime @gol
203 -fno-nil-receivers @gol
204 -fobjc-call-cxx-cdtors @gol
205 -fobjc-direct-dispatch @gol
206 -fobjc-exceptions @gol
207 -fobjc-gc @gol
208 -freplace-objc-classes @gol
209 -fzero-link @gol
210 -gen-decls @gol
211 -Wassign-intercept @gol
212 -Wno-protocol  -Wselector @gol
213 -Wstrict-selector-match @gol
214 -Wundeclared-selector}
216 @item Language Independent Options
217 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
218 @gccoptlist{-fmessage-length=@var{n}  @gol
219 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
220 -fdiagnostics-show-option
222 @item Warning Options
223 @xref{Warning Options,,Options to Request or Suppress Warnings}.
224 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
225 -w  -Wextra  -Wall  -Waggregate-return -Walways-true -Wno-attributes @gol
226 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
227 -Wconversion  -Wno-deprecated-declarations @gol
228 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
229 -Werror  -Werror-* -Werror-implicit-function-declaration @gol
230 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
231 -Wno-format-extra-args -Wformat-nonliteral @gol
232 -Wformat-security  -Wformat-y2k @gol
233 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
234 -Wimport  -Wno-import  -Winit-self  -Winline @gol
235 -Wno-int-to-pointer-cast @gol
236 -Wno-invalid-offsetof  -Winvalid-pch @gol
237 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
238 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
239 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
240 -Wmissing-noreturn @gol
241 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
242 -Woverlength-strings  -Wpacked  -Wpadded @gol
243 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
244 -Wredundant-decls @gol
245 -Wreturn-type  -Wsequence-point  -Wshadow @gol
246 -Wsign-compare  -Wstack-protector @gol
247 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
248 -Wstring-literal-comparison @gol
249 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
250 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
251 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
252 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
253 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
254 -Wvolatile-register-var  -Wwrite-strings}
256 @item C-only Warning Options
257 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
258 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
259 -Wstrict-prototypes  -Wtraditional @gol
260 -Wdeclaration-after-statement -Wpointer-sign}
262 @item Debugging Options
263 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
264 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
265 -fdump-noaddr -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
266 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
267 -fdump-ipa-all -fdump-ipa-cgraph @gol
268 -fdump-tree-all @gol
269 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
270 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
273 -fdump-tree-ch @gol
274 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
276 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
277 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
282 -fdump-tree-nrv -fdump-tree-vect @gol
283 -fdump-tree-sink @gol
284 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
285 -fdump-tree-salias @gol
286 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
288 -ftree-vectorizer-verbose=@var{n} @gol
289 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
290 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
291 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
292 -fmem-report -fprofile-arcs @gol
293 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
294 -ftest-coverage  -ftime-report -fvar-tracking @gol
295 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
296 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
297 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
298 -print-multi-directory  -print-multi-lib @gol
299 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
300 -save-temps  -time}
302 @item Optimization Options
303 @xref{Optimize Options,,Options that Control Optimization}.
304 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
305 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
306 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
307 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
308 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
309 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
310 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
311 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
312 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
313 -fforce-addr  -ffunction-sections @gol
314 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
315 -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
316 -finline-functions  -finline-functions-called-once @gol
317 -finline-limit=@var{n}  -fkeep-inline-functions @gol
318 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
319 -fmodulo-sched -fno-branch-count-reg @gol
320 -fno-default-inline  -fno-defer-pop -fmove-loop-invariants @gol
321 -fno-function-cse  -fno-guess-branch-probability @gol
322 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
323 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
324 -fno-toplevel-reorder -fno-trapping-math  -fno-zero-initialized-in-bss @gol
325 -fomit-frame-pointer  -foptimize-register-move @gol
326 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
327 -fprofile-generate -fprofile-use @gol
328 -fregmove  -frename-registers @gol
329 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
330 -frerun-cse-after-loop @gol
331 -frounding-math -frtl-abstract-sequences @gol
332 -fschedule-insns  -fschedule-insns2 @gol
333 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
334 -fsched-spec-load-dangerous  @gol
335 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
336 -fsched2-use-superblocks @gol
337 -fsched2-use-traces -fsee -freschedule-modulo-scheduled-loops @gol
338 -fsection-anchors  -fsignaling-nans  -fsingle-precision-constant @gol
339 -fstack-protector  -fstack-protector-all @gol
340 -fstrict-aliasing  -ftracer  -fthread-jumps @gol
341 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
342 -fsplit-ivs-in-unroller -funswitch-loops @gol
343 -fvariable-expansion-in-unroller @gol
344 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
345 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
346 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
347 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
348 -ftree-vect-loop-version -ftree-salias -fipa-pta -fweb @gol
349 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
350 --param @var{name}=@var{value}
351 -O  -O0  -O1  -O2  -O3  -Os}
353 @item Preprocessor Options
354 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
355 @gccoptlist{-A@var{question}=@var{answer} @gol
356 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
357 -C  -dD  -dI  -dM  -dN @gol
358 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
359 -idirafter @var{dir} @gol
360 -include @var{file}  -imacros @var{file} @gol
361 -iprefix @var{file}  -iwithprefix @var{dir} @gol
362 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
363 -imultilib @var{dir} -isysroot @var{dir} @gol
364 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
365 -P  -fworking-directory  -remap @gol
366 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
367 -Xpreprocessor @var{option}}
369 @item Assembler Option
370 @xref{Assembler Options,,Passing Options to the Assembler}.
371 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
373 @item Linker Options
374 @xref{Link Options,,Options for Linking}.
375 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
376 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
377 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
378 -Wl,@var{option}  -Xlinker @var{option} @gol
379 -u @var{symbol}}
381 @item Directory Options
382 @xref{Directory Options,,Options for Directory Search}.
383 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
384 -specs=@var{file}  -I- --sysroot=@var{dir}}
386 @item Target Options
387 @c I wrote this xref this way to avoid overfull hbox. -- rms
388 @xref{Target Options}.
389 @gccoptlist{-V @var{version}  -b @var{machine}}
391 @item Machine Dependent Options
392 @xref{Submodel Options,,Hardware Models and Configurations}.
393 @c This list is ordered alphanumerically by subsection name.
394 @c Try and put the significant identifier (CPU or system) first,
395 @c so users have a clue at guessing where the ones they want will be.
397 @emph{ARC Options}
398 @gccoptlist{-EB  -EL @gol
399 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
400 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
402 @emph{ARM Options}
403 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
404 -mabi=@var{name} @gol
405 -mapcs-stack-check  -mno-apcs-stack-check @gol
406 -mapcs-float  -mno-apcs-float @gol
407 -mapcs-reentrant  -mno-apcs-reentrant @gol
408 -msched-prolog  -mno-sched-prolog @gol
409 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
410 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
411 -mthumb-interwork  -mno-thumb-interwork @gol
412 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
413 -mstructure-size-boundary=@var{n} @gol
414 -mabort-on-noreturn @gol
415 -mlong-calls  -mno-long-calls @gol
416 -msingle-pic-base  -mno-single-pic-base @gol
417 -mpic-register=@var{reg} @gol
418 -mnop-fun-dllimport @gol
419 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
420 -mpoke-function-name @gol
421 -mthumb  -marm @gol
422 -mtpcs-frame  -mtpcs-leaf-frame @gol
423 -mcaller-super-interworking  -mcallee-super-interworking @gol
424 -mtp=@var{name}}
426 @emph{AVR Options}
427 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
428 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
430 @emph{Blackfin Options}
431 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
432 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
433 -mlow-64k -mno-low64k -mid-shared-library @gol
434 -mno-id-shared-library -mshared-library-id=@var{n} @gol
435 -mlong-calls  -mno-long-calls}
437 @emph{CRIS Options}
438 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
439 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
440 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
441 -mstack-align  -mdata-align  -mconst-align @gol
442 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
443 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
444 -mmul-bug-workaround  -mno-mul-bug-workaround}
446 @emph{CRX Options}
447 @gccoptlist{-mmac -mpush-args}
449 @emph{Darwin Options}
450 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
451 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
452 -client_name  -compatibility_version  -current_version @gol
453 -dead_strip @gol
454 -dependency-file  -dylib_file  -dylinker_install_name @gol
455 -dynamic  -dynamiclib  -exported_symbols_list @gol
456 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
457 -force_flat_namespace  -headerpad_max_install_names @gol
458 -image_base  -init  -install_name  -keep_private_externs @gol
459 -multi_module  -multiply_defined  -multiply_defined_unused @gol
460 -noall_load   -no_dead_strip_inits_and_terms @gol
461 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
462 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
463 -private_bundle  -read_only_relocs  -sectalign @gol
464 -sectobjectsymbols  -whyload  -seg1addr @gol
465 -sectcreate  -sectobjectsymbols  -sectorder @gol
466 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
467 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
468 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
469 -single_module  -static  -sub_library  -sub_umbrella @gol
470 -twolevel_namespace  -umbrella  -undefined @gol
471 -unexported_symbols_list  -weak_reference_mismatches @gol
472 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
473 -mkernel -mone-byte-bool}
475 @emph{DEC Alpha Options}
476 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
477 -mieee  -mieee-with-inexact  -mieee-conformant @gol
478 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
479 -mtrap-precision=@var{mode}  -mbuild-constants @gol
480 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
481 -mbwx  -mmax  -mfix  -mcix @gol
482 -mfloat-vax  -mfloat-ieee @gol
483 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
484 -msmall-text  -mlarge-text @gol
485 -mmemory-latency=@var{time}}
487 @emph{DEC Alpha/VMS Options}
488 @gccoptlist{-mvms-return-codes}
490 @emph{FRV Options}
491 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
492 -mhard-float  -msoft-float @gol
493 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
494 -mdouble  -mno-double @gol
495 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
496 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
497 -mlinked-fp  -mlong-calls  -malign-labels @gol
498 -mlibrary-pic  -macc-4  -macc-8 @gol
499 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
500 -moptimize-membar -mno-optimize-membar @gol
501 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
502 -mvliw-branch  -mno-vliw-branch @gol
503 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
504 -mno-nested-cond-exec  -mtomcat-stats @gol
505 -mTLS -mtls @gol
506 -mcpu=@var{cpu}}
508 @emph{GNU/Linux Options}
509 @gccoptlist{-muclibc}
511 @emph{H8/300 Options}
512 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
514 @emph{HPPA Options}
515 @gccoptlist{-march=@var{architecture-type} @gol
516 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
517 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
518 -mfixed-range=@var{register-range} @gol
519 -mjump-in-delay -mlinker-opt -mlong-calls @gol
520 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
521 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
522 -mno-jump-in-delay  -mno-long-load-store @gol
523 -mno-portable-runtime  -mno-soft-float @gol
524 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
525 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
526 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
527 -munix=@var{unix-std}  -nolibdld  -static  -threads}
529 @emph{i386 and x86-64 Options}
530 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
531 -mfpmath=@var{unit} @gol
532 -masm=@var{dialect}  -mno-fancy-math-387 @gol
533 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
534 -mno-wide-multiply  -mrtd  -malign-double @gol
535 -mpreferred-stack-boundary=@var{num} @gol
536 -mmmx  -msse  -msse2 -msse3 -mssse3 -m3dnow @gol
537 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
538 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
539 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
540 -mstackrealign @gol
541 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
542 -mcmodel=@var{code-model} @gol
543 -m32  -m64 -mlarge-data-threshold=@var{num}}
545 @emph{IA-64 Options}
546 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
547 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
548 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
549 -minline-float-divide-max-throughput @gol
550 -minline-int-divide-min-latency @gol
551 -minline-int-divide-max-throughput  @gol
552 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
553 -mno-dwarf2-asm -mearly-stop-bits @gol
554 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
555 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
556 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
557 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
558 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
559 -mno-sched-prefer-non-data-spec-insns @gol
560 -mno-sched-prefer-non-control-spec-insns @gol
561 -mno-sched-count-spec-in-critical-path}
563 @emph{M32R/D Options}
564 @gccoptlist{-m32r2 -m32rx -m32r @gol
565 -mdebug @gol
566 -malign-loops -mno-align-loops @gol
567 -missue-rate=@var{number} @gol
568 -mbranch-cost=@var{number} @gol
569 -mmodel=@var{code-size-model-type} @gol
570 -msdata=@var{sdata-type} @gol
571 -mno-flush-func -mflush-func=@var{name} @gol
572 -mno-flush-trap -mflush-trap=@var{number} @gol
573 -G @var{num}}
575 @emph{M32C Options}
576 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
578 @emph{M680x0 Options}
579 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
580 -m68060  -mcpu32  -m5200  -mcfv4e -m68881  -mbitfield  @gol
581 -mc68000  -mc68020   @gol
582 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
583 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
584 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
586 @emph{M68hc1x Options}
587 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
588 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
589 -msoft-reg-count=@var{count}}
591 @emph{MCore Options}
592 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
593 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
594 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
595 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
596 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
598 @emph{MIPS Options}
599 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
600 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
601 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
602 -mshared  -mno-shared  -mxgot  -mno-xgot  -mgp32  -mgp64  @gol
603 -mfp32  -mfp64  -mhard-float  -msoft-float  @gol
604 -msingle-float  -mdouble-float  -mdsp  -mpaired-single  -mips3d @gol
605 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
606 -G@var{num}  -membedded-data  -mno-embedded-data @gol
607 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
608 -msplit-addresses  -mno-split-addresses  @gol
609 -mexplicit-relocs  -mno-explicit-relocs  @gol
610 -mcheck-zero-division  -mno-check-zero-division @gol
611 -mdivide-traps  -mdivide-breaks @gol
612 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
613 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
614 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
615 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
616 -mfix-sb1  -mno-fix-sb1 @gol
617 -mflush-func=@var{func}  -mno-flush-func @gol
618 -mbranch-likely  -mno-branch-likely @gol
619 -mfp-exceptions -mno-fp-exceptions @gol
620 -mvr4130-align -mno-vr4130-align}
622 @emph{MMIX Options}
623 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
624 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
625 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
626 -mno-base-addresses  -msingle-exit  -mno-single-exit}
628 @emph{MN10300 Options}
629 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
630 -mam33  -mno-am33 @gol
631 -mam33-2  -mno-am33-2 @gol
632 -mreturn-pointer-on-d0 @gol
633 -mno-crt0  -mrelax}
635 @emph{MT Options}
636 @gccoptlist{-mno-crt0 -mbacc -msim @gol
637 -march=@var{cpu-type} }
639 @emph{PDP-11 Options}
640 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
641 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
642 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
643 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
644 -mbranch-expensive  -mbranch-cheap @gol
645 -msplit  -mno-split  -munix-asm  -mdec-asm}
647 @emph{PowerPC Options}
648 See RS/6000 and PowerPC Options.
650 @emph{RS/6000 and PowerPC Options}
651 @gccoptlist{-mcpu=@var{cpu-type} @gol
652 -mtune=@var{cpu-type} @gol
653 -mpower  -mno-power  -mpower2  -mno-power2 @gol
654 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
655 -maltivec  -mno-altivec @gol
656 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
657 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
658 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
659 -mnew-mnemonics  -mold-mnemonics @gol
660 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
661 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
662 -malign-power  -malign-natural @gol
663 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
664 -mstring  -mno-string  -mupdate  -mno-update @gol
665 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
666 -mstrict-align  -mno-strict-align  -mrelocatable @gol
667 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
668 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
669 -mdynamic-no-pic  -maltivec  -mswdiv @gol
670 -mprioritize-restricted-insns=@var{priority} @gol
671 -msched-costly-dep=@var{dependence_type} @gol
672 -minsert-sched-nops=@var{scheme} @gol
673 -mcall-sysv  -mcall-netbsd @gol
674 -maix-struct-return  -msvr4-struct-return @gol
675 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
676 -misel -mno-isel @gol
677 -misel=yes  -misel=no @gol
678 -mspe -mno-spe @gol
679 -mspe=yes  -mspe=no @gol
680 -mvrsave -mno-vrsave @gol
681 -mmulhw -mno-mulhw @gol
682 -mdlmzb -mno-dlmzb @gol
683 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
684 -mprototype  -mno-prototype @gol
685 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
686 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
688 @emph{S/390 and zSeries Options}
689 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
690 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
691 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
692 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
693 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
694 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
695 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
697 @emph{Score Options}
698 @gccoptlist{-mel -mel @gol
699 -mmac @gol
700 -mscore5u -mscore7}
702 @emph{SH Options}
703 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
704 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
705 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
706 -m5-64media  -m5-64media-nofpu @gol
707 -m5-32media  -m5-32media-nofpu @gol
708 -m5-compact  -m5-compact-nofpu @gol
709 -mb  -ml  -mdalign  -mrelax @gol
710 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
711 -mieee  -misize  -mpadstruct  -mspace @gol
712 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
713 -mdivsi3_libfunc=@var{name}  @gol
714 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
715  -minvalid-symbols}
717 @emph{SPARC Options}
718 @gccoptlist{-mcpu=@var{cpu-type} @gol
719 -mtune=@var{cpu-type} @gol
720 -mcmodel=@var{code-model} @gol
721 -m32  -m64  -mapp-regs  -mno-app-regs @gol
722 -mfaster-structs  -mno-faster-structs @gol
723 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
724 -mhard-quad-float  -msoft-quad-float @gol
725 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
726 -mstack-bias  -mno-stack-bias @gol
727 -munaligned-doubles  -mno-unaligned-doubles @gol
728 -mv8plus  -mno-v8plus  -mvis  -mno-vis
729 -threads -pthreads -pthread}
731 @emph{System V Options}
732 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
734 @emph{TMS320C3x/C4x Options}
735 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
736 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
737 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
738 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
740 @emph{V850 Options}
741 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
742 -mprolog-function  -mno-prolog-function  -mspace @gol
743 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
744 -mapp-regs  -mno-app-regs @gol
745 -mdisable-callt  -mno-disable-callt @gol
746 -mv850e1 @gol
747 -mv850e @gol
748 -mv850  -mbig-switch}
750 @emph{VAX Options}
751 @gccoptlist{-mg  -mgnu  -munix}
753 @emph{x86-64 Options}
754 See i386 and x86-64 Options.
756 @emph{Xstormy16 Options}
757 @gccoptlist{-msim}
759 @emph{Xtensa Options}
760 @gccoptlist{-mconst16 -mno-const16 @gol
761 -mfused-madd  -mno-fused-madd @gol
762 -mtext-section-literals  -mno-text-section-literals @gol
763 -mtarget-align  -mno-target-align @gol
764 -mlongcalls  -mno-longcalls}
766 @emph{zSeries Options}
767 See S/390 and zSeries Options.
769 @item Code Generation Options
770 @xref{Code Gen Options,,Options for Code Generation Conventions}.
771 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
772 -ffixed-@var{reg}  -fexceptions @gol
773 -fnon-call-exceptions  -funwind-tables @gol
774 -fasynchronous-unwind-tables @gol
775 -finhibit-size-directive  -finstrument-functions @gol
776 -fno-common  -fno-ident @gol
777 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
778 -fno-jump-tables @gol
779 -freg-struct-return  -fshort-enums @gol
780 -fshort-double  -fshort-wchar @gol
781 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
782 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
783 -fargument-alias  -fargument-noalias @gol
784 -fargument-noalias-global  -fargument-noalias-anything
785 -fleading-underscore  -ftls-model=@var{model} @gol
786 -ftrapv  -fwrapv  -fbounds-check @gol
787 -fvisibility}
788 @end table
790 @menu
791 * Overall Options::     Controlling the kind of output:
792                         an executable, object files, assembler files,
793                         or preprocessed source.
794 * C Dialect Options::   Controlling the variant of C language compiled.
795 * C++ Dialect Options:: Variations on C++.
796 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
797                         and Objective-C++.
798 * Language Independent Options:: Controlling how diagnostics should be
799                         formatted.
800 * Warning Options::     How picky should the compiler be?
801 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
802 * Optimize Options::    How much optimization?
803 * Preprocessor Options:: Controlling header files and macro definitions.
804                          Also, getting dependency information for Make.
805 * Assembler Options::   Passing options to the assembler.
806 * Link Options::        Specifying libraries and so on.
807 * Directory Options::   Where to find header files and libraries.
808                         Where to find the compiler executable files.
809 * Spec Files::          How to pass switches to sub-processes.
810 * Target Options::      Running a cross-compiler, or an old version of GCC.
811 @end menu
813 @node Overall Options
814 @section Options Controlling the Kind of Output
816 Compilation can involve up to four stages: preprocessing, compilation
817 proper, assembly and linking, always in that order.  GCC is capable of
818 preprocessing and compiling several files either into several
819 assembler input files, or into one assembler input file; then each
820 assembler input file produces an object file, and linking combines all
821 the object files (those newly compiled, and those specified as input)
822 into an executable file.
824 @cindex file name suffix
825 For any given input file, the file name suffix determines what kind of
826 compilation is done:
828 @table @gcctabopt
829 @item @var{file}.c
830 C source code which must be preprocessed.
832 @item @var{file}.i
833 C source code which should not be preprocessed.
835 @item @var{file}.ii
836 C++ source code which should not be preprocessed.
838 @item @var{file}.m
839 Objective-C source code.  Note that you must link with the @file{libobjc}
840 library to make an Objective-C program work.
842 @item @var{file}.mi
843 Objective-C source code which should not be preprocessed.
845 @item @var{file}.mm
846 @itemx @var{file}.M
847 Objective-C++ source code.  Note that you must link with the @file{libobjc}
848 library to make an Objective-C++ program work.  Note that @samp{.M} refers
849 to a literal capital M@.
851 @item @var{file}.mii
852 Objective-C++ source code which should not be preprocessed.
854 @item @var{file}.h
855 C, C++, Objective-C or Objective-C++ header file to be turned into a
856 precompiled header.
858 @item @var{file}.cc
859 @itemx @var{file}.cp
860 @itemx @var{file}.cxx
861 @itemx @var{file}.cpp
862 @itemx @var{file}.CPP
863 @itemx @var{file}.c++
864 @itemx @var{file}.C
865 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
866 the last two letters must both be literally @samp{x}.  Likewise,
867 @samp{.C} refers to a literal capital C@.
869 @item @var{file}.mm
870 @itemx @var{file}.M
871 Objective-C++ source code which must be preprocessed.
873 @item @var{file}.mii
874 Objective-C++ source code which should not be preprocessed.
876 @item @var{file}.hh
877 @itemx @var{file}.H
878 C++ header file to be turned into a precompiled header.
880 @item @var{file}.f
881 @itemx @var{file}.for
882 @itemx @var{file}.FOR
883 Fixed form Fortran source code which should not be preprocessed.
885 @item @var{file}.F
886 @itemx @var{file}.fpp
887 @itemx @var{file}.FPP
888 Fixed form Fortran source code which must be preprocessed (with the traditional
889 preprocessor).
891 @item @var{file}.f90
892 @itemx @var{file}.f95
893 Free form Fortran source code which should not be preprocessed.
895 @item @var{file}.F90
896 @itemx @var{file}.F95
897 Free form Fortran source code which must be preprocessed (with the
898 traditional preprocessor).
900 @c FIXME: Descriptions of Java file types.
901 @c @var{file}.java
902 @c @var{file}.class
903 @c @var{file}.zip
904 @c @var{file}.jar
906 @item @var{file}.ads
907 Ada source code file which contains a library unit declaration (a
908 declaration of a package, subprogram, or generic, or a generic
909 instantiation), or a library unit renaming declaration (a package,
910 generic, or subprogram renaming declaration).  Such files are also
911 called @dfn{specs}.
913 @itemx @var{file}.adb
914 Ada source code file containing a library unit body (a subprogram or
915 package body).  Such files are also called @dfn{bodies}.
917 @c GCC also knows about some suffixes for languages not yet included:
918 @c Pascal:
919 @c @var{file}.p
920 @c @var{file}.pas
921 @c Ratfor:
922 @c @var{file}.r
924 @item @var{file}.s
925 Assembler code.
927 @item @var{file}.S
928 Assembler code which must be preprocessed.
930 @item @var{other}
931 An object file to be fed straight into linking.
932 Any file name with no recognized suffix is treated this way.
933 @end table
935 @opindex x
936 You can specify the input language explicitly with the @option{-x} option:
938 @table @gcctabopt
939 @item -x @var{language}
940 Specify explicitly the @var{language} for the following input files
941 (rather than letting the compiler choose a default based on the file
942 name suffix).  This option applies to all following input files until
943 the next @option{-x} option.  Possible values for @var{language} are:
944 @smallexample
945 c  c-header  c-cpp-output
946 c++  c++-header  c++-cpp-output
947 objective-c  objective-c-header  objective-c-cpp-output
948 objective-c++ objective-c++-header objective-c++-cpp-output
949 assembler  assembler-with-cpp
951 f95  f95-cpp-input
952 java
953 treelang
954 @end smallexample
956 @item -x none
957 Turn off any specification of a language, so that subsequent files are
958 handled according to their file name suffixes (as they are if @option{-x}
959 has not been used at all).
961 @item -pass-exit-codes
962 @opindex pass-exit-codes
963 Normally the @command{gcc} program will exit with the code of 1 if any
964 phase of the compiler returns a non-success return code.  If you specify
965 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
966 numerically highest error produced by any phase that returned an error
967 indication.  The C, C++, and Fortran frontends return 4, if an internal
968 compiler error is encountered.
969 @end table
971 If you only want some of the stages of compilation, you can use
972 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
973 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
974 @command{gcc} is to stop.  Note that some combinations (for example,
975 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
977 @table @gcctabopt
978 @item -c
979 @opindex c
980 Compile or assemble the source files, but do not link.  The linking
981 stage simply is not done.  The ultimate output is in the form of an
982 object file for each source file.
984 By default, the object file name for a source file is made by replacing
985 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
987 Unrecognized input files, not requiring compilation or assembly, are
988 ignored.
990 @item -S
991 @opindex S
992 Stop after the stage of compilation proper; do not assemble.  The output
993 is in the form of an assembler code file for each non-assembler input
994 file specified.
996 By default, the assembler file name for a source file is made by
997 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
999 Input files that don't require compilation are ignored.
1001 @item -E
1002 @opindex E
1003 Stop after the preprocessing stage; do not run the compiler proper.  The
1004 output is in the form of preprocessed source code, which is sent to the
1005 standard output.
1007 Input files which don't require preprocessing are ignored.
1009 @cindex output file option
1010 @item -o @var{file}
1011 @opindex o
1012 Place output in file @var{file}.  This applies regardless to whatever
1013 sort of output is being produced, whether it be an executable file,
1014 an object file, an assembler file or preprocessed C code.
1016 If @option{-o} is not specified, the default is to put an executable
1017 file in @file{a.out}, the object file for
1018 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1019 assembler file in @file{@var{source}.s}, a precompiled header file in
1020 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1021 standard output.
1023 @item -v
1024 @opindex v
1025 Print (on standard error output) the commands executed to run the stages
1026 of compilation.  Also print the version number of the compiler driver
1027 program and of the preprocessor and the compiler proper.
1029 @item -###
1030 @opindex ###
1031 Like @option{-v} except the commands are not executed and all command
1032 arguments are quoted.  This is useful for shell scripts to capture the
1033 driver-generated command lines.
1035 @item -pipe
1036 @opindex pipe
1037 Use pipes rather than temporary files for communication between the
1038 various stages of compilation.  This fails to work on some systems where
1039 the assembler is unable to read from a pipe; but the GNU assembler has
1040 no trouble.
1042 @item -combine
1043 @opindex combine
1044 If you are compiling multiple source files, this option tells the driver
1045 to pass all the source files to the compiler at once (for those
1046 languages for which the compiler can handle this).  This will allow
1047 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1048 language for which this is supported is C@.  If you pass source files for
1049 multiple languages to the driver, using this option, the driver will invoke
1050 the compiler(s) that support IMA once each, passing each compiler all the
1051 source files appropriate for it.  For those languages that do not support
1052 IMA this option will be ignored, and the compiler will be invoked once for
1053 each source file in that language.  If you use this option in conjunction
1054 with @option{-save-temps}, the compiler will generate multiple
1055 pre-processed files
1056 (one for each source file), but only one (combined) @file{.o} or
1057 @file{.s} file.
1059 @item --help
1060 @opindex help
1061 Print (on the standard output) a description of the command line options
1062 understood by @command{gcc}.  If the @option{-v} option is also specified
1063 then @option{--help} will also be passed on to the various processes
1064 invoked by @command{gcc}, so that they can display the command line options
1065 they accept.  If the @option{-Wextra} option is also specified then command
1066 line options which have no documentation associated with them will also
1067 be displayed.
1069 @item --target-help
1070 @opindex target-help
1071 Print (on the standard output) a description of target specific command
1072 line options for each tool.
1074 @item --version
1075 @opindex version
1076 Display the version number and copyrights of the invoked GCC@.
1078 @include @value{srcdir}/../libiberty/at-file.texi
1079 @end table
1081 @node Invoking G++
1082 @section Compiling C++ Programs
1084 @cindex suffixes for C++ source
1085 @cindex C++ source file suffixes
1086 C++ source files conventionally use one of the suffixes @samp{.C},
1087 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1088 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1089 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1090 files with these names and compiles them as C++ programs even if you
1091 call the compiler the same way as for compiling C programs (usually
1092 with the name @command{gcc}).
1094 @findex g++
1095 @findex c++
1096 However, the use of @command{gcc} does not add the C++ library.
1097 @command{g++} is a program that calls GCC and treats @samp{.c},
1098 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1099 files unless @option{-x} is used, and automatically specifies linking
1100 against the C++ library.  This program is also useful when
1101 precompiling a C header file with a @samp{.h} extension for use in C++
1102 compilations.  On many systems, @command{g++} is also installed with
1103 the name @command{c++}.
1105 @cindex invoking @command{g++}
1106 When you compile C++ programs, you may specify many of the same
1107 command-line options that you use for compiling programs in any
1108 language; or command-line options meaningful for C and related
1109 languages; or options that are meaningful only for C++ programs.
1110 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1111 explanations of options for languages related to C@.
1112 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1113 explanations of options that are meaningful only for C++ programs.
1115 @node C Dialect Options
1116 @section Options Controlling C Dialect
1117 @cindex dialect options
1118 @cindex language dialect options
1119 @cindex options, dialect
1121 The following options control the dialect of C (or languages derived
1122 from C, such as C++, Objective-C and Objective-C++) that the compiler
1123 accepts:
1125 @table @gcctabopt
1126 @cindex ANSI support
1127 @cindex ISO support
1128 @item -ansi
1129 @opindex ansi
1130 In C mode, support all ISO C90 programs.  In C++ mode,
1131 remove GNU extensions that conflict with ISO C++.
1133 This turns off certain features of GCC that are incompatible with ISO
1134 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1135 such as the @code{asm} and @code{typeof} keywords, and
1136 predefined macros such as @code{unix} and @code{vax} that identify the
1137 type of system you are using.  It also enables the undesirable and
1138 rarely used ISO trigraph feature.  For the C compiler,
1139 it disables recognition of C++ style @samp{//} comments as well as
1140 the @code{inline} keyword.
1142 The alternate keywords @code{__asm__}, @code{__extension__},
1143 @code{__inline__} and @code{__typeof__} continue to work despite
1144 @option{-ansi}.  You would not want to use them in an ISO C program, of
1145 course, but it is useful to put them in header files that might be included
1146 in compilations done with @option{-ansi}.  Alternate predefined macros
1147 such as @code{__unix__} and @code{__vax__} are also available, with or
1148 without @option{-ansi}.
1150 The @option{-ansi} option does not cause non-ISO programs to be
1151 rejected gratuitously.  For that, @option{-pedantic} is required in
1152 addition to @option{-ansi}.  @xref{Warning Options}.
1154 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1155 option is used.  Some header files may notice this macro and refrain
1156 from declaring certain functions or defining certain macros that the
1157 ISO standard doesn't call for; this is to avoid interfering with any
1158 programs that might use these names for other things.
1160 Functions which would normally be built in but do not have semantics
1161 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1162 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1163 built-in functions provided by GCC}, for details of the functions
1164 affected.
1166 @item -std=
1167 @opindex std
1168 Determine the language standard.  This option is currently only
1169 supported when compiling C or C++.  A value for this option must be
1170 provided; possible values are
1172 @table @samp
1173 @item c89
1174 @itemx iso9899:1990
1175 ISO C90 (same as @option{-ansi}).
1177 @item iso9899:199409
1178 ISO C90 as modified in amendment 1.
1180 @item c99
1181 @itemx c9x
1182 @itemx iso9899:1999
1183 @itemx iso9899:199x
1184 ISO C99.  Note that this standard is not yet fully supported; see
1185 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1186 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1188 @item gnu89
1189 Default, ISO C90 plus GNU extensions (including some C99 features).
1191 @item gnu99
1192 @itemx gnu9x
1193 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1194 this will become the default.  The name @samp{gnu9x} is deprecated.
1196 @item c++98
1197 The 1998 ISO C++ standard plus amendments.
1199 @item gnu++98
1200 The same as @option{-std=c++98} plus GNU extensions.  This is the
1201 default for C++ code.
1202 @end table
1204 Even when this option is not specified, you can still use some of the
1205 features of newer standards in so far as they do not conflict with
1206 previous C standards.  For example, you may use @code{__restrict__} even
1207 when @option{-std=c99} is not specified.
1209 The @option{-std} options specifying some version of ISO C have the same
1210 effects as @option{-ansi}, except that features that were not in ISO C90
1211 but are in the specified version (for example, @samp{//} comments and
1212 the @code{inline} keyword in ISO C99) are not disabled.
1214 @xref{Standards,,Language Standards Supported by GCC}, for details of
1215 these standard versions.
1217 @item -aux-info @var{filename}
1218 @opindex aux-info
1219 Output to the given filename prototyped declarations for all functions
1220 declared and/or defined in a translation unit, including those in header
1221 files.  This option is silently ignored in any language other than C@.
1223 Besides declarations, the file indicates, in comments, the origin of
1224 each declaration (source file and line), whether the declaration was
1225 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1226 @samp{O} for old, respectively, in the first character after the line
1227 number and the colon), and whether it came from a declaration or a
1228 definition (@samp{C} or @samp{F}, respectively, in the following
1229 character).  In the case of function definitions, a K&R-style list of
1230 arguments followed by their declarations is also provided, inside
1231 comments, after the declaration.
1233 @item -fno-asm
1234 @opindex fno-asm
1235 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1236 keyword, so that code can use these words as identifiers.  You can use
1237 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1238 instead.  @option{-ansi} implies @option{-fno-asm}.
1240 In C++, this switch only affects the @code{typeof} keyword, since
1241 @code{asm} and @code{inline} are standard keywords.  You may want to
1242 use the @option{-fno-gnu-keywords} flag instead, which has the same
1243 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1244 switch only affects the @code{asm} and @code{typeof} keywords, since
1245 @code{inline} is a standard keyword in ISO C99.
1247 @item -fno-builtin
1248 @itemx -fno-builtin-@var{function}
1249 @opindex fno-builtin
1250 @cindex built-in functions
1251 Don't recognize built-in functions that do not begin with
1252 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1253 functions provided by GCC}, for details of the functions affected,
1254 including those which are not built-in functions when @option{-ansi} or
1255 @option{-std} options for strict ISO C conformance are used because they
1256 do not have an ISO standard meaning.
1258 GCC normally generates special code to handle certain built-in functions
1259 more efficiently; for instance, calls to @code{alloca} may become single
1260 instructions that adjust the stack directly, and calls to @code{memcpy}
1261 may become inline copy loops.  The resulting code is often both smaller
1262 and faster, but since the function calls no longer appear as such, you
1263 cannot set a breakpoint on those calls, nor can you change the behavior
1264 of the functions by linking with a different library.  In addition,
1265 when a function is recognized as a built-in function, GCC may use
1266 information about that function to warn about problems with calls to
1267 that function, or to generate more efficient code, even if the
1268 resulting code still contains calls to that function.  For example,
1269 warnings are given with @option{-Wformat} for bad calls to
1270 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1271 known not to modify global memory.
1273 With the @option{-fno-builtin-@var{function}} option
1274 only the built-in function @var{function} is
1275 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1276 function is named this is not built-in in this version of GCC, this
1277 option is ignored.  There is no corresponding
1278 @option{-fbuiltin-@var{function}} option; if you wish to enable
1279 built-in functions selectively when using @option{-fno-builtin} or
1280 @option{-ffreestanding}, you may define macros such as:
1282 @smallexample
1283 #define abs(n)          __builtin_abs ((n))
1284 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1285 @end smallexample
1287 @item -fhosted
1288 @opindex fhosted
1289 @cindex hosted environment
1291 Assert that compilation takes place in a hosted environment.  This implies
1292 @option{-fbuiltin}.  A hosted environment is one in which the
1293 entire standard library is available, and in which @code{main} has a return
1294 type of @code{int}.  Examples are nearly everything except a kernel.
1295 This is equivalent to @option{-fno-freestanding}.
1297 @item -ffreestanding
1298 @opindex ffreestanding
1299 @cindex hosted environment
1301 Assert that compilation takes place in a freestanding environment.  This
1302 implies @option{-fno-builtin}.  A freestanding environment
1303 is one in which the standard library may not exist, and program startup may
1304 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1305 This is equivalent to @option{-fno-hosted}.
1307 @xref{Standards,,Language Standards Supported by GCC}, for details of
1308 freestanding and hosted environments.
1310 @item -fopenmp
1311 @opindex fopenmp
1312 @cindex openmp parallel
1313 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1314 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1315 compiler generates parallel code according to the OpenMP Application
1316 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.
1318 @item -fms-extensions
1319 @opindex fms-extensions
1320 Accept some non-standard constructs used in Microsoft header files.
1322 Some cases of unnamed fields in structures and unions are only
1323 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1324 fields within structs/unions}, for details.
1326 @item -trigraphs
1327 @opindex trigraphs
1328 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1329 options for strict ISO C conformance) implies @option{-trigraphs}.
1331 @item -no-integrated-cpp
1332 @opindex no-integrated-cpp
1333 Performs a compilation in two passes: preprocessing and compiling.  This
1334 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1335 @option{-B} option.  The user supplied compilation step can then add in
1336 an additional preprocessing step after normal preprocessing but before
1337 compiling.  The default is to use the integrated cpp (internal cpp)
1339 The semantics of this option will change if "cc1", "cc1plus", and
1340 "cc1obj" are merged.
1342 @cindex traditional C language
1343 @cindex C language, traditional
1344 @item -traditional
1345 @itemx -traditional-cpp
1346 @opindex traditional-cpp
1347 @opindex traditional
1348 Formerly, these options caused GCC to attempt to emulate a pre-standard
1349 C compiler.  They are now only supported with the @option{-E} switch.
1350 The preprocessor continues to support a pre-standard mode.  See the GNU
1351 CPP manual for details.
1353 @item -fcond-mismatch
1354 @opindex fcond-mismatch
1355 Allow conditional expressions with mismatched types in the second and
1356 third arguments.  The value of such an expression is void.  This option
1357 is not supported for C++.
1359 @item -funsigned-char
1360 @opindex funsigned-char
1361 Let the type @code{char} be unsigned, like @code{unsigned char}.
1363 Each kind of machine has a default for what @code{char} should
1364 be.  It is either like @code{unsigned char} by default or like
1365 @code{signed char} by default.
1367 Ideally, a portable program should always use @code{signed char} or
1368 @code{unsigned char} when it depends on the signedness of an object.
1369 But many programs have been written to use plain @code{char} and
1370 expect it to be signed, or expect it to be unsigned, depending on the
1371 machines they were written for.  This option, and its inverse, let you
1372 make such a program work with the opposite default.
1374 The type @code{char} is always a distinct type from each of
1375 @code{signed char} or @code{unsigned char}, even though its behavior
1376 is always just like one of those two.
1378 @item -fsigned-char
1379 @opindex fsigned-char
1380 Let the type @code{char} be signed, like @code{signed char}.
1382 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1383 the negative form of @option{-funsigned-char}.  Likewise, the option
1384 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1386 @item -fsigned-bitfields
1387 @itemx -funsigned-bitfields
1388 @itemx -fno-signed-bitfields
1389 @itemx -fno-unsigned-bitfields
1390 @opindex fsigned-bitfields
1391 @opindex funsigned-bitfields
1392 @opindex fno-signed-bitfields
1393 @opindex fno-unsigned-bitfields
1394 These options control whether a bit-field is signed or unsigned, when the
1395 declaration does not use either @code{signed} or @code{unsigned}.  By
1396 default, such a bit-field is signed, because this is consistent: the
1397 basic integer types such as @code{int} are signed types.
1398 @end table
1400 @node C++ Dialect Options
1401 @section Options Controlling C++ Dialect
1403 @cindex compiler options, C++
1404 @cindex C++ options, command line
1405 @cindex options, C++
1406 This section describes the command-line options that are only meaningful
1407 for C++ programs; but you can also use most of the GNU compiler options
1408 regardless of what language your program is in.  For example, you
1409 might compile a file @code{firstClass.C} like this:
1411 @smallexample
1412 g++ -g -frepo -O -c firstClass.C
1413 @end smallexample
1415 @noindent
1416 In this example, only @option{-frepo} is an option meant
1417 only for C++ programs; you can use the other options with any
1418 language supported by GCC@.
1420 Here is a list of options that are @emph{only} for compiling C++ programs:
1422 @table @gcctabopt
1424 @item -fabi-version=@var{n}
1425 @opindex fabi-version
1426 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1427 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1428 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1429 the version that conforms most closely to the C++ ABI specification.
1430 Therefore, the ABI obtained using version 0 will change as ABI bugs
1431 are fixed.
1433 The default is version 2.
1435 @item -fno-access-control
1436 @opindex fno-access-control
1437 Turn off all access checking.  This switch is mainly useful for working
1438 around bugs in the access control code.
1440 @item -fcheck-new
1441 @opindex fcheck-new
1442 Check that the pointer returned by @code{operator new} is non-null
1443 before attempting to modify the storage allocated.  This check is
1444 normally unnecessary because the C++ standard specifies that
1445 @code{operator new} will only return @code{0} if it is declared
1446 @samp{throw()}, in which case the compiler will always check the
1447 return value even without this option.  In all other cases, when
1448 @code{operator new} has a non-empty exception specification, memory
1449 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1450 @samp{new (nothrow)}.
1452 @item -fconserve-space
1453 @opindex fconserve-space
1454 Put uninitialized or runtime-initialized global variables into the
1455 common segment, as C does.  This saves space in the executable at the
1456 cost of not diagnosing duplicate definitions.  If you compile with this
1457 flag and your program mysteriously crashes after @code{main()} has
1458 completed, you may have an object that is being destroyed twice because
1459 two definitions were merged.
1461 This option is no longer useful on most targets, now that support has
1462 been added for putting variables into BSS without making them common.
1464 @item -ffriend-injection
1465 @opindex ffriend-injection
1466 Inject friend functions into the enclosing namespace, so that they are
1467 visible outside the scope of the class in which they are declared.
1468 Friend functions were documented to work this way in the old Annotated
1469 C++ Reference Manual, and versions of G++ before 4.1 always worked
1470 that way.  However, in ISO C++ a friend function which is not declared
1471 in an enclosing scope can only be found using argument dependent
1472 lookup.  This option causes friends to be injected as they were in
1473 earlier releases.
1475 This option is for compatibility, and may be removed in a future
1476 release of G++.
1478 @item -fno-elide-constructors
1479 @opindex fno-elide-constructors
1480 The C++ standard allows an implementation to omit creating a temporary
1481 which is only used to initialize another object of the same type.
1482 Specifying this option disables that optimization, and forces G++ to
1483 call the copy constructor in all cases.
1485 @item -fno-enforce-eh-specs
1486 @opindex fno-enforce-eh-specs
1487 Don't generate code to check for violation of exception specifications
1488 at runtime.  This option violates the C++ standard, but may be useful
1489 for reducing code size in production builds, much like defining
1490 @samp{NDEBUG}.  This does not give user code permission to throw
1491 exceptions in violation of the exception specifications; the compiler
1492 will still optimize based on the specifications, so throwing an
1493 unexpected exception will result in undefined behavior.
1495 @item -ffor-scope
1496 @itemx -fno-for-scope
1497 @opindex ffor-scope
1498 @opindex fno-for-scope
1499 If @option{-ffor-scope} is specified, the scope of variables declared in
1500 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1501 as specified by the C++ standard.
1502 If @option{-fno-for-scope} is specified, the scope of variables declared in
1503 a @i{for-init-statement} extends to the end of the enclosing scope,
1504 as was the case in old versions of G++, and other (traditional)
1505 implementations of C++.
1507 The default if neither flag is given to follow the standard,
1508 but to allow and give a warning for old-style code that would
1509 otherwise be invalid, or have different behavior.
1511 @item -fno-gnu-keywords
1512 @opindex fno-gnu-keywords
1513 Do not recognize @code{typeof} as a keyword, so that code can use this
1514 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1515 @option{-ansi} implies @option{-fno-gnu-keywords}.
1517 @item -fno-implicit-templates
1518 @opindex fno-implicit-templates
1519 Never emit code for non-inline templates which are instantiated
1520 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1521 @xref{Template Instantiation}, for more information.
1523 @item -fno-implicit-inline-templates
1524 @opindex fno-implicit-inline-templates
1525 Don't emit code for implicit instantiations of inline templates, either.
1526 The default is to handle inlines differently so that compiles with and
1527 without optimization will need the same set of explicit instantiations.
1529 @item -fno-implement-inlines
1530 @opindex fno-implement-inlines
1531 To save space, do not emit out-of-line copies of inline functions
1532 controlled by @samp{#pragma implementation}.  This will cause linker
1533 errors if these functions are not inlined everywhere they are called.
1535 @item -fms-extensions
1536 @opindex fms-extensions
1537 Disable pedantic warnings about constructs used in MFC, such as implicit
1538 int and getting a pointer to member function via non-standard syntax.
1540 @item -fno-nonansi-builtins
1541 @opindex fno-nonansi-builtins
1542 Disable built-in declarations of functions that are not mandated by
1543 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1544 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1546 @item -fno-operator-names
1547 @opindex fno-operator-names
1548 Do not treat the operator name keywords @code{and}, @code{bitand},
1549 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1550 synonyms as keywords.
1552 @item -fno-optional-diags
1553 @opindex fno-optional-diags
1554 Disable diagnostics that the standard says a compiler does not need to
1555 issue.  Currently, the only such diagnostic issued by G++ is the one for
1556 a name having multiple meanings within a class.
1558 @item -fpermissive
1559 @opindex fpermissive
1560 Downgrade some diagnostics about nonconformant code from errors to
1561 warnings.  Thus, using @option{-fpermissive} will allow some
1562 nonconforming code to compile.
1564 @item -frepo
1565 @opindex frepo
1566 Enable automatic template instantiation at link time.  This option also
1567 implies @option{-fno-implicit-templates}.  @xref{Template
1568 Instantiation}, for more information.
1570 @item -fno-rtti
1571 @opindex fno-rtti
1572 Disable generation of information about every class with virtual
1573 functions for use by the C++ runtime type identification features
1574 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1575 of the language, you can save some space by using this flag.  Note that
1576 exception handling uses the same information, but it will generate it as
1577 needed. The @samp{dynamic_cast} operator can still be used for casts that
1578 do not require runtime type information, i.e. casts to @code{void *} or to
1579 unambiguous base classes.
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 -fno-use-cxa-get-exception-ptr
1609 @opindex fno-use-cxa-get-exception-ptr
1610 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1611 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1612 if the runtime routine is not available.
1614 @item -fvisibility-inlines-hidden
1615 @opindex fvisibility-inlines-hidden
1616 This switch declares that the user does not attempt to compare
1617 pointers to inline methods where the addresses of the two functions
1618 were taken in different shared objects.
1620 The effect of this is that GCC may, effectively, mark inline methods with
1621 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1622 appear in the export table of a DSO and do not require a PLT indirection
1623 when used within the DSO@.  Enabling this option can have a dramatic effect
1624 on load and link times of a DSO as it massively reduces the size of the
1625 dynamic export table when the library makes heavy use of templates.
1627 The behaviour of this switch is not quite the same as marking the
1628 methods as hidden directly, because it does not affect static variables
1629 local to the function or cause the compiler to deduce that
1630 the function is defined in only one shared object.
1632 You may mark a method as having a visibility explicitly to negate the
1633 effect of the switch for that method.  For example, if you do want to
1634 compare pointers to a particular inline method, you might mark it as
1635 having default visibility.  Marking the enclosing class with explicit
1636 visibility will have no effect.
1638 Explicitly instantiated inline methods are unaffected by this option
1639 as their linkage might otherwise cross a shared library boundary.
1640 @xref{Template Instantiation}.
1642 @item -fno-weak
1643 @opindex fno-weak
1644 Do not use weak symbol support, even if it is provided by the linker.
1645 By default, G++ will use weak symbols if they are available.  This
1646 option exists only for testing, and should not be used by end-users;
1647 it will result in inferior code and has no benefits.  This option may
1648 be removed in a future release of G++.
1650 @item -nostdinc++
1651 @opindex nostdinc++
1652 Do not search for header files in the standard directories specific to
1653 C++, but do still search the other standard directories.  (This option
1654 is used when building the C++ library.)
1655 @end table
1657 In addition, these optimization, warning, and code generation options
1658 have meanings only for C++ programs:
1660 @table @gcctabopt
1661 @item -fno-default-inline
1662 @opindex fno-default-inline
1663 Do not assume @samp{inline} for functions defined inside a class scope.
1664 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1665 functions will have linkage like inline functions; they just won't be
1666 inlined by default.
1668 @item -Wabi @r{(C++ only)}
1669 @opindex Wabi
1670 Warn when G++ generates code that is probably not compatible with the
1671 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1672 all such cases, there are probably some cases that are not warned about,
1673 even though G++ is generating incompatible code.  There may also be
1674 cases where warnings are emitted even though the code that is generated
1675 will be compatible.
1677 You should rewrite your code to avoid these warnings if you are
1678 concerned about the fact that code generated by G++ may not be binary
1679 compatible with code generated by other compilers.
1681 The known incompatibilities at this point include:
1683 @itemize @bullet
1685 @item
1686 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1687 pack data into the same byte as a base class.  For example:
1689 @smallexample
1690 struct A @{ virtual void f(); int f1 : 1; @};
1691 struct B : public A @{ int f2 : 1; @};
1692 @end smallexample
1694 @noindent
1695 In this case, G++ will place @code{B::f2} into the same byte
1696 as@code{A::f1}; other compilers will not.  You can avoid this problem
1697 by explicitly padding @code{A} so that its size is a multiple of the
1698 byte size on your platform; that will cause G++ and other compilers to
1699 layout @code{B} identically.
1701 @item
1702 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1703 tail padding when laying out virtual bases.  For example:
1705 @smallexample
1706 struct A @{ virtual void f(); char c1; @};
1707 struct B @{ B(); char c2; @};
1708 struct C : public A, public virtual B @{@};
1709 @end smallexample
1711 @noindent
1712 In this case, G++ will not place @code{B} into the tail-padding for
1713 @code{A}; other compilers will.  You can avoid this problem by
1714 explicitly padding @code{A} so that its size is a multiple of its
1715 alignment (ignoring virtual base classes); that will cause G++ and other
1716 compilers to layout @code{C} identically.
1718 @item
1719 Incorrect handling of bit-fields with declared widths greater than that
1720 of their underlying types, when the bit-fields appear in a union.  For
1721 example:
1723 @smallexample
1724 union U @{ int i : 4096; @};
1725 @end smallexample
1727 @noindent
1728 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1729 union too small by the number of bits in an @code{int}.
1731 @item
1732 Empty classes can be placed at incorrect offsets.  For example:
1734 @smallexample
1735 struct A @{@};
1737 struct B @{
1738   A a;
1739   virtual void f ();
1742 struct C : public B, public A @{@};
1743 @end smallexample
1745 @noindent
1746 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1747 it should be placed at offset zero.  G++ mistakenly believes that the
1748 @code{A} data member of @code{B} is already at offset zero.
1750 @item
1751 Names of template functions whose types involve @code{typename} or
1752 template template parameters can be mangled incorrectly.
1754 @smallexample
1755 template <typename Q>
1756 void f(typename Q::X) @{@}
1758 template <template <typename> class Q>
1759 void f(typename Q<int>::X) @{@}
1760 @end smallexample
1762 @noindent
1763 Instantiations of these templates may be mangled incorrectly.
1765 @end itemize
1767 @item -Wctor-dtor-privacy @r{(C++ only)}
1768 @opindex Wctor-dtor-privacy
1769 Warn when a class seems unusable because all the constructors or
1770 destructors in that class are private, and it has neither friends nor
1771 public static member functions.
1773 @item -Wnon-virtual-dtor @r{(C++ only)}
1774 @opindex Wnon-virtual-dtor
1775 Warn when a class appears to be polymorphic, thereby requiring a virtual
1776 destructor, yet it declares a non-virtual one.  This warning is also
1777 enabled if -Weffc++ is specified.
1779 @item -Wreorder @r{(C++ only)}
1780 @opindex Wreorder
1781 @cindex reordering, warning
1782 @cindex warning for reordering of member initializers
1783 Warn when the order of member initializers given in the code does not
1784 match the order in which they must be executed.  For instance:
1786 @smallexample
1787 struct A @{
1788   int i;
1789   int j;
1790   A(): j (0), i (1) @{ @}
1792 @end smallexample
1794 The compiler will rearrange the member initializers for @samp{i}
1795 and @samp{j} to match the declaration order of the members, emitting
1796 a warning to that effect.  This warning is enabled by @option{-Wall}.
1797 @end table
1799 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1801 @table @gcctabopt
1802 @item -Weffc++ @r{(C++ only)}
1803 @opindex Weffc++
1804 Warn about violations of the following style guidelines from Scott Meyers'
1805 @cite{Effective C++} book:
1807 @itemize @bullet
1808 @item
1809 Item 11:  Define a copy constructor and an assignment operator for classes
1810 with dynamically allocated memory.
1812 @item
1813 Item 12:  Prefer initialization to assignment in constructors.
1815 @item
1816 Item 14:  Make destructors virtual in base classes.
1818 @item
1819 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1821 @item
1822 Item 23:  Don't try to return a reference when you must return an object.
1824 @end itemize
1826 Also warn about violations of the following style guidelines from
1827 Scott Meyers' @cite{More Effective C++} book:
1829 @itemize @bullet
1830 @item
1831 Item 6:  Distinguish between prefix and postfix forms of increment and
1832 decrement operators.
1834 @item
1835 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1837 @end itemize
1839 When selecting this option, be aware that the standard library
1840 headers do not obey all of these guidelines; use @samp{grep -v}
1841 to filter out those warnings.
1843 @item -Wno-deprecated @r{(C++ only)}
1844 @opindex Wno-deprecated
1845 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1847 @item -Wstrict-null-sentinel @r{(C++ only)}
1848 @opindex Wstrict-null-sentinel
1849 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1850 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1851 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1852 it is guaranteed to of the same size as a pointer.  But this use is
1853 not portable across different compilers.
1855 @item -Wno-non-template-friend @r{(C++ only)}
1856 @opindex Wno-non-template-friend
1857 Disable warnings when non-templatized friend functions are declared
1858 within a template.  Since the advent of explicit template specification
1859 support in G++, if the name of the friend is an unqualified-id (i.e.,
1860 @samp{friend foo(int)}), the C++ language specification demands that the
1861 friend declare or define an ordinary, nontemplate function.  (Section
1862 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1863 could be interpreted as a particular specialization of a templatized
1864 function.  Because this non-conforming behavior is no longer the default
1865 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1866 check existing code for potential trouble spots and is on by default.
1867 This new compiler behavior can be turned off with
1868 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1869 but disables the helpful warning.
1871 @item -Wold-style-cast @r{(C++ only)}
1872 @opindex Wold-style-cast
1873 Warn if an old-style (C-style) cast to a non-void type is used within
1874 a C++ program.  The new-style casts (@samp{dynamic_cast},
1875 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1876 less vulnerable to unintended effects and much easier to search for.
1878 @item -Woverloaded-virtual @r{(C++ only)}
1879 @opindex Woverloaded-virtual
1880 @cindex overloaded virtual fn, warning
1881 @cindex warning for overloaded virtual fn
1882 Warn when a function declaration hides virtual functions from a
1883 base class.  For example, in:
1885 @smallexample
1886 struct A @{
1887   virtual void f();
1890 struct B: public A @{
1891   void f(int);
1893 @end smallexample
1895 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1896 like:
1898 @smallexample
1899 B* b;
1900 b->f();
1901 @end smallexample
1903 will fail to compile.
1905 @item -Wno-pmf-conversions @r{(C++ only)}
1906 @opindex Wno-pmf-conversions
1907 Disable the diagnostic for converting a bound pointer to member function
1908 to a plain pointer.
1910 @item -Wsign-promo @r{(C++ only)}
1911 @opindex Wsign-promo
1912 Warn when overload resolution chooses a promotion from unsigned or
1913 enumerated type to a signed type, over a conversion to an unsigned type of
1914 the same size.  Previous versions of G++ would try to preserve
1915 unsignedness, but the standard mandates the current behavior.
1917 @smallexample
1918 struct A @{
1919   operator int ();
1920   A& operator = (int);
1923 main ()
1925   A a,b;
1926   a = b;
1928 @end smallexample
1930 In this example, G++ will synthesize a default @samp{A& operator =
1931 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1932 @end table
1934 @node Objective-C and Objective-C++ Dialect Options
1935 @section Options Controlling Objective-C and Objective-C++ Dialects
1937 @cindex compiler options, Objective-C and Objective-C++
1938 @cindex Objective-C and Objective-C++ options, command line
1939 @cindex options, Objective-C and Objective-C++
1940 (NOTE: This manual does not describe the Objective-C and Objective-C++
1941 languages themselves.  See @xref{Standards,,Language Standards
1942 Supported by GCC}, for references.)
1944 This section describes the command-line options that are only meaningful
1945 for Objective-C and Objective-C++ programs, but you can also use most of
1946 the language-independent GNU compiler options.
1947 For example, you might compile a file @code{some_class.m} like this:
1949 @smallexample
1950 gcc -g -fgnu-runtime -O -c some_class.m
1951 @end smallexample
1953 @noindent
1954 In this example, @option{-fgnu-runtime} is an option meant only for
1955 Objective-C and Objective-C++ programs; you can use the other options with
1956 any language supported by GCC@.
1958 Note that since Objective-C is an extension of the C language, Objective-C
1959 compilations may also use options specific to the C front-end (e.g.,
1960 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1961 C++-specific options (e.g., @option{-Wabi}).
1963 Here is a list of options that are @emph{only} for compiling Objective-C
1964 and Objective-C++ programs:
1966 @table @gcctabopt
1967 @item -fconstant-string-class=@var{class-name}
1968 @opindex fconstant-string-class
1969 Use @var{class-name} as the name of the class to instantiate for each
1970 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1971 class name is @code{NXConstantString} if the GNU runtime is being used, and
1972 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1973 @option{-fconstant-cfstrings} option, if also present, will override the
1974 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1975 to be laid out as constant CoreFoundation strings.
1977 @item -fgnu-runtime
1978 @opindex fgnu-runtime
1979 Generate object code compatible with the standard GNU Objective-C
1980 runtime.  This is the default for most types of systems.
1982 @item -fnext-runtime
1983 @opindex fnext-runtime
1984 Generate output compatible with the NeXT runtime.  This is the default
1985 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1986 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1987 used.
1989 @item -fno-nil-receivers
1990 @opindex fno-nil-receivers
1991 Assume that all Objective-C message dispatches (e.g.,
1992 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1993 is not @code{nil}.  This allows for more efficient entry points in the runtime
1994 to be used.  Currently, this option is only available in conjunction with
1995 the NeXT runtime on Mac OS X 10.3 and later.
1997 @item -fobjc-call-cxx-cdtors
1998 @opindex fobjc-call-cxx-cdtors
1999 For each Objective-C class, check if any of its instance variables is a
2000 C++ object with a non-trivial default constructor.  If so, synthesize a
2001 special @code{- (id) .cxx_construct} instance method that will run
2002 non-trivial default constructors on any such instance variables, in order,
2003 and then return @code{self}.  Similarly, check if any instance variable
2004 is a C++ object with a non-trivial destructor, and if so, synthesize a
2005 special @code{- (void) .cxx_destruct} method that will run
2006 all such default destructors, in reverse order.
2008 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2009 thusly generated will only operate on instance variables declared in the
2010 current Objective-C class, and not those inherited from superclasses.  It
2011 is the responsibility of the Objective-C runtime to invoke all such methods
2012 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2013 will be invoked by the runtime immediately after a new object
2014 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2015 be invoked immediately before the runtime deallocates an object instance.
2017 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2018 support for invoking the @code{- (id) .cxx_construct} and
2019 @code{- (void) .cxx_destruct} methods.
2021 @item -fobjc-direct-dispatch
2022 @opindex fobjc-direct-dispatch
2023 Allow fast jumps to the message dispatcher.  On Darwin this is
2024 accomplished via the comm page.
2026 @item -fobjc-exceptions
2027 @opindex fobjc-exceptions
2028 Enable syntactic support for structured exception handling in Objective-C,
2029 similar to what is offered by C++ and Java.  This option is
2030 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2031 earlier.
2033 @smallexample
2034   @@try @{
2035     @dots{}
2036        @@throw expr;
2037     @dots{}
2038   @}
2039   @@catch (AnObjCClass *exc) @{
2040     @dots{}
2041       @@throw expr;
2042     @dots{}
2043       @@throw;
2044     @dots{}
2045   @}
2046   @@catch (AnotherClass *exc) @{
2047     @dots{}
2048   @}
2049   @@catch (id allOthers) @{
2050     @dots{}
2051   @}
2052   @@finally @{
2053     @dots{}
2054       @@throw expr;
2055     @dots{}
2056   @}
2057 @end smallexample
2059 The @code{@@throw} statement may appear anywhere in an Objective-C or
2060 Objective-C++ program; when used inside of a @code{@@catch} block, the
2061 @code{@@throw} may appear without an argument (as shown above), in which case
2062 the object caught by the @code{@@catch} will be rethrown.
2064 Note that only (pointers to) Objective-C objects may be thrown and
2065 caught using this scheme.  When an object is thrown, it will be caught
2066 by the nearest @code{@@catch} clause capable of handling objects of that type,
2067 analogously to how @code{catch} blocks work in C++ and Java.  A
2068 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2069 any and all Objective-C exceptions not caught by previous @code{@@catch}
2070 clauses (if any).
2072 The @code{@@finally} clause, if present, will be executed upon exit from the
2073 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2074 regardless of whether any exceptions are thrown, caught or rethrown
2075 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2076 of the @code{finally} clause in Java.
2078 There are several caveats to using the new exception mechanism:
2080 @itemize @bullet
2081 @item
2082 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2083 idioms provided by the @code{NSException} class, the new
2084 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2085 systems, due to additional functionality needed in the (NeXT) Objective-C
2086 runtime.
2088 @item
2089 As mentioned above, the new exceptions do not support handling
2090 types other than Objective-C objects.   Furthermore, when used from
2091 Objective-C++, the Objective-C exception model does not interoperate with C++
2092 exceptions at this time.  This means you cannot @code{@@throw} an exception
2093 from Objective-C and @code{catch} it in C++, or vice versa
2094 (i.e., @code{throw @dots{} @@catch}).
2095 @end itemize
2097 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2098 blocks for thread-safe execution:
2100 @smallexample
2101   @@synchronized (ObjCClass *guard) @{
2102     @dots{}
2103   @}
2104 @end smallexample
2106 Upon entering the @code{@@synchronized} block, a thread of execution shall
2107 first check whether a lock has been placed on the corresponding @code{guard}
2108 object by another thread.  If it has, the current thread shall wait until
2109 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2110 the current thread will place its own lock on it, execute the code contained in
2111 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2112 making @code{guard} available to other threads).
2114 Unlike Java, Objective-C does not allow for entire methods to be marked
2115 @code{@@synchronized}.  Note that throwing exceptions out of
2116 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2117 to be unlocked properly.
2119 @item -fobjc-gc
2120 @opindex fobjc-gc
2121 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2123 @item -freplace-objc-classes
2124 @opindex freplace-objc-classes
2125 Emit a special marker instructing @command{ld(1)} not to statically link in
2126 the resulting object file, and allow @command{dyld(1)} to load it in at
2127 run time instead.  This is used in conjunction with the Fix-and-Continue
2128 debugging mode, where the object file in question may be recompiled and
2129 dynamically reloaded in the course of program execution, without the need
2130 to restart the program itself.  Currently, Fix-and-Continue functionality
2131 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2132 and later.
2134 @item -fzero-link
2135 @opindex fzero-link
2136 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2137 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2138 compile time) with static class references that get initialized at load time,
2139 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2140 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2141 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2142 for individual class implementations to be modified during program execution.
2144 @item -gen-decls
2145 @opindex gen-decls
2146 Dump interface declarations for all classes seen in the source file to a
2147 file named @file{@var{sourcename}.decl}.
2149 @item -Wassign-intercept
2150 @opindex Wassign-intercept
2151 Warn whenever an Objective-C assignment is being intercepted by the
2152 garbage collector.
2154 @item -Wno-protocol
2155 @opindex Wno-protocol
2156 If a class is declared to implement a protocol, a warning is issued for
2157 every method in the protocol that is not implemented by the class.  The
2158 default behavior is to issue a warning for every method not explicitly
2159 implemented in the class, even if a method implementation is inherited
2160 from the superclass.  If you use the @option{-Wno-protocol} option, then
2161 methods inherited from the superclass are considered to be implemented,
2162 and no warning is issued for them.
2164 @item -Wselector
2165 @opindex Wselector
2166 Warn if multiple methods of different types for the same selector are
2167 found during compilation.  The check is performed on the list of methods
2168 in the final stage of compilation.  Additionally, a check is performed
2169 for each selector appearing in a @code{@@selector(@dots{})}
2170 expression, and a corresponding method for that selector has been found
2171 during compilation.  Because these checks scan the method table only at
2172 the end of compilation, these warnings are not produced if the final
2173 stage of compilation is not reached, for example because an error is
2174 found during compilation, or because the @option{-fsyntax-only} option is
2175 being used.
2177 @item -Wstrict-selector-match
2178 @opindex Wstrict-selector-match
2179 Warn if multiple methods with differing argument and/or return types are
2180 found for a given selector when attempting to send a message using this
2181 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2182 is off (which is the default behavior), the compiler will omit such warnings
2183 if any differences found are confined to types which share the same size
2184 and alignment.
2186 @item -Wundeclared-selector
2187 @opindex Wundeclared-selector
2188 Warn if a @code{@@selector(@dots{})} expression referring to an
2189 undeclared selector is found.  A selector is considered undeclared if no
2190 method with that name has been declared before the
2191 @code{@@selector(@dots{})} expression, either explicitly in an
2192 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2193 an @code{@@implementation} section.  This option always performs its
2194 checks as soon as a @code{@@selector(@dots{})} expression is found,
2195 while @option{-Wselector} only performs its checks in the final stage of
2196 compilation.  This also enforces the coding style convention
2197 that methods and selectors must be declared before being used.
2199 @item -print-objc-runtime-info
2200 @opindex print-objc-runtime-info
2201 Generate C header describing the largest structure that is passed by
2202 value, if any.
2204 @end table
2206 @node Language Independent Options
2207 @section Options to Control Diagnostic Messages Formatting
2208 @cindex options to control diagnostics formatting
2209 @cindex diagnostic messages
2210 @cindex message formatting
2212 Traditionally, diagnostic messages have been formatted irrespective of
2213 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2214 below can be used to control the diagnostic messages formatting
2215 algorithm, e.g.@: how many characters per line, how often source location
2216 information should be reported.  Right now, only the C++ front end can
2217 honor these options.  However it is expected, in the near future, that
2218 the remaining front ends would be able to digest them correctly.
2220 @table @gcctabopt
2221 @item -fmessage-length=@var{n}
2222 @opindex fmessage-length
2223 Try to format error messages so that they fit on lines of about @var{n}
2224 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2225 the front ends supported by GCC@.  If @var{n} is zero, then no
2226 line-wrapping will be done; each error message will appear on a single
2227 line.
2229 @opindex fdiagnostics-show-location
2230 @item -fdiagnostics-show-location=once
2231 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2232 reporter to emit @emph{once} source location information; that is, in
2233 case the message is too long to fit on a single physical line and has to
2234 be wrapped, the source location won't be emitted (as prefix) again,
2235 over and over, in subsequent continuation lines.  This is the default
2236 behavior.
2238 @item -fdiagnostics-show-location=every-line
2239 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2240 messages reporter to emit the same source location information (as
2241 prefix) for physical lines that result from the process of breaking
2242 a message which is too long to fit on a single line.
2244 @item -fdiagnostics-show-option
2245 @opindex fdiagnostics-show-option
2246 This option instructs the diagnostic machinery to add text to each
2247 diagnostic emitted, which indicates which command line option directly
2248 controls that diagnostic, when such an option is known to the
2249 diagnostic machinery.
2251 @end table
2253 @node Warning Options
2254 @section Options to Request or Suppress Warnings
2255 @cindex options to control warnings
2256 @cindex warning messages
2257 @cindex messages, warning
2258 @cindex suppressing warnings
2260 Warnings are diagnostic messages that report constructions which
2261 are not inherently erroneous but which are risky or suggest there
2262 may have been an error.
2264 You can request many specific warnings with options beginning @samp{-W},
2265 for example @option{-Wimplicit} to request warnings on implicit
2266 declarations.  Each of these specific warning options also has a
2267 negative form beginning @samp{-Wno-} to turn off warnings;
2268 for example, @option{-Wno-implicit}.  This manual lists only one of the
2269 two forms, whichever is not the default.
2271 The following options control the amount and kinds of warnings produced
2272 by GCC; for further, language-specific options also refer to
2273 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2274 Options}.
2276 @table @gcctabopt
2277 @cindex syntax checking
2278 @item -fsyntax-only
2279 @opindex fsyntax-only
2280 Check the code for syntax errors, but don't do anything beyond that.
2282 @item -pedantic
2283 @opindex pedantic
2284 Issue all the warnings demanded by strict ISO C and ISO C++;
2285 reject all programs that use forbidden extensions, and some other
2286 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2287 version of the ISO C standard specified by any @option{-std} option used.
2289 Valid ISO C and ISO C++ programs should compile properly with or without
2290 this option (though a rare few will require @option{-ansi} or a
2291 @option{-std} option specifying the required version of ISO C)@.  However,
2292 without this option, certain GNU extensions and traditional C and C++
2293 features are supported as well.  With this option, they are rejected.
2295 @option{-pedantic} does not cause warning messages for use of the
2296 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2297 warnings are also disabled in the expression that follows
2298 @code{__extension__}.  However, only system header files should use
2299 these escape routes; application programs should avoid them.
2300 @xref{Alternate Keywords}.
2302 Some users try to use @option{-pedantic} to check programs for strict ISO
2303 C conformance.  They soon find that it does not do quite what they want:
2304 it finds some non-ISO practices, but not all---only those for which
2305 ISO C @emph{requires} a diagnostic, and some others for which
2306 diagnostics have been added.
2308 A feature to report any failure to conform to ISO C might be useful in
2309 some instances, but would require considerable additional work and would
2310 be quite different from @option{-pedantic}.  We don't have plans to
2311 support such a feature in the near future.
2313 Where the standard specified with @option{-std} represents a GNU
2314 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2315 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2316 extended dialect is based.  Warnings from @option{-pedantic} are given
2317 where they are required by the base standard.  (It would not make sense
2318 for such warnings to be given only for features not in the specified GNU
2319 C dialect, since by definition the GNU dialects of C include all
2320 features the compiler supports with the given option, and there would be
2321 nothing to warn about.)
2323 @item -pedantic-errors
2324 @opindex pedantic-errors
2325 Like @option{-pedantic}, except that errors are produced rather than
2326 warnings.
2328 @item -w
2329 @opindex w
2330 Inhibit all warning messages.
2332 @item -Wno-import
2333 @opindex Wno-import
2334 Inhibit warning messages about the use of @samp{#import}.
2336 @item -Wchar-subscripts
2337 @opindex Wchar-subscripts
2338 Warn if an array subscript has type @code{char}.  This is a common cause
2339 of error, as programmers often forget that this type is signed on some
2340 machines.
2341 This warning is enabled by @option{-Wall}.
2343 @item -Wcomment
2344 @opindex Wcomment
2345 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2346 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2347 This warning is enabled by @option{-Wall}.
2349 @item -Wfatal-errors
2350 @opindex Wfatal-errors
2351 This option causes the compiler to abort compilation on the first error
2352 occurred rather than trying to keep going and printing further error
2353 messages.
2355 @item -Wformat
2356 @opindex Wformat
2357 @opindex ffreestanding
2358 @opindex fno-builtin
2359 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2360 the arguments supplied have types appropriate to the format string
2361 specified, and that the conversions specified in the format string make
2362 sense.  This includes standard functions, and others specified by format
2363 attributes (@pxref{Function Attributes}), in the @code{printf},
2364 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2365 not in the C standard) families (or other target-specific families).
2366 Which functions are checked without format attributes having been
2367 specified depends on the standard version selected, and such checks of
2368 functions without the attribute specified are disabled by
2369 @option{-ffreestanding} or @option{-fno-builtin}.
2371 The formats are checked against the format features supported by GNU
2372 libc version 2.2.  These include all ISO C90 and C99 features, as well
2373 as features from the Single Unix Specification and some BSD and GNU
2374 extensions.  Other library implementations may not support all these
2375 features; GCC does not support warning about features that go beyond a
2376 particular library's limitations.  However, if @option{-pedantic} is used
2377 with @option{-Wformat}, warnings will be given about format features not
2378 in the selected standard version (but not for @code{strfmon} formats,
2379 since those are not in any version of the C standard).  @xref{C Dialect
2380 Options,,Options Controlling C Dialect}.
2382 Since @option{-Wformat} also checks for null format arguments for
2383 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2385 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2386 aspects of format checking, the options @option{-Wformat-y2k},
2387 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2388 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2389 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2391 @item -Wformat-y2k
2392 @opindex Wformat-y2k
2393 If @option{-Wformat} is specified, also warn about @code{strftime}
2394 formats which may yield only a two-digit year.
2396 @item -Wno-format-extra-args
2397 @opindex Wno-format-extra-args
2398 If @option{-Wformat} is specified, do not warn about excess arguments to a
2399 @code{printf} or @code{scanf} format function.  The C standard specifies
2400 that such arguments are ignored.
2402 Where the unused arguments lie between used arguments that are
2403 specified with @samp{$} operand number specifications, normally
2404 warnings are still given, since the implementation could not know what
2405 type to pass to @code{va_arg} to skip the unused arguments.  However,
2406 in the case of @code{scanf} formats, this option will suppress the
2407 warning if the unused arguments are all pointers, since the Single
2408 Unix Specification says that such unused arguments are allowed.
2410 @item -Wno-format-zero-length
2411 @opindex Wno-format-zero-length
2412 If @option{-Wformat} is specified, do not warn about zero-length formats.
2413 The C standard specifies that zero-length formats are allowed.
2415 @item -Wformat-nonliteral
2416 @opindex Wformat-nonliteral
2417 If @option{-Wformat} is specified, also warn if the format string is not a
2418 string literal and so cannot be checked, unless the format function
2419 takes its format arguments as a @code{va_list}.
2421 @item -Wformat-security
2422 @opindex Wformat-security
2423 If @option{-Wformat} is specified, also warn about uses of format
2424 functions that represent possible security problems.  At present, this
2425 warns about calls to @code{printf} and @code{scanf} functions where the
2426 format string is not a string literal and there are no format arguments,
2427 as in @code{printf (foo);}.  This may be a security hole if the format
2428 string came from untrusted input and contains @samp{%n}.  (This is
2429 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2430 in future warnings may be added to @option{-Wformat-security} that are not
2431 included in @option{-Wformat-nonliteral}.)
2433 @item -Wformat=2
2434 @opindex Wformat=2
2435 Enable @option{-Wformat} plus format checks not included in
2436 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2437 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2439 @item -Wnonnull
2440 @opindex Wnonnull
2441 Warn about passing a null pointer for arguments marked as
2442 requiring a non-null value by the @code{nonnull} function attribute.
2444 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2445 can be disabled with the @option{-Wno-nonnull} option.
2447 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2448 @opindex Winit-self
2449 Warn about uninitialized variables which are initialized with themselves.
2450 Note this option can only be used with the @option{-Wuninitialized} option,
2451 which in turn only works with @option{-O1} and above.
2453 For example, GCC will warn about @code{i} being uninitialized in the
2454 following snippet only when @option{-Winit-self} has been specified:
2455 @smallexample
2456 @group
2457 int f()
2459   int i = i;
2460   return i;
2462 @end group
2463 @end smallexample
2465 @item -Wimplicit-int
2466 @opindex Wimplicit-int
2467 Warn when a declaration does not specify a type.
2468 This warning is enabled by @option{-Wall}.
2470 @item -Wimplicit-function-declaration
2471 @itemx -Werror-implicit-function-declaration
2472 @opindex Wimplicit-function-declaration
2473 @opindex Werror-implicit-function-declaration
2474 Give a warning (or error) whenever a function is used before being
2475 declared.  The form @option{-Wno-error-implicit-function-declaration}
2476 is not supported.
2477 This warning is enabled by @option{-Wall} (as a warning, not an error).
2479 @item -Wimplicit
2480 @opindex Wimplicit
2481 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2482 This warning is enabled by @option{-Wall}.
2484 @item -Wmain
2485 @opindex Wmain
2486 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2487 function with external linkage, returning int, taking either zero
2488 arguments, two, or three arguments of appropriate types.
2489 This warning is enabled by @option{-Wall}.
2491 @item -Wmissing-braces
2492 @opindex Wmissing-braces
2493 Warn if an aggregate or union initializer is not fully bracketed.  In
2494 the following example, the initializer for @samp{a} is not fully
2495 bracketed, but that for @samp{b} is fully bracketed.
2497 @smallexample
2498 int a[2][2] = @{ 0, 1, 2, 3 @};
2499 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2500 @end smallexample
2502 This warning is enabled by @option{-Wall}.
2504 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2505 @opindex Wmissing-include-dirs
2506 Warn if a user-supplied include directory does not exist.
2508 @item -Wparentheses
2509 @opindex Wparentheses
2510 Warn if parentheses are omitted in certain contexts, such
2511 as when there is an assignment in a context where a truth value
2512 is expected, or when operators are nested whose precedence people
2513 often get confused about.  Only the warning for an assignment used as
2514 a truth value is supported when compiling C++; the other warnings are
2515 only supported when compiling C@.
2517 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2518 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2519 interpretation from that of ordinary mathematical notation.
2521 Also warn about constructions where there may be confusion to which
2522 @code{if} statement an @code{else} branch belongs.  Here is an example of
2523 such a case:
2525 @smallexample
2526 @group
2528   if (a)
2529     if (b)
2530       foo ();
2531   else
2532     bar ();
2534 @end group
2535 @end smallexample
2537 In C, every @code{else} branch belongs to the innermost possible @code{if}
2538 statement, which in this example is @code{if (b)}.  This is often not
2539 what the programmer expected, as illustrated in the above example by
2540 indentation the programmer chose.  When there is the potential for this
2541 confusion, GCC will issue a warning when this flag is specified.
2542 To eliminate the warning, add explicit braces around the innermost
2543 @code{if} statement so there is no way the @code{else} could belong to
2544 the enclosing @code{if}.  The resulting code would look like this:
2546 @smallexample
2547 @group
2549   if (a)
2550     @{
2551       if (b)
2552         foo ();
2553       else
2554         bar ();
2555     @}
2557 @end group
2558 @end smallexample
2560 This warning is enabled by @option{-Wall}.
2562 @item -Wsequence-point
2563 @opindex Wsequence-point
2564 Warn about code that may have undefined semantics because of violations
2565 of sequence point rules in the C and C++ standards.
2567 The C and C++ standards defines the order in which expressions in a C/C++
2568 program are evaluated in terms of @dfn{sequence points}, which represent
2569 a partial ordering between the execution of parts of the program: those
2570 executed before the sequence point, and those executed after it.  These
2571 occur after the evaluation of a full expression (one which is not part
2572 of a larger expression), after the evaluation of the first operand of a
2573 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2574 function is called (but after the evaluation of its arguments and the
2575 expression denoting the called function), and in certain other places.
2576 Other than as expressed by the sequence point rules, the order of
2577 evaluation of subexpressions of an expression is not specified.  All
2578 these rules describe only a partial order rather than a total order,
2579 since, for example, if two functions are called within one expression
2580 with no sequence point between them, the order in which the functions
2581 are called is not specified.  However, the standards committee have
2582 ruled that function calls do not overlap.
2584 It is not specified when between sequence points modifications to the
2585 values of objects take effect.  Programs whose behavior depends on this
2586 have undefined behavior; the C and C++ standards specify that ``Between
2587 the previous and next sequence point an object shall have its stored
2588 value modified at most once by the evaluation of an expression.  
2589 Furthermore, the prior value shall be read only to determine the value
2590 to be stored.''.  If a program breaks these rules, the results on any
2591 particular implementation are entirely unpredictable.
2593 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2594 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2595 diagnosed by this option, and it may give an occasional false positive
2596 result, but in general it has been found fairly effective at detecting
2597 this sort of problem in programs.
2599 The standard is worded confusingly, therefore there is some debate
2600 over the precise meaning of the sequence point rules in subtle cases.
2601 Links to discussions of the problem, including proposed formal
2602 definitions, may be found on the GCC readings page, at
2603 @w{@uref{http://gcc.gnu.org/readings.html}}.
2605 This warning is enabled by @option{-Wall} for C and C++.
2607 @item -Wreturn-type
2608 @opindex Wreturn-type
2609 Warn whenever a function is defined with a return-type that defaults to
2610 @code{int}.  Also warn about any @code{return} statement with no
2611 return-value in a function whose return-type is not @code{void}.
2613 For C, also warn if the return type of a function has a type qualifier
2614 such as @code{const}.  Such a type qualifier has no effect, since the
2615 value returned by a function is not an lvalue.  ISO C prohibits
2616 qualified @code{void} return types on function definitions, so such
2617 return types always receive a warning even without this option.
2619 For C++, a function without return type always produces a diagnostic
2620 message, even when @option{-Wno-return-type} is specified.  The only
2621 exceptions are @samp{main} and functions defined in system headers.
2623 This warning is enabled by @option{-Wall}.
2625 @item -Wswitch
2626 @opindex Wswitch
2627 Warn whenever a @code{switch} statement has an index of enumerated type
2628 and lacks a @code{case} for one or more of the named codes of that
2629 enumeration.  (The presence of a @code{default} label prevents this
2630 warning.)  @code{case} labels outside the enumeration range also
2631 provoke warnings when this option is used.
2632 This warning is enabled by @option{-Wall}.
2634 @item -Wswitch-default
2635 @opindex Wswitch-switch
2636 Warn whenever a @code{switch} statement does not have a @code{default}
2637 case.
2639 @item -Wswitch-enum
2640 @opindex Wswitch-enum
2641 Warn whenever a @code{switch} statement has an index of enumerated type
2642 and lacks a @code{case} for one or more of the named codes of that
2643 enumeration.  @code{case} labels outside the enumeration range also
2644 provoke warnings when this option is used.
2646 @item -Wtrigraphs
2647 @opindex Wtrigraphs
2648 Warn if any trigraphs are encountered that might change the meaning of
2649 the program (trigraphs within comments are not warned about).
2650 This warning is enabled by @option{-Wall}.
2652 @item -Wunused-function
2653 @opindex Wunused-function
2654 Warn whenever a static function is declared but not defined or a
2655 non-inline static function is unused.
2656 This warning is enabled by @option{-Wall}.
2658 @item -Wunused-label
2659 @opindex Wunused-label
2660 Warn whenever a label is declared but not used.
2661 This warning is enabled by @option{-Wall}.
2663 To suppress this warning use the @samp{unused} attribute
2664 (@pxref{Variable Attributes}).
2666 @item -Wunused-parameter
2667 @opindex Wunused-parameter
2668 Warn whenever a function parameter is unused aside from its declaration.
2670 To suppress this warning use the @samp{unused} attribute
2671 (@pxref{Variable Attributes}).
2673 @item -Wunused-variable
2674 @opindex Wunused-variable
2675 Warn whenever a local variable or non-constant static variable is unused
2676 aside from its declaration.
2677 This warning is enabled by @option{-Wall}.
2679 To suppress this warning use the @samp{unused} attribute
2680 (@pxref{Variable Attributes}).
2682 @item -Wunused-value
2683 @opindex Wunused-value
2684 Warn whenever a statement computes a result that is explicitly not used.
2685 This warning is enabled by @option{-Wall}.
2687 To suppress this warning cast the expression to @samp{void}.
2689 @item -Wunused
2690 @opindex Wunused
2691 All the above @option{-Wunused} options combined.
2693 In order to get a warning about an unused function parameter, you must
2694 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2695 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2697 @item -Wuninitialized
2698 @opindex Wuninitialized
2699 Warn if an automatic variable is used without first being initialized or
2700 if a variable may be clobbered by a @code{setjmp} call.
2702 These warnings are possible only in optimizing compilation,
2703 because they require data flow information that is computed only
2704 when optimizing.  If you do not specify @option{-O}, you will not get 
2705 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
2706 requiring @option{-O}.
2708 If you want to warn about code which uses the uninitialized value of the
2709 variable in its own initializer, use the @option{-Winit-self} option.
2711 These warnings occur for individual uninitialized or clobbered
2712 elements of structure, union or array variables as well as for
2713 variables which are uninitialized or clobbered as a whole.  They do
2714 not occur for variables or elements declared @code{volatile}.  Because
2715 these warnings depend on optimization, the exact variables or elements
2716 for which there are warnings will depend on the precise optimization
2717 options and version of GCC used.
2719 Note that there may be no warning about a variable that is used only
2720 to compute a value that itself is never used, because such
2721 computations may be deleted by data flow analysis before the warnings
2722 are printed.
2724 These warnings are made optional because GCC is not smart
2725 enough to see all the reasons why the code might be correct
2726 despite appearing to have an error.  Here is one example of how
2727 this can happen:
2729 @smallexample
2730 @group
2732   int x;
2733   switch (y)
2734     @{
2735     case 1: x = 1;
2736       break;
2737     case 2: x = 4;
2738       break;
2739     case 3: x = 5;
2740     @}
2741   foo (x);
2743 @end group
2744 @end smallexample
2746 @noindent
2747 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2748 always initialized, but GCC doesn't know this.  Here is
2749 another common case:
2751 @smallexample
2753   int save_y;
2754   if (change_y) save_y = y, y = new_y;
2755   @dots{}
2756   if (change_y) y = save_y;
2758 @end smallexample
2760 @noindent
2761 This has no bug because @code{save_y} is used only if it is set.
2763 @cindex @code{longjmp} warnings
2764 This option also warns when a non-volatile automatic variable might be
2765 changed by a call to @code{longjmp}.  These warnings as well are possible
2766 only in optimizing compilation.
2768 The compiler sees only the calls to @code{setjmp}.  It cannot know
2769 where @code{longjmp} will be called; in fact, a signal handler could
2770 call it at any point in the code.  As a result, you may get a warning
2771 even when there is in fact no problem because @code{longjmp} cannot
2772 in fact be called at the place which would cause a problem.
2774 Some spurious warnings can be avoided if you declare all the functions
2775 you use that never return as @code{noreturn}.  @xref{Function
2776 Attributes}.
2778 This warning is enabled by @option{-Wall}.
2780 @item -Wunknown-pragmas
2781 @opindex Wunknown-pragmas
2782 @cindex warning for unknown pragmas
2783 @cindex unknown pragmas, warning
2784 @cindex pragmas, warning of unknown
2785 Warn when a #pragma directive is encountered which is not understood by
2786 GCC@.  If this command line option is used, warnings will even be issued
2787 for unknown pragmas in system header files.  This is not the case if
2788 the warnings were only enabled by the @option{-Wall} command line option.
2790 @item -Wno-pragmas
2791 @opindex Wno-pragmas
2792 @opindex Wpragmas
2793 Do not warn about misuses of pragmas, such as incorrect parameters,
2794 invalid syntax, or conflicts between pragmas.  See also
2795 @samp{-Wunknown-pragmas}.
2797 @item -Wstrict-aliasing
2798 @opindex Wstrict-aliasing
2799 This option is only active when @option{-fstrict-aliasing} is active.
2800 It warns about code which might break the strict aliasing rules that the
2801 compiler is using for optimization.  The warning does not catch all
2802 cases, but does attempt to catch the more common pitfalls.  It is
2803 included in @option{-Wall}.
2805 @item -Wstrict-aliasing=2
2806 @opindex Wstrict-aliasing=2
2807 This option is only active when @option{-fstrict-aliasing} is active.
2808 It warns about code which might break the strict aliasing rules that the
2809 compiler is using for optimization.  This warning catches more cases than
2810 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2811 cases that are safe.
2813 @item -Wall
2814 @opindex Wall
2815 All of the above @samp{-W} options combined.  This enables all the
2816 warnings about constructions that some users consider questionable, and
2817 that are easy to avoid (or modify to prevent the warning), even in
2818 conjunction with macros.  This also enables some language-specific
2819 warnings described in @ref{C++ Dialect Options} and
2820 @ref{Objective-C and Objective-C++ Dialect Options}.
2821 @end table
2823 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2824 Some of them warn about constructions that users generally do not
2825 consider questionable, but which occasionally you might wish to check
2826 for; others warn about constructions that are necessary or hard to avoid
2827 in some cases, and there is no simple way to modify the code to suppress
2828 the warning.
2830 @table @gcctabopt
2831 @item -Wextra
2832 @opindex W
2833 @opindex Wextra
2834 (This option used to be called @option{-W}.  The older name is still
2835 supported, but the newer name is more descriptive.)  Print extra warning
2836 messages for these events:
2838 @itemize @bullet
2839 @item
2840 A function can return either with or without a value.  (Falling
2841 off the end of the function body is considered returning without
2842 a value.)  For example, this function would evoke such a
2843 warning:
2845 @smallexample
2846 @group
2847 foo (a)
2849   if (a > 0)
2850     return a;
2852 @end group
2853 @end smallexample
2855 @item
2856 An expression-statement or the left-hand side of a comma expression
2857 contains no side effects.
2858 To suppress the warning, cast the unused expression to void.
2859 For example, an expression such as @samp{x[i,j]} will cause a warning,
2860 but @samp{x[(void)i,j]} will not.
2862 @item
2863 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2865 @item
2866 Storage-class specifiers like @code{static} are not the first things in
2867 a declaration.  According to the C Standard, this usage is obsolescent.
2869 @item
2870 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2871 arguments.
2873 @item
2874 A comparison between signed and unsigned values could produce an
2875 incorrect result when the signed value is converted to unsigned.
2876 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2878 @item
2879 An aggregate has an initializer which does not initialize all members.
2880 This warning can be independently controlled by
2881 @option{-Wmissing-field-initializers}.
2883 @item
2884 An initialized field without side effects is overridden when using
2885 designated initializers (@pxref{Designated Inits, , Designated
2886 Initializers}).  This warning can be independently controlled by
2887 @option{-Woverride-init}.
2889 @item
2890 A function parameter is declared without a type specifier in K&R-style
2891 functions:
2893 @smallexample
2894 void foo(bar) @{ @}
2895 @end smallexample
2897 @item
2898 An empty body occurs in an @samp{if} or @samp{else} statement.
2900 @item
2901 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2902 @samp{>}, or @samp{>=}.
2904 @item
2905 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2907 @item
2908 Any of several floating-point events that often indicate errors, such as
2909 overflow, underflow, loss of precision, etc.
2911 @item @r{(C++ only)}
2912 An enumerator and a non-enumerator both appear in a conditional expression.
2914 @item @r{(C++ only)}
2915 A non-static reference or non-static @samp{const} member appears in a
2916 class without constructors.
2918 @item @r{(C++ only)}
2919 Ambiguous virtual bases.
2921 @item @r{(C++ only)}
2922 Subscripting an array which has been declared @samp{register}.
2924 @item @r{(C++ only)}
2925 Taking the address of a variable which has been declared @samp{register}.
2927 @item @r{(C++ only)}
2928 A base class is not initialized in a derived class' copy constructor.
2929 @end itemize
2931 @item -Wno-div-by-zero
2932 @opindex Wno-div-by-zero
2933 @opindex Wdiv-by-zero
2934 Do not warn about compile-time integer division by zero.  Floating point
2935 division by zero is not warned about, as it can be a legitimate way of
2936 obtaining infinities and NaNs.
2938 @item -Wsystem-headers
2939 @opindex Wsystem-headers
2940 @cindex warnings from system headers
2941 @cindex system headers, warnings from
2942 Print warning messages for constructs found in system header files.
2943 Warnings from system headers are normally suppressed, on the assumption
2944 that they usually do not indicate real problems and would only make the
2945 compiler output harder to read.  Using this command line option tells
2946 GCC to emit warnings from system headers as if they occurred in user
2947 code.  However, note that using @option{-Wall} in conjunction with this
2948 option will @emph{not} warn about unknown pragmas in system
2949 headers---for that, @option{-Wunknown-pragmas} must also be used.
2951 @item -Wfloat-equal
2952 @opindex Wfloat-equal
2953 Warn if floating point values are used in equality comparisons.
2955 The idea behind this is that sometimes it is convenient (for the
2956 programmer) to consider floating-point values as approximations to
2957 infinitely precise real numbers.  If you are doing this, then you need
2958 to compute (by analyzing the code, or in some other way) the maximum or
2959 likely maximum error that the computation introduces, and allow for it
2960 when performing comparisons (and when producing output, but that's a
2961 different problem).  In particular, instead of testing for equality, you
2962 would check to see whether the two values have ranges that overlap; and
2963 this is done with the relational operators, so equality comparisons are
2964 probably mistaken.
2966 @item -Wtraditional @r{(C only)}
2967 @opindex Wtraditional
2968 Warn about certain constructs that behave differently in traditional and
2969 ISO C@.  Also warn about ISO C constructs that have no traditional C
2970 equivalent, and/or problematic constructs which should be avoided.
2972 @itemize @bullet
2973 @item
2974 Macro parameters that appear within string literals in the macro body.
2975 In traditional C macro replacement takes place within string literals,
2976 but does not in ISO C@.
2978 @item
2979 In traditional C, some preprocessor directives did not exist.
2980 Traditional preprocessors would only consider a line to be a directive
2981 if the @samp{#} appeared in column 1 on the line.  Therefore
2982 @option{-Wtraditional} warns about directives that traditional C
2983 understands but would ignore because the @samp{#} does not appear as the
2984 first character on the line.  It also suggests you hide directives like
2985 @samp{#pragma} not understood by traditional C by indenting them.  Some
2986 traditional implementations would not recognize @samp{#elif}, so it
2987 suggests avoiding it altogether.
2989 @item
2990 A function-like macro that appears without arguments.
2992 @item
2993 The unary plus operator.
2995 @item
2996 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2997 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2998 constants.)  Note, these suffixes appear in macros defined in the system
2999 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3000 Use of these macros in user code might normally lead to spurious
3001 warnings, however GCC's integrated preprocessor has enough context to
3002 avoid warning in these cases.
3004 @item
3005 A function declared external in one block and then used after the end of
3006 the block.
3008 @item
3009 A @code{switch} statement has an operand of type @code{long}.
3011 @item
3012 A non-@code{static} function declaration follows a @code{static} one.
3013 This construct is not accepted by some traditional C compilers.
3015 @item
3016 The ISO type of an integer constant has a different width or
3017 signedness from its traditional type.  This warning is only issued if
3018 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3019 typically represent bit patterns, are not warned about.
3021 @item
3022 Usage of ISO string concatenation is detected.
3024 @item
3025 Initialization of automatic aggregates.
3027 @item
3028 Identifier conflicts with labels.  Traditional C lacks a separate
3029 namespace for labels.
3031 @item
3032 Initialization of unions.  If the initializer is zero, the warning is
3033 omitted.  This is done under the assumption that the zero initializer in
3034 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3035 initializer warnings and relies on default initialization to zero in the
3036 traditional C case.
3038 @item
3039 Conversions by prototypes between fixed/floating point values and vice
3040 versa.  The absence of these prototypes when compiling with traditional
3041 C would cause serious problems.  This is a subset of the possible
3042 conversion warnings, for the full set use @option{-Wconversion}.
3044 @item
3045 Use of ISO C style function definitions.  This warning intentionally is
3046 @emph{not} issued for prototype declarations or variadic functions
3047 because these ISO C features will appear in your code when using
3048 libiberty's traditional C compatibility macros, @code{PARAMS} and
3049 @code{VPARAMS}.  This warning is also bypassed for nested functions
3050 because that feature is already a GCC extension and thus not relevant to
3051 traditional C compatibility.
3052 @end itemize
3054 @item -Wdeclaration-after-statement @r{(C only)}
3055 @opindex Wdeclaration-after-statement
3056 Warn when a declaration is found after a statement in a block.  This
3057 construct, known from C++, was introduced with ISO C99 and is by default
3058 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3059 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3061 @item -Wundef
3062 @opindex Wundef
3063 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3065 @item -Wno-endif-labels
3066 @opindex Wno-endif-labels
3067 @opindex Wendif-labels
3068 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3070 @item -Wshadow
3071 @opindex Wshadow
3072 Warn whenever a local variable shadows another local variable, parameter or
3073 global variable or whenever a built-in function is shadowed.
3075 @item -Wlarger-than-@var{len}
3076 @opindex Wlarger-than
3077 Warn whenever an object of larger than @var{len} bytes is defined.
3079 @item -Wunsafe-loop-optimizations
3080 @opindex Wunsafe-loop-optimizations
3081 Warn if the loop cannot be optimized because the compiler could not
3082 assume anything on the bounds of the loop indices.  With
3083 @option{-funsafe-loop-optimizations} warn if the compiler made
3084 such assumptions.
3086 @item -Wpointer-arith
3087 @opindex Wpointer-arith
3088 Warn about anything that depends on the ``size of'' a function type or
3089 of @code{void}.  GNU C assigns these types a size of 1, for
3090 convenience in calculations with @code{void *} pointers and pointers
3091 to functions.
3093 @item -Wbad-function-cast @r{(C only)}
3094 @opindex Wbad-function-cast
3095 Warn whenever a function call is cast to a non-matching type.
3096 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3098 @item -Wc++-compat
3099 Warn about ISO C constructs that are outside of the common subset of
3100 ISO C and ISO C++, e.g.@: request for implicit conversion from
3101 @code{void *} to a pointer to non-@code{void} type.
3103 @item -Wcast-qual
3104 @opindex Wcast-qual
3105 Warn whenever a pointer is cast so as to remove a type qualifier from
3106 the target type.  For example, warn if a @code{const char *} is cast
3107 to an ordinary @code{char *}.
3109 @item -Wcast-align
3110 @opindex Wcast-align
3111 Warn whenever a pointer is cast such that the required alignment of the
3112 target is increased.  For example, warn if a @code{char *} is cast to
3113 an @code{int *} on machines where integers can only be accessed at
3114 two- or four-byte boundaries.
3116 @item -Wwrite-strings
3117 @opindex Wwrite-strings
3118 When compiling C, give string constants the type @code{const
3119 char[@var{length}]} so that
3120 copying the address of one into a non-@code{const} @code{char *}
3121 pointer will get a warning; when compiling C++, warn about the
3122 deprecated conversion from string literals to @code{char *}.  This
3123 warning, by default, is enabled for C++ programs.
3124 These warnings will help you find at
3125 compile time code that can try to write into a string constant, but
3126 only if you have been very careful about using @code{const} in
3127 declarations and prototypes.  Otherwise, it will just be a nuisance;
3128 this is why we did not make @option{-Wall} request these warnings.
3130 @item -Wconversion
3131 @opindex Wconversion
3132 Warn if a prototype causes a type conversion that is different from what
3133 would happen to the same argument in the absence of a prototype.  This
3134 includes conversions of fixed point to floating and vice versa, and
3135 conversions changing the width or signedness of a fixed point argument
3136 except when the same as the default promotion.
3138 Also, warn if a negative integer constant expression is implicitly
3139 converted to an unsigned type.  For example, warn about the assignment
3140 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3141 casts like @code{(unsigned) -1}.
3143 @item -Wsign-compare
3144 @opindex Wsign-compare
3145 @cindex warning for comparison of signed and unsigned values
3146 @cindex comparison of signed and unsigned values, warning
3147 @cindex signed and unsigned values, comparison warning
3148 Warn when a comparison between signed and unsigned values could produce
3149 an incorrect result when the signed value is converted to unsigned.
3150 This warning is also enabled by @option{-Wextra}; to get the other warnings
3151 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3153 @item -Waggregate-return
3154 @opindex Waggregate-return
3155 Warn if any functions that return structures or unions are defined or
3156 called.  (In languages where you can return an array, this also elicits
3157 a warning.)
3159 @item -Walways-true
3160 @opindex Walways-true
3161 Warn about comparisons which are always true such as testing if
3162 unsigned values are greater than or equal to zero.  This warning is
3163 enabled by @option{-Wall}.
3165 @item -Wno-attributes
3166 @opindex Wno-attributes
3167 @opindex Wattributes
3168 Do not warn if an unexpected @code{__attribute__} is used, such as
3169 unrecognized attributes, function attributes applied to variables,
3170 etc.  This will not stop errors for incorrect use of supported
3171 attributes.
3173 @item -Wstrict-prototypes @r{(C only)}
3174 @opindex Wstrict-prototypes
3175 Warn if a function is declared or defined without specifying the
3176 argument types.  (An old-style function definition is permitted without
3177 a warning if preceded by a declaration which specifies the argument
3178 types.)
3180 @item -Wold-style-definition @r{(C only)}
3181 @opindex Wold-style-definition
3182 Warn if an old-style function definition is used.  A warning is given
3183 even if there is a previous prototype.
3185 @item -Wmissing-prototypes @r{(C only)}
3186 @opindex Wmissing-prototypes
3187 Warn if a global function is defined without a previous prototype
3188 declaration.  This warning is issued even if the definition itself
3189 provides a prototype.  The aim is to detect global functions that fail
3190 to be declared in header files.
3192 @item -Wmissing-declarations @r{(C only)}
3193 @opindex Wmissing-declarations
3194 Warn if a global function is defined without a previous declaration.
3195 Do so even if the definition itself provides a prototype.
3196 Use this option to detect global functions that are not declared in
3197 header files.
3199 @item -Wmissing-field-initializers
3200 @opindex Wmissing-field-initializers
3201 @opindex W
3202 @opindex Wextra
3203 Warn if a structure's initializer has some fields missing.  For
3204 example, the following code would cause such a warning, because
3205 @code{x.h} is implicitly zero:
3207 @smallexample
3208 struct s @{ int f, g, h; @};
3209 struct s x = @{ 3, 4 @};
3210 @end smallexample
3212 This option does not warn about designated initializers, so the following
3213 modification would not trigger a warning:
3215 @smallexample
3216 struct s @{ int f, g, h; @};
3217 struct s x = @{ .f = 3, .g = 4 @};
3218 @end smallexample
3220 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3221 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3223 @item -Wmissing-noreturn
3224 @opindex Wmissing-noreturn
3225 Warn about functions which might be candidates for attribute @code{noreturn}.
3226 Note these are only possible candidates, not absolute ones.  Care should
3227 be taken to manually verify functions actually do not ever return before
3228 adding the @code{noreturn} attribute, otherwise subtle code generation
3229 bugs could be introduced.  You will not get a warning for @code{main} in
3230 hosted C environments.
3232 @item -Wmissing-format-attribute
3233 @opindex Wmissing-format-attribute
3234 @opindex Wformat
3235 Warn about function pointers which might be candidates for @code{format}
3236 attributes.  Note these are only possible candidates, not absolute ones.
3237 GCC will guess that function pointers with @code{format} attributes that
3238 are used in assignment, initialization, parameter passing or return
3239 statements should have a corresponding @code{format} attribute in the
3240 resulting type.  I.e.@: the left-hand side of the assignment or
3241 initialization, the type of the parameter variable, or the return type
3242 of the containing function respectively should also have a @code{format}
3243 attribute to avoid the warning.
3245 GCC will also warn about function definitions which might be
3246 candidates for @code{format} attributes.  Again, these are only
3247 possible candidates.  GCC will guess that @code{format} attributes
3248 might be appropriate for any function that calls a function like
3249 @code{vprintf} or @code{vscanf}, but this might not always be the
3250 case, and some functions for which @code{format} attributes are
3251 appropriate may not be detected.
3253 @item -Wno-multichar
3254 @opindex Wno-multichar
3255 @opindex Wmultichar
3256 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3257 Usually they indicate a typo in the user's code, as they have
3258 implementation-defined values, and should not be used in portable code.
3260 @item -Wnormalized=<none|id|nfc|nfkc>
3261 @opindex Wnormalized
3262 @cindex NFC
3263 @cindex NFKC
3264 @cindex character set, input normalization
3265 In ISO C and ISO C++, two identifiers are different if they are
3266 different sequences of characters.  However, sometimes when characters
3267 outside the basic ASCII character set are used, you can have two
3268 different character sequences that look the same.  To avoid confusion,
3269 the ISO 10646 standard sets out some @dfn{normalization rules} which
3270 when applied ensure that two sequences that look the same are turned into
3271 the same sequence.  GCC can warn you if you are using identifiers which
3272 have not been normalized; this option controls that warning.
3274 There are four levels of warning that GCC supports.  The default is
3275 @option{-Wnormalized=nfc}, which warns about any identifier which is
3276 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3277 recommended form for most uses.
3279 Unfortunately, there are some characters which ISO C and ISO C++ allow
3280 in identifiers that when turned into NFC aren't allowable as
3281 identifiers.  That is, there's no way to use these symbols in portable
3282 ISO C or C++ and have all your identifiers in NFC.
3283 @option{-Wnormalized=id} suppresses the warning for these characters.
3284 It is hoped that future versions of the standards involved will correct
3285 this, which is why this option is not the default.
3287 You can switch the warning off for all characters by writing
3288 @option{-Wnormalized=none}.  You would only want to do this if you
3289 were using some other normalization scheme (like ``D''), because
3290 otherwise you can easily create bugs that are literally impossible to see.
3292 Some characters in ISO 10646 have distinct meanings but look identical
3293 in some fonts or display methodologies, especially once formatting has
3294 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3295 LETTER N'', will display just like a regular @code{n} which has been
3296 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3297 normalization scheme to convert all these into a standard form as
3298 well, and GCC will warn if your code is not in NFKC if you use
3299 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3300 about every identifier that contains the letter O because it might be
3301 confused with the digit 0, and so is not the default, but may be
3302 useful as a local coding convention if the programming environment is
3303 unable to be fixed to display these characters distinctly.
3305 @item -Wno-deprecated-declarations
3306 @opindex Wno-deprecated-declarations
3307 Do not warn about uses of functions (@pxref{Function Attributes}),
3308 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3309 Attributes}) marked as deprecated by using the @code{deprecated}
3310 attribute.
3312 @item -Wno-overflow
3313 @opindex Wno-overflow
3314 Do not warn about compile-time overflow in constant expressions.
3316 @item -Woverride-init
3317 @opindex Woverride-init
3318 @opindex W
3319 @opindex Wextra
3320 Warn if an initialized field without side effects is overridden when
3321 using designated initializers (@pxref{Designated Inits, , Designated
3322 Initializers}).
3324 This warning is included in @option{-Wextra}.  To get other
3325 @option{-Wextra} warnings without this one, use @samp{-Wextra
3326 -Wno-override-init}.
3328 @item -Wpacked
3329 @opindex Wpacked
3330 Warn if a structure is given the packed attribute, but the packed
3331 attribute has no effect on the layout or size of the structure.
3332 Such structures may be mis-aligned for little benefit.  For
3333 instance, in this code, the variable @code{f.x} in @code{struct bar}
3334 will be misaligned even though @code{struct bar} does not itself
3335 have the packed attribute:
3337 @smallexample
3338 @group
3339 struct foo @{
3340   int x;
3341   char a, b, c, d;
3342 @} __attribute__((packed));
3343 struct bar @{
3344   char z;
3345   struct foo f;
3347 @end group
3348 @end smallexample
3350 @item -Wpadded
3351 @opindex Wpadded
3352 Warn if padding is included in a structure, either to align an element
3353 of the structure or to align the whole structure.  Sometimes when this
3354 happens it is possible to rearrange the fields of the structure to
3355 reduce the padding and so make the structure smaller.
3357 @item -Wredundant-decls
3358 @opindex Wredundant-decls
3359 Warn if anything is declared more than once in the same scope, even in
3360 cases where multiple declaration is valid and changes nothing.
3362 @item -Wnested-externs @r{(C only)}
3363 @opindex Wnested-externs
3364 Warn if an @code{extern} declaration is encountered within a function.
3366 @item -Wunreachable-code
3367 @opindex Wunreachable-code
3368 Warn if the compiler detects that code will never be executed.
3370 This option is intended to warn when the compiler detects that at
3371 least a whole line of source code will never be executed, because
3372 some condition is never satisfied or because it is after a
3373 procedure that never returns.
3375 It is possible for this option to produce a warning even though there
3376 are circumstances under which part of the affected line can be executed,
3377 so care should be taken when removing apparently-unreachable code.
3379 For instance, when a function is inlined, a warning may mean that the
3380 line is unreachable in only one inlined copy of the function.
3382 This option is not made part of @option{-Wall} because in a debugging
3383 version of a program there is often substantial code which checks
3384 correct functioning of the program and is, hopefully, unreachable
3385 because the program does work.  Another common use of unreachable
3386 code is to provide behavior which is selectable at compile-time.
3388 @item -Winline
3389 @opindex Winline
3390 Warn if a function can not be inlined and it was declared as inline.
3391 Even with this option, the compiler will not warn about failures to
3392 inline functions declared in system headers.
3394 The compiler uses a variety of heuristics to determine whether or not
3395 to inline a function.  For example, the compiler takes into account
3396 the size of the function being inlined and the amount of inlining
3397 that has already been done in the current function.  Therefore,
3398 seemingly insignificant changes in the source program can cause the
3399 warnings produced by @option{-Winline} to appear or disappear.
3401 @item -Wno-invalid-offsetof @r{(C++ only)}
3402 @opindex Wno-invalid-offsetof
3403 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3404 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3405 to a non-POD type is undefined.  In existing C++ implementations,
3406 however, @samp{offsetof} typically gives meaningful results even when
3407 applied to certain kinds of non-POD types. (Such as a simple
3408 @samp{struct} that fails to be a POD type only by virtue of having a
3409 constructor.)  This flag is for users who are aware that they are
3410 writing nonportable code and who have deliberately chosen to ignore the
3411 warning about it.
3413 The restrictions on @samp{offsetof} may be relaxed in a future version
3414 of the C++ standard.
3416 @item -Wno-int-to-pointer-cast @r{(C only)}
3417 @opindex Wno-int-to-pointer-cast
3418 Suppress warnings from casts to pointer type of an integer of a
3419 different size.
3421 @item -Wno-pointer-to-int-cast @r{(C only)}
3422 @opindex Wno-pointer-to-int-cast
3423 Suppress warnings from casts from a pointer to an integer type of a
3424 different size.
3426 @item -Winvalid-pch
3427 @opindex Winvalid-pch
3428 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3429 the search path but can't be used.
3431 @item -Wlong-long
3432 @opindex Wlong-long
3433 @opindex Wno-long-long
3434 Warn if @samp{long long} type is used.  This is default.  To inhibit
3435 the warning messages, use @option{-Wno-long-long}.  Flags
3436 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3437 only when @option{-pedantic} flag is used.
3439 @item -Wvariadic-macros
3440 @opindex Wvariadic-macros
3441 @opindex Wno-variadic-macros
3442 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3443 alternate syntax when in pedantic ISO C99 mode.  This is default.
3444 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3446 @item -Wvolatile-register-var
3447 @opindex Wvolatile-register-var
3448 @opindex Wno-volatile-register-var
3449 Warn if a register variable is declared volatile.  The volatile
3450 modifier does not inhibit all optimizations that may eliminate reads
3451 and/or writes to register variables.
3453 @item -Wdisabled-optimization
3454 @opindex Wdisabled-optimization
3455 Warn if a requested optimization pass is disabled.  This warning does
3456 not generally indicate that there is anything wrong with your code; it
3457 merely indicates that GCC's optimizers were unable to handle the code
3458 effectively.  Often, the problem is that your code is too big or too
3459 complex; GCC will refuse to optimize programs when the optimization
3460 itself is likely to take inordinate amounts of time.
3462 @item -Wpointer-sign
3463 @opindex Wpointer-sign
3464 @opindex Wno-pointer-sign
3465 Warn for pointer argument passing or assignment with different signedness.
3466 This option is only supported for C and Objective-C@.  It is implied by
3467 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3468 @option{-Wno-pointer-sign}.
3470 @item -Werror
3471 @opindex Werror
3472 Make all warnings into errors.
3474 @item -Werror=
3475 @opindex Werror=
3476 Make the specified warning into an errors.  The specifier for a
3477 warning is appended, for example @option{-Werror=switch} turns the
3478 warnings controlled by @option{-Wswitch} into errors.  This switch
3479 takes a negative form, to be used to negate @option{-Werror} for
3480 specific warnings, for example @option{-Wno-error=switch} makes
3481 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3482 is in effect.  You can use the @option{-fdiagnostics-show-option}
3483 option to have each controllable warning amended with the option which
3484 controls it, to determine what to use with this option.
3486 Note that specifying @option{-Werror=}@var{foo} automatically implies
3487 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3488 imply anything.
3490 @item -Wstack-protector
3491 @opindex Wstack-protector
3492 This option is only active when @option{-fstack-protector} is active.  It
3493 warns about functions that will not be protected against stack smashing.
3495 @item -Wstring-literal-comparison
3496 @opindex Wstring-literal-comparison
3497 Warn about suspicious comparisons to string literal constants.  In C,
3498 direct comparisons against the memory address of a string literal, such
3499 as @code{if (x == "abc")}, typically indicate a programmer error, and
3500 even when intentional, result in unspecified behavior and are not portable.
3501 Usually these warnings alert that the programmer intended to use
3502 @code{strcmp}.  This warning is enabled by @option{-Wall}.
3504 @item -Woverlength-strings
3505 @opindex Woverlength-strings
3506 Warn about string constants which are longer than the ``minimum
3507 maximum'' length specified in the C standard.  Modern compilers
3508 generally allow string constants which are much longer than the
3509 standard's minimum limit, but very portable programs should avoid
3510 using longer strings.
3512 The limit applies @emph{after} string constant concatenation, and does
3513 not count the trailing NUL@.  In C89, the limit was 509 characters; in
3514 C99, it was raised to 4095.  C++98 does not specify a normative
3515 minimum maximum, so we do not diagnose overlength strings in C++@.
3517 This option is implied by @option{-pedantic}, and can be disabled with
3518 @option{-Wno-overlength-strings}.
3519 @end table
3521 @node Debugging Options
3522 @section Options for Debugging Your Program or GCC
3523 @cindex options, debugging
3524 @cindex debugging information options
3526 GCC has various special options that are used for debugging
3527 either your program or GCC:
3529 @table @gcctabopt
3530 @item -g
3531 @opindex g
3532 Produce debugging information in the operating system's native format
3533 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3534 information.
3536 On most systems that use stabs format, @option{-g} enables use of extra
3537 debugging information that only GDB can use; this extra information
3538 makes debugging work better in GDB but will probably make other debuggers
3539 crash or
3540 refuse to read the program.  If you want to control for certain whether
3541 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3542 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3544 GCC allows you to use @option{-g} with
3545 @option{-O}.  The shortcuts taken by optimized code may occasionally
3546 produce surprising results: some variables you declared may not exist
3547 at all; flow of control may briefly move where you did not expect it;
3548 some statements may not be executed because they compute constant
3549 results or their values were already at hand; some statements may
3550 execute in different places because they were moved out of loops.
3552 Nevertheless it proves possible to debug optimized output.  This makes
3553 it reasonable to use the optimizer for programs that might have bugs.
3555 The following options are useful when GCC is generated with the
3556 capability for more than one debugging format.
3558 @item -ggdb
3559 @opindex ggdb
3560 Produce debugging information for use by GDB@.  This means to use the
3561 most expressive format available (DWARF 2, stabs, or the native format
3562 if neither of those are supported), including GDB extensions if at all
3563 possible.
3565 @item -gstabs
3566 @opindex gstabs
3567 Produce debugging information in stabs format (if that is supported),
3568 without GDB extensions.  This is the format used by DBX on most BSD
3569 systems.  On MIPS, Alpha and System V Release 4 systems this option
3570 produces stabs debugging output which is not understood by DBX or SDB@.
3571 On System V Release 4 systems this option requires the GNU assembler.
3573 @item -feliminate-unused-debug-symbols
3574 @opindex feliminate-unused-debug-symbols
3575 Produce debugging information in stabs format (if that is supported),
3576 for only symbols that are actually used.
3578 @item -femit-class-debug-always
3579 Instead of emitting debugging information for a C++ class in only one
3580 object file, emit it in all object files using the class.  This option
3581 should be used only with debuggers that are unable to handle the way GCC
3582 normally emits debugging information for classes because using this
3583 option will increase the size of debugging information by as much as a
3584 factor of two.
3586 @item -gstabs+
3587 @opindex gstabs+
3588 Produce debugging information in stabs format (if that is supported),
3589 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3590 use of these extensions is likely to make other debuggers crash or
3591 refuse to read the program.
3593 @item -gcoff
3594 @opindex gcoff
3595 Produce debugging information in COFF format (if that is supported).
3596 This is the format used by SDB on most System V systems prior to
3597 System V Release 4.
3599 @item -gxcoff
3600 @opindex gxcoff
3601 Produce debugging information in XCOFF format (if that is supported).
3602 This is the format used by the DBX debugger on IBM RS/6000 systems.
3604 @item -gxcoff+
3605 @opindex gxcoff+
3606 Produce debugging information in XCOFF format (if that is supported),
3607 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3608 use of these extensions is likely to make other debuggers crash or
3609 refuse to read the program, and may cause assemblers other than the GNU
3610 assembler (GAS) to fail with an error.
3612 @item -gdwarf-2
3613 @opindex gdwarf-2
3614 Produce debugging information in DWARF version 2 format (if that is
3615 supported).  This is the format used by DBX on IRIX 6.  With this
3616 option, GCC uses features of DWARF version 3 when they are useful;
3617 version 3 is upward compatible with version 2, but may still cause
3618 problems for older debuggers.
3620 @item -gvms
3621 @opindex gvms
3622 Produce debugging information in VMS debug format (if that is
3623 supported).  This is the format used by DEBUG on VMS systems.
3625 @item -g@var{level}
3626 @itemx -ggdb@var{level}
3627 @itemx -gstabs@var{level}
3628 @itemx -gcoff@var{level}
3629 @itemx -gxcoff@var{level}
3630 @itemx -gvms@var{level}
3631 Request debugging information and also use @var{level} to specify how
3632 much information.  The default level is 2.
3634 Level 1 produces minimal information, enough for making backtraces in
3635 parts of the program that you don't plan to debug.  This includes
3636 descriptions of functions and external variables, but no information
3637 about local variables and no line numbers.
3639 Level 3 includes extra information, such as all the macro definitions
3640 present in the program.  Some debuggers support macro expansion when
3641 you use @option{-g3}.
3643 @option{-gdwarf-2} does not accept a concatenated debug level, because
3644 GCC used to support an option @option{-gdwarf} that meant to generate
3645 debug information in version 1 of the DWARF format (which is very
3646 different from version 2), and it would have been too confusing.  That
3647 debug format is long obsolete, but the option cannot be changed now.
3648 Instead use an additional @option{-g@var{level}} option to change the
3649 debug level for DWARF2.
3651 @item -feliminate-dwarf2-dups
3652 @opindex feliminate-dwarf2-dups
3653 Compress DWARF2 debugging information by eliminating duplicated
3654 information about each symbol.  This option only makes sense when
3655 generating DWARF2 debugging information with @option{-gdwarf-2}.
3657 @cindex @command{prof}
3658 @item -p
3659 @opindex p
3660 Generate extra code to write profile information suitable for the
3661 analysis program @command{prof}.  You must use this option when compiling
3662 the source files you want data about, and you must also use it when
3663 linking.
3665 @cindex @command{gprof}
3666 @item -pg
3667 @opindex pg
3668 Generate extra code to write profile information suitable for the
3669 analysis program @command{gprof}.  You must use this option when compiling
3670 the source files you want data about, and you must also use it when
3671 linking.
3673 @item -Q
3674 @opindex Q
3675 Makes the compiler print out each function name as it is compiled, and
3676 print some statistics about each pass when it finishes.
3678 @item -ftime-report
3679 @opindex ftime-report
3680 Makes the compiler print some statistics about the time consumed by each
3681 pass when it finishes.
3683 @item -fmem-report
3684 @opindex fmem-report
3685 Makes the compiler print some statistics about permanent memory
3686 allocation when it finishes.
3688 @item -fprofile-arcs
3689 @opindex fprofile-arcs
3690 Add code so that program flow @dfn{arcs} are instrumented.  During
3691 execution the program records how many times each branch and call is
3692 executed and how many times it is taken or returns.  When the compiled
3693 program exits it saves this data to a file called
3694 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3695 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3696 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3697 @var{auxname} is generated from the name of the output file, if
3698 explicitly specified and it is not the final executable, otherwise it is
3699 the basename of the source file.  In both cases any suffix is removed
3700 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3701 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3702 @xref{Cross-profiling}.
3704 @cindex @command{gcov}
3705 @item --coverage
3706 @opindex coverage
3708 This option is used to compile and link code instrumented for coverage
3709 analysis.  The option is a synonym for @option{-fprofile-arcs}
3710 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3711 linking).  See the documentation for those options for more details.
3713 @itemize
3715 @item
3716 Compile the source files with @option{-fprofile-arcs} plus optimization
3717 and code generation options.  For test coverage analysis, use the
3718 additional @option{-ftest-coverage} option.  You do not need to profile
3719 every source file in a program.
3721 @item
3722 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3723 (the latter implies the former).
3725 @item
3726 Run the program on a representative workload to generate the arc profile
3727 information.  This may be repeated any number of times.  You can run
3728 concurrent instances of your program, and provided that the file system
3729 supports locking, the data files will be correctly updated.  Also
3730 @code{fork} calls are detected and correctly handled (double counting
3731 will not happen).
3733 @item
3734 For profile-directed optimizations, compile the source files again with
3735 the same optimization and code generation options plus
3736 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3737 Control Optimization}).
3739 @item
3740 For test coverage analysis, use @command{gcov} to produce human readable
3741 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3742 @command{gcov} documentation for further information.
3744 @end itemize
3746 With @option{-fprofile-arcs}, for each function of your program GCC
3747 creates a program flow graph, then finds a spanning tree for the graph.
3748 Only arcs that are not on the spanning tree have to be instrumented: the
3749 compiler adds code to count the number of times that these arcs are
3750 executed.  When an arc is the only exit or only entrance to a block, the
3751 instrumentation code can be added to the block; otherwise, a new basic
3752 block must be created to hold the instrumentation code.
3754 @need 2000
3755 @item -ftest-coverage
3756 @opindex ftest-coverage
3757 Produce a notes file that the @command{gcov} code-coverage utility
3758 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3759 show program coverage.  Each source file's note file is called
3760 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3761 above for a description of @var{auxname} and instructions on how to
3762 generate test coverage data.  Coverage data will match the source files
3763 more closely, if you do not optimize.
3765 @item -d@var{letters}
3766 @item -fdump-rtl-@var{pass}
3767 @opindex d
3768 Says to make debugging dumps during compilation at times specified by
3769 @var{letters}.    This is used for debugging the RTL-based passes of the
3770 compiler.  The file names for most of the dumps are made by appending a
3771 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3772 from the name of the output file, if explicitly specified and it is not
3773 an executable, otherwise it is the basename of the source file.
3775 Most debug dumps can be enabled either passing a letter to the @option{-d}
3776 option, or with a long @option{-fdump-rtl} switch; here are the possible
3777 letters for use in @var{letters} and @var{pass}, and their meanings:
3779 @table @gcctabopt
3780 @item -dA
3781 @opindex dA
3782 Annotate the assembler output with miscellaneous debugging information.
3784 @item -dB
3785 @itemx -fdump-rtl-bbro
3786 @opindex dB
3787 @opindex fdump-rtl-bbro
3788 Dump after block reordering, to @file{@var{file}.148r.bbro}.
3790 @item -dc
3791 @itemx -fdump-rtl-combine
3792 @opindex dc
3793 @opindex fdump-rtl-combine
3794 Dump after instruction combination, to the file @file{@var{file}.129r.combine}.
3796 @item -dC
3797 @itemx -fdump-rtl-ce1
3798 @itemx -fdump-rtl-ce2
3799 @opindex dC
3800 @opindex fdump-rtl-ce1
3801 @opindex fdump-rtl-ce2
3802 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3803 first if conversion, to the file @file{@var{file}.117r.ce1}.  @option{-dC}
3804 and @option{-fdump-rtl-ce2} enable dumping after the second if
3805 conversion, to the file @file{@var{file}.130r.ce2}.
3807 @item -dd
3808 @itemx -fdump-rtl-btl
3809 @itemx -fdump-rtl-dbr
3810 @opindex dd
3811 @opindex fdump-rtl-btl
3812 @opindex fdump-rtl-dbr
3813 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3814 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3815 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3816 scheduling, to @file{@var{file}.36.dbr}.
3818 @item -dD
3819 @opindex dD
3820 Dump all macro definitions, at the end of preprocessing, in addition to
3821 normal output.
3823 @item -dE
3824 @itemx -fdump-rtl-ce3
3825 @opindex dE
3826 @opindex fdump-rtl-ce3
3827 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
3829 @item -df
3830 @itemx -fdump-rtl-cfg
3831 @itemx -fdump-rtl-life
3832 @opindex df
3833 @opindex fdump-rtl-cfg
3834 @opindex fdump-rtl-life
3835 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3836 and data flow analysis, to @file{@var{file}.116r.cfg}.  @option{-df}
3837 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3838 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
3840 @item -dg
3841 @itemx -fdump-rtl-greg
3842 @opindex dg
3843 @opindex fdump-rtl-greg
3844 Dump after global register allocation, to @file{@var{file}.139r.greg}.
3846 @item -dG
3847 @itemx -fdump-rtl-gcse
3848 @itemx -fdump-rtl-bypass
3849 @opindex dG
3850 @opindex fdump-rtl-gcse
3851 @opindex fdump-rtl-bypass
3852 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3853 @file{@var{file}.114r.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3854 enable dumping after jump bypassing and control flow optimizations, to
3855 @file{@var{file}.115r.bypass}.
3857 @item -dh
3858 @itemx -fdump-rtl-eh
3859 @opindex dh
3860 @opindex fdump-rtl-eh
3861 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3863 @item -di
3864 @itemx -fdump-rtl-sibling
3865 @opindex di
3866 @opindex fdump-rtl-sibling
3867 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
3869 @item -dj
3870 @itemx -fdump-rtl-jump
3871 @opindex dj
3872 @opindex fdump-rtl-jump
3873 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
3875 @item -dk
3876 @itemx -fdump-rtl-stack
3877 @opindex dk
3878 @opindex fdump-rtl-stack
3879 Dump after conversion from registers to stack, to @file{@var{file}.152r.stack}.
3881 @item -dl
3882 @itemx -fdump-rtl-lreg
3883 @opindex dl
3884 @opindex fdump-rtl-lreg
3885 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
3887 @item -dL
3888 @itemx -fdump-rtl-loop2
3889 @opindex dL
3890 @opindex fdump-rtl-loop2
3891 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
3892 loop optimization pass, to @file{@var{file}.119r.loop2},
3893 @file{@var{file}.120r.loop2_init},
3894 @file{@var{file}.121r.loop2_invariant}, and
3895 @file{@var{file}.125r.loop2_done}.
3897 @item -dm
3898 @itemx -fdump-rtl-sms
3899 @opindex dm
3900 @opindex fdump-rtl-sms
3901 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
3903 @item -dM
3904 @itemx -fdump-rtl-mach
3905 @opindex dM
3906 @opindex fdump-rtl-mach
3907 Dump after performing the machine dependent reorganization pass, to
3908 @file{@var{file}.155r.mach}.
3910 @item -dn
3911 @itemx -fdump-rtl-rnreg
3912 @opindex dn
3913 @opindex fdump-rtl-rnreg
3914 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
3916 @item -dN
3917 @itemx -fdump-rtl-regmove
3918 @opindex dN
3919 @opindex fdump-rtl-regmove
3920 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
3922 @item -do
3923 @itemx -fdump-rtl-postreload
3924 @opindex do
3925 @opindex fdump-rtl-postreload
3926 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3928 @item -dr
3929 @itemx -fdump-rtl-expand
3930 @opindex dr
3931 @opindex fdump-rtl-expand
3932 Dump after RTL generation, to @file{@var{file}.104r.expand}.
3934 @item -dR
3935 @itemx -fdump-rtl-sched2
3936 @opindex dR
3937 @opindex fdump-rtl-sched2
3938 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
3940 @item -ds
3941 @itemx -fdump-rtl-cse
3942 @opindex ds
3943 @opindex fdump-rtl-cse
3944 Dump after CSE (including the jump optimization that sometimes follows
3945 CSE), to @file{@var{file}.113r.cse}.
3947 @item -dS
3948 @itemx -fdump-rtl-sched1
3949 @opindex dS
3950 @opindex fdump-rtl-sched1
3951 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
3953 @item -dt
3954 @itemx -fdump-rtl-cse2
3955 @opindex dt
3956 @opindex fdump-rtl-cse2
3957 Dump after the second CSE pass (including the jump optimization that
3958 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
3960 @item -dT
3961 @itemx -fdump-rtl-tracer
3962 @opindex dT
3963 @opindex fdump-rtl-tracer
3964 Dump after running tracer, to @file{@var{file}.118r.tracer}.
3966 @item -dV
3967 @itemx -fdump-rtl-vpt
3968 @itemx -fdump-rtl-vartrack
3969 @opindex dV
3970 @opindex fdump-rtl-vpt
3971 @opindex fdump-rtl-vartrack
3972 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3973 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3974 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3975 to @file{@var{file}.154r.vartrack}.
3977 @item -dw
3978 @itemx -fdump-rtl-flow2
3979 @opindex dw
3980 @opindex fdump-rtl-flow2
3981 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
3983 @item -dz
3984 @itemx -fdump-rtl-peephole2
3985 @opindex dz
3986 @opindex fdump-rtl-peephole2
3987 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
3989 @item -dZ
3990 @itemx -fdump-rtl-web
3991 @opindex dZ
3992 @opindex fdump-rtl-web
3993 Dump after live range splitting, to @file{@var{file}.126r.web}.
3995 @item -da
3996 @itemx -fdump-rtl-all
3997 @opindex da
3998 @opindex fdump-rtl-all
3999 Produce all the dumps listed above.
4001 @item -dH
4002 @opindex dH
4003 Produce a core dump whenever an error occurs.
4005 @item -dm
4006 @opindex dm
4007 Print statistics on memory usage, at the end of the run, to
4008 standard error.
4010 @item -dp
4011 @opindex dp
4012 Annotate the assembler output with a comment indicating which
4013 pattern and alternative was used.  The length of each instruction is
4014 also printed.
4016 @item -dP
4017 @opindex dP
4018 Dump the RTL in the assembler output as a comment before each instruction.
4019 Also turns on @option{-dp} annotation.
4021 @item -dv
4022 @opindex dv
4023 For each of the other indicated dump files (either with @option{-d} or
4024 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4025 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4027 @item -dx
4028 @opindex dx
4029 Just generate RTL for a function instead of compiling it.  Usually used
4030 with @samp{r} (@option{-fdump-rtl-expand}).
4032 @item -dy
4033 @opindex dy
4034 Dump debugging information during parsing, to standard error.
4035 @end table
4037 @item -fdump-noaddr
4038 @opindex fdump-noaddr
4039 When doing debugging dumps (see @option{-d} option above), suppress
4040 address output.  This makes it more feasible to use diff on debugging
4041 dumps for compiler invocations with different compiler binaries and/or
4042 different text / bss / data / heap / stack / dso start locations.
4044 @item -fdump-unnumbered
4045 @opindex fdump-unnumbered
4046 When doing debugging dumps (see @option{-d} option above), suppress instruction
4047 numbers, line number note and address output.  This makes it more feasible to
4048 use diff on debugging dumps for compiler invocations with different
4049 options, in particular with and without @option{-g}.
4051 @item -fdump-translation-unit @r{(C++ only)}
4052 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4053 @opindex fdump-translation-unit
4054 Dump a representation of the tree structure for the entire translation
4055 unit to a file.  The file name is made by appending @file{.tu} to the
4056 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4057 controls the details of the dump as described for the
4058 @option{-fdump-tree} options.
4060 @item -fdump-class-hierarchy @r{(C++ only)}
4061 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4062 @opindex fdump-class-hierarchy
4063 Dump a representation of each class's hierarchy and virtual function
4064 table layout to a file.  The file name is made by appending @file{.class}
4065 to the source file name.  If the @samp{-@var{options}} form is used,
4066 @var{options} controls the details of the dump as described for the
4067 @option{-fdump-tree} options.
4069 @item -fdump-ipa-@var{switch}
4070 @opindex fdump-ipa
4071 Control the dumping at various stages of inter-procedural analysis
4072 language tree to a file.  The file name is generated by appending a switch
4073 specific suffix to the source file name.  The following dumps are possible:
4075 @table @samp
4076 @item all
4077 Enables all inter-procedural analysis dumps; currently the only produced
4078 dump is the @samp{cgraph} dump.
4080 @item cgraph
4081 Dumps information about call-graph optimization, unused function removal,
4082 and inlining decisions.
4083 @end table
4085 @item -fdump-tree-@var{switch}
4086 @itemx -fdump-tree-@var{switch}-@var{options}
4087 @opindex fdump-tree
4088 Control the dumping at various stages of processing the intermediate
4089 language tree to a file.  The file name is generated by appending a switch
4090 specific suffix to the source file name.  If the @samp{-@var{options}}
4091 form is used, @var{options} is a list of @samp{-} separated options that
4092 control the details of the dump.  Not all options are applicable to all
4093 dumps, those which are not meaningful will be ignored.  The following
4094 options are available
4096 @table @samp
4097 @item address
4098 Print the address of each node.  Usually this is not meaningful as it
4099 changes according to the environment and source file.  Its primary use
4100 is for tying up a dump file with a debug environment.
4101 @item slim
4102 Inhibit dumping of members of a scope or body of a function merely
4103 because that scope has been reached.  Only dump such items when they
4104 are directly reachable by some other path.  When dumping pretty-printed
4105 trees, this option inhibits dumping the bodies of control structures.
4106 @item raw
4107 Print a raw representation of the tree.  By default, trees are
4108 pretty-printed into a C-like representation.
4109 @item details
4110 Enable more detailed dumps (not honored by every dump option).
4111 @item stats
4112 Enable dumping various statistics about the pass (not honored by every dump
4113 option).
4114 @item blocks
4115 Enable showing basic block boundaries (disabled in raw dumps).
4116 @item vops
4117 Enable showing virtual operands for every statement.
4118 @item lineno
4119 Enable showing line numbers for statements.
4120 @item uid
4121 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4122 @item all
4123 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4124 @end table
4126 The following tree dumps are possible:
4127 @table @samp
4129 @item original
4130 Dump before any tree based optimization, to @file{@var{file}.original}.
4132 @item optimized
4133 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4135 @item inlined
4136 Dump after function inlining, to @file{@var{file}.inlined}.
4138 @item gimple
4139 @opindex fdump-tree-gimple
4140 Dump each function before and after the gimplification pass to a file.  The
4141 file name is made by appending @file{.gimple} to the source file name.
4143 @item cfg
4144 @opindex fdump-tree-cfg
4145 Dump the control flow graph of each function to a file.  The file name is
4146 made by appending @file{.cfg} to the source file name.
4148 @item vcg
4149 @opindex fdump-tree-vcg
4150 Dump the control flow graph of each function to a file in VCG format.  The
4151 file name is made by appending @file{.vcg} to the source file name.  Note
4152 that if the file contains more than one function, the generated file cannot
4153 be used directly by VCG@.  You will need to cut and paste each function's
4154 graph into its own separate file first.
4156 @item ch
4157 @opindex fdump-tree-ch
4158 Dump each function after copying loop headers.  The file name is made by
4159 appending @file{.ch} to the source file name.
4161 @item ssa
4162 @opindex fdump-tree-ssa
4163 Dump SSA related information to a file.  The file name is made by appending
4164 @file{.ssa} to the source file name.
4166 @item salias
4167 @opindex fdump-tree-salias
4168 Dump structure aliasing variable information to a file.  This file name
4169 is made by appending @file{.salias} to the source file name.
4171 @item alias
4172 @opindex fdump-tree-alias
4173 Dump aliasing information for each function.  The file name is made by
4174 appending @file{.alias} to the source file name.
4176 @item ccp
4177 @opindex fdump-tree-ccp
4178 Dump each function after CCP@.  The file name is made by appending
4179 @file{.ccp} to the source file name.
4181 @item storeccp
4182 @opindex fdump-tree-storeccp
4183 Dump each function after STORE-CCP.  The file name is made by appending
4184 @file{.storeccp} to the source file name.
4186 @item pre
4187 @opindex fdump-tree-pre
4188 Dump trees after partial redundancy elimination.  The file name is made
4189 by appending @file{.pre} to the source file name.
4191 @item fre
4192 @opindex fdump-tree-fre
4193 Dump trees after full redundancy elimination.  The file name is made
4194 by appending @file{.fre} to the source file name.
4196 @item copyprop
4197 @opindex fdump-tree-copyprop
4198 Dump trees after copy propagation.  The file name is made
4199 by appending @file{.copyprop} to the source file name.
4201 @item store_copyprop
4202 @opindex fdump-tree-store_copyprop
4203 Dump trees after store copy-propagation.  The file name is made
4204 by appending @file{.store_copyprop} to the source file name.
4206 @item dce
4207 @opindex fdump-tree-dce
4208 Dump each function after dead code elimination.  The file name is made by
4209 appending @file{.dce} to the source file name.
4211 @item mudflap
4212 @opindex fdump-tree-mudflap
4213 Dump each function after adding mudflap instrumentation.  The file name is
4214 made by appending @file{.mudflap} to the source file name.
4216 @item sra
4217 @opindex fdump-tree-sra
4218 Dump each function after performing scalar replacement of aggregates.  The
4219 file name is made by appending @file{.sra} to the source file name.
4221 @item sink
4222 @opindex fdump-tree-sink
4223 Dump each function after performing code sinking.  The file name is made
4224 by appending @file{.sink} to the source file name. 
4226 @item dom
4227 @opindex fdump-tree-dom
4228 Dump each function after applying dominator tree optimizations.  The file
4229 name is made by appending @file{.dom} to the source file name.
4231 @item dse
4232 @opindex fdump-tree-dse
4233 Dump each function after applying dead store elimination.  The file
4234 name is made by appending @file{.dse} to the source file name.
4236 @item phiopt
4237 @opindex fdump-tree-phiopt
4238 Dump each function after optimizing PHI nodes into straightline code.  The file
4239 name is made by appending @file{.phiopt} to the source file name.
4241 @item forwprop
4242 @opindex fdump-tree-forwprop
4243 Dump each function after forward propagating single use variables.  The file
4244 name is made by appending @file{.forwprop} to the source file name.
4246 @item copyrename
4247 @opindex fdump-tree-copyrename
4248 Dump each function after applying the copy rename optimization.  The file
4249 name is made by appending @file{.copyrename} to the source file name.
4251 @item nrv
4252 @opindex fdump-tree-nrv
4253 Dump each function after applying the named return value optimization on
4254 generic trees.  The file name is made by appending @file{.nrv} to the source
4255 file name.
4257 @item vect
4258 @opindex fdump-tree-vect
4259 Dump each function after applying vectorization of loops.  The file name is
4260 made by appending @file{.vect} to the source file name.
4262 @item vrp
4263 @opindex fdump-tree-vrp
4264 Dump each function after Value Range Propagation (VRP).  The file name
4265 is made by appending @file{.vrp} to the source file name.
4267 @item all
4268 @opindex fdump-tree-all
4269 Enable all the available tree dumps with the flags provided in this option.
4270 @end table
4272 @item -ftree-vectorizer-verbose=@var{n}
4273 @opindex ftree-vectorizer-verbose
4274 This option controls the amount of debugging output the vectorizer prints.
4275 This information is written to standard error, unless 
4276 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified, 
4277 in which case it is output to the usual dump listing file, @file{.vect}.
4278 For @var{n}=0 no diagnostic information is reported.
4279 If @var{n}=1 the vectorizer reports each loop that got vectorized, 
4280 and the total number of loops that got vectorized.
4281 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed 
4282 the first analysis phase (vect_analyze_loop_form) - i.e. countable, 
4283 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity 
4284 level that @option{-fdump-tree-vect-stats} uses.
4285 Higher verbosity levels mean either more information dumped for each 
4286 reported loop, or same amount of information reported for more loops:
4287 If @var{n}=3, alignment related information is added to the reports.
4288 If @var{n}=4, data-references related information (e.g. memory dependences, 
4289 memory access-patterns) is added to the reports.
4290 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops 
4291 that did not pass the first analysis phase (i.e. may not be countable, or 
4292 may have complicated control-flow).
4293 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4294 For @var{n}=7, all the information the vectorizer generates during its 
4295 analysis and transformation is reported.  This is the same verbosity level
4296 that @option{-fdump-tree-vect-details} uses.
4298 @item -frandom-seed=@var{string}
4299 @opindex frandom-string
4300 This option provides a seed that GCC uses when it would otherwise use
4301 random numbers.  It is used to generate certain symbol names
4302 that have to be different in every compiled file.  It is also used to
4303 place unique stamps in coverage data files and the object files that
4304 produce them.  You can use the @option{-frandom-seed} option to produce
4305 reproducibly identical object files.
4307 The @var{string} should be different for every file you compile.
4309 @item -fsched-verbose=@var{n}
4310 @opindex fsched-verbose
4311 On targets that use instruction scheduling, this option controls the
4312 amount of debugging output the scheduler prints.  This information is
4313 written to standard error, unless @option{-dS} or @option{-dR} is
4314 specified, in which case it is output to the usual dump
4315 listing file, @file{.sched} or @file{.sched2} respectively.  However
4316 for @var{n} greater than nine, the output is always printed to standard
4317 error.
4319 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4320 same information as @option{-dRS}.  For @var{n} greater than one, it
4321 also output basic block probabilities, detailed ready list information
4322 and unit/insn info.  For @var{n} greater than two, it includes RTL
4323 at abort point, control-flow and regions info.  And for @var{n} over
4324 four, @option{-fsched-verbose} also includes dependence info.
4326 @item -save-temps
4327 @opindex save-temps
4328 Store the usual ``temporary'' intermediate files permanently; place them
4329 in the current directory and name them based on the source file.  Thus,
4330 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4331 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4332 preprocessed @file{foo.i} output file even though the compiler now
4333 normally uses an integrated preprocessor.
4335 When used in combination with the @option{-x} command line option,
4336 @option{-save-temps} is sensible enough to avoid over writing an
4337 input source file with the same extension as an intermediate file.
4338 The corresponding intermediate file may be obtained by renaming the
4339 source file before using @option{-save-temps}.
4341 @item -time
4342 @opindex time
4343 Report the CPU time taken by each subprocess in the compilation
4344 sequence.  For C source files, this is the compiler proper and assembler
4345 (plus the linker if linking is done).  The output looks like this:
4347 @smallexample
4348 # cc1 0.12 0.01
4349 # as 0.00 0.01
4350 @end smallexample
4352 The first number on each line is the ``user time'', that is time spent
4353 executing the program itself.  The second number is ``system time'',
4354 time spent executing operating system routines on behalf of the program.
4355 Both numbers are in seconds.
4357 @item -fvar-tracking
4358 @opindex fvar-tracking
4359 Run variable tracking pass.  It computes where variables are stored at each
4360 position in code.  Better debugging information is then generated
4361 (if the debugging information format supports this information).
4363 It is enabled by default when compiling with optimization (@option{-Os},
4364 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4365 the debug info format supports it.
4367 @item -print-file-name=@var{library}
4368 @opindex print-file-name
4369 Print the full absolute name of the library file @var{library} that
4370 would be used when linking---and don't do anything else.  With this
4371 option, GCC does not compile or link anything; it just prints the
4372 file name.
4374 @item -print-multi-directory
4375 @opindex print-multi-directory
4376 Print the directory name corresponding to the multilib selected by any
4377 other switches present in the command line.  This directory is supposed
4378 to exist in @env{GCC_EXEC_PREFIX}.
4380 @item -print-multi-lib
4381 @opindex print-multi-lib
4382 Print the mapping from multilib directory names to compiler switches
4383 that enable them.  The directory name is separated from the switches by
4384 @samp{;}, and each switch starts with an @samp{@@} instead of the
4385 @samp{-}, without spaces between multiple switches.  This is supposed to
4386 ease shell-processing.
4388 @item -print-prog-name=@var{program}
4389 @opindex print-prog-name
4390 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4392 @item -print-libgcc-file-name
4393 @opindex print-libgcc-file-name
4394 Same as @option{-print-file-name=libgcc.a}.
4396 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4397 but you do want to link with @file{libgcc.a}.  You can do
4399 @smallexample
4400 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4401 @end smallexample
4403 @item -print-search-dirs
4404 @opindex print-search-dirs
4405 Print the name of the configured installation directory and a list of
4406 program and library directories @command{gcc} will search---and don't do anything else.
4408 This is useful when @command{gcc} prints the error message
4409 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4410 To resolve this you either need to put @file{cpp0} and the other compiler
4411 components where @command{gcc} expects to find them, or you can set the environment
4412 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4413 Don't forget the trailing @samp{/}.
4414 @xref{Environment Variables}.
4416 @item -dumpmachine
4417 @opindex dumpmachine
4418 Print the compiler's target machine (for example,
4419 @samp{i686-pc-linux-gnu})---and don't do anything else.
4421 @item -dumpversion
4422 @opindex dumpversion
4423 Print the compiler version (for example, @samp{3.0})---and don't do
4424 anything else.
4426 @item -dumpspecs
4427 @opindex dumpspecs
4428 Print the compiler's built-in specs---and don't do anything else.  (This
4429 is used when GCC itself is being built.)  @xref{Spec Files}.
4431 @item -feliminate-unused-debug-types
4432 @opindex feliminate-unused-debug-types
4433 Normally, when producing DWARF2 output, GCC will emit debugging
4434 information for all types declared in a compilation
4435 unit, regardless of whether or not they are actually used
4436 in that compilation unit.  Sometimes this is useful, such as
4437 if, in the debugger, you want to cast a value to a type that is
4438 not actually used in your program (but is declared).  More often,
4439 however, this results in a significant amount of wasted space.
4440 With this option, GCC will avoid producing debug symbol output
4441 for types that are nowhere used in the source file being compiled.
4442 @end table
4444 @node Optimize Options
4445 @section Options That Control Optimization
4446 @cindex optimize options
4447 @cindex options, optimization
4449 These options control various sorts of optimizations.
4451 Without any optimization option, the compiler's goal is to reduce the
4452 cost of compilation and to make debugging produce the expected
4453 results.  Statements are independent: if you stop the program with a
4454 breakpoint between statements, you can then assign a new value to any
4455 variable or change the program counter to any other statement in the
4456 function and get exactly the results you would expect from the source
4457 code.
4459 Turning on optimization flags makes the compiler attempt to improve
4460 the performance and/or code size at the expense of compilation time
4461 and possibly the ability to debug the program.
4463 The compiler performs optimization based on the knowledge it has of
4464 the program.  Optimization levels @option{-O} and above, in
4465 particular, enable @emph{unit-at-a-time} mode, which allows the
4466 compiler to consider information gained from later functions in
4467 the file when compiling a function.  Compiling multiple files at
4468 once to a single output file in @emph{unit-at-a-time} mode allows
4469 the compiler to use information gained from all of the files when
4470 compiling each of them.
4472 Not all optimizations are controlled directly by a flag.  Only
4473 optimizations that have a flag are listed.
4475 @table @gcctabopt
4476 @item -O
4477 @itemx -O1
4478 @opindex O
4479 @opindex O1
4480 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4481 more memory for a large function.
4483 With @option{-O}, the compiler tries to reduce code size and execution
4484 time, without performing any optimizations that take a great deal of
4485 compilation time.
4487 @option{-O} turns on the following optimization flags:
4488 @gccoptlist{-fdefer-pop @gol
4489 -fdelayed-branch @gol
4490 -fguess-branch-probability @gol
4491 -fcprop-registers @gol
4492 -fif-conversion @gol
4493 -fif-conversion2 @gol
4494 -ftree-ccp @gol
4495 -ftree-dce @gol
4496 -ftree-dominator-opts @gol
4497 -ftree-dse @gol
4498 -ftree-ter @gol
4499 -ftree-lrs @gol
4500 -ftree-sra @gol
4501 -ftree-copyrename @gol
4502 -ftree-fre @gol
4503 -ftree-ch @gol
4504 -funit-at-a-time @gol
4505 -fmerge-constants}
4507 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4508 where doing so does not interfere with debugging.
4510 @item -O2
4511 @opindex O2
4512 Optimize even more.  GCC performs nearly all supported optimizations
4513 that do not involve a space-speed tradeoff.  The compiler does not
4514 perform loop unrolling or function inlining when you specify @option{-O2}.
4515 As compared to @option{-O}, this option increases both compilation time
4516 and the performance of the generated code.
4518 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4519 also turns on the following optimization flags:
4520 @gccoptlist{-fthread-jumps @gol
4521 -fcrossjumping @gol
4522 -foptimize-sibling-calls @gol
4523 -fcse-follow-jumps  -fcse-skip-blocks @gol
4524 -fgcse  -fgcse-lm  @gol
4525 -fexpensive-optimizations @gol
4526 -frerun-cse-after-loop  @gol
4527 -fcaller-saves @gol
4528 -fpeephole2 @gol
4529 -fschedule-insns  -fschedule-insns2 @gol
4530 -fsched-interblock  -fsched-spec @gol
4531 -fregmove @gol
4532 -fstrict-aliasing @gol
4533 -fdelete-null-pointer-checks @gol
4534 -freorder-blocks  -freorder-functions @gol
4535 -falign-functions  -falign-jumps @gol
4536 -falign-loops  -falign-labels @gol
4537 -ftree-vrp @gol
4538 -ftree-pre}
4540 Please note the warning under @option{-fgcse} about
4541 invoking @option{-O2} on programs that use computed gotos.
4543 @item -O3
4544 @opindex O3
4545 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4546 @option{-O2} and also turns on the @option{-finline-functions},
4547 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4549 @item -O0
4550 @opindex O0
4551 Do not optimize.  This is the default.
4553 @item -Os
4554 @opindex Os
4555 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4556 do not typically increase code size.  It also performs further
4557 optimizations designed to reduce code size.
4559 @option{-Os} disables the following optimization flags:
4560 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4561 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4562 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4564 If you use multiple @option{-O} options, with or without level numbers,
4565 the last such option is the one that is effective.
4566 @end table
4568 Options of the form @option{-f@var{flag}} specify machine-independent
4569 flags.  Most flags have both positive and negative forms; the negative
4570 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4571 below, only one of the forms is listed---the one you typically will
4572 use.  You can figure out the other form by either removing @samp{no-}
4573 or adding it.
4575 The following options control specific optimizations.  They are either
4576 activated by @option{-O} options or are related to ones that are.  You
4577 can use the following flags in the rare cases when ``fine-tuning'' of
4578 optimizations to be performed is desired.
4580 @table @gcctabopt
4581 @item -fno-default-inline
4582 @opindex fno-default-inline
4583 Do not make member functions inline by default merely because they are
4584 defined inside the class scope (C++ only).  Otherwise, when you specify
4585 @w{@option{-O}}, member functions defined inside class scope are compiled
4586 inline by default; i.e., you don't need to add @samp{inline} in front of
4587 the member function name.
4589 @item -fno-defer-pop
4590 @opindex fno-defer-pop
4591 Always pop the arguments to each function call as soon as that function
4592 returns.  For machines which must pop arguments after a function call,
4593 the compiler normally lets arguments accumulate on the stack for several
4594 function calls and pops them all at once.
4596 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4598 @item -fforce-mem
4599 @opindex fforce-mem
4600 Force memory operands to be copied into registers before doing
4601 arithmetic on them.  This produces better code by making all memory
4602 references potential common subexpressions.  When they are not common
4603 subexpressions, instruction combination should eliminate the separate
4604 register-load. This option is now a nop and will be removed in 4.2.
4606 @item -fforce-addr
4607 @opindex fforce-addr
4608 Force memory address constants to be copied into registers before
4609 doing arithmetic on them.
4611 @item -fomit-frame-pointer
4612 @opindex fomit-frame-pointer
4613 Don't keep the frame pointer in a register for functions that
4614 don't need one.  This avoids the instructions to save, set up and
4615 restore frame pointers; it also makes an extra register available
4616 in many functions.  @strong{It also makes debugging impossible on
4617 some machines.}
4619 On some machines, such as the VAX, this flag has no effect, because
4620 the standard calling sequence automatically handles the frame pointer
4621 and nothing is saved by pretending it doesn't exist.  The
4622 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4623 whether a target machine supports this flag.  @xref{Registers,,Register
4624 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4626 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4628 @item -foptimize-sibling-calls
4629 @opindex foptimize-sibling-calls
4630 Optimize sibling and tail recursive calls.
4632 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4634 @item -fno-inline
4635 @opindex fno-inline
4636 Don't pay attention to the @code{inline} keyword.  Normally this option
4637 is used to keep the compiler from expanding any functions inline.
4638 Note that if you are not optimizing, no functions can be expanded inline.
4640 @item -finline-functions
4641 @opindex finline-functions
4642 Integrate all simple functions into their callers.  The compiler
4643 heuristically decides which functions are simple enough to be worth
4644 integrating in this way.
4646 If all calls to a given function are integrated, and the function is
4647 declared @code{static}, then the function is normally not output as
4648 assembler code in its own right.
4650 Enabled at level @option{-O3}.
4652 @item -finline-functions-called-once
4653 @opindex finline-functions-called-once
4654 Consider all @code{static} functions called once for inlining into their
4655 caller even if they are not marked @code{inline}.  If a call to a given
4656 function is integrated, then the function is not output as assembler code
4657 in its own right.
4659 Enabled if @option{-funit-at-a-time} is enabled.
4661 @item -fearly-inlining
4662 @opindex fearly-inlining
4663 Inline functions marked by @code{always_inline} and functions whose body seems
4664 smaller than the function call overhead early before doing
4665 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4666 makes profiling significantly cheaper and usually inlining faster on programs
4667 having large chains of nested wrapper functions.
4669 Enabled by default.
4671 @item -finline-limit=@var{n}
4672 @opindex finline-limit
4673 By default, GCC limits the size of functions that can be inlined.  This flag
4674 allows the control of this limit for functions that are explicitly marked as
4675 inline (i.e., marked with the inline keyword or defined within the class
4676 definition in c++).  @var{n} is the size of functions that can be inlined in
4677 number of pseudo instructions (not counting parameter handling).  The default
4678 value of @var{n} is 600.
4679 Increasing this value can result in more inlined code at
4680 the cost of compilation time and memory consumption.  Decreasing usually makes
4681 the compilation faster and less code will be inlined (which presumably
4682 means slower programs).  This option is particularly useful for programs that
4683 use inlining heavily such as those based on recursive templates with C++.
4685 Inlining is actually controlled by a number of parameters, which may be
4686 specified individually by using @option{--param @var{name}=@var{value}}.
4687 The @option{-finline-limit=@var{n}} option sets some of these parameters
4688 as follows:
4690 @table @gcctabopt
4691 @item max-inline-insns-single
4692  is set to @var{n}/2.
4693 @item max-inline-insns-auto
4694  is set to @var{n}/2.
4695 @item min-inline-insns
4696  is set to 130 or @var{n}/4, whichever is smaller.
4697 @item max-inline-insns-rtl
4698  is set to @var{n}.
4699 @end table
4701 See below for a documentation of the individual
4702 parameters controlling inlining.
4704 @emph{Note:} pseudo instruction represents, in this particular context, an
4705 abstract measurement of function's size.  In no way does it represent a count
4706 of assembly instructions and as such its exact meaning might change from one
4707 release to an another.
4709 @item -fkeep-inline-functions
4710 @opindex fkeep-inline-functions
4711 In C, emit @code{static} functions that are declared @code{inline}
4712 into the object file, even if the function has been inlined into all
4713 of its callers.  This switch does not affect functions using the
4714 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
4715 inline functions into the object file.
4717 @item -fkeep-static-consts
4718 @opindex fkeep-static-consts
4719 Emit variables declared @code{static const} when optimization isn't turned
4720 on, even if the variables aren't referenced.
4722 GCC enables this option by default.  If you want to force the compiler to
4723 check if the variable was referenced, regardless of whether or not
4724 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4726 @item -fmerge-constants
4727 Attempt to merge identical constants (string constants and floating point
4728 constants) across compilation units.
4730 This option is the default for optimized compilation if the assembler and
4731 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4732 behavior.
4734 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4736 @item -fmerge-all-constants
4737 Attempt to merge identical constants and identical variables.
4739 This option implies @option{-fmerge-constants}.  In addition to
4740 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4741 arrays or initialized constant variables with integral or floating point
4742 types.  Languages like C or C++ require each non-automatic variable to
4743 have distinct location, so using this option will result in non-conforming
4744 behavior.
4746 @item -fmodulo-sched
4747 @opindex fmodulo-sched
4748 Perform swing modulo scheduling immediately before the first scheduling
4749 pass.  This pass looks at innermost loops and reorders their
4750 instructions by overlapping different iterations.
4752 @item -fno-branch-count-reg
4753 @opindex fno-branch-count-reg
4754 Do not use ``decrement and branch'' instructions on a count register,
4755 but instead generate a sequence of instructions that decrement a
4756 register, compare it against zero, then branch based upon the result.
4757 This option is only meaningful on architectures that support such
4758 instructions, which include x86, PowerPC, IA-64 and S/390.
4760 The default is @option{-fbranch-count-reg}.
4762 @item -fno-function-cse
4763 @opindex fno-function-cse
4764 Do not put function addresses in registers; make each instruction that
4765 calls a constant function contain the function's address explicitly.
4767 This option results in less efficient code, but some strange hacks
4768 that alter the assembler output may be confused by the optimizations
4769 performed when this option is not used.
4771 The default is @option{-ffunction-cse}
4773 @item -fno-zero-initialized-in-bss
4774 @opindex fno-zero-initialized-in-bss
4775 If the target supports a BSS section, GCC by default puts variables that
4776 are initialized to zero into BSS@.  This can save space in the resulting
4777 code.
4779 This option turns off this behavior because some programs explicitly
4780 rely on variables going to the data section.  E.g., so that the
4781 resulting executable can find the beginning of that section and/or make
4782 assumptions based on that.
4784 The default is @option{-fzero-initialized-in-bss}.
4786 @item -fbounds-check
4787 @opindex fbounds-check
4788 For front-ends that support it, generate additional code to check that
4789 indices used to access arrays are within the declared range.  This is
4790 currently only supported by the Java and Fortran front-ends, where
4791 this option defaults to true and false respectively.
4793 @item -fmudflap -fmudflapth -fmudflapir
4794 @opindex fmudflap
4795 @opindex fmudflapth
4796 @opindex fmudflapir
4797 @cindex bounds checking
4798 @cindex mudflap
4799 For front-ends that support it (C and C++), instrument all risky
4800 pointer/array dereferencing operations, some standard library
4801 string/heap functions, and some other associated constructs with
4802 range/validity tests.  Modules so instrumented should be immune to
4803 buffer overflows, invalid heap use, and some other classes of C/C++
4804 programming errors.  The instrumentation relies on a separate runtime
4805 library (@file{libmudflap}), which will be linked into a program if
4806 @option{-fmudflap} is given at link time.  Run-time behavior of the
4807 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4808 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4809 for its options.
4811 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4812 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4813 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4814 instrumentation should ignore pointer reads.  This produces less
4815 instrumentation (and therefore faster execution) and still provides
4816 some protection against outright memory corrupting writes, but allows
4817 erroneously read data to propagate within a program.
4819 @item -fthread-jumps
4820 @opindex fthread-jumps
4821 Perform optimizations where we check to see if a jump branches to a
4822 location where another comparison subsumed by the first is found.  If
4823 so, the first branch is redirected to either the destination of the
4824 second branch or a point immediately following it, depending on whether
4825 the condition is known to be true or false.
4827 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4829 @item -fcse-follow-jumps
4830 @opindex fcse-follow-jumps
4831 In common subexpression elimination, scan through jump instructions
4832 when the target of the jump is not reached by any other path.  For
4833 example, when CSE encounters an @code{if} statement with an
4834 @code{else} clause, CSE will follow the jump when the condition
4835 tested is false.
4837 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4839 @item -fcse-skip-blocks
4840 @opindex fcse-skip-blocks
4841 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4842 follow jumps which conditionally skip over blocks.  When CSE
4843 encounters a simple @code{if} statement with no else clause,
4844 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4845 body of the @code{if}.
4847 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4849 @item -frerun-cse-after-loop
4850 @opindex frerun-cse-after-loop
4851 Re-run common subexpression elimination after loop optimizations has been
4852 performed.
4854 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4856 @item -fgcse
4857 @opindex fgcse
4858 Perform a global common subexpression elimination pass.
4859 This pass also performs global constant and copy propagation.
4861 @emph{Note:} When compiling a program using computed gotos, a GCC
4862 extension, you may get better runtime performance if you disable
4863 the global common subexpression elimination pass by adding
4864 @option{-fno-gcse} to the command line.
4866 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4868 @item -fgcse-lm
4869 @opindex fgcse-lm
4870 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4871 attempt to move loads which are only killed by stores into themselves.  This
4872 allows a loop containing a load/store sequence to be changed to a load outside
4873 the loop, and a copy/store within the loop.
4875 Enabled by default when gcse is enabled.
4877 @item -fgcse-sm
4878 @opindex fgcse-sm
4879 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4880 global common subexpression elimination.  This pass will attempt to move
4881 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4882 loops containing a load/store sequence can be changed to a load before
4883 the loop and a store after the loop.
4885 Not enabled at any optimization level.
4887 @item -fgcse-las
4888 @opindex fgcse-las
4889 When @option{-fgcse-las} is enabled, the global common subexpression
4890 elimination pass eliminates redundant loads that come after stores to the
4891 same memory location (both partial and full redundancies).
4893 Not enabled at any optimization level.
4895 @item -fgcse-after-reload
4896 @opindex fgcse-after-reload
4897 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4898 pass is performed after reload.  The purpose of this pass is to cleanup
4899 redundant spilling.
4901 @item -funsafe-loop-optimizations
4902 @opindex funsafe-loop-optimizations
4903 If given, the loop optimizer will assume that loop indices do not
4904 overflow, and that the loops with nontrivial exit condition are not
4905 infinite.  This enables a wider range of loop optimizations even if
4906 the loop optimizer itself cannot prove that these assumptions are valid.
4907 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4908 if it finds this kind of loop.
4910 @item -fcrossjumping
4911 @opindex crossjumping
4912 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4913 resulting code may or may not perform better than without cross-jumping.
4915 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4917 @item -fif-conversion
4918 @opindex if-conversion
4919 Attempt to transform conditional jumps into branch-less equivalents.  This
4920 include use of conditional moves, min, max, set flags and abs instructions, and
4921 some tricks doable by standard arithmetics.  The use of conditional execution
4922 on chips where it is available is controlled by @code{if-conversion2}.
4924 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4926 @item -fif-conversion2
4927 @opindex if-conversion2
4928 Use conditional execution (where available) to transform conditional jumps into
4929 branch-less equivalents.
4931 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4933 @item -fdelete-null-pointer-checks
4934 @opindex fdelete-null-pointer-checks
4935 Use global dataflow analysis to identify and eliminate useless checks
4936 for null pointers.  The compiler assumes that dereferencing a null
4937 pointer would have halted the program.  If a pointer is checked after
4938 it has already been dereferenced, it cannot be null.
4940 In some environments, this assumption is not true, and programs can
4941 safely dereference null pointers.  Use
4942 @option{-fno-delete-null-pointer-checks} to disable this optimization
4943 for programs which depend on that behavior.
4945 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4947 @item -fexpensive-optimizations
4948 @opindex fexpensive-optimizations
4949 Perform a number of minor optimizations that are relatively expensive.
4951 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4953 @item -foptimize-register-move
4954 @itemx -fregmove
4955 @opindex foptimize-register-move
4956 @opindex fregmove
4957 Attempt to reassign register numbers in move instructions and as
4958 operands of other simple instructions in order to maximize the amount of
4959 register tying.  This is especially helpful on machines with two-operand
4960 instructions.
4962 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4963 optimization.
4965 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4967 @item -fdelayed-branch
4968 @opindex fdelayed-branch
4969 If supported for the target machine, attempt to reorder instructions
4970 to exploit instruction slots available after delayed branch
4971 instructions.
4973 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4975 @item -fschedule-insns
4976 @opindex fschedule-insns
4977 If supported for the target machine, attempt to reorder instructions to
4978 eliminate execution stalls due to required data being unavailable.  This
4979 helps machines that have slow floating point or memory load instructions
4980 by allowing other instructions to be issued until the result of the load
4981 or floating point instruction is required.
4983 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4985 @item -fschedule-insns2
4986 @opindex fschedule-insns2
4987 Similar to @option{-fschedule-insns}, but requests an additional pass of
4988 instruction scheduling after register allocation has been done.  This is
4989 especially useful on machines with a relatively small number of
4990 registers and where memory load instructions take more than one cycle.
4992 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4994 @item -fno-sched-interblock
4995 @opindex fno-sched-interblock
4996 Don't schedule instructions across basic blocks.  This is normally
4997 enabled by default when scheduling before register allocation, i.e.@:
4998 with @option{-fschedule-insns} or at @option{-O2} or higher.
5000 @item -fno-sched-spec
5001 @opindex fno-sched-spec
5002 Don't allow speculative motion of non-load instructions.  This is normally
5003 enabled by default when scheduling before register allocation, i.e.@:
5004 with @option{-fschedule-insns} or at @option{-O2} or higher.
5006 @item -fsched-spec-load
5007 @opindex fsched-spec-load
5008 Allow speculative motion of some load instructions.  This only makes
5009 sense when scheduling before register allocation, i.e.@: with
5010 @option{-fschedule-insns} or at @option{-O2} or higher.
5012 @item -fsched-spec-load-dangerous
5013 @opindex fsched-spec-load-dangerous
5014 Allow speculative motion of more load instructions.  This only makes
5015 sense when scheduling before register allocation, i.e.@: with
5016 @option{-fschedule-insns} or at @option{-O2} or higher.
5018 @item -fsched-stalled-insns=@var{n}
5019 @opindex fsched-stalled-insns
5020 Define how many insns (if any) can be moved prematurely from the queue
5021 of stalled insns into the ready list, during the second scheduling pass.
5023 @item -fsched-stalled-insns-dep=@var{n}
5024 @opindex fsched-stalled-insns-dep
5025 Define how many insn groups (cycles) will be examined for a dependency
5026 on a stalled insn that is candidate for premature removal from the queue
5027 of stalled insns.  Has an effect only during the second scheduling pass,
5028 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
5030 @item -fsched2-use-superblocks
5031 @opindex fsched2-use-superblocks
5032 When scheduling after register allocation, do use superblock scheduling
5033 algorithm.  Superblock scheduling allows motion across basic block boundaries
5034 resulting on faster schedules.  This option is experimental, as not all machine
5035 descriptions used by GCC model the CPU closely enough to avoid unreliable
5036 results from the algorithm.
5038 This only makes sense when scheduling after register allocation, i.e.@: with
5039 @option{-fschedule-insns2} or at @option{-O2} or higher.
5041 @item -fsched2-use-traces
5042 @opindex fsched2-use-traces
5043 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5044 allocation and additionally perform code duplication in order to increase the
5045 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5046 trace formation.
5048 This mode should produce faster but significantly longer programs.  Also
5049 without @option{-fbranch-probabilities} the traces constructed may not
5050 match the reality and hurt the performance.  This only makes
5051 sense when scheduling after register allocation, i.e.@: with
5052 @option{-fschedule-insns2} or at @option{-O2} or higher.
5054 @item -fsee
5055 @opindex fsee
5056 Eliminates redundant extension instructions and move the non redundant
5057 ones to optimal placement using LCM.
5059 @item -freschedule-modulo-scheduled-loops
5060 @opindex fscheduling-in-modulo-scheduled-loops
5061 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
5062 we may want to prevent the later scheduling passes from changing its schedule, we use this
5063 option to control that.
5065 @item -fcaller-saves
5066 @opindex fcaller-saves
5067 Enable values to be allocated in registers that will be clobbered by
5068 function calls, by emitting extra instructions to save and restore the
5069 registers around such calls.  Such allocation is done only when it
5070 seems to result in better code than would otherwise be produced.
5072 This option is always enabled by default on certain machines, usually
5073 those which have no call-preserved registers to use instead.
5075 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5077 @item -ftree-pre
5078 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
5079 enabled by default at @option{-O2} and @option{-O3}.
5081 @item -ftree-fre
5082 Perform Full Redundancy Elimination (FRE) on trees.  The difference
5083 between FRE and PRE is that FRE only considers expressions
5084 that are computed on all paths leading to the redundant computation.
5085 This analysis faster than PRE, though it exposes fewer redundancies.
5086 This flag is enabled by default at @option{-O} and higher.
5088 @item -ftree-copy-prop
5089 Perform copy propagation on trees.  This pass eliminates unnecessary
5090 copy operations.  This flag is enabled by default at @option{-O} and
5091 higher.
5093 @item -ftree-store-copy-prop
5094 Perform copy propagation of memory loads and stores.  This pass
5095 eliminates unnecessary copy operations in memory references
5096 (structures, global variables, arrays, etc).  This flag is enabled by
5097 default at @option{-O2} and higher.
5099 @item -ftree-salias
5100 Perform structural alias analysis on trees.  This flag
5101 is enabled by default at @option{-O} and higher.
5103 @item -fipa-pta
5104 Perform interprocedural pointer analysis.
5106 @item -ftree-sink
5107 Perform forward store motion  on trees.  This flag is
5108 enabled by default at @option{-O} and higher.
5110 @item -ftree-ccp
5111 Perform sparse conditional constant propagation (CCP) on trees.  This
5112 pass only operates on local scalar variables and is enabled by default
5113 at @option{-O} and higher.
5115 @item -ftree-store-ccp
5116 Perform sparse conditional constant propagation (CCP) on trees.  This
5117 pass operates on both local scalar variables and memory stores and
5118 loads (global variables, structures, arrays, etc).  This flag is
5119 enabled by default at @option{-O2} and higher.
5121 @item -ftree-dce
5122 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5123 default at @option{-O} and higher.
5125 @item -ftree-dominator-opts
5126 Perform a variety of simple scalar cleanups (constant/copy
5127 propagation, redundancy elimination, range propagation and expression
5128 simplification) based on a dominator tree traversal.  This also
5129 performs jump threading (to reduce jumps to jumps). This flag is
5130 enabled by default at @option{-O} and higher.
5132 @item -ftree-ch
5133 Perform loop header copying on trees.  This is beneficial since it increases
5134 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5135 is enabled by default at @option{-O} and higher.  It is not enabled
5136 for @option{-Os}, since it usually increases code size.
5138 @item -ftree-loop-optimize
5139 Perform loop optimizations on trees.  This flag is enabled by default
5140 at @option{-O} and higher.
5142 @item -ftree-loop-linear
5143 Perform linear loop transformations on tree.  This flag can improve cache
5144 performance and allow further loop optimizations to take place.
5146 @item -ftree-loop-im
5147 Perform loop invariant motion on trees.  This pass moves only invariants that
5148 would be hard to handle at RTL level (function calls, operations that expand to
5149 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5150 operands of conditions that are invariant out of the loop, so that we can use
5151 just trivial invariantness analysis in loop unswitching.  The pass also includes
5152 store motion.
5154 @item -ftree-loop-ivcanon
5155 Create a canonical counter for number of iterations in the loop for that
5156 determining number of iterations requires complicated analysis.  Later
5157 optimizations then may determine the number easily.  Useful especially
5158 in connection with unrolling.
5160 @item -fivopts
5161 Perform induction variable optimizations (strength reduction, induction
5162 variable merging and induction variable elimination) on trees.
5164 @item -ftree-sra
5165 Perform scalar replacement of aggregates.  This pass replaces structure
5166 references with scalars to prevent committing structures to memory too
5167 early.  This flag is enabled by default at @option{-O} and higher.
5169 @item -ftree-copyrename
5170 Perform copy renaming on trees.  This pass attempts to rename compiler
5171 temporaries to other variables at copy locations, usually resulting in
5172 variable names which more closely resemble the original variables.  This flag
5173 is enabled by default at @option{-O} and higher.
5175 @item -ftree-ter
5176 Perform temporary expression replacement during the SSA->normal phase.  Single
5177 use/single def temporaries are replaced at their use location with their
5178 defining expression.  This results in non-GIMPLE code, but gives the expanders
5179 much more complex trees to work on resulting in better RTL generation.  This is
5180 enabled by default at @option{-O} and higher.
5182 @item -ftree-lrs
5183 Perform live range splitting during the SSA->normal phase.  Distinct live
5184 ranges of a variable are split into unique variables, allowing for better
5185 optimization later.  This is enabled by default at @option{-O} and higher.
5187 @item -ftree-vectorize
5188 Perform loop vectorization on trees.
5190 @item -ftree-vect-loop-version
5191 @opindex ftree-vect-loop-version
5192 Perform loop versioning when doing loop vectorization on trees.  When a loop
5193 appears to be vectorizable except that data alignment or data dependence cannot
5194 be determined at compile time then vectorized and non-vectorized versions of
5195 the loop are generated along with runtime checks for alignment or dependence
5196 to control which version is executed.  This option is enabled by default
5197 except at level @option{-Os} where it is disabled.
5199 @item -ftree-vrp
5200 Perform Value Range Propagation on trees.  This is similar to the
5201 constant propagation pass, but instead of values, ranges of values are
5202 propagated.  This allows the optimizers to remove unnecessary range
5203 checks like array bound checks and null pointer checks.  This is
5204 enabled by default at @option{-O2} and higher.  Null pointer check
5205 elimination is only done if @option{-fdelete-null-pointer-checks} is
5206 enabled.
5208 @item -ftracer
5209 @opindex ftracer
5210 Perform tail duplication to enlarge superblock size.  This transformation
5211 simplifies the control flow of the function allowing other optimizations to do
5212 better job.
5214 @item -funroll-loops
5215 @opindex funroll-loops
5216 Unroll loops whose number of iterations can be determined at compile
5217 time or upon entry to the loop.  @option{-funroll-loops} implies
5218 @option{-frerun-cse-after-loop}.  This option makes code larger,
5219 and may or may not make it run faster.
5221 @item -funroll-all-loops
5222 @opindex funroll-all-loops
5223 Unroll all loops, even if their number of iterations is uncertain when
5224 the loop is entered.  This usually makes programs run more slowly.
5225 @option{-funroll-all-loops} implies the same options as
5226 @option{-funroll-loops},
5228 @item -fsplit-ivs-in-unroller
5229 @opindex -fsplit-ivs-in-unroller
5230 Enables expressing of values of induction variables in later iterations
5231 of the unrolled loop using the value in the first iteration.  This breaks
5232 long dependency chains, thus improving efficiency of the scheduling passes.
5234 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5235 same effect.  However in cases the loop body is more complicated than
5236 a single basic block, this is not reliable.  It also does not work at all
5237 on some of the architectures due to restrictions in the CSE pass.
5239 This optimization is enabled by default.
5241 @item -fvariable-expansion-in-unroller
5242 @opindex -fvariable-expansion-in-unroller
5243 With this option, the compiler will create multiple copies of some
5244 local variables when unrolling a loop which can result in superior code.
5246 @item -fprefetch-loop-arrays
5247 @opindex fprefetch-loop-arrays
5248 If supported by the target machine, generate instructions to prefetch
5249 memory to improve the performance of loops that access large arrays.
5251 This option may generate better or worse code; results are highly
5252 dependent on the structure of loops within the source code.
5254 Disabled at level @option{-Os}.
5256 @item -fno-peephole
5257 @itemx -fno-peephole2
5258 @opindex fno-peephole
5259 @opindex fno-peephole2
5260 Disable any machine-specific peephole optimizations.  The difference
5261 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5262 are implemented in the compiler; some targets use one, some use the
5263 other, a few use both.
5265 @option{-fpeephole} is enabled by default.
5266 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5268 @item -fno-guess-branch-probability
5269 @opindex fno-guess-branch-probability
5270 Do not guess branch probabilities using heuristics.
5272 GCC will use heuristics to guess branch probabilities if they are
5273 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5274 heuristics are based on the control flow graph.  If some branch probabilities
5275 are specified by @samp{__builtin_expect}, then the heuristics will be
5276 used to guess branch probabilities for the rest of the control flow graph,
5277 taking the @samp{__builtin_expect} info into account.  The interactions
5278 between the heuristics and @samp{__builtin_expect} can be complex, and in
5279 some cases, it may be useful to disable the heuristics so that the effects
5280 of @samp{__builtin_expect} are easier to understand.
5282 The default is @option{-fguess-branch-probability} at levels
5283 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5285 @item -freorder-blocks
5286 @opindex freorder-blocks
5287 Reorder basic blocks in the compiled function in order to reduce number of
5288 taken branches and improve code locality.
5290 Enabled at levels @option{-O2}, @option{-O3}.
5292 @item -freorder-blocks-and-partition
5293 @opindex freorder-blocks-and-partition
5294 In addition to reordering basic blocks in the compiled function, in order
5295 to reduce number of taken branches, partitions hot and cold basic blocks
5296 into separate sections of the assembly and .o files, to improve
5297 paging and cache locality performance.
5299 This optimization is automatically turned off in the presence of
5300 exception handling, for linkonce sections, for functions with a user-defined
5301 section attribute and on any architecture that does not support named
5302 sections.
5304 @item -freorder-functions
5305 @opindex freorder-functions
5306 Reorder functions in the object file in order to
5307 improve code locality.  This is implemented by using special
5308 subsections @code{.text.hot} for most frequently executed functions and
5309 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5310 the linker so object file format must support named sections and linker must
5311 place them in a reasonable way.
5313 Also profile feedback must be available in to make this option effective.  See
5314 @option{-fprofile-arcs} for details.
5316 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5318 @item -fstrict-aliasing
5319 @opindex fstrict-aliasing
5320 Allows the compiler to assume the strictest aliasing rules applicable to
5321 the language being compiled.  For C (and C++), this activates
5322 optimizations based on the type of expressions.  In particular, an
5323 object of one type is assumed never to reside at the same address as an
5324 object of a different type, unless the types are almost the same.  For
5325 example, an @code{unsigned int} can alias an @code{int}, but not a
5326 @code{void*} or a @code{double}.  A character type may alias any other
5327 type.
5329 Pay special attention to code like this:
5330 @smallexample
5331 union a_union @{
5332   int i;
5333   double d;
5336 int f() @{
5337   a_union t;
5338   t.d = 3.0;
5339   return t.i;
5341 @end smallexample
5342 The practice of reading from a different union member than the one most
5343 recently written to (called ``type-punning'') is common.  Even with
5344 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5345 is accessed through the union type.  So, the code above will work as
5346 expected.  However, this code might not:
5347 @smallexample
5348 int f() @{
5349   a_union t;
5350   int* ip;
5351   t.d = 3.0;
5352   ip = &t.i;
5353   return *ip;
5355 @end smallexample
5357 Every language that wishes to perform language-specific alias analysis
5358 should define a function that computes, given an @code{tree}
5359 node, an alias set for the node.  Nodes in different alias sets are not
5360 allowed to alias.  For an example, see the C front-end function
5361 @code{c_get_alias_set}.
5363 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5365 @item -falign-functions
5366 @itemx -falign-functions=@var{n}
5367 @opindex falign-functions
5368 Align the start of functions to the next power-of-two greater than
5369 @var{n}, skipping up to @var{n} bytes.  For instance,
5370 @option{-falign-functions=32} aligns functions to the next 32-byte
5371 boundary, but @option{-falign-functions=24} would align to the next
5372 32-byte boundary only if this can be done by skipping 23 bytes or less.
5374 @option{-fno-align-functions} and @option{-falign-functions=1} are
5375 equivalent and mean that functions will not be aligned.
5377 Some assemblers only support this flag when @var{n} is a power of two;
5378 in that case, it is rounded up.
5380 If @var{n} is not specified or is zero, use a machine-dependent default.
5382 Enabled at levels @option{-O2}, @option{-O3}.
5384 @item -falign-labels
5385 @itemx -falign-labels=@var{n}
5386 @opindex falign-labels
5387 Align all branch targets to a power-of-two boundary, skipping up to
5388 @var{n} bytes like @option{-falign-functions}.  This option can easily
5389 make code slower, because it must insert dummy operations for when the
5390 branch target is reached in the usual flow of the code.
5392 @option{-fno-align-labels} and @option{-falign-labels=1} are
5393 equivalent and mean that labels will not be aligned.
5395 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5396 are greater than this value, then their values are used instead.
5398 If @var{n} is not specified or is zero, use a machine-dependent default
5399 which is very likely to be @samp{1}, meaning no alignment.
5401 Enabled at levels @option{-O2}, @option{-O3}.
5403 @item -falign-loops
5404 @itemx -falign-loops=@var{n}
5405 @opindex falign-loops
5406 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5407 like @option{-falign-functions}.  The hope is that the loop will be
5408 executed many times, which will make up for any execution of the dummy
5409 operations.
5411 @option{-fno-align-loops} and @option{-falign-loops=1} are
5412 equivalent and mean that loops will not be aligned.
5414 If @var{n} is not specified or is zero, use a machine-dependent default.
5416 Enabled at levels @option{-O2}, @option{-O3}.
5418 @item -falign-jumps
5419 @itemx -falign-jumps=@var{n}
5420 @opindex falign-jumps
5421 Align branch targets to a power-of-two boundary, for branch targets
5422 where the targets can only be reached by jumping, skipping up to @var{n}
5423 bytes like @option{-falign-functions}.  In this case, no dummy operations
5424 need be executed.
5426 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5427 equivalent and mean that loops will not be aligned.
5429 If @var{n} is not specified or is zero, use a machine-dependent default.
5431 Enabled at levels @option{-O2}, @option{-O3}.
5433 @item -funit-at-a-time
5434 @opindex funit-at-a-time
5435 Parse the whole compilation unit before starting to produce code.
5436 This allows some extra optimizations to take place but consumes
5437 more memory (in general).  There are some compatibility issues
5438 with @emph{unit-at-a-time} mode:
5439 @itemize @bullet
5440 @item
5441 enabling @emph{unit-at-a-time} mode may change the order
5442 in which functions, variables, and top-level @code{asm} statements
5443 are emitted, and will likely break code relying on some particular
5444 ordering.  The majority of such top-level @code{asm} statements,
5445 though, can be replaced by @code{section} attributes.  The
5446 @option{fno-toplevel-reorder} option may be used to keep the ordering
5447 used in the input file, at the cost of some optimizations.
5449 @item
5450 @emph{unit-at-a-time} mode removes unreferenced static variables
5451 and functions.  This may result in undefined references
5452 when an @code{asm} statement refers directly to variables or functions
5453 that are otherwise unused.  In that case either the variable/function
5454 shall be listed as an operand of the @code{asm} statement operand or,
5455 in the case of top-level @code{asm} statements the attribute @code{used}
5456 shall be used on the declaration.
5458 @item
5459 Static functions now can use non-standard passing conventions that
5460 may break @code{asm} statements calling functions directly.  Again,
5461 attribute @code{used} will prevent this behavior.
5462 @end itemize
5464 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5465 but this scheme may not be supported by future releases of GCC@.
5467 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5469 @item -fno-toplevel-reorder
5470 Do not reorder top-level functions, variables, and @code{asm}
5471 statements.  Output them in the same order that they appear in the
5472 input file.  When this option is used, unreferenced static variables
5473 will not be removed.  This option is intended to support existing code
5474 which relies on a particular ordering.  For new code, it is better to
5475 use attributes.
5477 @item -fweb
5478 @opindex fweb
5479 Constructs webs as commonly used for register allocation purposes and assign
5480 each web individual pseudo register.  This allows the register allocation pass
5481 to operate on pseudos directly, but also strengthens several other optimization
5482 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5483 however, make debugging impossible, since variables will no longer stay in a
5484 ``home register''.
5486 Enabled by default with @option{-funroll-loops}.
5488 @item -fwhole-program
5489 @opindex fwhole-program
5490 Assume that the current compilation unit represents whole program being
5491 compiled.  All public functions and variables with the exception of @code{main}
5492 and those merged by attribute @code{externally_visible} become static functions
5493 and in a affect gets more aggressively optimized by interprocedural optimizers.
5494 While this option is equivalent to proper use of @code{static} keyword for
5495 programs consisting of single file, in combination with option
5496 @option{--combine} this flag can be used to compile most of smaller scale C
5497 programs since the functions and variables become local for the whole combined
5498 compilation unit, not for the single source file itself.
5501 @item -fno-cprop-registers
5502 @opindex fno-cprop-registers
5503 After register allocation and post-register allocation instruction splitting,
5504 we perform a copy-propagation pass to try to reduce scheduling dependencies
5505 and occasionally eliminate the copy.
5507 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5509 @item -fprofile-generate
5510 @opindex fprofile-generate
5512 Enable options usually used for instrumenting application to produce
5513 profile useful for later recompilation with profile feedback based
5514 optimization.  You must use @option{-fprofile-generate} both when
5515 compiling and when linking your program.
5517 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5519 @item -fprofile-use
5520 @opindex fprofile-use
5521 Enable profile feedback directed optimizations, and optimizations
5522 generally profitable only with profile feedback available.
5524 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5525 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
5527 @end table
5529 The following options control compiler behavior regarding floating
5530 point arithmetic.  These options trade off between speed and
5531 correctness.  All must be specifically enabled.
5533 @table @gcctabopt
5534 @item -ffloat-store
5535 @opindex ffloat-store
5536 Do not store floating point variables in registers, and inhibit other
5537 options that might change whether a floating point value is taken from a
5538 register or memory.
5540 @cindex floating point precision
5541 This option prevents undesirable excess precision on machines such as
5542 the 68000 where the floating registers (of the 68881) keep more
5543 precision than a @code{double} is supposed to have.  Similarly for the
5544 x86 architecture.  For most programs, the excess precision does only
5545 good, but a few programs rely on the precise definition of IEEE floating
5546 point.  Use @option{-ffloat-store} for such programs, after modifying
5547 them to store all pertinent intermediate computations into variables.
5549 @item -ffast-math
5550 @opindex ffast-math
5551 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5552 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5553 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5554 and @option{fcx-limited-range}.
5556 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5558 This option should never be turned on by any @option{-O} option since
5559 it can result in incorrect output for programs which depend on
5560 an exact implementation of IEEE or ISO rules/specifications for
5561 math functions.
5563 @item -fno-math-errno
5564 @opindex fno-math-errno
5565 Do not set ERRNO after calling math functions that are executed
5566 with a single instruction, e.g., sqrt.  A program that relies on
5567 IEEE exceptions for math error handling may want to use this flag
5568 for speed while maintaining IEEE arithmetic compatibility.
5570 This option should never be turned on by any @option{-O} option since
5571 it can result in incorrect output for programs which depend on
5572 an exact implementation of IEEE or ISO rules/specifications for
5573 math functions.
5575 The default is @option{-fmath-errno}.
5577 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5578 no reason for the compiler to consider the possibility that it might,
5579 and @option{-fno-math-errno} is the default.
5581 @item -funsafe-math-optimizations
5582 @opindex funsafe-math-optimizations
5583 Allow optimizations for floating-point arithmetic that (a) assume
5584 that arguments and results are valid and (b) may violate IEEE or
5585 ANSI standards.  When used at link-time, it may include libraries
5586 or startup files that change the default FPU control word or other
5587 similar optimizations.
5589 This option should never be turned on by any @option{-O} option since
5590 it can result in incorrect output for programs which depend on
5591 an exact implementation of IEEE or ISO rules/specifications for
5592 math functions.
5594 The default is @option{-fno-unsafe-math-optimizations}.
5596 @item -ffinite-math-only
5597 @opindex ffinite-math-only
5598 Allow optimizations for floating-point arithmetic that assume
5599 that arguments and results are not NaNs or +-Infs.
5601 This option should never be turned on by any @option{-O} option since
5602 it can result in incorrect output for programs which depend on
5603 an exact implementation of IEEE or ISO rules/specifications.
5605 The default is @option{-fno-finite-math-only}.
5607 @item -fno-trapping-math
5608 @opindex fno-trapping-math
5609 Compile code assuming that floating-point operations cannot generate
5610 user-visible traps.  These traps include division by zero, overflow,
5611 underflow, inexact result and invalid operation.  This option implies
5612 @option{-fno-signaling-nans}.  Setting this option may allow faster
5613 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5615 This option should never be turned on by any @option{-O} option since
5616 it can result in incorrect output for programs which depend on
5617 an exact implementation of IEEE or ISO rules/specifications for
5618 math functions.
5620 The default is @option{-ftrapping-math}.
5622 @item -frounding-math
5623 @opindex frounding-math
5624 Disable transformations and optimizations that assume default floating
5625 point rounding behavior.  This is round-to-zero for all floating point
5626 to integer conversions, and round-to-nearest for all other arithmetic
5627 truncations.  This option should be specified for programs that change
5628 the FP rounding mode dynamically, or that may be executed with a
5629 non-default rounding mode.  This option disables constant folding of
5630 floating point expressions at compile-time (which may be affected by
5631 rounding mode) and arithmetic transformations that are unsafe in the
5632 presence of sign-dependent rounding modes.
5634 The default is @option{-fno-rounding-math}.
5636 This option is experimental and does not currently guarantee to
5637 disable all GCC optimizations that are affected by rounding mode.
5638 Future versions of GCC may provide finer control of this setting
5639 using C99's @code{FENV_ACCESS} pragma.  This command line option
5640 will be used to specify the default state for @code{FENV_ACCESS}.
5642 @item -frtl-abstract-sequences
5643 @opindex frtl-abstract-sequences
5644 It is a size optimization method. This option is to find identical
5645 sequences of code, which can be turned into pseudo-procedures  and
5646 then  replace  all  occurrences with  calls to  the  newly created
5647 subroutine. It is kind of an opposite of @option{-finline-functions}.
5648 This optimization runs at RTL level.
5650 @item -fsignaling-nans
5651 @opindex fsignaling-nans
5652 Compile code assuming that IEEE signaling NaNs may generate user-visible
5653 traps during floating-point operations.  Setting this option disables
5654 optimizations that may change the number of exceptions visible with
5655 signaling NaNs.  This option implies @option{-ftrapping-math}.
5657 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5658 be defined.
5660 The default is @option{-fno-signaling-nans}.
5662 This option is experimental and does not currently guarantee to
5663 disable all GCC optimizations that affect signaling NaN behavior.
5665 @item -fsingle-precision-constant
5666 @opindex fsingle-precision-constant
5667 Treat floating point constant as single precision constant instead of
5668 implicitly converting it to double precision constant.
5670 @item -fcx-limited-range
5671 @itemx -fno-cx-limited-range
5672 @opindex fcx-limited-range
5673 @opindex fno-cx-limited-range
5674 When enabled, this option states that a range reduction step is not
5675 needed when performing complex division.  The default is
5676 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5678 This option controls the default setting of the ISO C99 
5679 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5680 all languages.
5682 @end table
5684 The following options control optimizations that may improve
5685 performance, but are not enabled by any @option{-O} options.  This
5686 section includes experimental options that may produce broken code.
5688 @table @gcctabopt
5689 @item -fbranch-probabilities
5690 @opindex fbranch-probabilities
5691 After running a program compiled with @option{-fprofile-arcs}
5692 (@pxref{Debugging Options,, Options for Debugging Your Program or
5693 @command{gcc}}), you can compile it a second time using
5694 @option{-fbranch-probabilities}, to improve optimizations based on
5695 the number of times each branch was taken.  When the program
5696 compiled with @option{-fprofile-arcs} exits it saves arc execution
5697 counts to a file called @file{@var{sourcename}.gcda} for each source
5698 file  The information in this data file is very dependent on the
5699 structure of the generated code, so you must use the same source code
5700 and the same optimization options for both compilations.
5702 With @option{-fbranch-probabilities}, GCC puts a
5703 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5704 These can be used to improve optimization.  Currently, they are only
5705 used in one place: in @file{reorg.c}, instead of guessing which path a
5706 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5707 exactly determine which path is taken more often.
5709 @item -fprofile-values
5710 @opindex fprofile-values
5711 If combined with @option{-fprofile-arcs}, it adds code so that some
5712 data about values of expressions in the program is gathered.
5714 With @option{-fbranch-probabilities}, it reads back the data gathered
5715 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5716 notes to instructions for their later usage in optimizations.
5718 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5720 @item -fvpt
5721 @opindex fvpt
5722 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5723 a code to gather information about values of expressions.
5725 With @option{-fbranch-probabilities}, it reads back the data gathered
5726 and actually performs the optimizations based on them.
5727 Currently the optimizations include specialization of division operation
5728 using the knowledge about the value of the denominator.
5730 @item -frename-registers
5731 @opindex frename-registers
5732 Attempt to avoid false dependencies in scheduled code by making use
5733 of registers left over after register allocation.  This optimization
5734 will most benefit processors with lots of registers.  Depending on the
5735 debug information format adopted by the target, however, it can
5736 make debugging impossible, since variables will no longer stay in
5737 a ``home register''.
5739 Enabled by default with @option{-funroll-loops}.
5741 @item -ftracer
5742 @opindex ftracer
5743 Perform tail duplication to enlarge superblock size.  This transformation
5744 simplifies the control flow of the function allowing other optimizations to do
5745 better job.
5747 Enabled with @option{-fprofile-use}.
5749 @item -funroll-loops
5750 @opindex funroll-loops
5751 Unroll loops whose number of iterations can be determined at compile time or
5752 upon entry to the loop.  @option{-funroll-loops} implies
5753 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5754 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5755 small constant number of iterations).  This option makes code larger, and may
5756 or may not make it run faster.
5758 Enabled with @option{-fprofile-use}.
5760 @item -funroll-all-loops
5761 @opindex funroll-all-loops
5762 Unroll all loops, even if their number of iterations is uncertain when
5763 the loop is entered.  This usually makes programs run more slowly.
5764 @option{-funroll-all-loops} implies the same options as
5765 @option{-funroll-loops}.
5767 @item -fpeel-loops
5768 @opindex fpeel-loops
5769 Peels the loops for that there is enough information that they do not
5770 roll much (from profile feedback).  It also turns on complete loop peeling
5771 (i.e.@: complete removal of loops with small constant number of iterations).
5773 Enabled with @option{-fprofile-use}.
5775 @item -fmove-loop-invariants
5776 @opindex fmove-loop-invariants
5777 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
5778 at level @option{-O1}
5780 @item -funswitch-loops
5781 @opindex funswitch-loops
5782 Move branches with loop invariant conditions out of the loop, with duplicates
5783 of the loop on both branches (modified according to result of the condition).
5785 @item -ffunction-sections
5786 @itemx -fdata-sections
5787 @opindex ffunction-sections
5788 @opindex fdata-sections
5789 Place each function or data item into its own section in the output
5790 file if the target supports arbitrary sections.  The name of the
5791 function or the name of the data item determines the section's name
5792 in the output file.
5794 Use these options on systems where the linker can perform optimizations
5795 to improve locality of reference in the instruction space.  Most systems
5796 using the ELF object format and SPARC processors running Solaris 2 have
5797 linkers with such optimizations.  AIX may have these optimizations in
5798 the future.
5800 Only use these options when there are significant benefits from doing
5801 so.  When you specify these options, the assembler and linker will
5802 create larger object and executable files and will also be slower.
5803 You will not be able to use @code{gprof} on all systems if you
5804 specify this option and you may have problems with debugging if
5805 you specify both this option and @option{-g}.
5807 @item -fbranch-target-load-optimize
5808 @opindex fbranch-target-load-optimize
5809 Perform branch target register load optimization before prologue / epilogue
5810 threading.
5811 The use of target registers can typically be exposed only during reload,
5812 thus hoisting loads out of loops and doing inter-block scheduling needs
5813 a separate optimization pass.
5815 @item -fbranch-target-load-optimize2
5816 @opindex fbranch-target-load-optimize2
5817 Perform branch target register load optimization after prologue / epilogue
5818 threading.
5820 @item -fbtr-bb-exclusive
5821 @opindex fbtr-bb-exclusive
5822 When performing branch target register load optimization, don't reuse
5823 branch target registers in within any basic block.
5825 @item -fstack-protector
5826 Emit extra code to check for buffer overflows, such as stack smashing
5827 attacks.  This is done by adding a guard variable to functions with
5828 vulnerable objects.  This includes functions that call alloca, and
5829 functions with buffers larger than 8 bytes.  The guards are initialized
5830 when a function is entered and then checked when the function exits.
5831 If a guard check fails, an error message is printed and the program exits.
5833 @item -fstack-protector-all
5834 Like @option{-fstack-protector} except that all functions are protected.
5836 @item -fsection-anchors
5837 @opindex fsection-anchors
5838 Try to reduce the number of symbolic address calculations by using
5839 shared ``anchor'' symbols to address nearby objects.  This transformation
5840 can help to reduce the number of GOT entries and GOT accesses on some
5841 targets.
5843 For example, the implementation of the following function @code{foo}:
5845 @smallexample
5846 static int a, b, c;
5847 int foo (void) @{ return a + b + c; @}
5848 @end smallexample
5850 would usually calculate the addresses of all three variables, but if you
5851 compile it with @option{-fsection-anchors}, it will access the variables
5852 from a common anchor point instead.  The effect is similar to the
5853 following pseudocode (which isn't valid C):
5855 @smallexample
5856 int foo (void)
5858   register int *xr = &x;
5859   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
5861 @end smallexample
5863 Not all targets support this option.
5865 @item --param @var{name}=@var{value}
5866 @opindex param
5867 In some places, GCC uses various constants to control the amount of
5868 optimization that is done.  For example, GCC will not inline functions
5869 that contain more that a certain number of instructions.  You can
5870 control some of these constants on the command-line using the
5871 @option{--param} option.
5873 The names of specific parameters, and the meaning of the values, are
5874 tied to the internals of the compiler, and are subject to change
5875 without notice in future releases.
5877 In each case, the @var{value} is an integer.  The allowable choices for
5878 @var{name} are given in the following table:
5880 @table @gcctabopt
5881 @item salias-max-implicit-fields
5882 The maximum number of fields in a variable without direct
5883 structure accesses for which structure aliasing will consider trying 
5884 to track each field.  The default is 5
5886 @item salias-max-array-elements
5887 The maximum number of elements an array can have and its elements
5888 still be tracked individually by structure aliasing. The default is 4
5890 @item sra-max-structure-size
5891 The maximum structure size, in bytes, at which the scalar replacement
5892 of aggregates (SRA) optimization will perform block copies.  The
5893 default value, 0, implies that GCC will select the most appropriate
5894 size itself.
5896 @item sra-field-structure-ratio
5897 The threshold ratio (as a percentage) between instantiated fields and
5898 the complete structure size.  We say that if the ratio of the number
5899 of bytes in instantiated fields to the number of bytes in the complete
5900 structure exceeds this parameter, then block copies are not used.  The
5901 default is 75.
5903 @item max-crossjump-edges
5904 The maximum number of incoming edges to consider for crossjumping.
5905 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5906 the number of edges incoming to each block.  Increasing values mean
5907 more aggressive optimization, making the compile time increase with
5908 probably small improvement in executable size.
5910 @item min-crossjump-insns
5911 The minimum number of instructions which must be matched at the end
5912 of two blocks before crossjumping will be performed on them.  This
5913 value is ignored in the case where all instructions in the block being
5914 crossjumped from are matched.  The default value is 5.
5916 @item max-grow-copy-bb-insns
5917 The maximum code size expansion factor when copying basic blocks
5918 instead of jumping.  The expansion is relative to a jump instruction.
5919 The default value is 8.
5921 @item max-goto-duplication-insns
5922 The maximum number of instructions to duplicate to a block that jumps
5923 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5924 passes, GCC factors computed gotos early in the compilation process,
5925 and unfactors them as late as possible.  Only computed jumps at the
5926 end of a basic blocks with no more than max-goto-duplication-insns are
5927 unfactored.  The default value is 8.
5929 @item max-delay-slot-insn-search
5930 The maximum number of instructions to consider when looking for an
5931 instruction to fill a delay slot.  If more than this arbitrary number of
5932 instructions is searched, the time savings from filling the delay slot
5933 will be minimal so stop searching.  Increasing values mean more
5934 aggressive optimization, making the compile time increase with probably
5935 small improvement in executable run time.
5937 @item max-delay-slot-live-search
5938 When trying to fill delay slots, the maximum number of instructions to
5939 consider when searching for a block with valid live register
5940 information.  Increasing this arbitrarily chosen value means more
5941 aggressive optimization, increasing the compile time.  This parameter
5942 should be removed when the delay slot code is rewritten to maintain the
5943 control-flow graph.
5945 @item max-gcse-memory
5946 The approximate maximum amount of memory that will be allocated in
5947 order to perform the global common subexpression elimination
5948 optimization.  If more memory than specified is required, the
5949 optimization will not be done.
5951 @item max-gcse-passes
5952 The maximum number of passes of GCSE to run.  The default is 1.
5954 @item max-pending-list-length
5955 The maximum number of pending dependencies scheduling will allow
5956 before flushing the current state and starting over.  Large functions
5957 with few branches or calls can create excessively large lists which
5958 needlessly consume memory and resources.
5960 @item max-inline-insns-single
5961 Several parameters control the tree inliner used in gcc.
5962 This number sets the maximum number of instructions (counted in GCC's
5963 internal representation) in a single function that the tree inliner
5964 will consider for inlining.  This only affects functions declared
5965 inline and methods implemented in a class declaration (C++).
5966 The default value is 450.
5968 @item max-inline-insns-auto
5969 When you use @option{-finline-functions} (included in @option{-O3}),
5970 a lot of functions that would otherwise not be considered for inlining
5971 by the compiler will be investigated.  To those functions, a different
5972 (more restrictive) limit compared to functions declared inline can
5973 be applied.
5974 The default value is 90.
5976 @item large-function-insns
5977 The limit specifying really large functions.  For functions larger than this
5978 limit after inlining inlining is constrained by
5979 @option{--param large-function-growth}.  This parameter is useful primarily
5980 to avoid extreme compilation time caused by non-linear algorithms used by the
5981 backend.
5982 This parameter is ignored when @option{-funit-at-a-time} is not used.
5983 The default value is 2700.
5985 @item large-function-growth
5986 Specifies maximal growth of large function caused by inlining in percents.
5987 This parameter is ignored when @option{-funit-at-a-time} is not used.
5988 The default value is 100 which limits large function growth to 2.0 times
5989 the original size.
5991 @item large-unit-insns
5992 The limit specifying large translation unit.  Growth caused by inlining of
5993 units larger than this limit is limited by @option{--param inline-unit-growth}.
5994 For small units this might be too tight (consider unit consisting of function A
5995 that is inline and B that just calls A three time.  If B is small relative to
5996 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
5997 large units consisting of small inlininable functions however the overall unit
5998 growth limit is needed to avoid exponential explosion of code size.  Thus for
5999 smaller units, the size is increased to @option{--param large-unit-insns}
6000 before applying @option{--param inline-unit-growth}.  The default is 10000
6002 @item inline-unit-growth
6003 Specifies maximal overall growth of the compilation unit caused by inlining.
6004 This parameter is ignored when @option{-funit-at-a-time} is not used.
6005 The default value is 50 which limits unit growth to 1.5 times the original
6006 size.
6008 @item max-inline-insns-recursive
6009 @itemx max-inline-insns-recursive-auto
6010 Specifies maximum number of instructions out-of-line copy of self recursive inline
6011 function can grow into by performing recursive inlining.
6013 For functions declared inline @option{--param max-inline-insns-recursive} is
6014 taken into account.  For function not declared inline, recursive inlining
6015 happens only when @option{-finline-functions} (included in @option{-O3}) is
6016 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6017 default value is 450.
6019 @item max-inline-recursive-depth
6020 @itemx max-inline-recursive-depth-auto
6021 Specifies maximum recursion depth used by the recursive inlining.
6023 For functions declared inline @option{--param max-inline-recursive-depth} is
6024 taken into account.  For function not declared inline, recursive inlining
6025 happens only when @option{-finline-functions} (included in @option{-O3}) is
6026 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6027 default value is 450.
6029 @item min-inline-recursive-probability
6030 Recursive inlining is profitable only for function having deep recursion
6031 in average and can hurt for function having little recursion depth by
6032 increasing the prologue size or complexity of function body to other
6033 optimizers.
6035 When profile feedback is available (see @option{-fprofile-generate}) the actual
6036 recursion depth can be guessed from probability that function will recurse via
6037 given call expression.  This parameter limits inlining only to call expression
6038 whose probability exceeds given threshold (in percents).  The default value is
6041 @item inline-call-cost
6042 Specify cost of call instruction relative to simple arithmetics operations
6043 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
6044 functions and at the same time increases size of leaf function that is believed to
6045 reduce function size by being inlined.  In effect it increases amount of
6046 inlining for code having large abstraction penalty (many functions that just
6047 pass the arguments to other functions) and decrease inlining for code with low
6048 abstraction penalty.  The default value is 16.
6050 @item max-unrolled-insns
6051 The maximum number of instructions that a loop should have if that loop
6052 is unrolled, and if the loop is unrolled, it determines how many times
6053 the loop code is unrolled.
6055 @item max-average-unrolled-insns
6056 The maximum number of instructions biased by probabilities of their execution
6057 that a loop should have if that loop is unrolled, and if the loop is unrolled,
6058 it determines how many times the loop code is unrolled.
6060 @item max-unroll-times
6061 The maximum number of unrollings of a single loop.
6063 @item max-peeled-insns
6064 The maximum number of instructions that a loop should have if that loop
6065 is peeled, and if the loop is peeled, it determines how many times
6066 the loop code is peeled.
6068 @item max-peel-times
6069 The maximum number of peelings of a single loop.
6071 @item max-completely-peeled-insns
6072 The maximum number of insns of a completely peeled loop.
6074 @item max-completely-peel-times
6075 The maximum number of iterations of a loop to be suitable for complete peeling.
6077 @item max-unswitch-insns
6078 The maximum number of insns of an unswitched loop.
6080 @item max-unswitch-level
6081 The maximum number of branches unswitched in a single loop.
6083 @item lim-expensive
6084 The minimum cost of an expensive expression in the loop invariant motion.
6086 @item iv-consider-all-candidates-bound
6087 Bound on number of candidates for induction variables below that
6088 all candidates are considered for each use in induction variable
6089 optimizations.  Only the most relevant candidates are considered
6090 if there are more candidates, to avoid quadratic time complexity.
6092 @item iv-max-considered-uses
6093 The induction variable optimizations give up on loops that contain more
6094 induction variable uses.
6096 @item iv-always-prune-cand-set-bound
6097 If number of candidates in the set is smaller than this value,
6098 we always try to remove unnecessary ivs from the set during its
6099 optimization when a new iv is added to the set.
6101 @item scev-max-expr-size
6102 Bound on size of expressions used in the scalar evolutions analyzer.
6103 Large expressions slow the analyzer.
6105 @item vect-max-version-checks
6106 The maximum number of runtime checks that can be performed when doing
6107 loop versioning in the vectorizer.  See option ftree-vect-loop-version
6108 for more information.
6110 @item max-iterations-to-track
6112 The maximum number of iterations of a loop the brute force algorithm
6113 for analysis of # of iterations of the loop tries to evaluate.
6115 @item hot-bb-count-fraction
6116 Select fraction of the maximal count of repetitions of basic block in program
6117 given basic block needs to have to be considered hot.
6119 @item hot-bb-frequency-fraction
6120 Select fraction of the maximal frequency of executions of basic block in
6121 function given basic block needs to have to be considered hot
6123 @item max-predicted-iterations
6124 The maximum number of loop iterations we predict statically.  This is useful
6125 in cases where function contain single loop with known bound and other loop
6126 with unknown.  We predict the known number of iterations correctly, while
6127 the unknown number of iterations average to roughly 10.  This means that the
6128 loop without bounds would appear artificially cold relative to the other one.
6130 @item tracer-dynamic-coverage
6131 @itemx tracer-dynamic-coverage-feedback
6133 This value is used to limit superblock formation once the given percentage of
6134 executed instructions is covered.  This limits unnecessary code size
6135 expansion.
6137 The @option{tracer-dynamic-coverage-feedback} is used only when profile
6138 feedback is available.  The real profiles (as opposed to statically estimated
6139 ones) are much less balanced allowing the threshold to be larger value.
6141 @item tracer-max-code-growth
6142 Stop tail duplication once code growth has reached given percentage.  This is
6143 rather hokey argument, as most of the duplicates will be eliminated later in
6144 cross jumping, so it may be set to much higher values than is the desired code
6145 growth.
6147 @item tracer-min-branch-ratio
6149 Stop reverse growth when the reverse probability of best edge is less than this
6150 threshold (in percent).
6152 @item tracer-min-branch-ratio
6153 @itemx tracer-min-branch-ratio-feedback
6155 Stop forward growth if the best edge do have probability lower than this
6156 threshold.
6158 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6159 compilation for profile feedback and one for compilation without.  The value
6160 for compilation with profile feedback needs to be more conservative (higher) in
6161 order to make tracer effective.
6163 @item max-cse-path-length
6165 Maximum number of basic blocks on path that cse considers.  The default is 10.
6167 @item max-cse-insns
6168 The maximum instructions CSE process before flushing. The default is 1000.
6170 @item global-var-threshold
6172 Counts the number of function calls (@var{n}) and the number of
6173 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
6174 single artificial variable will be created to represent all the
6175 call-clobbered variables at function call sites.  This artificial
6176 variable will then be made to alias every call-clobbered variable.
6177 (done as @code{int * size_t} on the host machine; beware overflow).
6179 @item max-aliased-vops
6181 Maximum number of virtual operands allowed to represent aliases
6182 before triggering the alias grouping heuristic.  Alias grouping
6183 reduces compile times and memory consumption needed for aliasing at
6184 the expense of precision loss in alias information.
6186 @item ggc-min-expand
6188 GCC uses a garbage collector to manage its own memory allocation.  This
6189 parameter specifies the minimum percentage by which the garbage
6190 collector's heap should be allowed to expand between collections.
6191 Tuning this may improve compilation speed; it has no effect on code
6192 generation.
6194 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6195 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6196 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6197 GCC is not able to calculate RAM on a particular platform, the lower
6198 bound of 30% is used.  Setting this parameter and
6199 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6200 every opportunity.  This is extremely slow, but can be useful for
6201 debugging.
6203 @item ggc-min-heapsize
6205 Minimum size of the garbage collector's heap before it begins bothering
6206 to collect garbage.  The first collection occurs after the heap expands
6207 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6208 tuning this may improve compilation speed, and has no effect on code
6209 generation.
6211 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6212 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6213 with a lower bound of 4096 (four megabytes) and an upper bound of
6214 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6215 particular platform, the lower bound is used.  Setting this parameter
6216 very large effectively disables garbage collection.  Setting this
6217 parameter and @option{ggc-min-expand} to zero causes a full collection
6218 to occur at every opportunity.
6220 @item max-reload-search-insns
6221 The maximum number of instruction reload should look backward for equivalent
6222 register.  Increasing values mean more aggressive optimization, making the
6223 compile time increase with probably slightly better performance.  The default
6224 value is 100.
6226 @item max-cselib-memory-locations
6227 The maximum number of memory locations cselib should take into account.
6228 Increasing values mean more aggressive optimization, making the compile time
6229 increase with probably slightly better performance.  The default value is 500.
6231 @item max-flow-memory-locations
6232 Similar as @option{max-cselib-memory-locations} but for dataflow liveness.
6233 The default value is 100.
6235 @item reorder-blocks-duplicate
6236 @itemx reorder-blocks-duplicate-feedback
6238 Used by basic block reordering pass to decide whether to use unconditional
6239 branch or duplicate the code on its destination.  Code is duplicated when its
6240 estimated size is smaller than this value multiplied by the estimated size of
6241 unconditional jump in the hot spots of the program.
6243 The @option{reorder-block-duplicate-feedback} is used only when profile
6244 feedback is available and may be set to higher values than
6245 @option{reorder-block-duplicate} since information about the hot spots is more
6246 accurate.
6248 @item max-sched-ready-insns
6249 The maximum number of instructions ready to be issued the scheduler should
6250 consider at any given time during the first scheduling pass.  Increasing
6251 values mean more thorough searches, making the compilation time increase
6252 with probably little benefit.  The default value is 100.
6254 @item max-sched-region-blocks
6255 The maximum number of blocks in a region to be considered for
6256 interblock scheduling.  The default value is 10.
6258 @item max-sched-region-insns
6259 The maximum number of insns in a region to be considered for
6260 interblock scheduling.  The default value is 100.
6262 @item min-spec-prob
6263 The minimum probability (in percents) of reaching a source block
6264 for interblock speculative scheduling.  The default value is 40.
6266 @item max-sched-extend-regions-iters
6267 The maximum number of iterations through CFG to extend regions.
6268 0 - disable region extension,
6269 N - do at most N iterations.
6270 The default value is 0.
6272 @item max-sched-insn-conflict-delay
6273 The maximum conflict delay for an insn to be considered for speculative motion.
6274 The default value is 3.
6276 @item sched-spec-prob-cutoff
6277 The minimal probability of speculation success (in percents), so that
6278 speculative insn will be scheduled.
6279 The default value is 40.
6281 @item max-last-value-rtl
6283 The maximum size measured as number of RTLs that can be recorded in an expression
6284 in combiner for a pseudo register as last known value of that register.  The default
6285 is 10000.
6287 @item integer-share-limit
6288 Small integer constants can use a shared data structure, reducing the
6289 compiler's memory usage and increasing its speed.  This sets the maximum
6290 value of a shared integer constant's.  The default value is 256.
6292 @item min-virtual-mappings
6293 Specifies the minimum number of virtual mappings in the incremental
6294 SSA updater that should be registered to trigger the virtual mappings
6295 heuristic defined by virtual-mappings-ratio.  The default value is
6296 100.
6298 @item virtual-mappings-ratio
6299 If the number of virtual mappings is virtual-mappings-ratio bigger
6300 than the number of virtual symbols to be updated, then the incremental
6301 SSA updater switches to a full update for those symbols.  The default
6302 ratio is 3.
6304 @item ssp-buffer-size
6305 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6306 protection when @option{-fstack-protection} is used.
6308 @item max-jump-thread-duplication-stmts
6309 Maximum number of statements allowed in a block that needs to be
6310 duplicated when threading jumps.
6312 @item max-fields-for-field-sensitive
6313 Maximum number of fields in a structure we will treat in
6314 a field sensitive manner during pointer analysis.
6316 @end table
6317 @end table
6319 @node Preprocessor Options
6320 @section Options Controlling the Preprocessor
6321 @cindex preprocessor options
6322 @cindex options, preprocessor
6324 These options control the C preprocessor, which is run on each C source
6325 file before actual compilation.
6327 If you use the @option{-E} option, nothing is done except preprocessing.
6328 Some of these options make sense only together with @option{-E} because
6329 they cause the preprocessor output to be unsuitable for actual
6330 compilation.
6332 @table @gcctabopt
6333 @opindex Wp
6334 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6335 and pass @var{option} directly through to the preprocessor.  If
6336 @var{option} contains commas, it is split into multiple options at the
6337 commas.  However, many options are modified, translated or interpreted
6338 by the compiler driver before being passed to the preprocessor, and
6339 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6340 interface is undocumented and subject to change, so whenever possible
6341 you should avoid using @option{-Wp} and let the driver handle the
6342 options instead.
6344 @item -Xpreprocessor @var{option}
6345 @opindex preprocessor
6346 Pass @var{option} as an option to the preprocessor.  You can use this to
6347 supply system-specific preprocessor options which GCC does not know how to
6348 recognize.
6350 If you want to pass an option that takes an argument, you must use
6351 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6352 @end table
6354 @include cppopts.texi
6356 @node Assembler Options
6357 @section Passing Options to the Assembler
6359 @c prevent bad page break with this line
6360 You can pass options to the assembler.
6362 @table @gcctabopt
6363 @item -Wa,@var{option}
6364 @opindex Wa
6365 Pass @var{option} as an option to the assembler.  If @var{option}
6366 contains commas, it is split into multiple options at the commas.
6368 @item -Xassembler @var{option}
6369 @opindex Xassembler
6370 Pass @var{option} as an option to the assembler.  You can use this to
6371 supply system-specific assembler options which GCC does not know how to
6372 recognize.
6374 If you want to pass an option that takes an argument, you must use
6375 @option{-Xassembler} twice, once for the option and once for the argument.
6377 @end table
6379 @node Link Options
6380 @section Options for Linking
6381 @cindex link options
6382 @cindex options, linking
6384 These options come into play when the compiler links object files into
6385 an executable output file.  They are meaningless if the compiler is
6386 not doing a link step.
6388 @table @gcctabopt
6389 @cindex file names
6390 @item @var{object-file-name}
6391 A file name that does not end in a special recognized suffix is
6392 considered to name an object file or library.  (Object files are
6393 distinguished from libraries by the linker according to the file
6394 contents.)  If linking is done, these object files are used as input
6395 to the linker.
6397 @item -c
6398 @itemx -S
6399 @itemx -E
6400 @opindex c
6401 @opindex S
6402 @opindex E
6403 If any of these options is used, then the linker is not run, and
6404 object file names should not be used as arguments.  @xref{Overall
6405 Options}.
6407 @cindex Libraries
6408 @item -l@var{library}
6409 @itemx -l @var{library}
6410 @opindex l
6411 Search the library named @var{library} when linking.  (The second
6412 alternative with the library as a separate argument is only for
6413 POSIX compliance and is not recommended.)
6415 It makes a difference where in the command you write this option; the
6416 linker searches and processes libraries and object files in the order they
6417 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6418 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6419 to functions in @samp{z}, those functions may not be loaded.
6421 The linker searches a standard list of directories for the library,
6422 which is actually a file named @file{lib@var{library}.a}.  The linker
6423 then uses this file as if it had been specified precisely by name.
6425 The directories searched include several standard system directories
6426 plus any that you specify with @option{-L}.
6428 Normally the files found this way are library files---archive files
6429 whose members are object files.  The linker handles an archive file by
6430 scanning through it for members which define symbols that have so far
6431 been referenced but not defined.  But if the file that is found is an
6432 ordinary object file, it is linked in the usual fashion.  The only
6433 difference between using an @option{-l} option and specifying a file name
6434 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6435 and searches several directories.
6437 @item -lobjc
6438 @opindex lobjc
6439 You need this special case of the @option{-l} option in order to
6440 link an Objective-C or Objective-C++ program.
6442 @item -nostartfiles
6443 @opindex nostartfiles
6444 Do not use the standard system startup files when linking.
6445 The standard system libraries are used normally, unless @option{-nostdlib}
6446 or @option{-nodefaultlibs} is used.
6448 @item -nodefaultlibs
6449 @opindex nodefaultlibs
6450 Do not use the standard system libraries when linking.
6451 Only the libraries you specify will be passed to the linker.
6452 The standard startup files are used normally, unless @option{-nostartfiles}
6453 is used.  The compiler may generate calls to @code{memcmp},
6454 @code{memset}, @code{memcpy} and @code{memmove}.
6455 These entries are usually resolved by entries in
6456 libc.  These entry points should be supplied through some other
6457 mechanism when this option is specified.
6459 @item -nostdlib
6460 @opindex nostdlib
6461 Do not use the standard system startup files or libraries when linking.
6462 No startup files and only the libraries you specify will be passed to
6463 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6464 @code{memcpy} and @code{memmove}.
6465 These entries are usually resolved by entries in
6466 libc.  These entry points should be supplied through some other
6467 mechanism when this option is specified.
6469 @cindex @option{-lgcc}, use with @option{-nostdlib}
6470 @cindex @option{-nostdlib} and unresolved references
6471 @cindex unresolved references and @option{-nostdlib}
6472 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6473 @cindex @option{-nodefaultlibs} and unresolved references
6474 @cindex unresolved references and @option{-nodefaultlibs}
6475 One of the standard libraries bypassed by @option{-nostdlib} and
6476 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6477 that GCC uses to overcome shortcomings of particular machines, or special
6478 needs for some languages.
6479 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6480 Collection (GCC) Internals},
6481 for more discussion of @file{libgcc.a}.)
6482 In most cases, you need @file{libgcc.a} even when you want to avoid
6483 other standard libraries.  In other words, when you specify @option{-nostdlib}
6484 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6485 This ensures that you have no unresolved references to internal GCC
6486 library subroutines.  (For example, @samp{__main}, used to ensure C++
6487 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6488 GNU Compiler Collection (GCC) Internals}.)
6490 @item -pie
6491 @opindex pie
6492 Produce a position independent executable on targets which support it.
6493 For predictable results, you must also specify the same set of options
6494 that were used to generate code (@option{-fpie}, @option{-fPIE},
6495 or model suboptions) when you specify this option.
6497 @item -rdynamic
6498 @opindex rdynamic
6499 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6500 that support it. This instructs the linker to add all symbols, not
6501 only used ones, to the dynamic symbol table. This option is needed
6502 for some uses of @code{dlopen} or to allow obtaining backtraces
6503 from within a program.
6505 @item -s
6506 @opindex s
6507 Remove all symbol table and relocation information from the executable.
6509 @item -static
6510 @opindex static
6511 On systems that support dynamic linking, this prevents linking with the shared
6512 libraries.  On other systems, this option has no effect.
6514 @item -shared
6515 @opindex shared
6516 Produce a shared object which can then be linked with other objects to
6517 form an executable.  Not all systems support this option.  For predictable
6518 results, you must also specify the same set of options that were used to
6519 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6520 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6521 needs to build supplementary stub code for constructors to work.  On
6522 multi-libbed systems, @samp{gcc -shared} must select the correct support
6523 libraries to link against.  Failing to supply the correct flags may lead
6524 to subtle defects.  Supplying them in cases where they are not necessary
6525 is innocuous.}
6527 @item -shared-libgcc
6528 @itemx -static-libgcc
6529 @opindex shared-libgcc
6530 @opindex static-libgcc
6531 On systems that provide @file{libgcc} as a shared library, these options
6532 force the use of either the shared or static version respectively.
6533 If no shared version of @file{libgcc} was built when the compiler was
6534 configured, these options have no effect.
6536 There are several situations in which an application should use the
6537 shared @file{libgcc} instead of the static version.  The most common
6538 of these is when the application wishes to throw and catch exceptions
6539 across different shared libraries.  In that case, each of the libraries
6540 as well as the application itself should use the shared @file{libgcc}.
6542 Therefore, the G++ and GCJ drivers automatically add
6543 @option{-shared-libgcc} whenever you build a shared library or a main
6544 executable, because C++ and Java programs typically use exceptions, so
6545 this is the right thing to do.
6547 If, instead, you use the GCC driver to create shared libraries, you may
6548 find that they will not always be linked with the shared @file{libgcc}.
6549 If GCC finds, at its configuration time, that you have a non-GNU linker
6550 or a GNU linker that does not support option @option{--eh-frame-hdr},
6551 it will link the shared version of @file{libgcc} into shared libraries
6552 by default.  Otherwise, it will take advantage of the linker and optimize
6553 away the linking with the shared version of @file{libgcc}, linking with
6554 the static version of libgcc by default.  This allows exceptions to
6555 propagate through such shared libraries, without incurring relocation
6556 costs at library load time.
6558 However, if a library or main executable is supposed to throw or catch
6559 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6560 for the languages used in the program, or using the option
6561 @option{-shared-libgcc}, such that it is linked with the shared
6562 @file{libgcc}.
6564 @item -symbolic
6565 @opindex symbolic
6566 Bind references to global symbols when building a shared object.  Warn
6567 about any unresolved references (unless overridden by the link editor
6568 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6569 this option.
6571 @item -Xlinker @var{option}
6572 @opindex Xlinker
6573 Pass @var{option} as an option to the linker.  You can use this to
6574 supply system-specific linker options which GCC does not know how to
6575 recognize.
6577 If you want to pass an option that takes an argument, you must use
6578 @option{-Xlinker} twice, once for the option and once for the argument.
6579 For example, to pass @option{-assert definitions}, you must write
6580 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6581 @option{-Xlinker "-assert definitions"}, because this passes the entire
6582 string as a single argument, which is not what the linker expects.
6584 @item -Wl,@var{option}
6585 @opindex Wl
6586 Pass @var{option} as an option to the linker.  If @var{option} contains
6587 commas, it is split into multiple options at the commas.
6589 @item -u @var{symbol}
6590 @opindex u
6591 Pretend the symbol @var{symbol} is undefined, to force linking of
6592 library modules to define it.  You can use @option{-u} multiple times with
6593 different symbols to force loading of additional library modules.
6594 @end table
6596 @node Directory Options
6597 @section Options for Directory Search
6598 @cindex directory options
6599 @cindex options, directory search
6600 @cindex search path
6602 These options specify directories to search for header files, for
6603 libraries and for parts of the compiler:
6605 @table @gcctabopt
6606 @item -I@var{dir}
6607 @opindex I
6608 Add the directory @var{dir} to the head of the list of directories to be
6609 searched for header files.  This can be used to override a system header
6610 file, substituting your own version, since these directories are
6611 searched before the system header file directories.  However, you should
6612 not use this option to add directories that contain vendor-supplied
6613 system header files (use @option{-isystem} for that).  If you use more than
6614 one @option{-I} option, the directories are scanned in left-to-right
6615 order; the standard system directories come after.
6617 If a standard system include directory, or a directory specified with
6618 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6619 option will be ignored.  The directory will still be searched but as a
6620 system directory at its normal position in the system include chain.
6621 This is to ensure that GCC's procedure to fix buggy system headers and
6622 the ordering for the include_next directive are not inadvertently changed.
6623 If you really need to change the search order for system directories,
6624 use the @option{-nostdinc} and/or @option{-isystem} options.
6626 @item -iquote@var{dir}
6627 @opindex iquote
6628 Add the directory @var{dir} to the head of the list of directories to
6629 be searched for header files only for the case of @samp{#include
6630 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6631 otherwise just like @option{-I}.
6633 @item -L@var{dir}
6634 @opindex L
6635 Add directory @var{dir} to the list of directories to be searched
6636 for @option{-l}.
6638 @item -B@var{prefix}
6639 @opindex B
6640 This option specifies where to find the executables, libraries,
6641 include files, and data files of the compiler itself.
6643 The compiler driver program runs one or more of the subprograms
6644 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6645 @var{prefix} as a prefix for each program it tries to run, both with and
6646 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6648 For each subprogram to be run, the compiler driver first tries the
6649 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6650 was not specified, the driver tries two standard prefixes, which are
6651 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6652 those results in a file name that is found, the unmodified program
6653 name is searched for using the directories specified in your
6654 @env{PATH} environment variable.
6656 The compiler will check to see if the path provided by the @option{-B}
6657 refers to a directory, and if necessary it will add a directory
6658 separator character at the end of the path.
6660 @option{-B} prefixes that effectively specify directory names also apply
6661 to libraries in the linker, because the compiler translates these
6662 options into @option{-L} options for the linker.  They also apply to
6663 includes files in the preprocessor, because the compiler translates these
6664 options into @option{-isystem} options for the preprocessor.  In this case,
6665 the compiler appends @samp{include} to the prefix.
6667 The run-time support file @file{libgcc.a} can also be searched for using
6668 the @option{-B} prefix, if needed.  If it is not found there, the two
6669 standard prefixes above are tried, and that is all.  The file is left
6670 out of the link if it is not found by those means.
6672 Another way to specify a prefix much like the @option{-B} prefix is to use
6673 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6674 Variables}.
6676 As a special kludge, if the path provided by @option{-B} is
6677 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6678 9, then it will be replaced by @file{[dir/]include}.  This is to help
6679 with boot-strapping the compiler.
6681 @item -specs=@var{file}
6682 @opindex specs
6683 Process @var{file} after the compiler reads in the standard @file{specs}
6684 file, in order to override the defaults that the @file{gcc} driver
6685 program uses when determining what switches to pass to @file{cc1},
6686 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6687 @option{-specs=@var{file}} can be specified on the command line, and they
6688 are processed in order, from left to right.
6690 @item --sysroot=@var{dir}
6691 @opindex sysroot
6692 Use @var{dir} as the logical root directory for headers and libraries.
6693 For example, if the compiler would normally search for headers in
6694 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6695 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6697 If you use both this option and the @option{-isysroot} option, then
6698 the @option{--sysroot} option will apply to libraries, but the
6699 @option{-isysroot} option will apply to header files.
6701 The GNU linker (beginning with version 2.16) has the necessary support
6702 for this option.  If your linker does not support this option, the
6703 header file aspect of @option{--sysroot} will still work, but the
6704 library aspect will not.
6706 @item -I-
6707 @opindex I-
6708 This option has been deprecated.  Please use @option{-iquote} instead for
6709 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6710 Any directories you specify with @option{-I} options before the @option{-I-}
6711 option are searched only for the case of @samp{#include "@var{file}"};
6712 they are not searched for @samp{#include <@var{file}>}.
6714 If additional directories are specified with @option{-I} options after
6715 the @option{-I-}, these directories are searched for all @samp{#include}
6716 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6717 this way.)
6719 In addition, the @option{-I-} option inhibits the use of the current
6720 directory (where the current input file came from) as the first search
6721 directory for @samp{#include "@var{file}"}.  There is no way to
6722 override this effect of @option{-I-}.  With @option{-I.} you can specify
6723 searching the directory which was current when the compiler was
6724 invoked.  That is not exactly the same as what the preprocessor does
6725 by default, but it is often satisfactory.
6727 @option{-I-} does not inhibit the use of the standard system directories
6728 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6729 independent.
6730 @end table
6732 @c man end
6734 @node Spec Files
6735 @section Specifying subprocesses and the switches to pass to them
6736 @cindex Spec Files
6738 @command{gcc} is a driver program.  It performs its job by invoking a
6739 sequence of other programs to do the work of compiling, assembling and
6740 linking.  GCC interprets its command-line parameters and uses these to
6741 deduce which programs it should invoke, and which command-line options
6742 it ought to place on their command lines.  This behavior is controlled
6743 by @dfn{spec strings}.  In most cases there is one spec string for each
6744 program that GCC can invoke, but a few programs have multiple spec
6745 strings to control their behavior.  The spec strings built into GCC can
6746 be overridden by using the @option{-specs=} command-line switch to specify
6747 a spec file.
6749 @dfn{Spec files} are plaintext files that are used to construct spec
6750 strings.  They consist of a sequence of directives separated by blank
6751 lines.  The type of directive is determined by the first non-whitespace
6752 character on the line and it can be one of the following:
6754 @table @code
6755 @item %@var{command}
6756 Issues a @var{command} to the spec file processor.  The commands that can
6757 appear here are:
6759 @table @code
6760 @item %include <@var{file}>
6761 @cindex %include
6762 Search for @var{file} and insert its text at the current point in the
6763 specs file.
6765 @item %include_noerr <@var{file}>
6766 @cindex %include_noerr
6767 Just like @samp{%include}, but do not generate an error message if the include
6768 file cannot be found.
6770 @item %rename @var{old_name} @var{new_name}
6771 @cindex %rename
6772 Rename the spec string @var{old_name} to @var{new_name}.
6774 @end table
6776 @item *[@var{spec_name}]:
6777 This tells the compiler to create, override or delete the named spec
6778 string.  All lines after this directive up to the next directive or
6779 blank line are considered to be the text for the spec string.  If this
6780 results in an empty string then the spec will be deleted.  (Or, if the
6781 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6782 does not currently exist a new spec will be created.  If the spec does
6783 exist then its contents will be overridden by the text of this
6784 directive, unless the first character of that text is the @samp{+}
6785 character, in which case the text will be appended to the spec.
6787 @item [@var{suffix}]:
6788 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6789 and up to the next directive or blank line are considered to make up the
6790 spec string for the indicated suffix.  When the compiler encounters an
6791 input file with the named suffix, it will processes the spec string in
6792 order to work out how to compile that file.  For example:
6794 @smallexample
6795 .ZZ:
6796 z-compile -input %i
6797 @end smallexample
6799 This says that any input file whose name ends in @samp{.ZZ} should be
6800 passed to the program @samp{z-compile}, which should be invoked with the
6801 command-line switch @option{-input} and with the result of performing the
6802 @samp{%i} substitution.  (See below.)
6804 As an alternative to providing a spec string, the text that follows a
6805 suffix directive can be one of the following:
6807 @table @code
6808 @item @@@var{language}
6809 This says that the suffix is an alias for a known @var{language}.  This is
6810 similar to using the @option{-x} command-line switch to GCC to specify a
6811 language explicitly.  For example:
6813 @smallexample
6814 .ZZ:
6815 @@c++
6816 @end smallexample
6818 Says that .ZZ files are, in fact, C++ source files.
6820 @item #@var{name}
6821 This causes an error messages saying:
6823 @smallexample
6824 @var{name} compiler not installed on this system.
6825 @end smallexample
6826 @end table
6828 GCC already has an extensive list of suffixes built into it.
6829 This directive will add an entry to the end of the list of suffixes, but
6830 since the list is searched from the end backwards, it is effectively
6831 possible to override earlier entries using this technique.
6833 @end table
6835 GCC has the following spec strings built into it.  Spec files can
6836 override these strings or create their own.  Note that individual
6837 targets can also add their own spec strings to this list.
6839 @smallexample
6840 asm          Options to pass to the assembler
6841 asm_final    Options to pass to the assembler post-processor
6842 cpp          Options to pass to the C preprocessor
6843 cc1          Options to pass to the C compiler
6844 cc1plus      Options to pass to the C++ compiler
6845 endfile      Object files to include at the end of the link
6846 link         Options to pass to the linker
6847 lib          Libraries to include on the command line to the linker
6848 libgcc       Decides which GCC support library to pass to the linker
6849 linker       Sets the name of the linker
6850 predefines   Defines to be passed to the C preprocessor
6851 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6852              by default
6853 startfile    Object files to include at the start of the link
6854 @end smallexample
6856 Here is a small example of a spec file:
6858 @smallexample
6859 %rename lib                 old_lib
6861 *lib:
6862 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6863 @end smallexample
6865 This example renames the spec called @samp{lib} to @samp{old_lib} and
6866 then overrides the previous definition of @samp{lib} with a new one.
6867 The new definition adds in some extra command-line options before
6868 including the text of the old definition.
6870 @dfn{Spec strings} are a list of command-line options to be passed to their
6871 corresponding program.  In addition, the spec strings can contain
6872 @samp{%}-prefixed sequences to substitute variable text or to
6873 conditionally insert text into the command line.  Using these constructs
6874 it is possible to generate quite complex command lines.
6876 Here is a table of all defined @samp{%}-sequences for spec
6877 strings.  Note that spaces are not generated automatically around the
6878 results of expanding these sequences.  Therefore you can concatenate them
6879 together or combine them with constant text in a single argument.
6881 @table @code
6882 @item %%
6883 Substitute one @samp{%} into the program name or argument.
6885 @item %i
6886 Substitute the name of the input file being processed.
6888 @item %b
6889 Substitute the basename of the input file being processed.
6890 This is the substring up to (and not including) the last period
6891 and not including the directory.
6893 @item %B
6894 This is the same as @samp{%b}, but include the file suffix (text after
6895 the last period).
6897 @item %d
6898 Marks the argument containing or following the @samp{%d} as a
6899 temporary file name, so that that file will be deleted if GCC exits
6900 successfully.  Unlike @samp{%g}, this contributes no text to the
6901 argument.
6903 @item %g@var{suffix}
6904 Substitute a file name that has suffix @var{suffix} and is chosen
6905 once per compilation, and mark the argument in the same way as
6906 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6907 name is now chosen in a way that is hard to predict even when previously
6908 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6909 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6910 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6911 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6912 was simply substituted with a file name chosen once per compilation,
6913 without regard to any appended suffix (which was therefore treated
6914 just like ordinary text), making such attacks more likely to succeed.
6916 @item %u@var{suffix}
6917 Like @samp{%g}, but generates a new temporary file name even if
6918 @samp{%u@var{suffix}} was already seen.
6920 @item %U@var{suffix}
6921 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6922 new one if there is no such last file name.  In the absence of any
6923 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6924 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6925 would involve the generation of two distinct file names, one
6926 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6927 simply substituted with a file name chosen for the previous @samp{%u},
6928 without regard to any appended suffix.
6930 @item %j@var{suffix}
6931 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6932 writable, and if save-temps is off; otherwise, substitute the name
6933 of a temporary file, just like @samp{%u}.  This temporary file is not
6934 meant for communication between processes, but rather as a junk
6935 disposal mechanism.
6937 @item %|@var{suffix}
6938 @itemx %m@var{suffix}
6939 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6940 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6941 all.  These are the two most common ways to instruct a program that it
6942 should read from standard input or write to standard output.  If you
6943 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6944 construct: see for example @file{f/lang-specs.h}.
6946 @item %.@var{SUFFIX}
6947 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6948 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6949 terminated by the next space or %.
6951 @item %w
6952 Marks the argument containing or following the @samp{%w} as the
6953 designated output file of this compilation.  This puts the argument
6954 into the sequence of arguments that @samp{%o} will substitute later.
6956 @item %o
6957 Substitutes the names of all the output files, with spaces
6958 automatically placed around them.  You should write spaces
6959 around the @samp{%o} as well or the results are undefined.
6960 @samp{%o} is for use in the specs for running the linker.
6961 Input files whose names have no recognized suffix are not compiled
6962 at all, but they are included among the output files, so they will
6963 be linked.
6965 @item %O
6966 Substitutes the suffix for object files.  Note that this is
6967 handled specially when it immediately follows @samp{%g, %u, or %U},
6968 because of the need for those to form complete file names.  The
6969 handling is such that @samp{%O} is treated exactly as if it had already
6970 been substituted, except that @samp{%g, %u, and %U} do not currently
6971 support additional @var{suffix} characters following @samp{%O} as they would
6972 following, for example, @samp{.o}.
6974 @item %p
6975 Substitutes the standard macro predefinitions for the
6976 current target machine.  Use this when running @code{cpp}.
6978 @item %P
6979 Like @samp{%p}, but puts @samp{__} before and after the name of each
6980 predefined macro, except for macros that start with @samp{__} or with
6981 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6984 @item %I
6985 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6986 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
6987 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6988 and @option{-imultilib} as necessary.
6990 @item %s
6991 Current argument is the name of a library or startup file of some sort.
6992 Search for that file in a standard list of directories and substitute
6993 the full name found.
6995 @item %e@var{str}
6996 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6997 Use this when inconsistent options are detected.
6999 @item %(@var{name})
7000 Substitute the contents of spec string @var{name} at this point.
7002 @item %[@var{name}]
7003 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
7005 @item %x@{@var{option}@}
7006 Accumulate an option for @samp{%X}.
7008 @item %X
7009 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
7010 spec string.
7012 @item %Y
7013 Output the accumulated assembler options specified by @option{-Wa}.
7015 @item %Z
7016 Output the accumulated preprocessor options specified by @option{-Wp}.
7018 @item %a
7019 Process the @code{asm} spec.  This is used to compute the
7020 switches to be passed to the assembler.
7022 @item %A
7023 Process the @code{asm_final} spec.  This is a spec string for
7024 passing switches to an assembler post-processor, if such a program is
7025 needed.
7027 @item %l
7028 Process the @code{link} spec.  This is the spec for computing the
7029 command line passed to the linker.  Typically it will make use of the
7030 @samp{%L %G %S %D and %E} sequences.
7032 @item %D
7033 Dump out a @option{-L} option for each directory that GCC believes might
7034 contain startup files.  If the target supports multilibs then the
7035 current multilib directory will be prepended to each of these paths.
7037 @item %L
7038 Process the @code{lib} spec.  This is a spec string for deciding which
7039 libraries should be included on the command line to the linker.
7041 @item %G
7042 Process the @code{libgcc} spec.  This is a spec string for deciding
7043 which GCC support library should be included on the command line to the linker.
7045 @item %S
7046 Process the @code{startfile} spec.  This is a spec for deciding which
7047 object files should be the first ones passed to the linker.  Typically
7048 this might be a file named @file{crt0.o}.
7050 @item %E
7051 Process the @code{endfile} spec.  This is a spec string that specifies
7052 the last object files that will be passed to the linker.
7054 @item %C
7055 Process the @code{cpp} spec.  This is used to construct the arguments
7056 to be passed to the C preprocessor.
7058 @item %1
7059 Process the @code{cc1} spec.  This is used to construct the options to be
7060 passed to the actual C compiler (@samp{cc1}).
7062 @item %2
7063 Process the @code{cc1plus} spec.  This is used to construct the options to be
7064 passed to the actual C++ compiler (@samp{cc1plus}).
7066 @item %*
7067 Substitute the variable part of a matched option.  See below.
7068 Note that each comma in the substituted string is replaced by
7069 a single space.
7071 @item %<@code{S}
7072 Remove all occurrences of @code{-S} from the command line.  Note---this
7073 command is position dependent.  @samp{%} commands in the spec string
7074 before this one will see @code{-S}, @samp{%} commands in the spec string
7075 after this one will not.
7077 @item %:@var{function}(@var{args})
7078 Call the named function @var{function}, passing it @var{args}.
7079 @var{args} is first processed as a nested spec string, then split
7080 into an argument vector in the usual fashion.  The function returns
7081 a string which is processed as if it had appeared literally as part
7082 of the current spec.
7084 The following built-in spec functions are provided:
7086 @table @code
7087 @item @code{if-exists}
7088 The @code{if-exists} spec function takes one argument, an absolute
7089 pathname to a file.  If the file exists, @code{if-exists} returns the
7090 pathname.  Here is a small example of its usage:
7092 @smallexample
7093 *startfile:
7094 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
7095 @end smallexample
7097 @item @code{if-exists-else}
7098 The @code{if-exists-else} spec function is similar to the @code{if-exists}
7099 spec function, except that it takes two arguments.  The first argument is
7100 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
7101 returns the pathname.  If it does not exist, it returns the second argument.
7102 This way, @code{if-exists-else} can be used to select one file or another,
7103 based on the existence of the first.  Here is a small example of its usage:
7105 @smallexample
7106 *startfile:
7107 crt0%O%s %:if-exists(crti%O%s) \
7108 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
7109 @end smallexample
7111 @item @code{replace-outfile}
7112 The @code{replace-outfile} spec function takes two arguments.  It looks for the
7113 first argument in the outfiles array and replaces it with the second argument.  Here
7114 is a small example of its usage:
7116 @smallexample
7117 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
7118 @end smallexample
7120 @end table
7122 @item %@{@code{S}@}
7123 Substitutes the @code{-S} switch, if that switch was given to GCC@.
7124 If that switch was not specified, this substitutes nothing.  Note that
7125 the leading dash is omitted when specifying this option, and it is
7126 automatically inserted if the substitution is performed.  Thus the spec
7127 string @samp{%@{foo@}} would match the command-line option @option{-foo}
7128 and would output the command line option @option{-foo}.
7130 @item %W@{@code{S}@}
7131 Like %@{@code{S}@} but mark last argument supplied within as a file to be
7132 deleted on failure.
7134 @item %@{@code{S}*@}
7135 Substitutes all the switches specified to GCC whose names start
7136 with @code{-S}, but which also take an argument.  This is used for
7137 switches like @option{-o}, @option{-D}, @option{-I}, etc.
7138 GCC considers @option{-o foo} as being
7139 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
7140 text, including the space.  Thus two arguments would be generated.
7142 @item %@{@code{S}*&@code{T}*@}
7143 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7144 (the order of @code{S} and @code{T} in the spec is not significant).
7145 There can be any number of ampersand-separated variables; for each the
7146 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
7148 @item %@{@code{S}:@code{X}@}
7149 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7151 @item %@{!@code{S}:@code{X}@}
7152 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7154 @item %@{@code{S}*:@code{X}@}
7155 Substitutes @code{X} if one or more switches whose names start with
7156 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
7157 once, no matter how many such switches appeared.  However, if @code{%*}
7158 appears somewhere in @code{X}, then @code{X} will be substituted once
7159 for each matching switch, with the @code{%*} replaced by the part of
7160 that switch that matched the @code{*}.
7162 @item %@{.@code{S}:@code{X}@}
7163 Substitutes @code{X}, if processing a file with suffix @code{S}.
7165 @item %@{!.@code{S}:@code{X}@}
7166 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7168 @item %@{@code{S}|@code{P}:@code{X}@}
7169 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7170 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7171 although they have a stronger binding than the @samp{|}.  If @code{%*}
7172 appears in @code{X}, all of the alternatives must be starred, and only
7173 the first matching alternative is substituted.
7175 For example, a spec string like this:
7177 @smallexample
7178 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7179 @end smallexample
7181 will output the following command-line options from the following input
7182 command-line options:
7184 @smallexample
7185 fred.c        -foo -baz
7186 jim.d         -bar -boggle
7187 -d fred.c     -foo -baz -boggle
7188 -d jim.d      -bar -baz -boggle
7189 @end smallexample
7191 @item %@{S:X; T:Y; :D@}
7193 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7194 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7195 be as many clauses as you need.  This may be combined with @code{.},
7196 @code{!}, @code{|}, and @code{*} as needed.
7199 @end table
7201 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7202 construct may contain other nested @samp{%} constructs or spaces, or
7203 even newlines.  They are processed as usual, as described above.
7204 Trailing white space in @code{X} is ignored.  White space may also
7205 appear anywhere on the left side of the colon in these constructs,
7206 except between @code{.} or @code{*} and the corresponding word.
7208 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7209 handled specifically in these constructs.  If another value of
7210 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7211 @option{-W} switch is found later in the command line, the earlier
7212 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7213 just one letter, which passes all matching options.
7215 The character @samp{|} at the beginning of the predicate text is used to
7216 indicate that a command should be piped to the following command, but
7217 only if @option{-pipe} is specified.
7219 It is built into GCC which switches take arguments and which do not.
7220 (You might think it would be useful to generalize this to allow each
7221 compiler's spec to say which switches take arguments.  But this cannot
7222 be done in a consistent fashion.  GCC cannot even decide which input
7223 files have been specified without knowing which switches take arguments,
7224 and it must know which input files to compile in order to tell which
7225 compilers to run).
7227 GCC also knows implicitly that arguments starting in @option{-l} are to be
7228 treated as compiler output files, and passed to the linker in their
7229 proper position among the other output files.
7231 @c man begin OPTIONS
7233 @node Target Options
7234 @section Specifying Target Machine and Compiler Version
7235 @cindex target options
7236 @cindex cross compiling
7237 @cindex specifying machine version
7238 @cindex specifying compiler version and target machine
7239 @cindex compiler version, specifying
7240 @cindex target machine, specifying
7242 The usual way to run GCC is to run the executable called @file{gcc}, or
7243 @file{<machine>-gcc} when cross-compiling, or
7244 @file{<machine>-gcc-<version>} to run a version other than the one that
7245 was installed last.  Sometimes this is inconvenient, so GCC provides
7246 options that will switch to another cross-compiler or version.
7248 @table @gcctabopt
7249 @item -b @var{machine}
7250 @opindex b
7251 The argument @var{machine} specifies the target machine for compilation.
7253 The value to use for @var{machine} is the same as was specified as the
7254 machine type when configuring GCC as a cross-compiler.  For
7255 example, if a cross-compiler was configured with @samp{configure
7256 arm-elf}, meaning to compile for an arm processor with elf binaries,
7257 then you would specify @option{-b arm-elf} to run that cross compiler.
7258 Because there are other options beginning with @option{-b}, the
7259 configuration must contain a hyphen. 
7261 @item -V @var{version}
7262 @opindex V
7263 The argument @var{version} specifies which version of GCC to run.
7264 This is useful when multiple versions are installed.  For example,
7265 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7266 @end table
7268 The @option{-V} and @option{-b} options work by running the
7269 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7270 use them if you can just run that directly.
7272 @node Submodel Options
7273 @section Hardware Models and Configurations
7274 @cindex submodel options
7275 @cindex specifying hardware config
7276 @cindex hardware models and configurations, specifying
7277 @cindex machine dependent options
7279 Earlier we discussed the standard option @option{-b} which chooses among
7280 different installed compilers for completely different target
7281 machines, such as VAX vs.@: 68000 vs.@: 80386.
7283 In addition, each of these target machine types can have its own
7284 special options, starting with @samp{-m}, to choose among various
7285 hardware models or configurations---for example, 68010 vs 68020,
7286 floating coprocessor or none.  A single installed version of the
7287 compiler can compile for any model or configuration, according to the
7288 options specified.
7290 Some configurations of the compiler also support additional special
7291 options, usually for compatibility with other compilers on the same
7292 platform.
7294 @c This list is ordered alphanumerically by subsection name.
7295 @c It should be the same order and spelling as these options are listed
7296 @c in Machine Dependent Options
7298 @menu
7299 * ARC Options::
7300 * ARM Options::
7301 * AVR Options::
7302 * Blackfin Options::
7303 * CRIS Options::
7304 * CRX Options::
7305 * Darwin Options::
7306 * DEC Alpha Options::
7307 * DEC Alpha/VMS Options::
7308 * FRV Options::
7309 * GNU/Linux Options::
7310 * H8/300 Options::
7311 * HPPA Options::
7312 * i386 and x86-64 Options::
7313 * IA-64 Options::
7314 * M32C Options::
7315 * M32R/D Options::
7316 * M680x0 Options::
7317 * M68hc1x Options::
7318 * MCore Options::
7319 * MIPS Options::
7320 * MMIX Options::
7321 * MN10300 Options::
7322 * MT Options::
7323 * PDP-11 Options::
7324 * PowerPC Options::
7325 * RS/6000 and PowerPC Options::
7326 * S/390 and zSeries Options::
7327 * Score Options::
7328 * SH Options::
7329 * SPARC Options::
7330 * System V Options::
7331 * TMS320C3x/C4x Options::
7332 * V850 Options::
7333 * VAX Options::
7334 * x86-64 Options::
7335 * Xstormy16 Options::
7336 * Xtensa Options::
7337 * zSeries Options::
7338 @end menu
7340 @node ARC Options
7341 @subsection ARC Options
7342 @cindex ARC Options
7344 These options are defined for ARC implementations:
7346 @table @gcctabopt
7347 @item -EL
7348 @opindex EL
7349 Compile code for little endian mode.  This is the default.
7351 @item -EB
7352 @opindex EB
7353 Compile code for big endian mode.
7355 @item -mmangle-cpu
7356 @opindex mmangle-cpu
7357 Prepend the name of the cpu to all public symbol names.
7358 In multiple-processor systems, there are many ARC variants with different
7359 instruction and register set characteristics.  This flag prevents code
7360 compiled for one cpu to be linked with code compiled for another.
7361 No facility exists for handling variants that are ``almost identical''.
7362 This is an all or nothing option.
7364 @item -mcpu=@var{cpu}
7365 @opindex mcpu
7366 Compile code for ARC variant @var{cpu}.
7367 Which variants are supported depend on the configuration.
7368 All variants support @option{-mcpu=base}, this is the default.
7370 @item -mtext=@var{text-section}
7371 @itemx -mdata=@var{data-section}
7372 @itemx -mrodata=@var{readonly-data-section}
7373 @opindex mtext
7374 @opindex mdata
7375 @opindex mrodata
7376 Put functions, data, and readonly data in @var{text-section},
7377 @var{data-section}, and @var{readonly-data-section} respectively
7378 by default.  This can be overridden with the @code{section} attribute.
7379 @xref{Variable Attributes}.
7381 @end table
7383 @node ARM Options
7384 @subsection ARM Options
7385 @cindex ARM options
7387 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7388 architectures:
7390 @table @gcctabopt
7391 @item -mabi=@var{name}
7392 @opindex mabi
7393 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7394 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7396 @item -mapcs-frame
7397 @opindex mapcs-frame
7398 Generate a stack frame that is compliant with the ARM Procedure Call
7399 Standard for all functions, even if this is not strictly necessary for
7400 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7401 with this option will cause the stack frames not to be generated for
7402 leaf functions.  The default is @option{-mno-apcs-frame}.
7404 @item -mapcs
7405 @opindex mapcs
7406 This is a synonym for @option{-mapcs-frame}.
7408 @ignore
7409 @c not currently implemented
7410 @item -mapcs-stack-check
7411 @opindex mapcs-stack-check
7412 Generate code to check the amount of stack space available upon entry to
7413 every function (that actually uses some stack space).  If there is
7414 insufficient space available then either the function
7415 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7416 called, depending upon the amount of stack space required.  The run time
7417 system is required to provide these functions.  The default is
7418 @option{-mno-apcs-stack-check}, since this produces smaller code.
7420 @c not currently implemented
7421 @item -mapcs-float
7422 @opindex mapcs-float
7423 Pass floating point arguments using the float point registers.  This is
7424 one of the variants of the APCS@.  This option is recommended if the
7425 target hardware has a floating point unit or if a lot of floating point
7426 arithmetic is going to be performed by the code.  The default is
7427 @option{-mno-apcs-float}, since integer only code is slightly increased in
7428 size if @option{-mapcs-float} is used.
7430 @c not currently implemented
7431 @item -mapcs-reentrant
7432 @opindex mapcs-reentrant
7433 Generate reentrant, position independent code.  The default is
7434 @option{-mno-apcs-reentrant}.
7435 @end ignore
7437 @item -mthumb-interwork
7438 @opindex mthumb-interwork
7439 Generate code which supports calling between the ARM and Thumb
7440 instruction sets.  Without this option the two instruction sets cannot
7441 be reliably used inside one program.  The default is
7442 @option{-mno-thumb-interwork}, since slightly larger code is generated
7443 when @option{-mthumb-interwork} is specified.
7445 @item -mno-sched-prolog
7446 @opindex mno-sched-prolog
7447 Prevent the reordering of instructions in the function prolog, or the
7448 merging of those instruction with the instructions in the function's
7449 body.  This means that all functions will start with a recognizable set
7450 of instructions (or in fact one of a choice from a small set of
7451 different function prologues), and this information can be used to
7452 locate the start if functions inside an executable piece of code.  The
7453 default is @option{-msched-prolog}.
7455 @item -mhard-float
7456 @opindex mhard-float
7457 Generate output containing floating point instructions.  This is the
7458 default.
7460 @item -msoft-float
7461 @opindex msoft-float
7462 Generate output containing library calls for floating point.
7463 @strong{Warning:} the requisite libraries are not available for all ARM
7464 targets.  Normally the facilities of the machine's usual C compiler are
7465 used, but this cannot be done directly in cross-compilation.  You must make
7466 your own arrangements to provide suitable library functions for
7467 cross-compilation.
7469 @option{-msoft-float} changes the calling convention in the output file;
7470 therefore, it is only useful if you compile @emph{all} of a program with
7471 this option.  In particular, you need to compile @file{libgcc.a}, the
7472 library that comes with GCC, with @option{-msoft-float} in order for
7473 this to work.
7475 @item -mfloat-abi=@var{name}
7476 @opindex mfloat-abi
7477 Specifies which ABI to use for floating point values.  Permissible values
7478 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7480 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7481 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7482 of floating point instructions, but still uses the soft-float calling
7483 conventions.
7485 @item -mlittle-endian
7486 @opindex mlittle-endian
7487 Generate code for a processor running in little-endian mode.  This is
7488 the default for all standard configurations.
7490 @item -mbig-endian
7491 @opindex mbig-endian
7492 Generate code for a processor running in big-endian mode; the default is
7493 to compile code for a little-endian processor.
7495 @item -mwords-little-endian
7496 @opindex mwords-little-endian
7497 This option only applies when generating code for big-endian processors.
7498 Generate code for a little-endian word order but a big-endian byte
7499 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7500 option should only be used if you require compatibility with code for
7501 big-endian ARM processors generated by versions of the compiler prior to
7502 2.8.
7504 @item -mcpu=@var{name}
7505 @opindex mcpu
7506 This specifies the name of the target ARM processor.  GCC uses this name
7507 to determine what kind of instructions it can emit when generating
7508 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7509 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7510 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7511 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7512 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7513 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7514 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7515 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7516 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7517 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7518 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7519 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7520 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7521 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7522 @samp{ep9312}.
7524 @itemx -mtune=@var{name}
7525 @opindex mtune
7526 This option is very similar to the @option{-mcpu=} option, except that
7527 instead of specifying the actual target processor type, and hence
7528 restricting which instructions can be used, it specifies that GCC should
7529 tune the performance of the code as if the target were of the type
7530 specified in this option, but still choosing the instructions that it
7531 will generate based on the cpu specified by a @option{-mcpu=} option.
7532 For some ARM implementations better performance can be obtained by using
7533 this option.
7535 @item -march=@var{name}
7536 @opindex march
7537 This specifies the name of the target ARM architecture.  GCC uses this
7538 name to determine what kind of instructions it can emit when generating
7539 assembly code.  This option can be used in conjunction with or instead
7540 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7541 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7542 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7543 @samp{iwmmxt}, @samp{ep9312}.
7545 @item -mfpu=@var{name}
7546 @itemx -mfpe=@var{number}
7547 @itemx -mfp=@var{number}
7548 @opindex mfpu
7549 @opindex mfpe
7550 @opindex mfp
7551 This specifies what floating point hardware (or hardware emulation) is
7552 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7553 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7554 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7555 with older versions of GCC@.
7557 If @option{-msoft-float} is specified this specifies the format of
7558 floating point values.
7560 @item -mstructure-size-boundary=@var{n}
7561 @opindex mstructure-size-boundary
7562 The size of all structures and unions will be rounded up to a multiple
7563 of the number of bits set by this option.  Permissible values are 8, 32
7564 and 64.  The default value varies for different toolchains.  For the COFF
7565 targeted toolchain the default value is 8.  A value of 64 is only allowed
7566 if the underlying ABI supports it.
7568 Specifying the larger number can produce faster, more efficient code, but
7569 can also increase the size of the program.  Different values are potentially
7570 incompatible.  Code compiled with one value cannot necessarily expect to
7571 work with code or libraries compiled with another value, if they exchange
7572 information using structures or unions.
7574 @item -mabort-on-noreturn
7575 @opindex mabort-on-noreturn
7576 Generate a call to the function @code{abort} at the end of a
7577 @code{noreturn} function.  It will be executed if the function tries to
7578 return.
7580 @item -mlong-calls
7581 @itemx -mno-long-calls
7582 @opindex mlong-calls
7583 @opindex mno-long-calls
7584 Tells the compiler to perform function calls by first loading the
7585 address of the function into a register and then performing a subroutine
7586 call on this register.  This switch is needed if the target function
7587 will lie outside of the 64 megabyte addressing range of the offset based
7588 version of subroutine call instruction.
7590 Even if this switch is enabled, not all function calls will be turned
7591 into long calls.  The heuristic is that static functions, functions
7592 which have the @samp{short-call} attribute, functions that are inside
7593 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7594 definitions have already been compiled within the current compilation
7595 unit, will not be turned into long calls.  The exception to this rule is
7596 that weak function definitions, functions with the @samp{long-call}
7597 attribute or the @samp{section} attribute, and functions that are within
7598 the scope of a @samp{#pragma long_calls} directive, will always be
7599 turned into long calls.
7601 This feature is not enabled by default.  Specifying
7602 @option{-mno-long-calls} will restore the default behavior, as will
7603 placing the function calls within the scope of a @samp{#pragma
7604 long_calls_off} directive.  Note these switches have no effect on how
7605 the compiler generates code to handle function calls via function
7606 pointers.
7608 @item -mnop-fun-dllimport
7609 @opindex mnop-fun-dllimport
7610 Disable support for the @code{dllimport} attribute.
7612 @item -msingle-pic-base
7613 @opindex msingle-pic-base
7614 Treat the register used for PIC addressing as read-only, rather than
7615 loading it in the prologue for each function.  The run-time system is
7616 responsible for initializing this register with an appropriate value
7617 before execution begins.
7619 @item -mpic-register=@var{reg}
7620 @opindex mpic-register
7621 Specify the register to be used for PIC addressing.  The default is R10
7622 unless stack-checking is enabled, when R9 is used.
7624 @item -mcirrus-fix-invalid-insns
7625 @opindex mcirrus-fix-invalid-insns
7626 @opindex mno-cirrus-fix-invalid-insns
7627 Insert NOPs into the instruction stream to in order to work around
7628 problems with invalid Maverick instruction combinations.  This option
7629 is only valid if the @option{-mcpu=ep9312} option has been used to
7630 enable generation of instructions for the Cirrus Maverick floating
7631 point co-processor.  This option is not enabled by default, since the
7632 problem is only present in older Maverick implementations.  The default
7633 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7634 switch.
7636 @item -mpoke-function-name
7637 @opindex mpoke-function-name
7638 Write the name of each function into the text section, directly
7639 preceding the function prologue.  The generated code is similar to this:
7641 @smallexample
7642      t0
7643          .ascii "arm_poke_function_name", 0
7644          .align
7645      t1
7646          .word 0xff000000 + (t1 - t0)
7647      arm_poke_function_name
7648          mov     ip, sp
7649          stmfd   sp!, @{fp, ip, lr, pc@}
7650          sub     fp, ip, #4
7651 @end smallexample
7653 When performing a stack backtrace, code can inspect the value of
7654 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7655 location @code{pc - 12} and the top 8 bits are set, then we know that
7656 there is a function name embedded immediately preceding this location
7657 and has length @code{((pc[-3]) & 0xff000000)}.
7659 @item -mthumb
7660 @opindex mthumb
7661 Generate code for the 16-bit Thumb instruction set.  The default is to
7662 use the 32-bit ARM instruction set.
7664 @item -mtpcs-frame
7665 @opindex mtpcs-frame
7666 Generate a stack frame that is compliant with the Thumb Procedure Call
7667 Standard for all non-leaf functions.  (A leaf function is one that does
7668 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7670 @item -mtpcs-leaf-frame
7671 @opindex mtpcs-leaf-frame
7672 Generate a stack frame that is compliant with the Thumb Procedure Call
7673 Standard for all leaf functions.  (A leaf function is one that does
7674 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7676 @item -mcallee-super-interworking
7677 @opindex mcallee-super-interworking
7678 Gives all externally visible functions in the file being compiled an ARM
7679 instruction set header which switches to Thumb mode before executing the
7680 rest of the function.  This allows these functions to be called from
7681 non-interworking code.
7683 @item -mcaller-super-interworking
7684 @opindex mcaller-super-interworking
7685 Allows calls via function pointers (including virtual functions) to
7686 execute correctly regardless of whether the target code has been
7687 compiled for interworking or not.  There is a small overhead in the cost
7688 of executing a function pointer if this option is enabled.
7690 @item -mtp=@var{name}
7691 @opindex mtp
7692 Specify the access model for the thread local storage pointer.  The valid
7693 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7694 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7695 (supported in the arm6k architecture), and @option{auto}, which uses the
7696 best available method for the selected processor.  The default setting is
7697 @option{auto}.
7699 @end table
7701 @node AVR Options
7702 @subsection AVR Options
7703 @cindex AVR Options
7705 These options are defined for AVR implementations:
7707 @table @gcctabopt
7708 @item -mmcu=@var{mcu}
7709 @opindex mmcu
7710 Specify ATMEL AVR instruction set or MCU type.
7712 Instruction set avr1 is for the minimal AVR core, not supported by the C
7713 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7714 attiny11, attiny12, attiny15, attiny28).
7716 Instruction set avr2 (default) is for the classic AVR core with up to
7717 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7718 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7719 at90c8534, at90s8535).
7721 Instruction set avr3 is for the classic AVR core with up to 128K program
7722 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7724 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7725 memory space (MCU types: atmega8, atmega83, atmega85).
7727 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7728 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7729 atmega64, atmega128, at43usb355, at94k).
7731 @item -msize
7732 @opindex msize
7733 Output instruction sizes to the asm file.
7735 @item -minit-stack=@var{N}
7736 @opindex minit-stack
7737 Specify the initial stack address, which may be a symbol or numeric value,
7738 @samp{__stack} is the default.
7740 @item -mno-interrupts
7741 @opindex mno-interrupts
7742 Generated code is not compatible with hardware interrupts.
7743 Code size will be smaller.
7745 @item -mcall-prologues
7746 @opindex mcall-prologues
7747 Functions prologues/epilogues expanded as call to appropriate
7748 subroutines.  Code size will be smaller.
7750 @item -mno-tablejump
7751 @opindex mno-tablejump
7752 Do not generate tablejump insns which sometimes increase code size.
7754 @item -mtiny-stack
7755 @opindex mtiny-stack
7756 Change only the low 8 bits of the stack pointer.
7758 @item -mint8
7759 @opindex mint8
7760 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7761 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7762 and long long will be 4 bytes.  Please note that this option does not
7763 comply to the C standards, but it will provide you with smaller code
7764 size.
7765 @end table
7767 @node Blackfin Options
7768 @subsection Blackfin Options
7769 @cindex Blackfin Options
7771 @table @gcctabopt
7772 @item -momit-leaf-frame-pointer
7773 @opindex momit-leaf-frame-pointer
7774 Don't keep the frame pointer in a register for leaf functions.  This
7775 avoids the instructions to save, set up and restore frame pointers and
7776 makes an extra register available in leaf functions.  The option
7777 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7778 which might make debugging harder.
7780 @item -mspecld-anomaly
7781 @opindex mspecld-anomaly
7782 When enabled, the compiler will ensure that the generated code does not
7783 contain speculative loads after jump instructions.  This option is enabled
7784 by default.
7786 @item -mno-specld-anomaly
7787 @opindex mno-specld-anomaly
7788 Don't generate extra code to prevent speculative loads from occurring.
7790 @item -mcsync-anomaly
7791 @opindex mcsync-anomaly
7792 When enabled, the compiler will ensure that the generated code does not
7793 contain CSYNC or SSYNC instructions too soon after conditional branches.
7794 This option is enabled by default.
7796 @item -mno-csync-anomaly
7797 @opindex mno-csync-anomaly
7798 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7799 occurring too soon after a conditional branch.
7801 @item -mlow-64k
7802 @opindex mlow-64k
7803 When enabled, the compiler is free to take advantage of the knowledge that
7804 the entire program fits into the low 64k of memory.
7806 @item -mno-low-64k
7807 @opindex mno-low-64k
7808 Assume that the program is arbitrarily large.  This is the default.
7810 @item -mid-shared-library
7811 @opindex mid-shared-library
7812 Generate code that supports shared libraries via the library ID method.
7813 This allows for execute in place and shared libraries in an environment
7814 without virtual memory management.  This option implies @option{-fPIC}.
7816 @item -mno-id-shared-library
7817 @opindex mno-id-shared-library
7818 Generate code that doesn't assume ID based shared libraries are being used.
7819 This is the default.
7821 @item -mshared-library-id=n
7822 @opindex mshared-library-id
7823 Specified the identification number of the ID based shared library being
7824 compiled.  Specifying a value of 0 will generate more compact code, specifying
7825 other values will force the allocation of that number to the current
7826 library but is no more space or time efficient than omitting this option.
7828 @item -mlong-calls
7829 @itemx -mno-long-calls
7830 @opindex mlong-calls
7831 @opindex mno-long-calls
7832 Tells the compiler to perform function calls by first loading the
7833 address of the function into a register and then performing a subroutine
7834 call on this register.  This switch is needed if the target function
7835 will lie outside of the 24 bit addressing range of the offset based
7836 version of subroutine call instruction.
7838 This feature is not enabled by default.  Specifying
7839 @option{-mno-long-calls} will restore the default behavior.  Note these
7840 switches have no effect on how the compiler generates code to handle
7841 function calls via function pointers.
7842 @end table
7844 @node CRIS Options
7845 @subsection CRIS Options
7846 @cindex CRIS Options
7848 These options are defined specifically for the CRIS ports.
7850 @table @gcctabopt
7851 @item -march=@var{architecture-type}
7852 @itemx -mcpu=@var{architecture-type}
7853 @opindex march
7854 @opindex mcpu
7855 Generate code for the specified architecture.  The choices for
7856 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7857 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7858 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7859 @samp{v10}.
7861 @item -mtune=@var{architecture-type}
7862 @opindex mtune
7863 Tune to @var{architecture-type} everything applicable about the generated
7864 code, except for the ABI and the set of available instructions.  The
7865 choices for @var{architecture-type} are the same as for
7866 @option{-march=@var{architecture-type}}.
7868 @item -mmax-stack-frame=@var{n}
7869 @opindex mmax-stack-frame
7870 Warn when the stack frame of a function exceeds @var{n} bytes.
7872 @item -melinux-stacksize=@var{n}
7873 @opindex melinux-stacksize
7874 Only available with the @samp{cris-axis-aout} target.  Arranges for
7875 indications in the program to the kernel loader that the stack of the
7876 program should be set to @var{n} bytes.
7878 @item -metrax4
7879 @itemx -metrax100
7880 @opindex metrax4
7881 @opindex metrax100
7882 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7883 @option{-march=v3} and @option{-march=v8} respectively.
7885 @item -mmul-bug-workaround
7886 @itemx -mno-mul-bug-workaround
7887 @opindex mmul-bug-workaround
7888 @opindex mno-mul-bug-workaround
7889 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7890 models where it applies.  This option is active by default.
7892 @item -mpdebug
7893 @opindex mpdebug
7894 Enable CRIS-specific verbose debug-related information in the assembly
7895 code.  This option also has the effect to turn off the @samp{#NO_APP}
7896 formatted-code indicator to the assembler at the beginning of the
7897 assembly file.
7899 @item -mcc-init
7900 @opindex mcc-init
7901 Do not use condition-code results from previous instruction; always emit
7902 compare and test instructions before use of condition codes.
7904 @item -mno-side-effects
7905 @opindex mno-side-effects
7906 Do not emit instructions with side-effects in addressing modes other than
7907 post-increment.
7909 @item -mstack-align
7910 @itemx -mno-stack-align
7911 @itemx -mdata-align
7912 @itemx -mno-data-align
7913 @itemx -mconst-align
7914 @itemx -mno-const-align
7915 @opindex mstack-align
7916 @opindex mno-stack-align
7917 @opindex mdata-align
7918 @opindex mno-data-align
7919 @opindex mconst-align
7920 @opindex mno-const-align
7921 These options (no-options) arranges (eliminate arrangements) for the
7922 stack-frame, individual data and constants to be aligned for the maximum
7923 single data access size for the chosen CPU model.  The default is to
7924 arrange for 32-bit alignment.  ABI details such as structure layout are
7925 not affected by these options.
7927 @item -m32-bit
7928 @itemx -m16-bit
7929 @itemx -m8-bit
7930 @opindex m32-bit
7931 @opindex m16-bit
7932 @opindex m8-bit
7933 Similar to the stack- data- and const-align options above, these options
7934 arrange for stack-frame, writable data and constants to all be 32-bit,
7935 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7937 @item -mno-prologue-epilogue
7938 @itemx -mprologue-epilogue
7939 @opindex mno-prologue-epilogue
7940 @opindex mprologue-epilogue
7941 With @option{-mno-prologue-epilogue}, the normal function prologue and
7942 epilogue that sets up the stack-frame are omitted and no return
7943 instructions or return sequences are generated in the code.  Use this
7944 option only together with visual inspection of the compiled code: no
7945 warnings or errors are generated when call-saved registers must be saved,
7946 or storage for local variable needs to be allocated.
7948 @item -mno-gotplt
7949 @itemx -mgotplt
7950 @opindex mno-gotplt
7951 @opindex mgotplt
7952 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7953 instruction sequences that load addresses for functions from the PLT part
7954 of the GOT rather than (traditional on other architectures) calls to the
7955 PLT@.  The default is @option{-mgotplt}.
7957 @item -maout
7958 @opindex maout
7959 Legacy no-op option only recognized with the cris-axis-aout target.
7961 @item -melf
7962 @opindex melf
7963 Legacy no-op option only recognized with the cris-axis-elf and
7964 cris-axis-linux-gnu targets.
7966 @item -melinux
7967 @opindex melinux
7968 Only recognized with the cris-axis-aout target, where it selects a
7969 GNU/linux-like multilib, include files and instruction set for
7970 @option{-march=v8}.
7972 @item -mlinux
7973 @opindex mlinux
7974 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7976 @item -sim
7977 @opindex sim
7978 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7979 to link with input-output functions from a simulator library.  Code,
7980 initialized data and zero-initialized data are allocated consecutively.
7982 @item -sim2
7983 @opindex sim2
7984 Like @option{-sim}, but pass linker options to locate initialized data at
7985 0x40000000 and zero-initialized data at 0x80000000.
7986 @end table
7988 @node CRX Options
7989 @subsection CRX Options
7990 @cindex CRX Options
7992 These options are defined specifically for the CRX ports.
7994 @table @gcctabopt
7996 @item -mmac
7997 @opindex mmac
7998 Enable the use of multiply-accumulate instructions. Disabled by default.
8000 @item -mpush-args
8001 @opindex mpush-args
8002 Push instructions will be used to pass outgoing arguments when functions
8003 are called. Enabled by default.
8004 @end table
8006 @node Darwin Options
8007 @subsection Darwin Options
8008 @cindex Darwin options
8010 These options are defined for all architectures running the Darwin operating
8011 system.
8013 FSF GCC on Darwin does not create ``fat'' object files; it will create
8014 an object file for the single architecture that it was built to
8015 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
8016 @option{-arch} options are used; it does so by running the compiler or
8017 linker multiple times and joining the results together with
8018 @file{lipo}.
8020 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
8021 @samp{i686}) is determined by the flags that specify the ISA
8022 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
8023 @option{-force_cpusubtype_ALL} option can be used to override this.
8025 The Darwin tools vary in their behavior when presented with an ISA
8026 mismatch.  The assembler, @file{as}, will only permit instructions to
8027 be used that are valid for the subtype of the file it is generating,
8028 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
8029 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
8030 and print an error if asked to create a shared library with a less
8031 restrictive subtype than its input files (for instance, trying to put
8032 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
8033 for executables, @file{ld}, will quietly give the executable the most
8034 restrictive subtype of any of its input files.
8036 @table @gcctabopt
8037 @item -F@var{dir}
8038 @opindex F
8039 Add the framework directory @var{dir} to the head of the list of
8040 directories to be searched for header files.  These directories are
8041 interleaved with those specified by @option{-I} options and are
8042 scanned in a left-to-right order.
8044 A framework directory is a directory with frameworks in it.  A
8045 framework is a directory with a @samp{"Headers"} and/or
8046 @samp{"PrivateHeaders"} directory contained directly in it that ends
8047 in @samp{".framework"}.  The name of a framework is the name of this
8048 directory excluding the @samp{".framework"}.  Headers associated with
8049 the framework are found in one of those two directories, with
8050 @samp{"Headers"} being searched first.  A subframework is a framework
8051 directory that is in a framework's @samp{"Frameworks"} directory.
8052 Includes of subframework headers can only appear in a header of a
8053 framework that contains the subframework, or in a sibling subframework
8054 header.  Two subframeworks are siblings if they occur in the same
8055 framework.  A subframework should not have the same name as a
8056 framework, a warning will be issued if this is violated.  Currently a
8057 subframework cannot have subframeworks, in the future, the mechanism
8058 may be extended to support this.  The standard frameworks can be found
8059 in @samp{"/System/Library/Frameworks"} and
8060 @samp{"/Library/Frameworks"}.  An example include looks like
8061 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
8062 the name of the framework and header.h is found in the
8063 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
8065 @item -gused
8066 @opindex -gused
8067 Emit debugging information for symbols that are used.  For STABS
8068 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
8069 This is by default ON@.
8071 @item -gfull
8072 @opindex -gfull
8073 Emit debugging information for all symbols and types.
8075 @item -mmacosx-version-min=@var{version}
8076 The earliest version of MacOS X that this executable will run on
8077 is @var{version}.  Typical values of @var{version} include @code{10.1},
8078 @code{10.2}, and @code{10.3.9}.
8080 The default for this option is to make choices that seem to be most
8081 useful.  
8083 @item -mkernel
8084 @opindex mkernel
8085 Enable kernel development mode.  The @option{-mkernel} option sets
8086 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
8087 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
8088 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
8089 applicable.  This mode also sets @option{-mno-altivec},
8090 @option{-msoft-float}, @option{-fno-builtin} and
8091 @option{-mlong-branch} for PowerPC targets.
8093 @item -mone-byte-bool
8094 @opindex -mone-byte-bool
8095 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
8096 By default @samp{sizeof(bool)} is @samp{4} when compiling for
8097 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
8098 option has no effect on x86.
8100 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
8101 to generate code that is not binary compatible with code generated
8102 without that switch.  Using this switch may require recompiling all
8103 other modules in a program, including system libraries.  Use this
8104 switch to conform to a non-default data model.
8106 @item -mfix-and-continue
8107 @itemx -ffix-and-continue
8108 @itemx -findirect-data
8109 @opindex mfix-and-continue
8110 @opindex ffix-and-continue
8111 @opindex findirect-data
8112 Generate code suitable for fast turn around development.  Needed to
8113 enable gdb to dynamically load @code{.o} files into already running
8114 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
8115 are provided for backwards compatibility.
8117 @item -all_load
8118 @opindex all_load
8119 Loads all members of static archive libraries.
8120 See man ld(1) for more information.
8122 @item -arch_errors_fatal
8123 @opindex arch_errors_fatal
8124 Cause the errors having to do with files that have the wrong architecture
8125 to be fatal.
8127 @item -bind_at_load
8128 @opindex bind_at_load
8129 Causes the output file to be marked such that the dynamic linker will
8130 bind all undefined references when the file is loaded or launched.
8132 @item -bundle
8133 @opindex bundle
8134 Produce a Mach-o bundle format file.
8135 See man ld(1) for more information.
8137 @item -bundle_loader @var{executable}
8138 @opindex bundle_loader
8139 This option specifies the @var{executable} that will be loading the build
8140 output file being linked.  See man ld(1) for more information.
8142 @item -dynamiclib
8143 @opindex -dynamiclib
8144 When passed this option, GCC will produce a dynamic library instead of
8145 an executable when linking, using the Darwin @file{libtool} command.
8147 @item -force_cpusubtype_ALL
8148 @opindex -force_cpusubtype_ALL
8149 This causes GCC's output file to have the @var{ALL} subtype, instead of
8150 one controlled by the @option{-mcpu} or @option{-march} option.
8152 @item -allowable_client  @var{client_name}
8153 @itemx -client_name
8154 @itemx -compatibility_version
8155 @itemx -current_version
8156 @itemx -dead_strip
8157 @itemx -dependency-file
8158 @itemx -dylib_file
8159 @itemx -dylinker_install_name
8160 @itemx -dynamic
8161 @itemx -exported_symbols_list
8162 @itemx -filelist
8163 @itemx -flat_namespace
8164 @itemx -force_flat_namespace
8165 @itemx -headerpad_max_install_names
8166 @itemx -image_base
8167 @itemx -init
8168 @itemx -install_name
8169 @itemx -keep_private_externs
8170 @itemx -multi_module
8171 @itemx -multiply_defined
8172 @itemx -multiply_defined_unused
8173 @itemx -noall_load
8174 @itemx -no_dead_strip_inits_and_terms
8175 @itemx -nofixprebinding
8176 @itemx -nomultidefs
8177 @itemx -noprebind
8178 @itemx -noseglinkedit
8179 @itemx -pagezero_size
8180 @itemx -prebind
8181 @itemx -prebind_all_twolevel_modules
8182 @itemx -private_bundle
8183 @itemx -read_only_relocs
8184 @itemx -sectalign
8185 @itemx -sectobjectsymbols
8186 @itemx -whyload
8187 @itemx -seg1addr
8188 @itemx -sectcreate
8189 @itemx -sectobjectsymbols
8190 @itemx -sectorder
8191 @itemx -segaddr
8192 @itemx -segs_read_only_addr
8193 @itemx -segs_read_write_addr
8194 @itemx -seg_addr_table
8195 @itemx -seg_addr_table_filename
8196 @itemx -seglinkedit
8197 @itemx -segprot
8198 @itemx -segs_read_only_addr
8199 @itemx -segs_read_write_addr
8200 @itemx -single_module
8201 @itemx -static
8202 @itemx -sub_library
8203 @itemx -sub_umbrella
8204 @itemx -twolevel_namespace
8205 @itemx -umbrella
8206 @itemx -undefined
8207 @itemx -unexported_symbols_list
8208 @itemx -weak_reference_mismatches
8209 @itemx -whatsloaded
8211 @opindex allowable_client
8212 @opindex client_name
8213 @opindex compatibility_version
8214 @opindex current_version
8215 @opindex dead_strip
8216 @opindex dependency-file
8217 @opindex dylib_file
8218 @opindex dylinker_install_name
8219 @opindex dynamic
8220 @opindex exported_symbols_list
8221 @opindex filelist
8222 @opindex flat_namespace
8223 @opindex force_flat_namespace
8224 @opindex headerpad_max_install_names
8225 @opindex image_base
8226 @opindex init
8227 @opindex install_name
8228 @opindex keep_private_externs
8229 @opindex multi_module
8230 @opindex multiply_defined
8231 @opindex multiply_defined_unused
8232 @opindex noall_load
8233 @opindex no_dead_strip_inits_and_terms
8234 @opindex nofixprebinding
8235 @opindex nomultidefs
8236 @opindex noprebind
8237 @opindex noseglinkedit
8238 @opindex pagezero_size
8239 @opindex prebind
8240 @opindex prebind_all_twolevel_modules
8241 @opindex private_bundle
8242 @opindex read_only_relocs
8243 @opindex sectalign
8244 @opindex sectobjectsymbols
8245 @opindex whyload
8246 @opindex seg1addr
8247 @opindex sectcreate
8248 @opindex sectobjectsymbols
8249 @opindex sectorder
8250 @opindex segaddr
8251 @opindex segs_read_only_addr
8252 @opindex segs_read_write_addr
8253 @opindex seg_addr_table
8254 @opindex seg_addr_table_filename
8255 @opindex seglinkedit
8256 @opindex segprot
8257 @opindex segs_read_only_addr
8258 @opindex segs_read_write_addr
8259 @opindex single_module
8260 @opindex static
8261 @opindex sub_library
8262 @opindex sub_umbrella
8263 @opindex twolevel_namespace
8264 @opindex umbrella
8265 @opindex undefined
8266 @opindex unexported_symbols_list
8267 @opindex weak_reference_mismatches
8268 @opindex whatsloaded
8270 These options are passed to the Darwin linker.  The Darwin linker man page
8271 describes them in detail.
8272 @end table
8274 @node DEC Alpha Options
8275 @subsection DEC Alpha Options
8277 These @samp{-m} options are defined for the DEC Alpha implementations:
8279 @table @gcctabopt
8280 @item -mno-soft-float
8281 @itemx -msoft-float
8282 @opindex mno-soft-float
8283 @opindex msoft-float
8284 Use (do not use) the hardware floating-point instructions for
8285 floating-point operations.  When @option{-msoft-float} is specified,
8286 functions in @file{libgcc.a} will be used to perform floating-point
8287 operations.  Unless they are replaced by routines that emulate the
8288 floating-point operations, or compiled in such a way as to call such
8289 emulations routines, these routines will issue floating-point
8290 operations.   If you are compiling for an Alpha without floating-point
8291 operations, you must ensure that the library is built so as not to call
8292 them.
8294 Note that Alpha implementations without floating-point operations are
8295 required to have floating-point registers.
8297 @item -mfp-reg
8298 @itemx -mno-fp-regs
8299 @opindex mfp-reg
8300 @opindex mno-fp-regs
8301 Generate code that uses (does not use) the floating-point register set.
8302 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8303 register set is not used, floating point operands are passed in integer
8304 registers as if they were integers and floating-point results are passed
8305 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8306 so any function with a floating-point argument or return value called by code
8307 compiled with @option{-mno-fp-regs} must also be compiled with that
8308 option.
8310 A typical use of this option is building a kernel that does not use,
8311 and hence need not save and restore, any floating-point registers.
8313 @item -mieee
8314 @opindex mieee
8315 The Alpha architecture implements floating-point hardware optimized for
8316 maximum performance.  It is mostly compliant with the IEEE floating
8317 point standard.  However, for full compliance, software assistance is
8318 required.  This option generates code fully IEEE compliant code
8319 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8320 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8321 defined during compilation.  The resulting code is less efficient but is
8322 able to correctly support denormalized numbers and exceptional IEEE
8323 values such as not-a-number and plus/minus infinity.  Other Alpha
8324 compilers call this option @option{-ieee_with_no_inexact}.
8326 @item -mieee-with-inexact
8327 @opindex mieee-with-inexact
8328 This is like @option{-mieee} except the generated code also maintains
8329 the IEEE @var{inexact-flag}.  Turning on this option causes the
8330 generated code to implement fully-compliant IEEE math.  In addition to
8331 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8332 macro.  On some Alpha implementations the resulting code may execute
8333 significantly slower than the code generated by default.  Since there is
8334 very little code that depends on the @var{inexact-flag}, you should
8335 normally not specify this option.  Other Alpha compilers call this
8336 option @option{-ieee_with_inexact}.
8338 @item -mfp-trap-mode=@var{trap-mode}
8339 @opindex mfp-trap-mode
8340 This option controls what floating-point related traps are enabled.
8341 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8342 The trap mode can be set to one of four values:
8344 @table @samp
8345 @item n
8346 This is the default (normal) setting.  The only traps that are enabled
8347 are the ones that cannot be disabled in software (e.g., division by zero
8348 trap).
8350 @item u
8351 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8352 as well.
8354 @item su
8355 Like @samp{su}, but the instructions are marked to be safe for software
8356 completion (see Alpha architecture manual for details).
8358 @item sui
8359 Like @samp{su}, but inexact traps are enabled as well.
8360 @end table
8362 @item -mfp-rounding-mode=@var{rounding-mode}
8363 @opindex mfp-rounding-mode
8364 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8365 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8368 @table @samp
8369 @item n
8370 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8371 the nearest machine number or towards the even machine number in case
8372 of a tie.
8374 @item m
8375 Round towards minus infinity.
8377 @item c
8378 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8380 @item d
8381 Dynamic rounding mode.  A field in the floating point control register
8382 (@var{fpcr}, see Alpha architecture reference manual) controls the
8383 rounding mode in effect.  The C library initializes this register for
8384 rounding towards plus infinity.  Thus, unless your program modifies the
8385 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8386 @end table
8388 @item -mtrap-precision=@var{trap-precision}
8389 @opindex mtrap-precision
8390 In the Alpha architecture, floating point traps are imprecise.  This
8391 means without software assistance it is impossible to recover from a
8392 floating trap and program execution normally needs to be terminated.
8393 GCC can generate code that can assist operating system trap handlers
8394 in determining the exact location that caused a floating point trap.
8395 Depending on the requirements of an application, different levels of
8396 precisions can be selected:
8398 @table @samp
8399 @item p
8400 Program precision.  This option is the default and means a trap handler
8401 can only identify which program caused a floating point exception.
8403 @item f
8404 Function precision.  The trap handler can determine the function that
8405 caused a floating point exception.
8407 @item i
8408 Instruction precision.  The trap handler can determine the exact
8409 instruction that caused a floating point exception.
8410 @end table
8412 Other Alpha compilers provide the equivalent options called
8413 @option{-scope_safe} and @option{-resumption_safe}.
8415 @item -mieee-conformant
8416 @opindex mieee-conformant
8417 This option marks the generated code as IEEE conformant.  You must not
8418 use this option unless you also specify @option{-mtrap-precision=i} and either
8419 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8420 is to emit the line @samp{.eflag 48} in the function prologue of the
8421 generated assembly file.  Under DEC Unix, this has the effect that
8422 IEEE-conformant math library routines will be linked in.
8424 @item -mbuild-constants
8425 @opindex mbuild-constants
8426 Normally GCC examines a 32- or 64-bit integer constant to
8427 see if it can construct it from smaller constants in two or three
8428 instructions.  If it cannot, it will output the constant as a literal and
8429 generate code to load it from the data segment at runtime.
8431 Use this option to require GCC to construct @emph{all} integer constants
8432 using code, even if it takes more instructions (the maximum is six).
8434 You would typically use this option to build a shared library dynamic
8435 loader.  Itself a shared library, it must relocate itself in memory
8436 before it can find the variables and constants in its own data segment.
8438 @item -malpha-as
8439 @itemx -mgas
8440 @opindex malpha-as
8441 @opindex mgas
8442 Select whether to generate code to be assembled by the vendor-supplied
8443 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8445 @item -mbwx
8446 @itemx -mno-bwx
8447 @itemx -mcix
8448 @itemx -mno-cix
8449 @itemx -mfix
8450 @itemx -mno-fix
8451 @itemx -mmax
8452 @itemx -mno-max
8453 @opindex mbwx
8454 @opindex mno-bwx
8455 @opindex mcix
8456 @opindex mno-cix
8457 @opindex mfix
8458 @opindex mno-fix
8459 @opindex mmax
8460 @opindex mno-max
8461 Indicate whether GCC should generate code to use the optional BWX,
8462 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8463 sets supported by the CPU type specified via @option{-mcpu=} option or that
8464 of the CPU on which GCC was built if none was specified.
8466 @item -mfloat-vax
8467 @itemx -mfloat-ieee
8468 @opindex mfloat-vax
8469 @opindex mfloat-ieee
8470 Generate code that uses (does not use) VAX F and G floating point
8471 arithmetic instead of IEEE single and double precision.
8473 @item -mexplicit-relocs
8474 @itemx -mno-explicit-relocs
8475 @opindex mexplicit-relocs
8476 @opindex mno-explicit-relocs
8477 Older Alpha assemblers provided no way to generate symbol relocations
8478 except via assembler macros.  Use of these macros does not allow
8479 optimal instruction scheduling.  GNU binutils as of version 2.12
8480 supports a new syntax that allows the compiler to explicitly mark
8481 which relocations should apply to which instructions.  This option
8482 is mostly useful for debugging, as GCC detects the capabilities of
8483 the assembler when it is built and sets the default accordingly.
8485 @item -msmall-data
8486 @itemx -mlarge-data
8487 @opindex msmall-data
8488 @opindex mlarge-data
8489 When @option{-mexplicit-relocs} is in effect, static data is
8490 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8491 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8492 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8493 16-bit relocations off of the @code{$gp} register.  This limits the
8494 size of the small data area to 64KB, but allows the variables to be
8495 directly accessed via a single instruction.
8497 The default is @option{-mlarge-data}.  With this option the data area
8498 is limited to just below 2GB@.  Programs that require more than 2GB of
8499 data must use @code{malloc} or @code{mmap} to allocate the data in the
8500 heap instead of in the program's data segment.
8502 When generating code for shared libraries, @option{-fpic} implies
8503 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8505 @item -msmall-text
8506 @itemx -mlarge-text
8507 @opindex msmall-text
8508 @opindex mlarge-text
8509 When @option{-msmall-text} is used, the compiler assumes that the
8510 code of the entire program (or shared library) fits in 4MB, and is
8511 thus reachable with a branch instruction.  When @option{-msmall-data}
8512 is used, the compiler can assume that all local symbols share the
8513 same @code{$gp} value, and thus reduce the number of instructions
8514 required for a function call from 4 to 1.
8516 The default is @option{-mlarge-text}.
8518 @item -mcpu=@var{cpu_type}
8519 @opindex mcpu
8520 Set the instruction set and instruction scheduling parameters for
8521 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8522 style name or the corresponding chip number.  GCC supports scheduling
8523 parameters for the EV4, EV5 and EV6 family of processors and will
8524 choose the default values for the instruction set from the processor
8525 you specify.  If you do not specify a processor type, GCC will default
8526 to the processor on which the compiler was built.
8528 Supported values for @var{cpu_type} are
8530 @table @samp
8531 @item ev4
8532 @itemx ev45
8533 @itemx 21064
8534 Schedules as an EV4 and has no instruction set extensions.
8536 @item ev5
8537 @itemx 21164
8538 Schedules as an EV5 and has no instruction set extensions.
8540 @item ev56
8541 @itemx 21164a
8542 Schedules as an EV5 and supports the BWX extension.
8544 @item pca56
8545 @itemx 21164pc
8546 @itemx 21164PC
8547 Schedules as an EV5 and supports the BWX and MAX extensions.
8549 @item ev6
8550 @itemx 21264
8551 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8553 @item ev67
8554 @itemx 21264a
8555 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8556 @end table
8558 @item -mtune=@var{cpu_type}
8559 @opindex mtune
8560 Set only the instruction scheduling parameters for machine type
8561 @var{cpu_type}.  The instruction set is not changed.
8563 @item -mmemory-latency=@var{time}
8564 @opindex mmemory-latency
8565 Sets the latency the scheduler should assume for typical memory
8566 references as seen by the application.  This number is highly
8567 dependent on the memory access patterns used by the application
8568 and the size of the external cache on the machine.
8570 Valid options for @var{time} are
8572 @table @samp
8573 @item @var{number}
8574 A decimal number representing clock cycles.
8576 @item L1
8577 @itemx L2
8578 @itemx L3
8579 @itemx main
8580 The compiler contains estimates of the number of clock cycles for
8581 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8582 (also called Dcache, Scache, and Bcache), as well as to main memory.
8583 Note that L3 is only valid for EV5.
8585 @end table
8586 @end table
8588 @node DEC Alpha/VMS Options
8589 @subsection DEC Alpha/VMS Options
8591 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8593 @table @gcctabopt
8594 @item -mvms-return-codes
8595 @opindex mvms-return-codes
8596 Return VMS condition codes from main.  The default is to return POSIX
8597 style condition (e.g.@ error) codes.
8598 @end table
8600 @node FRV Options
8601 @subsection FRV Options
8602 @cindex FRV Options
8604 @table @gcctabopt
8605 @item -mgpr-32
8606 @opindex mgpr-32
8608 Only use the first 32 general purpose registers.
8610 @item -mgpr-64
8611 @opindex mgpr-64
8613 Use all 64 general purpose registers.
8615 @item -mfpr-32
8616 @opindex mfpr-32
8618 Use only the first 32 floating point registers.
8620 @item -mfpr-64
8621 @opindex mfpr-64
8623 Use all 64 floating point registers
8625 @item -mhard-float
8626 @opindex mhard-float
8628 Use hardware instructions for floating point operations.
8630 @item -msoft-float
8631 @opindex msoft-float
8633 Use library routines for floating point operations.
8635 @item -malloc-cc
8636 @opindex malloc-cc
8638 Dynamically allocate condition code registers.
8640 @item -mfixed-cc
8641 @opindex mfixed-cc
8643 Do not try to dynamically allocate condition code registers, only
8644 use @code{icc0} and @code{fcc0}.
8646 @item -mdword
8647 @opindex mdword
8649 Change ABI to use double word insns.
8651 @item -mno-dword
8652 @opindex mno-dword
8654 Do not use double word instructions.
8656 @item -mdouble
8657 @opindex mdouble
8659 Use floating point double instructions.
8661 @item -mno-double
8662 @opindex mno-double
8664 Do not use floating point double instructions.
8666 @item -mmedia
8667 @opindex mmedia
8669 Use media instructions.
8671 @item -mno-media
8672 @opindex mno-media
8674 Do not use media instructions.
8676 @item -mmuladd
8677 @opindex mmuladd
8679 Use multiply and add/subtract instructions.
8681 @item -mno-muladd
8682 @opindex mno-muladd
8684 Do not use multiply and add/subtract instructions.
8686 @item -mfdpic
8687 @opindex mfdpic
8689 Select the FDPIC ABI, that uses function descriptors to represent
8690 pointers to functions.  Without any PIC/PIE-related options, it
8691 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8692 assumes GOT entries and small data are within a 12-bit range from the
8693 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8694 are computed with 32 bits.
8696 @item -minline-plt
8697 @opindex minline-plt
8699 Enable inlining of PLT entries in function calls to functions that are
8700 not known to bind locally.  It has no effect without @option{-mfdpic}.
8701 It's enabled by default if optimizing for speed and compiling for
8702 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8703 optimization option such as @option{-O3} or above is present in the
8704 command line.
8706 @item -mTLS
8707 @opindex TLS
8709 Assume a large TLS segment when generating thread-local code.
8711 @item -mtls
8712 @opindex tls
8714 Do not assume a large TLS segment when generating thread-local code.
8716 @item -mgprel-ro
8717 @opindex mgprel-ro
8719 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8720 that is known to be in read-only sections.  It's enabled by default,
8721 except for @option{-fpic} or @option{-fpie}: even though it may help
8722 make the global offset table smaller, it trades 1 instruction for 4.
8723 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8724 one of which may be shared by multiple symbols, and it avoids the need
8725 for a GOT entry for the referenced symbol, so it's more likely to be a
8726 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8728 @item -multilib-library-pic
8729 @opindex multilib-library-pic
8731 Link with the (library, not FD) pic libraries.  It's implied by
8732 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8733 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8734 it explicitly.
8736 @item -mlinked-fp
8737 @opindex mlinked-fp
8739 Follow the EABI requirement of always creating a frame pointer whenever
8740 a stack frame is allocated.  This option is enabled by default and can
8741 be disabled with @option{-mno-linked-fp}.
8743 @item -mlong-calls
8744 @opindex mlong-calls
8746 Use indirect addressing to call functions outside the current
8747 compilation unit.  This allows the functions to be placed anywhere
8748 within the 32-bit address space.
8750 @item -malign-labels
8751 @opindex malign-labels
8753 Try to align labels to an 8-byte boundary by inserting nops into the
8754 previous packet.  This option only has an effect when VLIW packing
8755 is enabled.  It doesn't create new packets; it merely adds nops to
8756 existing ones.
8758 @item -mlibrary-pic
8759 @opindex mlibrary-pic
8761 Generate position-independent EABI code.
8763 @item -macc-4
8764 @opindex macc-4
8766 Use only the first four media accumulator registers.
8768 @item -macc-8
8769 @opindex macc-8
8771 Use all eight media accumulator registers.
8773 @item -mpack
8774 @opindex mpack
8776 Pack VLIW instructions.
8778 @item -mno-pack
8779 @opindex mno-pack
8781 Do not pack VLIW instructions.
8783 @item -mno-eflags
8784 @opindex mno-eflags
8786 Do not mark ABI switches in e_flags.
8788 @item -mcond-move
8789 @opindex mcond-move
8791 Enable the use of conditional-move instructions (default).
8793 This switch is mainly for debugging the compiler and will likely be removed
8794 in a future version.
8796 @item -mno-cond-move
8797 @opindex mno-cond-move
8799 Disable the use of conditional-move instructions.
8801 This switch is mainly for debugging the compiler and will likely be removed
8802 in a future version.
8804 @item -mscc
8805 @opindex mscc
8807 Enable the use of conditional set instructions (default).
8809 This switch is mainly for debugging the compiler and will likely be removed
8810 in a future version.
8812 @item -mno-scc
8813 @opindex mno-scc
8815 Disable the use of conditional set instructions.
8817 This switch is mainly for debugging the compiler and will likely be removed
8818 in a future version.
8820 @item -mcond-exec
8821 @opindex mcond-exec
8823 Enable the use of conditional execution (default).
8825 This switch is mainly for debugging the compiler and will likely be removed
8826 in a future version.
8828 @item -mno-cond-exec
8829 @opindex mno-cond-exec
8831 Disable the use of conditional execution.
8833 This switch is mainly for debugging the compiler and will likely be removed
8834 in a future version.
8836 @item -mvliw-branch
8837 @opindex mvliw-branch
8839 Run a pass to pack branches into VLIW instructions (default).
8841 This switch is mainly for debugging the compiler and will likely be removed
8842 in a future version.
8844 @item -mno-vliw-branch
8845 @opindex mno-vliw-branch
8847 Do not run a pass to pack branches into VLIW instructions.
8849 This switch is mainly for debugging the compiler and will likely be removed
8850 in a future version.
8852 @item -mmulti-cond-exec
8853 @opindex mmulti-cond-exec
8855 Enable optimization of @code{&&} and @code{||} in conditional execution
8856 (default).
8858 This switch is mainly for debugging the compiler and will likely be removed
8859 in a future version.
8861 @item -mno-multi-cond-exec
8862 @opindex mno-multi-cond-exec
8864 Disable optimization of @code{&&} and @code{||} in conditional execution.
8866 This switch is mainly for debugging the compiler and will likely be removed
8867 in a future version.
8869 @item -mnested-cond-exec
8870 @opindex mnested-cond-exec
8872 Enable nested conditional execution optimizations (default).
8874 This switch is mainly for debugging the compiler and will likely be removed
8875 in a future version.
8877 @item -mno-nested-cond-exec
8878 @opindex mno-nested-cond-exec
8880 Disable nested conditional execution optimizations.
8882 This switch is mainly for debugging the compiler and will likely be removed
8883 in a future version.
8885 @item -moptimize-membar
8886 @opindex moptimize-membar
8888 This switch removes redundant @code{membar} instructions from the
8889 compiler generated code.  It is enabled by default.
8891 @item -mno-optimize-membar
8892 @opindex mno-optimize-membar
8894 This switch disables the automatic removal of redundant @code{membar}
8895 instructions from the generated code.
8897 @item -mtomcat-stats
8898 @opindex mtomcat-stats
8900 Cause gas to print out tomcat statistics.
8902 @item -mcpu=@var{cpu}
8903 @opindex mcpu
8905 Select the processor type for which to generate code.  Possible values are
8906 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8907 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8909 @end table
8911 @node GNU/Linux Options
8912 @subsection GNU/Linux Options
8914 These @samp{-m} options are defined for GNU/Linux targets:
8916 @table @gcctabopt
8917 @item -mglibc
8918 @opindex mglibc
8919 Use the GNU C library instead of uClibc.  This is the default except
8920 on @samp{*-*-linux-*uclibc*} targets.
8922 @item -muclibc
8923 @opindex muclibc
8924 Use uClibc instead of the GNU C library.  This is the default on
8925 @samp{*-*-linux-*uclibc*} targets.
8926 @end table
8928 @node H8/300 Options
8929 @subsection H8/300 Options
8931 These @samp{-m} options are defined for the H8/300 implementations:
8933 @table @gcctabopt
8934 @item -mrelax
8935 @opindex mrelax
8936 Shorten some address references at link time, when possible; uses the
8937 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8938 ld, Using ld}, for a fuller description.
8940 @item -mh
8941 @opindex mh
8942 Generate code for the H8/300H@.
8944 @item -ms
8945 @opindex ms
8946 Generate code for the H8S@.
8948 @item -mn
8949 @opindex mn
8950 Generate code for the H8S and H8/300H in the normal mode.  This switch
8951 must be used either with @option{-mh} or @option{-ms}.
8953 @item -ms2600
8954 @opindex ms2600
8955 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8957 @item -mint32
8958 @opindex mint32
8959 Make @code{int} data 32 bits by default.
8961 @item -malign-300
8962 @opindex malign-300
8963 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8964 The default for the H8/300H and H8S is to align longs and floats on 4
8965 byte boundaries.
8966 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8967 This option has no effect on the H8/300.
8968 @end table
8970 @node HPPA Options
8971 @subsection HPPA Options
8972 @cindex HPPA Options
8974 These @samp{-m} options are defined for the HPPA family of computers:
8976 @table @gcctabopt
8977 @item -march=@var{architecture-type}
8978 @opindex march
8979 Generate code for the specified architecture.  The choices for
8980 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8981 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8982 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8983 architecture option for your machine.  Code compiled for lower numbered
8984 architectures will run on higher numbered architectures, but not the
8985 other way around.
8987 @item -mpa-risc-1-0
8988 @itemx -mpa-risc-1-1
8989 @itemx -mpa-risc-2-0
8990 @opindex mpa-risc-1-0
8991 @opindex mpa-risc-1-1
8992 @opindex mpa-risc-2-0
8993 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8995 @item -mbig-switch
8996 @opindex mbig-switch
8997 Generate code suitable for big switch tables.  Use this option only if
8998 the assembler/linker complain about out of range branches within a switch
8999 table.
9001 @item -mjump-in-delay
9002 @opindex mjump-in-delay
9003 Fill delay slots of function calls with unconditional jump instructions
9004 by modifying the return pointer for the function call to be the target
9005 of the conditional jump.
9007 @item -mdisable-fpregs
9008 @opindex mdisable-fpregs
9009 Prevent floating point registers from being used in any manner.  This is
9010 necessary for compiling kernels which perform lazy context switching of
9011 floating point registers.  If you use this option and attempt to perform
9012 floating point operations, the compiler will abort.
9014 @item -mdisable-indexing
9015 @opindex mdisable-indexing
9016 Prevent the compiler from using indexing address modes.  This avoids some
9017 rather obscure problems when compiling MIG generated code under MACH@.
9019 @item -mno-space-regs
9020 @opindex mno-space-regs
9021 Generate code that assumes the target has no space registers.  This allows
9022 GCC to generate faster indirect calls and use unscaled index address modes.
9024 Such code is suitable for level 0 PA systems and kernels.
9026 @item -mfast-indirect-calls
9027 @opindex mfast-indirect-calls
9028 Generate code that assumes calls never cross space boundaries.  This
9029 allows GCC to emit code which performs faster indirect calls.
9031 This option will not work in the presence of shared libraries or nested
9032 functions.
9034 @item -mfixed-range=@var{register-range}
9035 @opindex mfixed-range
9036 Generate code treating the given register range as fixed registers.
9037 A fixed register is one that the register allocator can not use.  This is
9038 useful when compiling kernel code.  A register range is specified as
9039 two registers separated by a dash.  Multiple register ranges can be
9040 specified separated by a comma.
9042 @item -mlong-load-store
9043 @opindex mlong-load-store
9044 Generate 3-instruction load and store sequences as sometimes required by
9045 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
9046 the HP compilers.
9048 @item -mportable-runtime
9049 @opindex mportable-runtime
9050 Use the portable calling conventions proposed by HP for ELF systems.
9052 @item -mgas
9053 @opindex mgas
9054 Enable the use of assembler directives only GAS understands.
9056 @item -mschedule=@var{cpu-type}
9057 @opindex mschedule
9058 Schedule code according to the constraints for the machine type
9059 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
9060 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
9061 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
9062 proper scheduling option for your machine.  The default scheduling is
9063 @samp{8000}.
9065 @item -mlinker-opt
9066 @opindex mlinker-opt
9067 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
9068 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
9069 linkers in which they give bogus error messages when linking some programs.
9071 @item -msoft-float
9072 @opindex msoft-float
9073 Generate output containing library calls for floating point.
9074 @strong{Warning:} the requisite libraries are not available for all HPPA
9075 targets.  Normally the facilities of the machine's usual C compiler are
9076 used, but this cannot be done directly in cross-compilation.  You must make
9077 your own arrangements to provide suitable library functions for
9078 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
9079 does provide software floating point support.
9081 @option{-msoft-float} changes the calling convention in the output file;
9082 therefore, it is only useful if you compile @emph{all} of a program with
9083 this option.  In particular, you need to compile @file{libgcc.a}, the
9084 library that comes with GCC, with @option{-msoft-float} in order for
9085 this to work.
9087 @item -msio
9088 @opindex msio
9089 Generate the predefine, @code{_SIO}, for server IO@.  The default is
9090 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
9091 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
9092 options are available under HP-UX and HI-UX@.
9094 @item -mgnu-ld
9095 @opindex gnu-ld
9096 Use GNU ld specific options.  This passes @option{-shared} to ld when
9097 building a shared library.  It is the default when GCC is configured,
9098 explicitly or implicitly, with the GNU linker.  This option does not
9099 have any affect on which ld is called, it only changes what parameters
9100 are passed to that ld.  The ld that is called is determined by the
9101 @option{--with-ld} configure option, GCC's program search path, and
9102 finally by the user's @env{PATH}.  The linker used by GCC can be printed
9103 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
9104 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9106 @item -mhp-ld
9107 @opindex hp-ld
9108 Use HP ld specific options.  This passes @option{-b} to ld when building
9109 a shared library and passes @option{+Accept TypeMismatch} to ld on all
9110 links.  It is the default when GCC is configured, explicitly or
9111 implicitly, with the HP linker.  This option does not have any affect on
9112 which ld is called, it only changes what parameters are passed to that
9113 ld.  The ld that is called is determined by the @option{--with-ld}
9114 configure option, GCC's program search path, and finally by the user's
9115 @env{PATH}.  The linker used by GCC can be printed using @samp{which
9116 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
9117 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9119 @item -mlong-calls
9120 @opindex mno-long-calls
9121 Generate code that uses long call sequences.  This ensures that a call
9122 is always able to reach linker generated stubs.  The default is to generate
9123 long calls only when the distance from the call site to the beginning
9124 of the function or translation unit, as the case may be, exceeds a
9125 predefined limit set by the branch type being used.  The limits for
9126 normal calls are 7,600,000 and 240,000 bytes, respectively for the
9127 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
9128 240,000 bytes.
9130 Distances are measured from the beginning of functions when using the
9131 @option{-ffunction-sections} option, or when using the @option{-mgas}
9132 and @option{-mno-portable-runtime} options together under HP-UX with
9133 the SOM linker.
9135 It is normally not desirable to use this option as it will degrade
9136 performance.  However, it may be useful in large applications,
9137 particularly when partial linking is used to build the application.
9139 The types of long calls used depends on the capabilities of the
9140 assembler and linker, and the type of code being generated.  The
9141 impact on systems that support long absolute calls, and long pic
9142 symbol-difference or pc-relative calls should be relatively small.
9143 However, an indirect call is used on 32-bit ELF systems in pic code
9144 and it is quite long.
9146 @item -munix=@var{unix-std}
9147 @opindex march
9148 Generate compiler predefines and select a startfile for the specified
9149 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
9150 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
9151 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
9152 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
9153 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9154 and later.
9156 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9157 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9158 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9159 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9160 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9161 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9163 It is @emph{important} to note that this option changes the interfaces
9164 for various library routines.  It also affects the operational behavior
9165 of the C library.  Thus, @emph{extreme} care is needed in using this
9166 option.
9168 Library code that is intended to operate with more than one UNIX
9169 standard must test, set and restore the variable @var{__xpg4_extended_mask}
9170 as appropriate.  Most GNU software doesn't provide this capability.
9172 @item -nolibdld
9173 @opindex nolibdld
9174 Suppress the generation of link options to search libdld.sl when the
9175 @option{-static} option is specified on HP-UX 10 and later.
9177 @item -static
9178 @opindex static
9179 The HP-UX implementation of setlocale in libc has a dependency on
9180 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
9181 when the @option{-static} option is specified, special link options
9182 are needed to resolve this dependency.
9184 On HP-UX 10 and later, the GCC driver adds the necessary options to
9185 link with libdld.sl when the @option{-static} option is specified.
9186 This causes the resulting binary to be dynamic.  On the 64-bit port,
9187 the linkers generate dynamic binaries by default in any case.  The
9188 @option{-nolibdld} option can be used to prevent the GCC driver from
9189 adding these link options.
9191 @item -threads
9192 @opindex threads
9193 Add support for multithreading with the @dfn{dce thread} library
9194 under HP-UX@.  This option sets flags for both the preprocessor and
9195 linker.
9196 @end table
9198 @node i386 and x86-64 Options
9199 @subsection Intel 386 and AMD x86-64 Options
9200 @cindex i386 Options
9201 @cindex x86-64 Options
9202 @cindex Intel 386 Options
9203 @cindex AMD x86-64 Options
9205 These @samp{-m} options are defined for the i386 and x86-64 family of
9206 computers:
9208 @table @gcctabopt
9209 @item -mtune=@var{cpu-type}
9210 @opindex mtune
9211 Tune to @var{cpu-type} everything applicable about the generated code, except
9212 for the ABI and the set of available instructions.  The choices for
9213 @var{cpu-type} are:
9214 @table @emph
9215 @item generic
9216 Produce code optimized for the most common IA32/AMD64/EM64T processors.
9217 If you know the CPU on which your code will run, then you should use
9218 the corresponding @option{-mtune} option instead of
9219 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
9220 of your application will have, then you should use this option.
9222 As new processors are deployed in the marketplace, the behavior of this
9223 option will change.  Therefore, if you upgrade to a newer version of
9224 GCC, the code generated option will change to reflect the processors
9225 that were most common when that version of GCC was released.
9227 There is no @option{-march=generic} option because @option{-march}
9228 indicates the instruction set the compiler can use, and there is no
9229 generic instruction set applicable to all processors.  In contrast,
9230 @option{-mtune} indicates the processor (or, in this case, collection of
9231 processors) for which the code is optimized.
9232 @item native
9233 This selects the CPU to tune for at compilation time by determining
9234 the processor type of the compiling machine.  Using @option{-mtune=native}
9235 will produce code optimized for the local machine under the constraints
9236 of the selected instruction set.  Using @option{-march=native} will
9237 enable all instruction subsets supported by the local machine (hence
9238 the result might not run on different machines).
9239 @item i386
9240 Original Intel's i386 CPU@.
9241 @item i486
9242 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
9243 @item i586, pentium
9244 Intel Pentium CPU with no MMX support.
9245 @item pentium-mmx
9246 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9247 @item pentiumpro
9248 Intel PentiumPro CPU@.
9249 @item i686
9250 Same as @code{generic}, but when used as @code{march} option, PentiumPro
9251 instruction set will be used, so the code will run on all i686 family chips.
9252 @item pentium2
9253 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9254 @item pentium3, pentium3m
9255 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9256 support.
9257 @item pentium-m
9258 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9259 support.  Used by Centrino notebooks.
9260 @item pentium4, pentium4m
9261 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9262 @item prescott
9263 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9264 set support.
9265 @item nocona
9266 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9267 SSE2 and SSE3 instruction set support.
9268 @item k6
9269 AMD K6 CPU with MMX instruction set support.
9270 @item k6-2, k6-3
9271 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9272 @item athlon, athlon-tbird
9273 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9274 support.
9275 @item athlon-4, athlon-xp, athlon-mp
9276 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9277 instruction set support.
9278 @item k8, opteron, athlon64, athlon-fx
9279 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9280 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9281 @item winchip-c6
9282 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9283 set support.
9284 @item winchip2
9285 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9286 instruction set support.
9287 @item c3
9288 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9289 implemented for this chip.)
9290 @item c3-2
9291 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9292 implemented for this chip.)
9293 @item geode
9294 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
9295 @end table
9297 While picking a specific @var{cpu-type} will schedule things appropriately
9298 for that particular chip, the compiler will not generate any code that
9299 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9300 being used.
9302 @item -march=@var{cpu-type}
9303 @opindex march
9304 Generate instructions for the machine type @var{cpu-type}.  The choices
9305 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9306 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9308 @item -mcpu=@var{cpu-type}
9309 @opindex mcpu
9310 A deprecated synonym for @option{-mtune}.
9312 @item -m386
9313 @itemx -m486
9314 @itemx -mpentium
9315 @itemx -mpentiumpro
9316 @opindex m386
9317 @opindex m486
9318 @opindex mpentium
9319 @opindex mpentiumpro
9320 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9321 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9322 These synonyms are deprecated.
9324 @item -mfpmath=@var{unit}
9325 @opindex march
9326 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9327 for @var{unit} are:
9329 @table @samp
9330 @item 387
9331 Use the standard 387 floating point coprocessor present majority of chips and
9332 emulated otherwise.  Code compiled with this option will run almost everywhere.
9333 The temporary results are computed in 80bit precision instead of precision
9334 specified by the type resulting in slightly different results compared to most
9335 of other chips.  See @option{-ffloat-store} for more detailed description.
9337 This is the default choice for i386 compiler.
9339 @item sse
9340 Use scalar floating point instructions present in the SSE instruction set.
9341 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9342 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9343 instruction set supports only single precision arithmetics, thus the double and
9344 extended precision arithmetics is still done using 387.  Later version, present
9345 only in Pentium4 and the future AMD x86-64 chips supports double precision
9346 arithmetics too.
9348 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9349 or @option{-msse2} switches to enable SSE extensions and make this option
9350 effective.  For the x86-64 compiler, these extensions are enabled by default.
9352 The resulting code should be considerably faster in the majority of cases and avoid
9353 the numerical instability problems of 387 code, but may break some existing
9354 code that expects temporaries to be 80bit.
9356 This is the default choice for the x86-64 compiler.
9358 @item sse,387
9359 Attempt to utilize both instruction sets at once.  This effectively double the
9360 amount of available registers and on chips with separate execution units for
9361 387 and SSE the execution resources too.  Use this option with care, as it is
9362 still experimental, because the GCC register allocator does not model separate
9363 functional units well resulting in instable performance.
9364 @end table
9366 @item -masm=@var{dialect}
9367 @opindex masm=@var{dialect}
9368 Output asm instructions using selected @var{dialect}.  Supported
9369 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9370 not support @samp{intel}.
9372 @item -mieee-fp
9373 @itemx -mno-ieee-fp
9374 @opindex mieee-fp
9375 @opindex mno-ieee-fp
9376 Control whether or not the compiler uses IEEE floating point
9377 comparisons.  These handle correctly the case where the result of a
9378 comparison is unordered.
9380 @item -msoft-float
9381 @opindex msoft-float
9382 Generate output containing library calls for floating point.
9383 @strong{Warning:} the requisite libraries are not part of GCC@.
9384 Normally the facilities of the machine's usual C compiler are used, but
9385 this can't be done directly in cross-compilation.  You must make your
9386 own arrangements to provide suitable library functions for
9387 cross-compilation.
9389 On machines where a function returns floating point results in the 80387
9390 register stack, some floating point opcodes may be emitted even if
9391 @option{-msoft-float} is used.
9393 @item -mno-fp-ret-in-387
9394 @opindex mno-fp-ret-in-387
9395 Do not use the FPU registers for return values of functions.
9397 The usual calling convention has functions return values of types
9398 @code{float} and @code{double} in an FPU register, even if there
9399 is no FPU@.  The idea is that the operating system should emulate
9400 an FPU@.
9402 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9403 in ordinary CPU registers instead.
9405 @item -mno-fancy-math-387
9406 @opindex mno-fancy-math-387
9407 Some 387 emulators do not support the @code{sin}, @code{cos} and
9408 @code{sqrt} instructions for the 387.  Specify this option to avoid
9409 generating those instructions.  This option is the default on FreeBSD,
9410 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9411 indicates that the target cpu will always have an FPU and so the
9412 instruction will not need emulation.  As of revision 2.6.1, these
9413 instructions are not generated unless you also use the
9414 @option{-funsafe-math-optimizations} switch.
9416 @item -malign-double
9417 @itemx -mno-align-double
9418 @opindex malign-double
9419 @opindex mno-align-double
9420 Control whether GCC aligns @code{double}, @code{long double}, and
9421 @code{long long} variables on a two word boundary or a one word
9422 boundary.  Aligning @code{double} variables on a two word boundary will
9423 produce code that runs somewhat faster on a @samp{Pentium} at the
9424 expense of more memory.
9426 On x86-64, @option{-malign-double} is enabled by default.
9428 @strong{Warning:} if you use the @option{-malign-double} switch,
9429 structures containing the above types will be aligned differently than
9430 the published application binary interface specifications for the 386
9431 and will not be binary compatible with structures in code compiled
9432 without that switch.
9434 @item -m96bit-long-double
9435 @itemx -m128bit-long-double
9436 @opindex m96bit-long-double
9437 @opindex m128bit-long-double
9438 These switches control the size of @code{long double} type.  The i386
9439 application binary interface specifies the size to be 96 bits,
9440 so @option{-m96bit-long-double} is the default in 32 bit mode.
9442 Modern architectures (Pentium and newer) would prefer @code{long double}
9443 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9444 conforming to the ABI, this would not be possible.  So specifying a
9445 @option{-m128bit-long-double} will align @code{long double}
9446 to a 16 byte boundary by padding the @code{long double} with an additional
9447 32 bit zero.
9449 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9450 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9452 Notice that neither of these options enable any extra precision over the x87
9453 standard of 80 bits for a @code{long double}.
9455 @strong{Warning:} if you override the default value for your target ABI, the
9456 structures and arrays containing @code{long double} variables will change
9457 their size as well as function calling convention for function taking
9458 @code{long double} will be modified.  Hence they will not be binary
9459 compatible with arrays or structures in code compiled without that switch.
9461 @item -mmlarge-data-threshold=@var{number}
9462 @opindex mlarge-data-threshold=@var{number}
9463 When @option{-mcmodel=medium} is specified, the data greater than
9464 @var{threshold} are placed in large data section.  This value must be the
9465 same across all object linked into the binary and defaults to 65535.
9467 @item -msvr3-shlib
9468 @itemx -mno-svr3-shlib
9469 @opindex msvr3-shlib
9470 @opindex mno-svr3-shlib
9471 Control whether GCC places uninitialized local variables into the
9472 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9473 into @code{bss}.  These options are meaningful only on System V Release 3.
9475 @item -mrtd
9476 @opindex mrtd
9477 Use a different function-calling convention, in which functions that
9478 take a fixed number of arguments return with the @code{ret} @var{num}
9479 instruction, which pops their arguments while returning.  This saves one
9480 instruction in the caller since there is no need to pop the arguments
9481 there.
9483 You can specify that an individual function is called with this calling
9484 sequence with the function attribute @samp{stdcall}.  You can also
9485 override the @option{-mrtd} option by using the function attribute
9486 @samp{cdecl}.  @xref{Function Attributes}.
9488 @strong{Warning:} this calling convention is incompatible with the one
9489 normally used on Unix, so you cannot use it if you need to call
9490 libraries compiled with the Unix compiler.
9492 Also, you must provide function prototypes for all functions that
9493 take variable numbers of arguments (including @code{printf});
9494 otherwise incorrect code will be generated for calls to those
9495 functions.
9497 In addition, seriously incorrect code will result if you call a
9498 function with too many arguments.  (Normally, extra arguments are
9499 harmlessly ignored.)
9501 @item -mregparm=@var{num}
9502 @opindex mregparm
9503 Control how many registers are used to pass integer arguments.  By
9504 default, no registers are used to pass arguments, and at most 3
9505 registers can be used.  You can control this behavior for a specific
9506 function by using the function attribute @samp{regparm}.
9507 @xref{Function Attributes}.
9509 @strong{Warning:} if you use this switch, and
9510 @var{num} is nonzero, then you must build all modules with the same
9511 value, including any libraries.  This includes the system libraries and
9512 startup modules.
9514 @item -msseregparm
9515 @opindex msseregparm
9516 Use SSE register passing conventions for float and double arguments
9517 and return values.  You can control this behavior for a specific
9518 function by using the function attribute @samp{sseregparm}.
9519 @xref{Function Attributes}.
9521 @strong{Warning:} if you use this switch then you must build all
9522 modules with the same value, including any libraries.  This includes
9523 the system libraries and startup modules.
9525 @item -mstackrealign
9526 @opindex mstackrealign
9527 Realign the stack at entry.  On the Intel x86, the
9528 @option{-mstackrealign} option will generate an alternate prologue and
9529 epilogue that realigns the runtime stack.  This supports mixing legacy
9530 codes that keep a 4-byte aligned stack with modern codes that keep a
9531 16-byte stack for SSE compatibility.  The alternate prologue and
9532 epilogue are slower and bigger than the regular ones, and the
9533 alternate prologue requires an extra scratch register; this lowers the
9534 number of registers available if used in conjunction with the
9535 @code{regparm} attribute.  The @option{-mstackrealign} option is
9536 incompatible with the nested function prologue; this is considered a
9537 hard error.  See also the attribute @code{force_align_arg_pointer},
9538 applicable to individual functions.
9540 @item -mpreferred-stack-boundary=@var{num}
9541 @opindex mpreferred-stack-boundary
9542 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9543 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9544 the default is 4 (16 bytes or 128 bits).
9546 On Pentium and PentiumPro, @code{double} and @code{long double} values
9547 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9548 suffer significant run time performance penalties.  On Pentium III, the
9549 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
9550 properly if it is not 16 byte aligned.
9552 To ensure proper alignment of this values on the stack, the stack boundary
9553 must be as aligned as that required by any value stored on the stack.
9554 Further, every function must be generated such that it keeps the stack
9555 aligned.  Thus calling a function compiled with a higher preferred
9556 stack boundary from a function compiled with a lower preferred stack
9557 boundary will most likely misalign the stack.  It is recommended that
9558 libraries that use callbacks always use the default setting.
9560 This extra alignment does consume extra stack space, and generally
9561 increases code size.  Code that is sensitive to stack space usage, such
9562 as embedded systems and operating system kernels, may want to reduce the
9563 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9565 @item -mmmx
9566 @itemx -mno-mmx
9567 @item -msse
9568 @itemx -mno-sse
9569 @item -msse2
9570 @itemx -mno-sse2
9571 @item -msse3
9572 @itemx -mno-sse3
9573 @item -mssse3
9574 @itemx -mno-ssse3
9575 @item -m3dnow
9576 @itemx -mno-3dnow
9577 @opindex mmmx
9578 @opindex mno-mmx
9579 @opindex msse
9580 @opindex mno-sse
9581 @opindex m3dnow
9582 @opindex mno-3dnow
9583 These switches enable or disable the use of instructions in the MMX,
9584 SSE, SSE2, SSE3, SSSE3 or 3DNow! extended instruction sets.
9585 These extensions are also available as built-in functions: see
9586 @ref{X86 Built-in Functions}, for details of the functions enabled and
9587 disabled by these switches.
9589 To have SSE/SSE2 instructions generated automatically from floating-point
9590 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9592 These options will enable GCC to use these extended instructions in
9593 generated code, even without @option{-mfpmath=sse}.  Applications which
9594 perform runtime CPU detection must compile separate files for each
9595 supported architecture, using the appropriate flags.  In particular,
9596 the file containing the CPU detection code should be compiled without
9597 these options.
9599 @item -mpush-args
9600 @itemx -mno-push-args
9601 @opindex mpush-args
9602 @opindex mno-push-args
9603 Use PUSH operations to store outgoing parameters.  This method is shorter
9604 and usually equally fast as method using SUB/MOV operations and is enabled
9605 by default.  In some cases disabling it may improve performance because of
9606 improved scheduling and reduced dependencies.
9608 @item -maccumulate-outgoing-args
9609 @opindex maccumulate-outgoing-args
9610 If enabled, the maximum amount of space required for outgoing arguments will be
9611 computed in the function prologue.  This is faster on most modern CPUs
9612 because of reduced dependencies, improved scheduling and reduced stack usage
9613 when preferred stack boundary is not equal to 2.  The drawback is a notable
9614 increase in code size.  This switch implies @option{-mno-push-args}.
9616 @item -mthreads
9617 @opindex mthreads
9618 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9619 on thread-safe exception handling must compile and link all code with the
9620 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9621 @option{-D_MT}; when linking, it links in a special thread helper library
9622 @option{-lmingwthrd} which cleans up per thread exception handling data.
9624 @item -mno-align-stringops
9625 @opindex mno-align-stringops
9626 Do not align destination of inlined string operations.  This switch reduces
9627 code size and improves performance in case the destination is already aligned,
9628 but GCC doesn't know about it.
9630 @item -minline-all-stringops
9631 @opindex minline-all-stringops
9632 By default GCC inlines string operations only when destination is known to be
9633 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9634 size, but may improve performance of code that depends on fast memcpy, strlen
9635 and memset for short lengths.
9637 @item -momit-leaf-frame-pointer
9638 @opindex momit-leaf-frame-pointer
9639 Don't keep the frame pointer in a register for leaf functions.  This
9640 avoids the instructions to save, set up and restore frame pointers and
9641 makes an extra register available in leaf functions.  The option
9642 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9643 which might make debugging harder.
9645 @item -mtls-direct-seg-refs
9646 @itemx -mno-tls-direct-seg-refs
9647 @opindex mtls-direct-seg-refs
9648 Controls whether TLS variables may be accessed with offsets from the
9649 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9650 or whether the thread base pointer must be added.  Whether or not this
9651 is legal depends on the operating system, and whether it maps the
9652 segment to cover the entire TLS area.
9654 For systems that use GNU libc, the default is on.
9655 @end table
9657 These @samp{-m} switches are supported in addition to the above
9658 on AMD x86-64 processors in 64-bit environments.
9660 @table @gcctabopt
9661 @item -m32
9662 @itemx -m64
9663 @opindex m32
9664 @opindex m64
9665 Generate code for a 32-bit or 64-bit environment.
9666 The 32-bit environment sets int, long and pointer to 32 bits and
9667 generates code that runs on any i386 system.
9668 The 64-bit environment sets int to 32 bits and long and pointer
9669 to 64 bits and generates code for AMD's x86-64 architecture.
9671 @item -mno-red-zone
9672 @opindex no-red-zone
9673 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9674 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9675 stack pointer that will not be modified by signal or interrupt handlers
9676 and therefore can be used for temporary data without adjusting the stack
9677 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9679 @item -mcmodel=small
9680 @opindex mcmodel=small
9681 Generate code for the small code model: the program and its symbols must
9682 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9683 Programs can be statically or dynamically linked.  This is the default
9684 code model.
9686 @item -mcmodel=kernel
9687 @opindex mcmodel=kernel
9688 Generate code for the kernel code model.  The kernel runs in the
9689 negative 2 GB of the address space.
9690 This model has to be used for Linux kernel code.
9692 @item -mcmodel=medium
9693 @opindex mcmodel=medium
9694 Generate code for the medium model: The program is linked in the lower 2
9695 GB of the address space but symbols can be located anywhere in the
9696 address space.  Programs can be statically or dynamically linked, but
9697 building of shared libraries are not supported with the medium model.
9699 @item -mcmodel=large
9700 @opindex mcmodel=large
9701 Generate code for the large model: This model makes no assumptions
9702 about addresses and sizes of sections.  Currently GCC does not implement
9703 this model.
9704 @end table
9706 @node IA-64 Options
9707 @subsection IA-64 Options
9708 @cindex IA-64 Options
9710 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9712 @table @gcctabopt
9713 @item -mbig-endian
9714 @opindex mbig-endian
9715 Generate code for a big endian target.  This is the default for HP-UX@.
9717 @item -mlittle-endian
9718 @opindex mlittle-endian
9719 Generate code for a little endian target.  This is the default for AIX5
9720 and GNU/Linux.
9722 @item -mgnu-as
9723 @itemx -mno-gnu-as
9724 @opindex mgnu-as
9725 @opindex mno-gnu-as
9726 Generate (or don't) code for the GNU assembler.  This is the default.
9727 @c Also, this is the default if the configure option @option{--with-gnu-as}
9728 @c is used.
9730 @item -mgnu-ld
9731 @itemx -mno-gnu-ld
9732 @opindex mgnu-ld
9733 @opindex mno-gnu-ld
9734 Generate (or don't) code for the GNU linker.  This is the default.
9735 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9736 @c is used.
9738 @item -mno-pic
9739 @opindex mno-pic
9740 Generate code that does not use a global pointer register.  The result
9741 is not position independent code, and violates the IA-64 ABI@.
9743 @item -mvolatile-asm-stop
9744 @itemx -mno-volatile-asm-stop
9745 @opindex mvolatile-asm-stop
9746 @opindex mno-volatile-asm-stop
9747 Generate (or don't) a stop bit immediately before and after volatile asm
9748 statements.
9750 @item -mregister-names
9751 @itemx -mno-register-names
9752 @opindex mregister-names
9753 @opindex mno-register-names
9754 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9755 the stacked registers.  This may make assembler output more readable.
9757 @item -mno-sdata
9758 @itemx -msdata
9759 @opindex mno-sdata
9760 @opindex msdata
9761 Disable (or enable) optimizations that use the small data section.  This may
9762 be useful for working around optimizer bugs.
9764 @item -mconstant-gp
9765 @opindex mconstant-gp
9766 Generate code that uses a single constant global pointer value.  This is
9767 useful when compiling kernel code.
9769 @item -mauto-pic
9770 @opindex mauto-pic
9771 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9772 This is useful when compiling firmware code.
9774 @item -minline-float-divide-min-latency
9775 @opindex minline-float-divide-min-latency
9776 Generate code for inline divides of floating point values
9777 using the minimum latency algorithm.
9779 @item -minline-float-divide-max-throughput
9780 @opindex minline-float-divide-max-throughput
9781 Generate code for inline divides of floating point values
9782 using the maximum throughput algorithm.
9784 @item -minline-int-divide-min-latency
9785 @opindex minline-int-divide-min-latency
9786 Generate code for inline divides of integer values
9787 using the minimum latency algorithm.
9789 @item -minline-int-divide-max-throughput
9790 @opindex minline-int-divide-max-throughput
9791 Generate code for inline divides of integer values
9792 using the maximum throughput algorithm.
9794 @item -minline-sqrt-min-latency
9795 @opindex minline-sqrt-min-latency
9796 Generate code for inline square roots
9797 using the minimum latency algorithm.
9799 @item -minline-sqrt-max-throughput
9800 @opindex minline-sqrt-max-throughput
9801 Generate code for inline square roots
9802 using the maximum throughput algorithm.
9804 @item -mno-dwarf2-asm
9805 @itemx -mdwarf2-asm
9806 @opindex mno-dwarf2-asm
9807 @opindex mdwarf2-asm
9808 Don't (or do) generate assembler code for the DWARF2 line number debugging
9809 info.  This may be useful when not using the GNU assembler.
9811 @item -mearly-stop-bits
9812 @itemx -mno-early-stop-bits
9813 @opindex mearly-stop-bits
9814 @opindex mno-early-stop-bits
9815 Allow stop bits to be placed earlier than immediately preceding the
9816 instruction that triggered the stop bit.  This can improve instruction
9817 scheduling, but does not always do so.
9819 @item -mfixed-range=@var{register-range}
9820 @opindex mfixed-range
9821 Generate code treating the given register range as fixed registers.
9822 A fixed register is one that the register allocator can not use.  This is
9823 useful when compiling kernel code.  A register range is specified as
9824 two registers separated by a dash.  Multiple register ranges can be
9825 specified separated by a comma.
9827 @item -mtls-size=@var{tls-size}
9828 @opindex mtls-size
9829 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9832 @item -mtune=@var{cpu-type}
9833 @opindex mtune
9834 Tune the instruction scheduling for a particular CPU, Valid values are
9835 itanium, itanium1, merced, itanium2, and mckinley.
9837 @item -mt
9838 @itemx -pthread
9839 @opindex mt
9840 @opindex pthread
9841 Add support for multithreading using the POSIX threads library.  This
9842 option sets flags for both the preprocessor and linker.  It does
9843 not affect the thread safety of object code produced by the compiler or
9844 that of libraries supplied with it.  These are HP-UX specific flags.
9846 @item -milp32
9847 @itemx -mlp64
9848 @opindex milp32
9849 @opindex mlp64
9850 Generate code for a 32-bit or 64-bit environment.
9851 The 32-bit environment sets int, long and pointer to 32 bits.
9852 The 64-bit environment sets int to 32 bits and long and pointer
9853 to 64 bits.  These are HP-UX specific flags.
9855 @item -mno-sched-br-data-spec
9856 @itemx -msched-br-data-spec
9857 @opindex -mno-sched-br-data-spec
9858 @opindex -msched-br-data-spec
9859 (Dis/En)able data speculative scheduling before reload.
9860 This will result in generation of the ld.a instructions and
9861 the corresponding check instructions (ld.c / chk.a).
9862 The default is 'disable'.
9864 @item -msched-ar-data-spec
9865 @itemx -mno-sched-ar-data-spec
9866 @opindex -msched-ar-data-spec
9867 @opindex -mno-sched-ar-data-spec
9868 (En/Dis)able data speculative scheduling after reload.
9869 This will result in generation of the ld.a instructions and
9870 the corresponding check instructions (ld.c / chk.a).
9871 The default is 'enable'.
9873 @item -mno-sched-control-spec
9874 @itemx -msched-control-spec
9875 @opindex -mno-sched-control-spec
9876 @opindex -msched-control-spec
9877 (Dis/En)able control speculative scheduling.  This feature is
9878 available only during region scheduling (i.e. before reload).
9879 This will result in generation of the ld.s instructions and
9880 the corresponding check instructions chk.s .
9881 The default is 'disable'.
9883 @item -msched-br-in-data-spec
9884 @itemx -mno-sched-br-in-data-spec
9885 @opindex -msched-br-in-data-spec
9886 @opindex -mno-sched-br-in-data-spec
9887 (En/Dis)able speculative scheduling of the instructions that
9888 are dependent on the data speculative loads before reload.
9889 This is effective only with @option{-msched-br-data-spec} enabled.
9890 The default is 'enable'.
9892 @item -msched-ar-in-data-spec
9893 @itemx -mno-sched-ar-in-data-spec
9894 @opindex -msched-ar-in-data-spec
9895 @opindex -mno-sched-ar-in-data-spec
9896 (En/Dis)able speculative scheduling of the instructions that
9897 are dependent on the data speculative loads after reload.
9898 This is effective only with @option{-msched-ar-data-spec} enabled.
9899 The default is 'enable'.
9901 @item -msched-in-control-spec
9902 @itemx -mno-sched-in-control-spec
9903 @opindex -msched-in-control-spec
9904 @opindex -mno-sched-in-control-spec
9905 (En/Dis)able speculative scheduling of the instructions that
9906 are dependent on the control speculative loads.
9907 This is effective only with @option{-msched-control-spec} enabled.
9908 The default is 'enable'.
9910 @item -msched-ldc
9911 @itemx -mno-sched-ldc
9912 @opindex -msched-ldc
9913 @opindex -mno-sched-ldc
9914 (En/Dis)able use of simple data speculation checks ld.c .
9915 If disabled, only chk.a instructions will be emitted to check
9916 data speculative loads.
9917 The default is 'enable'.
9919 @item -mno-sched-control-ldc
9920 @itemx -msched-control-ldc
9921 @opindex -mno-sched-control-ldc
9922 @opindex -msched-control-ldc 
9923 (Dis/En)able use of ld.c instructions to check control speculative loads.
9924 If enabled, in case of control speculative load with no speculatively
9925 scheduled dependent instructions this load will be emitted as ld.sa and
9926 ld.c will be used to check it.
9927 The default is 'disable'.
9929 @item -mno-sched-spec-verbose
9930 @itemx -msched-spec-verbose
9931 @opindex -mno-sched-spec-verbose
9932 @opindex -msched-spec-verbose
9933 (Dis/En)able printing of the information about speculative motions.
9935 @item -mno-sched-prefer-non-data-spec-insns
9936 @itemx -msched-prefer-non-data-spec-insns
9937 @opindex -mno-sched-prefer-non-data-spec-insns
9938 @opindex -msched-prefer-non-data-spec-insns
9939 If enabled, data speculative instructions will be chosen for schedule
9940 only if there are no other choices at the moment.  This will make
9941 the use of the data speculation much more conservative.
9942 The default is 'disable'.
9944 @item -mno-sched-prefer-non-control-spec-insns
9945 @itemx -msched-prefer-non-control-spec-insns
9946 @opindex -mno-sched-prefer-non-control-spec-insns
9947 @opindex -msched-prefer-non-control-spec-insns
9948 If enabled, control speculative instructions will be chosen for schedule
9949 only if there are no other choices at the moment.  This will make
9950 the use of the control speculation much more conservative.
9951 The default is 'disable'.
9953 @item -mno-sched-count-spec-in-critical-path
9954 @itemx -msched-count-spec-in-critical-path
9955 @opindex -mno-sched-count-spec-in-critical-path
9956 @opindex -msched-count-spec-in-critical-path
9957 If enabled, speculative dependencies will be considered during
9958 computation of the instructions priorities.  This will make the use of the
9959 speculation a bit more conservative.
9960 The default is 'disable'.
9962 @end table
9964 @node M32C Options
9965 @subsection M32C Options
9966 @cindex M32C options
9968 @table @gcctabopt
9969 @item -mcpu=@var{name}
9970 @opindex mcpu=
9971 Select the CPU for which code is generated.  @var{name} may be one of
9972 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9973 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9974 the M32C/80 series.
9976 @item -msim
9977 @opindex msim
9978 Specifies that the program will be run on the simulator.  This causes
9979 an alternate runtime library to be linked in which supports, for
9980 example, file I/O.  You must not use this option when generating
9981 programs that will run on real hardware; you must provide your own
9982 runtime library for whatever I/O functions are needed.
9984 @item -memregs=@var{number}
9985 @opindex memregs=
9986 Specifies the number of memory-based pseudo-registers GCC will use
9987 during code generation.  These pseudo-registers will be used like real
9988 registers, so there is a tradeoff between GCC's ability to fit the
9989 code into available registers, and the performance penalty of using
9990 memory instead of registers.  Note that all modules in a program must
9991 be compiled with the same value for this option.  Because of that, you
9992 must not use this option with the default runtime libraries gcc
9993 builds.
9995 @end table
9997 @node M32R/D Options
9998 @subsection M32R/D Options
9999 @cindex M32R/D options
10001 These @option{-m} options are defined for Renesas M32R/D architectures:
10003 @table @gcctabopt
10004 @item -m32r2
10005 @opindex m32r2
10006 Generate code for the M32R/2@.
10008 @item -m32rx
10009 @opindex m32rx
10010 Generate code for the M32R/X@.
10012 @item -m32r
10013 @opindex m32r
10014 Generate code for the M32R@.  This is the default.
10016 @item -mmodel=small
10017 @opindex mmodel=small
10018 Assume all objects live in the lower 16MB of memory (so that their addresses
10019 can be loaded with the @code{ld24} instruction), and assume all subroutines
10020 are reachable with the @code{bl} instruction.
10021 This is the default.
10023 The addressability of a particular object can be set with the
10024 @code{model} attribute.
10026 @item -mmodel=medium
10027 @opindex mmodel=medium
10028 Assume objects may be anywhere in the 32-bit address space (the compiler
10029 will generate @code{seth/add3} instructions to load their addresses), and
10030 assume all subroutines are reachable with the @code{bl} instruction.
10032 @item -mmodel=large
10033 @opindex mmodel=large
10034 Assume objects may be anywhere in the 32-bit address space (the compiler
10035 will generate @code{seth/add3} instructions to load their addresses), and
10036 assume subroutines may not be reachable with the @code{bl} instruction
10037 (the compiler will generate the much slower @code{seth/add3/jl}
10038 instruction sequence).
10040 @item -msdata=none
10041 @opindex msdata=none
10042 Disable use of the small data area.  Variables will be put into
10043 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
10044 @code{section} attribute has been specified).
10045 This is the default.
10047 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
10048 Objects may be explicitly put in the small data area with the
10049 @code{section} attribute using one of these sections.
10051 @item -msdata=sdata
10052 @opindex msdata=sdata
10053 Put small global and static data in the small data area, but do not
10054 generate special code to reference them.
10056 @item -msdata=use
10057 @opindex msdata=use
10058 Put small global and static data in the small data area, and generate
10059 special instructions to reference them.
10061 @item -G @var{num}
10062 @opindex G
10063 @cindex smaller data references
10064 Put global and static objects less than or equal to @var{num} bytes
10065 into the small data or bss sections instead of the normal data or bss
10066 sections.  The default value of @var{num} is 8.
10067 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
10068 for this option to have any effect.
10070 All modules should be compiled with the same @option{-G @var{num}} value.
10071 Compiling with different values of @var{num} may or may not work; if it
10072 doesn't the linker will give an error message---incorrect code will not be
10073 generated.
10075 @item -mdebug
10076 @opindex mdebug
10077 Makes the M32R specific code in the compiler display some statistics
10078 that might help in debugging programs.
10080 @item -malign-loops
10081 @opindex malign-loops
10082 Align all loops to a 32-byte boundary.
10084 @item -mno-align-loops
10085 @opindex mno-align-loops
10086 Do not enforce a 32-byte alignment for loops.  This is the default.
10088 @item -missue-rate=@var{number}
10089 @opindex missue-rate=@var{number}
10090 Issue @var{number} instructions per cycle.  @var{number} can only be 1
10091 or 2.
10093 @item -mbranch-cost=@var{number}
10094 @opindex mbranch-cost=@var{number}
10095 @var{number} can only be 1 or 2.  If it is 1 then branches will be
10096 preferred over conditional code, if it is 2, then the opposite will
10097 apply.
10099 @item -mflush-trap=@var{number}
10100 @opindex mflush-trap=@var{number}
10101 Specifies the trap number to use to flush the cache.  The default is
10102 12.  Valid numbers are between 0 and 15 inclusive.
10104 @item -mno-flush-trap
10105 @opindex mno-flush-trap
10106 Specifies that the cache cannot be flushed by using a trap.
10108 @item -mflush-func=@var{name}
10109 @opindex mflush-func=@var{name}
10110 Specifies the name of the operating system function to call to flush
10111 the cache.  The default is @emph{_flush_cache}, but a function call
10112 will only be used if a trap is not available.
10114 @item -mno-flush-func
10115 @opindex mno-flush-func
10116 Indicates that there is no OS function for flushing the cache.
10118 @end table
10120 @node M680x0 Options
10121 @subsection M680x0 Options
10122 @cindex M680x0 options
10124 These are the @samp{-m} options defined for the 68000 series.  The default
10125 values for these options depends on which style of 68000 was selected when
10126 the compiler was configured; the defaults for the most common choices are
10127 given below.
10129 @table @gcctabopt
10130 @item -m68000
10131 @itemx -mc68000
10132 @opindex m68000
10133 @opindex mc68000
10134 Generate output for a 68000.  This is the default
10135 when the compiler is configured for 68000-based systems.
10137 Use this option for microcontrollers with a 68000 or EC000 core,
10138 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
10140 @item -m68020
10141 @itemx -mc68020
10142 @opindex m68020
10143 @opindex mc68020
10144 Generate output for a 68020.  This is the default
10145 when the compiler is configured for 68020-based systems.
10147 @item -m68881
10148 @opindex m68881
10149 Generate output containing 68881 instructions for floating point.
10150 This is the default for most 68020 systems unless @option{--nfp} was
10151 specified when the compiler was configured.
10153 @item -m68030
10154 @opindex m68030
10155 Generate output for a 68030.  This is the default when the compiler is
10156 configured for 68030-based systems.
10158 @item -m68040
10159 @opindex m68040
10160 Generate output for a 68040.  This is the default when the compiler is
10161 configured for 68040-based systems.
10163 This option inhibits the use of 68881/68882 instructions that have to be
10164 emulated by software on the 68040.  Use this option if your 68040 does not
10165 have code to emulate those instructions.
10167 @item -m68060
10168 @opindex m68060
10169 Generate output for a 68060.  This is the default when the compiler is
10170 configured for 68060-based systems.
10172 This option inhibits the use of 68020 and 68881/68882 instructions that
10173 have to be emulated by software on the 68060.  Use this option if your 68060
10174 does not have code to emulate those instructions.
10176 @item -mcpu32
10177 @opindex mcpu32
10178 Generate output for a CPU32.  This is the default
10179 when the compiler is configured for CPU32-based systems.
10181 Use this option for microcontrollers with a
10182 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
10183 68336, 68340, 68341, 68349 and 68360.
10185 @item -m5200
10186 @opindex m5200
10187 Generate output for a 520X ``coldfire'' family cpu.  This is the default
10188 when the compiler is configured for 520X-based systems.
10190 Use this option for microcontroller with a 5200 core, including
10191 the MCF5202, MCF5203, MCF5204 and MCF5202.
10193 @item -mcfv4e
10194 @opindex mcfv4e
10195 Generate output for a ColdFire V4e family cpu (e.g.@: 547x/548x).
10196 This includes use of hardware floating point instructions.
10198 @item -m68020-40
10199 @opindex m68020-40
10200 Generate output for a 68040, without using any of the new instructions.
10201 This results in code which can run relatively efficiently on either a
10202 68020/68881 or a 68030 or a 68040.  The generated code does use the
10203 68881 instructions that are emulated on the 68040.
10205 @item -m68020-60
10206 @opindex m68020-60
10207 Generate output for a 68060, without using any of the new instructions.
10208 This results in code which can run relatively efficiently on either a
10209 68020/68881 or a 68030 or a 68040.  The generated code does use the
10210 68881 instructions that are emulated on the 68060.
10212 @item -msoft-float
10213 @opindex msoft-float
10214 Generate output containing library calls for floating point.
10215 @strong{Warning:} the requisite libraries are not available for all m68k
10216 targets.  Normally the facilities of the machine's usual C compiler are
10217 used, but this can't be done directly in cross-compilation.  You must
10218 make your own arrangements to provide suitable library functions for
10219 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
10220 @samp{m68k-*-coff} do provide software floating point support.
10222 @item -mshort
10223 @opindex mshort
10224 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10225 Additionally, parameters passed on the stack are also aligned to a
10226 16-bit boundary even on targets whose API mandates promotion to 32-bit.
10228 @item -mnobitfield
10229 @opindex mnobitfield
10230 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
10231 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
10233 @item -mbitfield
10234 @opindex mbitfield
10235 Do use the bit-field instructions.  The @option{-m68020} option implies
10236 @option{-mbitfield}.  This is the default if you use a configuration
10237 designed for a 68020.
10239 @item -mrtd
10240 @opindex mrtd
10241 Use a different function-calling convention, in which functions
10242 that take a fixed number of arguments return with the @code{rtd}
10243 instruction, which pops their arguments while returning.  This
10244 saves one instruction in the caller since there is no need to pop
10245 the arguments there.
10247 This calling convention is incompatible with the one normally
10248 used on Unix, so you cannot use it if you need to call libraries
10249 compiled with the Unix compiler.
10251 Also, you must provide function prototypes for all functions that
10252 take variable numbers of arguments (including @code{printf});
10253 otherwise incorrect code will be generated for calls to those
10254 functions.
10256 In addition, seriously incorrect code will result if you call a
10257 function with too many arguments.  (Normally, extra arguments are
10258 harmlessly ignored.)
10260 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
10261 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
10263 @item -malign-int
10264 @itemx -mno-align-int
10265 @opindex malign-int
10266 @opindex mno-align-int
10267 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
10268 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
10269 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
10270 Aligning variables on 32-bit boundaries produces code that runs somewhat
10271 faster on processors with 32-bit busses at the expense of more memory.
10273 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
10274 align structures containing the above types  differently than
10275 most published application binary interface specifications for the m68k.
10277 @item -mpcrel
10278 @opindex mpcrel
10279 Use the pc-relative addressing mode of the 68000 directly, instead of
10280 using a global offset table.  At present, this option implies @option{-fpic},
10281 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
10282 not presently supported with @option{-mpcrel}, though this could be supported for
10283 68020 and higher processors.
10285 @item -mno-strict-align
10286 @itemx -mstrict-align
10287 @opindex mno-strict-align
10288 @opindex mstrict-align
10289 Do not (do) assume that unaligned memory references will be handled by
10290 the system.
10292 @item -msep-data
10293 Generate code that allows the data segment to be located in a different
10294 area of memory from the text segment.  This allows for execute in place in
10295 an environment without virtual memory management.  This option implies
10296 @option{-fPIC}.
10298 @item -mno-sep-data
10299 Generate code that assumes that the data segment follows the text segment.
10300 This is the default.
10302 @item -mid-shared-library
10303 Generate code that supports shared libraries via the library ID method.
10304 This allows for execute in place and shared libraries in an environment
10305 without virtual memory management.  This option implies @option{-fPIC}.
10307 @item -mno-id-shared-library
10308 Generate code that doesn't assume ID based shared libraries are being used.
10309 This is the default.
10311 @item -mshared-library-id=n
10312 Specified the identification number of the ID based shared library being
10313 compiled.  Specifying a value of 0 will generate more compact code, specifying
10314 other values will force the allocation of that number to the current
10315 library but is no more space or time efficient than omitting this option.
10317 @end table
10319 @node M68hc1x Options
10320 @subsection M68hc1x Options
10321 @cindex M68hc1x options
10323 These are the @samp{-m} options defined for the 68hc11 and 68hc12
10324 microcontrollers.  The default values for these options depends on
10325 which style of microcontroller was selected when the compiler was configured;
10326 the defaults for the most common choices are given below.
10328 @table @gcctabopt
10329 @item -m6811
10330 @itemx -m68hc11
10331 @opindex m6811
10332 @opindex m68hc11
10333 Generate output for a 68HC11.  This is the default
10334 when the compiler is configured for 68HC11-based systems.
10336 @item -m6812
10337 @itemx -m68hc12
10338 @opindex m6812
10339 @opindex m68hc12
10340 Generate output for a 68HC12.  This is the default
10341 when the compiler is configured for 68HC12-based systems.
10343 @item -m68S12
10344 @itemx -m68hcs12
10345 @opindex m68S12
10346 @opindex m68hcs12
10347 Generate output for a 68HCS12.
10349 @item -mauto-incdec
10350 @opindex mauto-incdec
10351 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10352 addressing modes.
10354 @item -minmax
10355 @itemx -nominmax
10356 @opindex minmax
10357 @opindex mnominmax
10358 Enable the use of 68HC12 min and max instructions.
10360 @item -mlong-calls
10361 @itemx -mno-long-calls
10362 @opindex mlong-calls
10363 @opindex mno-long-calls
10364 Treat all calls as being far away (near).  If calls are assumed to be
10365 far away, the compiler will use the @code{call} instruction to
10366 call a function and the @code{rtc} instruction for returning.
10368 @item -mshort
10369 @opindex mshort
10370 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10372 @item -msoft-reg-count=@var{count}
10373 @opindex msoft-reg-count
10374 Specify the number of pseudo-soft registers which are used for the
10375 code generation.  The maximum number is 32.  Using more pseudo-soft
10376 register may or may not result in better code depending on the program.
10377 The default is 4 for 68HC11 and 2 for 68HC12.
10379 @end table
10381 @node MCore Options
10382 @subsection MCore Options
10383 @cindex MCore options
10385 These are the @samp{-m} options defined for the Motorola M*Core
10386 processors.
10388 @table @gcctabopt
10390 @item -mhardlit
10391 @itemx -mno-hardlit
10392 @opindex mhardlit
10393 @opindex mno-hardlit
10394 Inline constants into the code stream if it can be done in two
10395 instructions or less.
10397 @item -mdiv
10398 @itemx -mno-div
10399 @opindex mdiv
10400 @opindex mno-div
10401 Use the divide instruction.  (Enabled by default).
10403 @item -mrelax-immediate
10404 @itemx -mno-relax-immediate
10405 @opindex mrelax-immediate
10406 @opindex mno-relax-immediate
10407 Allow arbitrary sized immediates in bit operations.
10409 @item -mwide-bitfields
10410 @itemx -mno-wide-bitfields
10411 @opindex mwide-bitfields
10412 @opindex mno-wide-bitfields
10413 Always treat bit-fields as int-sized.
10415 @item -m4byte-functions
10416 @itemx -mno-4byte-functions
10417 @opindex m4byte-functions
10418 @opindex mno-4byte-functions
10419 Force all functions to be aligned to a four byte boundary.
10421 @item -mcallgraph-data
10422 @itemx -mno-callgraph-data
10423 @opindex mcallgraph-data
10424 @opindex mno-callgraph-data
10425 Emit callgraph information.
10427 @item -mslow-bytes
10428 @itemx -mno-slow-bytes
10429 @opindex mslow-bytes
10430 @opindex mno-slow-bytes
10431 Prefer word access when reading byte quantities.
10433 @item -mlittle-endian
10434 @itemx -mbig-endian
10435 @opindex mlittle-endian
10436 @opindex mbig-endian
10437 Generate code for a little endian target.
10439 @item -m210
10440 @itemx -m340
10441 @opindex m210
10442 @opindex m340
10443 Generate code for the 210 processor.
10444 @end table
10446 @node MIPS Options
10447 @subsection MIPS Options
10448 @cindex MIPS options
10450 @table @gcctabopt
10452 @item -EB
10453 @opindex EB
10454 Generate big-endian code.
10456 @item -EL
10457 @opindex EL
10458 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10459 configurations.
10461 @item -march=@var{arch}
10462 @opindex march
10463 Generate code that will run on @var{arch}, which can be the name of a
10464 generic MIPS ISA, or the name of a particular processor.
10465 The ISA names are:
10466 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10467 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10468 The processor names are:
10469 @samp{4kc}, @samp{4km}, @samp{4kp},
10470 @samp{5kc}, @samp{5kf},
10471 @samp{20kc},
10472 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10473 @samp{m4k},
10474 @samp{orion},
10475 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10476 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10477 @samp{rm7000}, @samp{rm9000},
10478 @samp{sb1},
10479 @samp{sr71000},
10480 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10481 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10482 The special value @samp{from-abi} selects the
10483 most compatible architecture for the selected ABI (that is,
10484 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10486 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10487 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10488 @samp{vr} may be written @samp{r}.
10490 GCC defines two macros based on the value of this option.  The first
10491 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10492 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10493 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10494 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10495 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10497 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10498 above.  In other words, it will have the full prefix and will not
10499 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10500 the macro names the resolved architecture (either @samp{"mips1"} or
10501 @samp{"mips3"}).  It names the default architecture when no
10502 @option{-march} option is given.
10504 @item -mtune=@var{arch}
10505 @opindex mtune
10506 Optimize for @var{arch}.  Among other things, this option controls
10507 the way instructions are scheduled, and the perceived cost of arithmetic
10508 operations.  The list of @var{arch} values is the same as for
10509 @option{-march}.
10511 When this option is not used, GCC will optimize for the processor
10512 specified by @option{-march}.  By using @option{-march} and
10513 @option{-mtune} together, it is possible to generate code that will
10514 run on a family of processors, but optimize the code for one
10515 particular member of that family.
10517 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10518 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10519 @samp{-march} ones described above.
10521 @item -mips1
10522 @opindex mips1
10523 Equivalent to @samp{-march=mips1}.
10525 @item -mips2
10526 @opindex mips2
10527 Equivalent to @samp{-march=mips2}.
10529 @item -mips3
10530 @opindex mips3
10531 Equivalent to @samp{-march=mips3}.
10533 @item -mips4
10534 @opindex mips4
10535 Equivalent to @samp{-march=mips4}.
10537 @item -mips32
10538 @opindex mips32
10539 Equivalent to @samp{-march=mips32}.
10541 @item -mips32r2
10542 @opindex mips32r2
10543 Equivalent to @samp{-march=mips32r2}.
10545 @item -mips64
10546 @opindex mips64
10547 Equivalent to @samp{-march=mips64}.
10549 @item -mips16
10550 @itemx -mno-mips16
10551 @opindex mips16
10552 @opindex mno-mips16
10553 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10554 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10556 @item -mabi=32
10557 @itemx -mabi=o64
10558 @itemx -mabi=n32
10559 @itemx -mabi=64
10560 @itemx -mabi=eabi
10561 @opindex mabi=32
10562 @opindex mabi=o64
10563 @opindex mabi=n32
10564 @opindex mabi=64
10565 @opindex mabi=eabi
10566 Generate code for the given ABI@.
10568 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10569 generates 64-bit code when you select a 64-bit architecture, but you
10570 can use @option{-mgp32} to get 32-bit code instead.
10572 For information about the O64 ABI, see
10573 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10575 @item -mabicalls
10576 @itemx -mno-abicalls
10577 @opindex mabicalls
10578 @opindex mno-abicalls
10579 Generate (do not generate) code that is suitable for SVR4-style
10580 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
10581 systems.
10583 @item -mshared
10584 @itemx -mno-shared
10585 Generate (do not generate) code that is fully position-independent,
10586 and that can therefore be linked into shared libraries.  This option
10587 only affects @option{-mabicalls}.
10589 All @option{-mabicalls} code has traditionally been position-independent,
10590 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
10591 as an extension, the GNU toolchain allows executables to use absolute
10592 accesses for locally-binding symbols.  It can also use shorter GP
10593 initialization sequences and generate direct calls to locally-defined
10594 functions.  This mode is selected by @option{-mno-shared}.
10596 @option{-mno-shared} depends on binutils 2.16 or higher and generates
10597 objects that can only be linked by the GNU linker.  However, the option
10598 does not affect the ABI of the final executable; it only affects the ABI
10599 of relocatable objects.  Using @option{-mno-shared} will generally make
10600 executables both smaller and quicker.
10602 @option{-mshared} is the default.
10604 @item -mxgot
10605 @itemx -mno-xgot
10606 @opindex mxgot
10607 @opindex mno-xgot
10608 Lift (do not lift) the usual restrictions on the size of the global
10609 offset table.
10611 GCC normally uses a single instruction to load values from the GOT@.
10612 While this is relatively efficient, it will only work if the GOT
10613 is smaller than about 64k.  Anything larger will cause the linker
10614 to report an error such as:
10616 @cindex relocation truncated to fit (MIPS)
10617 @smallexample
10618 relocation truncated to fit: R_MIPS_GOT16 foobar
10619 @end smallexample
10621 If this happens, you should recompile your code with @option{-mxgot}.
10622 It should then work with very large GOTs, although it will also be
10623 less efficient, since it will take three instructions to fetch the
10624 value of a global symbol.
10626 Note that some linkers can create multiple GOTs.  If you have such a
10627 linker, you should only need to use @option{-mxgot} when a single object
10628 file accesses more than 64k's worth of GOT entries.  Very few do.
10630 These options have no effect unless GCC is generating position
10631 independent code.
10633 @item -mgp32
10634 @opindex mgp32
10635 Assume that general-purpose registers are 32 bits wide.
10637 @item -mgp64
10638 @opindex mgp64
10639 Assume that general-purpose registers are 64 bits wide.
10641 @item -mfp32
10642 @opindex mfp32
10643 Assume that floating-point registers are 32 bits wide.
10645 @item -mfp64
10646 @opindex mfp64
10647 Assume that floating-point registers are 64 bits wide.
10649 @item -mhard-float
10650 @opindex mhard-float
10651 Use floating-point coprocessor instructions.
10653 @item -msoft-float
10654 @opindex msoft-float
10655 Do not use floating-point coprocessor instructions.  Implement
10656 floating-point calculations using library calls instead.
10658 @item -msingle-float
10659 @opindex msingle-float
10660 Assume that the floating-point coprocessor only supports single-precision
10661 operations.
10663 @itemx -mdouble-float
10664 @opindex mdouble-float
10665 Assume that the floating-point coprocessor supports double-precision
10666 operations.  This is the default.
10668 @itemx -mdsp
10669 @itemx -mno-dsp
10670 @opindex mdsp
10671 @opindex mno-dsp
10672 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10674 @itemx -mpaired-single
10675 @itemx -mno-paired-single
10676 @opindex mpaired-single
10677 @opindex mno-paired-single
10678 Use (do not use) paired-single floating-point instructions.
10679 @xref{MIPS Paired-Single Support}.  This option can only be used
10680 when generating 64-bit code and requires hardware floating-point
10681 support to be enabled.
10683 @itemx -mips3d
10684 @itemx -mno-mips3d
10685 @opindex mips3d
10686 @opindex mno-mips3d
10687 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10688 The option @option{-mips3d} implies @option{-mpaired-single}.
10690 @item -mlong64
10691 @opindex mlong64
10692 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10693 an explanation of the default and the way that the pointer size is
10694 determined.
10696 @item -mlong32
10697 @opindex mlong32
10698 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10700 The default size of @code{int}s, @code{long}s and pointers depends on
10701 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10702 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10703 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10704 or the same size as integer registers, whichever is smaller.
10706 @item -msym32
10707 @itemx -mno-sym32
10708 @opindex msym32
10709 @opindex mno-sym32
10710 Assume (do not assume) that all symbols have 32-bit values, regardless
10711 of the selected ABI@.  This option is useful in combination with
10712 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10713 to generate shorter and faster references to symbolic addresses.
10715 @item -G @var{num}
10716 @opindex G
10717 @cindex smaller data references (MIPS)
10718 @cindex gp-relative references (MIPS)
10719 Put global and static items less than or equal to @var{num} bytes into
10720 the small data or bss section instead of the normal data or bss section.
10721 This allows the data to be accessed using a single instruction.
10723 All modules should be compiled with the same @option{-G @var{num}}
10724 value.
10726 @item -membedded-data
10727 @itemx -mno-embedded-data
10728 @opindex membedded-data
10729 @opindex mno-embedded-data
10730 Allocate variables to the read-only data section first if possible, then
10731 next in the small data section if possible, otherwise in data.  This gives
10732 slightly slower code than the default, but reduces the amount of RAM required
10733 when executing, and thus may be preferred for some embedded systems.
10735 @item -muninit-const-in-rodata
10736 @itemx -mno-uninit-const-in-rodata
10737 @opindex muninit-const-in-rodata
10738 @opindex mno-uninit-const-in-rodata
10739 Put uninitialized @code{const} variables in the read-only data section.
10740 This option is only meaningful in conjunction with @option{-membedded-data}.
10742 @item -msplit-addresses
10743 @itemx -mno-split-addresses
10744 @opindex msplit-addresses
10745 @opindex mno-split-addresses
10746 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10747 relocation operators.  This option has been superseded by
10748 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10750 @item -mexplicit-relocs
10751 @itemx -mno-explicit-relocs
10752 @opindex mexplicit-relocs
10753 @opindex mno-explicit-relocs
10754 Use (do not use) assembler relocation operators when dealing with symbolic
10755 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10756 is to use assembler macros instead.
10758 @option{-mexplicit-relocs} is the default if GCC was configured
10759 to use an assembler that supports relocation operators.
10761 @item -mcheck-zero-division
10762 @itemx -mno-check-zero-division
10763 @opindex mcheck-zero-division
10764 @opindex mno-check-zero-division
10765 Trap (do not trap) on integer division by zero.  The default is
10766 @option{-mcheck-zero-division}.
10768 @item -mdivide-traps
10769 @itemx -mdivide-breaks
10770 @opindex mdivide-traps
10771 @opindex mdivide-breaks
10772 MIPS systems check for division by zero by generating either a
10773 conditional trap or a break instruction.  Using traps results in
10774 smaller code, but is only supported on MIPS II and later.  Also, some
10775 versions of the Linux kernel have a bug that prevents trap from
10776 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10777 allow conditional traps on architectures that support them and
10778 @option{-mdivide-breaks} to force the use of breaks.
10780 The default is usually @option{-mdivide-traps}, but this can be
10781 overridden at configure time using @option{--with-divide=breaks}.
10782 Divide-by-zero checks can be completely disabled using
10783 @option{-mno-check-zero-division}.
10785 @item -mmemcpy
10786 @itemx -mno-memcpy
10787 @opindex mmemcpy
10788 @opindex mno-memcpy
10789 Force (do not force) the use of @code{memcpy()} for non-trivial block
10790 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10791 most constant-sized copies.
10793 @item -mlong-calls
10794 @itemx -mno-long-calls
10795 @opindex mlong-calls
10796 @opindex mno-long-calls
10797 Disable (do not disable) use of the @code{jal} instruction.  Calling
10798 functions using @code{jal} is more efficient but requires the caller
10799 and callee to be in the same 256 megabyte segment.
10801 This option has no effect on abicalls code.  The default is
10802 @option{-mno-long-calls}.
10804 @item -mmad
10805 @itemx -mno-mad
10806 @opindex mmad
10807 @opindex mno-mad
10808 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10809 instructions, as provided by the R4650 ISA@.
10811 @item -mfused-madd
10812 @itemx -mno-fused-madd
10813 @opindex mfused-madd
10814 @opindex mno-fused-madd
10815 Enable (disable) use of the floating point multiply-accumulate
10816 instructions, when they are available.  The default is
10817 @option{-mfused-madd}.
10819 When multiply-accumulate instructions are used, the intermediate
10820 product is calculated to infinite precision and is not subject to
10821 the FCSR Flush to Zero bit.  This may be undesirable in some
10822 circumstances.
10824 @item -nocpp
10825 @opindex nocpp
10826 Tell the MIPS assembler to not run its preprocessor over user
10827 assembler files (with a @samp{.s} suffix) when assembling them.
10829 @item -mfix-r4000
10830 @itemx -mno-fix-r4000
10831 @opindex mfix-r4000
10832 @opindex mno-fix-r4000
10833 Work around certain R4000 CPU errata:
10834 @itemize @minus
10835 @item
10836 A double-word or a variable shift may give an incorrect result if executed
10837 immediately after starting an integer division.
10838 @item
10839 A double-word or a variable shift may give an incorrect result if executed
10840 while an integer multiplication is in progress.
10841 @item
10842 An integer division may give an incorrect result if started in a delay slot
10843 of a taken branch or a jump.
10844 @end itemize
10846 @item -mfix-r4400
10847 @itemx -mno-fix-r4400
10848 @opindex mfix-r4400
10849 @opindex mno-fix-r4400
10850 Work around certain R4400 CPU errata:
10851 @itemize @minus
10852 @item
10853 A double-word or a variable shift may give an incorrect result if executed
10854 immediately after starting an integer division.
10855 @end itemize
10857 @item -mfix-vr4120
10858 @itemx -mno-fix-vr4120
10859 @opindex mfix-vr4120
10860 Work around certain VR4120 errata:
10861 @itemize @minus
10862 @item
10863 @code{dmultu} does not always produce the correct result.
10864 @item
10865 @code{div} and @code{ddiv} do not always produce the correct result if one
10866 of the operands is negative.
10867 @end itemize
10868 The workarounds for the division errata rely on special functions in
10869 @file{libgcc.a}.  At present, these functions are only provided by
10870 the @code{mips64vr*-elf} configurations.
10872 Other VR4120 errata require a nop to be inserted between certain pairs of
10873 instructions.  These errata are handled by the assembler, not by GCC itself.
10875 @item -mfix-vr4130
10876 @opindex mfix-vr4130
10877 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10878 workarounds are implemented by the assembler rather than by GCC,
10879 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10880 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10881 instructions are available instead.
10883 @item -mfix-sb1
10884 @itemx -mno-fix-sb1
10885 @opindex mfix-sb1
10886 Work around certain SB-1 CPU core errata.
10887 (This flag currently works around the SB-1 revision 2
10888 ``F1'' and ``F2'' floating point errata.)
10890 @item -mflush-func=@var{func}
10891 @itemx -mno-flush-func
10892 @opindex mflush-func
10893 Specifies the function to call to flush the I and D caches, or to not
10894 call any such function.  If called, the function must take the same
10895 arguments as the common @code{_flush_func()}, that is, the address of the
10896 memory range for which the cache is being flushed, the size of the
10897 memory range, and the number 3 (to flush both caches).  The default
10898 depends on the target GCC was configured for, but commonly is either
10899 @samp{_flush_func} or @samp{__cpu_flush}.
10901 @item -mbranch-likely
10902 @itemx -mno-branch-likely
10903 @opindex mbranch-likely
10904 @opindex mno-branch-likely
10905 Enable or disable use of Branch Likely instructions, regardless of the
10906 default for the selected architecture.  By default, Branch Likely
10907 instructions may be generated if they are supported by the selected
10908 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10909 and processors which implement those architectures; for those, Branch
10910 Likely instructions will not be generated by default because the MIPS32
10911 and MIPS64 architectures specifically deprecate their use.
10913 @item -mfp-exceptions
10914 @itemx -mno-fp-exceptions
10915 @opindex mfp-exceptions
10916 Specifies whether FP exceptions are enabled.  This affects how we schedule
10917 FP instructions for some processors.  The default is that FP exceptions are
10918 enabled.
10920 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10921 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10922 FP pipe.
10924 @item -mvr4130-align
10925 @itemx -mno-vr4130-align
10926 @opindex mvr4130-align
10927 The VR4130 pipeline is two-way superscalar, but can only issue two
10928 instructions together if the first one is 8-byte aligned.  When this
10929 option is enabled, GCC will align pairs of instructions that it
10930 thinks should execute in parallel.
10932 This option only has an effect when optimizing for the VR4130.
10933 It normally makes code faster, but at the expense of making it bigger.
10934 It is enabled by default at optimization level @option{-O3}.
10935 @end table
10937 @node MMIX Options
10938 @subsection MMIX Options
10939 @cindex MMIX Options
10941 These options are defined for the MMIX:
10943 @table @gcctabopt
10944 @item -mlibfuncs
10945 @itemx -mno-libfuncs
10946 @opindex mlibfuncs
10947 @opindex mno-libfuncs
10948 Specify that intrinsic library functions are being compiled, passing all
10949 values in registers, no matter the size.
10951 @item -mepsilon
10952 @itemx -mno-epsilon
10953 @opindex mepsilon
10954 @opindex mno-epsilon
10955 Generate floating-point comparison instructions that compare with respect
10956 to the @code{rE} epsilon register.
10958 @item -mabi=mmixware
10959 @itemx -mabi=gnu
10960 @opindex mabi-mmixware
10961 @opindex mabi=gnu
10962 Generate code that passes function parameters and return values that (in
10963 the called function) are seen as registers @code{$0} and up, as opposed to
10964 the GNU ABI which uses global registers @code{$231} and up.
10966 @item -mzero-extend
10967 @itemx -mno-zero-extend
10968 @opindex mzero-extend
10969 @opindex mno-zero-extend
10970 When reading data from memory in sizes shorter than 64 bits, use (do not
10971 use) zero-extending load instructions by default, rather than
10972 sign-extending ones.
10974 @item -mknuthdiv
10975 @itemx -mno-knuthdiv
10976 @opindex mknuthdiv
10977 @opindex mno-knuthdiv
10978 Make the result of a division yielding a remainder have the same sign as
10979 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10980 remainder follows the sign of the dividend.  Both methods are
10981 arithmetically valid, the latter being almost exclusively used.
10983 @item -mtoplevel-symbols
10984 @itemx -mno-toplevel-symbols
10985 @opindex mtoplevel-symbols
10986 @opindex mno-toplevel-symbols
10987 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10988 code can be used with the @code{PREFIX} assembly directive.
10990 @item -melf
10991 @opindex melf
10992 Generate an executable in the ELF format, rather than the default
10993 @samp{mmo} format used by the @command{mmix} simulator.
10995 @item -mbranch-predict
10996 @itemx -mno-branch-predict
10997 @opindex mbranch-predict
10998 @opindex mno-branch-predict
10999 Use (do not use) the probable-branch instructions, when static branch
11000 prediction indicates a probable branch.
11002 @item -mbase-addresses
11003 @itemx -mno-base-addresses
11004 @opindex mbase-addresses
11005 @opindex mno-base-addresses
11006 Generate (do not generate) code that uses @emph{base addresses}.  Using a
11007 base address automatically generates a request (handled by the assembler
11008 and the linker) for a constant to be set up in a global register.  The
11009 register is used for one or more base address requests within the range 0
11010 to 255 from the value held in the register.  The generally leads to short
11011 and fast code, but the number of different data items that can be
11012 addressed is limited.  This means that a program that uses lots of static
11013 data may require @option{-mno-base-addresses}.
11015 @item -msingle-exit
11016 @itemx -mno-single-exit
11017 @opindex msingle-exit
11018 @opindex mno-single-exit
11019 Force (do not force) generated code to have a single exit point in each
11020 function.
11021 @end table
11023 @node MN10300 Options
11024 @subsection MN10300 Options
11025 @cindex MN10300 options
11027 These @option{-m} options are defined for Matsushita MN10300 architectures:
11029 @table @gcctabopt
11030 @item -mmult-bug
11031 @opindex mmult-bug
11032 Generate code to avoid bugs in the multiply instructions for the MN10300
11033 processors.  This is the default.
11035 @item -mno-mult-bug
11036 @opindex mno-mult-bug
11037 Do not generate code to avoid bugs in the multiply instructions for the
11038 MN10300 processors.
11040 @item -mam33
11041 @opindex mam33
11042 Generate code which uses features specific to the AM33 processor.
11044 @item -mno-am33
11045 @opindex mno-am33
11046 Do not generate code which uses features specific to the AM33 processor.  This
11047 is the default.
11049 @item -mreturn-pointer-on-d0
11050 @opindex mreturn-pointer-on-d0
11051 When generating a function which returns a pointer, return the pointer
11052 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
11053 only in a0, and attempts to call such functions without a prototype
11054 would result in errors.  Note that this option is on by default; use
11055 @option{-mno-return-pointer-on-d0} to disable it.
11057 @item -mno-crt0
11058 @opindex mno-crt0
11059 Do not link in the C run-time initialization object file.
11061 @item -mrelax
11062 @opindex mrelax
11063 Indicate to the linker that it should perform a relaxation optimization pass
11064 to shorten branches, calls and absolute memory addresses.  This option only
11065 has an effect when used on the command line for the final link step.
11067 This option makes symbolic debugging impossible.
11068 @end table
11070 @node MT Options
11071 @subsection MT Options
11072 @cindex MT options
11074 These @option{-m} options are defined for Morpho MT architectures:
11076 @table @gcctabopt
11078 @item -march=@var{cpu-type}
11079 @opindex march
11080 Generate code that will run on @var{cpu-type}, which is the name of a system
11081 representing a certain processor type.  Possible values for
11082 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
11083 @samp{ms1-16-003} and @samp{ms2}.
11085 When this option is not used, the default is @option{-march=ms1-16-002}.
11087 @item -mbacc
11088 @opindex mbacc
11089 Use byte loads and stores when generating code.
11091 @item -mno-bacc
11092 @opindex mno-bacc
11093 Do not use byte loads and stores when generating code.
11095 @item -msim
11096 @opindex msim
11097 Use simulator runtime
11099 @item -mno-crt0
11100 @opindex mno-crt0
11101 Do not link in the C run-time initialization object file
11102 @file{crti.o}.  Other run-time initialization and termination files
11103 such as @file{startup.o} and @file{exit.o} are still included on the
11104 linker command line.
11106 @end table
11108 @node PDP-11 Options
11109 @subsection PDP-11 Options
11110 @cindex PDP-11 Options
11112 These options are defined for the PDP-11:
11114 @table @gcctabopt
11115 @item -mfpu
11116 @opindex mfpu
11117 Use hardware FPP floating point.  This is the default.  (FIS floating
11118 point on the PDP-11/40 is not supported.)
11120 @item -msoft-float
11121 @opindex msoft-float
11122 Do not use hardware floating point.
11124 @item -mac0
11125 @opindex mac0
11126 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
11128 @item -mno-ac0
11129 @opindex mno-ac0
11130 Return floating-point results in memory.  This is the default.
11132 @item -m40
11133 @opindex m40
11134 Generate code for a PDP-11/40.
11136 @item -m45
11137 @opindex m45
11138 Generate code for a PDP-11/45.  This is the default.
11140 @item -m10
11141 @opindex m10
11142 Generate code for a PDP-11/10.
11144 @item -mbcopy-builtin
11145 @opindex bcopy-builtin
11146 Use inline @code{movmemhi} patterns for copying memory.  This is the
11147 default.
11149 @item -mbcopy
11150 @opindex mbcopy
11151 Do not use inline @code{movmemhi} patterns for copying memory.
11153 @item -mint16
11154 @itemx -mno-int32
11155 @opindex mint16
11156 @opindex mno-int32
11157 Use 16-bit @code{int}.  This is the default.
11159 @item -mint32
11160 @itemx -mno-int16
11161 @opindex mint32
11162 @opindex mno-int16
11163 Use 32-bit @code{int}.
11165 @item -mfloat64
11166 @itemx -mno-float32
11167 @opindex mfloat64
11168 @opindex mno-float32
11169 Use 64-bit @code{float}.  This is the default.
11171 @item -mfloat32
11172 @itemx -mno-float64
11173 @opindex mfloat32
11174 @opindex mno-float64
11175 Use 32-bit @code{float}.
11177 @item -mabshi
11178 @opindex mabshi
11179 Use @code{abshi2} pattern.  This is the default.
11181 @item -mno-abshi
11182 @opindex mno-abshi
11183 Do not use @code{abshi2} pattern.
11185 @item -mbranch-expensive
11186 @opindex mbranch-expensive
11187 Pretend that branches are expensive.  This is for experimenting with
11188 code generation only.
11190 @item -mbranch-cheap
11191 @opindex mbranch-cheap
11192 Do not pretend that branches are expensive.  This is the default.
11194 @item -msplit
11195 @opindex msplit
11196 Generate code for a system with split I&D@.
11198 @item -mno-split
11199 @opindex mno-split
11200 Generate code for a system without split I&D@.  This is the default.
11202 @item -munix-asm
11203 @opindex munix-asm
11204 Use Unix assembler syntax.  This is the default when configured for
11205 @samp{pdp11-*-bsd}.
11207 @item -mdec-asm
11208 @opindex mdec-asm
11209 Use DEC assembler syntax.  This is the default when configured for any
11210 PDP-11 target other than @samp{pdp11-*-bsd}.
11211 @end table
11213 @node PowerPC Options
11214 @subsection PowerPC Options
11215 @cindex PowerPC options
11217 These are listed under @xref{RS/6000 and PowerPC Options}.
11219 @node RS/6000 and PowerPC Options
11220 @subsection IBM RS/6000 and PowerPC Options
11221 @cindex RS/6000 and PowerPC Options
11222 @cindex IBM RS/6000 and PowerPC Options
11224 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
11225 @table @gcctabopt
11226 @item -mpower
11227 @itemx -mno-power
11228 @itemx -mpower2
11229 @itemx -mno-power2
11230 @itemx -mpowerpc
11231 @itemx -mno-powerpc
11232 @itemx -mpowerpc-gpopt
11233 @itemx -mno-powerpc-gpopt
11234 @itemx -mpowerpc-gfxopt
11235 @itemx -mno-powerpc-gfxopt
11236 @itemx -mpowerpc64
11237 @itemx -mno-powerpc64
11238 @itemx -mmfcrf
11239 @itemx -mno-mfcrf
11240 @itemx -mpopcntb
11241 @itemx -mno-popcntb
11242 @itemx -mfprnd
11243 @itemx -mno-fprnd
11244 @opindex mpower
11245 @opindex mno-power
11246 @opindex mpower2
11247 @opindex mno-power2
11248 @opindex mpowerpc
11249 @opindex mno-powerpc
11250 @opindex mpowerpc-gpopt
11251 @opindex mno-powerpc-gpopt
11252 @opindex mpowerpc-gfxopt
11253 @opindex mno-powerpc-gfxopt
11254 @opindex mpowerpc64
11255 @opindex mno-powerpc64
11256 @opindex mmfcrf
11257 @opindex mno-mfcrf
11258 @opindex mpopcntb
11259 @opindex mno-popcntb
11260 @opindex mfprnd
11261 @opindex mno-fprnd
11262 GCC supports two related instruction set architectures for the
11263 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
11264 instructions supported by the @samp{rios} chip set used in the original
11265 RS/6000 systems and the @dfn{PowerPC} instruction set is the
11266 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
11267 the IBM 4xx, 6xx, and follow-on microprocessors.
11269 Neither architecture is a subset of the other.  However there is a
11270 large common subset of instructions supported by both.  An MQ
11271 register is included in processors supporting the POWER architecture.
11273 You use these options to specify which instructions are available on the
11274 processor you are using.  The default value of these options is
11275 determined when configuring GCC@.  Specifying the
11276 @option{-mcpu=@var{cpu_type}} overrides the specification of these
11277 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
11278 rather than the options listed above.
11280 The @option{-mpower} option allows GCC to generate instructions that
11281 are found only in the POWER architecture and to use the MQ register.
11282 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
11283 to generate instructions that are present in the POWER2 architecture but
11284 not the original POWER architecture.
11286 The @option{-mpowerpc} option allows GCC to generate instructions that
11287 are found only in the 32-bit subset of the PowerPC architecture.
11288 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
11289 GCC to use the optional PowerPC architecture instructions in the
11290 General Purpose group, including floating-point square root.  Specifying
11291 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
11292 use the optional PowerPC architecture instructions in the Graphics
11293 group, including floating-point select.
11295 The @option{-mmfcrf} option allows GCC to generate the move from
11296 condition register field instruction implemented on the POWER4
11297 processor and other processors that support the PowerPC V2.01
11298 architecture.
11299 The @option{-mpopcntb} option allows GCC to generate the popcount and
11300 double precision FP reciprocal estimate instruction implemented on the
11301 POWER5 processor and other processors that support the PowerPC V2.02
11302 architecture.
11303 The @option{-mfprnd} option allows GCC to generate the FP round to
11304 integer instructions implemented on the POWER5+ processor and other
11305 processors that support the PowerPC V2.03 architecture.
11307 The @option{-mpowerpc64} option allows GCC to generate the additional
11308 64-bit instructions that are found in the full PowerPC64 architecture
11309 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
11310 @option{-mno-powerpc64}.
11312 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
11313 will use only the instructions in the common subset of both
11314 architectures plus some special AIX common-mode calls, and will not use
11315 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
11316 permits GCC to use any instruction from either architecture and to
11317 allow use of the MQ register; specify this for the Motorola MPC601.
11319 @item -mnew-mnemonics
11320 @itemx -mold-mnemonics
11321 @opindex mnew-mnemonics
11322 @opindex mold-mnemonics
11323 Select which mnemonics to use in the generated assembler code.  With
11324 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
11325 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
11326 assembler mnemonics defined for the POWER architecture.  Instructions
11327 defined in only one architecture have only one mnemonic; GCC uses that
11328 mnemonic irrespective of which of these options is specified.
11330 GCC defaults to the mnemonics appropriate for the architecture in
11331 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
11332 value of these option.  Unless you are building a cross-compiler, you
11333 should normally not specify either @option{-mnew-mnemonics} or
11334 @option{-mold-mnemonics}, but should instead accept the default.
11336 @item -mcpu=@var{cpu_type}
11337 @opindex mcpu
11338 Set architecture type, register usage, choice of mnemonics, and
11339 instruction scheduling parameters for machine type @var{cpu_type}.
11340 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
11341 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
11342 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
11343 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
11344 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
11345 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
11346 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
11347 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
11348 @samp{common}, @samp{powerpc}, @samp{powerpc64},
11349 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
11351 @option{-mcpu=common} selects a completely generic processor.  Code
11352 generated under this option will run on any POWER or PowerPC processor.
11353 GCC will use only the instructions in the common subset of both
11354 architectures, and will not use the MQ register.  GCC assumes a generic
11355 processor model for scheduling purposes.
11357 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11358 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11359 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11360 types, with an appropriate, generic processor model assumed for
11361 scheduling purposes.
11363 The other options specify a specific processor.  Code generated under
11364 those options will run best on that processor, and may not run at all on
11365 others.
11367 The @option{-mcpu} options automatically enable or disable the
11368 following options: @option{-maltivec}, @option{-mfprnd},
11369 @option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
11370 @option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
11371 @option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
11372 @option{-mpowerpc-gfxopt}, @option{-mstring}, @option{-mmulhw}, @option{-mdlmzb}.
11373 The particular options
11374 set for any particular CPU will vary between compiler versions,
11375 depending on what setting seems to produce optimal code for that CPU;
11376 it doesn't necessarily reflect the actual hardware's capabilities.  If
11377 you wish to set an individual option to a particular value, you may
11378 specify it after the @option{-mcpu} option, like @samp{-mcpu=970
11379 -mno-altivec}.
11381 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
11382 not enabled or disabled by the @option{-mcpu} option at present because
11383 AIX does not have full support for these options.  You may still
11384 enable or disable them individually if you're sure it'll work in your
11385 environment.
11387 @item -mtune=@var{cpu_type}
11388 @opindex mtune
11389 Set the instruction scheduling parameters for machine type
11390 @var{cpu_type}, but do not set the architecture type, register usage, or
11391 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
11392 values for @var{cpu_type} are used for @option{-mtune} as for
11393 @option{-mcpu}.  If both are specified, the code generated will use the
11394 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11395 scheduling parameters set by @option{-mtune}.
11397 @item -mswdiv
11398 @itemx -mno-swdiv
11399 @opindex mswdiv
11400 @opindex mno-swdiv
11401 Generate code to compute division as reciprocal estimate and iterative
11402 refinement, creating opportunities for increased throughput.  This
11403 feature requires: optional PowerPC Graphics instruction set for single
11404 precision and FRE instruction for double precision, assuming divides
11405 cannot generate user-visible traps, and the domain values not include
11406 Infinities, denormals or zero denominator.
11408 @item -maltivec
11409 @itemx -mno-altivec
11410 @opindex maltivec
11411 @opindex mno-altivec
11412 Generate code that uses (does not use) AltiVec instructions, and also
11413 enable the use of built-in functions that allow more direct access to
11414 the AltiVec instruction set.  You may also need to set
11415 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11416 enhancements.
11418 @item -mvrsave
11419 @item -mno-vrsave
11420 @opindex mvrsave
11421 @opindex mno-vrsave
11422 Generate VRSAVE instructions when generating AltiVec code.
11424 @item -msecure-plt
11425 @opindex msecure-plt
11426 Generate code that allows ld and ld.so to build executables and shared
11427 libraries with non-exec .plt and .got sections.  This is a PowerPC
11428 32-bit SYSV ABI option.
11430 @item -mbss-plt
11431 @opindex mbss-plt
11432 Generate code that uses a BSS .plt section that ld.so fills in, and
11433 requires .plt and .got sections that are both writable and executable.
11434 This is a PowerPC 32-bit SYSV ABI option.
11436 @item -misel
11437 @itemx -mno-isel
11438 @opindex misel
11439 @opindex mno-isel
11440 This switch enables or disables the generation of ISEL instructions.
11442 @item -misel=@var{yes/no}
11443 This switch has been deprecated.  Use @option{-misel} and
11444 @option{-mno-isel} instead.
11446 @item -mspe
11447 @itemx -mno-isel
11448 @opindex mspe
11449 @opindex mno-spe
11450 This switch enables or disables the generation of SPE simd
11451 instructions.
11453 @item -mspe=@var{yes/no}
11454 This option has been deprecated.  Use @option{-mspe} and
11455 @option{-mno-spe} instead.
11457 @item -mfloat-gprs=@var{yes/single/double/no}
11458 @itemx -mfloat-gprs
11459 @opindex mfloat-gprs
11460 This switch enables or disables the generation of floating point
11461 operations on the general purpose registers for architectures that
11462 support it.
11464 The argument @var{yes} or @var{single} enables the use of
11465 single-precision floating point operations.
11467 The argument @var{double} enables the use of single and
11468 double-precision floating point operations.
11470 The argument @var{no} disables floating point operations on the
11471 general purpose registers.
11473 This option is currently only available on the MPC854x.
11475 @item -m32
11476 @itemx -m64
11477 @opindex m32
11478 @opindex m64
11479 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11480 targets (including GNU/Linux).  The 32-bit environment sets int, long
11481 and pointer to 32 bits and generates code that runs on any PowerPC
11482 variant.  The 64-bit environment sets int to 32 bits and long and
11483 pointer to 64 bits, and generates code for PowerPC64, as for
11484 @option{-mpowerpc64}.
11486 @item -mfull-toc
11487 @itemx -mno-fp-in-toc
11488 @itemx -mno-sum-in-toc
11489 @itemx -mminimal-toc
11490 @opindex mfull-toc
11491 @opindex mno-fp-in-toc
11492 @opindex mno-sum-in-toc
11493 @opindex mminimal-toc
11494 Modify generation of the TOC (Table Of Contents), which is created for
11495 every executable file.  The @option{-mfull-toc} option is selected by
11496 default.  In that case, GCC will allocate at least one TOC entry for
11497 each unique non-automatic variable reference in your program.  GCC
11498 will also place floating-point constants in the TOC@.  However, only
11499 16,384 entries are available in the TOC@.
11501 If you receive a linker error message that saying you have overflowed
11502 the available TOC space, you can reduce the amount of TOC space used
11503 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11504 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11505 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11506 generate code to calculate the sum of an address and a constant at
11507 run-time instead of putting that sum into the TOC@.  You may specify one
11508 or both of these options.  Each causes GCC to produce very slightly
11509 slower and larger code at the expense of conserving TOC space.
11511 If you still run out of space in the TOC even when you specify both of
11512 these options, specify @option{-mminimal-toc} instead.  This option causes
11513 GCC to make only one TOC entry for every file.  When you specify this
11514 option, GCC will produce code that is slower and larger but which
11515 uses extremely little TOC space.  You may wish to use this option
11516 only on files that contain less frequently executed code.
11518 @item -maix64
11519 @itemx -maix32
11520 @opindex maix64
11521 @opindex maix32
11522 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11523 @code{long} type, and the infrastructure needed to support them.
11524 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11525 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11526 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11528 @item -mxl-compat
11529 @itemx -mno-xl-compat
11530 @opindex mxl-compat
11531 @opindex mno-xl-compat
11532 Produce code that conforms more closely to IBM XL compiler semantics
11533 when using AIX-compatible ABI.  Pass floating-point arguments to
11534 prototyped functions beyond the register save area (RSA) on the stack
11535 in addition to argument FPRs.  Do not assume that most significant
11536 double in 128-bit long double value is properly rounded when comparing
11537 values and converting to double.  Use XL symbol names for long double
11538 support routines.
11540 The AIX calling convention was extended but not initially documented to
11541 handle an obscure K&R C case of calling a function that takes the
11542 address of its arguments with fewer arguments than declared.  IBM XL
11543 compilers access floating point arguments which do not fit in the
11544 RSA from the stack when a subroutine is compiled without
11545 optimization.  Because always storing floating-point arguments on the
11546 stack is inefficient and rarely needed, this option is not enabled by
11547 default and only is necessary when calling subroutines compiled by IBM
11548 XL compilers without optimization.
11550 @item -mpe
11551 @opindex mpe
11552 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11553 application written to use message passing with special startup code to
11554 enable the application to run.  The system must have PE installed in the
11555 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11556 must be overridden with the @option{-specs=} option to specify the
11557 appropriate directory location.  The Parallel Environment does not
11558 support threads, so the @option{-mpe} option and the @option{-pthread}
11559 option are incompatible.
11561 @item -malign-natural
11562 @itemx -malign-power
11563 @opindex malign-natural
11564 @opindex malign-power
11565 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11566 @option{-malign-natural} overrides the ABI-defined alignment of larger
11567 types, such as floating-point doubles, on their natural size-based boundary.
11568 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11569 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11571 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11572 is not supported.
11574 @item -msoft-float
11575 @itemx -mhard-float
11576 @opindex msoft-float
11577 @opindex mhard-float
11578 Generate code that does not use (uses) the floating-point register set.
11579 Software floating point emulation is provided if you use the
11580 @option{-msoft-float} option, and pass the option to GCC when linking.
11582 @item -mmultiple
11583 @itemx -mno-multiple
11584 @opindex mmultiple
11585 @opindex mno-multiple
11586 Generate code that uses (does not use) the load multiple word
11587 instructions and the store multiple word instructions.  These
11588 instructions are generated by default on POWER systems, and not
11589 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11590 endian PowerPC systems, since those instructions do not work when the
11591 processor is in little endian mode.  The exceptions are PPC740 and
11592 PPC750 which permit the instructions usage in little endian mode.
11594 @item -mstring
11595 @itemx -mno-string
11596 @opindex mstring
11597 @opindex mno-string
11598 Generate code that uses (does not use) the load string instructions
11599 and the store string word instructions to save multiple registers and
11600 do small block moves.  These instructions are generated by default on
11601 POWER systems, and not generated on PowerPC systems.  Do not use
11602 @option{-mstring} on little endian PowerPC systems, since those
11603 instructions do not work when the processor is in little endian mode.
11604 The exceptions are PPC740 and PPC750 which permit the instructions
11605 usage in little endian mode.
11607 @item -mupdate
11608 @itemx -mno-update
11609 @opindex mupdate
11610 @opindex mno-update
11611 Generate code that uses (does not use) the load or store instructions
11612 that update the base register to the address of the calculated memory
11613 location.  These instructions are generated by default.  If you use
11614 @option{-mno-update}, there is a small window between the time that the
11615 stack pointer is updated and the address of the previous frame is
11616 stored, which means code that walks the stack frame across interrupts or
11617 signals may get corrupted data.
11619 @item -mfused-madd
11620 @itemx -mno-fused-madd
11621 @opindex mfused-madd
11622 @opindex mno-fused-madd
11623 Generate code that uses (does not use) the floating point multiply and
11624 accumulate instructions.  These instructions are generated by default if
11625 hardware floating is used.
11627 @item -mmulhw
11628 @itemx -mno-mulhw
11629 @opindex mmulhw
11630 @opindex mno-mulhw
11631 Generate code that uses (does not use) the half-word multiply and
11632 multiply-accumulate instructions on the IBM 405 and 440 processors.
11633 These instructions are generated by default when targetting those
11634 processors.
11636 @item -mdlmzb
11637 @itemx -mno-dlmzb
11638 @opindex mdlmzb
11639 @opindex mno-dlmzb
11640 Generate code that uses (does not use) the string-search @samp{dlmzb}
11641 instruction on the IBM 405 and 440 processors.  This instruction is
11642 generated by default when targetting those processors.
11644 @item -mno-bit-align
11645 @itemx -mbit-align
11646 @opindex mno-bit-align
11647 @opindex mbit-align
11648 On System V.4 and embedded PowerPC systems do not (do) force structures
11649 and unions that contain bit-fields to be aligned to the base type of the
11650 bit-field.
11652 For example, by default a structure containing nothing but 8
11653 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11654 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11655 the structure would be aligned to a 1 byte boundary and be one byte in
11656 size.
11658 @item -mno-strict-align
11659 @itemx -mstrict-align
11660 @opindex mno-strict-align
11661 @opindex mstrict-align
11662 On System V.4 and embedded PowerPC systems do not (do) assume that
11663 unaligned memory references will be handled by the system.
11665 @item -mrelocatable
11666 @itemx -mno-relocatable
11667 @opindex mrelocatable
11668 @opindex mno-relocatable
11669 On embedded PowerPC systems generate code that allows (does not allow)
11670 the program to be relocated to a different address at runtime.  If you
11671 use @option{-mrelocatable} on any module, all objects linked together must
11672 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11674 @item -mrelocatable-lib
11675 @itemx -mno-relocatable-lib
11676 @opindex mrelocatable-lib
11677 @opindex mno-relocatable-lib
11678 On embedded PowerPC systems generate code that allows (does not allow)
11679 the program to be relocated to a different address at runtime.  Modules
11680 compiled with @option{-mrelocatable-lib} can be linked with either modules
11681 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11682 with modules compiled with the @option{-mrelocatable} options.
11684 @item -mno-toc
11685 @itemx -mtoc
11686 @opindex mno-toc
11687 @opindex mtoc
11688 On System V.4 and embedded PowerPC systems do not (do) assume that
11689 register 2 contains a pointer to a global area pointing to the addresses
11690 used in the program.
11692 @item -mlittle
11693 @itemx -mlittle-endian
11694 @opindex mlittle
11695 @opindex mlittle-endian
11696 On System V.4 and embedded PowerPC systems compile code for the
11697 processor in little endian mode.  The @option{-mlittle-endian} option is
11698 the same as @option{-mlittle}.
11700 @item -mbig
11701 @itemx -mbig-endian
11702 @opindex mbig
11703 @opindex mbig-endian
11704 On System V.4 and embedded PowerPC systems compile code for the
11705 processor in big endian mode.  The @option{-mbig-endian} option is
11706 the same as @option{-mbig}.
11708 @item -mdynamic-no-pic
11709 @opindex mdynamic-no-pic
11710 On Darwin and Mac OS X systems, compile code so that it is not
11711 relocatable, but that its external references are relocatable.  The
11712 resulting code is suitable for applications, but not shared
11713 libraries.
11715 @item -mprioritize-restricted-insns=@var{priority}
11716 @opindex mprioritize-restricted-insns
11717 This option controls the priority that is assigned to
11718 dispatch-slot restricted instructions during the second scheduling
11719 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11720 @var{no/highest/second-highest} priority to dispatch slot restricted
11721 instructions.
11723 @item -msched-costly-dep=@var{dependence_type}
11724 @opindex msched-costly-dep
11725 This option controls which dependences are considered costly
11726 by the target during instruction scheduling.  The argument
11727 @var{dependence_type} takes one of the following values:
11728 @var{no}: no dependence is costly,
11729 @var{all}: all dependences are costly,
11730 @var{true_store_to_load}: a true dependence from store to load is costly,
11731 @var{store_to_load}: any dependence from store to load is costly,
11732 @var{number}: any dependence which latency >= @var{number} is costly.
11734 @item -minsert-sched-nops=@var{scheme}
11735 @opindex minsert-sched-nops
11736 This option controls which nop insertion scheme will be used during
11737 the second scheduling pass.  The argument @var{scheme} takes one of the
11738 following values:
11739 @var{no}: Don't insert nops.
11740 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11741 according to the scheduler's grouping.
11742 @var{regroup_exact}: Insert nops to force costly dependent insns into
11743 separate groups.  Insert exactly as many nops as needed to force an insn
11744 to a new group, according to the estimated processor grouping.
11745 @var{number}: Insert nops to force costly dependent insns into
11746 separate groups.  Insert @var{number} nops to force an insn to a new group.
11748 @item -mcall-sysv
11749 @opindex mcall-sysv
11750 On System V.4 and embedded PowerPC systems compile code using calling
11751 conventions that adheres to the March 1995 draft of the System V
11752 Application Binary Interface, PowerPC processor supplement.  This is the
11753 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11755 @item -mcall-sysv-eabi
11756 @opindex mcall-sysv-eabi
11757 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11759 @item -mcall-sysv-noeabi
11760 @opindex mcall-sysv-noeabi
11761 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11763 @item -mcall-solaris
11764 @opindex mcall-solaris
11765 On System V.4 and embedded PowerPC systems compile code for the Solaris
11766 operating system.
11768 @item -mcall-linux
11769 @opindex mcall-linux
11770 On System V.4 and embedded PowerPC systems compile code for the
11771 Linux-based GNU system.
11773 @item -mcall-gnu
11774 @opindex mcall-gnu
11775 On System V.4 and embedded PowerPC systems compile code for the
11776 Hurd-based GNU system.
11778 @item -mcall-netbsd
11779 @opindex mcall-netbsd
11780 On System V.4 and embedded PowerPC systems compile code for the
11781 NetBSD operating system.
11783 @item -maix-struct-return
11784 @opindex maix-struct-return
11785 Return all structures in memory (as specified by the AIX ABI)@.
11787 @item -msvr4-struct-return
11788 @opindex msvr4-struct-return
11789 Return structures smaller than 8 bytes in registers (as specified by the
11790 SVR4 ABI)@.
11792 @item -mabi=@var{abi-type}
11793 @opindex mabi
11794 Extend the current ABI with a particular extension, or remove such extension.
11795 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11796 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
11798 @item -mabi=spe
11799 @opindex mabi=spe
11800 Extend the current ABI with SPE ABI extensions.  This does not change
11801 the default ABI, instead it adds the SPE ABI extensions to the current
11802 ABI@.
11804 @item -mabi=no-spe
11805 @opindex mabi=no-spe
11806 Disable Booke SPE ABI extensions for the current ABI@.
11808 @item -mabi=ibmlongdouble
11809 @opindex mabi=ibmlongdouble
11810 Change the current ABI to use IBM extended precision long double.
11811 This is a PowerPC 32-bit SYSV ABI option.
11813 @item -mabi=ieeelongdouble
11814 @opindex mabi=ieeelongdouble
11815 Change the current ABI to use IEEE extended precision long double.
11816 This is a PowerPC 32-bit Linux ABI option.
11818 @item -mprototype
11819 @itemx -mno-prototype
11820 @opindex mprototype
11821 @opindex mno-prototype
11822 On System V.4 and embedded PowerPC systems assume that all calls to
11823 variable argument functions are properly prototyped.  Otherwise, the
11824 compiler must insert an instruction before every non prototyped call to
11825 set or clear bit 6 of the condition code register (@var{CR}) to
11826 indicate whether floating point values were passed in the floating point
11827 registers in case the function takes a variable arguments.  With
11828 @option{-mprototype}, only calls to prototyped variable argument functions
11829 will set or clear the bit.
11831 @item -msim
11832 @opindex msim
11833 On embedded PowerPC systems, assume that the startup module is called
11834 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11835 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11836 configurations.
11838 @item -mmvme
11839 @opindex mmvme
11840 On embedded PowerPC systems, assume that the startup module is called
11841 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11842 @file{libc.a}.
11844 @item -mads
11845 @opindex mads
11846 On embedded PowerPC systems, assume that the startup module is called
11847 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11848 @file{libc.a}.
11850 @item -myellowknife
11851 @opindex myellowknife
11852 On embedded PowerPC systems, assume that the startup module is called
11853 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11854 @file{libc.a}.
11856 @item -mvxworks
11857 @opindex mvxworks
11858 On System V.4 and embedded PowerPC systems, specify that you are
11859 compiling for a VxWorks system.
11861 @item -mwindiss
11862 @opindex mwindiss
11863 Specify that you are compiling for the WindISS simulation environment.
11865 @item -memb
11866 @opindex memb
11867 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11868 header to indicate that @samp{eabi} extended relocations are used.
11870 @item -meabi
11871 @itemx -mno-eabi
11872 @opindex meabi
11873 @opindex mno-eabi
11874 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11875 Embedded Applications Binary Interface (eabi) which is a set of
11876 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11877 means that the stack is aligned to an 8 byte boundary, a function
11878 @code{__eabi} is called to from @code{main} to set up the eabi
11879 environment, and the @option{-msdata} option can use both @code{r2} and
11880 @code{r13} to point to two separate small data areas.  Selecting
11881 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11882 do not call an initialization function from @code{main}, and the
11883 @option{-msdata} option will only use @code{r13} to point to a single
11884 small data area.  The @option{-meabi} option is on by default if you
11885 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11887 @item -msdata=eabi
11888 @opindex msdata=eabi
11889 On System V.4 and embedded PowerPC systems, put small initialized
11890 @code{const} global and static data in the @samp{.sdata2} section, which
11891 is pointed to by register @code{r2}.  Put small initialized
11892 non-@code{const} global and static data in the @samp{.sdata} section,
11893 which is pointed to by register @code{r13}.  Put small uninitialized
11894 global and static data in the @samp{.sbss} section, which is adjacent to
11895 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11896 incompatible with the @option{-mrelocatable} option.  The
11897 @option{-msdata=eabi} option also sets the @option{-memb} option.
11899 @item -msdata=sysv
11900 @opindex msdata=sysv
11901 On System V.4 and embedded PowerPC systems, put small global and static
11902 data in the @samp{.sdata} section, which is pointed to by register
11903 @code{r13}.  Put small uninitialized global and static data in the
11904 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11905 The @option{-msdata=sysv} option is incompatible with the
11906 @option{-mrelocatable} option.
11908 @item -msdata=default
11909 @itemx -msdata
11910 @opindex msdata=default
11911 @opindex msdata
11912 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11913 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11914 same as @option{-msdata=sysv}.
11916 @item -msdata-data
11917 @opindex msdata-data
11918 On System V.4 and embedded PowerPC systems, put small global
11919 data in the @samp{.sdata} section.  Put small uninitialized global
11920 data in the @samp{.sbss} section.  Do not use register @code{r13}
11921 to address small data however.  This is the default behavior unless
11922 other @option{-msdata} options are used.
11924 @item -msdata=none
11925 @itemx -mno-sdata
11926 @opindex msdata=none
11927 @opindex mno-sdata
11928 On embedded PowerPC systems, put all initialized global and static data
11929 in the @samp{.data} section, and all uninitialized data in the
11930 @samp{.bss} section.
11932 @item -G @var{num}
11933 @opindex G
11934 @cindex smaller data references (PowerPC)
11935 @cindex .sdata/.sdata2 references (PowerPC)
11936 On embedded PowerPC systems, put global and static items less than or
11937 equal to @var{num} bytes into the small data or bss sections instead of
11938 the normal data or bss section.  By default, @var{num} is 8.  The
11939 @option{-G @var{num}} switch is also passed to the linker.
11940 All modules should be compiled with the same @option{-G @var{num}} value.
11942 @item -mregnames
11943 @itemx -mno-regnames
11944 @opindex mregnames
11945 @opindex mno-regnames
11946 On System V.4 and embedded PowerPC systems do (do not) emit register
11947 names in the assembly language output using symbolic forms.
11949 @item -mlongcall
11950 @itemx -mno-longcall
11951 @opindex mlongcall
11952 @opindex mno-longcall
11953 By default assume that all calls are far away so that a longer more
11954 expensive calling sequence is required.  This is required for calls
11955 further than 32 megabytes (33,554,432 bytes) from the current location.
11956 A short call will be generated if the compiler knows
11957 the call cannot be that far away.  This setting can be overridden by
11958 the @code{shortcall} function attribute, or by @code{#pragma
11959 longcall(0)}.
11961 Some linkers are capable of detecting out-of-range calls and generating
11962 glue code on the fly.  On these systems, long calls are unnecessary and
11963 generate slower code.  As of this writing, the AIX linker can do this,
11964 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11965 to the GNU linker for 32-bit PowerPC systems as well.
11967 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11968 callee, L42'', plus a ``branch island'' (glue code).  The two target
11969 addresses represent the callee and the ``branch island''.  The
11970 Darwin/PPC linker will prefer the first address and generate a ``bl
11971 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11972 otherwise, the linker will generate ``bl L42'' to call the ``branch
11973 island''.  The ``branch island'' is appended to the body of the
11974 calling function; it computes the full 32-bit address of the callee
11975 and jumps to it.
11977 On Mach-O (Darwin) systems, this option directs the compiler emit to
11978 the glue for every direct call, and the Darwin linker decides whether
11979 to use or discard it.
11981 In the future, we may cause GCC to ignore all longcall specifications
11982 when the linker is known to generate glue.
11984 @item -pthread
11985 @opindex pthread
11986 Adds support for multithreading with the @dfn{pthreads} library.
11987 This option sets flags for both the preprocessor and linker.
11989 @end table
11991 @node S/390 and zSeries Options
11992 @subsection S/390 and zSeries Options
11993 @cindex S/390 and zSeries Options
11995 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11997 @table @gcctabopt
11998 @item -mhard-float
11999 @itemx -msoft-float
12000 @opindex mhard-float
12001 @opindex msoft-float
12002 Use (do not use) the hardware floating-point instructions and registers
12003 for floating-point operations.  When @option{-msoft-float} is specified,
12004 functions in @file{libgcc.a} will be used to perform floating-point
12005 operations.  When @option{-mhard-float} is specified, the compiler
12006 generates IEEE floating-point instructions.  This is the default.
12008 @item -mlong-double-64
12009 @itemx -mlong-double-128
12010 @opindex mlong-double-64
12011 @opindex mlong-double-128
12012 These switches control the size of @code{long double} type. A size
12013 of 64bit makes the @code{long double} type equivalent to the @code{double}
12014 type. This is the default.
12016 @item -mbackchain
12017 @itemx -mno-backchain
12018 @opindex mbackchain
12019 @opindex mno-backchain
12020 Store (do not store) the address of the caller's frame as backchain pointer
12021 into the callee's stack frame.
12022 A backchain may be needed to allow debugging using tools that do not understand
12023 DWARF-2 call frame information.
12024 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
12025 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
12026 the backchain is placed into the topmost word of the 96/160 byte register
12027 save area.
12029 In general, code compiled with @option{-mbackchain} is call-compatible with
12030 code compiled with @option{-mmo-backchain}; however, use of the backchain
12031 for debugging purposes usually requires that the whole binary is built with
12032 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
12033 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
12034 to build a linux kernel use @option{-msoft-float}.
12036 The default is to not maintain the backchain.
12038 @item -mpacked-stack
12039 @item -mno-packed-stack
12040 @opindex mpacked-stack
12041 @opindex mno-packed-stack
12042 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
12043 specified, the compiler uses the all fields of the 96/160 byte register save
12044 area only for their default purpose; unused fields still take up stack space.
12045 When @option{-mpacked-stack} is specified, register save slots are densely
12046 packed at the top of the register save area; unused space is reused for other
12047 purposes, allowing for more efficient use of the available stack space.
12048 However, when @option{-mbackchain} is also in effect, the topmost word of
12049 the save area is always used to store the backchain, and the return address
12050 register is always saved two words below the backchain.
12052 As long as the stack frame backchain is not used, code generated with
12053 @option{-mpacked-stack} is call-compatible with code generated with
12054 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
12055 S/390 or zSeries generated code that uses the stack frame backchain at run
12056 time, not just for debugging purposes.  Such code is not call-compatible
12057 with code compiled with @option{-mpacked-stack}.  Also, note that the
12058 combination of @option{-mbackchain},
12059 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
12060 to build a linux kernel use @option{-msoft-float}.
12062 The default is to not use the packed stack layout.
12064 @item -msmall-exec
12065 @itemx -mno-small-exec
12066 @opindex msmall-exec
12067 @opindex mno-small-exec
12068 Generate (or do not generate) code using the @code{bras} instruction
12069 to do subroutine calls.
12070 This only works reliably if the total executable size does not
12071 exceed 64k.  The default is to use the @code{basr} instruction instead,
12072 which does not have this limitation.
12074 @item -m64
12075 @itemx -m31
12076 @opindex m64
12077 @opindex m31
12078 When @option{-m31} is specified, generate code compliant to the
12079 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
12080 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
12081 particular to generate 64-bit instructions.  For the @samp{s390}
12082 targets, the default is @option{-m31}, while the @samp{s390x}
12083 targets default to @option{-m64}.
12085 @item -mzarch
12086 @itemx -mesa
12087 @opindex mzarch
12088 @opindex mesa
12089 When @option{-mzarch} is specified, generate code using the
12090 instructions available on z/Architecture.
12091 When @option{-mesa} is specified, generate code using the
12092 instructions available on ESA/390.  Note that @option{-mesa} is
12093 not possible with @option{-m64}.
12094 When generating code compliant to the GNU/Linux for S/390 ABI,
12095 the default is @option{-mesa}.  When generating code compliant
12096 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
12098 @item -mmvcle
12099 @itemx -mno-mvcle
12100 @opindex mmvcle
12101 @opindex mno-mvcle
12102 Generate (or do not generate) code using the @code{mvcle} instruction
12103 to perform block moves.  When @option{-mno-mvcle} is specified,
12104 use a @code{mvc} loop instead.  This is the default unless optimizing for
12105 size.
12107 @item -mdebug
12108 @itemx -mno-debug
12109 @opindex mdebug
12110 @opindex mno-debug
12111 Print (or do not print) additional debug information when compiling.
12112 The default is to not print debug information.
12114 @item -march=@var{cpu-type}
12115 @opindex march
12116 Generate code that will run on @var{cpu-type}, which is the name of a system
12117 representing a certain processor type.  Possible values for
12118 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
12119 When generating code using the instructions available on z/Architecture,
12120 the default is @option{-march=z900}.  Otherwise, the default is
12121 @option{-march=g5}.
12123 @item -mtune=@var{cpu-type}
12124 @opindex mtune
12125 Tune to @var{cpu-type} everything applicable about the generated code,
12126 except for the ABI and the set of available instructions.
12127 The list of @var{cpu-type} values is the same as for @option{-march}.
12128 The default is the value used for @option{-march}.
12130 @item -mtpf-trace
12131 @itemx -mno-tpf-trace
12132 @opindex mtpf-trace
12133 @opindex mno-tpf-trace
12134 Generate code that adds (does not add) in TPF OS specific branches to trace
12135 routines in the operating system.  This option is off by default, even
12136 when compiling for the TPF OS@.
12138 @item -mfused-madd
12139 @itemx -mno-fused-madd
12140 @opindex mfused-madd
12141 @opindex mno-fused-madd
12142 Generate code that uses (does not use) the floating point multiply and
12143 accumulate instructions.  These instructions are generated by default if
12144 hardware floating point is used.
12146 @item -mwarn-framesize=@var{framesize}
12147 @opindex mwarn-framesize
12148 Emit a warning if the current function exceeds the given frame size.  Because
12149 this is a compile time check it doesn't need to be a real problem when the program
12150 runs.  It is intended to identify functions which most probably cause
12151 a stack overflow.  It is useful to be used in an environment with limited stack
12152 size e.g.@: the linux kernel.
12154 @item -mwarn-dynamicstack
12155 @opindex mwarn-dynamicstack
12156 Emit a warning if the function calls alloca or uses dynamically
12157 sized arrays.  This is generally a bad idea with a limited stack size.
12159 @item -mstack-guard=@var{stack-guard}
12160 @item -mstack-size=@var{stack-size}
12161 @opindex mstack-guard
12162 @opindex mstack-size
12163 These arguments always have to be used in conjunction.  If they are present the s390
12164 back end emits additional instructions in the function prologue which trigger a trap
12165 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
12166 (remember that the stack on s390 grows downward).  These options are intended to
12167 be used to help debugging stack overflow problems.  The additionally emitted code
12168 causes only little overhead and hence can also be used in production like systems
12169 without greater performance degradation.  The given values have to be exact
12170 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
12171 exceeding 64k.
12172 In order to be efficient the extra code makes the assumption that the stack starts
12173 at an address aligned to the value given by @var{stack-size}.
12174 @end table
12176 @node Score Options
12177 @subsection Score Options
12178 @cindex Score Options
12180 These options are defined for Score implementations:
12182 @table @gcctabopt
12183 @item -mel
12184 @opindex -mel
12185 Compile code for little endian mode. 
12187 @item -meb
12188 @opindex meb
12189 Compile code for big endian mode.  This is the default.
12191 @item -mmac
12192 @opindex mmac
12193 Enable the use of multiply-accumulate instructions. Disabled by default. 
12195 @item -mscore5u
12196 @opindex mscore5u
12197 Specify the SCORE5U of the target architecture.
12199 @item -mscore7
12200 @opindex mscore7
12201 Specify the SCORE7 of the target architecture. This is the default.
12202 @end table
12204 @node SH Options
12205 @subsection SH Options
12207 These @samp{-m} options are defined for the SH implementations:
12209 @table @gcctabopt
12210 @item -m1
12211 @opindex m1
12212 Generate code for the SH1.
12214 @item -m2
12215 @opindex m2
12216 Generate code for the SH2.
12218 @item -m2e
12219 Generate code for the SH2e.
12221 @item -m3
12222 @opindex m3
12223 Generate code for the SH3.
12225 @item -m3e
12226 @opindex m3e
12227 Generate code for the SH3e.
12229 @item -m4-nofpu
12230 @opindex m4-nofpu
12231 Generate code for the SH4 without a floating-point unit.
12233 @item -m4-single-only
12234 @opindex m4-single-only
12235 Generate code for the SH4 with a floating-point unit that only
12236 supports single-precision arithmetic.
12238 @item -m4-single
12239 @opindex m4-single
12240 Generate code for the SH4 assuming the floating-point unit is in
12241 single-precision mode by default.
12243 @item -m4
12244 @opindex m4
12245 Generate code for the SH4.
12247 @item -m4a-nofpu
12248 @opindex m4a-nofpu
12249 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
12250 floating-point unit is not used.
12252 @item -m4a-single-only
12253 @opindex m4a-single-only
12254 Generate code for the SH4a, in such a way that no double-precision
12255 floating point operations are used.
12257 @item -m4a-single
12258 @opindex m4a-single
12259 Generate code for the SH4a assuming the floating-point unit is in
12260 single-precision mode by default.
12262 @item -m4a
12263 @opindex m4a
12264 Generate code for the SH4a.
12266 @item -m4al
12267 @opindex m4al
12268 Same as @option{-m4a-nofpu}, except that it implicitly passes
12269 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
12270 instructions at the moment.
12272 @item -mb
12273 @opindex mb
12274 Compile code for the processor in big endian mode.
12276 @item -ml
12277 @opindex ml
12278 Compile code for the processor in little endian mode.
12280 @item -mdalign
12281 @opindex mdalign
12282 Align doubles at 64-bit boundaries.  Note that this changes the calling
12283 conventions, and thus some functions from the standard C library will
12284 not work unless you recompile it first with @option{-mdalign}.
12286 @item -mrelax
12287 @opindex mrelax
12288 Shorten some address references at link time, when possible; uses the
12289 linker option @option{-relax}.
12291 @item -mbigtable
12292 @opindex mbigtable
12293 Use 32-bit offsets in @code{switch} tables.  The default is to use
12294 16-bit offsets.
12296 @item -mfmovd
12297 @opindex mfmovd
12298 Enable the use of the instruction @code{fmovd}.
12300 @item -mhitachi
12301 @opindex mhitachi
12302 Comply with the calling conventions defined by Renesas.
12304 @item -mrenesas
12305 @opindex mhitachi
12306 Comply with the calling conventions defined by Renesas.
12308 @item -mno-renesas
12309 @opindex mhitachi
12310 Comply with the calling conventions defined for GCC before the Renesas
12311 conventions were available.  This option is the default for all
12312 targets of the SH toolchain except for @samp{sh-symbianelf}.
12314 @item -mnomacsave
12315 @opindex mnomacsave
12316 Mark the @code{MAC} register as call-clobbered, even if
12317 @option{-mhitachi} is given.
12319 @item -mieee
12320 @opindex mieee
12321 Increase IEEE-compliance of floating-point code.
12322 At the moment, this is equivalent to @option{-fno-finite-math-only}.
12323 When generating 16 bit SH opcodes, getting IEEE-conforming results for
12324 comparisons of NANs / infinities incurs extra overhead in every
12325 floating point comparison, therefore the default is set to
12326 @option{-ffinite-math-only}.
12328 @item -misize
12329 @opindex misize
12330 Dump instruction size and location in the assembly code.
12332 @item -mpadstruct
12333 @opindex mpadstruct
12334 This option is deprecated.  It pads structures to multiple of 4 bytes,
12335 which is incompatible with the SH ABI@.
12337 @item -mspace
12338 @opindex mspace
12339 Optimize for space instead of speed.  Implied by @option{-Os}.
12341 @item -mprefergot
12342 @opindex mprefergot
12343 When generating position-independent code, emit function calls using
12344 the Global Offset Table instead of the Procedure Linkage Table.
12346 @item -musermode
12347 @opindex musermode
12348 Generate a library function call to invalidate instruction cache
12349 entries, after fixing up a trampoline.  This library function call
12350 doesn't assume it can write to the whole memory address space.  This
12351 is the default when the target is @code{sh-*-linux*}.
12353 @item -multcost=@var{number}
12354 @opindex multcost=@var{number}
12355 Set the cost to assume for a multiply insn.
12357 @item -mdiv=@var{strategy}
12358 @opindex mdiv=@var{strategy}
12359 Set the division strategy to use for SHmedia code.  @var{strategy} must be
12360 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
12361 inv:call2, inv:fp .
12362 "fp" performs the operation in floating point.  This has a very high latency,
12363 but needs only a few instructions, so it might be a good choice if
12364 your code has enough easily exploitable ILP to allow the compiler to
12365 schedule the floating point instructions together with other instructions.
12366 Division by zero causes a floating point exception.
12367 "inv" uses integer operations to calculate the inverse of the divisor,
12368 and then multiplies the dividend with the inverse.  This strategy allows
12369 cse and hoisting of the inverse calculation.  Division by zero calculates
12370 an unspecified result, but does not trap.
12371 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
12372 have been found, or if the entire operation has been hoisted to the same
12373 place, the last stages of the inverse calculation are intertwined with the
12374 final multiply to reduce the overall latency, at the expense of using a few
12375 more instructions, and thus offering fewer scheduling opportunities with
12376 other code.
12377 "call" calls a library function that usually implements the inv:minlat
12378 strategy.
12379 This gives high code density for m5-*media-nofpu compilations.
12380 "call2" uses a different entry point of the same library function, where it
12381 assumes that a pointer to a lookup table has already been set up, which
12382 exposes the pointer load to cse / code hoisting optimizations.
12383 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
12384 code generation, but if the code stays unoptimized, revert to the "call",
12385 "call2", or "fp" strategies, respectively.  Note that the
12386 potentially-trapping side effect of division by zero is carried by a
12387 separate instruction, so it is possible that all the integer instructions
12388 are hoisted out, but the marker for the side effect stays where it is.
12389 A recombination to fp operations or a call is not possible in that case.
12390 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
12391 that the inverse calculation was nor separated from the multiply, they speed
12392 up division where the dividend fits into 20 bits (plus sign where applicable),
12393 by inserting a test to skip a number of operations in this case; this test
12394 slows down the case of larger dividends.  inv20u assumes the case of a such
12395 a small dividend to be unlikely, and inv20l assumes it to be likely.
12397 @item -mdivsi3_libfunc=@var{name}
12398 @opindex mdivsi3_libfunc=@var{name}
12399 Set the name of the library function used for 32 bit signed division to
12400 @var{name}.  This only affect the name used in the call and inv:call
12401 division strategies, and the compiler will still expect the same
12402 sets of input/output/clobbered registers as if this option was not present.
12404 @item -madjust-unroll
12405 @opindex madjust-unroll
12406 Throttle unrolling to avoid thrashing target registers.
12407 This option only has an effect if the gcc code base supports the
12408 TARGET_ADJUST_UNROLL_MAX target hook.
12410 @item -mindexed-addressing
12411 @opindex mindexed-addressing
12412 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12413 This is only safe if the hardware and/or OS implement 32 bit wrap-around
12414 semantics for the indexed addressing mode.  The architecture allows the
12415 implementation of processors with 64 bit MMU, which the OS could use to
12416 get 32 bit addressing, but since no current hardware implementation supports
12417 this or any other way to make the indexed addressing mode safe to use in
12418 the 32 bit ABI, the default is -mno-indexed-addressing.
12420 @item -mgettrcost=@var{number}
12421 @opindex mgettrcost=@var{number}
12422 Set the cost assumed for the gettr instruction to @var{number}.
12423 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12425 @item -mpt-fixed
12426 @opindex mpt-fixed
12427 Assume pt* instructions won't trap.  This will generally generate better
12428 scheduled code, but is unsafe on current hardware.  The current architecture
12429 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12430 This has the unintentional effect of making it unsafe to schedule ptabs /
12431 ptrel before a branch, or hoist it out of a loop.  For example,
12432 __do_global_ctors, a part of libgcc that runs constructors at program
12433 startup, calls functions in a list which is delimited by -1.  With the
12434 -mpt-fixed option, the ptabs will be done before testing against -1.
12435 That means that all the constructors will be run a bit quicker, but when
12436 the loop comes to the end of the list, the program crashes because ptabs
12437 loads -1 into a target register.  Since this option is unsafe for any
12438 hardware implementing the current architecture specification, the default
12439 is -mno-pt-fixed.  Unless the user specifies a specific cost with
12440 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12441 this deters register allocation using target registers for storing
12442 ordinary integers.
12444 @item -minvalid-symbols
12445 @opindex minvalid-symbols
12446 Assume symbols might be invalid.  Ordinary function symbols generated by
12447 the compiler will always be valid to load with movi/shori/ptabs or
12448 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12449 to generate symbols that will cause ptabs / ptrel to trap.
12450 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12451 It will then prevent cross-basic-block cse, hoisting and most scheduling
12452 of symbol loads.  The default is @option{-mno-invalid-symbols}.
12453 @end table
12455 @node SPARC Options
12456 @subsection SPARC Options
12457 @cindex SPARC options
12459 These @samp{-m} options are supported on the SPARC:
12461 @table @gcctabopt
12462 @item -mno-app-regs
12463 @itemx -mapp-regs
12464 @opindex mno-app-regs
12465 @opindex mapp-regs
12466 Specify @option{-mapp-regs} to generate output using the global registers
12467 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12468 is the default.
12470 To be fully SVR4 ABI compliant at the cost of some performance loss,
12471 specify @option{-mno-app-regs}.  You should compile libraries and system
12472 software with this option.
12474 @item -mfpu
12475 @itemx -mhard-float
12476 @opindex mfpu
12477 @opindex mhard-float
12478 Generate output containing floating point instructions.  This is the
12479 default.
12481 @item -mno-fpu
12482 @itemx -msoft-float
12483 @opindex mno-fpu
12484 @opindex msoft-float
12485 Generate output containing library calls for floating point.
12486 @strong{Warning:} the requisite libraries are not available for all SPARC
12487 targets.  Normally the facilities of the machine's usual C compiler are
12488 used, but this cannot be done directly in cross-compilation.  You must make
12489 your own arrangements to provide suitable library functions for
12490 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12491 @samp{sparclite-*-*} do provide software floating point support.
12493 @option{-msoft-float} changes the calling convention in the output file;
12494 therefore, it is only useful if you compile @emph{all} of a program with
12495 this option.  In particular, you need to compile @file{libgcc.a}, the
12496 library that comes with GCC, with @option{-msoft-float} in order for
12497 this to work.
12499 @item -mhard-quad-float
12500 @opindex mhard-quad-float
12501 Generate output containing quad-word (long double) floating point
12502 instructions.
12504 @item -msoft-quad-float
12505 @opindex msoft-quad-float
12506 Generate output containing library calls for quad-word (long double)
12507 floating point instructions.  The functions called are those specified
12508 in the SPARC ABI@.  This is the default.
12510 As of this writing, there are no SPARC implementations that have hardware
12511 support for the quad-word floating point instructions.  They all invoke
12512 a trap handler for one of these instructions, and then the trap handler
12513 emulates the effect of the instruction.  Because of the trap handler overhead,
12514 this is much slower than calling the ABI library routines.  Thus the
12515 @option{-msoft-quad-float} option is the default.
12517 @item -mno-unaligned-doubles
12518 @itemx -munaligned-doubles
12519 @opindex mno-unaligned-doubles
12520 @opindex munaligned-doubles
12521 Assume that doubles have 8 byte alignment.  This is the default.
12523 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12524 alignment only if they are contained in another type, or if they have an
12525 absolute address.  Otherwise, it assumes they have 4 byte alignment.
12526 Specifying this option avoids some rare compatibility problems with code
12527 generated by other compilers.  It is not the default because it results
12528 in a performance loss, especially for floating point code.
12530 @item -mno-faster-structs
12531 @itemx -mfaster-structs
12532 @opindex mno-faster-structs
12533 @opindex mfaster-structs
12534 With @option{-mfaster-structs}, the compiler assumes that structures
12535 should have 8 byte alignment.  This enables the use of pairs of
12536 @code{ldd} and @code{std} instructions for copies in structure
12537 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12538 However, the use of this changed alignment directly violates the SPARC
12539 ABI@.  Thus, it's intended only for use on targets where the developer
12540 acknowledges that their resulting code will not be directly in line with
12541 the rules of the ABI@.
12543 @item -mimpure-text
12544 @opindex mimpure-text
12545 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12546 the compiler to not pass @option{-z text} to the linker when linking a
12547 shared object.  Using this option, you can link position-dependent
12548 code into a shared object.
12550 @option{-mimpure-text} suppresses the ``relocations remain against
12551 allocatable but non-writable sections'' linker error message.
12552 However, the necessary relocations will trigger copy-on-write, and the
12553 shared object is not actually shared across processes.  Instead of
12554 using @option{-mimpure-text}, you should compile all source code with
12555 @option{-fpic} or @option{-fPIC}.
12557 This option is only available on SunOS and Solaris.
12559 @item -mcpu=@var{cpu_type}
12560 @opindex mcpu
12561 Set the instruction set, register set, and instruction scheduling parameters
12562 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12563 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12564 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12565 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
12566 @samp{ultrasparc3}, and @samp{niagara}.
12568 Default instruction scheduling parameters are used for values that select
12569 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12570 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12572 Here is a list of each supported architecture and their supported
12573 implementations.
12575 @smallexample
12576     v7:             cypress
12577     v8:             supersparc, hypersparc
12578     sparclite:      f930, f934, sparclite86x
12579     sparclet:       tsc701
12580     v9:             ultrasparc, ultrasparc3, niagara
12581 @end smallexample
12583 By default (unless configured otherwise), GCC generates code for the V7
12584 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
12585 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12586 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12587 SPARCStation 1, 2, IPX etc.
12589 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12590 architecture.  The only difference from V7 code is that the compiler emits
12591 the integer multiply and integer divide instructions which exist in SPARC-V8
12592 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12593 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12594 2000 series.
12596 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12597 the SPARC architecture.  This adds the integer multiply, integer divide step
12598 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12599 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12600 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12601 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12602 MB86934 chip, which is the more recent SPARClite with FPU@.
12604 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12605 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12606 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12607 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12608 optimizes it for the TEMIC SPARClet chip.
12610 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12611 architecture.  This adds 64-bit integer and floating-point move instructions,
12612 3 additional floating-point condition code registers and conditional move
12613 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12614 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
12615 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12616 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
12617 @option{-mcpu=niagara}, the compiler additionally optimizes it for
12618 Sun UltraSPARC T1 chips.
12620 @item -mtune=@var{cpu_type}
12621 @opindex mtune
12622 Set the instruction scheduling parameters for machine type
12623 @var{cpu_type}, but do not set the instruction set or register set that the
12624 option @option{-mcpu=@var{cpu_type}} would.
12626 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12627 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12628 that select a particular cpu implementation.  Those are @samp{cypress},
12629 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12630 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
12631 @samp{ultrasparc3}, and @samp{niagara}.
12633 @item -mv8plus
12634 @itemx -mno-v8plus
12635 @opindex mv8plus
12636 @opindex mno-v8plus
12637 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12638 difference from the V8 ABI is that the global and out registers are
12639 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12640 mode for all SPARC-V9 processors.
12642 @item -mvis
12643 @itemx -mno-vis
12644 @opindex mvis
12645 @opindex mno-vis
12646 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12647 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12648 @end table
12650 These @samp{-m} options are supported in addition to the above
12651 on SPARC-V9 processors in 64-bit environments:
12653 @table @gcctabopt
12654 @item -mlittle-endian
12655 @opindex mlittle-endian
12656 Generate code for a processor running in little-endian mode.  It is only
12657 available for a few configurations and most notably not on Solaris and Linux.
12659 @item -m32
12660 @itemx -m64
12661 @opindex m32
12662 @opindex m64
12663 Generate code for a 32-bit or 64-bit environment.
12664 The 32-bit environment sets int, long and pointer to 32 bits.
12665 The 64-bit environment sets int to 32 bits and long and pointer
12666 to 64 bits.
12668 @item -mcmodel=medlow
12669 @opindex mcmodel=medlow
12670 Generate code for the Medium/Low code model: 64-bit addresses, programs
12671 must be linked in the low 32 bits of memory.  Programs can be statically
12672 or dynamically linked.
12674 @item -mcmodel=medmid
12675 @opindex mcmodel=medmid
12676 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12677 must be linked in the low 44 bits of memory, the text and data segments must
12678 be less than 2GB in size and the data segment must be located within 2GB of
12679 the text segment.
12681 @item -mcmodel=medany
12682 @opindex mcmodel=medany
12683 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12684 may be linked anywhere in memory, the text and data segments must be less
12685 than 2GB in size and the data segment must be located within 2GB of the
12686 text segment.
12688 @item -mcmodel=embmedany
12689 @opindex mcmodel=embmedany
12690 Generate code for the Medium/Anywhere code model for embedded systems:
12691 64-bit addresses, the text and data segments must be less than 2GB in
12692 size, both starting anywhere in memory (determined at link time).  The
12693 global register %g4 points to the base of the data segment.  Programs
12694 are statically linked and PIC is not supported.
12696 @item -mstack-bias
12697 @itemx -mno-stack-bias
12698 @opindex mstack-bias
12699 @opindex mno-stack-bias
12700 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12701 frame pointer if present, are offset by @minus{}2047 which must be added back
12702 when making stack frame references.  This is the default in 64-bit mode.
12703 Otherwise, assume no such offset is present.
12704 @end table
12706 These switches are supported in addition to the above on Solaris:
12708 @table @gcctabopt
12709 @item -threads
12710 @opindex threads
12711 Add support for multithreading using the Solaris threads library.  This
12712 option sets flags for both the preprocessor and linker.  This option does
12713 not affect the thread safety of object code produced by the compiler or
12714 that of libraries supplied with it.
12716 @item -pthreads
12717 @opindex pthreads
12718 Add support for multithreading using the POSIX threads library.  This
12719 option sets flags for both the preprocessor and linker.  This option does
12720 not affect the thread safety of object code produced  by the compiler or
12721 that of libraries supplied with it.
12723 @item -pthread
12724 @opindex pthread
12725 This is a synonym for @option{-pthreads}.
12726 @end table
12728 @node System V Options
12729 @subsection Options for System V
12731 These additional options are available on System V Release 4 for
12732 compatibility with other compilers on those systems:
12734 @table @gcctabopt
12735 @item -G
12736 @opindex G
12737 Create a shared object.
12738 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12740 @item -Qy
12741 @opindex Qy
12742 Identify the versions of each tool used by the compiler, in a
12743 @code{.ident} assembler directive in the output.
12745 @item -Qn
12746 @opindex Qn
12747 Refrain from adding @code{.ident} directives to the output file (this is
12748 the default).
12750 @item -YP,@var{dirs}
12751 @opindex YP
12752 Search the directories @var{dirs}, and no others, for libraries
12753 specified with @option{-l}.
12755 @item -Ym,@var{dir}
12756 @opindex Ym
12757 Look in the directory @var{dir} to find the M4 preprocessor.
12758 The assembler uses this option.
12759 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12760 @c the generic assembler that comes with Solaris takes just -Ym.
12761 @end table
12763 @node TMS320C3x/C4x Options
12764 @subsection TMS320C3x/C4x Options
12765 @cindex TMS320C3x/C4x Options
12767 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12769 @table @gcctabopt
12771 @item -mcpu=@var{cpu_type}
12772 @opindex mcpu
12773 Set the instruction set, register set, and instruction scheduling
12774 parameters for machine type @var{cpu_type}.  Supported values for
12775 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12776 @samp{c44}.  The default is @samp{c40} to generate code for the
12777 TMS320C40.
12779 @item -mbig-memory
12780 @itemx -mbig
12781 @itemx -msmall-memory
12782 @itemx -msmall
12783 @opindex mbig-memory
12784 @opindex mbig
12785 @opindex msmall-memory
12786 @opindex msmall
12787 Generates code for the big or small memory model.  The small memory
12788 model assumed that all data fits into one 64K word page.  At run-time
12789 the data page (DP) register must be set to point to the 64K page
12790 containing the .bss and .data program sections.  The big memory model is
12791 the default and requires reloading of the DP register for every direct
12792 memory access.
12794 @item -mbk
12795 @itemx -mno-bk
12796 @opindex mbk
12797 @opindex mno-bk
12798 Allow (disallow) allocation of general integer operands into the block
12799 count register BK@.
12801 @item -mdb
12802 @itemx -mno-db
12803 @opindex mdb
12804 @opindex mno-db
12805 Enable (disable) generation of code using decrement and branch,
12806 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12807 on the safe side, this is disabled for the C3x, since the maximum
12808 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12809 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12810 that it can utilize the decrement and branch instruction, but will give
12811 up if there is more than one memory reference in the loop.  Thus a loop
12812 where the loop counter is decremented can generate slightly more
12813 efficient code, in cases where the RPTB instruction cannot be utilized.
12815 @item -mdp-isr-reload
12816 @itemx -mparanoid
12817 @opindex mdp-isr-reload
12818 @opindex mparanoid
12819 Force the DP register to be saved on entry to an interrupt service
12820 routine (ISR), reloaded to point to the data section, and restored on
12821 exit from the ISR@.  This should not be required unless someone has
12822 violated the small memory model by modifying the DP register, say within
12823 an object library.
12825 @item -mmpyi
12826 @itemx -mno-mpyi
12827 @opindex mmpyi
12828 @opindex mno-mpyi
12829 For the C3x use the 24-bit MPYI instruction for integer multiplies
12830 instead of a library call to guarantee 32-bit results.  Note that if one
12831 of the operands is a constant, then the multiplication will be performed
12832 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12833 then squaring operations are performed inline instead of a library call.
12835 @item -mfast-fix
12836 @itemx -mno-fast-fix
12837 @opindex mfast-fix
12838 @opindex mno-fast-fix
12839 The C3x/C4x FIX instruction to convert a floating point value to an
12840 integer value chooses the nearest integer less than or equal to the
12841 floating point value rather than to the nearest integer.  Thus if the
12842 floating point number is negative, the result will be incorrectly
12843 truncated an additional code is necessary to detect and correct this
12844 case.  This option can be used to disable generation of the additional
12845 code required to correct the result.
12847 @item -mrptb
12848 @itemx -mno-rptb
12849 @opindex mrptb
12850 @opindex mno-rptb
12851 Enable (disable) generation of repeat block sequences using the RPTB
12852 instruction for zero overhead looping.  The RPTB construct is only used
12853 for innermost loops that do not call functions or jump across the loop
12854 boundaries.  There is no advantage having nested RPTB loops due to the
12855 overhead required to save and restore the RC, RS, and RE registers.
12856 This is enabled by default with @option{-O2}.
12858 @item -mrpts=@var{count}
12859 @itemx -mno-rpts
12860 @opindex mrpts
12861 @opindex mno-rpts
12862 Enable (disable) the use of the single instruction repeat instruction
12863 RPTS@.  If a repeat block contains a single instruction, and the loop
12864 count can be guaranteed to be less than the value @var{count}, GCC will
12865 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12866 then a RPTS will be emitted even if the loop count cannot be determined
12867 at compile time.  Note that the repeated instruction following RPTS does
12868 not have to be reloaded from memory each iteration, thus freeing up the
12869 CPU buses for operands.  However, since interrupts are blocked by this
12870 instruction, it is disabled by default.
12872 @item -mloop-unsigned
12873 @itemx -mno-loop-unsigned
12874 @opindex mloop-unsigned
12875 @opindex mno-loop-unsigned
12876 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12877 is @math{2^{31} + 1} since these instructions test if the iteration count is
12878 negative to terminate the loop.  If the iteration count is unsigned
12879 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12880 exceeded.  This switch allows an unsigned iteration count.
12882 @item -mti
12883 @opindex mti
12884 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12885 with.  This also enforces compatibility with the API employed by the TI
12886 C3x C compiler.  For example, long doubles are passed as structures
12887 rather than in floating point registers.
12889 @item -mregparm
12890 @itemx -mmemparm
12891 @opindex mregparm
12892 @opindex mmemparm
12893 Generate code that uses registers (stack) for passing arguments to functions.
12894 By default, arguments are passed in registers where possible rather
12895 than by pushing arguments on to the stack.
12897 @item -mparallel-insns
12898 @itemx -mno-parallel-insns
12899 @opindex mparallel-insns
12900 @opindex mno-parallel-insns
12901 Allow the generation of parallel instructions.  This is enabled by
12902 default with @option{-O2}.
12904 @item -mparallel-mpy
12905 @itemx -mno-parallel-mpy
12906 @opindex mparallel-mpy
12907 @opindex mno-parallel-mpy
12908 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12909 provided @option{-mparallel-insns} is also specified.  These instructions have
12910 tight register constraints which can pessimize the code generation
12911 of large functions.
12913 @end table
12915 @node V850 Options
12916 @subsection V850 Options
12917 @cindex V850 Options
12919 These @samp{-m} options are defined for V850 implementations:
12921 @table @gcctabopt
12922 @item -mlong-calls
12923 @itemx -mno-long-calls
12924 @opindex mlong-calls
12925 @opindex mno-long-calls
12926 Treat all calls as being far away (near).  If calls are assumed to be
12927 far away, the compiler will always load the functions address up into a
12928 register, and call indirect through the pointer.
12930 @item -mno-ep
12931 @itemx -mep
12932 @opindex mno-ep
12933 @opindex mep
12934 Do not optimize (do optimize) basic blocks that use the same index
12935 pointer 4 or more times to copy pointer into the @code{ep} register, and
12936 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12937 option is on by default if you optimize.
12939 @item -mno-prolog-function
12940 @itemx -mprolog-function
12941 @opindex mno-prolog-function
12942 @opindex mprolog-function
12943 Do not use (do use) external functions to save and restore registers
12944 at the prologue and epilogue of a function.  The external functions
12945 are slower, but use less code space if more than one function saves
12946 the same number of registers.  The @option{-mprolog-function} option
12947 is on by default if you optimize.
12949 @item -mspace
12950 @opindex mspace
12951 Try to make the code as small as possible.  At present, this just turns
12952 on the @option{-mep} and @option{-mprolog-function} options.
12954 @item -mtda=@var{n}
12955 @opindex mtda
12956 Put static or global variables whose size is @var{n} bytes or less into
12957 the tiny data area that register @code{ep} points to.  The tiny data
12958 area can hold up to 256 bytes in total (128 bytes for byte references).
12960 @item -msda=@var{n}
12961 @opindex msda
12962 Put static or global variables whose size is @var{n} bytes or less into
12963 the small data area that register @code{gp} points to.  The small data
12964 area can hold up to 64 kilobytes.
12966 @item -mzda=@var{n}
12967 @opindex mzda
12968 Put static or global variables whose size is @var{n} bytes or less into
12969 the first 32 kilobytes of memory.
12971 @item -mv850
12972 @opindex mv850
12973 Specify that the target processor is the V850.
12975 @item -mbig-switch
12976 @opindex mbig-switch
12977 Generate code suitable for big switch tables.  Use this option only if
12978 the assembler/linker complain about out of range branches within a switch
12979 table.
12981 @item -mapp-regs
12982 @opindex mapp-regs
12983 This option will cause r2 and r5 to be used in the code generated by
12984 the compiler.  This setting is the default.
12986 @item -mno-app-regs
12987 @opindex mno-app-regs
12988 This option will cause r2 and r5 to be treated as fixed registers.
12990 @item -mv850e1
12991 @opindex mv850e1
12992 Specify that the target processor is the V850E1.  The preprocessor
12993 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12994 this option is used.
12996 @item -mv850e
12997 @opindex mv850e
12998 Specify that the target processor is the V850E@.  The preprocessor
12999 constant @samp{__v850e__} will be defined if this option is used.
13001 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
13002 are defined then a default target processor will be chosen and the
13003 relevant @samp{__v850*__} preprocessor constant will be defined.
13005 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
13006 defined, regardless of which processor variant is the target.
13008 @item -mdisable-callt
13009 @opindex mdisable-callt
13010 This option will suppress generation of the CALLT instruction for the
13011 v850e and v850e1 flavors of the v850 architecture.  The default is
13012 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
13014 @end table
13016 @node VAX Options
13017 @subsection VAX Options
13018 @cindex VAX options
13020 These @samp{-m} options are defined for the VAX:
13022 @table @gcctabopt
13023 @item -munix
13024 @opindex munix
13025 Do not output certain jump instructions (@code{aobleq} and so on)
13026 that the Unix assembler for the VAX cannot handle across long
13027 ranges.
13029 @item -mgnu
13030 @opindex mgnu
13031 Do output those jump instructions, on the assumption that you
13032 will assemble with the GNU assembler.
13034 @item -mg
13035 @opindex mg
13036 Output code for g-format floating point numbers instead of d-format.
13037 @end table
13039 @node x86-64 Options
13040 @subsection x86-64 Options
13041 @cindex x86-64 options
13043 These are listed under @xref{i386 and x86-64 Options}.
13045 @node Xstormy16 Options
13046 @subsection Xstormy16 Options
13047 @cindex Xstormy16 Options
13049 These options are defined for Xstormy16:
13051 @table @gcctabopt
13052 @item -msim
13053 @opindex msim
13054 Choose startup files and linker script suitable for the simulator.
13055 @end table
13057 @node Xtensa Options
13058 @subsection Xtensa Options
13059 @cindex Xtensa Options
13061 These options are supported for Xtensa targets:
13063 @table @gcctabopt
13064 @item -mconst16
13065 @itemx -mno-const16
13066 @opindex mconst16
13067 @opindex mno-const16
13068 Enable or disable use of @code{CONST16} instructions for loading
13069 constant values.  The @code{CONST16} instruction is currently not a
13070 standard option from Tensilica.  When enabled, @code{CONST16}
13071 instructions are always used in place of the standard @code{L32R}
13072 instructions.  The use of @code{CONST16} is enabled by default only if
13073 the @code{L32R} instruction is not available.
13075 @item -mfused-madd
13076 @itemx -mno-fused-madd
13077 @opindex mfused-madd
13078 @opindex mno-fused-madd
13079 Enable or disable use of fused multiply/add and multiply/subtract
13080 instructions in the floating-point option.  This has no effect if the
13081 floating-point option is not also enabled.  Disabling fused multiply/add
13082 and multiply/subtract instructions forces the compiler to use separate
13083 instructions for the multiply and add/subtract operations.  This may be
13084 desirable in some cases where strict IEEE 754-compliant results are
13085 required: the fused multiply add/subtract instructions do not round the
13086 intermediate result, thereby producing results with @emph{more} bits of
13087 precision than specified by the IEEE standard.  Disabling fused multiply
13088 add/subtract instructions also ensures that the program output is not
13089 sensitive to the compiler's ability to combine multiply and add/subtract
13090 operations.
13092 @item -mtext-section-literals
13093 @itemx -mno-text-section-literals
13094 @opindex mtext-section-literals
13095 @opindex mno-text-section-literals
13096 Control the treatment of literal pools.  The default is
13097 @option{-mno-text-section-literals}, which places literals in a separate
13098 section in the output file.  This allows the literal pool to be placed
13099 in a data RAM/ROM, and it also allows the linker to combine literal
13100 pools from separate object files to remove redundant literals and
13101 improve code size.  With @option{-mtext-section-literals}, the literals
13102 are interspersed in the text section in order to keep them as close as
13103 possible to their references.  This may be necessary for large assembly
13104 files.
13106 @item -mtarget-align
13107 @itemx -mno-target-align
13108 @opindex mtarget-align
13109 @opindex mno-target-align
13110 When this option is enabled, GCC instructs the assembler to
13111 automatically align instructions to reduce branch penalties at the
13112 expense of some code density.  The assembler attempts to widen density
13113 instructions to align branch targets and the instructions following call
13114 instructions.  If there are not enough preceding safe density
13115 instructions to align a target, no widening will be performed.  The
13116 default is @option{-mtarget-align}.  These options do not affect the
13117 treatment of auto-aligned instructions like @code{LOOP}, which the
13118 assembler will always align, either by widening density instructions or
13119 by inserting no-op instructions.
13121 @item -mlongcalls
13122 @itemx -mno-longcalls
13123 @opindex mlongcalls
13124 @opindex mno-longcalls
13125 When this option is enabled, GCC instructs the assembler to translate
13126 direct calls to indirect calls unless it can determine that the target
13127 of a direct call is in the range allowed by the call instruction.  This
13128 translation typically occurs for calls to functions in other source
13129 files.  Specifically, the assembler translates a direct @code{CALL}
13130 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
13131 The default is @option{-mno-longcalls}.  This option should be used in
13132 programs where the call target can potentially be out of range.  This
13133 option is implemented in the assembler, not the compiler, so the
13134 assembly code generated by GCC will still show direct call
13135 instructions---look at the disassembled object code to see the actual
13136 instructions.  Note that the assembler will use an indirect call for
13137 every cross-file call, not just those that really will be out of range.
13138 @end table
13140 @node zSeries Options
13141 @subsection zSeries Options
13142 @cindex zSeries options
13144 These are listed under @xref{S/390 and zSeries Options}.
13146 @node Code Gen Options
13147 @section Options for Code Generation Conventions
13148 @cindex code generation conventions
13149 @cindex options, code generation
13150 @cindex run-time options
13152 These machine-independent options control the interface conventions
13153 used in code generation.
13155 Most of them have both positive and negative forms; the negative form
13156 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
13157 one of the forms is listed---the one which is not the default.  You
13158 can figure out the other form by either removing @samp{no-} or adding
13161 @table @gcctabopt
13162 @item -fbounds-check
13163 @opindex fbounds-check
13164 For front-ends that support it, generate additional code to check that
13165 indices used to access arrays are within the declared range.  This is
13166 currently only supported by the Java and Fortran front-ends, where
13167 this option defaults to true and false respectively.
13169 @item -ftrapv
13170 @opindex ftrapv
13171 This option generates traps for signed overflow on addition, subtraction,
13172 multiplication operations.
13174 @item -fwrapv
13175 @opindex fwrapv
13176 This option instructs the compiler to assume that signed arithmetic
13177 overflow of addition, subtraction and multiplication wraps around
13178 using twos-complement representation.  This flag enables some optimizations
13179 and disables others.  This option is enabled by default for the Java
13180 front-end, as required by the Java language specification.
13182 @item -fexceptions
13183 @opindex fexceptions
13184 Enable exception handling.  Generates extra code needed to propagate
13185 exceptions.  For some targets, this implies GCC will generate frame
13186 unwind information for all functions, which can produce significant data
13187 size overhead, although it does not affect execution.  If you do not
13188 specify this option, GCC will enable it by default for languages like
13189 C++ which normally require exception handling, and disable it for
13190 languages like C that do not normally require it.  However, you may need
13191 to enable this option when compiling C code that needs to interoperate
13192 properly with exception handlers written in C++.  You may also wish to
13193 disable this option if you are compiling older C++ programs that don't
13194 use exception handling.
13196 @item -fnon-call-exceptions
13197 @opindex fnon-call-exceptions
13198 Generate code that allows trapping instructions to throw exceptions.
13199 Note that this requires platform-specific runtime support that does
13200 not exist everywhere.  Moreover, it only allows @emph{trapping}
13201 instructions to throw exceptions, i.e.@: memory references or floating
13202 point instructions.  It does not allow exceptions to be thrown from
13203 arbitrary signal handlers such as @code{SIGALRM}.
13205 @item -funwind-tables
13206 @opindex funwind-tables
13207 Similar to @option{-fexceptions}, except that it will just generate any needed
13208 static data, but will not affect the generated code in any other way.
13209 You will normally not enable this option; instead, a language processor
13210 that needs this handling would enable it on your behalf.
13212 @item -fasynchronous-unwind-tables
13213 @opindex fasynchronous-unwind-tables
13214 Generate unwind table in dwarf2 format, if supported by target machine.  The
13215 table is exact at each instruction boundary, so it can be used for stack
13216 unwinding from asynchronous events (such as debugger or garbage collector).
13218 @item -fpcc-struct-return
13219 @opindex fpcc-struct-return
13220 Return ``short'' @code{struct} and @code{union} values in memory like
13221 longer ones, rather than in registers.  This convention is less
13222 efficient, but it has the advantage of allowing intercallability between
13223 GCC-compiled files and files compiled with other compilers, particularly
13224 the Portable C Compiler (pcc).
13226 The precise convention for returning structures in memory depends
13227 on the target configuration macros.
13229 Short structures and unions are those whose size and alignment match
13230 that of some integer type.
13232 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
13233 switch is not binary compatible with code compiled with the
13234 @option{-freg-struct-return} switch.
13235 Use it to conform to a non-default application binary interface.
13237 @item -freg-struct-return
13238 @opindex freg-struct-return
13239 Return @code{struct} and @code{union} values in registers when possible.
13240 This is more efficient for small structures than
13241 @option{-fpcc-struct-return}.
13243 If you specify neither @option{-fpcc-struct-return} nor
13244 @option{-freg-struct-return}, GCC defaults to whichever convention is
13245 standard for the target.  If there is no standard convention, GCC
13246 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
13247 the principal compiler.  In those cases, we can choose the standard, and
13248 we chose the more efficient register return alternative.
13250 @strong{Warning:} code compiled with the @option{-freg-struct-return}
13251 switch is not binary compatible with code compiled with the
13252 @option{-fpcc-struct-return} switch.
13253 Use it to conform to a non-default application binary interface.
13255 @item -fshort-enums
13256 @opindex fshort-enums
13257 Allocate to an @code{enum} type only as many bytes as it needs for the
13258 declared range of possible values.  Specifically, the @code{enum} type
13259 will be equivalent to the smallest integer type which has enough room.
13261 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
13262 code that is not binary compatible with code generated without that switch.
13263 Use it to conform to a non-default application binary interface.
13265 @item -fshort-double
13266 @opindex fshort-double
13267 Use the same size for @code{double} as for @code{float}.
13269 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
13270 code that is not binary compatible with code generated without that switch.
13271 Use it to conform to a non-default application binary interface.
13273 @item -fshort-wchar
13274 @opindex fshort-wchar
13275 Override the underlying type for @samp{wchar_t} to be @samp{short
13276 unsigned int} instead of the default for the target.  This option is
13277 useful for building programs to run under WINE@.
13279 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
13280 code that is not binary compatible with code generated without that switch.
13281 Use it to conform to a non-default application binary interface.
13283 @item -fno-common
13284 @opindex fno-common
13285 In C, allocate even uninitialized global variables in the data section of the
13286 object file, rather than generating them as common blocks.  This has the
13287 effect that if the same variable is declared (without @code{extern}) in
13288 two different compilations, you will get an error when you link them.
13289 The only reason this might be useful is if you wish to verify that the
13290 program will work on other systems which always work this way.
13292 @item -fno-ident
13293 @opindex fno-ident
13294 Ignore the @samp{#ident} directive.
13296 @item -finhibit-size-directive
13297 @opindex finhibit-size-directive
13298 Don't output a @code{.size} assembler directive, or anything else that
13299 would cause trouble if the function is split in the middle, and the
13300 two halves are placed at locations far apart in memory.  This option is
13301 used when compiling @file{crtstuff.c}; you should not need to use it
13302 for anything else.
13304 @item -fverbose-asm
13305 @opindex fverbose-asm
13306 Put extra commentary information in the generated assembly code to
13307 make it more readable.  This option is generally only of use to those
13308 who actually need to read the generated assembly code (perhaps while
13309 debugging the compiler itself).
13311 @option{-fno-verbose-asm}, the default, causes the
13312 extra information to be omitted and is useful when comparing two assembler
13313 files.
13315 @item -fpic
13316 @opindex fpic
13317 @cindex global offset table
13318 @cindex PIC
13319 Generate position-independent code (PIC) suitable for use in a shared
13320 library, if supported for the target machine.  Such code accesses all
13321 constant addresses through a global offset table (GOT)@.  The dynamic
13322 loader resolves the GOT entries when the program starts (the dynamic
13323 loader is not part of GCC; it is part of the operating system).  If
13324 the GOT size for the linked executable exceeds a machine-specific
13325 maximum size, you get an error message from the linker indicating that
13326 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13327 instead.  (These maximums are 8k on the SPARC and 32k
13328 on the m68k and RS/6000.  The 386 has no such limit.)
13330 Position-independent code requires special support, and therefore works
13331 only on certain machines.  For the 386, GCC supports PIC for System V
13332 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13333 position-independent.
13335 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13336 are defined to 1.
13338 @item -fPIC
13339 @opindex fPIC
13340 If supported for the target machine, emit position-independent code,
13341 suitable for dynamic linking and avoiding any limit on the size of the
13342 global offset table.  This option makes a difference on the m68k,
13343 PowerPC and SPARC@.
13345 Position-independent code requires special support, and therefore works
13346 only on certain machines.
13348 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13349 are defined to 2.
13351 @item -fpie
13352 @itemx -fPIE
13353 @opindex fpie
13354 @opindex fPIE
13355 These options are similar to @option{-fpic} and @option{-fPIC}, but
13356 generated position independent code can be only linked into executables.
13357 Usually these options are used when @option{-pie} GCC option will be
13358 used during linking.
13360 @item -fno-jump-tables
13361 @opindex fno-jump-tables
13362 Do not use jump tables for switch statements even where it would be
13363 more efficient than other code generation strategies.  This option is
13364 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13365 building code which forms part of a dynamic linker and cannot
13366 reference the address of a jump table.  On some targets, jump tables
13367 do not require a GOT and this option is not needed.
13369 @item -ffixed-@var{reg}
13370 @opindex ffixed
13371 Treat the register named @var{reg} as a fixed register; generated code
13372 should never refer to it (except perhaps as a stack pointer, frame
13373 pointer or in some other fixed role).
13375 @var{reg} must be the name of a register.  The register names accepted
13376 are machine-specific and are defined in the @code{REGISTER_NAMES}
13377 macro in the machine description macro file.
13379 This flag does not have a negative form, because it specifies a
13380 three-way choice.
13382 @item -fcall-used-@var{reg}
13383 @opindex fcall-used
13384 Treat the register named @var{reg} as an allocable register that is
13385 clobbered by function calls.  It may be allocated for temporaries or
13386 variables that do not live across a call.  Functions compiled this way
13387 will not save and restore the register @var{reg}.
13389 It is an error to used this flag with the frame pointer or stack pointer.
13390 Use of this flag for other registers that have fixed pervasive roles in
13391 the machine's execution model will produce disastrous results.
13393 This flag does not have a negative form, because it specifies a
13394 three-way choice.
13396 @item -fcall-saved-@var{reg}
13397 @opindex fcall-saved
13398 Treat the register named @var{reg} as an allocable register saved by
13399 functions.  It may be allocated even for temporaries or variables that
13400 live across a call.  Functions compiled this way will save and restore
13401 the register @var{reg} if they use it.
13403 It is an error to used this flag with the frame pointer or stack pointer.
13404 Use of this flag for other registers that have fixed pervasive roles in
13405 the machine's execution model will produce disastrous results.
13407 A different sort of disaster will result from the use of this flag for
13408 a register in which function values may be returned.
13410 This flag does not have a negative form, because it specifies a
13411 three-way choice.
13413 @item -fpack-struct[=@var{n}]
13414 @opindex fpack-struct
13415 Without a value specified, pack all structure members together without
13416 holes.  When a value is specified (which must be a small power of two), pack
13417 structure members according to this value, representing the maximum
13418 alignment (that is, objects with default alignment requirements larger than
13419 this will be output potentially unaligned at the next fitting location.
13421 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13422 code that is not binary compatible with code generated without that switch.
13423 Additionally, it makes the code suboptimal.
13424 Use it to conform to a non-default application binary interface.
13426 @item -finstrument-functions
13427 @opindex finstrument-functions
13428 Generate instrumentation calls for entry and exit to functions.  Just
13429 after function entry and just before function exit, the following
13430 profiling functions will be called with the address of the current
13431 function and its call site.  (On some platforms,
13432 @code{__builtin_return_address} does not work beyond the current
13433 function, so the call site information may not be available to the
13434 profiling functions otherwise.)
13436 @smallexample
13437 void __cyg_profile_func_enter (void *this_fn,
13438                                void *call_site);
13439 void __cyg_profile_func_exit  (void *this_fn,
13440                                void *call_site);
13441 @end smallexample
13443 The first argument is the address of the start of the current function,
13444 which may be looked up exactly in the symbol table.
13446 This instrumentation is also done for functions expanded inline in other
13447 functions.  The profiling calls will indicate where, conceptually, the
13448 inline function is entered and exited.  This means that addressable
13449 versions of such functions must be available.  If all your uses of a
13450 function are expanded inline, this may mean an additional expansion of
13451 code size.  If you use @samp{extern inline} in your C code, an
13452 addressable version of such functions must be provided.  (This is
13453 normally the case anyways, but if you get lucky and the optimizer always
13454 expands the functions inline, you might have gotten away without
13455 providing static copies.)
13457 A function may be given the attribute @code{no_instrument_function}, in
13458 which case this instrumentation will not be done.  This can be used, for
13459 example, for the profiling functions listed above, high-priority
13460 interrupt routines, and any functions from which the profiling functions
13461 cannot safely be called (perhaps signal handlers, if the profiling
13462 routines generate output or allocate memory).
13464 @item -fstack-check
13465 @opindex fstack-check
13466 Generate code to verify that you do not go beyond the boundary of the
13467 stack.  You should specify this flag if you are running in an
13468 environment with multiple threads, but only rarely need to specify it in
13469 a single-threaded environment since stack overflow is automatically
13470 detected on nearly all systems if there is only one stack.
13472 Note that this switch does not actually cause checking to be done; the
13473 operating system must do that.  The switch causes generation of code
13474 to ensure that the operating system sees the stack being extended.
13476 @item -fstack-limit-register=@var{reg}
13477 @itemx -fstack-limit-symbol=@var{sym}
13478 @itemx -fno-stack-limit
13479 @opindex fstack-limit-register
13480 @opindex fstack-limit-symbol
13481 @opindex fno-stack-limit
13482 Generate code to ensure that the stack does not grow beyond a certain value,
13483 either the value of a register or the address of a symbol.  If the stack
13484 would grow beyond the value, a signal is raised.  For most targets,
13485 the signal is raised before the stack overruns the boundary, so
13486 it is possible to catch the signal without taking special precautions.
13488 For instance, if the stack starts at absolute address @samp{0x80000000}
13489 and grows downwards, you can use the flags
13490 @option{-fstack-limit-symbol=__stack_limit} and
13491 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13492 of 128KB@.  Note that this may only work with the GNU linker.
13494 @cindex aliasing of parameters
13495 @cindex parameters, aliased
13496 @item -fargument-alias
13497 @itemx -fargument-noalias
13498 @itemx -fargument-noalias-global
13499 @itemx -fargument-noalias-anything
13500 @opindex fargument-alias
13501 @opindex fargument-noalias
13502 @opindex fargument-noalias-global
13503 @opindex fargument-noalias-anything
13504 Specify the possible relationships among parameters and between
13505 parameters and global data.
13507 @option{-fargument-alias} specifies that arguments (parameters) may
13508 alias each other and may alias global storage.@*
13509 @option{-fargument-noalias} specifies that arguments do not alias
13510 each other, but may alias global storage.@*
13511 @option{-fargument-noalias-global} specifies that arguments do not
13512 alias each other and do not alias global storage.
13513 @option{-fargument-noalias-anything} specifies that arguments do not
13514 alias any other storage.
13516 Each language will automatically use whatever option is required by
13517 the language standard.  You should not need to use these options yourself.
13519 @item -fleading-underscore
13520 @opindex fleading-underscore
13521 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13522 change the way C symbols are represented in the object file.  One use
13523 is to help link with legacy assembly code.
13525 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13526 generate code that is not binary compatible with code generated without that
13527 switch.  Use it to conform to a non-default application binary interface.
13528 Not all targets provide complete support for this switch.
13530 @item -ftls-model=@var{model}
13531 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13532 The @var{model} argument should be one of @code{global-dynamic},
13533 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13535 The default without @option{-fpic} is @code{initial-exec}; with
13536 @option{-fpic} the default is @code{global-dynamic}.
13538 @item -fvisibility=@var{default|internal|hidden|protected}
13539 @opindex fvisibility
13540 Set the default ELF image symbol visibility to the specified option---all
13541 symbols will be marked with this unless overridden within the code.
13542 Using this feature can very substantially improve linking and
13543 load times of shared object libraries, produce more optimized
13544 code, provide near-perfect API export and prevent symbol clashes.
13545 It is @strong{strongly} recommended that you use this in any shared objects
13546 you distribute.
13548 Despite the nomenclature, @code{default} always means public ie;
13549 available to be linked against from outside the shared object.
13550 @code{protected} and @code{internal} are pretty useless in real-world
13551 usage so the only other commonly used option will be @code{hidden}.
13552 The default if @option{-fvisibility} isn't specified is
13553 @code{default}, i.e., make every
13554 symbol public---this causes the same behavior as previous versions of
13555 GCC@.
13557 A good explanation of the benefits offered by ensuring ELF
13558 symbols have the correct visibility is given by ``How To Write
13559 Shared Libraries'' by Ulrich Drepper (which can be found at
13560 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13561 solution made possible by this option to marking things hidden when
13562 the default is public is to make the default hidden and mark things
13563 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13564 and @code{__attribute__ ((visibility("default")))} instead of
13565 @code{__declspec(dllexport)} you get almost identical semantics with
13566 identical syntax.  This is a great boon to those working with
13567 cross-platform projects.
13569 For those adding visibility support to existing code, you may find
13570 @samp{#pragma GCC visibility} of use.  This works by you enclosing
13571 the declarations you wish to set visibility for with (for example)
13572 @samp{#pragma GCC visibility push(hidden)} and
13573 @samp{#pragma GCC visibility pop}.
13574 Bear in mind that symbol visibility should be viewed @strong{as
13575 part of the API interface contract} and thus all new code should
13576 always specify visibility when it is not the default ie; declarations
13577 only for use within the local DSO should @strong{always} be marked explicitly
13578 as hidden as so to avoid PLT indirection overheads---making this
13579 abundantly clear also aids readability and self-documentation of the code.
13580 Note that due to ISO C++ specification requirements, operator new and
13581 operator delete must always be of default visibility.
13583 Be aware that headers from outside your project, in particular system
13584 headers and headers from any other library you use, may not be
13585 expecting to be compiled with visibility other than the default.  You
13586 may need to explicitly say @samp{#pragma GCC visibility push(default)}
13587 before including any such headers.
13589 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
13590 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
13591 no modifications.  However, this means that calls to @samp{extern}
13592 functions with no explicit visibility will use the PLT, so it is more
13593 effective to use @samp{__attribute ((visibility))} and/or
13594 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
13595 declarations should be treated as hidden.
13597 Note that @samp{-fvisibility} does affect C++ vague linkage
13598 entities. This means that, for instance, an exception class that will
13599 be thrown between DSOs must be explicitly marked with default
13600 visibility so that the @samp{type_info} nodes will be unified between
13601 the DSOs.
13603 An overview of these techniques, their benefits and how to use them
13604 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13606 @end table
13608 @c man end
13610 @node Environment Variables
13611 @section Environment Variables Affecting GCC
13612 @cindex environment variables
13614 @c man begin ENVIRONMENT
13615 This section describes several environment variables that affect how GCC
13616 operates.  Some of them work by specifying directories or prefixes to use
13617 when searching for various kinds of files.  Some are used to specify other
13618 aspects of the compilation environment.
13620 Note that you can also specify places to search using options such as
13621 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13622 take precedence over places specified using environment variables, which
13623 in turn take precedence over those specified by the configuration of GCC@.
13624 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13625 GNU Compiler Collection (GCC) Internals}.
13627 @table @env
13628 @item LANG
13629 @itemx LC_CTYPE
13630 @c @itemx LC_COLLATE
13631 @itemx LC_MESSAGES
13632 @c @itemx LC_MONETARY
13633 @c @itemx LC_NUMERIC
13634 @c @itemx LC_TIME
13635 @itemx LC_ALL
13636 @findex LANG
13637 @findex LC_CTYPE
13638 @c @findex LC_COLLATE
13639 @findex LC_MESSAGES
13640 @c @findex LC_MONETARY
13641 @c @findex LC_NUMERIC
13642 @c @findex LC_TIME
13643 @findex LC_ALL
13644 @cindex locale
13645 These environment variables control the way that GCC uses
13646 localization information that allow GCC to work with different
13647 national conventions.  GCC inspects the locale categories
13648 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13649 so.  These locale categories can be set to any value supported by your
13650 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13651 Kingdom encoded in UTF-8.
13653 The @env{LC_CTYPE} environment variable specifies character
13654 classification.  GCC uses it to determine the character boundaries in
13655 a string; this is needed for some multibyte encodings that contain quote
13656 and escape characters that would otherwise be interpreted as a string
13657 end or escape.
13659 The @env{LC_MESSAGES} environment variable specifies the language to
13660 use in diagnostic messages.
13662 If the @env{LC_ALL} environment variable is set, it overrides the value
13663 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13664 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13665 environment variable.  If none of these variables are set, GCC
13666 defaults to traditional C English behavior.
13668 @item TMPDIR
13669 @findex TMPDIR
13670 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13671 files.  GCC uses temporary files to hold the output of one stage of
13672 compilation which is to be used as input to the next stage: for example,
13673 the output of the preprocessor, which is the input to the compiler
13674 proper.
13676 @item GCC_EXEC_PREFIX
13677 @findex GCC_EXEC_PREFIX
13678 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13679 names of the subprograms executed by the compiler.  No slash is added
13680 when this prefix is combined with the name of a subprogram, but you can
13681 specify a prefix that ends with a slash if you wish.
13683 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13684 an appropriate prefix to use based on the pathname it was invoked with.
13686 If GCC cannot find the subprogram using the specified prefix, it
13687 tries looking in the usual places for the subprogram.
13689 The default value of @env{GCC_EXEC_PREFIX} is
13690 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13691 of @code{prefix} when you ran the @file{configure} script.
13693 Other prefixes specified with @option{-B} take precedence over this prefix.
13695 This prefix is also used for finding files such as @file{crt0.o} that are
13696 used for linking.
13698 In addition, the prefix is used in an unusual way in finding the
13699 directories to search for header files.  For each of the standard
13700 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13701 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13702 replacing that beginning with the specified prefix to produce an
13703 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13704 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13705 These alternate directories are searched first; the standard directories
13706 come next.
13708 @item COMPILER_PATH
13709 @findex COMPILER_PATH
13710 The value of @env{COMPILER_PATH} is a colon-separated list of
13711 directories, much like @env{PATH}.  GCC tries the directories thus
13712 specified when searching for subprograms, if it can't find the
13713 subprograms using @env{GCC_EXEC_PREFIX}.
13715 @item LIBRARY_PATH
13716 @findex LIBRARY_PATH
13717 The value of @env{LIBRARY_PATH} is a colon-separated list of
13718 directories, much like @env{PATH}.  When configured as a native compiler,
13719 GCC tries the directories thus specified when searching for special
13720 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13721 using GCC also uses these directories when searching for ordinary
13722 libraries for the @option{-l} option (but directories specified with
13723 @option{-L} come first).
13725 @item LANG
13726 @findex LANG
13727 @cindex locale definition
13728 This variable is used to pass locale information to the compiler.  One way in
13729 which this information is used is to determine the character set to be used
13730 when character literals, string literals and comments are parsed in C and C++.
13731 When the compiler is configured to allow multibyte characters,
13732 the following values for @env{LANG} are recognized:
13734 @table @samp
13735 @item C-JIS
13736 Recognize JIS characters.
13737 @item C-SJIS
13738 Recognize SJIS characters.
13739 @item C-EUCJP
13740 Recognize EUCJP characters.
13741 @end table
13743 If @env{LANG} is not defined, or if it has some other value, then the
13744 compiler will use mblen and mbtowc as defined by the default locale to
13745 recognize and translate multibyte characters.
13746 @end table
13748 @noindent
13749 Some additional environments variables affect the behavior of the
13750 preprocessor.
13752 @include cppenv.texi
13754 @c man end
13756 @node Precompiled Headers
13757 @section Using Precompiled Headers
13758 @cindex precompiled headers
13759 @cindex speed of compilation
13761 Often large projects have many header files that are included in every
13762 source file.  The time the compiler takes to process these header files
13763 over and over again can account for nearly all of the time required to
13764 build the project.  To make builds faster, GCC allows users to
13765 `precompile' a header file; then, if builds can use the precompiled
13766 header file they will be much faster.
13768 To create a precompiled header file, simply compile it as you would any
13769 other file, if necessary using the @option{-x} option to make the driver
13770 treat it as a C or C++ header file.  You will probably want to use a
13771 tool like @command{make} to keep the precompiled header up-to-date when
13772 the headers it contains change.
13774 A precompiled header file will be searched for when @code{#include} is
13775 seen in the compilation.  As it searches for the included file
13776 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13777 compiler looks for a precompiled header in each directory just before it
13778 looks for the include file in that directory.  The name searched for is
13779 the name specified in the @code{#include} with @samp{.gch} appended.  If
13780 the precompiled header file can't be used, it is ignored.
13782 For instance, if you have @code{#include "all.h"}, and you have
13783 @file{all.h.gch} in the same directory as @file{all.h}, then the
13784 precompiled header file will be used if possible, and the original
13785 header will be used otherwise.
13787 Alternatively, you might decide to put the precompiled header file in a
13788 directory and use @option{-I} to ensure that directory is searched
13789 before (or instead of) the directory containing the original header.
13790 Then, if you want to check that the precompiled header file is always
13791 used, you can put a file of the same name as the original header in this
13792 directory containing an @code{#error} command.
13794 This also works with @option{-include}.  So yet another way to use
13795 precompiled headers, good for projects not designed with precompiled
13796 header files in mind, is to simply take most of the header files used by
13797 a project, include them from another header file, precompile that header
13798 file, and @option{-include} the precompiled header.  If the header files
13799 have guards against multiple inclusion, they will be skipped because
13800 they've already been included (in the precompiled header).
13802 If you need to precompile the same header file for different
13803 languages, targets, or compiler options, you can instead make a
13804 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13805 header in the directory, perhaps using @option{-o}.  It doesn't matter
13806 what you call the files in the directory, every precompiled header in
13807 the directory will be considered.  The first precompiled header
13808 encountered in the directory that is valid for this compilation will
13809 be used; they're searched in no particular order.
13811 There are many other possibilities, limited only by your imagination,
13812 good sense, and the constraints of your build system.
13814 A precompiled header file can be used only when these conditions apply:
13816 @itemize
13817 @item
13818 Only one precompiled header can be used in a particular compilation.
13820 @item
13821 A precompiled header can't be used once the first C token is seen.  You
13822 can have preprocessor directives before a precompiled header; you can
13823 even include a precompiled header from inside another header, so long as
13824 there are no C tokens before the @code{#include}.
13826 @item
13827 The precompiled header file must be produced for the same language as
13828 the current compilation.  You can't use a C precompiled header for a C++
13829 compilation.
13831 @item
13832 The precompiled header file must have been produced by the same compiler
13833 binary as the current compilation is using.
13835 @item
13836 Any macros defined before the precompiled header is included must
13837 either be defined in the same way as when the precompiled header was
13838 generated, or must not affect the precompiled header, which usually
13839 means that they don't appear in the precompiled header at all.
13841 The @option{-D} option is one way to define a macro before a
13842 precompiled header is included; using a @code{#define} can also do it.
13843 There are also some options that define macros implicitly, like
13844 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13845 defined this way.
13847 @item If debugging information is output when using the precompiled
13848 header, using @option{-g} or similar, the same kind of debugging information
13849 must have been output when building the precompiled header.  However,
13850 a precompiled header built using @option{-g} can be used in a compilation
13851 when no debugging information is being output.
13853 @item The same @option{-m} options must generally be used when building
13854 and using the precompiled header.  @xref{Submodel Options},
13855 for any cases where this rule is relaxed.
13857 @item Each of the following options must be the same when building and using
13858 the precompiled header:
13860 @gccoptlist{-fexceptions -funit-at-a-time}
13862 @item
13863 Some other command-line options starting with @option{-f},
13864 @option{-p}, or @option{-O} must be defined in the same way as when
13865 the precompiled header was generated.  At present, it's not clear
13866 which options are safe to change and which are not; the safest choice
13867 is to use exactly the same options when generating and using the
13868 precompiled header.  The following are known to be safe:
13870 @gccoptlist{-fmessage-length= -fpreprocessed
13871 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13872 -fsched-verbose=<number> -fschedule-insns -fvisibility=
13873 -pedantic-errors}
13875 @end itemize
13877 For all of these except the last, the compiler will automatically
13878 ignore the precompiled header if the conditions aren't met.  If you
13879 find an option combination that doesn't work and doesn't cause the
13880 precompiled header to be ignored, please consider filing a bug report,
13881 see @ref{Bugs}.
13883 If you do use differing options when generating and using the
13884 precompiled header, the actual behavior will be a mixture of the
13885 behavior for the options.  For instance, if you use @option{-g} to
13886 generate the precompiled header but not when using it, you may or may
13887 not get debugging information for routines in the precompiled header.
13889 @node Running Protoize
13890 @section Running Protoize
13892 The program @code{protoize} is an optional part of GCC@.  You can use
13893 it to add prototypes to a program, thus converting the program to ISO
13894 C in one respect.  The companion program @code{unprotoize} does the
13895 reverse: it removes argument types from any prototypes that are found.
13897 When you run these programs, you must specify a set of source files as
13898 command line arguments.  The conversion programs start out by compiling
13899 these files to see what functions they define.  The information gathered
13900 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13902 After scanning comes actual conversion.  The specified files are all
13903 eligible to be converted; any files they include (whether sources or
13904 just headers) are eligible as well.
13906 But not all the eligible files are converted.  By default,
13907 @code{protoize} and @code{unprotoize} convert only source and header
13908 files in the current directory.  You can specify additional directories
13909 whose files should be converted with the @option{-d @var{directory}}
13910 option.  You can also specify particular files to exclude with the
13911 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13912 directory name matches one of the specified directory names, and its
13913 name within the directory has not been excluded.
13915 Basic conversion with @code{protoize} consists of rewriting most
13916 function definitions and function declarations to specify the types of
13917 the arguments.  The only ones not rewritten are those for varargs
13918 functions.
13920 @code{protoize} optionally inserts prototype declarations at the
13921 beginning of the source file, to make them available for any calls that
13922 precede the function's definition.  Or it can insert prototype
13923 declarations with block scope in the blocks where undeclared functions
13924 are called.
13926 Basic conversion with @code{unprotoize} consists of rewriting most
13927 function declarations to remove any argument types, and rewriting
13928 function definitions to the old-style pre-ISO form.
13930 Both conversion programs print a warning for any function declaration or
13931 definition that they can't convert.  You can suppress these warnings
13932 with @option{-q}.
13934 The output from @code{protoize} or @code{unprotoize} replaces the
13935 original source file.  The original file is renamed to a name ending
13936 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13937 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13938 for DOS) file already exists, then the source file is simply discarded.
13940 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13941 scan the program and collect information about the functions it uses.
13942 So neither of these programs will work until GCC is installed.
13944 Here is a table of the options you can use with @code{protoize} and
13945 @code{unprotoize}.  Each option works with both programs unless
13946 otherwise stated.
13948 @table @code
13949 @item -B @var{directory}
13950 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13951 usual directory (normally @file{/usr/local/lib}).  This file contains
13952 prototype information about standard system functions.  This option
13953 applies only to @code{protoize}.
13955 @item -c @var{compilation-options}
13956 Use @var{compilation-options} as the options when running @command{gcc} to
13957 produce the @samp{.X} files.  The special option @option{-aux-info} is
13958 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13960 Note that the compilation options must be given as a single argument to
13961 @code{protoize} or @code{unprotoize}.  If you want to specify several
13962 @command{gcc} options, you must quote the entire set of compilation options
13963 to make them a single word in the shell.
13965 There are certain @command{gcc} arguments that you cannot use, because they
13966 would produce the wrong kind of output.  These include @option{-g},
13967 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13968 the @var{compilation-options}, they are ignored.
13970 @item -C
13971 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13972 systems) instead of @samp{.c}.  This is convenient if you are converting
13973 a C program to C++.  This option applies only to @code{protoize}.
13975 @item -g
13976 Add explicit global declarations.  This means inserting explicit
13977 declarations at the beginning of each source file for each function
13978 that is called in the file and was not declared.  These declarations
13979 precede the first function definition that contains a call to an
13980 undeclared function.  This option applies only to @code{protoize}.
13982 @item -i @var{string}
13983 Indent old-style parameter declarations with the string @var{string}.
13984 This option applies only to @code{protoize}.
13986 @code{unprotoize} converts prototyped function definitions to old-style
13987 function definitions, where the arguments are declared between the
13988 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13989 uses five spaces as the indentation.  If you want to indent with just
13990 one space instead, use @option{-i " "}.
13992 @item -k
13993 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13994 is finished.
13996 @item -l
13997 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13998 a prototype declaration for each function in each block which calls the
13999 function without any declaration.  This option applies only to
14000 @code{protoize}.
14002 @item -n
14003 Make no real changes.  This mode just prints information about the conversions
14004 that would have been done without @option{-n}.
14006 @item -N
14007 Make no @samp{.save} files.  The original files are simply deleted.
14008 Use this option with caution.
14010 @item -p @var{program}
14011 Use the program @var{program} as the compiler.  Normally, the name
14012 @file{gcc} is used.
14014 @item -q
14015 Work quietly.  Most warnings are suppressed.
14017 @item -v
14018 Print the version number, just like @option{-v} for @command{gcc}.
14019 @end table
14021 If you need special compiler options to compile one of your program's
14022 source files, then you should generate that file's @samp{.X} file
14023 specially, by running @command{gcc} on that source file with the
14024 appropriate options and the option @option{-aux-info}.  Then run
14025 @code{protoize} on the entire set of files.  @code{protoize} will use
14026 the existing @samp{.X} file because it is newer than the source file.
14027 For example:
14029 @smallexample
14030 gcc -Dfoo=bar file1.c -aux-info file1.X
14031 protoize *.c
14032 @end smallexample
14034 @noindent
14035 You need to include the special files along with the rest in the
14036 @code{protoize} command, even though their @samp{.X} files already
14037 exist, because otherwise they won't get converted.
14039 @xref{Protoize Caveats}, for more information on how to use
14040 @code{protoize} successfully.