invoke.texi (-Write-strings): Document that it is enabled by default.
[official-gcc.git] / gcc / doc / invoke.texi
blob6fb86e314e8ee7de176022048f0767fbdafe4606
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{-fstrength-reduce}, @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  -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-options
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  -Woverlength-strings  -Wpacked  -Wpadded @gol
242 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
243 -Wredundant-decls @gol
244 -Wreturn-type  -Wsequence-point  -Wshadow @gol
245 -Wsign-compare  -Wstack-protector @gol
246 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
247 -Wstring-literal-comparison @gol
248 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
249 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
250 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
251 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
252 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
253 -Wvolatile-register-var  -Wwrite-strings}
255 @item C-only Warning Options
256 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
257 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
258 -Wstrict-prototypes  -Wtraditional @gol
259 -Wdeclaration-after-statement -Wpointer-sign}
261 @item Debugging Options
262 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
263 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
264 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
265 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
266 -fdump-ipa-all -fdump-ipa-cgraph @gol
267 -fdump-tree-all @gol
268 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
269 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
272 -fdump-tree-ch @gol
273 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
276 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
277 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-nrv -fdump-tree-vect @gol
282 -fdump-tree-sink @gol
283 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
284 -fdump-tree-salias @gol
285 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
286 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
287 -ftree-vectorizer-verbose=@var{n} @gol
288 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
289 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
290 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
291 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
292 -ftest-coverage  -ftime-report -fvar-tracking @gol
293 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
294 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
295 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
296 -print-multi-directory  -print-multi-lib @gol
297 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
298 -save-temps  -time}
300 @item Optimization Options
301 @xref{Optimize Options,,Options that Control Optimization}.
302 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
303 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
304 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
305 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
306 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
307 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
308 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
309 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
310 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
311 -fforce-addr  -ffunction-sections @gol
312 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
313 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
314 -finline-functions  -finline-functions-called-once @gol
315 -finline-limit=@var{n}  -fkeep-inline-functions @gol
316 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
317 -fmodulo-sched -fno-branch-count-reg @gol
318 -fno-default-inline  -fno-defer-pop -fmove-loop-invariants @gol
319 -fno-function-cse  -fno-guess-branch-probability @gol
320 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
321 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
322 -fno-toplevel-reorder -fno-trapping-math  -fno-zero-initialized-in-bss @gol
323 -fomit-frame-pointer  -foptimize-register-move @gol
324 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
325 -fprofile-generate -fprofile-use @gol
326 -fregmove  -frename-registers @gol
327 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
328 -frerun-cse-after-loop  -frerun-loop-opt @gol
329 -frounding-math -frtl-abstract-sequences @gol
330 -fschedule-insns  -fschedule-insns2 @gol
331 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
332 -fsched-spec-load-dangerous  @gol
333 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
334 -fsched2-use-superblocks @gol
335 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
336 -fsignaling-nans -fsingle-precision-constant  @gol
337 -fstack-protector  -fstack-protector-all @gol
338 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
339 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
340 -fsplit-ivs-in-unroller -funswitch-loops @gol
341 -fvariable-expansion-in-unroller @gol
342 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
343 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
344 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
345 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
346 -ftree-vect-loop-version -ftree-salias -fweb @gol
347 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
348 --param @var{name}=@var{value}
349 -O  -O0  -O1  -O2  -O3  -Os}
351 @item Preprocessor Options
352 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
353 @gccoptlist{-A@var{question}=@var{answer} @gol
354 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
355 -C  -dD  -dI  -dM  -dN @gol
356 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
357 -idirafter @var{dir} @gol
358 -include @var{file}  -imacros @var{file} @gol
359 -iprefix @var{file}  -iwithprefix @var{dir} @gol
360 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
361 -imultilib @var{dir} -isysroot @var{dir} @gol
362 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
363 -P  -fworking-directory  -remap @gol
364 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
365 -Xpreprocessor @var{option}}
367 @item Assembler Option
368 @xref{Assembler Options,,Passing Options to the Assembler}.
369 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
371 @item Linker Options
372 @xref{Link Options,,Options for Linking}.
373 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
374 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
375 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
376 -Wl,@var{option}  -Xlinker @var{option} @gol
377 -u @var{symbol}}
379 @item Directory Options
380 @xref{Directory Options,,Options for Directory Search}.
381 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
382 -specs=@var{file}  -I- --sysroot=@var{dir}}
384 @item Target Options
385 @c I wrote this xref this way to avoid overfull hbox. -- rms
386 @xref{Target Options}.
387 @gccoptlist{-V @var{version}  -b @var{machine}}
389 @item Machine Dependent Options
390 @xref{Submodel Options,,Hardware Models and Configurations}.
391 @c This list is ordered alphanumerically by subsection name.
392 @c Try and put the significant identifier (CPU or system) first,
393 @c so users have a clue at guessing where the ones they want will be.
395 @emph{ARC Options}
396 @gccoptlist{-EB  -EL @gol
397 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
398 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
400 @emph{ARM Options}
401 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
402 -mabi=@var{name} @gol
403 -mapcs-stack-check  -mno-apcs-stack-check @gol
404 -mapcs-float  -mno-apcs-float @gol
405 -mapcs-reentrant  -mno-apcs-reentrant @gol
406 -msched-prolog  -mno-sched-prolog @gol
407 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
408 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
409 -mthumb-interwork  -mno-thumb-interwork @gol
410 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
411 -mstructure-size-boundary=@var{n} @gol
412 -mabort-on-noreturn @gol
413 -mlong-calls  -mno-long-calls @gol
414 -msingle-pic-base  -mno-single-pic-base @gol
415 -mpic-register=@var{reg} @gol
416 -mnop-fun-dllimport @gol
417 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
418 -mpoke-function-name @gol
419 -mthumb  -marm @gol
420 -mtpcs-frame  -mtpcs-leaf-frame @gol
421 -mcaller-super-interworking  -mcallee-super-interworking @gol
422 -mtp=@var{name}}
424 @emph{AVR Options}
425 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
426 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
428 @emph{Blackfin Options}
429 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
430 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
431 -mlow-64k -mno-low64k -mid-shared-library @gol
432 -mno-id-shared-library -mshared-library-id=@var{n} @gol
433 -mlong-calls  -mno-long-calls}
435 @emph{CRIS Options}
436 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
437 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
438 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
439 -mstack-align  -mdata-align  -mconst-align @gol
440 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
441 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
442 -mmul-bug-workaround  -mno-mul-bug-workaround}
444 @emph{CRX Options}
445 @gccoptlist{-mmac -mpush-args}
447 @emph{Darwin Options}
448 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
449 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
450 -client_name  -compatibility_version  -current_version @gol
451 -dead_strip @gol
452 -dependency-file  -dylib_file  -dylinker_install_name @gol
453 -dynamic  -dynamiclib  -exported_symbols_list @gol
454 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
455 -force_flat_namespace  -headerpad_max_install_names @gol
456 -image_base  -init  -install_name  -keep_private_externs @gol
457 -multi_module  -multiply_defined  -multiply_defined_unused @gol
458 -noall_load   -no_dead_strip_inits_and_terms @gol
459 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
460 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
461 -private_bundle  -read_only_relocs  -sectalign @gol
462 -sectobjectsymbols  -whyload  -seg1addr @gol
463 -sectcreate  -sectobjectsymbols  -sectorder @gol
464 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
465 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
466 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
467 -single_module  -static  -sub_library  -sub_umbrella @gol
468 -twolevel_namespace  -umbrella  -undefined @gol
469 -unexported_symbols_list  -weak_reference_mismatches @gol
470 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
471 -mone-byte-bool}
473 @emph{DEC Alpha Options}
474 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
475 -mieee  -mieee-with-inexact  -mieee-conformant @gol
476 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
477 -mtrap-precision=@var{mode}  -mbuild-constants @gol
478 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
479 -mbwx  -mmax  -mfix  -mcix @gol
480 -mfloat-vax  -mfloat-ieee @gol
481 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
482 -msmall-text  -mlarge-text @gol
483 -mmemory-latency=@var{time}}
485 @emph{DEC Alpha/VMS Options}
486 @gccoptlist{-mvms-return-codes}
488 @emph{FRV Options}
489 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
490 -mhard-float  -msoft-float @gol
491 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
492 -mdouble  -mno-double @gol
493 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
494 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
495 -mlinked-fp  -mlong-calls  -malign-labels @gol
496 -mlibrary-pic  -macc-4  -macc-8 @gol
497 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
498 -moptimize-membar -mno-optimize-membar @gol
499 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
500 -mvliw-branch  -mno-vliw-branch @gol
501 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
502 -mno-nested-cond-exec  -mtomcat-stats @gol
503 -mTLS -mtls @gol
504 -mcpu=@var{cpu}}
506 @emph{H8/300 Options}
507 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
509 @emph{HPPA Options}
510 @gccoptlist{-march=@var{architecture-type} @gol
511 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
512 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
513 -mfixed-range=@var{register-range} @gol
514 -mjump-in-delay -mlinker-opt -mlong-calls @gol
515 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
516 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
517 -mno-jump-in-delay  -mno-long-load-store @gol
518 -mno-portable-runtime  -mno-soft-float @gol
519 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
520 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
521 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
522 -munix=@var{unix-std}  -nolibdld  -static  -threads}
524 @emph{i386 and x86-64 Options}
525 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
526 -mfpmath=@var{unit} @gol
527 -masm=@var{dialect}  -mno-fancy-math-387 @gol
528 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
529 -mno-wide-multiply  -mrtd  -malign-double @gol
530 -mpreferred-stack-boundary=@var{num} @gol
531 -mmmx  -msse  -msse2 -msse3 -m3dnow -msselibm @gol
532 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
533 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
534 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
535 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
536 -mcmodel=@var{code-model} @gol
537 -m32  -m64 -mlarge-data-threshold=@var{num}}
539 @emph{IA-64 Options}
540 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
541 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
542 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
543 -minline-float-divide-max-throughput @gol
544 -minline-int-divide-min-latency @gol
545 -minline-int-divide-max-throughput  @gol
546 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
547 -mno-dwarf2-asm -mearly-stop-bits @gol
548 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
549 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
551 @emph{M32R/D Options}
552 @gccoptlist{-m32r2 -m32rx -m32r @gol
553 -mdebug @gol
554 -malign-loops -mno-align-loops @gol
555 -missue-rate=@var{number} @gol
556 -mbranch-cost=@var{number} @gol
557 -mmodel=@var{code-size-model-type} @gol
558 -msdata=@var{sdata-type} @gol
559 -mno-flush-func -mflush-func=@var{name} @gol
560 -mno-flush-trap -mflush-trap=@var{number} @gol
561 -G @var{num}}
563 @emph{M32C Options}
564 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
566 @emph{M680x0 Options}
567 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
568 -m68060  -mcpu32  -m5200  -mcfv4e -m68881  -mbitfield  @gol
569 -mc68000  -mc68020   @gol
570 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
571 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
572 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
574 @emph{M68hc1x Options}
575 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
576 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
577 -msoft-reg-count=@var{count}}
579 @emph{MCore Options}
580 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
581 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
582 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
583 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
584 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
586 @emph{MIPS Options}
587 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
588 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
589 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
590 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
591 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
592 -mdsp  -mpaired-single  -mips3d @gol
593 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
594 -G@var{num}  -membedded-data  -mno-embedded-data @gol
595 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
596 -msplit-addresses  -mno-split-addresses  @gol
597 -mexplicit-relocs  -mno-explicit-relocs  @gol
598 -mcheck-zero-division  -mno-check-zero-division @gol
599 -mdivide-traps  -mdivide-breaks @gol
600 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
601 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
602 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
603 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
604 -mfix-sb1  -mno-fix-sb1 @gol
605 -mflush-func=@var{func}  -mno-flush-func @gol
606 -mbranch-likely  -mno-branch-likely @gol
607 -mfp-exceptions -mno-fp-exceptions @gol
608 -mvr4130-align -mno-vr4130-align}
610 @emph{MMIX Options}
611 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
612 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
613 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
614 -mno-base-addresses  -msingle-exit  -mno-single-exit}
616 @emph{MN10300 Options}
617 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
618 -mam33  -mno-am33 @gol
619 -mam33-2  -mno-am33-2 @gol
620 -mreturn-pointer-on-d0 @gol
621 -mno-crt0  -mrelax}
623 @emph{MT Options}
624 @gccoptlist{-mno-crt0 -mbacc -msim @gol
625 -march=@var{cpu-type} }
627 @emph{PDP-11 Options}
628 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
629 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
630 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
631 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
632 -mbranch-expensive  -mbranch-cheap @gol
633 -msplit  -mno-split  -munix-asm  -mdec-asm}
635 @emph{PowerPC Options}
636 See RS/6000 and PowerPC Options.
638 @emph{RS/6000 and PowerPC Options}
639 @gccoptlist{-mcpu=@var{cpu-type} @gol
640 -mtune=@var{cpu-type} @gol
641 -mpower  -mno-power  -mpower2  -mno-power2 @gol
642 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
643 -maltivec  -mno-altivec @gol
644 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
645 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
646 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
647 -mnew-mnemonics  -mold-mnemonics @gol
648 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
649 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
650 -malign-power  -malign-natural @gol
651 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
652 -mstring  -mno-string  -mupdate  -mno-update @gol
653 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
654 -mstrict-align  -mno-strict-align  -mrelocatable @gol
655 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
656 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
657 -mdynamic-no-pic  -maltivec  -mswdiv @gol
658 -mprioritize-restricted-insns=@var{priority} @gol
659 -msched-costly-dep=@var{dependence_type} @gol
660 -minsert-sched-nops=@var{scheme} @gol
661 -mcall-sysv  -mcall-netbsd @gol
662 -maix-struct-return  -msvr4-struct-return @gol
663 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
664 -misel -mno-isel @gol
665 -misel=yes  -misel=no @gol
666 -mspe -mno-spe @gol
667 -mspe=yes  -mspe=no @gol
668 -mvrsave -mno-vrsave @gol
669 -mmulhw -mno-mulhw @gol
670 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
671 -mprototype  -mno-prototype @gol
672 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
673 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
675 @emph{S/390 and zSeries Options}
676 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
677 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
678 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
679 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
680 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
681 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
682 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
684 @emph{SH Options}
685 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
686 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
687 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
688 -m5-64media  -m5-64media-nofpu @gol
689 -m5-32media  -m5-32media-nofpu @gol
690 -m5-compact  -m5-compact-nofpu @gol
691 -mb  -ml  -mdalign  -mrelax @gol
692 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
693 -mieee  -misize  -mpadstruct  -mspace @gol
694 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
695 -mdivsi3_libfunc=@var{name}  @gol
696 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
697  -minvalid-symbols}
699 @emph{SPARC Options}
700 @gccoptlist{-mcpu=@var{cpu-type} @gol
701 -mtune=@var{cpu-type} @gol
702 -mcmodel=@var{code-model} @gol
703 -m32  -m64  -mapp-regs  -mno-app-regs @gol
704 -mfaster-structs  -mno-faster-structs @gol
705 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
706 -mhard-quad-float  -msoft-quad-float @gol
707 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
708 -mstack-bias  -mno-stack-bias @gol
709 -munaligned-doubles  -mno-unaligned-doubles @gol
710 -mv8plus  -mno-v8plus  -mvis  -mno-vis
711 -threads -pthreads -pthread}
713 @emph{System V Options}
714 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
716 @emph{TMS320C3x/C4x Options}
717 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
718 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
719 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
720 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
722 @emph{V850 Options}
723 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
724 -mprolog-function  -mno-prolog-function  -mspace @gol
725 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
726 -mapp-regs  -mno-app-regs @gol
727 -mdisable-callt  -mno-disable-callt @gol
728 -mv850e1 @gol
729 -mv850e @gol
730 -mv850  -mbig-switch}
732 @emph{VAX Options}
733 @gccoptlist{-mg  -mgnu  -munix}
735 @emph{x86-64 Options}
736 See i386 and x86-64 Options.
738 @emph{Xstormy16 Options}
739 @gccoptlist{-msim}
741 @emph{Xtensa Options}
742 @gccoptlist{-mconst16 -mno-const16 @gol
743 -mfused-madd  -mno-fused-madd @gol
744 -mtext-section-literals  -mno-text-section-literals @gol
745 -mtarget-align  -mno-target-align @gol
746 -mlongcalls  -mno-longcalls}
748 @emph{zSeries Options}
749 See S/390 and zSeries Options.
751 @item Code Generation Options
752 @xref{Code Gen Options,,Options for Code Generation Conventions}.
753 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
754 -ffixed-@var{reg}  -fexceptions @gol
755 -fnon-call-exceptions  -funwind-tables @gol
756 -fasynchronous-unwind-tables @gol
757 -finhibit-size-directive  -finstrument-functions @gol
758 -fno-common  -fno-ident @gol
759 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
760 -fno-jump-tables @gol
761 -freg-struct-return  -fshared-data  -fshort-enums @gol
762 -fshort-double  -fshort-wchar @gol
763 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
764 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
765 -fargument-alias  -fargument-noalias @gol
766 -fargument-noalias-global  -fleading-underscore @gol
767 -ftls-model=@var{model} @gol
768 -ftrapv  -fwrapv  -fbounds-check @gol
769 -fvisibility  -fopenmp}
770 @end table
772 @menu
773 * Overall Options::     Controlling the kind of output:
774                         an executable, object files, assembler files,
775                         or preprocessed source.
776 * C Dialect Options::   Controlling the variant of C language compiled.
777 * C++ Dialect Options:: Variations on C++.
778 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
779                         and Objective-C++.
780 * Language Independent Options:: Controlling how diagnostics should be
781                         formatted.
782 * Warning Options::     How picky should the compiler be?
783 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
784 * Optimize Options::    How much optimization?
785 * Preprocessor Options:: Controlling header files and macro definitions.
786                          Also, getting dependency information for Make.
787 * Assembler Options::   Passing options to the assembler.
788 * Link Options::        Specifying libraries and so on.
789 * Directory Options::   Where to find header files and libraries.
790                         Where to find the compiler executable files.
791 * Spec Files::          How to pass switches to sub-processes.
792 * Target Options::      Running a cross-compiler, or an old version of GCC.
793 @end menu
795 @node Overall Options
796 @section Options Controlling the Kind of Output
798 Compilation can involve up to four stages: preprocessing, compilation
799 proper, assembly and linking, always in that order.  GCC is capable of
800 preprocessing and compiling several files either into several
801 assembler input files, or into one assembler input file; then each
802 assembler input file produces an object file, and linking combines all
803 the object files (those newly compiled, and those specified as input)
804 into an executable file.
806 @cindex file name suffix
807 For any given input file, the file name suffix determines what kind of
808 compilation is done:
810 @table @gcctabopt
811 @item @var{file}.c
812 C source code which must be preprocessed.
814 @item @var{file}.i
815 C source code which should not be preprocessed.
817 @item @var{file}.ii
818 C++ source code which should not be preprocessed.
820 @item @var{file}.m
821 Objective-C source code.  Note that you must link with the @file{libobjc}
822 library to make an Objective-C program work.
824 @item @var{file}.mi
825 Objective-C source code which should not be preprocessed.
827 @item @var{file}.mm
828 @itemx @var{file}.M
829 Objective-C++ source code.  Note that you must link with the @file{libobjc}
830 library to make an Objective-C++ program work.  Note that @samp{.M} refers
831 to a literal capital M@.
833 @item @var{file}.mii
834 Objective-C++ source code which should not be preprocessed.
836 @item @var{file}.h
837 C, C++, Objective-C or Objective-C++ header file to be turned into a
838 precompiled header.
840 @item @var{file}.cc
841 @itemx @var{file}.cp
842 @itemx @var{file}.cxx
843 @itemx @var{file}.cpp
844 @itemx @var{file}.CPP
845 @itemx @var{file}.c++
846 @itemx @var{file}.C
847 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
848 the last two letters must both be literally @samp{x}.  Likewise,
849 @samp{.C} refers to a literal capital C@.
851 @item @var{file}.mm
852 @itemx @var{file}.M
853 Objective-C++ source code which must be preprocessed.
855 @item @var{file}.mii
856 Objective-C++ source code which should not be preprocessed.
858 @item @var{file}.hh
859 @itemx @var{file}.H
860 C++ header file to be turned into a precompiled header.
862 @item @var{file}.f
863 @itemx @var{file}.for
864 @itemx @var{file}.FOR
865 Fixed form Fortran source code which should not be preprocessed.
867 @item @var{file}.F
868 @itemx @var{file}.fpp
869 @itemx @var{file}.FPP
870 Fixed form Fortran source code which must be preprocessed (with the traditional
871 preprocessor).
873 @item @var{file}.f90
874 @itemx @var{file}.f95
875 Free form Fortran source code which should not be preprocessed.
877 @item @var{file}.F90
878 @itemx @var{file}.F95
879 Free form Fortran source code which must be preprocessed (with the
880 traditional preprocessor).
882 @c FIXME: Descriptions of Java file types.
883 @c @var{file}.java
884 @c @var{file}.class
885 @c @var{file}.zip
886 @c @var{file}.jar
888 @item @var{file}.ads
889 Ada source code file which contains a library unit declaration (a
890 declaration of a package, subprogram, or generic, or a generic
891 instantiation), or a library unit renaming declaration (a package,
892 generic, or subprogram renaming declaration).  Such files are also
893 called @dfn{specs}.
895 @itemx @var{file}.adb
896 Ada source code file containing a library unit body (a subprogram or
897 package body).  Such files are also called @dfn{bodies}.
899 @c GCC also knows about some suffixes for languages not yet included:
900 @c Pascal:
901 @c @var{file}.p
902 @c @var{file}.pas
903 @c Ratfor:
904 @c @var{file}.r
906 @item @var{file}.s
907 Assembler code.
909 @item @var{file}.S
910 Assembler code which must be preprocessed.
912 @item @var{other}
913 An object file to be fed straight into linking.
914 Any file name with no recognized suffix is treated this way.
915 @end table
917 @opindex x
918 You can specify the input language explicitly with the @option{-x} option:
920 @table @gcctabopt
921 @item -x @var{language}
922 Specify explicitly the @var{language} for the following input files
923 (rather than letting the compiler choose a default based on the file
924 name suffix).  This option applies to all following input files until
925 the next @option{-x} option.  Possible values for @var{language} are:
926 @smallexample
927 c  c-header  c-cpp-output
928 c++  c++-header  c++-cpp-output
929 objective-c  objective-c-header  objective-c-cpp-output
930 objective-c++ objective-c++-header objective-c++-cpp-output
931 assembler  assembler-with-cpp
933 f77  f77-cpp-input
934 f95  f95-cpp-input
935 java
936 treelang
937 @end smallexample
939 @item -x none
940 Turn off any specification of a language, so that subsequent files are
941 handled according to their file name suffixes (as they are if @option{-x}
942 has not been used at all).
944 @item -pass-exit-codes
945 @opindex pass-exit-codes
946 Normally the @command{gcc} program will exit with the code of 1 if any
947 phase of the compiler returns a non-success return code.  If you specify
948 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
949 numerically highest error produced by any phase that returned an error
950 indication.
951 @end table
953 If you only want some of the stages of compilation, you can use
954 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
955 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
956 @command{gcc} is to stop.  Note that some combinations (for example,
957 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
959 @table @gcctabopt
960 @item -c
961 @opindex c
962 Compile or assemble the source files, but do not link.  The linking
963 stage simply is not done.  The ultimate output is in the form of an
964 object file for each source file.
966 By default, the object file name for a source file is made by replacing
967 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
969 Unrecognized input files, not requiring compilation or assembly, are
970 ignored.
972 @item -S
973 @opindex S
974 Stop after the stage of compilation proper; do not assemble.  The output
975 is in the form of an assembler code file for each non-assembler input
976 file specified.
978 By default, the assembler file name for a source file is made by
979 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
981 Input files that don't require compilation are ignored.
983 @item -E
984 @opindex E
985 Stop after the preprocessing stage; do not run the compiler proper.  The
986 output is in the form of preprocessed source code, which is sent to the
987 standard output.
989 Input files which don't require preprocessing are ignored.
991 @cindex output file option
992 @item -o @var{file}
993 @opindex o
994 Place output in file @var{file}.  This applies regardless to whatever
995 sort of output is being produced, whether it be an executable file,
996 an object file, an assembler file or preprocessed C code.
998 If @option{-o} is not specified, the default is to put an executable
999 file in @file{a.out}, the object file for
1000 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1001 assembler file in @file{@var{source}.s}, a precompiled header file in
1002 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1003 standard output.
1005 @item -v
1006 @opindex v
1007 Print (on standard error output) the commands executed to run the stages
1008 of compilation.  Also print the version number of the compiler driver
1009 program and of the preprocessor and the compiler proper.
1011 @item -###
1012 @opindex ###
1013 Like @option{-v} except the commands are not executed and all command
1014 arguments are quoted.  This is useful for shell scripts to capture the
1015 driver-generated command lines.
1017 @item -pipe
1018 @opindex pipe
1019 Use pipes rather than temporary files for communication between the
1020 various stages of compilation.  This fails to work on some systems where
1021 the assembler is unable to read from a pipe; but the GNU assembler has
1022 no trouble.
1024 @item -combine
1025 @opindex combine
1026 If you are compiling multiple source files, this option tells the driver
1027 to pass all the source files to the compiler at once (for those
1028 languages for which the compiler can handle this).  This will allow
1029 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1030 language for which this is supported is C@.  If you pass source files for
1031 multiple languages to the driver, using this option, the driver will invoke
1032 the compiler(s) that support IMA once each, passing each compiler all the
1033 source files appropriate for it.  For those languages that do not support
1034 IMA this option will be ignored, and the compiler will be invoked once for
1035 each source file in that language.  If you use this option in conjunction
1036 with @option{-save-temps}, the compiler will generate multiple
1037 pre-processed files
1038 (one for each source file), but only one (combined) @file{.o} or
1039 @file{.s} file.
1041 @item --help
1042 @opindex help
1043 Print (on the standard output) a description of the command line options
1044 understood by @command{gcc}.  If the @option{-v} option is also specified
1045 then @option{--help} will also be passed on to the various processes
1046 invoked by @command{gcc}, so that they can display the command line options
1047 they accept.  If the @option{-Wextra} option is also specified then command
1048 line options which have no documentation associated with them will also
1049 be displayed.
1051 @item --target-help
1052 @opindex target-help
1053 Print (on the standard output) a description of target specific command
1054 line options for each tool.
1056 @item --version
1057 @opindex version
1058 Display the version number and copyrights of the invoked GCC@.
1060 @include @value{srcdir}/../libiberty/at-file.texi
1061 @end table
1063 @node Invoking G++
1064 @section Compiling C++ Programs
1066 @cindex suffixes for C++ source
1067 @cindex C++ source file suffixes
1068 C++ source files conventionally use one of the suffixes @samp{.C},
1069 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1070 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1071 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1072 files with these names and compiles them as C++ programs even if you
1073 call the compiler the same way as for compiling C programs (usually
1074 with the name @command{gcc}).
1076 @findex g++
1077 @findex c++
1078 However, C++ programs often require class libraries as well as a
1079 compiler that understands the C++ language---and under some
1080 circumstances, you might want to compile programs or header files from
1081 standard input, or otherwise without a suffix that flags them as C++
1082 programs.  You might also like to precompile a C header file with a
1083 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1084 program that calls GCC with the default language set to C++, and
1085 automatically specifies linking against the C++ library.  On many
1086 systems, @command{g++} is also installed with the name @command{c++}.
1088 @cindex invoking @command{g++}
1089 When you compile C++ programs, you may specify many of the same
1090 command-line options that you use for compiling programs in any
1091 language; or command-line options meaningful for C and related
1092 languages; or options that are meaningful only for C++ programs.
1093 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1094 explanations of options for languages related to C@.
1095 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1096 explanations of options that are meaningful only for C++ programs.
1098 @node C Dialect Options
1099 @section Options Controlling C Dialect
1100 @cindex dialect options
1101 @cindex language dialect options
1102 @cindex options, dialect
1104 The following options control the dialect of C (or languages derived
1105 from C, such as C++, Objective-C and Objective-C++) that the compiler
1106 accepts:
1108 @table @gcctabopt
1109 @cindex ANSI support
1110 @cindex ISO support
1111 @item -ansi
1112 @opindex ansi
1113 In C mode, support all ISO C90 programs.  In C++ mode,
1114 remove GNU extensions that conflict with ISO C++.
1116 This turns off certain features of GCC that are incompatible with ISO
1117 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1118 such as the @code{asm} and @code{typeof} keywords, and
1119 predefined macros such as @code{unix} and @code{vax} that identify the
1120 type of system you are using.  It also enables the undesirable and
1121 rarely used ISO trigraph feature.  For the C compiler,
1122 it disables recognition of C++ style @samp{//} comments as well as
1123 the @code{inline} keyword.
1125 The alternate keywords @code{__asm__}, @code{__extension__},
1126 @code{__inline__} and @code{__typeof__} continue to work despite
1127 @option{-ansi}.  You would not want to use them in an ISO C program, of
1128 course, but it is useful to put them in header files that might be included
1129 in compilations done with @option{-ansi}.  Alternate predefined macros
1130 such as @code{__unix__} and @code{__vax__} are also available, with or
1131 without @option{-ansi}.
1133 The @option{-ansi} option does not cause non-ISO programs to be
1134 rejected gratuitously.  For that, @option{-pedantic} is required in
1135 addition to @option{-ansi}.  @xref{Warning Options}.
1137 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1138 option is used.  Some header files may notice this macro and refrain
1139 from declaring certain functions or defining certain macros that the
1140 ISO standard doesn't call for; this is to avoid interfering with any
1141 programs that might use these names for other things.
1143 Functions which would normally be built in but do not have semantics
1144 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1145 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1146 built-in functions provided by GCC}, for details of the functions
1147 affected.
1149 @item -std=
1150 @opindex std
1151 Determine the language standard.  This option is currently only
1152 supported when compiling C or C++.  A value for this option must be
1153 provided; possible values are
1155 @table @samp
1156 @item c89
1157 @itemx iso9899:1990
1158 ISO C90 (same as @option{-ansi}).
1160 @item iso9899:199409
1161 ISO C90 as modified in amendment 1.
1163 @item c99
1164 @itemx c9x
1165 @itemx iso9899:1999
1166 @itemx iso9899:199x
1167 ISO C99.  Note that this standard is not yet fully supported; see
1168 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1169 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1171 @item gnu89
1172 Default, ISO C90 plus GNU extensions (including some C99 features).
1174 @item gnu99
1175 @itemx gnu9x
1176 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1177 this will become the default.  The name @samp{gnu9x} is deprecated.
1179 @item c++98
1180 The 1998 ISO C++ standard plus amendments.
1182 @item gnu++98
1183 The same as @option{-std=c++98} plus GNU extensions.  This is the
1184 default for C++ code.
1185 @end table
1187 Even when this option is not specified, you can still use some of the
1188 features of newer standards in so far as they do not conflict with
1189 previous C standards.  For example, you may use @code{__restrict__} even
1190 when @option{-std=c99} is not specified.
1192 The @option{-std} options specifying some version of ISO C have the same
1193 effects as @option{-ansi}, except that features that were not in ISO C90
1194 but are in the specified version (for example, @samp{//} comments and
1195 the @code{inline} keyword in ISO C99) are not disabled.
1197 @xref{Standards,,Language Standards Supported by GCC}, for details of
1198 these standard versions.
1200 @item -aux-info @var{filename}
1201 @opindex aux-info
1202 Output to the given filename prototyped declarations for all functions
1203 declared and/or defined in a translation unit, including those in header
1204 files.  This option is silently ignored in any language other than C@.
1206 Besides declarations, the file indicates, in comments, the origin of
1207 each declaration (source file and line), whether the declaration was
1208 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1209 @samp{O} for old, respectively, in the first character after the line
1210 number and the colon), and whether it came from a declaration or a
1211 definition (@samp{C} or @samp{F}, respectively, in the following
1212 character).  In the case of function definitions, a K&R-style list of
1213 arguments followed by their declarations is also provided, inside
1214 comments, after the declaration.
1216 @item -fno-asm
1217 @opindex fno-asm
1218 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1219 keyword, so that code can use these words as identifiers.  You can use
1220 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1221 instead.  @option{-ansi} implies @option{-fno-asm}.
1223 In C++, this switch only affects the @code{typeof} keyword, since
1224 @code{asm} and @code{inline} are standard keywords.  You may want to
1225 use the @option{-fno-gnu-keywords} flag instead, which has the same
1226 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1227 switch only affects the @code{asm} and @code{typeof} keywords, since
1228 @code{inline} is a standard keyword in ISO C99.
1230 @item -fno-builtin
1231 @itemx -fno-builtin-@var{function}
1232 @opindex fno-builtin
1233 @cindex built-in functions
1234 Don't recognize built-in functions that do not begin with
1235 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1236 functions provided by GCC}, for details of the functions affected,
1237 including those which are not built-in functions when @option{-ansi} or
1238 @option{-std} options for strict ISO C conformance are used because they
1239 do not have an ISO standard meaning.
1241 GCC normally generates special code to handle certain built-in functions
1242 more efficiently; for instance, calls to @code{alloca} may become single
1243 instructions that adjust the stack directly, and calls to @code{memcpy}
1244 may become inline copy loops.  The resulting code is often both smaller
1245 and faster, but since the function calls no longer appear as such, you
1246 cannot set a breakpoint on those calls, nor can you change the behavior
1247 of the functions by linking with a different library.  In addition,
1248 when a function is recognized as a built-in function, GCC may use
1249 information about that function to warn about problems with calls to
1250 that function, or to generate more efficient code, even if the
1251 resulting code still contains calls to that function.  For example,
1252 warnings are given with @option{-Wformat} for bad calls to
1253 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1254 known not to modify global memory.
1256 With the @option{-fno-builtin-@var{function}} option
1257 only the built-in function @var{function} is
1258 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1259 function is named this is not built-in in this version of GCC, this
1260 option is ignored.  There is no corresponding
1261 @option{-fbuiltin-@var{function}} option; if you wish to enable
1262 built-in functions selectively when using @option{-fno-builtin} or
1263 @option{-ffreestanding}, you may define macros such as:
1265 @smallexample
1266 #define abs(n)          __builtin_abs ((n))
1267 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1268 @end smallexample
1270 @item -fhosted
1271 @opindex fhosted
1272 @cindex hosted environment
1274 Assert that compilation takes place in a hosted environment.  This implies
1275 @option{-fbuiltin}.  A hosted environment is one in which the
1276 entire standard library is available, and in which @code{main} has a return
1277 type of @code{int}.  Examples are nearly everything except a kernel.
1278 This is equivalent to @option{-fno-freestanding}.
1280 @item -ffreestanding
1281 @opindex ffreestanding
1282 @cindex hosted environment
1284 Assert that compilation takes place in a freestanding environment.  This
1285 implies @option{-fno-builtin}.  A freestanding environment
1286 is one in which the standard library may not exist, and program startup may
1287 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1288 This is equivalent to @option{-fno-hosted}.
1290 @xref{Standards,,Language Standards Supported by GCC}, for details of
1291 freestanding and hosted environments.
1293 @item -fms-extensions
1294 @opindex fms-extensions
1295 Accept some non-standard constructs used in Microsoft header files.
1297 Some cases of unnamed fields in structures and unions are only
1298 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1299 fields within structs/unions}, for details.
1301 @item -trigraphs
1302 @opindex trigraphs
1303 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1304 options for strict ISO C conformance) implies @option{-trigraphs}.
1306 @item -no-integrated-cpp
1307 @opindex no-integrated-cpp
1308 Performs a compilation in two passes: preprocessing and compiling.  This
1309 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1310 @option{-B} option.  The user supplied compilation step can then add in
1311 an additional preprocessing step after normal preprocessing but before
1312 compiling.  The default is to use the integrated cpp (internal cpp)
1314 The semantics of this option will change if "cc1", "cc1plus", and
1315 "cc1obj" are merged.
1317 @cindex traditional C language
1318 @cindex C language, traditional
1319 @item -traditional
1320 @itemx -traditional-cpp
1321 @opindex traditional-cpp
1322 @opindex traditional
1323 Formerly, these options caused GCC to attempt to emulate a pre-standard
1324 C compiler.  They are now only supported with the @option{-E} switch.
1325 The preprocessor continues to support a pre-standard mode.  See the GNU
1326 CPP manual for details.
1328 @item -fcond-mismatch
1329 @opindex fcond-mismatch
1330 Allow conditional expressions with mismatched types in the second and
1331 third arguments.  The value of such an expression is void.  This option
1332 is not supported for C++.
1334 @item -funsigned-char
1335 @opindex funsigned-char
1336 Let the type @code{char} be unsigned, like @code{unsigned char}.
1338 Each kind of machine has a default for what @code{char} should
1339 be.  It is either like @code{unsigned char} by default or like
1340 @code{signed char} by default.
1342 Ideally, a portable program should always use @code{signed char} or
1343 @code{unsigned char} when it depends on the signedness of an object.
1344 But many programs have been written to use plain @code{char} and
1345 expect it to be signed, or expect it to be unsigned, depending on the
1346 machines they were written for.  This option, and its inverse, let you
1347 make such a program work with the opposite default.
1349 The type @code{char} is always a distinct type from each of
1350 @code{signed char} or @code{unsigned char}, even though its behavior
1351 is always just like one of those two.
1353 @item -fsigned-char
1354 @opindex fsigned-char
1355 Let the type @code{char} be signed, like @code{signed char}.
1357 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1358 the negative form of @option{-funsigned-char}.  Likewise, the option
1359 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1361 @item -fsigned-bitfields
1362 @itemx -funsigned-bitfields
1363 @itemx -fno-signed-bitfields
1364 @itemx -fno-unsigned-bitfields
1365 @opindex fsigned-bitfields
1366 @opindex funsigned-bitfields
1367 @opindex fno-signed-bitfields
1368 @opindex fno-unsigned-bitfields
1369 These options control whether a bit-field is signed or unsigned, when the
1370 declaration does not use either @code{signed} or @code{unsigned}.  By
1371 default, such a bit-field is signed, because this is consistent: the
1372 basic integer types such as @code{int} are signed types.
1373 @end table
1375 @node C++ Dialect Options
1376 @section Options Controlling C++ Dialect
1378 @cindex compiler options, C++
1379 @cindex C++ options, command line
1380 @cindex options, C++
1381 This section describes the command-line options that are only meaningful
1382 for C++ programs; but you can also use most of the GNU compiler options
1383 regardless of what language your program is in.  For example, you
1384 might compile a file @code{firstClass.C} like this:
1386 @smallexample
1387 g++ -g -frepo -O -c firstClass.C
1388 @end smallexample
1390 @noindent
1391 In this example, only @option{-frepo} is an option meant
1392 only for C++ programs; you can use the other options with any
1393 language supported by GCC@.
1395 Here is a list of options that are @emph{only} for compiling C++ programs:
1397 @table @gcctabopt
1399 @item -fabi-version=@var{n}
1400 @opindex fabi-version
1401 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1402 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1403 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1404 the version that conforms most closely to the C++ ABI specification.
1405 Therefore, the ABI obtained using version 0 will change as ABI bugs
1406 are fixed.
1408 The default is version 2.
1410 @item -fno-access-control
1411 @opindex fno-access-control
1412 Turn off all access checking.  This switch is mainly useful for working
1413 around bugs in the access control code.
1415 @item -fcheck-new
1416 @opindex fcheck-new
1417 Check that the pointer returned by @code{operator new} is non-null
1418 before attempting to modify the storage allocated.  This check is
1419 normally unnecessary because the C++ standard specifies that
1420 @code{operator new} will only return @code{0} if it is declared
1421 @samp{throw()}, in which case the compiler will always check the
1422 return value even without this option.  In all other cases, when
1423 @code{operator new} has a non-empty exception specification, memory
1424 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1425 @samp{new (nothrow)}.
1427 @item -fconserve-space
1428 @opindex fconserve-space
1429 Put uninitialized or runtime-initialized global variables into the
1430 common segment, as C does.  This saves space in the executable at the
1431 cost of not diagnosing duplicate definitions.  If you compile with this
1432 flag and your program mysteriously crashes after @code{main()} has
1433 completed, you may have an object that is being destroyed twice because
1434 two definitions were merged.
1436 This option is no longer useful on most targets, now that support has
1437 been added for putting variables into BSS without making them common.
1439 @item -ffriend-injection
1440 @opindex ffriend-injection
1441 Inject friend functions into the enclosing namespace, so that they are
1442 visible outside the scope of the class in which they are declared.
1443 Friend functions were documented to work this way in the old Annotated
1444 C++ Reference Manual, and versions of G++ before 4.1 always worked
1445 that way.  However, in ISO C++ a friend function which is not declared
1446 in an enclosing scope can only be found using argument dependent
1447 lookup.  This option causes friends to be injected as they were in
1448 earlier releases.
1450 This option is for compatibility, and may be removed in a future
1451 release of G++.
1453 @item -fno-elide-constructors
1454 @opindex fno-elide-constructors
1455 The C++ standard allows an implementation to omit creating a temporary
1456 which is only used to initialize another object of the same type.
1457 Specifying this option disables that optimization, and forces G++ to
1458 call the copy constructor in all cases.
1460 @item -fno-enforce-eh-specs
1461 @opindex fno-enforce-eh-specs
1462 Don't generate code to check for violation of exception specifications
1463 at runtime.  This option violates the C++ standard, but may be useful
1464 for reducing code size in production builds, much like defining
1465 @samp{NDEBUG}.  This does not give user code permission to throw
1466 exceptions in violation of the exception specifications; the compiler
1467 will still optimize based on the specifications, so throwing an
1468 unexpected exception will result in undefined behavior.
1470 @item -ffor-scope
1471 @itemx -fno-for-scope
1472 @opindex ffor-scope
1473 @opindex fno-for-scope
1474 If @option{-ffor-scope} is specified, the scope of variables declared in
1475 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1476 as specified by the C++ standard.
1477 If @option{-fno-for-scope} is specified, the scope of variables declared in
1478 a @i{for-init-statement} extends to the end of the enclosing scope,
1479 as was the case in old versions of G++, and other (traditional)
1480 implementations of C++.
1482 The default if neither flag is given to follow the standard,
1483 but to allow and give a warning for old-style code that would
1484 otherwise be invalid, or have different behavior.
1486 @item -fno-gnu-keywords
1487 @opindex fno-gnu-keywords
1488 Do not recognize @code{typeof} as a keyword, so that code can use this
1489 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1490 @option{-ansi} implies @option{-fno-gnu-keywords}.
1492 @item -fno-implicit-templates
1493 @opindex fno-implicit-templates
1494 Never emit code for non-inline templates which are instantiated
1495 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1496 @xref{Template Instantiation}, for more information.
1498 @item -fno-implicit-inline-templates
1499 @opindex fno-implicit-inline-templates
1500 Don't emit code for implicit instantiations of inline templates, either.
1501 The default is to handle inlines differently so that compiles with and
1502 without optimization will need the same set of explicit instantiations.
1504 @item -fno-implement-inlines
1505 @opindex fno-implement-inlines
1506 To save space, do not emit out-of-line copies of inline functions
1507 controlled by @samp{#pragma implementation}.  This will cause linker
1508 errors if these functions are not inlined everywhere they are called.
1510 @item -fms-extensions
1511 @opindex fms-extensions
1512 Disable pedantic warnings about constructs used in MFC, such as implicit
1513 int and getting a pointer to member function via non-standard syntax.
1515 @item -fno-nonansi-builtins
1516 @opindex fno-nonansi-builtins
1517 Disable built-in declarations of functions that are not mandated by
1518 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1519 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1521 @item -fno-operator-names
1522 @opindex fno-operator-names
1523 Do not treat the operator name keywords @code{and}, @code{bitand},
1524 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1525 synonyms as keywords.
1527 @item -fno-optional-diags
1528 @opindex fno-optional-diags
1529 Disable diagnostics that the standard says a compiler does not need to
1530 issue.  Currently, the only such diagnostic issued by G++ is the one for
1531 a name having multiple meanings within a class.
1533 @item -fpermissive
1534 @opindex fpermissive
1535 Downgrade some diagnostics about nonconformant code from errors to
1536 warnings.  Thus, using @option{-fpermissive} will allow some
1537 nonconforming code to compile.
1539 @item -frepo
1540 @opindex frepo
1541 Enable automatic template instantiation at link time.  This option also
1542 implies @option{-fno-implicit-templates}.  @xref{Template
1543 Instantiation}, for more information.
1545 @item -fno-rtti
1546 @opindex fno-rtti
1547 Disable generation of information about every class with virtual
1548 functions for use by the C++ runtime type identification features
1549 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1550 of the language, you can save some space by using this flag.  Note that
1551 exception handling uses the same information, but it will generate it as
1552 needed.
1554 @item -fstats
1555 @opindex fstats
1556 Emit statistics about front-end processing at the end of the compilation.
1557 This information is generally only useful to the G++ development team.
1559 @item -ftemplate-depth-@var{n}
1560 @opindex ftemplate-depth
1561 Set the maximum instantiation depth for template classes to @var{n}.
1562 A limit on the template instantiation depth is needed to detect
1563 endless recursions during template class instantiation.  ANSI/ISO C++
1564 conforming programs must not rely on a maximum depth greater than 17.
1566 @item -fno-threadsafe-statics
1567 @opindex fno-threadsafe-statics
1568 Do not emit the extra code to use the routines specified in the C++
1569 ABI for thread-safe initialization of local statics.  You can use this
1570 option to reduce code size slightly in code that doesn't need to be
1571 thread-safe.
1573 @item -fuse-cxa-atexit
1574 @opindex fuse-cxa-atexit
1575 Register destructors for objects with static storage duration with the
1576 @code{__cxa_atexit} function rather than the @code{atexit} function.
1577 This option is required for fully standards-compliant handling of static
1578 destructors, but will only work if your C library supports
1579 @code{__cxa_atexit}.
1581 @item -fvisibility-inlines-hidden
1582 @opindex fvisibility-inlines-hidden
1583 Causes all inlined methods to be marked with
1584 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1585 appear in the export table of a DSO and do not require a PLT indirection
1586 when used within the DSO@.  Enabling this option can have a dramatic effect
1587 on load and link times of a DSO as it massively reduces the size of the
1588 dynamic export table when the library makes heavy use of templates.  While
1589 it can cause bloating through duplication of code within each DSO where
1590 it is used, often the wastage is less than the considerable space occupied
1591 by a long symbol name in the export table which is typical when using
1592 templates and namespaces.  For even more savings, combine with the
1593 @option{-fvisibility=hidden} switch.
1595 @item -fno-weak
1596 @opindex fno-weak
1597 Do not use weak symbol support, even if it is provided by the linker.
1598 By default, G++ will use weak symbols if they are available.  This
1599 option exists only for testing, and should not be used by end-users;
1600 it will result in inferior code and has no benefits.  This option may
1601 be removed in a future release of G++.
1603 @item -nostdinc++
1604 @opindex nostdinc++
1605 Do not search for header files in the standard directories specific to
1606 C++, but do still search the other standard directories.  (This option
1607 is used when building the C++ library.)
1608 @end table
1610 In addition, these optimization, warning, and code generation options
1611 have meanings only for C++ programs:
1613 @table @gcctabopt
1614 @item -fno-default-inline
1615 @opindex fno-default-inline
1616 Do not assume @samp{inline} for functions defined inside a class scope.
1617 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1618 functions will have linkage like inline functions; they just won't be
1619 inlined by default.
1621 @item -Wabi @r{(C++ only)}
1622 @opindex Wabi
1623 Warn when G++ generates code that is probably not compatible with the
1624 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1625 all such cases, there are probably some cases that are not warned about,
1626 even though G++ is generating incompatible code.  There may also be
1627 cases where warnings are emitted even though the code that is generated
1628 will be compatible.
1630 You should rewrite your code to avoid these warnings if you are
1631 concerned about the fact that code generated by G++ may not be binary
1632 compatible with code generated by other compilers.
1634 The known incompatibilities at this point include:
1636 @itemize @bullet
1638 @item
1639 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1640 pack data into the same byte as a base class.  For example:
1642 @smallexample
1643 struct A @{ virtual void f(); int f1 : 1; @};
1644 struct B : public A @{ int f2 : 1; @};
1645 @end smallexample
1647 @noindent
1648 In this case, G++ will place @code{B::f2} into the same byte
1649 as@code{A::f1}; other compilers will not.  You can avoid this problem
1650 by explicitly padding @code{A} so that its size is a multiple of the
1651 byte size on your platform; that will cause G++ and other compilers to
1652 layout @code{B} identically.
1654 @item
1655 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1656 tail padding when laying out virtual bases.  For example:
1658 @smallexample
1659 struct A @{ virtual void f(); char c1; @};
1660 struct B @{ B(); char c2; @};
1661 struct C : public A, public virtual B @{@};
1662 @end smallexample
1664 @noindent
1665 In this case, G++ will not place @code{B} into the tail-padding for
1666 @code{A}; other compilers will.  You can avoid this problem by
1667 explicitly padding @code{A} so that its size is a multiple of its
1668 alignment (ignoring virtual base classes); that will cause G++ and other
1669 compilers to layout @code{C} identically.
1671 @item
1672 Incorrect handling of bit-fields with declared widths greater than that
1673 of their underlying types, when the bit-fields appear in a union.  For
1674 example:
1676 @smallexample
1677 union U @{ int i : 4096; @};
1678 @end smallexample
1680 @noindent
1681 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1682 union too small by the number of bits in an @code{int}.
1684 @item
1685 Empty classes can be placed at incorrect offsets.  For example:
1687 @smallexample
1688 struct A @{@};
1690 struct B @{
1691   A a;
1692   virtual void f ();
1695 struct C : public B, public A @{@};
1696 @end smallexample
1698 @noindent
1699 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1700 it should be placed at offset zero.  G++ mistakenly believes that the
1701 @code{A} data member of @code{B} is already at offset zero.
1703 @item
1704 Names of template functions whose types involve @code{typename} or
1705 template template parameters can be mangled incorrectly.
1707 @smallexample
1708 template <typename Q>
1709 void f(typename Q::X) @{@}
1711 template <template <typename> class Q>
1712 void f(typename Q<int>::X) @{@}
1713 @end smallexample
1715 @noindent
1716 Instantiations of these templates may be mangled incorrectly.
1718 @end itemize
1720 @item -Wctor-dtor-privacy @r{(C++ only)}
1721 @opindex Wctor-dtor-privacy
1722 Warn when a class seems unusable because all the constructors or
1723 destructors in that class are private, and it has neither friends nor
1724 public static member functions.
1726 @item -Wnon-virtual-dtor @r{(C++ only)}
1727 @opindex Wnon-virtual-dtor
1728 Warn when a class appears to be polymorphic, thereby requiring a virtual
1729 destructor, yet it declares a non-virtual one.  This warning is also
1730 enabled if -Weffc++ is specified.
1732 @item -Wreorder @r{(C++ only)}
1733 @opindex Wreorder
1734 @cindex reordering, warning
1735 @cindex warning for reordering of member initializers
1736 Warn when the order of member initializers given in the code does not
1737 match the order in which they must be executed.  For instance:
1739 @smallexample
1740 struct A @{
1741   int i;
1742   int j;
1743   A(): j (0), i (1) @{ @}
1745 @end smallexample
1747 The compiler will rearrange the member initializers for @samp{i}
1748 and @samp{j} to match the declaration order of the members, emitting
1749 a warning to that effect.  This warning is enabled by @option{-Wall}.
1750 @end table
1752 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1754 @table @gcctabopt
1755 @item -Weffc++ @r{(C++ only)}
1756 @opindex Weffc++
1757 Warn about violations of the following style guidelines from Scott Meyers'
1758 @cite{Effective C++} book:
1760 @itemize @bullet
1761 @item
1762 Item 11:  Define a copy constructor and an assignment operator for classes
1763 with dynamically allocated memory.
1765 @item
1766 Item 12:  Prefer initialization to assignment in constructors.
1768 @item
1769 Item 14:  Make destructors virtual in base classes.
1771 @item
1772 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1774 @item
1775 Item 23:  Don't try to return a reference when you must return an object.
1777 @end itemize
1779 Also warn about violations of the following style guidelines from
1780 Scott Meyers' @cite{More Effective C++} book:
1782 @itemize @bullet
1783 @item
1784 Item 6:  Distinguish between prefix and postfix forms of increment and
1785 decrement operators.
1787 @item
1788 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1790 @end itemize
1792 When selecting this option, be aware that the standard library
1793 headers do not obey all of these guidelines; use @samp{grep -v}
1794 to filter out those warnings.
1796 @item -Wno-deprecated @r{(C++ only)}
1797 @opindex Wno-deprecated
1798 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1800 @item -Wstrict-null-sentinel @r{(C++ only)}
1801 @opindex Wstrict-null-sentinel
1802 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1803 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1804 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1805 it is guaranteed to of the same size as a pointer.  But this use is
1806 not portable across different compilers.
1808 @item -Wno-non-template-friend @r{(C++ only)}
1809 @opindex Wno-non-template-friend
1810 Disable warnings when non-templatized friend functions are declared
1811 within a template.  Since the advent of explicit template specification
1812 support in G++, if the name of the friend is an unqualified-id (i.e.,
1813 @samp{friend foo(int)}), the C++ language specification demands that the
1814 friend declare or define an ordinary, nontemplate function.  (Section
1815 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1816 could be interpreted as a particular specialization of a templatized
1817 function.  Because this non-conforming behavior is no longer the default
1818 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1819 check existing code for potential trouble spots and is on by default.
1820 This new compiler behavior can be turned off with
1821 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1822 but disables the helpful warning.
1824 @item -Wold-style-cast @r{(C++ only)}
1825 @opindex Wold-style-cast
1826 Warn if an old-style (C-style) cast to a non-void type is used within
1827 a C++ program.  The new-style casts (@samp{dynamic_cast},
1828 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1829 less vulnerable to unintended effects and much easier to search for.
1831 @item -Woverloaded-virtual @r{(C++ only)}
1832 @opindex Woverloaded-virtual
1833 @cindex overloaded virtual fn, warning
1834 @cindex warning for overloaded virtual fn
1835 Warn when a function declaration hides virtual functions from a
1836 base class.  For example, in:
1838 @smallexample
1839 struct A @{
1840   virtual void f();
1843 struct B: public A @{
1844   void f(int);
1846 @end smallexample
1848 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1849 like:
1851 @smallexample
1852 B* b;
1853 b->f();
1854 @end smallexample
1856 will fail to compile.
1858 @item -Wno-pmf-conversions @r{(C++ only)}
1859 @opindex Wno-pmf-conversions
1860 Disable the diagnostic for converting a bound pointer to member function
1861 to a plain pointer.
1863 @item -Wsign-promo @r{(C++ only)}
1864 @opindex Wsign-promo
1865 Warn when overload resolution chooses a promotion from unsigned or
1866 enumerated type to a signed type, over a conversion to an unsigned type of
1867 the same size.  Previous versions of G++ would try to preserve
1868 unsignedness, but the standard mandates the current behavior.
1870 @smallexample
1871 struct A @{
1872   operator int ();
1873   A& operator = (int);
1876 main ()
1878   A a,b;
1879   a = b;
1881 @end smallexample
1883 In this example, G++ will synthesize a default @samp{A& operator =
1884 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1885 @end table
1887 @node Objective-C and Objective-C++ Dialect Options
1888 @section Options Controlling Objective-C and Objective-C++ Dialects
1890 @cindex compiler options, Objective-C and Objective-C++
1891 @cindex Objective-C and Objective-C++ options, command line
1892 @cindex options, Objective-C and Objective-C++
1893 (NOTE: This manual does not describe the Objective-C and Objective-C++
1894 languages themselves.  See @xref{Standards,,Language Standards
1895 Supported by GCC}, for references.)
1897 This section describes the command-line options that are only meaningful
1898 for Objective-C and Objective-C++ programs, but you can also use most of
1899 the language-independent GNU compiler options.
1900 For example, you might compile a file @code{some_class.m} like this:
1902 @smallexample
1903 gcc -g -fgnu-runtime -O -c some_class.m
1904 @end smallexample
1906 @noindent
1907 In this example, @option{-fgnu-runtime} is an option meant only for
1908 Objective-C and Objective-C++ programs; you can use the other options with
1909 any language supported by GCC@.
1911 Note that since Objective-C is an extension of the C language, Objective-C
1912 compilations may also use options specific to the C front-end (e.g.,
1913 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1914 C++-specific options (e.g., @option{-Wabi}).
1916 Here is a list of options that are @emph{only} for compiling Objective-C
1917 and Objective-C++ programs:
1919 @table @gcctabopt
1920 @item -fconstant-string-class=@var{class-name}
1921 @opindex fconstant-string-class
1922 Use @var{class-name} as the name of the class to instantiate for each
1923 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1924 class name is @code{NXConstantString} if the GNU runtime is being used, and
1925 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1926 @option{-fconstant-cfstrings} option, if also present, will override the
1927 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1928 to be laid out as constant CoreFoundation strings.
1930 @item -fgnu-runtime
1931 @opindex fgnu-runtime
1932 Generate object code compatible with the standard GNU Objective-C
1933 runtime.  This is the default for most types of systems.
1935 @item -fnext-runtime
1936 @opindex fnext-runtime
1937 Generate output compatible with the NeXT runtime.  This is the default
1938 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1939 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1940 used.
1942 @item -fno-nil-receivers
1943 @opindex fno-nil-receivers
1944 Assume that all Objective-C message dispatches (e.g.,
1945 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1946 is not @code{nil}.  This allows for more efficient entry points in the runtime
1947 to be used.  Currently, this option is only available in conjunction with
1948 the NeXT runtime on Mac OS X 10.3 and later.
1950 @item -fobjc-call-cxx-cdtors
1951 @opindex fobjc-call-cxx-cdtors
1952 For each Objective-C class, check if any of its instance variables is a
1953 C++ object with a non-trivial default constructor.  If so, synthesize a
1954 special @code{- (id) .cxx_construct} instance method that will run
1955 non-trivial default constructors on any such instance variables, in order,
1956 and then return @code{self}.  Similarly, check if any instance variable
1957 is a C++ object with a non-trivial destructor, and if so, synthesize a
1958 special @code{- (void) .cxx_destruct} method that will run
1959 all such default destructors, in reverse order.
1961 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1962 thusly generated will only operate on instance variables declared in the
1963 current Objective-C class, and not those inherited from superclasses.  It
1964 is the responsibility of the Objective-C runtime to invoke all such methods
1965 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1966 will be invoked by the runtime immediately after a new object
1967 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1968 be invoked immediately before the runtime deallocates an object instance.
1970 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1971 support for invoking the @code{- (id) .cxx_construct} and
1972 @code{- (void) .cxx_destruct} methods.
1974 @item -fobjc-direct-dispatch
1975 @opindex fobjc-direct-dispatch
1976 Allow fast jumps to the message dispatcher.  On Darwin this is
1977 accomplished via the comm page.
1979 @item -fobjc-exceptions
1980 @opindex fobjc-exceptions
1981 Enable syntactic support for structured exception handling in Objective-C,
1982 similar to what is offered by C++ and Java.  This option is
1983 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
1984 earlier.
1986 @smallexample
1987   @@try @{
1988     @dots{}
1989        @@throw expr;
1990     @dots{}
1991   @}
1992   @@catch (AnObjCClass *exc) @{
1993     @dots{}
1994       @@throw expr;
1995     @dots{}
1996       @@throw;
1997     @dots{}
1998   @}
1999   @@catch (AnotherClass *exc) @{
2000     @dots{}
2001   @}
2002   @@catch (id allOthers) @{
2003     @dots{}
2004   @}
2005   @@finally @{
2006     @dots{}
2007       @@throw expr;
2008     @dots{}
2009   @}
2010 @end smallexample
2012 The @code{@@throw} statement may appear anywhere in an Objective-C or
2013 Objective-C++ program; when used inside of a @code{@@catch} block, the
2014 @code{@@throw} may appear without an argument (as shown above), in which case
2015 the object caught by the @code{@@catch} will be rethrown.
2017 Note that only (pointers to) Objective-C objects may be thrown and
2018 caught using this scheme.  When an object is thrown, it will be caught
2019 by the nearest @code{@@catch} clause capable of handling objects of that type,
2020 analogously to how @code{catch} blocks work in C++ and Java.  A
2021 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2022 any and all Objective-C exceptions not caught by previous @code{@@catch}
2023 clauses (if any).
2025 The @code{@@finally} clause, if present, will be executed upon exit from the
2026 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2027 regardless of whether any exceptions are thrown, caught or rethrown
2028 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2029 of the @code{finally} clause in Java.
2031 There are several caveats to using the new exception mechanism:
2033 @itemize @bullet
2034 @item
2035 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2036 idioms provided by the @code{NSException} class, the new
2037 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2038 systems, due to additional functionality needed in the (NeXT) Objective-C
2039 runtime.
2041 @item
2042 As mentioned above, the new exceptions do not support handling
2043 types other than Objective-C objects.   Furthermore, when used from
2044 Objective-C++, the Objective-C exception model does not interoperate with C++
2045 exceptions at this time.  This means you cannot @code{@@throw} an exception
2046 from Objective-C and @code{catch} it in C++, or vice versa
2047 (i.e., @code{throw @dots{} @@catch}).
2048 @end itemize
2050 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2051 blocks for thread-safe execution:
2053 @smallexample
2054   @@synchronized (ObjCClass *guard) @{
2055     @dots{}
2056   @}
2057 @end smallexample
2059 Upon entering the @code{@@synchronized} block, a thread of execution shall
2060 first check whether a lock has been placed on the corresponding @code{guard}
2061 object by another thread.  If it has, the current thread shall wait until
2062 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2063 the current thread will place its own lock on it, execute the code contained in
2064 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2065 making @code{guard} available to other threads).
2067 Unlike Java, Objective-C does not allow for entire methods to be marked
2068 @code{@@synchronized}.  Note that throwing exceptions out of
2069 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2070 to be unlocked properly.
2072 @item -fobjc-gc
2073 @opindex fobjc-gc
2074 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2076 @item -freplace-objc-classes
2077 @opindex freplace-objc-classes
2078 Emit a special marker instructing @command{ld(1)} not to statically link in
2079 the resulting object file, and allow @command{dyld(1)} to load it in at
2080 run time instead.  This is used in conjunction with the Fix-and-Continue
2081 debugging mode, where the object file in question may be recompiled and
2082 dynamically reloaded in the course of program execution, without the need
2083 to restart the program itself.  Currently, Fix-and-Continue functionality
2084 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2085 and later.
2087 @item -fzero-link
2088 @opindex fzero-link
2089 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2090 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2091 compile time) with static class references that get initialized at load time,
2092 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2093 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2094 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2095 for individual class implementations to be modified during program execution.
2097 @item -gen-decls
2098 @opindex gen-decls
2099 Dump interface declarations for all classes seen in the source file to a
2100 file named @file{@var{sourcename}.decl}.
2102 @item -Wassign-intercept
2103 @opindex Wassign-intercept
2104 Warn whenever an Objective-C assignment is being intercepted by the
2105 garbage collector.
2107 @item -Wno-protocol
2108 @opindex Wno-protocol
2109 If a class is declared to implement a protocol, a warning is issued for
2110 every method in the protocol that is not implemented by the class.  The
2111 default behavior is to issue a warning for every method not explicitly
2112 implemented in the class, even if a method implementation is inherited
2113 from the superclass.  If you use the @option{-Wno-protocol} option, then
2114 methods inherited from the superclass are considered to be implemented,
2115 and no warning is issued for them.
2117 @item -Wselector
2118 @opindex Wselector
2119 Warn if multiple methods of different types for the same selector are
2120 found during compilation.  The check is performed on the list of methods
2121 in the final stage of compilation.  Additionally, a check is performed
2122 for each selector appearing in a @code{@@selector(@dots{})}
2123 expression, and a corresponding method for that selector has been found
2124 during compilation.  Because these checks scan the method table only at
2125 the end of compilation, these warnings are not produced if the final
2126 stage of compilation is not reached, for example because an error is
2127 found during compilation, or because the @option{-fsyntax-only} option is
2128 being used.
2130 @item -Wstrict-selector-match
2131 @opindex Wstrict-selector-match
2132 Warn if multiple methods with differing argument and/or return types are
2133 found for a given selector when attempting to send a message using this
2134 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2135 is off (which is the default behavior), the compiler will omit such warnings
2136 if any differences found are confined to types which share the same size
2137 and alignment.
2139 @item -Wundeclared-selector
2140 @opindex Wundeclared-selector
2141 Warn if a @code{@@selector(@dots{})} expression referring to an
2142 undeclared selector is found.  A selector is considered undeclared if no
2143 method with that name has been declared before the
2144 @code{@@selector(@dots{})} expression, either explicitly in an
2145 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2146 an @code{@@implementation} section.  This option always performs its
2147 checks as soon as a @code{@@selector(@dots{})} expression is found,
2148 while @option{-Wselector} only performs its checks in the final stage of
2149 compilation.  This also enforces the coding style convention
2150 that methods and selectors must be declared before being used.
2152 @item -print-objc-runtime-info
2153 @opindex print-objc-runtime-info
2154 Generate C header describing the largest structure that is passed by
2155 value, if any.
2157 @end table
2159 @node Language Independent Options
2160 @section Options to Control Diagnostic Messages Formatting
2161 @cindex options to control diagnostics formatting
2162 @cindex diagnostic messages
2163 @cindex message formatting
2165 Traditionally, diagnostic messages have been formatted irrespective of
2166 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2167 below can be used to control the diagnostic messages formatting
2168 algorithm, e.g.@: how many characters per line, how often source location
2169 information should be reported.  Right now, only the C++ front end can
2170 honor these options.  However it is expected, in the near future, that
2171 the remaining front ends would be able to digest them correctly.
2173 @table @gcctabopt
2174 @item -fmessage-length=@var{n}
2175 @opindex fmessage-length
2176 Try to format error messages so that they fit on lines of about @var{n}
2177 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2178 the front ends supported by GCC@.  If @var{n} is zero, then no
2179 line-wrapping will be done; each error message will appear on a single
2180 line.
2182 @opindex fdiagnostics-show-location
2183 @item -fdiagnostics-show-location=once
2184 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2185 reporter to emit @emph{once} source location information; that is, in
2186 case the message is too long to fit on a single physical line and has to
2187 be wrapped, the source location won't be emitted (as prefix) again,
2188 over and over, in subsequent continuation lines.  This is the default
2189 behavior.
2191 @item -fdiagnostics-show-location=every-line
2192 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2193 messages reporter to emit the same source location information (as
2194 prefix) for physical lines that result from the process of breaking
2195 a message which is too long to fit on a single line.
2197 @item -fdiagnostics-show-options
2198 @opindex fdiagnostics-show-options
2199 This option instructs the diagnostic machinery to add text to each
2200 diagnostic emitted, which indicates which command line option directly
2201 controls that diagnostic, when such an option is known to the
2202 diagnostic machinery.
2204 @end table
2206 @node Warning Options
2207 @section Options to Request or Suppress Warnings
2208 @cindex options to control warnings
2209 @cindex warning messages
2210 @cindex messages, warning
2211 @cindex suppressing warnings
2213 Warnings are diagnostic messages that report constructions which
2214 are not inherently erroneous but which are risky or suggest there
2215 may have been an error.
2217 You can request many specific warnings with options beginning @samp{-W},
2218 for example @option{-Wimplicit} to request warnings on implicit
2219 declarations.  Each of these specific warning options also has a
2220 negative form beginning @samp{-Wno-} to turn off warnings;
2221 for example, @option{-Wno-implicit}.  This manual lists only one of the
2222 two forms, whichever is not the default.
2224 The following options control the amount and kinds of warnings produced
2225 by GCC; for further, language-specific options also refer to
2226 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2227 Options}.
2229 @table @gcctabopt
2230 @cindex syntax checking
2231 @item -fsyntax-only
2232 @opindex fsyntax-only
2233 Check the code for syntax errors, but don't do anything beyond that.
2235 @item -pedantic
2236 @opindex pedantic
2237 Issue all the warnings demanded by strict ISO C and ISO C++;
2238 reject all programs that use forbidden extensions, and some other
2239 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2240 version of the ISO C standard specified by any @option{-std} option used.
2242 Valid ISO C and ISO C++ programs should compile properly with or without
2243 this option (though a rare few will require @option{-ansi} or a
2244 @option{-std} option specifying the required version of ISO C)@.  However,
2245 without this option, certain GNU extensions and traditional C and C++
2246 features are supported as well.  With this option, they are rejected.
2248 @option{-pedantic} does not cause warning messages for use of the
2249 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2250 warnings are also disabled in the expression that follows
2251 @code{__extension__}.  However, only system header files should use
2252 these escape routes; application programs should avoid them.
2253 @xref{Alternate Keywords}.
2255 Some users try to use @option{-pedantic} to check programs for strict ISO
2256 C conformance.  They soon find that it does not do quite what they want:
2257 it finds some non-ISO practices, but not all---only those for which
2258 ISO C @emph{requires} a diagnostic, and some others for which
2259 diagnostics have been added.
2261 A feature to report any failure to conform to ISO C might be useful in
2262 some instances, but would require considerable additional work and would
2263 be quite different from @option{-pedantic}.  We don't have plans to
2264 support such a feature in the near future.
2266 Where the standard specified with @option{-std} represents a GNU
2267 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2268 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2269 extended dialect is based.  Warnings from @option{-pedantic} are given
2270 where they are required by the base standard.  (It would not make sense
2271 for such warnings to be given only for features not in the specified GNU
2272 C dialect, since by definition the GNU dialects of C include all
2273 features the compiler supports with the given option, and there would be
2274 nothing to warn about.)
2276 @item -pedantic-errors
2277 @opindex pedantic-errors
2278 Like @option{-pedantic}, except that errors are produced rather than
2279 warnings.
2281 @item -w
2282 @opindex w
2283 Inhibit all warning messages.
2285 @item -Wno-import
2286 @opindex Wno-import
2287 Inhibit warning messages about the use of @samp{#import}.
2289 @item -Wchar-subscripts
2290 @opindex Wchar-subscripts
2291 Warn if an array subscript has type @code{char}.  This is a common cause
2292 of error, as programmers often forget that this type is signed on some
2293 machines.
2294 This warning is enabled by @option{-Wall}.
2296 @item -Wcomment
2297 @opindex Wcomment
2298 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2299 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2300 This warning is enabled by @option{-Wall}.
2302 @item -Wfatal-errors
2303 @opindex Wfatal-errors
2304 This option causes the compiler to abort compilation on the first error
2305 occurred rather than trying to keep going and printing further error
2306 messages.
2308 @item -Wformat
2309 @opindex Wformat
2310 @opindex ffreestanding
2311 @opindex fno-builtin
2312 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2313 the arguments supplied have types appropriate to the format string
2314 specified, and that the conversions specified in the format string make
2315 sense.  This includes standard functions, and others specified by format
2316 attributes (@pxref{Function Attributes}), in the @code{printf},
2317 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2318 not in the C standard) families (or other target-specific families).
2319 Which functions are checked without format attributes having been
2320 specified depends on the standard version selected, and such checks of
2321 functions without the attribute specified are disabled by
2322 @option{-ffreestanding} or @option{-fno-builtin}.
2324 The formats are checked against the format features supported by GNU
2325 libc version 2.2.  These include all ISO C90 and C99 features, as well
2326 as features from the Single Unix Specification and some BSD and GNU
2327 extensions.  Other library implementations may not support all these
2328 features; GCC does not support warning about features that go beyond a
2329 particular library's limitations.  However, if @option{-pedantic} is used
2330 with @option{-Wformat}, warnings will be given about format features not
2331 in the selected standard version (but not for @code{strfmon} formats,
2332 since those are not in any version of the C standard).  @xref{C Dialect
2333 Options,,Options Controlling C Dialect}.
2335 Since @option{-Wformat} also checks for null format arguments for
2336 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2338 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2339 aspects of format checking, the options @option{-Wformat-y2k},
2340 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2341 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2342 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2344 @item -Wformat-y2k
2345 @opindex Wformat-y2k
2346 If @option{-Wformat} is specified, also warn about @code{strftime}
2347 formats which may yield only a two-digit year.
2349 @item -Wno-format-extra-args
2350 @opindex Wno-format-extra-args
2351 If @option{-Wformat} is specified, do not warn about excess arguments to a
2352 @code{printf} or @code{scanf} format function.  The C standard specifies
2353 that such arguments are ignored.
2355 Where the unused arguments lie between used arguments that are
2356 specified with @samp{$} operand number specifications, normally
2357 warnings are still given, since the implementation could not know what
2358 type to pass to @code{va_arg} to skip the unused arguments.  However,
2359 in the case of @code{scanf} formats, this option will suppress the
2360 warning if the unused arguments are all pointers, since the Single
2361 Unix Specification says that such unused arguments are allowed.
2363 @item -Wno-format-zero-length
2364 @opindex Wno-format-zero-length
2365 If @option{-Wformat} is specified, do not warn about zero-length formats.
2366 The C standard specifies that zero-length formats are allowed.
2368 @item -Wformat-nonliteral
2369 @opindex Wformat-nonliteral
2370 If @option{-Wformat} is specified, also warn if the format string is not a
2371 string literal and so cannot be checked, unless the format function
2372 takes its format arguments as a @code{va_list}.
2374 @item -Wformat-security
2375 @opindex Wformat-security
2376 If @option{-Wformat} is specified, also warn about uses of format
2377 functions that represent possible security problems.  At present, this
2378 warns about calls to @code{printf} and @code{scanf} functions where the
2379 format string is not a string literal and there are no format arguments,
2380 as in @code{printf (foo);}.  This may be a security hole if the format
2381 string came from untrusted input and contains @samp{%n}.  (This is
2382 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2383 in future warnings may be added to @option{-Wformat-security} that are not
2384 included in @option{-Wformat-nonliteral}.)
2386 @item -Wformat=2
2387 @opindex Wformat=2
2388 Enable @option{-Wformat} plus format checks not included in
2389 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2390 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2392 @item -Wnonnull
2393 @opindex Wnonnull
2394 Warn about passing a null pointer for arguments marked as
2395 requiring a non-null value by the @code{nonnull} function attribute.
2397 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2398 can be disabled with the @option{-Wno-nonnull} option.
2400 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2401 @opindex Winit-self
2402 Warn about uninitialized variables which are initialized with themselves.
2403 Note this option can only be used with the @option{-Wuninitialized} option,
2404 which in turn only works with @option{-O1} and above.
2406 For example, GCC will warn about @code{i} being uninitialized in the
2407 following snippet only when @option{-Winit-self} has been specified:
2408 @smallexample
2409 @group
2410 int f()
2412   int i = i;
2413   return i;
2415 @end group
2416 @end smallexample
2418 @item -Wimplicit-int
2419 @opindex Wimplicit-int
2420 Warn when a declaration does not specify a type.
2421 This warning is enabled by @option{-Wall}.
2423 @item -Wimplicit-function-declaration
2424 @itemx -Werror-implicit-function-declaration
2425 @opindex Wimplicit-function-declaration
2426 @opindex Werror-implicit-function-declaration
2427 Give a warning (or error) whenever a function is used before being
2428 declared.  The form @option{-Wno-error-implicit-function-declaration}
2429 is not supported.
2430 This warning is enabled by @option{-Wall} (as a warning, not an error).
2432 @item -Wimplicit
2433 @opindex Wimplicit
2434 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2435 This warning is enabled by @option{-Wall}.
2437 @item -Wmain
2438 @opindex Wmain
2439 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2440 function with external linkage, returning int, taking either zero
2441 arguments, two, or three arguments of appropriate types.
2442 This warning is enabled by @option{-Wall}.
2444 @item -Wmissing-braces
2445 @opindex Wmissing-braces
2446 Warn if an aggregate or union initializer is not fully bracketed.  In
2447 the following example, the initializer for @samp{a} is not fully
2448 bracketed, but that for @samp{b} is fully bracketed.
2450 @smallexample
2451 int a[2][2] = @{ 0, 1, 2, 3 @};
2452 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2453 @end smallexample
2455 This warning is enabled by @option{-Wall}.
2457 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2458 @opindex Wmissing-include-dirs
2459 Warn if a user-supplied include directory does not exist.
2461 @item -Wparentheses
2462 @opindex Wparentheses
2463 Warn if parentheses are omitted in certain contexts, such
2464 as when there is an assignment in a context where a truth value
2465 is expected, or when operators are nested whose precedence people
2466 often get confused about.  Only the warning for an assignment used as
2467 a truth value is supported when compiling C++; the other warnings are
2468 only supported when compiling C@.
2470 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2471 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2472 interpretation from that of ordinary mathematical notation.
2474 Also warn about constructions where there may be confusion to which
2475 @code{if} statement an @code{else} branch belongs.  Here is an example of
2476 such a case:
2478 @smallexample
2479 @group
2481   if (a)
2482     if (b)
2483       foo ();
2484   else
2485     bar ();
2487 @end group
2488 @end smallexample
2490 In C, every @code{else} branch belongs to the innermost possible @code{if}
2491 statement, which in this example is @code{if (b)}.  This is often not
2492 what the programmer expected, as illustrated in the above example by
2493 indentation the programmer chose.  When there is the potential for this
2494 confusion, GCC will issue a warning when this flag is specified.
2495 To eliminate the warning, add explicit braces around the innermost
2496 @code{if} statement so there is no way the @code{else} could belong to
2497 the enclosing @code{if}.  The resulting code would look like this:
2499 @smallexample
2500 @group
2502   if (a)
2503     @{
2504       if (b)
2505         foo ();
2506       else
2507         bar ();
2508     @}
2510 @end group
2511 @end smallexample
2513 This warning is enabled by @option{-Wall}.
2515 @item -Wsequence-point
2516 @opindex Wsequence-point
2517 Warn about code that may have undefined semantics because of violations
2518 of sequence point rules in the C and C++ standards.
2520 The C and C++ standards defines the order in which expressions in a C/C++
2521 program are evaluated in terms of @dfn{sequence points}, which represent
2522 a partial ordering between the execution of parts of the program: those
2523 executed before the sequence point, and those executed after it.  These
2524 occur after the evaluation of a full expression (one which is not part
2525 of a larger expression), after the evaluation of the first operand of a
2526 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2527 function is called (but after the evaluation of its arguments and the
2528 expression denoting the called function), and in certain other places.
2529 Other than as expressed by the sequence point rules, the order of
2530 evaluation of subexpressions of an expression is not specified.  All
2531 these rules describe only a partial order rather than a total order,
2532 since, for example, if two functions are called within one expression
2533 with no sequence point between them, the order in which the functions
2534 are called is not specified.  However, the standards committee have
2535 ruled that function calls do not overlap.
2537 It is not specified when between sequence points modifications to the
2538 values of objects take effect.  Programs whose behavior depends on this
2539 have undefined behavior; the C and C++ standards specify that ``Between
2540 the previous and next sequence point an object shall have its stored
2541 value modified at most once by the evaluation of an expression.  
2542 Furthermore, the prior value shall be read only to determine the value
2543 to be stored.''.  If a program breaks these rules, the results on any
2544 particular implementation are entirely unpredictable.
2546 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2547 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2548 diagnosed by this option, and it may give an occasional false positive
2549 result, but in general it has been found fairly effective at detecting
2550 this sort of problem in programs.
2552 The standard is worded confusingly, therefore there is some debate
2553 over the precise meaning of the sequence point rules in subtle cases.
2554 Links to discussions of the problem, including proposed formal
2555 definitions, may be found on the GCC readings page, at
2556 @w{@uref{http://gcc.gnu.org/readings.html}}.
2558 This warning is enabled by @option{-Wall} for C and C++.
2560 @item -Wreturn-type
2561 @opindex Wreturn-type
2562 Warn whenever a function is defined with a return-type that defaults to
2563 @code{int}.  Also warn about any @code{return} statement with no
2564 return-value in a function whose return-type is not @code{void}.
2566 For C, also warn if the return type of a function has a type qualifier
2567 such as @code{const}.  Such a type qualifier has no effect, since the
2568 value returned by a function is not an lvalue.  ISO C prohibits
2569 qualified @code{void} return types on function definitions, so such
2570 return types always receive a warning even without this option.
2572 For C++, a function without return type always produces a diagnostic
2573 message, even when @option{-Wno-return-type} is specified.  The only
2574 exceptions are @samp{main} and functions defined in system headers.
2576 This warning is enabled by @option{-Wall}.
2578 @item -Wswitch
2579 @opindex Wswitch
2580 Warn whenever a @code{switch} statement has an index of enumerated type
2581 and lacks a @code{case} for one or more of the named codes of that
2582 enumeration.  (The presence of a @code{default} label prevents this
2583 warning.)  @code{case} labels outside the enumeration range also
2584 provoke warnings when this option is used.
2585 This warning is enabled by @option{-Wall}.
2587 @item -Wswitch-default
2588 @opindex Wswitch-switch
2589 Warn whenever a @code{switch} statement does not have a @code{default}
2590 case.
2592 @item -Wswitch-enum
2593 @opindex Wswitch-enum
2594 Warn whenever a @code{switch} statement has an index of enumerated type
2595 and lacks a @code{case} for one or more of the named codes of that
2596 enumeration.  @code{case} labels outside the enumeration range also
2597 provoke warnings when this option is used.
2599 @item -Wtrigraphs
2600 @opindex Wtrigraphs
2601 Warn if any trigraphs are encountered that might change the meaning of
2602 the program (trigraphs within comments are not warned about).
2603 This warning is enabled by @option{-Wall}.
2605 @item -Wunused-function
2606 @opindex Wunused-function
2607 Warn whenever a static function is declared but not defined or a
2608 non-inline static function is unused.
2609 This warning is enabled by @option{-Wall}.
2611 @item -Wunused-label
2612 @opindex Wunused-label
2613 Warn whenever a label is declared but not used.
2614 This warning is enabled by @option{-Wall}.
2616 To suppress this warning use the @samp{unused} attribute
2617 (@pxref{Variable Attributes}).
2619 @item -Wunused-parameter
2620 @opindex Wunused-parameter
2621 Warn whenever a function parameter is unused aside from its declaration.
2623 To suppress this warning use the @samp{unused} attribute
2624 (@pxref{Variable Attributes}).
2626 @item -Wunused-variable
2627 @opindex Wunused-variable
2628 Warn whenever a local variable or non-constant static variable is unused
2629 aside from its declaration
2630 This warning is enabled by @option{-Wall}.
2632 To suppress this warning use the @samp{unused} attribute
2633 (@pxref{Variable Attributes}).
2635 @item -Wunused-value
2636 @opindex Wunused-value
2637 Warn whenever a statement computes a result that is explicitly not used.
2638 This warning is enabled by @option{-Wall}.
2640 To suppress this warning cast the expression to @samp{void}.
2642 @item -Wunused
2643 @opindex Wunused
2644 All the above @option{-Wunused} options combined.
2646 In order to get a warning about an unused function parameter, you must
2647 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2648 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2650 @item -Wuninitialized
2651 @opindex Wuninitialized
2652 Warn if an automatic variable is used without first being initialized or
2653 if a variable may be clobbered by a @code{setjmp} call.
2655 These warnings are possible only in optimizing compilation,
2656 because they require data flow information that is computed only
2657 when optimizing.  If you don't specify @option{-O}, you simply won't
2658 get these warnings.
2660 If you want to warn about code which uses the uninitialized value of the
2661 variable in its own initializer, use the @option{-Winit-self} option.
2663 These warnings occur for individual uninitialized or clobbered
2664 elements of structure, union or array variables as well as for
2665 variables which are uninitialized or clobbered as a whole.  They do
2666 not occur for variables or elements declared @code{volatile}.  Because
2667 these warnings depend on optimization, the exact variables or elements
2668 for which there are warnings will depend on the precise optimization
2669 options and version of GCC used.
2671 Note that there may be no warning about a variable that is used only
2672 to compute a value that itself is never used, because such
2673 computations may be deleted by data flow analysis before the warnings
2674 are printed.
2676 These warnings are made optional because GCC is not smart
2677 enough to see all the reasons why the code might be correct
2678 despite appearing to have an error.  Here is one example of how
2679 this can happen:
2681 @smallexample
2682 @group
2684   int x;
2685   switch (y)
2686     @{
2687     case 1: x = 1;
2688       break;
2689     case 2: x = 4;
2690       break;
2691     case 3: x = 5;
2692     @}
2693   foo (x);
2695 @end group
2696 @end smallexample
2698 @noindent
2699 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2700 always initialized, but GCC doesn't know this.  Here is
2701 another common case:
2703 @smallexample
2705   int save_y;
2706   if (change_y) save_y = y, y = new_y;
2707   @dots{}
2708   if (change_y) y = save_y;
2710 @end smallexample
2712 @noindent
2713 This has no bug because @code{save_y} is used only if it is set.
2715 @cindex @code{longjmp} warnings
2716 This option also warns when a non-volatile automatic variable might be
2717 changed by a call to @code{longjmp}.  These warnings as well are possible
2718 only in optimizing compilation.
2720 The compiler sees only the calls to @code{setjmp}.  It cannot know
2721 where @code{longjmp} will be called; in fact, a signal handler could
2722 call it at any point in the code.  As a result, you may get a warning
2723 even when there is in fact no problem because @code{longjmp} cannot
2724 in fact be called at the place which would cause a problem.
2726 Some spurious warnings can be avoided if you declare all the functions
2727 you use that never return as @code{noreturn}.  @xref{Function
2728 Attributes}.
2730 This warning is enabled by @option{-Wall}.
2732 @item -Wunknown-pragmas
2733 @opindex Wunknown-pragmas
2734 @cindex warning for unknown pragmas
2735 @cindex unknown pragmas, warning
2736 @cindex pragmas, warning of unknown
2737 Warn when a #pragma directive is encountered which is not understood by
2738 GCC@.  If this command line option is used, warnings will even be issued
2739 for unknown pragmas in system header files.  This is not the case if
2740 the warnings were only enabled by the @option{-Wall} command line option.
2742 @item -Wno-pragmas
2743 @opindex Wno-pragmas
2744 @opindex Wpragmas
2745 Do not warn about misuses of pragmas, such as incorrect parameters,
2746 invalid syntax, or conflicts between pragmas.  See also
2747 @samp{-Wunknown-pragmas}.
2749 @item -Wstrict-aliasing
2750 @opindex Wstrict-aliasing
2751 This option is only active when @option{-fstrict-aliasing} is active.
2752 It warns about code which might break the strict aliasing rules that the
2753 compiler is using for optimization.  The warning does not catch all
2754 cases, but does attempt to catch the more common pitfalls.  It is
2755 included in @option{-Wall}.
2757 @item -Wstrict-aliasing=2
2758 @opindex Wstrict-aliasing=2
2759 This option is only active when @option{-fstrict-aliasing} is active.
2760 It warns about code which might break the strict aliasing rules that the
2761 compiler is using for optimization.  This warning catches more cases than
2762 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2763 cases that are safe.
2765 @item -Wall
2766 @opindex Wall
2767 All of the above @samp{-W} options combined.  This enables all the
2768 warnings about constructions that some users consider questionable, and
2769 that are easy to avoid (or modify to prevent the warning), even in
2770 conjunction with macros.  This also enables some language-specific
2771 warnings described in @ref{C++ Dialect Options} and
2772 @ref{Objective-C and Objective-C++ Dialect Options}.
2773 @end table
2775 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2776 Some of them warn about constructions that users generally do not
2777 consider questionable, but which occasionally you might wish to check
2778 for; others warn about constructions that are necessary or hard to avoid
2779 in some cases, and there is no simple way to modify the code to suppress
2780 the warning.
2782 @table @gcctabopt
2783 @item -Wextra
2784 @opindex W
2785 @opindex Wextra
2786 (This option used to be called @option{-W}.  The older name is still
2787 supported, but the newer name is more descriptive.)  Print extra warning
2788 messages for these events:
2790 @itemize @bullet
2791 @item
2792 A function can return either with or without a value.  (Falling
2793 off the end of the function body is considered returning without
2794 a value.)  For example, this function would evoke such a
2795 warning:
2797 @smallexample
2798 @group
2799 foo (a)
2801   if (a > 0)
2802     return a;
2804 @end group
2805 @end smallexample
2807 @item
2808 An expression-statement or the left-hand side of a comma expression
2809 contains no side effects.
2810 To suppress the warning, cast the unused expression to void.
2811 For example, an expression such as @samp{x[i,j]} will cause a warning,
2812 but @samp{x[(void)i,j]} will not.
2814 @item
2815 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2817 @item
2818 Storage-class specifiers like @code{static} are not the first things in
2819 a declaration.  According to the C Standard, this usage is obsolescent.
2821 @item
2822 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2823 arguments.
2825 @item
2826 A comparison between signed and unsigned values could produce an
2827 incorrect result when the signed value is converted to unsigned.
2828 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2830 @item
2831 An aggregate has an initializer which does not initialize all members.
2832 This warning can be independently controlled by
2833 @option{-Wmissing-field-initializers}.
2835 @item
2836 A function parameter is declared without a type specifier in K&R-style
2837 functions:
2839 @smallexample
2840 void foo(bar) @{ @}
2841 @end smallexample
2843 @item
2844 An empty body occurs in an @samp{if} or @samp{else} statement.
2846 @item
2847 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2848 @samp{>}, or @samp{>=}.
2850 @item
2851 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2853 @item
2854 Any of several floating-point events that often indicate errors, such as
2855 overflow, underflow, loss of precision, etc.
2857 @item @r{(C++ only)}
2858 An enumerator and a non-enumerator both appear in a conditional expression.
2860 @item @r{(C++ only)}
2861 A non-static reference or non-static @samp{const} member appears in a
2862 class without constructors.
2864 @item @r{(C++ only)}
2865 Ambiguous virtual bases.
2867 @item @r{(C++ only)}
2868 Subscripting an array which has been declared @samp{register}.
2870 @item @r{(C++ only)}
2871 Taking the address of a variable which has been declared @samp{register}.
2873 @item @r{(C++ only)}
2874 A base class is not initialized in a derived class' copy constructor.
2875 @end itemize
2877 @item -Wno-div-by-zero
2878 @opindex Wno-div-by-zero
2879 @opindex Wdiv-by-zero
2880 Do not warn about compile-time integer division by zero.  Floating point
2881 division by zero is not warned about, as it can be a legitimate way of
2882 obtaining infinities and NaNs.
2884 @item -Wsystem-headers
2885 @opindex Wsystem-headers
2886 @cindex warnings from system headers
2887 @cindex system headers, warnings from
2888 Print warning messages for constructs found in system header files.
2889 Warnings from system headers are normally suppressed, on the assumption
2890 that they usually do not indicate real problems and would only make the
2891 compiler output harder to read.  Using this command line option tells
2892 GCC to emit warnings from system headers as if they occurred in user
2893 code.  However, note that using @option{-Wall} in conjunction with this
2894 option will @emph{not} warn about unknown pragmas in system
2895 headers---for that, @option{-Wunknown-pragmas} must also be used.
2897 @item -Wfloat-equal
2898 @opindex Wfloat-equal
2899 Warn if floating point values are used in equality comparisons.
2901 The idea behind this is that sometimes it is convenient (for the
2902 programmer) to consider floating-point values as approximations to
2903 infinitely precise real numbers.  If you are doing this, then you need
2904 to compute (by analyzing the code, or in some other way) the maximum or
2905 likely maximum error that the computation introduces, and allow for it
2906 when performing comparisons (and when producing output, but that's a
2907 different problem).  In particular, instead of testing for equality, you
2908 would check to see whether the two values have ranges that overlap; and
2909 this is done with the relational operators, so equality comparisons are
2910 probably mistaken.
2912 @item -Wtraditional @r{(C only)}
2913 @opindex Wtraditional
2914 Warn about certain constructs that behave differently in traditional and
2915 ISO C@.  Also warn about ISO C constructs that have no traditional C
2916 equivalent, and/or problematic constructs which should be avoided.
2918 @itemize @bullet
2919 @item
2920 Macro parameters that appear within string literals in the macro body.
2921 In traditional C macro replacement takes place within string literals,
2922 but does not in ISO C@.
2924 @item
2925 In traditional C, some preprocessor directives did not exist.
2926 Traditional preprocessors would only consider a line to be a directive
2927 if the @samp{#} appeared in column 1 on the line.  Therefore
2928 @option{-Wtraditional} warns about directives that traditional C
2929 understands but would ignore because the @samp{#} does not appear as the
2930 first character on the line.  It also suggests you hide directives like
2931 @samp{#pragma} not understood by traditional C by indenting them.  Some
2932 traditional implementations would not recognize @samp{#elif}, so it
2933 suggests avoiding it altogether.
2935 @item
2936 A function-like macro that appears without arguments.
2938 @item
2939 The unary plus operator.
2941 @item
2942 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2943 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2944 constants.)  Note, these suffixes appear in macros defined in the system
2945 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2946 Use of these macros in user code might normally lead to spurious
2947 warnings, however GCC's integrated preprocessor has enough context to
2948 avoid warning in these cases.
2950 @item
2951 A function declared external in one block and then used after the end of
2952 the block.
2954 @item
2955 A @code{switch} statement has an operand of type @code{long}.
2957 @item
2958 A non-@code{static} function declaration follows a @code{static} one.
2959 This construct is not accepted by some traditional C compilers.
2961 @item
2962 The ISO type of an integer constant has a different width or
2963 signedness from its traditional type.  This warning is only issued if
2964 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2965 typically represent bit patterns, are not warned about.
2967 @item
2968 Usage of ISO string concatenation is detected.
2970 @item
2971 Initialization of automatic aggregates.
2973 @item
2974 Identifier conflicts with labels.  Traditional C lacks a separate
2975 namespace for labels.
2977 @item
2978 Initialization of unions.  If the initializer is zero, the warning is
2979 omitted.  This is done under the assumption that the zero initializer in
2980 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2981 initializer warnings and relies on default initialization to zero in the
2982 traditional C case.
2984 @item
2985 Conversions by prototypes between fixed/floating point values and vice
2986 versa.  The absence of these prototypes when compiling with traditional
2987 C would cause serious problems.  This is a subset of the possible
2988 conversion warnings, for the full set use @option{-Wconversion}.
2990 @item
2991 Use of ISO C style function definitions.  This warning intentionally is
2992 @emph{not} issued for prototype declarations or variadic functions
2993 because these ISO C features will appear in your code when using
2994 libiberty's traditional C compatibility macros, @code{PARAMS} and
2995 @code{VPARAMS}.  This warning is also bypassed for nested functions
2996 because that feature is already a GCC extension and thus not relevant to
2997 traditional C compatibility.
2998 @end itemize
3000 @item -Wdeclaration-after-statement @r{(C only)}
3001 @opindex Wdeclaration-after-statement
3002 Warn when a declaration is found after a statement in a block.  This
3003 construct, known from C++, was introduced with ISO C99 and is by default
3004 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3005 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3007 @item -Wundef
3008 @opindex Wundef
3009 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3011 @item -Wno-endif-labels
3012 @opindex Wno-endif-labels
3013 @opindex Wendif-labels
3014 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3016 @item -Wshadow
3017 @opindex Wshadow
3018 Warn whenever a local variable shadows another local variable, parameter or
3019 global variable or whenever a built-in function is shadowed.
3021 @item -Wlarger-than-@var{len}
3022 @opindex Wlarger-than
3023 Warn whenever an object of larger than @var{len} bytes is defined.
3025 @item -Wunsafe-loop-optimizations
3026 @opindex Wunsafe-loop-optimizations
3027 Warn if the loop cannot be optimized because the compiler could not
3028 assume anything on the bounds of the loop indices.  With
3029 @option{-funsafe-loop-optimizations} warn if the compiler made
3030 such assumptions.
3032 @item -Wpointer-arith
3033 @opindex Wpointer-arith
3034 Warn about anything that depends on the ``size of'' a function type or
3035 of @code{void}.  GNU C assigns these types a size of 1, for
3036 convenience in calculations with @code{void *} pointers and pointers
3037 to functions.
3039 @item -Wbad-function-cast @r{(C only)}
3040 @opindex Wbad-function-cast
3041 Warn whenever a function call is cast to a non-matching type.
3042 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3044 @item -Wc++-compat
3045 Warn about ISO C constructs that are outside of the common subset of
3046 ISO C and ISO C++, e.g.@: request for implicit conversion from
3047 @code{void *} to a pointer to non-@code{void} type.
3049 @item -Wcast-qual
3050 @opindex Wcast-qual
3051 Warn whenever a pointer is cast so as to remove a type qualifier from
3052 the target type.  For example, warn if a @code{const char *} is cast
3053 to an ordinary @code{char *}.
3055 @item -Wcast-align
3056 @opindex Wcast-align
3057 Warn whenever a pointer is cast such that the required alignment of the
3058 target is increased.  For example, warn if a @code{char *} is cast to
3059 an @code{int *} on machines where integers can only be accessed at
3060 two- or four-byte boundaries.
3062 @item -Wwrite-strings
3063 @opindex Wwrite-strings
3064 When compiling C, give string constants the type @code{const
3065 char[@var{length}]} so that
3066 copying the address of one into a non-@code{const} @code{char *}
3067 pointer will get a warning; when compiling C++, warn about the
3068 deprecated conversion from string literals to @code{char *}.  This
3069 warning, by default, is enabled for C++ programs.
3070 These warnings will help you find at
3071 compile time code that can try to write into a string constant, but
3072 only if you have been very careful about using @code{const} in
3073 declarations and prototypes.  Otherwise, it will just be a nuisance;
3074 this is why we did not make @option{-Wall} request these warnings.
3076 @item -Wconversion
3077 @opindex Wconversion
3078 Warn if a prototype causes a type conversion that is different from what
3079 would happen to the same argument in the absence of a prototype.  This
3080 includes conversions of fixed point to floating and vice versa, and
3081 conversions changing the width or signedness of a fixed point argument
3082 except when the same as the default promotion.
3084 Also, warn if a negative integer constant expression is implicitly
3085 converted to an unsigned type.  For example, warn about the assignment
3086 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3087 casts like @code{(unsigned) -1}.
3089 @item -Wsign-compare
3090 @opindex Wsign-compare
3091 @cindex warning for comparison of signed and unsigned values
3092 @cindex comparison of signed and unsigned values, warning
3093 @cindex signed and unsigned values, comparison warning
3094 Warn when a comparison between signed and unsigned values could produce
3095 an incorrect result when the signed value is converted to unsigned.
3096 This warning is also enabled by @option{-Wextra}; to get the other warnings
3097 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3099 @item -Waggregate-return
3100 @opindex Waggregate-return
3101 Warn if any functions that return structures or unions are defined or
3102 called.  (In languages where you can return an array, this also elicits
3103 a warning.)
3105 @item -Walways-true
3106 @opindex Walways-true
3107 Warn about comparisons which are always true such as testing if
3108 unsigned values are greater than or equal to zero.  This warning is
3109 enabled by @option{-Wall}.
3111 @item -Wno-attributes
3112 @opindex Wno-attributes
3113 @opindex Wattributes
3114 Do not warn if an unexpected @code{__attribute__} is used, such as
3115 unrecognized attributes, function attributes applied to variables,
3116 etc.  This will not stop errors for incorrect use of supported
3117 attributes.
3119 @item -Wstrict-prototypes @r{(C only)}
3120 @opindex Wstrict-prototypes
3121 Warn if a function is declared or defined without specifying the
3122 argument types.  (An old-style function definition is permitted without
3123 a warning if preceded by a declaration which specifies the argument
3124 types.)
3126 @item -Wold-style-definition @r{(C only)}
3127 @opindex Wold-style-definition
3128 Warn if an old-style function definition is used.  A warning is given
3129 even if there is a previous prototype.
3131 @item -Wmissing-prototypes @r{(C only)}
3132 @opindex Wmissing-prototypes
3133 Warn if a global function is defined without a previous prototype
3134 declaration.  This warning is issued even if the definition itself
3135 provides a prototype.  The aim is to detect global functions that fail
3136 to be declared in header files.
3138 @item -Wmissing-declarations @r{(C only)}
3139 @opindex Wmissing-declarations
3140 Warn if a global function is defined without a previous declaration.
3141 Do so even if the definition itself provides a prototype.
3142 Use this option to detect global functions that are not declared in
3143 header files.
3145 @item -Wmissing-field-initializers
3146 @opindex Wmissing-field-initializers
3147 @opindex W
3148 @opindex Wextra
3149 Warn if a structure's initializer has some fields missing.  For
3150 example, the following code would cause such a warning, because
3151 @code{x.h} is implicitly zero:
3153 @smallexample
3154 struct s @{ int f, g, h; @};
3155 struct s x = @{ 3, 4 @};
3156 @end smallexample
3158 This option does not warn about designated initializers, so the following
3159 modification would not trigger a warning:
3161 @smallexample
3162 struct s @{ int f, g, h; @};
3163 struct s x = @{ .f = 3, .g = 4 @};
3164 @end smallexample
3166 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3167 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3169 @item -Wmissing-noreturn
3170 @opindex Wmissing-noreturn
3171 Warn about functions which might be candidates for attribute @code{noreturn}.
3172 Note these are only possible candidates, not absolute ones.  Care should
3173 be taken to manually verify functions actually do not ever return before
3174 adding the @code{noreturn} attribute, otherwise subtle code generation
3175 bugs could be introduced.  You will not get a warning for @code{main} in
3176 hosted C environments.
3178 @item -Wmissing-format-attribute
3179 @opindex Wmissing-format-attribute
3180 @opindex Wformat
3181 Warn about function pointers which might be candidates for @code{format}
3182 attributes.  Note these are only possible candidates, not absolute ones.
3183 GCC will guess that function pointers with @code{format} attributes that
3184 are used in assignment, initialization, parameter passing or return
3185 statements should have a corresponding @code{format} attribute in the
3186 resulting type.  I.e.@: the left-hand side of the assignment or
3187 initialization, the type of the parameter variable, or the return type
3188 of the containing function respectively should also have a @code{format}
3189 attribute to avoid the warning.
3191 GCC will also warn about function definitions which might be
3192 candidates for @code{format} attributes.  Again, these are only
3193 possible candidates.  GCC will guess that @code{format} attributes
3194 might be appropriate for any function that calls a function like
3195 @code{vprintf} or @code{vscanf}, but this might not always be the
3196 case, and some functions for which @code{format} attributes are
3197 appropriate may not be detected.
3199 @item -Wno-multichar
3200 @opindex Wno-multichar
3201 @opindex Wmultichar
3202 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3203 Usually they indicate a typo in the user's code, as they have
3204 implementation-defined values, and should not be used in portable code.
3206 @item -Wnormalized=<none|id|nfc|nfkc>
3207 @opindex Wnormalized
3208 @cindex NFC
3209 @cindex NFKC
3210 @cindex character set, input normalization
3211 In ISO C and ISO C++, two identifiers are different if they are
3212 different sequences of characters.  However, sometimes when characters
3213 outside the basic ASCII character set are used, you can have two
3214 different character sequences that look the same.  To avoid confusion,
3215 the ISO 10646 standard sets out some @dfn{normalization rules} which
3216 when applied ensure that two sequences that look the same are turned into
3217 the same sequence.  GCC can warn you if you are using identifiers which
3218 have not been normalized; this option controls that warning.
3220 There are four levels of warning that GCC supports.  The default is
3221 @option{-Wnormalized=nfc}, which warns about any identifier which is
3222 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3223 recommended form for most uses.
3225 Unfortunately, there are some characters which ISO C and ISO C++ allow
3226 in identifiers that when turned into NFC aren't allowable as
3227 identifiers.  That is, there's no way to use these symbols in portable
3228 ISO C or C++ and have all your identifiers in NFC.
3229 @option{-Wnormalized=id} suppresses the warning for these characters.
3230 It is hoped that future versions of the standards involved will correct
3231 this, which is why this option is not the default.
3233 You can switch the warning off for all characters by writing
3234 @option{-Wnormalized=none}.  You would only want to do this if you
3235 were using some other normalization scheme (like ``D''), because
3236 otherwise you can easily create bugs that are literally impossible to see.
3238 Some characters in ISO 10646 have distinct meanings but look identical
3239 in some fonts or display methodologies, especially once formatting has
3240 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3241 LETTER N'', will display just like a regular @code{n} which has been
3242 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3243 normalisation scheme to convert all these into a standard form as
3244 well, and GCC will warn if your code is not in NFKC if you use
3245 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3246 about every identifier that contains the letter O because it might be
3247 confused with the digit 0, and so is not the default, but may be
3248 useful as a local coding convention if the programming environment is
3249 unable to be fixed to display these characters distinctly.
3251 @item -Wno-deprecated-declarations
3252 @opindex Wno-deprecated-declarations
3253 Do not warn about uses of functions, variables, and types marked as
3254 deprecated by using the @code{deprecated} attribute.
3255 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3256 @pxref{Type Attributes}.)
3258 @item -Wpacked
3259 @opindex Wpacked
3260 Warn if a structure is given the packed attribute, but the packed
3261 attribute has no effect on the layout or size of the structure.
3262 Such structures may be mis-aligned for little benefit.  For
3263 instance, in this code, the variable @code{f.x} in @code{struct bar}
3264 will be misaligned even though @code{struct bar} does not itself
3265 have the packed attribute:
3267 @smallexample
3268 @group
3269 struct foo @{
3270   int x;
3271   char a, b, c, d;
3272 @} __attribute__((packed));
3273 struct bar @{
3274   char z;
3275   struct foo f;
3277 @end group
3278 @end smallexample
3280 @item -Wpadded
3281 @opindex Wpadded
3282 Warn if padding is included in a structure, either to align an element
3283 of the structure or to align the whole structure.  Sometimes when this
3284 happens it is possible to rearrange the fields of the structure to
3285 reduce the padding and so make the structure smaller.
3287 @item -Wredundant-decls
3288 @opindex Wredundant-decls
3289 Warn if anything is declared more than once in the same scope, even in
3290 cases where multiple declaration is valid and changes nothing.
3292 @item -Wnested-externs @r{(C only)}
3293 @opindex Wnested-externs
3294 Warn if an @code{extern} declaration is encountered within a function.
3296 @item -Wunreachable-code
3297 @opindex Wunreachable-code
3298 Warn if the compiler detects that code will never be executed.
3300 This option is intended to warn when the compiler detects that at
3301 least a whole line of source code will never be executed, because
3302 some condition is never satisfied or because it is after a
3303 procedure that never returns.
3305 It is possible for this option to produce a warning even though there
3306 are circumstances under which part of the affected line can be executed,
3307 so care should be taken when removing apparently-unreachable code.
3309 For instance, when a function is inlined, a warning may mean that the
3310 line is unreachable in only one inlined copy of the function.
3312 This option is not made part of @option{-Wall} because in a debugging
3313 version of a program there is often substantial code which checks
3314 correct functioning of the program and is, hopefully, unreachable
3315 because the program does work.  Another common use of unreachable
3316 code is to provide behavior which is selectable at compile-time.
3318 @item -Winline
3319 @opindex Winline
3320 Warn if a function can not be inlined and it was declared as inline.
3321 Even with this option, the compiler will not warn about failures to
3322 inline functions declared in system headers.
3324 The compiler uses a variety of heuristics to determine whether or not
3325 to inline a function.  For example, the compiler takes into account
3326 the size of the function being inlined and the amount of inlining
3327 that has already been done in the current function.  Therefore,
3328 seemingly insignificant changes in the source program can cause the
3329 warnings produced by @option{-Winline} to appear or disappear.
3331 @item -Wno-invalid-offsetof @r{(C++ only)}
3332 @opindex Wno-invalid-offsetof
3333 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3334 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3335 to a non-POD type is undefined.  In existing C++ implementations,
3336 however, @samp{offsetof} typically gives meaningful results even when
3337 applied to certain kinds of non-POD types. (Such as a simple
3338 @samp{struct} that fails to be a POD type only by virtue of having a
3339 constructor.)  This flag is for users who are aware that they are
3340 writing nonportable code and who have deliberately chosen to ignore the
3341 warning about it.
3343 The restrictions on @samp{offsetof} may be relaxed in a future version
3344 of the C++ standard.
3346 @item -Wno-int-to-pointer-cast @r{(C only)}
3347 @opindex Wno-int-to-pointer-cast
3348 Suppress warnings from casts to pointer type of an integer of a
3349 different size.
3351 @item -Wno-pointer-to-int-cast @r{(C only)}
3352 @opindex Wno-pointer-to-int-cast
3353 Suppress warnings from casts from a pointer to an integer type of a
3354 different size.
3356 @item -Winvalid-pch
3357 @opindex Winvalid-pch
3358 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3359 the search path but can't be used.
3361 @item -Wlong-long
3362 @opindex Wlong-long
3363 @opindex Wno-long-long
3364 Warn if @samp{long long} type is used.  This is default.  To inhibit
3365 the warning messages, use @option{-Wno-long-long}.  Flags
3366 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3367 only when @option{-pedantic} flag is used.
3369 @item -Wvariadic-macros
3370 @opindex Wvariadic-macros
3371 @opindex Wno-variadic-macros
3372 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3373 alternate syntax when in pedantic ISO C99 mode.  This is default.
3374 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3376 @item -Wvolatile-register-var
3377 @opindex Wvolatile-register-var
3378 @opindex Wno-volatile-register-var
3379 Warn if a register variable is declared volatile.  The volatile
3380 modifier does not inhibit all optimizations that may eliminate reads
3381 and/or writes to register variables.
3383 @item -Wdisabled-optimization
3384 @opindex Wdisabled-optimization
3385 Warn if a requested optimization pass is disabled.  This warning does
3386 not generally indicate that there is anything wrong with your code; it
3387 merely indicates that GCC's optimizers were unable to handle the code
3388 effectively.  Often, the problem is that your code is too big or too
3389 complex; GCC will refuse to optimize programs when the optimization
3390 itself is likely to take inordinate amounts of time.
3392 @item -Wpointer-sign
3393 @opindex Wpointer-sign
3394 @opindex Wno-pointer-sign
3395 Warn for pointer argument passing or assignment with different signedness.
3396 This option is only supported for C and Objective-C@.  It is implied by
3397 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3398 @option{-Wno-pointer-sign}.
3400 @item -Werror
3401 @opindex Werror
3402 Make all warnings into errors.
3404 @item -Werror=
3405 @opindex Werror=
3406 Make the specified warning into an errors.  The specifier for a
3407 warning is appended, for example @option{-Werror=switch} turns the
3408 warnings controlled by @option{-Wswitch} into errors.  This switch
3409 takes a negative form, to be used to negate @option{-Werror} for
3410 specific warnings, for example @option{-Wno-error=switch} makes
3411 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3412 is in effect.  You can use the @option{-fdiagnostics-show-option}
3413 option to have each controllable warning amended with the option which
3414 controls it, to determine what to use with this option.
3416 Note that specifying @option{-Werror=}@var{foo} automatically implies
3417 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3418 imply anything.
3420 @item -Wstack-protector
3421 @opindex Wstack-protector
3422 This option is only active when @option{-fstack-protector} is active.  It
3423 warns about functions that will not be protected against stack smashing.
3425 @item -Wstring-literal-comparison
3426 @opindex Wstring-literal-comparison
3427 Warn about suspicious comparisons to string literal constants.  In C,
3428 direct comparisons against the memory address of a string literal, such
3429 as @code{if (x == "abc")}, typically indicate a programmer error, and
3430 even when intentional, result in unspecified behavior and are not portable.
3431 Usually these warnings alert that the programmer intended to use
3432 @code{strcmp}.  This warning is enabled by @option{-Wall}.
3434 @item -Woverlength-strings
3435 @opindex Woverlength-strings
3436 Warn about string constants which are longer than the ``minimum
3437 maximum'' length specified in the C standard.  Modern compilers
3438 generally allow string constants which are much longer than the
3439 standard's minimum limit, but very portable programs should avoid
3440 using longer strings.
3442 The limit applies @emph{after} string constant concatenation, and does
3443 not count the trailing NUL@.  In C89, the limit was 509 characters; in
3444 C99, it was raised to 4095.  C++98 does not specify a normative
3445 minimum maximum, so we do not diagnose overlength strings in C++@.
3447 This option is implied by @option{-pedantic}, and can be disabled with
3448 @option{-Wno-overlength-strings}.
3449 @end table
3451 @node Debugging Options
3452 @section Options for Debugging Your Program or GCC
3453 @cindex options, debugging
3454 @cindex debugging information options
3456 GCC has various special options that are used for debugging
3457 either your program or GCC:
3459 @table @gcctabopt
3460 @item -g
3461 @opindex g
3462 Produce debugging information in the operating system's native format
3463 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3464 information.
3466 On most systems that use stabs format, @option{-g} enables use of extra
3467 debugging information that only GDB can use; this extra information
3468 makes debugging work better in GDB but will probably make other debuggers
3469 crash or
3470 refuse to read the program.  If you want to control for certain whether
3471 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3472 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3474 GCC allows you to use @option{-g} with
3475 @option{-O}.  The shortcuts taken by optimized code may occasionally
3476 produce surprising results: some variables you declared may not exist
3477 at all; flow of control may briefly move where you did not expect it;
3478 some statements may not be executed because they compute constant
3479 results or their values were already at hand; some statements may
3480 execute in different places because they were moved out of loops.
3482 Nevertheless it proves possible to debug optimized output.  This makes
3483 it reasonable to use the optimizer for programs that might have bugs.
3485 The following options are useful when GCC is generated with the
3486 capability for more than one debugging format.
3488 @item -ggdb
3489 @opindex ggdb
3490 Produce debugging information for use by GDB@.  This means to use the
3491 most expressive format available (DWARF 2, stabs, or the native format
3492 if neither of those are supported), including GDB extensions if at all
3493 possible.
3495 @item -gstabs
3496 @opindex gstabs
3497 Produce debugging information in stabs format (if that is supported),
3498 without GDB extensions.  This is the format used by DBX on most BSD
3499 systems.  On MIPS, Alpha and System V Release 4 systems this option
3500 produces stabs debugging output which is not understood by DBX or SDB@.
3501 On System V Release 4 systems this option requires the GNU assembler.
3503 @item -feliminate-unused-debug-symbols
3504 @opindex feliminate-unused-debug-symbols
3505 Produce debugging information in stabs format (if that is supported),
3506 for only symbols that are actually used.
3508 @item -gstabs+
3509 @opindex gstabs+
3510 Produce debugging information in stabs format (if that is supported),
3511 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3512 use of these extensions is likely to make other debuggers crash or
3513 refuse to read the program.
3515 @item -gcoff
3516 @opindex gcoff
3517 Produce debugging information in COFF format (if that is supported).
3518 This is the format used by SDB on most System V systems prior to
3519 System V Release 4.
3521 @item -gxcoff
3522 @opindex gxcoff
3523 Produce debugging information in XCOFF format (if that is supported).
3524 This is the format used by the DBX debugger on IBM RS/6000 systems.
3526 @item -gxcoff+
3527 @opindex gxcoff+
3528 Produce debugging information in XCOFF format (if that is supported),
3529 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3530 use of these extensions is likely to make other debuggers crash or
3531 refuse to read the program, and may cause assemblers other than the GNU
3532 assembler (GAS) to fail with an error.
3534 @item -gdwarf-2
3535 @opindex gdwarf-2
3536 Produce debugging information in DWARF version 2 format (if that is
3537 supported).  This is the format used by DBX on IRIX 6.  With this
3538 option, GCC uses features of DWARF version 3 when they are useful;
3539 version 3 is upward compatible with version 2, but may still cause
3540 problems for older debuggers.
3542 @item -gvms
3543 @opindex gvms
3544 Produce debugging information in VMS debug format (if that is
3545 supported).  This is the format used by DEBUG on VMS systems.
3547 @item -g@var{level}
3548 @itemx -ggdb@var{level}
3549 @itemx -gstabs@var{level}
3550 @itemx -gcoff@var{level}
3551 @itemx -gxcoff@var{level}
3552 @itemx -gvms@var{level}
3553 Request debugging information and also use @var{level} to specify how
3554 much information.  The default level is 2.
3556 Level 1 produces minimal information, enough for making backtraces in
3557 parts of the program that you don't plan to debug.  This includes
3558 descriptions of functions and external variables, but no information
3559 about local variables and no line numbers.
3561 Level 3 includes extra information, such as all the macro definitions
3562 present in the program.  Some debuggers support macro expansion when
3563 you use @option{-g3}.
3565 @option{-gdwarf-2} does not accept a concatenated debug level, because
3566 GCC used to support an option @option{-gdwarf} that meant to generate
3567 debug information in version 1 of the DWARF format (which is very
3568 different from version 2), and it would have been too confusing.  That
3569 debug format is long obsolete, but the option cannot be changed now.
3570 Instead use an additional @option{-g@var{level}} option to change the
3571 debug level for DWARF2.
3573 @item -feliminate-dwarf2-dups
3574 @opindex feliminate-dwarf2-dups
3575 Compress DWARF2 debugging information by eliminating duplicated
3576 information about each symbol.  This option only makes sense when
3577 generating DWARF2 debugging information with @option{-gdwarf-2}.
3579 @cindex @command{prof}
3580 @item -p
3581 @opindex p
3582 Generate extra code to write profile information suitable for the
3583 analysis program @command{prof}.  You must use this option when compiling
3584 the source files you want data about, and you must also use it when
3585 linking.
3587 @cindex @command{gprof}
3588 @item -pg
3589 @opindex pg
3590 Generate extra code to write profile information suitable for the
3591 analysis program @command{gprof}.  You must use this option when compiling
3592 the source files you want data about, and you must also use it when
3593 linking.
3595 @item -Q
3596 @opindex Q
3597 Makes the compiler print out each function name as it is compiled, and
3598 print some statistics about each pass when it finishes.
3600 @item -ftime-report
3601 @opindex ftime-report
3602 Makes the compiler print some statistics about the time consumed by each
3603 pass when it finishes.
3605 @item -fmem-report
3606 @opindex fmem-report
3607 Makes the compiler print some statistics about permanent memory
3608 allocation when it finishes.
3610 @item -fprofile-arcs
3611 @opindex fprofile-arcs
3612 Add code so that program flow @dfn{arcs} are instrumented.  During
3613 execution the program records how many times each branch and call is
3614 executed and how many times it is taken or returns.  When the compiled
3615 program exits it saves this data to a file called
3616 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3617 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3618 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3619 @var{auxname} is generated from the name of the output file, if
3620 explicitly specified and it is not the final executable, otherwise it is
3621 the basename of the source file.  In both cases any suffix is removed
3622 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3623 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3624 @xref{Cross-profiling}.
3626 @cindex @command{gcov}
3627 @item --coverage
3628 @opindex coverage
3630 This option is used to compile and link code instrumented for coverage
3631 analysis.  The option is a synonym for @option{-fprofile-arcs}
3632 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3633 linking).  See the documentation for those options for more details.
3635 @itemize
3637 @item
3638 Compile the source files with @option{-fprofile-arcs} plus optimization
3639 and code generation options.  For test coverage analysis, use the
3640 additional @option{-ftest-coverage} option.  You do not need to profile
3641 every source file in a program.
3643 @item
3644 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3645 (the latter implies the former).
3647 @item
3648 Run the program on a representative workload to generate the arc profile
3649 information.  This may be repeated any number of times.  You can run
3650 concurrent instances of your program, and provided that the file system
3651 supports locking, the data files will be correctly updated.  Also
3652 @code{fork} calls are detected and correctly handled (double counting
3653 will not happen).
3655 @item
3656 For profile-directed optimizations, compile the source files again with
3657 the same optimization and code generation options plus
3658 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3659 Control Optimization}).
3661 @item
3662 For test coverage analysis, use @command{gcov} to produce human readable
3663 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3664 @command{gcov} documentation for further information.
3666 @end itemize
3668 With @option{-fprofile-arcs}, for each function of your program GCC
3669 creates a program flow graph, then finds a spanning tree for the graph.
3670 Only arcs that are not on the spanning tree have to be instrumented: the
3671 compiler adds code to count the number of times that these arcs are
3672 executed.  When an arc is the only exit or only entrance to a block, the
3673 instrumentation code can be added to the block; otherwise, a new basic
3674 block must be created to hold the instrumentation code.
3676 @need 2000
3677 @item -ftest-coverage
3678 @opindex ftest-coverage
3679 Produce a notes file that the @command{gcov} code-coverage utility
3680 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3681 show program coverage.  Each source file's note file is called
3682 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3683 above for a description of @var{auxname} and instructions on how to
3684 generate test coverage data.  Coverage data will match the source files
3685 more closely, if you do not optimize.
3687 @item -d@var{letters}
3688 @item -fdump-rtl-@var{pass}
3689 @opindex d
3690 Says to make debugging dumps during compilation at times specified by
3691 @var{letters}.    This is used for debugging the RTL-based passes of the
3692 compiler.  The file names for most of the dumps are made by appending a
3693 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3694 from the name of the output file, if explicitly specified and it is not
3695 an executable, otherwise it is the basename of the source file.
3697 Most debug dumps can be enabled either passing a letter to the @option{-d}
3698 option, or with a long @option{-fdump-rtl} switch; here are the possible
3699 letters for use in @var{letters} and @var{pass}, and their meanings:
3701 @table @gcctabopt
3702 @item -dA
3703 @opindex dA
3704 Annotate the assembler output with miscellaneous debugging information.
3706 @item -db
3707 @itemx -fdump-rtl-bp
3708 @opindex db
3709 @opindex fdump-rtl-bp
3710 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3712 @item -dB
3713 @itemx -fdump-rtl-bbro
3714 @opindex dB
3715 @opindex fdump-rtl-bbro
3716 Dump after block reordering, to @file{@var{file}.30.bbro}.
3718 @item -dc
3719 @itemx -fdump-rtl-combine
3720 @opindex dc
3721 @opindex fdump-rtl-combine
3722 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3724 @item -dC
3725 @itemx -fdump-rtl-ce1
3726 @itemx -fdump-rtl-ce2
3727 @opindex dC
3728 @opindex fdump-rtl-ce1
3729 @opindex fdump-rtl-ce2
3730 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3731 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3732 and @option{-fdump-rtl-ce2} enable dumping after the second if
3733 conversion, to the file @file{@var{file}.18.ce2}.
3735 @item -dd
3736 @itemx -fdump-rtl-btl
3737 @itemx -fdump-rtl-dbr
3738 @opindex dd
3739 @opindex fdump-rtl-btl
3740 @opindex fdump-rtl-dbr
3741 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3742 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3743 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3744 scheduling, to @file{@var{file}.36.dbr}.
3746 @item -dD
3747 @opindex dD
3748 Dump all macro definitions, at the end of preprocessing, in addition to
3749 normal output.
3751 @item -dE
3752 @itemx -fdump-rtl-ce3
3753 @opindex dE
3754 @opindex fdump-rtl-ce3
3755 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3757 @item -df
3758 @itemx -fdump-rtl-cfg
3759 @itemx -fdump-rtl-life
3760 @opindex df
3761 @opindex fdump-rtl-cfg
3762 @opindex fdump-rtl-life
3763 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3764 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3765 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3766 to @file{@var{file}.16.life}.
3768 @item -dg
3769 @itemx -fdump-rtl-greg
3770 @opindex dg
3771 @opindex fdump-rtl-greg
3772 Dump after global register allocation, to @file{@var{file}.23.greg}.
3774 @item -dG
3775 @itemx -fdump-rtl-gcse
3776 @itemx -fdump-rtl-bypass
3777 @opindex dG
3778 @opindex fdump-rtl-gcse
3779 @opindex fdump-rtl-bypass
3780 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3781 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3782 enable dumping after jump bypassing and control flow optimizations, to
3783 @file{@var{file}.07.bypass}.
3785 @item -dh
3786 @itemx -fdump-rtl-eh
3787 @opindex dh
3788 @opindex fdump-rtl-eh
3789 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3791 @item -di
3792 @itemx -fdump-rtl-sibling
3793 @opindex di
3794 @opindex fdump-rtl-sibling
3795 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3797 @item -dj
3798 @itemx -fdump-rtl-jump
3799 @opindex dj
3800 @opindex fdump-rtl-jump
3801 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3803 @item -dk
3804 @itemx -fdump-rtl-stack
3805 @opindex dk
3806 @opindex fdump-rtl-stack
3807 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3809 @item -dl
3810 @itemx -fdump-rtl-lreg
3811 @opindex dl
3812 @opindex fdump-rtl-lreg
3813 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3815 @item -dL
3816 @itemx -fdump-rtl-loop
3817 @itemx -fdump-rtl-loop2
3818 @opindex dL
3819 @opindex fdump-rtl-loop
3820 @opindex fdump-rtl-loop2
3821 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3822 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3823 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3824 @file{@var{file}.13.loop2}.
3826 @item -dm
3827 @itemx -fdump-rtl-sms
3828 @opindex dm
3829 @opindex fdump-rtl-sms
3830 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3832 @item -dM
3833 @itemx -fdump-rtl-mach
3834 @opindex dM
3835 @opindex fdump-rtl-mach
3836 Dump after performing the machine dependent reorganization pass, to
3837 @file{@var{file}.35.mach}.
3839 @item -dn
3840 @itemx -fdump-rtl-rnreg
3841 @opindex dn
3842 @opindex fdump-rtl-rnreg
3843 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3845 @item -dN
3846 @itemx -fdump-rtl-regmove
3847 @opindex dN
3848 @opindex fdump-rtl-regmove
3849 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3851 @item -do
3852 @itemx -fdump-rtl-postreload
3853 @opindex do
3854 @opindex fdump-rtl-postreload
3855 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3857 @item -dr
3858 @itemx -fdump-rtl-expand
3859 @opindex dr
3860 @opindex fdump-rtl-expand
3861 Dump after RTL generation, to @file{@var{file}.00.expand}.
3863 @item -dR
3864 @itemx -fdump-rtl-sched2
3865 @opindex dR
3866 @opindex fdump-rtl-sched2
3867 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3869 @item -ds
3870 @itemx -fdump-rtl-cse
3871 @opindex ds
3872 @opindex fdump-rtl-cse
3873 Dump after CSE (including the jump optimization that sometimes follows
3874 CSE), to @file{@var{file}.04.cse}.
3876 @item -dS
3877 @itemx -fdump-rtl-sched
3878 @opindex dS
3879 @opindex fdump-rtl-sched
3880 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3882 @item -dt
3883 @itemx -fdump-rtl-cse2
3884 @opindex dt
3885 @opindex fdump-rtl-cse2
3886 Dump after the second CSE pass (including the jump optimization that
3887 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3889 @item -dT
3890 @itemx -fdump-rtl-tracer
3891 @opindex dT
3892 @opindex fdump-rtl-tracer
3893 Dump after running tracer, to @file{@var{file}.12.tracer}.
3895 @item -dV
3896 @itemx -fdump-rtl-vpt
3897 @itemx -fdump-rtl-vartrack
3898 @opindex dV
3899 @opindex fdump-rtl-vpt
3900 @opindex fdump-rtl-vartrack
3901 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3902 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3903 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3904 to @file{@var{file}.34.vartrack}.
3906 @item -dw
3907 @itemx -fdump-rtl-flow2
3908 @opindex dw
3909 @opindex fdump-rtl-flow2
3910 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3912 @item -dz
3913 @itemx -fdump-rtl-peephole2
3914 @opindex dz
3915 @opindex fdump-rtl-peephole2
3916 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3918 @item -dZ
3919 @itemx -fdump-rtl-web
3920 @opindex dZ
3921 @opindex fdump-rtl-web
3922 Dump after live range splitting, to @file{@var{file}.14.web}.
3924 @item -da
3925 @itemx -fdump-rtl-all
3926 @opindex da
3927 @opindex fdump-rtl-all
3928 Produce all the dumps listed above.
3930 @item -dH
3931 @opindex dH
3932 Produce a core dump whenever an error occurs.
3934 @item -dm
3935 @opindex dm
3936 Print statistics on memory usage, at the end of the run, to
3937 standard error.
3939 @item -dp
3940 @opindex dp
3941 Annotate the assembler output with a comment indicating which
3942 pattern and alternative was used.  The length of each instruction is
3943 also printed.
3945 @item -dP
3946 @opindex dP
3947 Dump the RTL in the assembler output as a comment before each instruction.
3948 Also turns on @option{-dp} annotation.
3950 @item -dv
3951 @opindex dv
3952 For each of the other indicated dump files (either with @option{-d} or
3953 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3954 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3956 @item -dx
3957 @opindex dx
3958 Just generate RTL for a function instead of compiling it.  Usually used
3959 with @samp{r} (@option{-fdump-rtl-expand}).
3961 @item -dy
3962 @opindex dy
3963 Dump debugging information during parsing, to standard error.
3964 @end table
3966 @item -fdump-unnumbered
3967 @opindex fdump-unnumbered
3968 When doing debugging dumps (see @option{-d} option above), suppress instruction
3969 numbers and line number note output.  This makes it more feasible to
3970 use diff on debugging dumps for compiler invocations with different
3971 options, in particular with and without @option{-g}.
3973 @item -fdump-translation-unit @r{(C++ only)}
3974 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3975 @opindex fdump-translation-unit
3976 Dump a representation of the tree structure for the entire translation
3977 unit to a file.  The file name is made by appending @file{.tu} to the
3978 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3979 controls the details of the dump as described for the
3980 @option{-fdump-tree} options.
3982 @item -fdump-class-hierarchy @r{(C++ only)}
3983 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3984 @opindex fdump-class-hierarchy
3985 Dump a representation of each class's hierarchy and virtual function
3986 table layout to a file.  The file name is made by appending @file{.class}
3987 to the source file name.  If the @samp{-@var{options}} form is used,
3988 @var{options} controls the details of the dump as described for the
3989 @option{-fdump-tree} options.
3991 @item -fdump-ipa-@var{switch}
3992 @opindex fdump-ipa
3993 Control the dumping at various stages of inter-procedural analysis
3994 language tree to a file.  The file name is generated by appending a switch
3995 specific suffix to the source file name.  The following dumps are possible:
3997 @table @samp
3998 @item all
3999 Enables all inter-procedural analysis dumps; currently the only produced
4000 dump is the @samp{cgraph} dump.
4002 @item cgraph
4003 Dumps information about call-graph optimization, unused function removal,
4004 and inlining decisions.
4005 @end table
4007 @item -fdump-tree-@var{switch}
4008 @itemx -fdump-tree-@var{switch}-@var{options}
4009 @opindex fdump-tree
4010 Control the dumping at various stages of processing the intermediate
4011 language tree to a file.  The file name is generated by appending a switch
4012 specific suffix to the source file name.  If the @samp{-@var{options}}
4013 form is used, @var{options} is a list of @samp{-} separated options that
4014 control the details of the dump.  Not all options are applicable to all
4015 dumps, those which are not meaningful will be ignored.  The following
4016 options are available
4018 @table @samp
4019 @item address
4020 Print the address of each node.  Usually this is not meaningful as it
4021 changes according to the environment and source file.  Its primary use
4022 is for tying up a dump file with a debug environment.
4023 @item slim
4024 Inhibit dumping of members of a scope or body of a function merely
4025 because that scope has been reached.  Only dump such items when they
4026 are directly reachable by some other path.  When dumping pretty-printed
4027 trees, this option inhibits dumping the bodies of control structures.
4028 @item raw
4029 Print a raw representation of the tree.  By default, trees are
4030 pretty-printed into a C-like representation.
4031 @item details
4032 Enable more detailed dumps (not honored by every dump option).
4033 @item stats
4034 Enable dumping various statistics about the pass (not honored by every dump
4035 option).
4036 @item blocks
4037 Enable showing basic block boundaries (disabled in raw dumps).
4038 @item vops
4039 Enable showing virtual operands for every statement.
4040 @item lineno
4041 Enable showing line numbers for statements.
4042 @item uid
4043 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4044 @item all
4045 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4046 @end table
4048 The following tree dumps are possible:
4049 @table @samp
4051 @item original
4052 Dump before any tree based optimization, to @file{@var{file}.original}.
4054 @item optimized
4055 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4057 @item inlined
4058 Dump after function inlining, to @file{@var{file}.inlined}.
4060 @item gimple
4061 @opindex fdump-tree-gimple
4062 Dump each function before and after the gimplification pass to a file.  The
4063 file name is made by appending @file{.gimple} to the source file name.
4065 @item cfg
4066 @opindex fdump-tree-cfg
4067 Dump the control flow graph of each function to a file.  The file name is
4068 made by appending @file{.cfg} to the source file name.
4070 @item vcg
4071 @opindex fdump-tree-vcg
4072 Dump the control flow graph of each function to a file in VCG format.  The
4073 file name is made by appending @file{.vcg} to the source file name.  Note
4074 that if the file contains more than one function, the generated file cannot
4075 be used directly by VCG@.  You will need to cut and paste each function's
4076 graph into its own separate file first.
4078 @item ch
4079 @opindex fdump-tree-ch
4080 Dump each function after copying loop headers.  The file name is made by
4081 appending @file{.ch} to the source file name.
4083 @item ssa
4084 @opindex fdump-tree-ssa
4085 Dump SSA related information to a file.  The file name is made by appending
4086 @file{.ssa} to the source file name.
4088 @item salias
4089 @opindex fdump-tree-salias
4090 Dump structure aliasing variable information to a file.  This file name
4091 is made by appending @file{.salias} to the source file name.
4093 @item alias
4094 @opindex fdump-tree-alias
4095 Dump aliasing information for each function.  The file name is made by
4096 appending @file{.alias} to the source file name.
4098 @item ccp
4099 @opindex fdump-tree-ccp
4100 Dump each function after CCP@.  The file name is made by appending
4101 @file{.ccp} to the source file name.
4103 @item storeccp
4104 @opindex fdump-tree-storeccp
4105 Dump each function after STORE-CCP.  The file name is made by appending
4106 @file{.storeccp} to the source file name.
4108 @item pre
4109 @opindex fdump-tree-pre
4110 Dump trees after partial redundancy elimination.  The file name is made
4111 by appending @file{.pre} to the source file name.
4113 @item fre
4114 @opindex fdump-tree-fre
4115 Dump trees after full redundancy elimination.  The file name is made
4116 by appending @file{.fre} to the source file name.
4118 @item copyprop
4119 @opindex fdump-tree-copyprop
4120 Dump trees after copy propagation.  The file name is made
4121 by appending @file{.copyprop} to the source file name.
4123 @item store_copyprop
4124 @opindex fdump-tree-store_copyprop
4125 Dump trees after store copy-propagation.  The file name is made
4126 by appending @file{.store_copyprop} to the source file name.
4128 @item dce
4129 @opindex fdump-tree-dce
4130 Dump each function after dead code elimination.  The file name is made by
4131 appending @file{.dce} to the source file name.
4133 @item mudflap
4134 @opindex fdump-tree-mudflap
4135 Dump each function after adding mudflap instrumentation.  The file name is
4136 made by appending @file{.mudflap} to the source file name.
4138 @item sra
4139 @opindex fdump-tree-sra
4140 Dump each function after performing scalar replacement of aggregates.  The
4141 file name is made by appending @file{.sra} to the source file name.
4143 @item sink
4144 @opindex fdump-tree-sink
4145 Dump each function after performing code sinking.  The file name is made
4146 by appending @file{.sink} to the source file name. 
4148 @item dom
4149 @opindex fdump-tree-dom
4150 Dump each function after applying dominator tree optimizations.  The file
4151 name is made by appending @file{.dom} to the source file name.
4153 @item dse
4154 @opindex fdump-tree-dse
4155 Dump each function after applying dead store elimination.  The file
4156 name is made by appending @file{.dse} to the source file name.
4158 @item phiopt
4159 @opindex fdump-tree-phiopt
4160 Dump each function after optimizing PHI nodes into straightline code.  The file
4161 name is made by appending @file{.phiopt} to the source file name.
4163 @item forwprop
4164 @opindex fdump-tree-forwprop
4165 Dump each function after forward propagating single use variables.  The file
4166 name is made by appending @file{.forwprop} to the source file name.
4168 @item copyrename
4169 @opindex fdump-tree-copyrename
4170 Dump each function after applying the copy rename optimization.  The file
4171 name is made by appending @file{.copyrename} to the source file name.
4173 @item nrv
4174 @opindex fdump-tree-nrv
4175 Dump each function after applying the named return value optimization on
4176 generic trees.  The file name is made by appending @file{.nrv} to the source
4177 file name.
4179 @item vect
4180 @opindex fdump-tree-vect
4181 Dump each function after applying vectorization of loops.  The file name is
4182 made by appending @file{.vect} to the source file name.
4184 @item vrp
4185 @opindex fdump-tree-vrp
4186 Dump each function after Value Range Propagation (VRP).  The file name
4187 is made by appending @file{.vrp} to the source file name.
4189 @item all
4190 @opindex fdump-tree-all
4191 Enable all the available tree dumps with the flags provided in this option.
4192 @end table
4194 @item -ftree-vectorizer-verbose=@var{n}
4195 @opindex ftree-vectorizer-verbose
4196 This option controls the amount of debugging output the vectorizer prints.
4197 This information is written to standard error, unless @option{-fdump-tree-all}
4198 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4199 usual dump listing file, @file{.vect}.
4201 @item -frandom-seed=@var{string}
4202 @opindex frandom-string
4203 This option provides a seed that GCC uses when it would otherwise use
4204 random numbers.  It is used to generate certain symbol names
4205 that have to be different in every compiled file.  It is also used to
4206 place unique stamps in coverage data files and the object files that
4207 produce them.  You can use the @option{-frandom-seed} option to produce
4208 reproducibly identical object files.
4210 The @var{string} should be different for every file you compile.
4212 @item -fsched-verbose=@var{n}
4213 @opindex fsched-verbose
4214 On targets that use instruction scheduling, this option controls the
4215 amount of debugging output the scheduler prints.  This information is
4216 written to standard error, unless @option{-dS} or @option{-dR} is
4217 specified, in which case it is output to the usual dump
4218 listing file, @file{.sched} or @file{.sched2} respectively.  However
4219 for @var{n} greater than nine, the output is always printed to standard
4220 error.
4222 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4223 same information as @option{-dRS}.  For @var{n} greater than one, it
4224 also output basic block probabilities, detailed ready list information
4225 and unit/insn info.  For @var{n} greater than two, it includes RTL
4226 at abort point, control-flow and regions info.  And for @var{n} over
4227 four, @option{-fsched-verbose} also includes dependence info.
4229 @item -save-temps
4230 @opindex save-temps
4231 Store the usual ``temporary'' intermediate files permanently; place them
4232 in the current directory and name them based on the source file.  Thus,
4233 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4234 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4235 preprocessed @file{foo.i} output file even though the compiler now
4236 normally uses an integrated preprocessor.
4238 When used in combination with the @option{-x} command line option,
4239 @option{-save-temps} is sensible enough to avoid over writing an
4240 input source file with the same extension as an intermediate file.
4241 The corresponding intermediate file may be obtained by renaming the
4242 source file before using @option{-save-temps}.
4244 @item -time
4245 @opindex time
4246 Report the CPU time taken by each subprocess in the compilation
4247 sequence.  For C source files, this is the compiler proper and assembler
4248 (plus the linker if linking is done).  The output looks like this:
4250 @smallexample
4251 # cc1 0.12 0.01
4252 # as 0.00 0.01
4253 @end smallexample
4255 The first number on each line is the ``user time'', that is time spent
4256 executing the program itself.  The second number is ``system time'',
4257 time spent executing operating system routines on behalf of the program.
4258 Both numbers are in seconds.
4260 @item -fvar-tracking
4261 @opindex fvar-tracking
4262 Run variable tracking pass.  It computes where variables are stored at each
4263 position in code.  Better debugging information is then generated
4264 (if the debugging information format supports this information).
4266 It is enabled by default when compiling with optimization (@option{-Os},
4267 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4268 the debug info format supports it.
4270 @item -print-file-name=@var{library}
4271 @opindex print-file-name
4272 Print the full absolute name of the library file @var{library} that
4273 would be used when linking---and don't do anything else.  With this
4274 option, GCC does not compile or link anything; it just prints the
4275 file name.
4277 @item -print-multi-directory
4278 @opindex print-multi-directory
4279 Print the directory name corresponding to the multilib selected by any
4280 other switches present in the command line.  This directory is supposed
4281 to exist in @env{GCC_EXEC_PREFIX}.
4283 @item -print-multi-lib
4284 @opindex print-multi-lib
4285 Print the mapping from multilib directory names to compiler switches
4286 that enable them.  The directory name is separated from the switches by
4287 @samp{;}, and each switch starts with an @samp{@@} instead of the
4288 @samp{-}, without spaces between multiple switches.  This is supposed to
4289 ease shell-processing.
4291 @item -print-prog-name=@var{program}
4292 @opindex print-prog-name
4293 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4295 @item -print-libgcc-file-name
4296 @opindex print-libgcc-file-name
4297 Same as @option{-print-file-name=libgcc.a}.
4299 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4300 but you do want to link with @file{libgcc.a}.  You can do
4302 @smallexample
4303 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4304 @end smallexample
4306 @item -print-search-dirs
4307 @opindex print-search-dirs
4308 Print the name of the configured installation directory and a list of
4309 program and library directories @command{gcc} will search---and don't do anything else.
4311 This is useful when @command{gcc} prints the error message
4312 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4313 To resolve this you either need to put @file{cpp0} and the other compiler
4314 components where @command{gcc} expects to find them, or you can set the environment
4315 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4316 Don't forget the trailing @samp{/}.
4317 @xref{Environment Variables}.
4319 @item -dumpmachine
4320 @opindex dumpmachine
4321 Print the compiler's target machine (for example,
4322 @samp{i686-pc-linux-gnu})---and don't do anything else.
4324 @item -dumpversion
4325 @opindex dumpversion
4326 Print the compiler version (for example, @samp{3.0})---and don't do
4327 anything else.
4329 @item -dumpspecs
4330 @opindex dumpspecs
4331 Print the compiler's built-in specs---and don't do anything else.  (This
4332 is used when GCC itself is being built.)  @xref{Spec Files}.
4334 @item -feliminate-unused-debug-types
4335 @opindex feliminate-unused-debug-types
4336 Normally, when producing DWARF2 output, GCC will emit debugging
4337 information for all types declared in a compilation
4338 unit, regardless of whether or not they are actually used
4339 in that compilation unit.  Sometimes this is useful, such as
4340 if, in the debugger, you want to cast a value to a type that is
4341 not actually used in your program (but is declared).  More often,
4342 however, this results in a significant amount of wasted space.
4343 With this option, GCC will avoid producing debug symbol output
4344 for types that are nowhere used in the source file being compiled.
4345 @end table
4347 @node Optimize Options
4348 @section Options That Control Optimization
4349 @cindex optimize options
4350 @cindex options, optimization
4352 These options control various sorts of optimizations.
4354 Without any optimization option, the compiler's goal is to reduce the
4355 cost of compilation and to make debugging produce the expected
4356 results.  Statements are independent: if you stop the program with a
4357 breakpoint between statements, you can then assign a new value to any
4358 variable or change the program counter to any other statement in the
4359 function and get exactly the results you would expect from the source
4360 code.
4362 Turning on optimization flags makes the compiler attempt to improve
4363 the performance and/or code size at the expense of compilation time
4364 and possibly the ability to debug the program.
4366 The compiler performs optimization based on the knowledge it has of
4367 the program.  Optimization levels @option{-O2} and above, in
4368 particular, enable @emph{unit-at-a-time} mode, which allows the
4369 compiler to consider information gained from later functions in
4370 the file when compiling a function.  Compiling multiple files at
4371 once to a single output file in @emph{unit-at-a-time} mode allows
4372 the compiler to use information gained from all of the files when
4373 compiling each of them.
4375 Not all optimizations are controlled directly by a flag.  Only
4376 optimizations that have a flag are listed.
4378 @table @gcctabopt
4379 @item -O
4380 @itemx -O1
4381 @opindex O
4382 @opindex O1
4383 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4384 more memory for a large function.
4386 With @option{-O}, the compiler tries to reduce code size and execution
4387 time, without performing any optimizations that take a great deal of
4388 compilation time.
4390 @option{-O} turns on the following optimization flags:
4391 @gccoptlist{-fdefer-pop @gol
4392 -fdelayed-branch @gol
4393 -fguess-branch-probability @gol
4394 -fcprop-registers @gol
4395 -floop-optimize @gol
4396 -fif-conversion @gol
4397 -fif-conversion2 @gol
4398 -ftree-ccp @gol
4399 -ftree-dce @gol
4400 -ftree-dominator-opts @gol
4401 -ftree-dse @gol
4402 -ftree-ter @gol
4403 -ftree-lrs @gol
4404 -ftree-sra @gol
4405 -ftree-copyrename @gol
4406 -ftree-fre @gol
4407 -ftree-ch @gol
4408 -fmerge-constants}
4410 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4411 where doing so does not interfere with debugging.
4413 @item -O2
4414 @opindex O2
4415 Optimize even more.  GCC performs nearly all supported optimizations
4416 that do not involve a space-speed tradeoff.  The compiler does not
4417 perform loop unrolling or function inlining when you specify @option{-O2}.
4418 As compared to @option{-O}, this option increases both compilation time
4419 and the performance of the generated code.
4421 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4422 also turns on the following optimization flags:
4423 @gccoptlist{-fthread-jumps @gol
4424 -fcrossjumping @gol
4425 -foptimize-sibling-calls @gol
4426 -fcse-follow-jumps  -fcse-skip-blocks @gol
4427 -fgcse  -fgcse-lm  @gol
4428 -fexpensive-optimizations @gol
4429 -fstrength-reduce @gol
4430 -frerun-cse-after-loop  -frerun-loop-opt @gol
4431 -fcaller-saves @gol
4432 -fpeephole2 @gol
4433 -fschedule-insns  -fschedule-insns2 @gol
4434 -fsched-interblock  -fsched-spec @gol
4435 -fregmove @gol
4436 -fstrict-aliasing @gol
4437 -fdelete-null-pointer-checks @gol
4438 -freorder-blocks  -freorder-functions @gol
4439 -funit-at-a-time @gol
4440 -falign-functions  -falign-jumps @gol
4441 -falign-loops  -falign-labels @gol
4442 -ftree-vrp @gol
4443 -ftree-pre}
4445 Please note the warning under @option{-fgcse} about
4446 invoking @option{-O2} on programs that use computed gotos.
4448 @item -O3
4449 @opindex O3
4450 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4451 @option{-O2} and also turns on the @option{-finline-functions},
4452 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4454 @item -O0
4455 @opindex O0
4456 Do not optimize.  This is the default.
4458 @item -Os
4459 @opindex Os
4460 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4461 do not typically increase code size.  It also performs further
4462 optimizations designed to reduce code size.
4464 @option{-Os} disables the following optimization flags:
4465 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4466 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4467 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4469 If you use multiple @option{-O} options, with or without level numbers,
4470 the last such option is the one that is effective.
4471 @end table
4473 Options of the form @option{-f@var{flag}} specify machine-independent
4474 flags.  Most flags have both positive and negative forms; the negative
4475 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4476 below, only one of the forms is listed---the one you typically will
4477 use.  You can figure out the other form by either removing @samp{no-}
4478 or adding it.
4480 The following options control specific optimizations.  They are either
4481 activated by @option{-O} options or are related to ones that are.  You
4482 can use the following flags in the rare cases when ``fine-tuning'' of
4483 optimizations to be performed is desired.
4485 @table @gcctabopt
4486 @item -fno-default-inline
4487 @opindex fno-default-inline
4488 Do not make member functions inline by default merely because they are
4489 defined inside the class scope (C++ only).  Otherwise, when you specify
4490 @w{@option{-O}}, member functions defined inside class scope are compiled
4491 inline by default; i.e., you don't need to add @samp{inline} in front of
4492 the member function name.
4494 @item -fno-defer-pop
4495 @opindex fno-defer-pop
4496 Always pop the arguments to each function call as soon as that function
4497 returns.  For machines which must pop arguments after a function call,
4498 the compiler normally lets arguments accumulate on the stack for several
4499 function calls and pops them all at once.
4501 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4503 @item -fforce-mem
4504 @opindex fforce-mem
4505 Force memory operands to be copied into registers before doing
4506 arithmetic on them.  This produces better code by making all memory
4507 references potential common subexpressions.  When they are not common
4508 subexpressions, instruction combination should eliminate the separate
4509 register-load. This option is now a nop and will be removed in 4.2.
4511 @item -fforce-addr
4512 @opindex fforce-addr
4513 Force memory address constants to be copied into registers before
4514 doing arithmetic on them.
4516 @item -fomit-frame-pointer
4517 @opindex fomit-frame-pointer
4518 Don't keep the frame pointer in a register for functions that
4519 don't need one.  This avoids the instructions to save, set up and
4520 restore frame pointers; it also makes an extra register available
4521 in many functions.  @strong{It also makes debugging impossible on
4522 some machines.}
4524 On some machines, such as the VAX, this flag has no effect, because
4525 the standard calling sequence automatically handles the frame pointer
4526 and nothing is saved by pretending it doesn't exist.  The
4527 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4528 whether a target machine supports this flag.  @xref{Registers,,Register
4529 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4531 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4533 @item -foptimize-sibling-calls
4534 @opindex foptimize-sibling-calls
4535 Optimize sibling and tail recursive calls.
4537 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4539 @item -fno-inline
4540 @opindex fno-inline
4541 Don't pay attention to the @code{inline} keyword.  Normally this option
4542 is used to keep the compiler from expanding any functions inline.
4543 Note that if you are not optimizing, no functions can be expanded inline.
4545 @item -finline-functions
4546 @opindex finline-functions
4547 Integrate all simple functions into their callers.  The compiler
4548 heuristically decides which functions are simple enough to be worth
4549 integrating in this way.
4551 If all calls to a given function are integrated, and the function is
4552 declared @code{static}, then the function is normally not output as
4553 assembler code in its own right.
4555 Enabled at level @option{-O3}.
4557 @item -finline-functions-called-once
4558 @opindex finline-functions-called-once
4559 Consider all @code{static} functions called once for inlining into their
4560 caller even if they are not marked @code{inline}.  If a call to a given
4561 function is integrated, then the function is not output as assembler code
4562 in its own right.
4564 Enabled if @option{-funit-at-a-time} is enabled.
4566 @item -fearly-inlining
4567 @opindex fearly-inlining
4568 Inline functions marked by @code{always_inline} and functions whose body seems
4569 smaller than the function call overhead early before doing
4570 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4571 makes profiling significantly cheaper and usually inlining faster on programs
4572 having large chains of nested wrapper functions.
4574 Enabled by default.
4576 @item -finline-limit=@var{n}
4577 @opindex finline-limit
4578 By default, GCC limits the size of functions that can be inlined.  This flag
4579 allows the control of this limit for functions that are explicitly marked as
4580 inline (i.e., marked with the inline keyword or defined within the class
4581 definition in c++).  @var{n} is the size of functions that can be inlined in
4582 number of pseudo instructions (not counting parameter handling).  The default
4583 value of @var{n} is 600.
4584 Increasing this value can result in more inlined code at
4585 the cost of compilation time and memory consumption.  Decreasing usually makes
4586 the compilation faster and less code will be inlined (which presumably
4587 means slower programs).  This option is particularly useful for programs that
4588 use inlining heavily such as those based on recursive templates with C++.
4590 Inlining is actually controlled by a number of parameters, which may be
4591 specified individually by using @option{--param @var{name}=@var{value}}.
4592 The @option{-finline-limit=@var{n}} option sets some of these parameters
4593 as follows:
4595 @table @gcctabopt
4596  @item max-inline-insns-single
4597   is set to @var{n}/2.
4598  @item max-inline-insns-auto
4599   is set to @var{n}/2.
4600  @item min-inline-insns
4601   is set to 130 or @var{n}/4, whichever is smaller.
4602  @item max-inline-insns-rtl
4603   is set to @var{n}.
4604 @end table
4606 See below for a documentation of the individual
4607 parameters controlling inlining.
4609 @emph{Note:} pseudo instruction represents, in this particular context, an
4610 abstract measurement of function's size.  In no way does it represent a count
4611 of assembly instructions and as such its exact meaning might change from one
4612 release to an another.
4614 @item -fkeep-inline-functions
4615 @opindex fkeep-inline-functions
4616 In C, emit @code{static} functions that are declared @code{inline}
4617 into the object file, even if the function has been inlined into all
4618 of its callers.  This switch does not affect functions using the
4619 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4620 inline functions into the object file.
4622 @item -fkeep-static-consts
4623 @opindex fkeep-static-consts
4624 Emit variables declared @code{static const} when optimization isn't turned
4625 on, even if the variables aren't referenced.
4627 GCC enables this option by default.  If you want to force the compiler to
4628 check if the variable was referenced, regardless of whether or not
4629 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4631 @item -fmerge-constants
4632 Attempt to merge identical constants (string constants and floating point
4633 constants) across compilation units.
4635 This option is the default for optimized compilation if the assembler and
4636 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4637 behavior.
4639 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4641 @item -fmerge-all-constants
4642 Attempt to merge identical constants and identical variables.
4644 This option implies @option{-fmerge-constants}.  In addition to
4645 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4646 arrays or initialized constant variables with integral or floating point
4647 types.  Languages like C or C++ require each non-automatic variable to
4648 have distinct location, so using this option will result in non-conforming
4649 behavior.
4651 @item -fmodulo-sched
4652 @opindex fmodulo-sched
4653 Perform swing modulo scheduling immediately before the first scheduling
4654 pass.  This pass looks at innermost loops and reorders their
4655 instructions by overlapping different iterations.
4657 @item -fno-branch-count-reg
4658 @opindex fno-branch-count-reg
4659 Do not use ``decrement and branch'' instructions on a count register,
4660 but instead generate a sequence of instructions that decrement a
4661 register, compare it against zero, then branch based upon the result.
4662 This option is only meaningful on architectures that support such
4663 instructions, which include x86, PowerPC, IA-64 and S/390.
4665 The default is @option{-fbranch-count-reg}, enabled when
4666 @option{-fstrength-reduce} is enabled.
4668 @item -fno-function-cse
4669 @opindex fno-function-cse
4670 Do not put function addresses in registers; make each instruction that
4671 calls a constant function contain the function's address explicitly.
4673 This option results in less efficient code, but some strange hacks
4674 that alter the assembler output may be confused by the optimizations
4675 performed when this option is not used.
4677 The default is @option{-ffunction-cse}
4679 @item -fno-zero-initialized-in-bss
4680 @opindex fno-zero-initialized-in-bss
4681 If the target supports a BSS section, GCC by default puts variables that
4682 are initialized to zero into BSS@.  This can save space in the resulting
4683 code.
4685 This option turns off this behavior because some programs explicitly
4686 rely on variables going to the data section.  E.g., so that the
4687 resulting executable can find the beginning of that section and/or make
4688 assumptions based on that.
4690 The default is @option{-fzero-initialized-in-bss}.
4692 @item -fbounds-check
4693 @opindex fbounds-check
4694 For front-ends that support it, generate additional code to check that
4695 indices used to access arrays are within the declared range.  This is
4696 currently only supported by the Java and Fortran front-ends, where
4697 this option defaults to true and false respectively.
4699 @item -fmudflap -fmudflapth -fmudflapir
4700 @opindex fmudflap
4701 @opindex fmudflapth
4702 @opindex fmudflapir
4703 @cindex bounds checking
4704 @cindex mudflap
4705 For front-ends that support it (C and C++), instrument all risky
4706 pointer/array dereferencing operations, some standard library
4707 string/heap functions, and some other associated constructs with
4708 range/validity tests.  Modules so instrumented should be immune to
4709 buffer overflows, invalid heap use, and some other classes of C/C++
4710 programming errors.  The instrumentation relies on a separate runtime
4711 library (@file{libmudflap}), which will be linked into a program if
4712 @option{-fmudflap} is given at link time.  Run-time behavior of the
4713 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4714 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4715 for its options.
4717 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4718 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4719 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4720 instrumentation should ignore pointer reads.  This produces less
4721 instrumentation (and therefore faster execution) and still provides
4722 some protection against outright memory corrupting writes, but allows
4723 erroneously read data to propagate within a program.
4725 @item -fopenmp
4726 @opindex fopenmp
4727 @cindex openmp parallel
4728 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
4729 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
4730 compiler generates parallel code according to the OpenMP Application
4731 Program Interface v2.5.  To generate the final exectuable, the runtime
4732 library @code{libgomp} must be linked in using @option{-lgomp}.
4734 @item -fstrength-reduce
4735 @opindex fstrength-reduce
4736 Perform the optimizations of loop strength reduction and
4737 elimination of iteration variables.
4739 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4741 @item -fthread-jumps
4742 @opindex fthread-jumps
4743 Perform optimizations where we check to see if a jump branches to a
4744 location where another comparison subsumed by the first is found.  If
4745 so, the first branch is redirected to either the destination of the
4746 second branch or a point immediately following it, depending on whether
4747 the condition is known to be true or false.
4749 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4751 @item -fcse-follow-jumps
4752 @opindex fcse-follow-jumps
4753 In common subexpression elimination, scan through jump instructions
4754 when the target of the jump is not reached by any other path.  For
4755 example, when CSE encounters an @code{if} statement with an
4756 @code{else} clause, CSE will follow the jump when the condition
4757 tested is false.
4759 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4761 @item -fcse-skip-blocks
4762 @opindex fcse-skip-blocks
4763 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4764 follow jumps which conditionally skip over blocks.  When CSE
4765 encounters a simple @code{if} statement with no else clause,
4766 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4767 body of the @code{if}.
4769 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4771 @item -frerun-cse-after-loop
4772 @opindex frerun-cse-after-loop
4773 Re-run common subexpression elimination after loop optimizations has been
4774 performed.
4776 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4778 @item -frerun-loop-opt
4779 @opindex frerun-loop-opt
4780 Run the loop optimizer twice.
4782 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4784 @item -fgcse
4785 @opindex fgcse
4786 Perform a global common subexpression elimination pass.
4787 This pass also performs global constant and copy propagation.
4789 @emph{Note:} When compiling a program using computed gotos, a GCC
4790 extension, you may get better runtime performance if you disable
4791 the global common subexpression elimination pass by adding
4792 @option{-fno-gcse} to the command line.
4794 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4796 @item -fgcse-lm
4797 @opindex fgcse-lm
4798 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4799 attempt to move loads which are only killed by stores into themselves.  This
4800 allows a loop containing a load/store sequence to be changed to a load outside
4801 the loop, and a copy/store within the loop.
4803 Enabled by default when gcse is enabled.
4805 @item -fgcse-sm
4806 @opindex fgcse-sm
4807 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4808 global common subexpression elimination.  This pass will attempt to move
4809 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4810 loops containing a load/store sequence can be changed to a load before
4811 the loop and a store after the loop.
4813 Not enabled at any optimization level.
4815 @item -fgcse-las
4816 @opindex fgcse-las
4817 When @option{-fgcse-las} is enabled, the global common subexpression
4818 elimination pass eliminates redundant loads that come after stores to the
4819 same memory location (both partial and full redundancies).
4821 Not enabled at any optimization level.
4823 @item -fgcse-after-reload
4824 @opindex fgcse-after-reload
4825 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4826 pass is performed after reload.  The purpose of this pass is to cleanup
4827 redundant spilling.
4829 @item -floop-optimize
4830 @opindex floop-optimize
4831 Perform loop optimizations: move constant expressions out of loops, simplify
4832 exit test conditions and optionally do strength-reduction as well.
4834 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4836 @item -funsafe-loop-optimizations
4837 @opindex funsafe-loop-optimizations
4838 If given, the loop optimizer will assume that loop indices do not
4839 overflow, and that the loops with nontrivial exit condition are not
4840 infinite.  This enables a wider range of loop optimizations even if
4841 the loop optimizer itself cannot prove that these assumptions are valid.
4842 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4843 if it finds this kind of loop.
4845 @item -fcrossjumping
4846 @opindex crossjumping
4847 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4848 resulting code may or may not perform better than without cross-jumping.
4850 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4852 @item -fif-conversion
4853 @opindex if-conversion
4854 Attempt to transform conditional jumps into branch-less equivalents.  This
4855 include use of conditional moves, min, max, set flags and abs instructions, and
4856 some tricks doable by standard arithmetics.  The use of conditional execution
4857 on chips where it is available is controlled by @code{if-conversion2}.
4859 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4861 @item -fif-conversion2
4862 @opindex if-conversion2
4863 Use conditional execution (where available) to transform conditional jumps into
4864 branch-less equivalents.
4866 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4868 @item -fdelete-null-pointer-checks
4869 @opindex fdelete-null-pointer-checks
4870 Use global dataflow analysis to identify and eliminate useless checks
4871 for null pointers.  The compiler assumes that dereferencing a null
4872 pointer would have halted the program.  If a pointer is checked after
4873 it has already been dereferenced, it cannot be null.
4875 In some environments, this assumption is not true, and programs can
4876 safely dereference null pointers.  Use
4877 @option{-fno-delete-null-pointer-checks} to disable this optimization
4878 for programs which depend on that behavior.
4880 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4882 @item -fexpensive-optimizations
4883 @opindex fexpensive-optimizations
4884 Perform a number of minor optimizations that are relatively expensive.
4886 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4888 @item -foptimize-register-move
4889 @itemx -fregmove
4890 @opindex foptimize-register-move
4891 @opindex fregmove
4892 Attempt to reassign register numbers in move instructions and as
4893 operands of other simple instructions in order to maximize the amount of
4894 register tying.  This is especially helpful on machines with two-operand
4895 instructions.
4897 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4898 optimization.
4900 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4902 @item -fdelayed-branch
4903 @opindex fdelayed-branch
4904 If supported for the target machine, attempt to reorder instructions
4905 to exploit instruction slots available after delayed branch
4906 instructions.
4908 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4910 @item -fschedule-insns
4911 @opindex fschedule-insns
4912 If supported for the target machine, attempt to reorder instructions to
4913 eliminate execution stalls due to required data being unavailable.  This
4914 helps machines that have slow floating point or memory load instructions
4915 by allowing other instructions to be issued until the result of the load
4916 or floating point instruction is required.
4918 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4920 @item -fschedule-insns2
4921 @opindex fschedule-insns2
4922 Similar to @option{-fschedule-insns}, but requests an additional pass of
4923 instruction scheduling after register allocation has been done.  This is
4924 especially useful on machines with a relatively small number of
4925 registers and where memory load instructions take more than one cycle.
4927 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4929 @item -fno-sched-interblock
4930 @opindex fno-sched-interblock
4931 Don't schedule instructions across basic blocks.  This is normally
4932 enabled by default when scheduling before register allocation, i.e.@:
4933 with @option{-fschedule-insns} or at @option{-O2} or higher.
4935 @item -fno-sched-spec
4936 @opindex fno-sched-spec
4937 Don't allow speculative motion of non-load instructions.  This is normally
4938 enabled by default when scheduling before register allocation, i.e.@:
4939 with @option{-fschedule-insns} or at @option{-O2} or higher.
4941 @item -fsched-spec-load
4942 @opindex fsched-spec-load
4943 Allow speculative motion of some load instructions.  This only makes
4944 sense when scheduling before register allocation, i.e.@: with
4945 @option{-fschedule-insns} or at @option{-O2} or higher.
4947 @item -fsched-spec-load-dangerous
4948 @opindex fsched-spec-load-dangerous
4949 Allow speculative motion of more load instructions.  This only makes
4950 sense when scheduling before register allocation, i.e.@: with
4951 @option{-fschedule-insns} or at @option{-O2} or higher.
4953 @item -fsched-stalled-insns=@var{n}
4954 @opindex fsched-stalled-insns
4955 Define how many insns (if any) can be moved prematurely from the queue
4956 of stalled insns into the ready list, during the second scheduling pass.
4958 @item -fsched-stalled-insns-dep=@var{n}
4959 @opindex fsched-stalled-insns-dep
4960 Define how many insn groups (cycles) will be examined for a dependency
4961 on a stalled insn that is candidate for premature removal from the queue
4962 of stalled insns.  Has an effect only during the second scheduling pass,
4963 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4965 @item -fsched2-use-superblocks
4966 @opindex fsched2-use-superblocks
4967 When scheduling after register allocation, do use superblock scheduling
4968 algorithm.  Superblock scheduling allows motion across basic block boundaries
4969 resulting on faster schedules.  This option is experimental, as not all machine
4970 descriptions used by GCC model the CPU closely enough to avoid unreliable
4971 results from the algorithm.
4973 This only makes sense when scheduling after register allocation, i.e.@: with
4974 @option{-fschedule-insns2} or at @option{-O2} or higher.
4976 @item -fsched2-use-traces
4977 @opindex fsched2-use-traces
4978 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4979 allocation and additionally perform code duplication in order to increase the
4980 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4981 trace formation.
4983 This mode should produce faster but significantly longer programs.  Also
4984 without @option{-fbranch-probabilities} the traces constructed may not
4985 match the reality and hurt the performance.  This only makes
4986 sense when scheduling after register allocation, i.e.@: with
4987 @option{-fschedule-insns2} or at @option{-O2} or higher.
4989 @item -freschedule-modulo-scheduled-loops
4990 @opindex fscheduling-in-modulo-scheduled-loops
4991 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4992 we may want to prevent the later scheduling passes from changing its schedule, we use this
4993 option to control that.
4995 @item -fcaller-saves
4996 @opindex fcaller-saves
4997 Enable values to be allocated in registers that will be clobbered by
4998 function calls, by emitting extra instructions to save and restore the
4999 registers around such calls.  Such allocation is done only when it
5000 seems to result in better code than would otherwise be produced.
5002 This option is always enabled by default on certain machines, usually
5003 those which have no call-preserved registers to use instead.
5005 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5007 @item -ftree-pre
5008 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
5009 enabled by default at @option{-O2} and @option{-O3}.
5011 @item -ftree-fre
5012 Perform Full Redundancy Elimination (FRE) on trees.  The difference
5013 between FRE and PRE is that FRE only considers expressions
5014 that are computed on all paths leading to the redundant computation.
5015 This analysis faster than PRE, though it exposes fewer redundancies.
5016 This flag is enabled by default at @option{-O} and higher.
5018 @item -ftree-copy-prop
5019 Perform copy propagation on trees.  This pass eliminates unnecessary
5020 copy operations.  This flag is enabled by default at @option{-O} and
5021 higher.
5023 @item -ftree-store-copy-prop
5024 Perform copy propagation of memory loads and stores.  This pass
5025 eliminates unnecessary copy operations in memory references
5026 (structures, global variables, arrays, etc).  This flag is enabled by
5027 default at @option{-O2} and higher.
5029 @item -ftree-salias
5030 Perform structural alias analysis on trees.  This flag
5031 is enabled by default at @option{-O} and higher.
5033 @item -ftree-sink
5034 Perform forward store motion  on trees.  This flag is
5035 enabled by default at @option{-O} and higher.
5037 @item -ftree-ccp
5038 Perform sparse conditional constant propagation (CCP) on trees.  This
5039 pass only operates on local scalar variables and is enabled by default
5040 at @option{-O} and higher.
5042 @item -ftree-store-ccp
5043 Perform sparse conditional constant propagation (CCP) on trees.  This
5044 pass operates on both local scalar variables and memory stores and
5045 loads (global variables, structures, arrays, etc).  This flag is
5046 enabled by default at @option{-O2} and higher.
5048 @item -ftree-dce
5049 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5050 default at @option{-O} and higher.
5052 @item -ftree-dominator-opts
5053 Perform a variety of simple scalar cleanups (constant/copy
5054 propagation, redundancy elimination, range propagation and expression
5055 simplification) based on a dominator tree traversal.  This also
5056 performs jump threading (to reduce jumps to jumps). This flag is
5057 enabled by default at @option{-O} and higher.
5059 @item -ftree-ch
5060 Perform loop header copying on trees.  This is beneficial since it increases
5061 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5062 is enabled by default at @option{-O} and higher.  It is not enabled
5063 for @option{-Os}, since it usually increases code size.
5065 @item -ftree-loop-optimize
5066 Perform loop optimizations on trees.  This flag is enabled by default
5067 at @option{-O} and higher.
5069 @item -ftree-loop-linear
5070 Perform linear loop transformations on tree.  This flag can improve cache
5071 performance and allow further loop optimizations to take place.
5073 @item -ftree-loop-im
5074 Perform loop invariant motion on trees.  This pass moves only invariants that
5075 would be hard to handle at RTL level (function calls, operations that expand to
5076 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5077 operands of conditions that are invariant out of the loop, so that we can use
5078 just trivial invariantness analysis in loop unswitching.  The pass also includes
5079 store motion.
5081 @item -ftree-loop-ivcanon
5082 Create a canonical counter for number of iterations in the loop for that
5083 determining number of iterations requires complicated analysis.  Later
5084 optimizations then may determine the number easily.  Useful especially
5085 in connection with unrolling.
5087 @item -fivopts
5088 Perform induction variable optimizations (strength reduction, induction
5089 variable merging and induction variable elimination) on trees.
5091 @item -ftree-sra
5092 Perform scalar replacement of aggregates.  This pass replaces structure
5093 references with scalars to prevent committing structures to memory too
5094 early.  This flag is enabled by default at @option{-O} and higher.
5096 @item -ftree-copyrename
5097 Perform copy renaming on trees.  This pass attempts to rename compiler
5098 temporaries to other variables at copy locations, usually resulting in
5099 variable names which more closely resemble the original variables.  This flag
5100 is enabled by default at @option{-O} and higher.
5102 @item -ftree-ter
5103 Perform temporary expression replacement during the SSA->normal phase.  Single
5104 use/single def temporaries are replaced at their use location with their
5105 defining expression.  This results in non-GIMPLE code, but gives the expanders
5106 much more complex trees to work on resulting in better RTL generation.  This is
5107 enabled by default at @option{-O} and higher.
5109 @item -ftree-lrs
5110 Perform live range splitting during the SSA->normal phase.  Distinct live
5111 ranges of a variable are split into unique variables, allowing for better
5112 optimization later.  This is enabled by default at @option{-O} and higher.
5114 @item -ftree-vectorize
5115 Perform loop vectorization on trees.
5117 @item -ftree-vect-loop-version
5118 @opindex ftree-vect-loop-version
5119 Perform loop versioning when doing loop vectorization on trees.  When a loop
5120 appears to be vectorizable except that data alignment or data dependence cannot
5121 be determined at compile time then vectorized and non-vectorized versions of
5122 the loop are generated along with runtime checks for alignment or dependence
5123 to control which version is executed.  This option is enabled by default
5124 except at level @option{-Os} where it is disabled.
5126 @item -ftree-vrp
5127 Perform Value Range Propagation on trees.  This is similar to the
5128 constant propagation pass, but instead of values, ranges of values are
5129 propagated.  This allows the optimizers to remove unnecessary range
5130 checks like array bound checks and null pointer checks.  This is
5131 enabled by default at @option{-O2} and higher.  Null pointer check
5132 elimination is only done if @option{-fdelete-null-pointer-checks} is
5133 enabled.
5135 @item -ftracer
5136 @opindex ftracer
5137 Perform tail duplication to enlarge superblock size.  This transformation
5138 simplifies the control flow of the function allowing other optimizations to do
5139 better job.
5141 @item -funroll-loops
5142 @opindex funroll-loops
5143 Unroll loops whose number of iterations can be determined at compile
5144 time or upon entry to the loop.  @option{-funroll-loops} implies both
5145 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5146 option makes code larger, and may or may not make it run faster.
5148 @item -funroll-all-loops
5149 @opindex funroll-all-loops
5150 Unroll all loops, even if their number of iterations is uncertain when
5151 the loop is entered.  This usually makes programs run more slowly.
5152 @option{-funroll-all-loops} implies the same options as
5153 @option{-funroll-loops},
5155 @item -fsplit-ivs-in-unroller
5156 @opindex -fsplit-ivs-in-unroller
5157 Enables expressing of values of induction variables in later iterations
5158 of the unrolled loop using the value in the first iteration.  This breaks
5159 long dependency chains, thus improving efficiency of the scheduling passes.
5161 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5162 same effect.  However in cases the loop body is more complicated than
5163 a single basic block, this is not reliable.  It also does not work at all
5164 on some of the architectures due to restrictions in the CSE pass.
5166 This optimization is enabled by default.
5168 @item -fvariable-expansion-in-unroller
5169 @opindex -fvariable-expansion-in-unroller
5170 With this option, the compiler will create multiple copies of some
5171 local variables when unrolling a loop which can result in superior code.
5173 @item -fprefetch-loop-arrays
5174 @opindex fprefetch-loop-arrays
5175 If supported by the target machine, generate instructions to prefetch
5176 memory to improve the performance of loops that access large arrays.
5178 These options may generate better or worse code; results are highly
5179 dependent on the structure of loops within the source code.
5181 @item -fno-peephole
5182 @itemx -fno-peephole2
5183 @opindex fno-peephole
5184 @opindex fno-peephole2
5185 Disable any machine-specific peephole optimizations.  The difference
5186 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5187 are implemented in the compiler; some targets use one, some use the
5188 other, a few use both.
5190 @option{-fpeephole} is enabled by default.
5191 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5193 @item -fno-guess-branch-probability
5194 @opindex fno-guess-branch-probability
5195 Do not guess branch probabilities using heuristics.
5197 GCC will use heuristics to guess branch probabilities if they are
5198 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5199 heuristics are based on the control flow graph.  If some branch probabilities
5200 are specified by @samp{__builtin_expect}, then the heuristics will be
5201 used to guess branch probabilities for the rest of the control flow graph,
5202 taking the @samp{__builtin_expect} info into account.  The interactions
5203 between the heuristics and @samp{__builtin_expect} can be complex, and in
5204 some cases, it may be useful to disable the heuristics so that the effects
5205 of @samp{__builtin_expect} are easier to understand.
5207 The default is @option{-fguess-branch-probability} at levels
5208 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5210 @item -freorder-blocks
5211 @opindex freorder-blocks
5212 Reorder basic blocks in the compiled function in order to reduce number of
5213 taken branches and improve code locality.
5215 Enabled at levels @option{-O2}, @option{-O3}.
5217 @item -freorder-blocks-and-partition
5218 @opindex freorder-blocks-and-partition
5219 In addition to reordering basic blocks in the compiled function, in order
5220 to reduce number of taken branches, partitions hot and cold basic blocks
5221 into separate sections of the assembly and .o files, to improve
5222 paging and cache locality performance.
5224 This optimization is automatically turned off in the presence of
5225 exception handling, for linkonce sections, for functions with a user-defined
5226 section attribute and on any architecture that does not support named
5227 sections.
5229 @item -freorder-functions
5230 @opindex freorder-functions
5231 Reorder functions in the object file in order to
5232 improve code locality.  This is implemented by using special
5233 subsections @code{.text.hot} for most frequently executed functions and
5234 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5235 the linker so object file format must support named sections and linker must
5236 place them in a reasonable way.
5238 Also profile feedback must be available in to make this option effective.  See
5239 @option{-fprofile-arcs} for details.
5241 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5243 @item -fstrict-aliasing
5244 @opindex fstrict-aliasing
5245 Allows the compiler to assume the strictest aliasing rules applicable to
5246 the language being compiled.  For C (and C++), this activates
5247 optimizations based on the type of expressions.  In particular, an
5248 object of one type is assumed never to reside at the same address as an
5249 object of a different type, unless the types are almost the same.  For
5250 example, an @code{unsigned int} can alias an @code{int}, but not a
5251 @code{void*} or a @code{double}.  A character type may alias any other
5252 type.
5254 Pay special attention to code like this:
5255 @smallexample
5256 union a_union @{
5257   int i;
5258   double d;
5261 int f() @{
5262   a_union t;
5263   t.d = 3.0;
5264   return t.i;
5266 @end smallexample
5267 The practice of reading from a different union member than the one most
5268 recently written to (called ``type-punning'') is common.  Even with
5269 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5270 is accessed through the union type.  So, the code above will work as
5271 expected.  However, this code might not:
5272 @smallexample
5273 int f() @{
5274   a_union t;
5275   int* ip;
5276   t.d = 3.0;
5277   ip = &t.i;
5278   return *ip;
5280 @end smallexample
5282 Every language that wishes to perform language-specific alias analysis
5283 should define a function that computes, given an @code{tree}
5284 node, an alias set for the node.  Nodes in different alias sets are not
5285 allowed to alias.  For an example, see the C front-end function
5286 @code{c_get_alias_set}.
5288 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5290 @item -falign-functions
5291 @itemx -falign-functions=@var{n}
5292 @opindex falign-functions
5293 Align the start of functions to the next power-of-two greater than
5294 @var{n}, skipping up to @var{n} bytes.  For instance,
5295 @option{-falign-functions=32} aligns functions to the next 32-byte
5296 boundary, but @option{-falign-functions=24} would align to the next
5297 32-byte boundary only if this can be done by skipping 23 bytes or less.
5299 @option{-fno-align-functions} and @option{-falign-functions=1} are
5300 equivalent and mean that functions will not be aligned.
5302 Some assemblers only support this flag when @var{n} is a power of two;
5303 in that case, it is rounded up.
5305 If @var{n} is not specified or is zero, use a machine-dependent default.
5307 Enabled at levels @option{-O2}, @option{-O3}.
5309 @item -falign-labels
5310 @itemx -falign-labels=@var{n}
5311 @opindex falign-labels
5312 Align all branch targets to a power-of-two boundary, skipping up to
5313 @var{n} bytes like @option{-falign-functions}.  This option can easily
5314 make code slower, because it must insert dummy operations for when the
5315 branch target is reached in the usual flow of the code.
5317 @option{-fno-align-labels} and @option{-falign-labels=1} are
5318 equivalent and mean that labels will not be aligned.
5320 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5321 are greater than this value, then their values are used instead.
5323 If @var{n} is not specified or is zero, use a machine-dependent default
5324 which is very likely to be @samp{1}, meaning no alignment.
5326 Enabled at levels @option{-O2}, @option{-O3}.
5328 @item -falign-loops
5329 @itemx -falign-loops=@var{n}
5330 @opindex falign-loops
5331 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5332 like @option{-falign-functions}.  The hope is that the loop will be
5333 executed many times, which will make up for any execution of the dummy
5334 operations.
5336 @option{-fno-align-loops} and @option{-falign-loops=1} are
5337 equivalent and mean that loops will not be aligned.
5339 If @var{n} is not specified or is zero, use a machine-dependent default.
5341 Enabled at levels @option{-O2}, @option{-O3}.
5343 @item -falign-jumps
5344 @itemx -falign-jumps=@var{n}
5345 @opindex falign-jumps
5346 Align branch targets to a power-of-two boundary, for branch targets
5347 where the targets can only be reached by jumping, skipping up to @var{n}
5348 bytes like @option{-falign-functions}.  In this case, no dummy operations
5349 need be executed.
5351 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5352 equivalent and mean that loops will not be aligned.
5354 If @var{n} is not specified or is zero, use a machine-dependent default.
5356 Enabled at levels @option{-O2}, @option{-O3}.
5358 @item -funit-at-a-time
5359 @opindex funit-at-a-time
5360 Parse the whole compilation unit before starting to produce code.
5361 This allows some extra optimizations to take place but consumes
5362 more memory (in general).  There are some compatibility issues
5363 with @emph{unit-at-a-time} mode:
5364 @itemize @bullet
5365 @item
5366 enabling @emph{unit-at-a-time} mode may change the order
5367 in which functions, variables, and top-level @code{asm} statements
5368 are emitted, and will likely break code relying on some particular
5369 ordering.  The majority of such top-level @code{asm} statements,
5370 though, can be replaced by @code{section} attributes.  The
5371 @option{fno-toplevel-reorder} option may be used to keep the ordering
5372 used in the input file, at the cost of some optimizations.
5374 @item
5375 @emph{unit-at-a-time} mode removes unreferenced static variables
5376 and functions.  This may result in undefined references
5377 when an @code{asm} statement refers directly to variables or functions
5378 that are otherwise unused.  In that case either the variable/function
5379 shall be listed as an operand of the @code{asm} statement operand or,
5380 in the case of top-level @code{asm} statements the attribute @code{used}
5381 shall be used on the declaration.
5383 @item
5384 Static functions now can use non-standard passing conventions that
5385 may break @code{asm} statements calling functions directly.  Again,
5386 attribute @code{used} will prevent this behavior.
5387 @end itemize
5389 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5390 but this scheme may not be supported by future releases of GCC@.
5392 Enabled at levels @option{-O2}, @option{-O3}.
5394 @item -fno-toplevel-reorder
5395 Do not reorder top-level functions, variables, and @code{asm}
5396 statements.  Output them in the same order that they appear in the
5397 input file.  When this option is used, unreferenced static variables
5398 will not be removed.  This option is intended to support existing code
5399 which relies on a particular ordering.  For new code, it is better to
5400 use attributes.
5402 @item -fweb
5403 @opindex fweb
5404 Constructs webs as commonly used for register allocation purposes and assign
5405 each web individual pseudo register.  This allows the register allocation pass
5406 to operate on pseudos directly, but also strengthens several other optimization
5407 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5408 however, make debugging impossible, since variables will no longer stay in a
5409 ``home register''.
5411 Enabled by default with @option{-funroll-loops}.
5413 @item -fwhole-program
5414 @opindex fwhole-program
5415 Assume that the current compilation unit represents whole program being
5416 compiled.  All public functions and variables with the exception of @code{main}
5417 and those merged by attribute @code{externally_visible} become static functions
5418 and in a affect gets more aggressively optimized by interprocedural optimizers.
5419 While this option is equivalent to proper use of @code{static} keyword for
5420 programs consisting of single file, in combination with option
5421 @option{--combine} this flag can be used to compile most of smaller scale C
5422 programs since the functions and variables become local for the whole combined
5423 compilation unit, not for the single source file itself.
5426 @item -fno-cprop-registers
5427 @opindex fno-cprop-registers
5428 After register allocation and post-register allocation instruction splitting,
5429 we perform a copy-propagation pass to try to reduce scheduling dependencies
5430 and occasionally eliminate the copy.
5432 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5434 @item -fprofile-generate
5435 @opindex fprofile-generate
5437 Enable options usually used for instrumenting application to produce
5438 profile useful for later recompilation with profile feedback based
5439 optimization.  You must use @option{-fprofile-generate} both when
5440 compiling and when linking your program.
5442 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5444 @item -fprofile-use
5445 @opindex fprofile-use
5446 Enable profile feedback directed optimizations, and optimizations
5447 generally profitable only with profile feedback available.
5449 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5450 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5451 @code{-fno-loop-optimize}.
5453 @end table
5455 The following options control compiler behavior regarding floating
5456 point arithmetic.  These options trade off between speed and
5457 correctness.  All must be specifically enabled.
5459 @table @gcctabopt
5460 @item -ffloat-store
5461 @opindex ffloat-store
5462 Do not store floating point variables in registers, and inhibit other
5463 options that might change whether a floating point value is taken from a
5464 register or memory.
5466 @cindex floating point precision
5467 This option prevents undesirable excess precision on machines such as
5468 the 68000 where the floating registers (of the 68881) keep more
5469 precision than a @code{double} is supposed to have.  Similarly for the
5470 x86 architecture.  For most programs, the excess precision does only
5471 good, but a few programs rely on the precise definition of IEEE floating
5472 point.  Use @option{-ffloat-store} for such programs, after modifying
5473 them to store all pertinent intermediate computations into variables.
5475 @item -ffast-math
5476 @opindex ffast-math
5477 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5478 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5479 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5480 and @option{fcx-limited-range}.
5482 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5484 This option should never be turned on by any @option{-O} option since
5485 it can result in incorrect output for programs which depend on
5486 an exact implementation of IEEE or ISO rules/specifications for
5487 math functions.
5489 @item -fno-math-errno
5490 @opindex fno-math-errno
5491 Do not set ERRNO after calling math functions that are executed
5492 with a single instruction, e.g., sqrt.  A program that relies on
5493 IEEE exceptions for math error handling may want to use this flag
5494 for speed while maintaining IEEE arithmetic compatibility.
5496 This option should never be turned on by any @option{-O} option since
5497 it can result in incorrect output for programs which depend on
5498 an exact implementation of IEEE or ISO rules/specifications for
5499 math functions.
5501 The default is @option{-fmath-errno}.
5503 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5504 no reason for the compiler to consider the possibility that it might,
5505 and @option{-fno-math-errno} is the default.
5507 @item -funsafe-math-optimizations
5508 @opindex funsafe-math-optimizations
5509 Allow optimizations for floating-point arithmetic that (a) assume
5510 that arguments and results are valid and (b) may violate IEEE or
5511 ANSI standards.  When used at link-time, it may include libraries
5512 or startup files that change the default FPU control word or other
5513 similar optimizations.
5515 This option should never be turned on by any @option{-O} option since
5516 it can result in incorrect output for programs which depend on
5517 an exact implementation of IEEE or ISO rules/specifications for
5518 math functions.
5520 The default is @option{-fno-unsafe-math-optimizations}.
5522 @item -ffinite-math-only
5523 @opindex ffinite-math-only
5524 Allow optimizations for floating-point arithmetic that assume
5525 that arguments and results are not NaNs or +-Infs.
5527 This option should never be turned on by any @option{-O} option since
5528 it can result in incorrect output for programs which depend on
5529 an exact implementation of IEEE or ISO rules/specifications.
5531 The default is @option{-fno-finite-math-only}.
5533 @item -fno-trapping-math
5534 @opindex fno-trapping-math
5535 Compile code assuming that floating-point operations cannot generate
5536 user-visible traps.  These traps include division by zero, overflow,
5537 underflow, inexact result and invalid operation.  This option implies
5538 @option{-fno-signaling-nans}.  Setting this option may allow faster
5539 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5541 This option should never be turned on by any @option{-O} option since
5542 it can result in incorrect output for programs which depend on
5543 an exact implementation of IEEE or ISO rules/specifications for
5544 math functions.
5546 The default is @option{-ftrapping-math}.
5548 @item -frounding-math
5549 @opindex frounding-math
5550 Disable transformations and optimizations that assume default floating
5551 point rounding behavior.  This is round-to-zero for all floating point
5552 to integer conversions, and round-to-nearest for all other arithmetic
5553 truncations.  This option should be specified for programs that change
5554 the FP rounding mode dynamically, or that may be executed with a
5555 non-default rounding mode.  This option disables constant folding of
5556 floating point expressions at compile-time (which may be affected by
5557 rounding mode) and arithmetic transformations that are unsafe in the
5558 presence of sign-dependent rounding modes.
5560 The default is @option{-fno-rounding-math}.
5562 This option is experimental and does not currently guarantee to
5563 disable all GCC optimizations that are affected by rounding mode.
5564 Future versions of GCC may provide finer control of this setting
5565 using C99's @code{FENV_ACCESS} pragma.  This command line option
5566 will be used to specify the default state for @code{FENV_ACCESS}.
5568 @item -frtl-abstract-sequences
5569 @opindex frtl-abstract-sequences
5570 It is a size optimization method. This option is to find identical
5571 sequences of code, which can be turned into pseudo-procedures  and
5572 then  replace  all  occurrences with  calls to  the  newly created
5573 subroutine. It is kind of an opposite of @option{-finline-functions}.
5574 This optimization runs at RTL level.
5576 @item -fsignaling-nans
5577 @opindex fsignaling-nans
5578 Compile code assuming that IEEE signaling NaNs may generate user-visible
5579 traps during floating-point operations.  Setting this option disables
5580 optimizations that may change the number of exceptions visible with
5581 signaling NaNs.  This option implies @option{-ftrapping-math}.
5583 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5584 be defined.
5586 The default is @option{-fno-signaling-nans}.
5588 This option is experimental and does not currently guarantee to
5589 disable all GCC optimizations that affect signaling NaN behavior.
5591 @item -fsingle-precision-constant
5592 @opindex fsingle-precision-constant
5593 Treat floating point constant as single precision constant instead of
5594 implicitly converting it to double precision constant.
5596 @item -fcx-limited-range
5597 @itemx -fno-cx-limited-range
5598 @opindex fcx-limited-range
5599 @opindex fno-cx-limited-range
5600 When enabled, this option states that a range reduction step is not
5601 needed when performing complex division.  The default is
5602 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5604 This option controls the default setting of the ISO C99 
5605 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5606 all languages.
5608 @end table
5610 The following options control optimizations that may improve
5611 performance, but are not enabled by any @option{-O} options.  This
5612 section includes experimental options that may produce broken code.
5614 @table @gcctabopt
5615 @item -fbranch-probabilities
5616 @opindex fbranch-probabilities
5617 After running a program compiled with @option{-fprofile-arcs}
5618 (@pxref{Debugging Options,, Options for Debugging Your Program or
5619 @command{gcc}}), you can compile it a second time using
5620 @option{-fbranch-probabilities}, to improve optimizations based on
5621 the number of times each branch was taken.  When the program
5622 compiled with @option{-fprofile-arcs} exits it saves arc execution
5623 counts to a file called @file{@var{sourcename}.gcda} for each source
5624 file  The information in this data file is very dependent on the
5625 structure of the generated code, so you must use the same source code
5626 and the same optimization options for both compilations.
5628 With @option{-fbranch-probabilities}, GCC puts a
5629 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5630 These can be used to improve optimization.  Currently, they are only
5631 used in one place: in @file{reorg.c}, instead of guessing which path a
5632 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5633 exactly determine which path is taken more often.
5635 @item -fprofile-values
5636 @opindex fprofile-values
5637 If combined with @option{-fprofile-arcs}, it adds code so that some
5638 data about values of expressions in the program is gathered.
5640 With @option{-fbranch-probabilities}, it reads back the data gathered
5641 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5642 notes to instructions for their later usage in optimizations.
5644 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5646 @item -fvpt
5647 @opindex fvpt
5648 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5649 a code to gather information about values of expressions.
5651 With @option{-fbranch-probabilities}, it reads back the data gathered
5652 and actually performs the optimizations based on them.
5653 Currently the optimizations include specialization of division operation
5654 using the knowledge about the value of the denominator.
5656 @item -frename-registers
5657 @opindex frename-registers
5658 Attempt to avoid false dependencies in scheduled code by making use
5659 of registers left over after register allocation.  This optimization
5660 will most benefit processors with lots of registers.  Depending on the
5661 debug information format adopted by the target, however, it can
5662 make debugging impossible, since variables will no longer stay in
5663 a ``home register''.
5665 Enabled by default with @option{-funroll-loops}.
5667 @item -ftracer
5668 @opindex ftracer
5669 Perform tail duplication to enlarge superblock size.  This transformation
5670 simplifies the control flow of the function allowing other optimizations to do
5671 better job.
5673 Enabled with @option{-fprofile-use}.
5675 @item -funroll-loops
5676 @opindex funroll-loops
5677 Unroll loops whose number of iterations can be determined at compile time or
5678 upon entry to the loop.  @option{-funroll-loops} implies
5679 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5680 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5681 small constant number of iterations).  This option makes code larger, and may
5682 or may not make it run faster.
5684 Enabled with @option{-fprofile-use}.
5686 @item -funroll-all-loops
5687 @opindex funroll-all-loops
5688 Unroll all loops, even if their number of iterations is uncertain when
5689 the loop is entered.  This usually makes programs run more slowly.
5690 @option{-funroll-all-loops} implies the same options as
5691 @option{-funroll-loops}.
5693 @item -fpeel-loops
5694 @opindex fpeel-loops
5695 Peels the loops for that there is enough information that they do not
5696 roll much (from profile feedback).  It also turns on complete loop peeling
5697 (i.e.@: complete removal of loops with small constant number of iterations).
5699 Enabled with @option{-fprofile-use}.
5701 @item -fmove-loop-invariants
5702 @opindex fmove-loop-invariants
5703 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5704 at level @option{-O1}
5706 @item -funswitch-loops
5707 @opindex funswitch-loops
5708 Move branches with loop invariant conditions out of the loop, with duplicates
5709 of the loop on both branches (modified according to result of the condition).
5711 @item -fprefetch-loop-arrays
5712 @opindex fprefetch-loop-arrays
5713 If supported by the target machine, generate instructions to prefetch
5714 memory to improve the performance of loops that access large arrays.
5716 Disabled at level @option{-Os}.
5718 @item -ffunction-sections
5719 @itemx -fdata-sections
5720 @opindex ffunction-sections
5721 @opindex fdata-sections
5722 Place each function or data item into its own section in the output
5723 file if the target supports arbitrary sections.  The name of the
5724 function or the name of the data item determines the section's name
5725 in the output file.
5727 Use these options on systems where the linker can perform optimizations
5728 to improve locality of reference in the instruction space.  Most systems
5729 using the ELF object format and SPARC processors running Solaris 2 have
5730 linkers with such optimizations.  AIX may have these optimizations in
5731 the future.
5733 Only use these options when there are significant benefits from doing
5734 so.  When you specify these options, the assembler and linker will
5735 create larger object and executable files and will also be slower.
5736 You will not be able to use @code{gprof} on all systems if you
5737 specify this option and you may have problems with debugging if
5738 you specify both this option and @option{-g}.
5740 @item -fbranch-target-load-optimize
5741 @opindex fbranch-target-load-optimize
5742 Perform branch target register load optimization before prologue / epilogue
5743 threading.
5744 The use of target registers can typically be exposed only during reload,
5745 thus hoisting loads out of loops and doing inter-block scheduling needs
5746 a separate optimization pass.
5748 @item -fbranch-target-load-optimize2
5749 @opindex fbranch-target-load-optimize2
5750 Perform branch target register load optimization after prologue / epilogue
5751 threading.
5753 @item -fbtr-bb-exclusive
5754 @opindex fbtr-bb-exclusive
5755 When performing branch target register load optimization, don't reuse
5756 branch target registers in within any basic block.
5758 @item -fstack-protector
5759 Emit extra code to check for buffer overflows, such as stack smashing
5760 attacks.  This is done by adding a guard variable to functions with
5761 vulnerable objects.  This includes functions that call alloca, and
5762 functions with buffers larger than 8 bytes.  The guards are initialized
5763 when a function is entered and then checked when the function exits.
5764 If a guard check fails, an error message is printed and the program exits.
5766 @item -fstack-protector-all
5767 Like @option{-fstack-protector} except that all functions are protected.
5769 @item --param @var{name}=@var{value}
5770 @opindex param
5771 In some places, GCC uses various constants to control the amount of
5772 optimization that is done.  For example, GCC will not inline functions
5773 that contain more that a certain number of instructions.  You can
5774 control some of these constants on the command-line using the
5775 @option{--param} option.
5777 The names of specific parameters, and the meaning of the values, are
5778 tied to the internals of the compiler, and are subject to change
5779 without notice in future releases.
5781 In each case, the @var{value} is an integer.  The allowable choices for
5782 @var{name} are given in the following table:
5784 @table @gcctabopt
5785 @item salias-max-implicit-fields
5786 The maximum number of fields in a variable without direct
5787 structure accesses for which structure aliasing will consider trying 
5788 to track each field.  The default is 5
5790 @item salias-max-array-elements
5791 The maximum number of elements an array can have and its elements
5792 still be tracked individually by structure aliasing. The default is 4
5794 @item sra-max-structure-size
5795 The maximum structure size, in bytes, at which the scalar replacement
5796 of aggregates (SRA) optimization will perform block copies.  The
5797 default value, 0, implies that GCC will select the most appropriate
5798 size itself.
5800 @item sra-field-structure-ratio
5801 The threshold ratio (as a percentage) between instantiated fields and
5802 the complete structure size.  We say that if the ratio of the number
5803 of bytes in instantiated fields to the number of bytes in the complete
5804 structure exceeds this parameter, then block copies are not used.  The
5805 default is 75.
5807 @item max-crossjump-edges
5808 The maximum number of incoming edges to consider for crossjumping.
5809 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5810 the number of edges incoming to each block.  Increasing values mean
5811 more aggressive optimization, making the compile time increase with
5812 probably small improvement in executable size.
5814 @item min-crossjump-insns
5815 The minimum number of instructions which must be matched at the end
5816 of two blocks before crossjumping will be performed on them.  This
5817 value is ignored in the case where all instructions in the block being
5818 crossjumped from are matched.  The default value is 5.
5820 @item max-grow-copy-bb-insns
5821 The maximum code size expansion factor when copying basic blocks
5822 instead of jumping.  The expansion is relative to a jump instruction.
5823 The default value is 8.
5825 @item max-goto-duplication-insns
5826 The maximum number of instructions to duplicate to a block that jumps
5827 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5828 passes, GCC factors computed gotos early in the compilation process,
5829 and unfactors them as late as possible.  Only computed jumps at the
5830 end of a basic blocks with no more than max-goto-duplication-insns are
5831 unfactored.  The default value is 8.
5833 @item max-delay-slot-insn-search
5834 The maximum number of instructions to consider when looking for an
5835 instruction to fill a delay slot.  If more than this arbitrary number of
5836 instructions is searched, the time savings from filling the delay slot
5837 will be minimal so stop searching.  Increasing values mean more
5838 aggressive optimization, making the compile time increase with probably
5839 small improvement in executable run time.
5841 @item max-delay-slot-live-search
5842 When trying to fill delay slots, the maximum number of instructions to
5843 consider when searching for a block with valid live register
5844 information.  Increasing this arbitrarily chosen value means more
5845 aggressive optimization, increasing the compile time.  This parameter
5846 should be removed when the delay slot code is rewritten to maintain the
5847 control-flow graph.
5849 @item max-gcse-memory
5850 The approximate maximum amount of memory that will be allocated in
5851 order to perform the global common subexpression elimination
5852 optimization.  If more memory than specified is required, the
5853 optimization will not be done.
5855 @item max-gcse-passes
5856 The maximum number of passes of GCSE to run.  The default is 1.
5858 @item max-pending-list-length
5859 The maximum number of pending dependencies scheduling will allow
5860 before flushing the current state and starting over.  Large functions
5861 with few branches or calls can create excessively large lists which
5862 needlessly consume memory and resources.
5864 @item max-inline-insns-single
5865 Several parameters control the tree inliner used in gcc.
5866 This number sets the maximum number of instructions (counted in GCC's
5867 internal representation) in a single function that the tree inliner
5868 will consider for inlining.  This only affects functions declared
5869 inline and methods implemented in a class declaration (C++).
5870 The default value is 450.
5872 @item max-inline-insns-auto
5873 When you use @option{-finline-functions} (included in @option{-O3}),
5874 a lot of functions that would otherwise not be considered for inlining
5875 by the compiler will be investigated.  To those functions, a different
5876 (more restrictive) limit compared to functions declared inline can
5877 be applied.
5878 The default value is 90.
5880 @item large-function-insns
5881 The limit specifying really large functions.  For functions larger than this
5882 limit after inlining inlining is constrained by
5883 @option{--param large-function-growth}.  This parameter is useful primarily
5884 to avoid extreme compilation time caused by non-linear algorithms used by the
5885 backend.
5886 This parameter is ignored when @option{-funit-at-a-time} is not used.
5887 The default value is 2700.
5889 @item large-function-growth
5890 Specifies maximal growth of large function caused by inlining in percents.
5891 This parameter is ignored when @option{-funit-at-a-time} is not used.
5892 The default value is 100 which limits large function growth to 2.0 times
5893 the original size.
5895 @item large-unit-insns
5896 The limit specifying large translation unit.  Growth caused by inlining of
5897 units larger than this limit is limited by @option{--param inline-unit-growth}.
5898 For small units this might be too tight (consider unit consisting of function A
5899 that is inline and B that just calls A three time.  If B is small relative to
5900 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
5901 large units consisting of small inlininable functions however the overall unit
5902 growth limit is needed to avoid exponential explosion of code size.  Thus for
5903 smaller units, the size is increased to @option{--param large-unit-insns}
5904 before applying @option{--param inline-unit-growth}.  The default is 10000
5906 @item inline-unit-growth
5907 Specifies maximal overall growth of the compilation unit caused by inlining.
5908 This parameter is ignored when @option{-funit-at-a-time} is not used.
5909 The default value is 50 which limits unit growth to 1.5 times the original
5910 size.
5912 @item max-inline-insns-recursive
5913 @itemx max-inline-insns-recursive-auto
5914 Specifies maximum number of instructions out-of-line copy of self recursive inline
5915 function can grow into by performing recursive inlining.
5917 For functions declared inline @option{--param max-inline-insns-recursive} is
5918 taken into acount.  For function not declared inline, recursive inlining
5919 happens only when @option{-finline-functions} (included in @option{-O3}) is
5920 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5921 default value is 450.
5923 @item max-inline-recursive-depth
5924 @itemx max-inline-recursive-depth-auto
5925 Specifies maximum recursion depth used by the recursive inlining.
5927 For functions declared inline @option{--param max-inline-recursive-depth} is
5928 taken into acount.  For function not declared inline, recursive inlining
5929 happens only when @option{-finline-functions} (included in @option{-O3}) is
5930 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5931 default value is 450.
5933 @item min-inline-recursive-probability
5934 Recursive inlining is profitable only for function having deep recursion
5935 in average and can hurt for function having little recursion depth by
5936 increasing the prologue size or complexity of function body to other
5937 optimizers.
5939 When profile feedback is available (see @option{-fprofile-generate}) the actual
5940 recursion depth can be guessed from probability that function will recurse via
5941 given call expression.  This parameter limits inlining only to call expression
5942 whose probability exceeds given threshold (in percents).  The default value is
5945 @item inline-call-cost
5946 Specify cost of call instruction relative to simple arithmetics operations
5947 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5948 functions and at the same time increases size of leaf function that is believed to
5949 reduce function size by being inlined.  In effect it increases amount of
5950 inlining for code having large abstraction penalty (many functions that just
5951 pass the arguments to other functions) and decrease inlining for code with low
5952 abstraction penalty.  The default value is 16.
5954 @item max-unrolled-insns
5955 The maximum number of instructions that a loop should have if that loop
5956 is unrolled, and if the loop is unrolled, it determines how many times
5957 the loop code is unrolled.
5959 @item max-average-unrolled-insns
5960 The maximum number of instructions biased by probabilities of their execution
5961 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5962 it determines how many times the loop code is unrolled.
5964 @item max-unroll-times
5965 The maximum number of unrollings of a single loop.
5967 @item max-peeled-insns
5968 The maximum number of instructions that a loop should have if that loop
5969 is peeled, and if the loop is peeled, it determines how many times
5970 the loop code is peeled.
5972 @item max-peel-times
5973 The maximum number of peelings of a single loop.
5975 @item max-completely-peeled-insns
5976 The maximum number of insns of a completely peeled loop.
5978 @item max-completely-peel-times
5979 The maximum number of iterations of a loop to be suitable for complete peeling.
5981 @item max-unswitch-insns
5982 The maximum number of insns of an unswitched loop.
5984 @item max-unswitch-level
5985 The maximum number of branches unswitched in a single loop.
5987 @item lim-expensive
5988 The minimum cost of an expensive expression in the loop invariant motion.
5990 @item iv-consider-all-candidates-bound
5991 Bound on number of candidates for induction variables below that
5992 all candidates are considered for each use in induction variable
5993 optimizations.  Only the most relevant candidates are considered
5994 if there are more candidates, to avoid quadratic time complexity.
5996 @item iv-max-considered-uses
5997 The induction variable optimizations give up on loops that contain more
5998 induction variable uses.
6000 @item iv-always-prune-cand-set-bound
6001 If number of candidates in the set is smaller than this value,
6002 we always try to remove unnecessary ivs from the set during its
6003 optimization when a new iv is added to the set.
6005 @item scev-max-expr-size
6006 Bound on size of expressions used in the scalar evolutions analyzer.
6007 Large expressions slow the analyzer.
6009 @item vect-max-version-checks
6010 The maximum number of runtime checks that can be performed when doing
6011 loop versioning in the vectorizer.  See option ftree-vect-loop-version
6012 for more information.
6014 @item max-iterations-to-track
6016 The maximum number of iterations of a loop the brute force algorithm
6017 for analysis of # of iterations of the loop tries to evaluate.
6019 @item hot-bb-count-fraction
6020 Select fraction of the maximal count of repetitions of basic block in program
6021 given basic block needs to have to be considered hot.
6023 @item hot-bb-frequency-fraction
6024 Select fraction of the maximal frequency of executions of basic block in
6025 function given basic block needs to have to be considered hot
6027 @item max-predicted-iterations
6028 The maximum number of loop iterations we predict statically.  This is useful
6029 in cases where function contain single loop with known bound and other loop
6030 with unknown.  We predict the known number of iterations correctly, while
6031 the unknown number of iterations average to roughly 10.  This means that the
6032 loop without bounds would appear artificially cold relative to the other one.
6034 @item tracer-dynamic-coverage
6035 @itemx tracer-dynamic-coverage-feedback
6037 This value is used to limit superblock formation once the given percentage of
6038 executed instructions is covered.  This limits unnecessary code size
6039 expansion.
6041 The @option{tracer-dynamic-coverage-feedback} is used only when profile
6042 feedback is available.  The real profiles (as opposed to statically estimated
6043 ones) are much less balanced allowing the threshold to be larger value.
6045 @item tracer-max-code-growth
6046 Stop tail duplication once code growth has reached given percentage.  This is
6047 rather hokey argument, as most of the duplicates will be eliminated later in
6048 cross jumping, so it may be set to much higher values than is the desired code
6049 growth.
6051 @item tracer-min-branch-ratio
6053 Stop reverse growth when the reverse probability of best edge is less than this
6054 threshold (in percent).
6056 @item tracer-min-branch-ratio
6057 @itemx tracer-min-branch-ratio-feedback
6059 Stop forward growth if the best edge do have probability lower than this
6060 threshold.
6062 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6063 compilation for profile feedback and one for compilation without.  The value
6064 for compilation with profile feedback needs to be more conservative (higher) in
6065 order to make tracer effective.
6067 @item max-cse-path-length
6069 Maximum number of basic blocks on path that cse considers.  The default is 10.
6071 @item max-cse-insns
6072 The maximum instructions CSE process before flushing. The default is 1000.
6074 @item global-var-threshold
6076 Counts the number of function calls (@var{n}) and the number of
6077 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
6078 single artificial variable will be created to represent all the
6079 call-clobbered variables at function call sites.  This artificial
6080 variable will then be made to alias every call-clobbered variable.
6081 (done as @code{int * size_t} on the host machine; beware overflow).
6083 @item max-aliased-vops
6085 Maximum number of virtual operands allowed to represent aliases
6086 before triggering the alias grouping heuristic.  Alias grouping
6087 reduces compile times and memory consumption needed for aliasing at
6088 the expense of precision loss in alias information.
6090 @item ggc-min-expand
6092 GCC uses a garbage collector to manage its own memory allocation.  This
6093 parameter specifies the minimum percentage by which the garbage
6094 collector's heap should be allowed to expand between collections.
6095 Tuning this may improve compilation speed; it has no effect on code
6096 generation.
6098 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6099 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6100 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6101 GCC is not able to calculate RAM on a particular platform, the lower
6102 bound of 30% is used.  Setting this parameter and
6103 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6104 every opportunity.  This is extremely slow, but can be useful for
6105 debugging.
6107 @item ggc-min-heapsize
6109 Minimum size of the garbage collector's heap before it begins bothering
6110 to collect garbage.  The first collection occurs after the heap expands
6111 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6112 tuning this may improve compilation speed, and has no effect on code
6113 generation.
6115 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6116 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6117 with a lower bound of 4096 (four megabytes) and an upper bound of
6118 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6119 particular platform, the lower bound is used.  Setting this parameter
6120 very large effectively disables garbage collection.  Setting this
6121 parameter and @option{ggc-min-expand} to zero causes a full collection
6122 to occur at every opportunity.
6124 @item max-reload-search-insns
6125 The maximum number of instruction reload should look backward for equivalent
6126 register.  Increasing values mean more aggressive optimization, making the
6127 compile time increase with probably slightly better performance.  The default
6128 value is 100.
6130 @item max-cselib-memory-location
6131 The maximum number of memory locations cselib should take into acount.
6132 Increasing values mean more aggressive optimization, making the compile time
6133 increase with probably slightly better performance.  The default value is 500.
6135 @item max-flow-memory-location
6136 Similar as @option{max-cselib-memory-location} but for dataflow liveness.
6137 The default value is 100.
6139 @item reorder-blocks-duplicate
6140 @itemx reorder-blocks-duplicate-feedback
6142 Used by basic block reordering pass to decide whether to use unconditional
6143 branch or duplicate the code on its destination.  Code is duplicated when its
6144 estimated size is smaller than this value multiplied by the estimated size of
6145 unconditional jump in the hot spots of the program.
6147 The @option{reorder-block-duplicate-feedback} is used only when profile
6148 feedback is available and may be set to higher values than
6149 @option{reorder-block-duplicate} since information about the hot spots is more
6150 accurate.
6152 @item max-sched-region-blocks
6153 The maximum number of blocks in a region to be considered for
6154 interblock scheduling.  The default value is 10.
6156 @item max-sched-region-insns
6157 The maximum number of insns in a region to be considered for
6158 interblock scheduling.  The default value is 100.
6160 @item min-spec-prob
6161 The minimum probability (in percents) of reaching a source block
6162 for interblock speculative scheduling.  The default value is 40.
6164 @item max-last-value-rtl
6166 The maximum size measured as number of RTLs that can be recorded in an expression
6167 in combiner for a pseudo register as last known value of that register.  The default
6168 is 10000.
6170 @item integer-share-limit
6171 Small integer constants can use a shared data structure, reducing the
6172 compiler's memory usage and increasing its speed.  This sets the maximum
6173 value of a shared integer constant's.  The default value is 256.
6175 @item min-virtual-mappings
6176 Specifies the minimum number of virtual mappings in the incremental
6177 SSA updater that should be registered to trigger the virtual mappings
6178 heuristic defined by virtual-mappings-ratio.  The default value is
6179 100.
6181 @item virtual-mappings-ratio
6182 If the number of virtual mappings is virtual-mappings-ratio bigger
6183 than the number of virtual symbols to be updated, then the incremental
6184 SSA updater switches to a full update for those symbols.  The default
6185 ratio is 3.
6187 @item ssp-buffer-size
6188 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6189 protection when @option{-fstack-protection} is used.
6191 @item max-jump-thread-duplication-stmts
6192 Maximum number of statements allowed in a block that needs to be
6193 duplicated when threading jumps.
6194 @end table
6195 @end table
6197 @node Preprocessor Options
6198 @section Options Controlling the Preprocessor
6199 @cindex preprocessor options
6200 @cindex options, preprocessor
6202 These options control the C preprocessor, which is run on each C source
6203 file before actual compilation.
6205 If you use the @option{-E} option, nothing is done except preprocessing.
6206 Some of these options make sense only together with @option{-E} because
6207 they cause the preprocessor output to be unsuitable for actual
6208 compilation.
6210 @table @gcctabopt
6211 @opindex Wp
6212 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6213 and pass @var{option} directly through to the preprocessor.  If
6214 @var{option} contains commas, it is split into multiple options at the
6215 commas.  However, many options are modified, translated or interpreted
6216 by the compiler driver before being passed to the preprocessor, and
6217 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6218 interface is undocumented and subject to change, so whenever possible
6219 you should avoid using @option{-Wp} and let the driver handle the
6220 options instead.
6222 @item -Xpreprocessor @var{option}
6223 @opindex preprocessor
6224 Pass @var{option} as an option to the preprocessor.  You can use this to
6225 supply system-specific preprocessor options which GCC does not know how to
6226 recognize.
6228 If you want to pass an option that takes an argument, you must use
6229 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6230 @end table
6232 @include cppopts.texi
6234 @node Assembler Options
6235 @section Passing Options to the Assembler
6237 @c prevent bad page break with this line
6238 You can pass options to the assembler.
6240 @table @gcctabopt
6241 @item -Wa,@var{option}
6242 @opindex Wa
6243 Pass @var{option} as an option to the assembler.  If @var{option}
6244 contains commas, it is split into multiple options at the commas.
6246 @item -Xassembler @var{option}
6247 @opindex Xassembler
6248 Pass @var{option} as an option to the assembler.  You can use this to
6249 supply system-specific assembler options which GCC does not know how to
6250 recognize.
6252 If you want to pass an option that takes an argument, you must use
6253 @option{-Xassembler} twice, once for the option and once for the argument.
6255 @end table
6257 @node Link Options
6258 @section Options for Linking
6259 @cindex link options
6260 @cindex options, linking
6262 These options come into play when the compiler links object files into
6263 an executable output file.  They are meaningless if the compiler is
6264 not doing a link step.
6266 @table @gcctabopt
6267 @cindex file names
6268 @item @var{object-file-name}
6269 A file name that does not end in a special recognized suffix is
6270 considered to name an object file or library.  (Object files are
6271 distinguished from libraries by the linker according to the file
6272 contents.)  If linking is done, these object files are used as input
6273 to the linker.
6275 @item -c
6276 @itemx -S
6277 @itemx -E
6278 @opindex c
6279 @opindex S
6280 @opindex E
6281 If any of these options is used, then the linker is not run, and
6282 object file names should not be used as arguments.  @xref{Overall
6283 Options}.
6285 @cindex Libraries
6286 @item -l@var{library}
6287 @itemx -l @var{library}
6288 @opindex l
6289 Search the library named @var{library} when linking.  (The second
6290 alternative with the library as a separate argument is only for
6291 POSIX compliance and is not recommended.)
6293 It makes a difference where in the command you write this option; the
6294 linker searches and processes libraries and object files in the order they
6295 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6296 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6297 to functions in @samp{z}, those functions may not be loaded.
6299 The linker searches a standard list of directories for the library,
6300 which is actually a file named @file{lib@var{library}.a}.  The linker
6301 then uses this file as if it had been specified precisely by name.
6303 The directories searched include several standard system directories
6304 plus any that you specify with @option{-L}.
6306 Normally the files found this way are library files---archive files
6307 whose members are object files.  The linker handles an archive file by
6308 scanning through it for members which define symbols that have so far
6309 been referenced but not defined.  But if the file that is found is an
6310 ordinary object file, it is linked in the usual fashion.  The only
6311 difference between using an @option{-l} option and specifying a file name
6312 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6313 and searches several directories.
6315 @item -lobjc
6316 @opindex lobjc
6317 You need this special case of the @option{-l} option in order to
6318 link an Objective-C or Objective-C++ program.
6320 @item -nostartfiles
6321 @opindex nostartfiles
6322 Do not use the standard system startup files when linking.
6323 The standard system libraries are used normally, unless @option{-nostdlib}
6324 or @option{-nodefaultlibs} is used.
6326 @item -nodefaultlibs
6327 @opindex nodefaultlibs
6328 Do not use the standard system libraries when linking.
6329 Only the libraries you specify will be passed to the linker.
6330 The standard startup files are used normally, unless @option{-nostartfiles}
6331 is used.  The compiler may generate calls to @code{memcmp},
6332 @code{memset}, @code{memcpy} and @code{memmove}.
6333 These entries are usually resolved by entries in
6334 libc.  These entry points should be supplied through some other
6335 mechanism when this option is specified.
6337 @item -nostdlib
6338 @opindex nostdlib
6339 Do not use the standard system startup files or libraries when linking.
6340 No startup files and only the libraries you specify will be passed to
6341 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6342 @code{memcpy} and @code{memmove}.
6343 These entries are usually resolved by entries in
6344 libc.  These entry points should be supplied through some other
6345 mechanism when this option is specified.
6347 @cindex @option{-lgcc}, use with @option{-nostdlib}
6348 @cindex @option{-nostdlib} and unresolved references
6349 @cindex unresolved references and @option{-nostdlib}
6350 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6351 @cindex @option{-nodefaultlibs} and unresolved references
6352 @cindex unresolved references and @option{-nodefaultlibs}
6353 One of the standard libraries bypassed by @option{-nostdlib} and
6354 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6355 that GCC uses to overcome shortcomings of particular machines, or special
6356 needs for some languages.
6357 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6358 Collection (GCC) Internals},
6359 for more discussion of @file{libgcc.a}.)
6360 In most cases, you need @file{libgcc.a} even when you want to avoid
6361 other standard libraries.  In other words, when you specify @option{-nostdlib}
6362 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6363 This ensures that you have no unresolved references to internal GCC
6364 library subroutines.  (For example, @samp{__main}, used to ensure C++
6365 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6366 GNU Compiler Collection (GCC) Internals}.)
6368 @item -pie
6369 @opindex pie
6370 Produce a position independent executable on targets which support it.
6371 For predictable results, you must also specify the same set of options
6372 that were used to generate code (@option{-fpie}, @option{-fPIE},
6373 or model suboptions) when you specify this option.
6375 @item -rdynamic
6376 @opindex rdynamic
6377 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6378 that support it. This instructs the linker to add all symbols, not
6379 only used ones, to the dynamic symbol table. This option is needed
6380 for some uses of @code{dlopen} or to allow obtaining backtraces
6381 from within a program.
6383 @item -s
6384 @opindex s
6385 Remove all symbol table and relocation information from the executable.
6387 @item -static
6388 @opindex static
6389 On systems that support dynamic linking, this prevents linking with the shared
6390 libraries.  On other systems, this option has no effect.
6392 @item -shared
6393 @opindex shared
6394 Produce a shared object which can then be linked with other objects to
6395 form an executable.  Not all systems support this option.  For predictable
6396 results, you must also specify the same set of options that were used to
6397 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6398 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6399 needs to build supplementary stub code for constructors to work.  On
6400 multi-libbed systems, @samp{gcc -shared} must select the correct support
6401 libraries to link against.  Failing to supply the correct flags may lead
6402 to subtle defects.  Supplying them in cases where they are not necessary
6403 is innocuous.}
6405 @item -shared-libgcc
6406 @itemx -static-libgcc
6407 @opindex shared-libgcc
6408 @opindex static-libgcc
6409 On systems that provide @file{libgcc} as a shared library, these options
6410 force the use of either the shared or static version respectively.
6411 If no shared version of @file{libgcc} was built when the compiler was
6412 configured, these options have no effect.
6414 There are several situations in which an application should use the
6415 shared @file{libgcc} instead of the static version.  The most common
6416 of these is when the application wishes to throw and catch exceptions
6417 across different shared libraries.  In that case, each of the libraries
6418 as well as the application itself should use the shared @file{libgcc}.
6420 Therefore, the G++ and GCJ drivers automatically add
6421 @option{-shared-libgcc} whenever you build a shared library or a main
6422 executable, because C++ and Java programs typically use exceptions, so
6423 this is the right thing to do.
6425 If, instead, you use the GCC driver to create shared libraries, you may
6426 find that they will not always be linked with the shared @file{libgcc}.
6427 If GCC finds, at its configuration time, that you have a non-GNU linker
6428 or a GNU linker that does not support option @option{--eh-frame-hdr},
6429 it will link the shared version of @file{libgcc} into shared libraries
6430 by default.  Otherwise, it will take advantage of the linker and optimize
6431 away the linking with the shared version of @file{libgcc}, linking with
6432 the static version of libgcc by default.  This allows exceptions to
6433 propagate through such shared libraries, without incurring relocation
6434 costs at library load time.
6436 However, if a library or main executable is supposed to throw or catch
6437 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6438 for the languages used in the program, or using the option
6439 @option{-shared-libgcc}, such that it is linked with the shared
6440 @file{libgcc}.
6442 @item -symbolic
6443 @opindex symbolic
6444 Bind references to global symbols when building a shared object.  Warn
6445 about any unresolved references (unless overridden by the link editor
6446 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6447 this option.
6449 @item -Xlinker @var{option}
6450 @opindex Xlinker
6451 Pass @var{option} as an option to the linker.  You can use this to
6452 supply system-specific linker options which GCC does not know how to
6453 recognize.
6455 If you want to pass an option that takes an argument, you must use
6456 @option{-Xlinker} twice, once for the option and once for the argument.
6457 For example, to pass @option{-assert definitions}, you must write
6458 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6459 @option{-Xlinker "-assert definitions"}, because this passes the entire
6460 string as a single argument, which is not what the linker expects.
6462 @item -Wl,@var{option}
6463 @opindex Wl
6464 Pass @var{option} as an option to the linker.  If @var{option} contains
6465 commas, it is split into multiple options at the commas.
6467 @item -u @var{symbol}
6468 @opindex u
6469 Pretend the symbol @var{symbol} is undefined, to force linking of
6470 library modules to define it.  You can use @option{-u} multiple times with
6471 different symbols to force loading of additional library modules.
6472 @end table
6474 @node Directory Options
6475 @section Options for Directory Search
6476 @cindex directory options
6477 @cindex options, directory search
6478 @cindex search path
6480 These options specify directories to search for header files, for
6481 libraries and for parts of the compiler:
6483 @table @gcctabopt
6484 @item -I@var{dir}
6485 @opindex I
6486 Add the directory @var{dir} to the head of the list of directories to be
6487 searched for header files.  This can be used to override a system header
6488 file, substituting your own version, since these directories are
6489 searched before the system header file directories.  However, you should
6490 not use this option to add directories that contain vendor-supplied
6491 system header files (use @option{-isystem} for that).  If you use more than
6492 one @option{-I} option, the directories are scanned in left-to-right
6493 order; the standard system directories come after.
6495 If a standard system include directory, or a directory specified with
6496 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6497 option will be ignored.  The directory will still be searched but as a
6498 system directory at its normal position in the system include chain.
6499 This is to ensure that GCC's procedure to fix buggy system headers and
6500 the ordering for the include_next directive are not inadvertently changed.
6501 If you really need to change the search order for system directories,
6502 use the @option{-nostdinc} and/or @option{-isystem} options.
6504 @item -iquote@var{dir}
6505 @opindex iquote
6506 Add the directory @var{dir} to the head of the list of directories to
6507 be searched for header files only for the case of @samp{#include
6508 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6509 otherwise just like @option{-I}.
6511 @item -L@var{dir}
6512 @opindex L
6513 Add directory @var{dir} to the list of directories to be searched
6514 for @option{-l}.
6516 @item -B@var{prefix}
6517 @opindex B
6518 This option specifies where to find the executables, libraries,
6519 include files, and data files of the compiler itself.
6521 The compiler driver program runs one or more of the subprograms
6522 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6523 @var{prefix} as a prefix for each program it tries to run, both with and
6524 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6526 For each subprogram to be run, the compiler driver first tries the
6527 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6528 was not specified, the driver tries two standard prefixes, which are
6529 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6530 those results in a file name that is found, the unmodified program
6531 name is searched for using the directories specified in your
6532 @env{PATH} environment variable.
6534 The compiler will check to see if the path provided by the @option{-B}
6535 refers to a directory, and if necessary it will add a directory
6536 separator character at the end of the path.
6538 @option{-B} prefixes that effectively specify directory names also apply
6539 to libraries in the linker, because the compiler translates these
6540 options into @option{-L} options for the linker.  They also apply to
6541 includes files in the preprocessor, because the compiler translates these
6542 options into @option{-isystem} options for the preprocessor.  In this case,
6543 the compiler appends @samp{include} to the prefix.
6545 The run-time support file @file{libgcc.a} can also be searched for using
6546 the @option{-B} prefix, if needed.  If it is not found there, the two
6547 standard prefixes above are tried, and that is all.  The file is left
6548 out of the link if it is not found by those means.
6550 Another way to specify a prefix much like the @option{-B} prefix is to use
6551 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6552 Variables}.
6554 As a special kludge, if the path provided by @option{-B} is
6555 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6556 9, then it will be replaced by @file{[dir/]include}.  This is to help
6557 with boot-strapping the compiler.
6559 @item -specs=@var{file}
6560 @opindex specs
6561 Process @var{file} after the compiler reads in the standard @file{specs}
6562 file, in order to override the defaults that the @file{gcc} driver
6563 program uses when determining what switches to pass to @file{cc1},
6564 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6565 @option{-specs=@var{file}} can be specified on the command line, and they
6566 are processed in order, from left to right.
6568 @item --sysroot=@var{dir}
6569 @opindex sysroot
6570 Use @var{dir} as the logical root directory for headers and libraries.
6571 For example, if the compiler would normally search for headers in
6572 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6573 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6575 If you use both this option and the @option{-isysroot} option, then
6576 the @option{--sysroot} option will apply to libraries, but the
6577 @option{-isysroot} option will apply to header files.
6579 The GNU linker (beginning with version 2.16) has the necessary support
6580 for this option.  If your linker does not support this option, the
6581 header file aspect of @option{--sysroot} will still work, but the
6582 library aspect will not.
6584 @item -I-
6585 @opindex I-
6586 This option has been deprecated.  Please use @option{-iquote} instead for
6587 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6588 Any directories you specify with @option{-I} options before the @option{-I-}
6589 option are searched only for the case of @samp{#include "@var{file}"};
6590 they are not searched for @samp{#include <@var{file}>}.
6592 If additional directories are specified with @option{-I} options after
6593 the @option{-I-}, these directories are searched for all @samp{#include}
6594 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6595 this way.)
6597 In addition, the @option{-I-} option inhibits the use of the current
6598 directory (where the current input file came from) as the first search
6599 directory for @samp{#include "@var{file}"}.  There is no way to
6600 override this effect of @option{-I-}.  With @option{-I.} you can specify
6601 searching the directory which was current when the compiler was
6602 invoked.  That is not exactly the same as what the preprocessor does
6603 by default, but it is often satisfactory.
6605 @option{-I-} does not inhibit the use of the standard system directories
6606 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6607 independent.
6608 @end table
6610 @c man end
6612 @node Spec Files
6613 @section Specifying subprocesses and the switches to pass to them
6614 @cindex Spec Files
6616 @command{gcc} is a driver program.  It performs its job by invoking a
6617 sequence of other programs to do the work of compiling, assembling and
6618 linking.  GCC interprets its command-line parameters and uses these to
6619 deduce which programs it should invoke, and which command-line options
6620 it ought to place on their command lines.  This behavior is controlled
6621 by @dfn{spec strings}.  In most cases there is one spec string for each
6622 program that GCC can invoke, but a few programs have multiple spec
6623 strings to control their behavior.  The spec strings built into GCC can
6624 be overridden by using the @option{-specs=} command-line switch to specify
6625 a spec file.
6627 @dfn{Spec files} are plaintext files that are used to construct spec
6628 strings.  They consist of a sequence of directives separated by blank
6629 lines.  The type of directive is determined by the first non-whitespace
6630 character on the line and it can be one of the following:
6632 @table @code
6633 @item %@var{command}
6634 Issues a @var{command} to the spec file processor.  The commands that can
6635 appear here are:
6637 @table @code
6638 @item %include <@var{file}>
6639 @cindex %include
6640 Search for @var{file} and insert its text at the current point in the
6641 specs file.
6643 @item %include_noerr <@var{file}>
6644 @cindex %include_noerr
6645 Just like @samp{%include}, but do not generate an error message if the include
6646 file cannot be found.
6648 @item %rename @var{old_name} @var{new_name}
6649 @cindex %rename
6650 Rename the spec string @var{old_name} to @var{new_name}.
6652 @end table
6654 @item *[@var{spec_name}]:
6655 This tells the compiler to create, override or delete the named spec
6656 string.  All lines after this directive up to the next directive or
6657 blank line are considered to be the text for the spec string.  If this
6658 results in an empty string then the spec will be deleted.  (Or, if the
6659 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6660 does not currently exist a new spec will be created.  If the spec does
6661 exist then its contents will be overridden by the text of this
6662 directive, unless the first character of that text is the @samp{+}
6663 character, in which case the text will be appended to the spec.
6665 @item [@var{suffix}]:
6666 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6667 and up to the next directive or blank line are considered to make up the
6668 spec string for the indicated suffix.  When the compiler encounters an
6669 input file with the named suffix, it will processes the spec string in
6670 order to work out how to compile that file.  For example:
6672 @smallexample
6673 .ZZ:
6674 z-compile -input %i
6675 @end smallexample
6677 This says that any input file whose name ends in @samp{.ZZ} should be
6678 passed to the program @samp{z-compile}, which should be invoked with the
6679 command-line switch @option{-input} and with the result of performing the
6680 @samp{%i} substitution.  (See below.)
6682 As an alternative to providing a spec string, the text that follows a
6683 suffix directive can be one of the following:
6685 @table @code
6686 @item @@@var{language}
6687 This says that the suffix is an alias for a known @var{language}.  This is
6688 similar to using the @option{-x} command-line switch to GCC to specify a
6689 language explicitly.  For example:
6691 @smallexample
6692 .ZZ:
6693 @@c++
6694 @end smallexample
6696 Says that .ZZ files are, in fact, C++ source files.
6698 @item #@var{name}
6699 This causes an error messages saying:
6701 @smallexample
6702 @var{name} compiler not installed on this system.
6703 @end smallexample
6704 @end table
6706 GCC already has an extensive list of suffixes built into it.
6707 This directive will add an entry to the end of the list of suffixes, but
6708 since the list is searched from the end backwards, it is effectively
6709 possible to override earlier entries using this technique.
6711 @end table
6713 GCC has the following spec strings built into it.  Spec files can
6714 override these strings or create their own.  Note that individual
6715 targets can also add their own spec strings to this list.
6717 @smallexample
6718 asm          Options to pass to the assembler
6719 asm_final    Options to pass to the assembler post-processor
6720 cpp          Options to pass to the C preprocessor
6721 cc1          Options to pass to the C compiler
6722 cc1plus      Options to pass to the C++ compiler
6723 endfile      Object files to include at the end of the link
6724 link         Options to pass to the linker
6725 lib          Libraries to include on the command line to the linker
6726 libgcc       Decides which GCC support library to pass to the linker
6727 linker       Sets the name of the linker
6728 predefines   Defines to be passed to the C preprocessor
6729 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6730              by default
6731 startfile    Object files to include at the start of the link
6732 @end smallexample
6734 Here is a small example of a spec file:
6736 @smallexample
6737 %rename lib                 old_lib
6739 *lib:
6740 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6741 @end smallexample
6743 This example renames the spec called @samp{lib} to @samp{old_lib} and
6744 then overrides the previous definition of @samp{lib} with a new one.
6745 The new definition adds in some extra command-line options before
6746 including the text of the old definition.
6748 @dfn{Spec strings} are a list of command-line options to be passed to their
6749 corresponding program.  In addition, the spec strings can contain
6750 @samp{%}-prefixed sequences to substitute variable text or to
6751 conditionally insert text into the command line.  Using these constructs
6752 it is possible to generate quite complex command lines.
6754 Here is a table of all defined @samp{%}-sequences for spec
6755 strings.  Note that spaces are not generated automatically around the
6756 results of expanding these sequences.  Therefore you can concatenate them
6757 together or combine them with constant text in a single argument.
6759 @table @code
6760 @item %%
6761 Substitute one @samp{%} into the program name or argument.
6763 @item %i
6764 Substitute the name of the input file being processed.
6766 @item %b
6767 Substitute the basename of the input file being processed.
6768 This is the substring up to (and not including) the last period
6769 and not including the directory.
6771 @item %B
6772 This is the same as @samp{%b}, but include the file suffix (text after
6773 the last period).
6775 @item %d
6776 Marks the argument containing or following the @samp{%d} as a
6777 temporary file name, so that that file will be deleted if GCC exits
6778 successfully.  Unlike @samp{%g}, this contributes no text to the
6779 argument.
6781 @item %g@var{suffix}
6782 Substitute a file name that has suffix @var{suffix} and is chosen
6783 once per compilation, and mark the argument in the same way as
6784 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6785 name is now chosen in a way that is hard to predict even when previously
6786 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6787 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6788 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6789 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6790 was simply substituted with a file name chosen once per compilation,
6791 without regard to any appended suffix (which was therefore treated
6792 just like ordinary text), making such attacks more likely to succeed.
6794 @item %u@var{suffix}
6795 Like @samp{%g}, but generates a new temporary file name even if
6796 @samp{%u@var{suffix}} was already seen.
6798 @item %U@var{suffix}
6799 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6800 new one if there is no such last file name.  In the absence of any
6801 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6802 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6803 would involve the generation of two distinct file names, one
6804 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6805 simply substituted with a file name chosen for the previous @samp{%u},
6806 without regard to any appended suffix.
6808 @item %j@var{suffix}
6809 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6810 writable, and if save-temps is off; otherwise, substitute the name
6811 of a temporary file, just like @samp{%u}.  This temporary file is not
6812 meant for communication between processes, but rather as a junk
6813 disposal mechanism.
6815 @item %|@var{suffix}
6816 @itemx %m@var{suffix}
6817 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6818 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6819 all.  These are the two most common ways to instruct a program that it
6820 should read from standard input or write to standard output.  If you
6821 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6822 construct: see for example @file{f/lang-specs.h}.
6824 @item %.@var{SUFFIX}
6825 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6826 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6827 terminated by the next space or %.
6829 @item %w
6830 Marks the argument containing or following the @samp{%w} as the
6831 designated output file of this compilation.  This puts the argument
6832 into the sequence of arguments that @samp{%o} will substitute later.
6834 @item %o
6835 Substitutes the names of all the output files, with spaces
6836 automatically placed around them.  You should write spaces
6837 around the @samp{%o} as well or the results are undefined.
6838 @samp{%o} is for use in the specs for running the linker.
6839 Input files whose names have no recognized suffix are not compiled
6840 at all, but they are included among the output files, so they will
6841 be linked.
6843 @item %O
6844 Substitutes the suffix for object files.  Note that this is
6845 handled specially when it immediately follows @samp{%g, %u, or %U},
6846 because of the need for those to form complete file names.  The
6847 handling is such that @samp{%O} is treated exactly as if it had already
6848 been substituted, except that @samp{%g, %u, and %U} do not currently
6849 support additional @var{suffix} characters following @samp{%O} as they would
6850 following, for example, @samp{.o}.
6852 @item %p
6853 Substitutes the standard macro predefinitions for the
6854 current target machine.  Use this when running @code{cpp}.
6856 @item %P
6857 Like @samp{%p}, but puts @samp{__} before and after the name of each
6858 predefined macro, except for macros that start with @samp{__} or with
6859 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6862 @item %I
6863 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6864 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
6865 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6866 and @option{-imultilib} as necessary.
6868 @item %s
6869 Current argument is the name of a library or startup file of some sort.
6870 Search for that file in a standard list of directories and substitute
6871 the full name found.
6873 @item %e@var{str}
6874 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6875 Use this when inconsistent options are detected.
6877 @item %(@var{name})
6878 Substitute the contents of spec string @var{name} at this point.
6880 @item %[@var{name}]
6881 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6883 @item %x@{@var{option}@}
6884 Accumulate an option for @samp{%X}.
6886 @item %X
6887 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6888 spec string.
6890 @item %Y
6891 Output the accumulated assembler options specified by @option{-Wa}.
6893 @item %Z
6894 Output the accumulated preprocessor options specified by @option{-Wp}.
6896 @item %a
6897 Process the @code{asm} spec.  This is used to compute the
6898 switches to be passed to the assembler.
6900 @item %A
6901 Process the @code{asm_final} spec.  This is a spec string for
6902 passing switches to an assembler post-processor, if such a program is
6903 needed.
6905 @item %l
6906 Process the @code{link} spec.  This is the spec for computing the
6907 command line passed to the linker.  Typically it will make use of the
6908 @samp{%L %G %S %D and %E} sequences.
6910 @item %D
6911 Dump out a @option{-L} option for each directory that GCC believes might
6912 contain startup files.  If the target supports multilibs then the
6913 current multilib directory will be prepended to each of these paths.
6915 @item %L
6916 Process the @code{lib} spec.  This is a spec string for deciding which
6917 libraries should be included on the command line to the linker.
6919 @item %G
6920 Process the @code{libgcc} spec.  This is a spec string for deciding
6921 which GCC support library should be included on the command line to the linker.
6923 @item %S
6924 Process the @code{startfile} spec.  This is a spec for deciding which
6925 object files should be the first ones passed to the linker.  Typically
6926 this might be a file named @file{crt0.o}.
6928 @item %E
6929 Process the @code{endfile} spec.  This is a spec string that specifies
6930 the last object files that will be passed to the linker.
6932 @item %C
6933 Process the @code{cpp} spec.  This is used to construct the arguments
6934 to be passed to the C preprocessor.
6936 @item %1
6937 Process the @code{cc1} spec.  This is used to construct the options to be
6938 passed to the actual C compiler (@samp{cc1}).
6940 @item %2
6941 Process the @code{cc1plus} spec.  This is used to construct the options to be
6942 passed to the actual C++ compiler (@samp{cc1plus}).
6944 @item %*
6945 Substitute the variable part of a matched option.  See below.
6946 Note that each comma in the substituted string is replaced by
6947 a single space.
6949 @item %<@code{S}
6950 Remove all occurrences of @code{-S} from the command line.  Note---this
6951 command is position dependent.  @samp{%} commands in the spec string
6952 before this one will see @code{-S}, @samp{%} commands in the spec string
6953 after this one will not.
6955 @item %:@var{function}(@var{args})
6956 Call the named function @var{function}, passing it @var{args}.
6957 @var{args} is first processed as a nested spec string, then split
6958 into an argument vector in the usual fashion.  The function returns
6959 a string which is processed as if it had appeared literally as part
6960 of the current spec.
6962 The following built-in spec functions are provided:
6964 @table @code
6965 @item @code{if-exists}
6966 The @code{if-exists} spec function takes one argument, an absolute
6967 pathname to a file.  If the file exists, @code{if-exists} returns the
6968 pathname.  Here is a small example of its usage:
6970 @smallexample
6971 *startfile:
6972 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6973 @end smallexample
6975 @item @code{if-exists-else}
6976 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6977 spec function, except that it takes two arguments.  The first argument is
6978 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6979 returns the pathname.  If it does not exist, it returns the second argument.
6980 This way, @code{if-exists-else} can be used to select one file or another,
6981 based on the existence of the first.  Here is a small example of its usage:
6983 @smallexample
6984 *startfile:
6985 crt0%O%s %:if-exists(crti%O%s) \
6986 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6987 @end smallexample
6989 @item @code{replace-outfile}
6990 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6991 first argument in the outfiles array and replaces it with the second argument.  Here
6992 is a small example of its usage:
6994 @smallexample
6995 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6996 @end smallexample
6998 @end table
7000 @item %@{@code{S}@}
7001 Substitutes the @code{-S} switch, if that switch was given to GCC@.
7002 If that switch was not specified, this substitutes nothing.  Note that
7003 the leading dash is omitted when specifying this option, and it is
7004 automatically inserted if the substitution is performed.  Thus the spec
7005 string @samp{%@{foo@}} would match the command-line option @option{-foo}
7006 and would output the command line option @option{-foo}.
7008 @item %W@{@code{S}@}
7009 Like %@{@code{S}@} but mark last argument supplied within as a file to be
7010 deleted on failure.
7012 @item %@{@code{S}*@}
7013 Substitutes all the switches specified to GCC whose names start
7014 with @code{-S}, but which also take an argument.  This is used for
7015 switches like @option{-o}, @option{-D}, @option{-I}, etc.
7016 GCC considers @option{-o foo} as being
7017 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
7018 text, including the space.  Thus two arguments would be generated.
7020 @item %@{@code{S}*&@code{T}*@}
7021 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7022 (the order of @code{S} and @code{T} in the spec is not significant).
7023 There can be any number of ampersand-separated variables; for each the
7024 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
7026 @item %@{@code{S}:@code{X}@}
7027 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7029 @item %@{!@code{S}:@code{X}@}
7030 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7032 @item %@{@code{S}*:@code{X}@}
7033 Substitutes @code{X} if one or more switches whose names start with
7034 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
7035 once, no matter how many such switches appeared.  However, if @code{%*}
7036 appears somewhere in @code{X}, then @code{X} will be substituted once
7037 for each matching switch, with the @code{%*} replaced by the part of
7038 that switch that matched the @code{*}.
7040 @item %@{.@code{S}:@code{X}@}
7041 Substitutes @code{X}, if processing a file with suffix @code{S}.
7043 @item %@{!.@code{S}:@code{X}@}
7044 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7046 @item %@{@code{S}|@code{P}:@code{X}@}
7047 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7048 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7049 although they have a stronger binding than the @samp{|}.  If @code{%*}
7050 appears in @code{X}, all of the alternatives must be starred, and only
7051 the first matching alternative is substituted.
7053 For example, a spec string like this:
7055 @smallexample
7056 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7057 @end smallexample
7059 will output the following command-line options from the following input
7060 command-line options:
7062 @smallexample
7063 fred.c        -foo -baz
7064 jim.d         -bar -boggle
7065 -d fred.c     -foo -baz -boggle
7066 -d jim.d      -bar -baz -boggle
7067 @end smallexample
7069 @item %@{S:X; T:Y; :D@}
7071 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7072 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7073 be as many clauses as you need.  This may be combined with @code{.},
7074 @code{!}, @code{|}, and @code{*} as needed.
7077 @end table
7079 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7080 construct may contain other nested @samp{%} constructs or spaces, or
7081 even newlines.  They are processed as usual, as described above.
7082 Trailing white space in @code{X} is ignored.  White space may also
7083 appear anywhere on the left side of the colon in these constructs,
7084 except between @code{.} or @code{*} and the corresponding word.
7086 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7087 handled specifically in these constructs.  If another value of
7088 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7089 @option{-W} switch is found later in the command line, the earlier
7090 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7091 just one letter, which passes all matching options.
7093 The character @samp{|} at the beginning of the predicate text is used to
7094 indicate that a command should be piped to the following command, but
7095 only if @option{-pipe} is specified.
7097 It is built into GCC which switches take arguments and which do not.
7098 (You might think it would be useful to generalize this to allow each
7099 compiler's spec to say which switches take arguments.  But this cannot
7100 be done in a consistent fashion.  GCC cannot even decide which input
7101 files have been specified without knowing which switches take arguments,
7102 and it must know which input files to compile in order to tell which
7103 compilers to run).
7105 GCC also knows implicitly that arguments starting in @option{-l} are to be
7106 treated as compiler output files, and passed to the linker in their
7107 proper position among the other output files.
7109 @c man begin OPTIONS
7111 @node Target Options
7112 @section Specifying Target Machine and Compiler Version
7113 @cindex target options
7114 @cindex cross compiling
7115 @cindex specifying machine version
7116 @cindex specifying compiler version and target machine
7117 @cindex compiler version, specifying
7118 @cindex target machine, specifying
7120 The usual way to run GCC is to run the executable called @file{gcc}, or
7121 @file{<machine>-gcc} when cross-compiling, or
7122 @file{<machine>-gcc-<version>} to run a version other than the one that
7123 was installed last.  Sometimes this is inconvenient, so GCC provides
7124 options that will switch to another cross-compiler or version.
7126 @table @gcctabopt
7127 @item -b @var{machine}
7128 @opindex b
7129 The argument @var{machine} specifies the target machine for compilation.
7131 The value to use for @var{machine} is the same as was specified as the
7132 machine type when configuring GCC as a cross-compiler.  For
7133 example, if a cross-compiler was configured with @samp{configure
7134 arm-elf}, meaning to compile for an arm processor with elf binaries,
7135 then you would specify @option{-b arm-elf} to run that cross compiler.
7136 Because there are other options beginning with @option{-b}, the
7137 configuration must contain a hyphen. 
7139 @item -V @var{version}
7140 @opindex V
7141 The argument @var{version} specifies which version of GCC to run.
7142 This is useful when multiple versions are installed.  For example,
7143 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7144 @end table
7146 The @option{-V} and @option{-b} options work by running the
7147 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7148 use them if you can just run that directly.
7150 @node Submodel Options
7151 @section Hardware Models and Configurations
7152 @cindex submodel options
7153 @cindex specifying hardware config
7154 @cindex hardware models and configurations, specifying
7155 @cindex machine dependent options
7157 Earlier we discussed the standard option @option{-b} which chooses among
7158 different installed compilers for completely different target
7159 machines, such as VAX vs.@: 68000 vs.@: 80386.
7161 In addition, each of these target machine types can have its own
7162 special options, starting with @samp{-m}, to choose among various
7163 hardware models or configurations---for example, 68010 vs 68020,
7164 floating coprocessor or none.  A single installed version of the
7165 compiler can compile for any model or configuration, according to the
7166 options specified.
7168 Some configurations of the compiler also support additional special
7169 options, usually for compatibility with other compilers on the same
7170 platform.
7172 @c This list is ordered alphanumerically by subsection name.
7173 @c It should be the same order and spelling as these options are listed
7174 @c in Machine Dependent Options
7176 @menu
7177 * ARC Options::
7178 * ARM Options::
7179 * AVR Options::
7180 * Blackfin Options::
7181 * CRIS Options::
7182 * CRX Options::
7183 * Darwin Options::
7184 * DEC Alpha Options::
7185 * DEC Alpha/VMS Options::
7186 * FRV Options::
7187 * H8/300 Options::
7188 * HPPA Options::
7189 * i386 and x86-64 Options::
7190 * IA-64 Options::
7191 * M32C Options::
7192 * M32R/D Options::
7193 * M680x0 Options::
7194 * M68hc1x Options::
7195 * MCore Options::
7196 * MIPS Options::
7197 * MMIX Options::
7198 * MN10300 Options::
7199 * MT Options::
7200 * PDP-11 Options::
7201 * PowerPC Options::
7202 * RS/6000 and PowerPC Options::
7203 * S/390 and zSeries Options::
7204 * SH Options::
7205 * SPARC Options::
7206 * System V Options::
7207 * TMS320C3x/C4x Options::
7208 * V850 Options::
7209 * VAX Options::
7210 * x86-64 Options::
7211 * Xstormy16 Options::
7212 * Xtensa Options::
7213 * zSeries Options::
7214 @end menu
7216 @node ARC Options
7217 @subsection ARC Options
7218 @cindex ARC Options
7220 These options are defined for ARC implementations:
7222 @table @gcctabopt
7223 @item -EL
7224 @opindex EL
7225 Compile code for little endian mode.  This is the default.
7227 @item -EB
7228 @opindex EB
7229 Compile code for big endian mode.
7231 @item -mmangle-cpu
7232 @opindex mmangle-cpu
7233 Prepend the name of the cpu to all public symbol names.
7234 In multiple-processor systems, there are many ARC variants with different
7235 instruction and register set characteristics.  This flag prevents code
7236 compiled for one cpu to be linked with code compiled for another.
7237 No facility exists for handling variants that are ``almost identical''.
7238 This is an all or nothing option.
7240 @item -mcpu=@var{cpu}
7241 @opindex mcpu
7242 Compile code for ARC variant @var{cpu}.
7243 Which variants are supported depend on the configuration.
7244 All variants support @option{-mcpu=base}, this is the default.
7246 @item -mtext=@var{text-section}
7247 @itemx -mdata=@var{data-section}
7248 @itemx -mrodata=@var{readonly-data-section}
7249 @opindex mtext
7250 @opindex mdata
7251 @opindex mrodata
7252 Put functions, data, and readonly data in @var{text-section},
7253 @var{data-section}, and @var{readonly-data-section} respectively
7254 by default.  This can be overridden with the @code{section} attribute.
7255 @xref{Variable Attributes}.
7257 @end table
7259 @node ARM Options
7260 @subsection ARM Options
7261 @cindex ARM options
7263 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7264 architectures:
7266 @table @gcctabopt
7267 @item -mabi=@var{name}
7268 @opindex mabi
7269 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7270 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7272 @item -mapcs-frame
7273 @opindex mapcs-frame
7274 Generate a stack frame that is compliant with the ARM Procedure Call
7275 Standard for all functions, even if this is not strictly necessary for
7276 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7277 with this option will cause the stack frames not to be generated for
7278 leaf functions.  The default is @option{-mno-apcs-frame}.
7280 @item -mapcs
7281 @opindex mapcs
7282 This is a synonym for @option{-mapcs-frame}.
7284 @ignore
7285 @c not currently implemented
7286 @item -mapcs-stack-check
7287 @opindex mapcs-stack-check
7288 Generate code to check the amount of stack space available upon entry to
7289 every function (that actually uses some stack space).  If there is
7290 insufficient space available then either the function
7291 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7292 called, depending upon the amount of stack space required.  The run time
7293 system is required to provide these functions.  The default is
7294 @option{-mno-apcs-stack-check}, since this produces smaller code.
7296 @c not currently implemented
7297 @item -mapcs-float
7298 @opindex mapcs-float
7299 Pass floating point arguments using the float point registers.  This is
7300 one of the variants of the APCS@.  This option is recommended if the
7301 target hardware has a floating point unit or if a lot of floating point
7302 arithmetic is going to be performed by the code.  The default is
7303 @option{-mno-apcs-float}, since integer only code is slightly increased in
7304 size if @option{-mapcs-float} is used.
7306 @c not currently implemented
7307 @item -mapcs-reentrant
7308 @opindex mapcs-reentrant
7309 Generate reentrant, position independent code.  The default is
7310 @option{-mno-apcs-reentrant}.
7311 @end ignore
7313 @item -mthumb-interwork
7314 @opindex mthumb-interwork
7315 Generate code which supports calling between the ARM and Thumb
7316 instruction sets.  Without this option the two instruction sets cannot
7317 be reliably used inside one program.  The default is
7318 @option{-mno-thumb-interwork}, since slightly larger code is generated
7319 when @option{-mthumb-interwork} is specified.
7321 @item -mno-sched-prolog
7322 @opindex mno-sched-prolog
7323 Prevent the reordering of instructions in the function prolog, or the
7324 merging of those instruction with the instructions in the function's
7325 body.  This means that all functions will start with a recognizable set
7326 of instructions (or in fact one of a choice from a small set of
7327 different function prologues), and this information can be used to
7328 locate the start if functions inside an executable piece of code.  The
7329 default is @option{-msched-prolog}.
7331 @item -mhard-float
7332 @opindex mhard-float
7333 Generate output containing floating point instructions.  This is the
7334 default.
7336 @item -msoft-float
7337 @opindex msoft-float
7338 Generate output containing library calls for floating point.
7339 @strong{Warning:} the requisite libraries are not available for all ARM
7340 targets.  Normally the facilities of the machine's usual C compiler are
7341 used, but this cannot be done directly in cross-compilation.  You must make
7342 your own arrangements to provide suitable library functions for
7343 cross-compilation.
7345 @option{-msoft-float} changes the calling convention in the output file;
7346 therefore, it is only useful if you compile @emph{all} of a program with
7347 this option.  In particular, you need to compile @file{libgcc.a}, the
7348 library that comes with GCC, with @option{-msoft-float} in order for
7349 this to work.
7351 @item -mfloat-abi=@var{name}
7352 @opindex mfloat-abi
7353 Specifies which ABI to use for floating point values.  Permissible values
7354 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7356 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7357 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7358 of floating point instructions, but still uses the soft-float calling
7359 conventions.
7361 @item -mlittle-endian
7362 @opindex mlittle-endian
7363 Generate code for a processor running in little-endian mode.  This is
7364 the default for all standard configurations.
7366 @item -mbig-endian
7367 @opindex mbig-endian
7368 Generate code for a processor running in big-endian mode; the default is
7369 to compile code for a little-endian processor.
7371 @item -mwords-little-endian
7372 @opindex mwords-little-endian
7373 This option only applies when generating code for big-endian processors.
7374 Generate code for a little-endian word order but a big-endian byte
7375 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7376 option should only be used if you require compatibility with code for
7377 big-endian ARM processors generated by versions of the compiler prior to
7378 2.8.
7380 @item -mcpu=@var{name}
7381 @opindex mcpu
7382 This specifies the name of the target ARM processor.  GCC uses this name
7383 to determine what kind of instructions it can emit when generating
7384 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7385 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7386 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7387 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7388 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7389 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7390 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7391 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7392 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7393 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7394 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7395 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7396 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7397 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7398 @samp{ep9312}.
7400 @itemx -mtune=@var{name}
7401 @opindex mtune
7402 This option is very similar to the @option{-mcpu=} option, except that
7403 instead of specifying the actual target processor type, and hence
7404 restricting which instructions can be used, it specifies that GCC should
7405 tune the performance of the code as if the target were of the type
7406 specified in this option, but still choosing the instructions that it
7407 will generate based on the cpu specified by a @option{-mcpu=} option.
7408 For some ARM implementations better performance can be obtained by using
7409 this option.
7411 @item -march=@var{name}
7412 @opindex march
7413 This specifies the name of the target ARM architecture.  GCC uses this
7414 name to determine what kind of instructions it can emit when generating
7415 assembly code.  This option can be used in conjunction with or instead
7416 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7417 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7418 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7419 @samp{iwmmxt}, @samp{ep9312}.
7421 @item -mfpu=@var{name}
7422 @itemx -mfpe=@var{number}
7423 @itemx -mfp=@var{number}
7424 @opindex mfpu
7425 @opindex mfpe
7426 @opindex mfp
7427 This specifies what floating point hardware (or hardware emulation) is
7428 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7429 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7430 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7431 with older versions of GCC@.
7433 If @option{-msoft-float} is specified this specifies the format of
7434 floating point values.
7436 @item -mstructure-size-boundary=@var{n}
7437 @opindex mstructure-size-boundary
7438 The size of all structures and unions will be rounded up to a multiple
7439 of the number of bits set by this option.  Permissible values are 8, 32
7440 and 64.  The default value varies for different toolchains.  For the COFF
7441 targeted toolchain the default value is 8.  A value of 64 is only allowed
7442 if the underlying ABI supports it.
7444 Specifying the larger number can produce faster, more efficient code, but
7445 can also increase the size of the program.  Different values are potentially
7446 incompatible.  Code compiled with one value cannot necessarily expect to
7447 work with code or libraries compiled with another value, if they exchange
7448 information using structures or unions.
7450 @item -mabort-on-noreturn
7451 @opindex mabort-on-noreturn
7452 Generate a call to the function @code{abort} at the end of a
7453 @code{noreturn} function.  It will be executed if the function tries to
7454 return.
7456 @item -mlong-calls
7457 @itemx -mno-long-calls
7458 @opindex mlong-calls
7459 @opindex mno-long-calls
7460 Tells the compiler to perform function calls by first loading the
7461 address of the function into a register and then performing a subroutine
7462 call on this register.  This switch is needed if the target function
7463 will lie outside of the 64 megabyte addressing range of the offset based
7464 version of subroutine call instruction.
7466 Even if this switch is enabled, not all function calls will be turned
7467 into long calls.  The heuristic is that static functions, functions
7468 which have the @samp{short-call} attribute, functions that are inside
7469 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7470 definitions have already been compiled within the current compilation
7471 unit, will not be turned into long calls.  The exception to this rule is
7472 that weak function definitions, functions with the @samp{long-call}
7473 attribute or the @samp{section} attribute, and functions that are within
7474 the scope of a @samp{#pragma long_calls} directive, will always be
7475 turned into long calls.
7477 This feature is not enabled by default.  Specifying
7478 @option{-mno-long-calls} will restore the default behavior, as will
7479 placing the function calls within the scope of a @samp{#pragma
7480 long_calls_off} directive.  Note these switches have no effect on how
7481 the compiler generates code to handle function calls via function
7482 pointers.
7484 @item -mnop-fun-dllimport
7485 @opindex mnop-fun-dllimport
7486 Disable support for the @code{dllimport} attribute.
7488 @item -msingle-pic-base
7489 @opindex msingle-pic-base
7490 Treat the register used for PIC addressing as read-only, rather than
7491 loading it in the prologue for each function.  The run-time system is
7492 responsible for initializing this register with an appropriate value
7493 before execution begins.
7495 @item -mpic-register=@var{reg}
7496 @opindex mpic-register
7497 Specify the register to be used for PIC addressing.  The default is R10
7498 unless stack-checking is enabled, when R9 is used.
7500 @item -mcirrus-fix-invalid-insns
7501 @opindex mcirrus-fix-invalid-insns
7502 @opindex mno-cirrus-fix-invalid-insns
7503 Insert NOPs into the instruction stream to in order to work around
7504 problems with invalid Maverick instruction combinations.  This option
7505 is only valid if the @option{-mcpu=ep9312} option has been used to
7506 enable generation of instructions for the Cirrus Maverick floating
7507 point co-processor.  This option is not enabled by default, since the
7508 problem is only present in older Maverick implementations.  The default
7509 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7510 switch.
7512 @item -mpoke-function-name
7513 @opindex mpoke-function-name
7514 Write the name of each function into the text section, directly
7515 preceding the function prologue.  The generated code is similar to this:
7517 @smallexample
7518      t0
7519          .ascii "arm_poke_function_name", 0
7520          .align
7521      t1
7522          .word 0xff000000 + (t1 - t0)
7523      arm_poke_function_name
7524          mov     ip, sp
7525          stmfd   sp!, @{fp, ip, lr, pc@}
7526          sub     fp, ip, #4
7527 @end smallexample
7529 When performing a stack backtrace, code can inspect the value of
7530 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7531 location @code{pc - 12} and the top 8 bits are set, then we know that
7532 there is a function name embedded immediately preceding this location
7533 and has length @code{((pc[-3]) & 0xff000000)}.
7535 @item -mthumb
7536 @opindex mthumb
7537 Generate code for the 16-bit Thumb instruction set.  The default is to
7538 use the 32-bit ARM instruction set.
7540 @item -mtpcs-frame
7541 @opindex mtpcs-frame
7542 Generate a stack frame that is compliant with the Thumb Procedure Call
7543 Standard for all non-leaf functions.  (A leaf function is one that does
7544 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7546 @item -mtpcs-leaf-frame
7547 @opindex mtpcs-leaf-frame
7548 Generate a stack frame that is compliant with the Thumb Procedure Call
7549 Standard for all leaf functions.  (A leaf function is one that does
7550 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7552 @item -mcallee-super-interworking
7553 @opindex mcallee-super-interworking
7554 Gives all externally visible functions in the file being compiled an ARM
7555 instruction set header which switches to Thumb mode before executing the
7556 rest of the function.  This allows these functions to be called from
7557 non-interworking code.
7559 @item -mcaller-super-interworking
7560 @opindex mcaller-super-interworking
7561 Allows calls via function pointers (including virtual functions) to
7562 execute correctly regardless of whether the target code has been
7563 compiled for interworking or not.  There is a small overhead in the cost
7564 of executing a function pointer if this option is enabled.
7566 @item -mtp=@var{name}
7567 @opindex mtp
7568 Specify the access model for the thread local storage pointer.  The valid
7569 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7570 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7571 (supported in the arm6k architecture), and @option{auto}, which uses the
7572 best available method for the selected processor.  The default setting is
7573 @option{auto}.
7575 @end table
7577 @node AVR Options
7578 @subsection AVR Options
7579 @cindex AVR Options
7581 These options are defined for AVR implementations:
7583 @table @gcctabopt
7584 @item -mmcu=@var{mcu}
7585 @opindex mmcu
7586 Specify ATMEL AVR instruction set or MCU type.
7588 Instruction set avr1 is for the minimal AVR core, not supported by the C
7589 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7590 attiny11, attiny12, attiny15, attiny28).
7592 Instruction set avr2 (default) is for the classic AVR core with up to
7593 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7594 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7595 at90c8534, at90s8535).
7597 Instruction set avr3 is for the classic AVR core with up to 128K program
7598 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7600 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7601 memory space (MCU types: atmega8, atmega83, atmega85).
7603 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7604 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7605 atmega64, atmega128, at43usb355, at94k).
7607 @item -msize
7608 @opindex msize
7609 Output instruction sizes to the asm file.
7611 @item -minit-stack=@var{N}
7612 @opindex minit-stack
7613 Specify the initial stack address, which may be a symbol or numeric value,
7614 @samp{__stack} is the default.
7616 @item -mno-interrupts
7617 @opindex mno-interrupts
7618 Generated code is not compatible with hardware interrupts.
7619 Code size will be smaller.
7621 @item -mcall-prologues
7622 @opindex mcall-prologues
7623 Functions prologues/epilogues expanded as call to appropriate
7624 subroutines.  Code size will be smaller.
7626 @item -mno-tablejump
7627 @opindex mno-tablejump
7628 Do not generate tablejump insns which sometimes increase code size.
7630 @item -mtiny-stack
7631 @opindex mtiny-stack
7632 Change only the low 8 bits of the stack pointer.
7634 @item -mint8
7635 @opindex mint8
7636 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7637 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7638 and long long will be 4 bytes.  Please note that this option does not
7639 comply to the C standards, but it will provide you with smaller code
7640 size.
7641 @end table
7643 @node Blackfin Options
7644 @subsection Blackfin Options
7645 @cindex Blackfin Options
7647 @table @gcctabopt
7648 @item -momit-leaf-frame-pointer
7649 @opindex momit-leaf-frame-pointer
7650 Don't keep the frame pointer in a register for leaf functions.  This
7651 avoids the instructions to save, set up and restore frame pointers and
7652 makes an extra register available in leaf functions.  The option
7653 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7654 which might make debugging harder.
7656 @item -mspecld-anomaly
7657 @opindex mspecld-anomaly
7658 When enabled, the compiler will ensure that the generated code does not
7659 contain speculative loads after jump instructions.  This option is enabled
7660 by default.
7662 @item -mno-specld-anomaly
7663 @opindex mno-specld-anomaly
7664 Don't generate extra code to prevent speculative loads from occurring.
7666 @item -mcsync-anomaly
7667 @opindex mcsync-anomaly
7668 When enabled, the compiler will ensure that the generated code does not
7669 contain CSYNC or SSYNC instructions too soon after conditional branches.
7670 This option is enabled by default.
7672 @item -mno-csync-anomaly
7673 @opindex mno-csync-anomaly
7674 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7675 occurring too soon after a conditional branch.
7677 @item -mlow-64k
7678 @opindex mlow-64k
7679 When enabled, the compiler is free to take advantage of the knowledge that
7680 the entire program fits into the low 64k of memory.
7682 @item -mno-low-64k
7683 @opindex mno-low-64k
7684 Assume that the program is arbitrarily large.  This is the default.
7686 @item -mid-shared-library
7687 @opindex mid-shared-library
7688 Generate code that supports shared libraries via the library ID method.
7689 This allows for execute in place and shared libraries in an environment
7690 without virtual memory management.  This option implies @option{-fPIC}.
7692 @item -mno-id-shared-library
7693 @opindex mno-id-shared-library
7694 Generate code that doesn't assume ID based shared libraries are being used.
7695 This is the default.
7697 @item -mshared-library-id=n
7698 @opindex mshared-library-id
7699 Specified the identification number of the ID based shared library being
7700 compiled.  Specifying a value of 0 will generate more compact code, specifying
7701 other values will force the allocation of that number to the current
7702 library but is no more space or time efficient than omitting this option.
7704 @item -mlong-calls
7705 @itemx -mno-long-calls
7706 @opindex mlong-calls
7707 @opindex mno-long-calls
7708 Tells the compiler to perform function calls by first loading the
7709 address of the function into a register and then performing a subroutine
7710 call on this register.  This switch is needed if the target function
7711 will lie outside of the 24 bit addressing range of the offset based
7712 version of subroutine call instruction.
7714 This feature is not enabled by default.  Specifying
7715 @option{-mno-long-calls} will restore the default behavior.  Note these
7716 switches have no effect on how the compiler generates code to handle
7717 function calls via function pointers.
7718 @end table
7720 @node CRIS Options
7721 @subsection CRIS Options
7722 @cindex CRIS Options
7724 These options are defined specifically for the CRIS ports.
7726 @table @gcctabopt
7727 @item -march=@var{architecture-type}
7728 @itemx -mcpu=@var{architecture-type}
7729 @opindex march
7730 @opindex mcpu
7731 Generate code for the specified architecture.  The choices for
7732 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7733 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7734 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7735 @samp{v10}.
7737 @item -mtune=@var{architecture-type}
7738 @opindex mtune
7739 Tune to @var{architecture-type} everything applicable about the generated
7740 code, except for the ABI and the set of available instructions.  The
7741 choices for @var{architecture-type} are the same as for
7742 @option{-march=@var{architecture-type}}.
7744 @item -mmax-stack-frame=@var{n}
7745 @opindex mmax-stack-frame
7746 Warn when the stack frame of a function exceeds @var{n} bytes.
7748 @item -melinux-stacksize=@var{n}
7749 @opindex melinux-stacksize
7750 Only available with the @samp{cris-axis-aout} target.  Arranges for
7751 indications in the program to the kernel loader that the stack of the
7752 program should be set to @var{n} bytes.
7754 @item -metrax4
7755 @itemx -metrax100
7756 @opindex metrax4
7757 @opindex metrax100
7758 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7759 @option{-march=v3} and @option{-march=v8} respectively.
7761 @item -mmul-bug-workaround
7762 @itemx -mno-mul-bug-workaround
7763 @opindex mmul-bug-workaround
7764 @opindex mno-mul-bug-workaround
7765 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7766 models where it applies.  This option is active by default.
7768 @item -mpdebug
7769 @opindex mpdebug
7770 Enable CRIS-specific verbose debug-related information in the assembly
7771 code.  This option also has the effect to turn off the @samp{#NO_APP}
7772 formatted-code indicator to the assembler at the beginning of the
7773 assembly file.
7775 @item -mcc-init
7776 @opindex mcc-init
7777 Do not use condition-code results from previous instruction; always emit
7778 compare and test instructions before use of condition codes.
7780 @item -mno-side-effects
7781 @opindex mno-side-effects
7782 Do not emit instructions with side-effects in addressing modes other than
7783 post-increment.
7785 @item -mstack-align
7786 @itemx -mno-stack-align
7787 @itemx -mdata-align
7788 @itemx -mno-data-align
7789 @itemx -mconst-align
7790 @itemx -mno-const-align
7791 @opindex mstack-align
7792 @opindex mno-stack-align
7793 @opindex mdata-align
7794 @opindex mno-data-align
7795 @opindex mconst-align
7796 @opindex mno-const-align
7797 These options (no-options) arranges (eliminate arrangements) for the
7798 stack-frame, individual data and constants to be aligned for the maximum
7799 single data access size for the chosen CPU model.  The default is to
7800 arrange for 32-bit alignment.  ABI details such as structure layout are
7801 not affected by these options.
7803 @item -m32-bit
7804 @itemx -m16-bit
7805 @itemx -m8-bit
7806 @opindex m32-bit
7807 @opindex m16-bit
7808 @opindex m8-bit
7809 Similar to the stack- data- and const-align options above, these options
7810 arrange for stack-frame, writable data and constants to all be 32-bit,
7811 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7813 @item -mno-prologue-epilogue
7814 @itemx -mprologue-epilogue
7815 @opindex mno-prologue-epilogue
7816 @opindex mprologue-epilogue
7817 With @option{-mno-prologue-epilogue}, the normal function prologue and
7818 epilogue that sets up the stack-frame are omitted and no return
7819 instructions or return sequences are generated in the code.  Use this
7820 option only together with visual inspection of the compiled code: no
7821 warnings or errors are generated when call-saved registers must be saved,
7822 or storage for local variable needs to be allocated.
7824 @item -mno-gotplt
7825 @itemx -mgotplt
7826 @opindex mno-gotplt
7827 @opindex mgotplt
7828 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7829 instruction sequences that load addresses for functions from the PLT part
7830 of the GOT rather than (traditional on other architectures) calls to the
7831 PLT@.  The default is @option{-mgotplt}.
7833 @item -maout
7834 @opindex maout
7835 Legacy no-op option only recognized with the cris-axis-aout target.
7837 @item -melf
7838 @opindex melf
7839 Legacy no-op option only recognized with the cris-axis-elf and
7840 cris-axis-linux-gnu targets.
7842 @item -melinux
7843 @opindex melinux
7844 Only recognized with the cris-axis-aout target, where it selects a
7845 GNU/linux-like multilib, include files and instruction set for
7846 @option{-march=v8}.
7848 @item -mlinux
7849 @opindex mlinux
7850 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7852 @item -sim
7853 @opindex sim
7854 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7855 to link with input-output functions from a simulator library.  Code,
7856 initialized data and zero-initialized data are allocated consecutively.
7858 @item -sim2
7859 @opindex sim2
7860 Like @option{-sim}, but pass linker options to locate initialized data at
7861 0x40000000 and zero-initialized data at 0x80000000.
7862 @end table
7864 @node CRX Options
7865 @subsection CRX Options
7866 @cindex CRX Options
7868 These options are defined specifically for the CRX ports.
7870 @table @gcctabopt
7872 @item -mmac
7873 @opindex mmac
7874 Enable the use of multiply-accumulate instructions. Disabled by default.
7876 @item -mpush-args
7877 @opindex mpush-args
7878 Push instructions will be used to pass outgoing arguments when functions
7879 are called. Enabled by default.
7880 @end table
7882 @node Darwin Options
7883 @subsection Darwin Options
7884 @cindex Darwin options
7886 These options are defined for all architectures running the Darwin operating
7887 system.
7889 FSF GCC on Darwin does not create ``fat'' object files; it will create
7890 an object file for the single architecture that it was built to
7891 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7892 @option{-arch} options are used; it does so by running the compiler or
7893 linker multiple times and joining the results together with
7894 @file{lipo}.
7896 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7897 @samp{i686}) is determined by the flags that specify the ISA
7898 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7899 @option{-force_cpusubtype_ALL} option can be used to override this.
7901 The Darwin tools vary in their behavior when presented with an ISA
7902 mismatch.  The assembler, @file{as}, will only permit instructions to
7903 be used that are valid for the subtype of the file it is generating,
7904 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7905 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7906 and print an error if asked to create a shared library with a less
7907 restrictive subtype than its input files (for instance, trying to put
7908 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7909 for executables, @file{ld}, will quietly give the executable the most
7910 restrictive subtype of any of its input files.
7912 @table @gcctabopt
7913 @item -F@var{dir}
7914 @opindex F
7915 Add the framework directory @var{dir} to the head of the list of
7916 directories to be searched for header files.  These directories are
7917 interleaved with those specified by @option{-I} options and are
7918 scanned in a left-to-right order.
7920 A framework directory is a directory with frameworks in it.  A
7921 framework is a directory with a @samp{"Headers"} and/or
7922 @samp{"PrivateHeaders"} directory contained directly in it that ends
7923 in @samp{".framework"}.  The name of a framework is the name of this
7924 directory excluding the @samp{".framework"}.  Headers associated with
7925 the framework are found in one of those two directories, with
7926 @samp{"Headers"} being searched first.  A subframework is a framework
7927 directory that is in a framework's @samp{"Frameworks"} directory.
7928 Includes of subframework headers can only appear in a header of a
7929 framework that contains the subframework, or in a sibling subframework
7930 header.  Two subframeworks are siblings if they occur in the same
7931 framework.  A subframework should not have the same name as a
7932 framework, a warning will be issued if this is violated.  Currently a
7933 subframework cannot have subframeworks, in the future, the mechanism
7934 may be extended to support this.  The standard frameworks can be found
7935 in @samp{"/System/Library/Frameworks"} and
7936 @samp{"/Library/Frameworks"}.  An example include looks like
7937 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7938 the name of the framework and header.h is found in the
7939 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7941 @item -gused
7942 @opindex -gused
7943 Emit debugging information for symbols that are used.  For STABS
7944 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7945 This is by default ON@.
7947 @item -gfull
7948 @opindex -gfull
7949 Emit debugging information for all symbols and types.
7951 @item -mmacosx-version-min=@var{version}
7952 The earliest version of MacOS X that this executable will run on
7953 is @var{version}.  Typical values of @var{version} include @code{10.1},
7954 @code{10.2}, and @code{10.3.9}.
7956 The default for this option is to make choices that seem to be most
7957 useful.  
7959 @item -mone-byte-bool
7960 @opindex -mone-byte-bool
7961 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7962 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7963 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7964 option has no effect on x86.
7966 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7967 to generate code that is not binary compatible with code generated
7968 without that switch.  Using this switch may require recompiling all
7969 other modules in a program, including system libraries.  Use this
7970 switch to conform to a non-default data model.
7972 @item -mfix-and-continue
7973 @itemx -ffix-and-continue
7974 @itemx -findirect-data
7975 @opindex mfix-and-continue
7976 @opindex ffix-and-continue
7977 @opindex findirect-data
7978 Generate code suitable for fast turn around development.  Needed to
7979 enable gdb to dynamically load @code{.o} files into already running
7980 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7981 are provided for backwards compatibility.
7983 @item -all_load
7984 @opindex all_load
7985 Loads all members of static archive libraries.
7986 See man ld(1) for more information.
7988 @item -arch_errors_fatal
7989 @opindex arch_errors_fatal
7990 Cause the errors having to do with files that have the wrong architecture
7991 to be fatal.
7993 @item -bind_at_load
7994 @opindex bind_at_load
7995 Causes the output file to be marked such that the dynamic linker will
7996 bind all undefined references when the file is loaded or launched.
7998 @item -bundle
7999 @opindex bundle
8000 Produce a Mach-o bundle format file.
8001 See man ld(1) for more information.
8003 @item -bundle_loader @var{executable}
8004 @opindex bundle_loader
8005 This option specifies the @var{executable} that will be loading the build
8006 output file being linked.  See man ld(1) for more information.
8008 @item -dynamiclib
8009 @opindex -dynamiclib
8010 When passed this option, GCC will produce a dynamic library instead of
8011 an executable when linking, using the Darwin @file{libtool} command.
8013 @item -force_cpusubtype_ALL
8014 @opindex -force_cpusubtype_ALL
8015 This causes GCC's output file to have the @var{ALL} subtype, instead of
8016 one controlled by the @option{-mcpu} or @option{-march} option.
8018 @item -allowable_client  @var{client_name}
8019 @itemx -client_name
8020 @itemx -compatibility_version
8021 @itemx -current_version
8022 @itemx -dead_strip
8023 @itemx -dependency-file
8024 @itemx -dylib_file
8025 @itemx -dylinker_install_name
8026 @itemx -dynamic
8027 @itemx -exported_symbols_list
8028 @itemx -filelist
8029 @itemx -flat_namespace
8030 @itemx -force_flat_namespace
8031 @itemx -headerpad_max_install_names
8032 @itemx -image_base
8033 @itemx -init
8034 @itemx -install_name
8035 @itemx -keep_private_externs
8036 @itemx -multi_module
8037 @itemx -multiply_defined
8038 @itemx -multiply_defined_unused
8039 @itemx -noall_load
8040 @itemx -no_dead_strip_inits_and_terms
8041 @itemx -nofixprebinding
8042 @itemx -nomultidefs
8043 @itemx -noprebind
8044 @itemx -noseglinkedit
8045 @itemx -pagezero_size
8046 @itemx -prebind
8047 @itemx -prebind_all_twolevel_modules
8048 @itemx -private_bundle
8049 @itemx -read_only_relocs
8050 @itemx -sectalign
8051 @itemx -sectobjectsymbols
8052 @itemx -whyload
8053 @itemx -seg1addr
8054 @itemx -sectcreate
8055 @itemx -sectobjectsymbols
8056 @itemx -sectorder
8057 @itemx -segaddr
8058 @itemx -segs_read_only_addr
8059 @itemx -segs_read_write_addr
8060 @itemx -seg_addr_table
8061 @itemx -seg_addr_table_filename
8062 @itemx -seglinkedit
8063 @itemx -segprot
8064 @itemx -segs_read_only_addr
8065 @itemx -segs_read_write_addr
8066 @itemx -single_module
8067 @itemx -static
8068 @itemx -sub_library
8069 @itemx -sub_umbrella
8070 @itemx -twolevel_namespace
8071 @itemx -umbrella
8072 @itemx -undefined
8073 @itemx -unexported_symbols_list
8074 @itemx -weak_reference_mismatches
8075 @itemx -whatsloaded
8077 @opindex allowable_client
8078 @opindex client_name
8079 @opindex compatibility_version
8080 @opindex current_version
8081 @opindex dead_strip
8082 @opindex dependency-file
8083 @opindex dylib_file
8084 @opindex dylinker_install_name
8085 @opindex dynamic
8086 @opindex exported_symbols_list
8087 @opindex filelist
8088 @opindex flat_namespace
8089 @opindex force_flat_namespace
8090 @opindex headerpad_max_install_names
8091 @opindex image_base
8092 @opindex init
8093 @opindex install_name
8094 @opindex keep_private_externs
8095 @opindex multi_module
8096 @opindex multiply_defined
8097 @opindex multiply_defined_unused
8098 @opindex noall_load
8099 @opindex no_dead_strip_inits_and_terms
8100 @opindex nofixprebinding
8101 @opindex nomultidefs
8102 @opindex noprebind
8103 @opindex noseglinkedit
8104 @opindex pagezero_size
8105 @opindex prebind
8106 @opindex prebind_all_twolevel_modules
8107 @opindex private_bundle
8108 @opindex read_only_relocs
8109 @opindex sectalign
8110 @opindex sectobjectsymbols
8111 @opindex whyload
8112 @opindex seg1addr
8113 @opindex sectcreate
8114 @opindex sectobjectsymbols
8115 @opindex sectorder
8116 @opindex segaddr
8117 @opindex segs_read_only_addr
8118 @opindex segs_read_write_addr
8119 @opindex seg_addr_table
8120 @opindex seg_addr_table_filename
8121 @opindex seglinkedit
8122 @opindex segprot
8123 @opindex segs_read_only_addr
8124 @opindex segs_read_write_addr
8125 @opindex single_module
8126 @opindex static
8127 @opindex sub_library
8128 @opindex sub_umbrella
8129 @opindex twolevel_namespace
8130 @opindex umbrella
8131 @opindex undefined
8132 @opindex unexported_symbols_list
8133 @opindex weak_reference_mismatches
8134 @opindex whatsloaded
8136 These options are passed to the Darwin linker.  The Darwin linker man page
8137 describes them in detail.
8138 @end table
8140 @node DEC Alpha Options
8141 @subsection DEC Alpha Options
8143 These @samp{-m} options are defined for the DEC Alpha implementations:
8145 @table @gcctabopt
8146 @item -mno-soft-float
8147 @itemx -msoft-float
8148 @opindex mno-soft-float
8149 @opindex msoft-float
8150 Use (do not use) the hardware floating-point instructions for
8151 floating-point operations.  When @option{-msoft-float} is specified,
8152 functions in @file{libgcc.a} will be used to perform floating-point
8153 operations.  Unless they are replaced by routines that emulate the
8154 floating-point operations, or compiled in such a way as to call such
8155 emulations routines, these routines will issue floating-point
8156 operations.   If you are compiling for an Alpha without floating-point
8157 operations, you must ensure that the library is built so as not to call
8158 them.
8160 Note that Alpha implementations without floating-point operations are
8161 required to have floating-point registers.
8163 @item -mfp-reg
8164 @itemx -mno-fp-regs
8165 @opindex mfp-reg
8166 @opindex mno-fp-regs
8167 Generate code that uses (does not use) the floating-point register set.
8168 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8169 register set is not used, floating point operands are passed in integer
8170 registers as if they were integers and floating-point results are passed
8171 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8172 so any function with a floating-point argument or return value called by code
8173 compiled with @option{-mno-fp-regs} must also be compiled with that
8174 option.
8176 A typical use of this option is building a kernel that does not use,
8177 and hence need not save and restore, any floating-point registers.
8179 @item -mieee
8180 @opindex mieee
8181 The Alpha architecture implements floating-point hardware optimized for
8182 maximum performance.  It is mostly compliant with the IEEE floating
8183 point standard.  However, for full compliance, software assistance is
8184 required.  This option generates code fully IEEE compliant code
8185 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8186 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8187 defined during compilation.  The resulting code is less efficient but is
8188 able to correctly support denormalized numbers and exceptional IEEE
8189 values such as not-a-number and plus/minus infinity.  Other Alpha
8190 compilers call this option @option{-ieee_with_no_inexact}.
8192 @item -mieee-with-inexact
8193 @opindex mieee-with-inexact
8194 This is like @option{-mieee} except the generated code also maintains
8195 the IEEE @var{inexact-flag}.  Turning on this option causes the
8196 generated code to implement fully-compliant IEEE math.  In addition to
8197 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8198 macro.  On some Alpha implementations the resulting code may execute
8199 significantly slower than the code generated by default.  Since there is
8200 very little code that depends on the @var{inexact-flag}, you should
8201 normally not specify this option.  Other Alpha compilers call this
8202 option @option{-ieee_with_inexact}.
8204 @item -mfp-trap-mode=@var{trap-mode}
8205 @opindex mfp-trap-mode
8206 This option controls what floating-point related traps are enabled.
8207 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8208 The trap mode can be set to one of four values:
8210 @table @samp
8211 @item n
8212 This is the default (normal) setting.  The only traps that are enabled
8213 are the ones that cannot be disabled in software (e.g., division by zero
8214 trap).
8216 @item u
8217 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8218 as well.
8220 @item su
8221 Like @samp{su}, but the instructions are marked to be safe for software
8222 completion (see Alpha architecture manual for details).
8224 @item sui
8225 Like @samp{su}, but inexact traps are enabled as well.
8226 @end table
8228 @item -mfp-rounding-mode=@var{rounding-mode}
8229 @opindex mfp-rounding-mode
8230 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8231 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8234 @table @samp
8235 @item n
8236 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8237 the nearest machine number or towards the even machine number in case
8238 of a tie.
8240 @item m
8241 Round towards minus infinity.
8243 @item c
8244 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8246 @item d
8247 Dynamic rounding mode.  A field in the floating point control register
8248 (@var{fpcr}, see Alpha architecture reference manual) controls the
8249 rounding mode in effect.  The C library initializes this register for
8250 rounding towards plus infinity.  Thus, unless your program modifies the
8251 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8252 @end table
8254 @item -mtrap-precision=@var{trap-precision}
8255 @opindex mtrap-precision
8256 In the Alpha architecture, floating point traps are imprecise.  This
8257 means without software assistance it is impossible to recover from a
8258 floating trap and program execution normally needs to be terminated.
8259 GCC can generate code that can assist operating system trap handlers
8260 in determining the exact location that caused a floating point trap.
8261 Depending on the requirements of an application, different levels of
8262 precisions can be selected:
8264 @table @samp
8265 @item p
8266 Program precision.  This option is the default and means a trap handler
8267 can only identify which program caused a floating point exception.
8269 @item f
8270 Function precision.  The trap handler can determine the function that
8271 caused a floating point exception.
8273 @item i
8274 Instruction precision.  The trap handler can determine the exact
8275 instruction that caused a floating point exception.
8276 @end table
8278 Other Alpha compilers provide the equivalent options called
8279 @option{-scope_safe} and @option{-resumption_safe}.
8281 @item -mieee-conformant
8282 @opindex mieee-conformant
8283 This option marks the generated code as IEEE conformant.  You must not
8284 use this option unless you also specify @option{-mtrap-precision=i} and either
8285 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8286 is to emit the line @samp{.eflag 48} in the function prologue of the
8287 generated assembly file.  Under DEC Unix, this has the effect that
8288 IEEE-conformant math library routines will be linked in.
8290 @item -mbuild-constants
8291 @opindex mbuild-constants
8292 Normally GCC examines a 32- or 64-bit integer constant to
8293 see if it can construct it from smaller constants in two or three
8294 instructions.  If it cannot, it will output the constant as a literal and
8295 generate code to load it from the data segment at runtime.
8297 Use this option to require GCC to construct @emph{all} integer constants
8298 using code, even if it takes more instructions (the maximum is six).
8300 You would typically use this option to build a shared library dynamic
8301 loader.  Itself a shared library, it must relocate itself in memory
8302 before it can find the variables and constants in its own data segment.
8304 @item -malpha-as
8305 @itemx -mgas
8306 @opindex malpha-as
8307 @opindex mgas
8308 Select whether to generate code to be assembled by the vendor-supplied
8309 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8311 @item -mbwx
8312 @itemx -mno-bwx
8313 @itemx -mcix
8314 @itemx -mno-cix
8315 @itemx -mfix
8316 @itemx -mno-fix
8317 @itemx -mmax
8318 @itemx -mno-max
8319 @opindex mbwx
8320 @opindex mno-bwx
8321 @opindex mcix
8322 @opindex mno-cix
8323 @opindex mfix
8324 @opindex mno-fix
8325 @opindex mmax
8326 @opindex mno-max
8327 Indicate whether GCC should generate code to use the optional BWX,
8328 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8329 sets supported by the CPU type specified via @option{-mcpu=} option or that
8330 of the CPU on which GCC was built if none was specified.
8332 @item -mfloat-vax
8333 @itemx -mfloat-ieee
8334 @opindex mfloat-vax
8335 @opindex mfloat-ieee
8336 Generate code that uses (does not use) VAX F and G floating point
8337 arithmetic instead of IEEE single and double precision.
8339 @item -mexplicit-relocs
8340 @itemx -mno-explicit-relocs
8341 @opindex mexplicit-relocs
8342 @opindex mno-explicit-relocs
8343 Older Alpha assemblers provided no way to generate symbol relocations
8344 except via assembler macros.  Use of these macros does not allow
8345 optimal instruction scheduling.  GNU binutils as of version 2.12
8346 supports a new syntax that allows the compiler to explicitly mark
8347 which relocations should apply to which instructions.  This option
8348 is mostly useful for debugging, as GCC detects the capabilities of
8349 the assembler when it is built and sets the default accordingly.
8351 @item -msmall-data
8352 @itemx -mlarge-data
8353 @opindex msmall-data
8354 @opindex mlarge-data
8355 When @option{-mexplicit-relocs} is in effect, static data is
8356 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8357 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8358 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8359 16-bit relocations off of the @code{$gp} register.  This limits the
8360 size of the small data area to 64KB, but allows the variables to be
8361 directly accessed via a single instruction.
8363 The default is @option{-mlarge-data}.  With this option the data area
8364 is limited to just below 2GB@.  Programs that require more than 2GB of
8365 data must use @code{malloc} or @code{mmap} to allocate the data in the
8366 heap instead of in the program's data segment.
8368 When generating code for shared libraries, @option{-fpic} implies
8369 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8371 @item -msmall-text
8372 @itemx -mlarge-text
8373 @opindex msmall-text
8374 @opindex mlarge-text
8375 When @option{-msmall-text} is used, the compiler assumes that the
8376 code of the entire program (or shared library) fits in 4MB, and is
8377 thus reachable with a branch instruction.  When @option{-msmall-data}
8378 is used, the compiler can assume that all local symbols share the
8379 same @code{$gp} value, and thus reduce the number of instructions
8380 required for a function call from 4 to 1.
8382 The default is @option{-mlarge-text}.
8384 @item -mcpu=@var{cpu_type}
8385 @opindex mcpu
8386 Set the instruction set and instruction scheduling parameters for
8387 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8388 style name or the corresponding chip number.  GCC supports scheduling
8389 parameters for the EV4, EV5 and EV6 family of processors and will
8390 choose the default values for the instruction set from the processor
8391 you specify.  If you do not specify a processor type, GCC will default
8392 to the processor on which the compiler was built.
8394 Supported values for @var{cpu_type} are
8396 @table @samp
8397 @item ev4
8398 @itemx ev45
8399 @itemx 21064
8400 Schedules as an EV4 and has no instruction set extensions.
8402 @item ev5
8403 @itemx 21164
8404 Schedules as an EV5 and has no instruction set extensions.
8406 @item ev56
8407 @itemx 21164a
8408 Schedules as an EV5 and supports the BWX extension.
8410 @item pca56
8411 @itemx 21164pc
8412 @itemx 21164PC
8413 Schedules as an EV5 and supports the BWX and MAX extensions.
8415 @item ev6
8416 @itemx 21264
8417 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8419 @item ev67
8420 @itemx 21264a
8421 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8422 @end table
8424 @item -mtune=@var{cpu_type}
8425 @opindex mtune
8426 Set only the instruction scheduling parameters for machine type
8427 @var{cpu_type}.  The instruction set is not changed.
8429 @item -mmemory-latency=@var{time}
8430 @opindex mmemory-latency
8431 Sets the latency the scheduler should assume for typical memory
8432 references as seen by the application.  This number is highly
8433 dependent on the memory access patterns used by the application
8434 and the size of the external cache on the machine.
8436 Valid options for @var{time} are
8438 @table @samp
8439 @item @var{number}
8440 A decimal number representing clock cycles.
8442 @item L1
8443 @itemx L2
8444 @itemx L3
8445 @itemx main
8446 The compiler contains estimates of the number of clock cycles for
8447 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8448 (also called Dcache, Scache, and Bcache), as well as to main memory.
8449 Note that L3 is only valid for EV5.
8451 @end table
8452 @end table
8454 @node DEC Alpha/VMS Options
8455 @subsection DEC Alpha/VMS Options
8457 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8459 @table @gcctabopt
8460 @item -mvms-return-codes
8461 @opindex mvms-return-codes
8462 Return VMS condition codes from main.  The default is to return POSIX
8463 style condition (e.g.@ error) codes.
8464 @end table
8466 @node FRV Options
8467 @subsection FRV Options
8468 @cindex FRV Options
8470 @table @gcctabopt
8471 @item -mgpr-32
8472 @opindex mgpr-32
8474 Only use the first 32 general purpose registers.
8476 @item -mgpr-64
8477 @opindex mgpr-64
8479 Use all 64 general purpose registers.
8481 @item -mfpr-32
8482 @opindex mfpr-32
8484 Use only the first 32 floating point registers.
8486 @item -mfpr-64
8487 @opindex mfpr-64
8489 Use all 64 floating point registers
8491 @item -mhard-float
8492 @opindex mhard-float
8494 Use hardware instructions for floating point operations.
8496 @item -msoft-float
8497 @opindex msoft-float
8499 Use library routines for floating point operations.
8501 @item -malloc-cc
8502 @opindex malloc-cc
8504 Dynamically allocate condition code registers.
8506 @item -mfixed-cc
8507 @opindex mfixed-cc
8509 Do not try to dynamically allocate condition code registers, only
8510 use @code{icc0} and @code{fcc0}.
8512 @item -mdword
8513 @opindex mdword
8515 Change ABI to use double word insns.
8517 @item -mno-dword
8518 @opindex mno-dword
8520 Do not use double word instructions.
8522 @item -mdouble
8523 @opindex mdouble
8525 Use floating point double instructions.
8527 @item -mno-double
8528 @opindex mno-double
8530 Do not use floating point double instructions.
8532 @item -mmedia
8533 @opindex mmedia
8535 Use media instructions.
8537 @item -mno-media
8538 @opindex mno-media
8540 Do not use media instructions.
8542 @item -mmuladd
8543 @opindex mmuladd
8545 Use multiply and add/subtract instructions.
8547 @item -mno-muladd
8548 @opindex mno-muladd
8550 Do not use multiply and add/subtract instructions.
8552 @item -mfdpic
8553 @opindex mfdpic
8555 Select the FDPIC ABI, that uses function descriptors to represent
8556 pointers to functions.  Without any PIC/PIE-related options, it
8557 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8558 assumes GOT entries and small data are within a 12-bit range from the
8559 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8560 are computed with 32 bits.
8562 @item -minline-plt
8563 @opindex minline-plt
8565 Enable inlining of PLT entries in function calls to functions that are
8566 not known to bind locally.  It has no effect without @option{-mfdpic}.
8567 It's enabled by default if optimizing for speed and compiling for
8568 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8569 optimization option such as @option{-O3} or above is present in the
8570 command line.
8572 @item -mTLS
8573 @opindex TLS
8575 Assume a large TLS segment when generating thread-local code.
8577 @item -mtls
8578 @opindex tls
8580 Do not assume a large TLS segment when generating thread-local code.
8582 @item -mgprel-ro
8583 @opindex mgprel-ro
8585 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8586 that is known to be in read-only sections.  It's enabled by default,
8587 except for @option{-fpic} or @option{-fpie}: even though it may help
8588 make the global offset table smaller, it trades 1 instruction for 4.
8589 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8590 one of which may be shared by multiple symbols, and it avoids the need
8591 for a GOT entry for the referenced symbol, so it's more likely to be a
8592 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8594 @item -multilib-library-pic
8595 @opindex multilib-library-pic
8597 Link with the (library, not FD) pic libraries.  It's implied by
8598 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8599 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8600 it explicitly.
8602 @item -mlinked-fp
8603 @opindex mlinked-fp
8605 Follow the EABI requirement of always creating a frame pointer whenever
8606 a stack frame is allocated.  This option is enabled by default and can
8607 be disabled with @option{-mno-linked-fp}.
8609 @item -mlong-calls
8610 @opindex mlong-calls
8612 Use indirect addressing to call functions outside the current
8613 compilation unit.  This allows the functions to be placed anywhere
8614 within the 32-bit address space.
8616 @item -malign-labels
8617 @opindex malign-labels
8619 Try to align labels to an 8-byte boundary by inserting nops into the
8620 previous packet.  This option only has an effect when VLIW packing
8621 is enabled.  It doesn't create new packets; it merely adds nops to
8622 existing ones.
8624 @item -mlibrary-pic
8625 @opindex mlibrary-pic
8627 Generate position-independent EABI code.
8629 @item -macc-4
8630 @opindex macc-4
8632 Use only the first four media accumulator registers.
8634 @item -macc-8
8635 @opindex macc-8
8637 Use all eight media accumulator registers.
8639 @item -mpack
8640 @opindex mpack
8642 Pack VLIW instructions.
8644 @item -mno-pack
8645 @opindex mno-pack
8647 Do not pack VLIW instructions.
8649 @item -mno-eflags
8650 @opindex mno-eflags
8652 Do not mark ABI switches in e_flags.
8654 @item -mcond-move
8655 @opindex mcond-move
8657 Enable the use of conditional-move instructions (default).
8659 This switch is mainly for debugging the compiler and will likely be removed
8660 in a future version.
8662 @item -mno-cond-move
8663 @opindex mno-cond-move
8665 Disable the use of conditional-move instructions.
8667 This switch is mainly for debugging the compiler and will likely be removed
8668 in a future version.
8670 @item -mscc
8671 @opindex mscc
8673 Enable the use of conditional set instructions (default).
8675 This switch is mainly for debugging the compiler and will likely be removed
8676 in a future version.
8678 @item -mno-scc
8679 @opindex mno-scc
8681 Disable the use of conditional set instructions.
8683 This switch is mainly for debugging the compiler and will likely be removed
8684 in a future version.
8686 @item -mcond-exec
8687 @opindex mcond-exec
8689 Enable the use of conditional execution (default).
8691 This switch is mainly for debugging the compiler and will likely be removed
8692 in a future version.
8694 @item -mno-cond-exec
8695 @opindex mno-cond-exec
8697 Disable the use of conditional execution.
8699 This switch is mainly for debugging the compiler and will likely be removed
8700 in a future version.
8702 @item -mvliw-branch
8703 @opindex mvliw-branch
8705 Run a pass to pack branches into VLIW instructions (default).
8707 This switch is mainly for debugging the compiler and will likely be removed
8708 in a future version.
8710 @item -mno-vliw-branch
8711 @opindex mno-vliw-branch
8713 Do not run a pass to pack branches into VLIW instructions.
8715 This switch is mainly for debugging the compiler and will likely be removed
8716 in a future version.
8718 @item -mmulti-cond-exec
8719 @opindex mmulti-cond-exec
8721 Enable optimization of @code{&&} and @code{||} in conditional execution
8722 (default).
8724 This switch is mainly for debugging the compiler and will likely be removed
8725 in a future version.
8727 @item -mno-multi-cond-exec
8728 @opindex mno-multi-cond-exec
8730 Disable optimization of @code{&&} and @code{||} in conditional execution.
8732 This switch is mainly for debugging the compiler and will likely be removed
8733 in a future version.
8735 @item -mnested-cond-exec
8736 @opindex mnested-cond-exec
8738 Enable nested conditional execution optimizations (default).
8740 This switch is mainly for debugging the compiler and will likely be removed
8741 in a future version.
8743 @item -mno-nested-cond-exec
8744 @opindex mno-nested-cond-exec
8746 Disable nested conditional execution optimizations.
8748 This switch is mainly for debugging the compiler and will likely be removed
8749 in a future version.
8751 @item -moptimize-membar
8752 @opindex moptimize-membar
8754 This switch removes redundant @code{membar} instructions from the
8755 compiler generated code.  It is enabled by default.
8757 @item -mno-optimize-membar
8758 @opindex mno-optimize-membar
8760 This switch disables the automatic removal of redundant @code{membar}
8761 instructions from the generated code.
8763 @item -mtomcat-stats
8764 @opindex mtomcat-stats
8766 Cause gas to print out tomcat statistics.
8768 @item -mcpu=@var{cpu}
8769 @opindex mcpu
8771 Select the processor type for which to generate code.  Possible values are
8772 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8773 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8775 @end table
8777 @node H8/300 Options
8778 @subsection H8/300 Options
8780 These @samp{-m} options are defined for the H8/300 implementations:
8782 @table @gcctabopt
8783 @item -mrelax
8784 @opindex mrelax
8785 Shorten some address references at link time, when possible; uses the
8786 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8787 ld, Using ld}, for a fuller description.
8789 @item -mh
8790 @opindex mh
8791 Generate code for the H8/300H@.
8793 @item -ms
8794 @opindex ms
8795 Generate code for the H8S@.
8797 @item -mn
8798 @opindex mn
8799 Generate code for the H8S and H8/300H in the normal mode.  This switch
8800 must be used either with @option{-mh} or @option{-ms}.
8802 @item -ms2600
8803 @opindex ms2600
8804 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8806 @item -mint32
8807 @opindex mint32
8808 Make @code{int} data 32 bits by default.
8810 @item -malign-300
8811 @opindex malign-300
8812 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8813 The default for the H8/300H and H8S is to align longs and floats on 4
8814 byte boundaries.
8815 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8816 This option has no effect on the H8/300.
8817 @end table
8819 @node HPPA Options
8820 @subsection HPPA Options
8821 @cindex HPPA Options
8823 These @samp{-m} options are defined for the HPPA family of computers:
8825 @table @gcctabopt
8826 @item -march=@var{architecture-type}
8827 @opindex march
8828 Generate code for the specified architecture.  The choices for
8829 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8830 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8831 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8832 architecture option for your machine.  Code compiled for lower numbered
8833 architectures will run on higher numbered architectures, but not the
8834 other way around.
8836 @item -mpa-risc-1-0
8837 @itemx -mpa-risc-1-1
8838 @itemx -mpa-risc-2-0
8839 @opindex mpa-risc-1-0
8840 @opindex mpa-risc-1-1
8841 @opindex mpa-risc-2-0
8842 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8844 @item -mbig-switch
8845 @opindex mbig-switch
8846 Generate code suitable for big switch tables.  Use this option only if
8847 the assembler/linker complain about out of range branches within a switch
8848 table.
8850 @item -mjump-in-delay
8851 @opindex mjump-in-delay
8852 Fill delay slots of function calls with unconditional jump instructions
8853 by modifying the return pointer for the function call to be the target
8854 of the conditional jump.
8856 @item -mdisable-fpregs
8857 @opindex mdisable-fpregs
8858 Prevent floating point registers from being used in any manner.  This is
8859 necessary for compiling kernels which perform lazy context switching of
8860 floating point registers.  If you use this option and attempt to perform
8861 floating point operations, the compiler will abort.
8863 @item -mdisable-indexing
8864 @opindex mdisable-indexing
8865 Prevent the compiler from using indexing address modes.  This avoids some
8866 rather obscure problems when compiling MIG generated code under MACH@.
8868 @item -mno-space-regs
8869 @opindex mno-space-regs
8870 Generate code that assumes the target has no space registers.  This allows
8871 GCC to generate faster indirect calls and use unscaled index address modes.
8873 Such code is suitable for level 0 PA systems and kernels.
8875 @item -mfast-indirect-calls
8876 @opindex mfast-indirect-calls
8877 Generate code that assumes calls never cross space boundaries.  This
8878 allows GCC to emit code which performs faster indirect calls.
8880 This option will not work in the presence of shared libraries or nested
8881 functions.
8883 @item -mfixed-range=@var{register-range}
8884 @opindex mfixed-range
8885 Generate code treating the given register range as fixed registers.
8886 A fixed register is one that the register allocator can not use.  This is
8887 useful when compiling kernel code.  A register range is specified as
8888 two registers separated by a dash.  Multiple register ranges can be
8889 specified separated by a comma.
8891 @item -mlong-load-store
8892 @opindex mlong-load-store
8893 Generate 3-instruction load and store sequences as sometimes required by
8894 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8895 the HP compilers.
8897 @item -mportable-runtime
8898 @opindex mportable-runtime
8899 Use the portable calling conventions proposed by HP for ELF systems.
8901 @item -mgas
8902 @opindex mgas
8903 Enable the use of assembler directives only GAS understands.
8905 @item -mschedule=@var{cpu-type}
8906 @opindex mschedule
8907 Schedule code according to the constraints for the machine type
8908 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8909 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8910 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8911 proper scheduling option for your machine.  The default scheduling is
8912 @samp{8000}.
8914 @item -mlinker-opt
8915 @opindex mlinker-opt
8916 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8917 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8918 linkers in which they give bogus error messages when linking some programs.
8920 @item -msoft-float
8921 @opindex msoft-float
8922 Generate output containing library calls for floating point.
8923 @strong{Warning:} the requisite libraries are not available for all HPPA
8924 targets.  Normally the facilities of the machine's usual C compiler are
8925 used, but this cannot be done directly in cross-compilation.  You must make
8926 your own arrangements to provide suitable library functions for
8927 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8928 does provide software floating point support.
8930 @option{-msoft-float} changes the calling convention in the output file;
8931 therefore, it is only useful if you compile @emph{all} of a program with
8932 this option.  In particular, you need to compile @file{libgcc.a}, the
8933 library that comes with GCC, with @option{-msoft-float} in order for
8934 this to work.
8936 @item -msio
8937 @opindex msio
8938 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8939 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8940 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8941 options are available under HP-UX and HI-UX@.
8943 @item -mgnu-ld
8944 @opindex gnu-ld
8945 Use GNU ld specific options.  This passes @option{-shared} to ld when
8946 building a shared library.  It is the default when GCC is configured,
8947 explicitly or implicitly, with the GNU linker.  This option does not
8948 have any affect on which ld is called, it only changes what parameters
8949 are passed to that ld.  The ld that is called is determined by the
8950 @option{--with-ld} configure option, GCC's program search path, and
8951 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8952 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
8953 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8955 @item -mhp-ld
8956 @opindex hp-ld
8957 Use HP ld specific options.  This passes @option{-b} to ld when building
8958 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8959 links.  It is the default when GCC is configured, explicitly or
8960 implicitly, with the HP linker.  This option does not have any affect on
8961 which ld is called, it only changes what parameters are passed to that
8962 ld.  The ld that is called is determined by the @option{--with-ld}
8963 configure option, GCC's program search path, and finally by the user's
8964 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8965 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
8966 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8968 @item -mlong-calls
8969 @opindex mno-long-calls
8970 Generate code that uses long call sequences.  This ensures that a call
8971 is always able to reach linker generated stubs.  The default is to generate
8972 long calls only when the distance from the call site to the beginning
8973 of the function or translation unit, as the case may be, exceeds a
8974 predefined limit set by the branch type being used.  The limits for
8975 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8976 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8977 240,000 bytes.
8979 Distances are measured from the beginning of functions when using the
8980 @option{-ffunction-sections} option, or when using the @option{-mgas}
8981 and @option{-mno-portable-runtime} options together under HP-UX with
8982 the SOM linker.
8984 It is normally not desirable to use this option as it will degrade
8985 performance.  However, it may be useful in large applications,
8986 particularly when partial linking is used to build the application.
8988 The types of long calls used depends on the capabilities of the
8989 assembler and linker, and the type of code being generated.  The
8990 impact on systems that support long absolute calls, and long pic
8991 symbol-difference or pc-relative calls should be relatively small.
8992 However, an indirect call is used on 32-bit ELF systems in pic code
8993 and it is quite long.
8995 @item -munix=@var{unix-std}
8996 @opindex march
8997 Generate compiler predefines and select a startfile for the specified
8998 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8999 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
9000 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
9001 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
9002 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9003 and later.
9005 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9006 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9007 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9008 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9009 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9010 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9012 It is @emph{important} to note that this option changes the interfaces
9013 for various library routines.  It also affects the operational behavior
9014 of the C library.  Thus, @emph{extreme} care is needed in using this
9015 option.
9017 Library code that is intended to operate with more than one UNIX
9018 standard must test, set and restore the variable @var{__xpg4_extended_mask}
9019 as appropriate.  Most GNU software doesn't provide this capability.
9021 @item -nolibdld
9022 @opindex nolibdld
9023 Suppress the generation of link options to search libdld.sl when the
9024 @option{-static} option is specified on HP-UX 10 and later.
9026 @item -static
9027 @opindex static
9028 The HP-UX implementation of setlocale in libc has a dependency on
9029 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
9030 when the @option{-static} option is specified, special link options
9031 are needed to resolve this dependency.
9033 On HP-UX 10 and later, the GCC driver adds the necessary options to
9034 link with libdld.sl when the @option{-static} option is specified.
9035 This causes the resulting binary to be dynamic.  On the 64-bit port,
9036 the linkers generate dynamic binaries by default in any case.  The
9037 @option{-nolibdld} option can be used to prevent the GCC driver from
9038 adding these link options.
9040 @item -threads
9041 @opindex threads
9042 Add support for multithreading with the @dfn{dce thread} library
9043 under HP-UX@.  This option sets flags for both the preprocessor and
9044 linker.
9045 @end table
9047 @node i386 and x86-64 Options
9048 @subsection Intel 386 and AMD x86-64 Options
9049 @cindex i386 Options
9050 @cindex x86-64 Options
9051 @cindex Intel 386 Options
9052 @cindex AMD x86-64 Options
9054 These @samp{-m} options are defined for the i386 and x86-64 family of
9055 computers:
9057 @table @gcctabopt
9058 @item -mtune=@var{cpu-type}
9059 @opindex mtune
9060 Tune to @var{cpu-type} everything applicable about the generated code, except
9061 for the ABI and the set of available instructions.  The choices for
9062 @var{cpu-type} are:
9063 @table @emph
9064 @item generic
9065 Produce code optimized for the most common IA32/AMD64/EM64T processors.
9066 If you know the CPU on which your code will run, then you should use
9067 the corresponding @option{-mtune} option instead of
9068 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
9069 of your application will have, then you should use this option.
9071 As new processors are deployed in the marketplace, the behavior of this
9072 option will change.  Therefore, if you upgrade to a newer version of
9073 GCC, the code generated option will change to reflect the processors
9074 that were most common when that version of GCC was released.
9076 There is no @option{-march=generic} option because @option{-march}
9077 indicates the instruction set the compiler can use, and there is no
9078 generic instruction set applicable to all processors.  In contrast,
9079 @option{-mtune} indicates the processor (or, in this case, collection of
9080 processors) for which the code is optimized.
9081 @item i386
9082 Original Intel's i386 CPU@.
9083 @item i486
9084 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
9085 @item i586, pentium
9086 Intel Pentium CPU with no MMX support.
9087 @item pentium-mmx
9088 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9089 @item pentiumpro
9090 Intel PentiumPro CPU@.
9091 @item i686
9092 Same as @code{generic}, but when used as @code{march} option, PentiumPro
9093 instruction set will be used, so the code will run on all i686 familly chips.
9094 @item pentium2
9095 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9096 @item pentium3, pentium3m
9097 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9098 support.
9099 @item pentium-m
9100 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9101 support.  Used by Centrino notebooks.
9102 @item pentium4, pentium4m
9103 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9104 @item prescott
9105 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9106 set support.
9107 @item nocona
9108 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9109 SSE2 and SSE3 instruction set support.
9110 @item k6
9111 AMD K6 CPU with MMX instruction set support.
9112 @item k6-2, k6-3
9113 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9114 @item athlon, athlon-tbird
9115 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9116 support.
9117 @item athlon-4, athlon-xp, athlon-mp
9118 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9119 instruction set support.
9120 @item k8, opteron, athlon64, athlon-fx
9121 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9122 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9123 @item winchip-c6
9124 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9125 set support.
9126 @item winchip2
9127 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9128 instruction set support.
9129 @item c3
9130 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9131 implemented for this chip.)
9132 @item c3-2
9133 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9134 implemented for this chip.)
9135 @end table
9137 While picking a specific @var{cpu-type} will schedule things appropriately
9138 for that particular chip, the compiler will not generate any code that
9139 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9140 being used.
9142 @item -march=@var{cpu-type}
9143 @opindex march
9144 Generate instructions for the machine type @var{cpu-type}.  The choices
9145 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9146 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9148 @item -mcpu=@var{cpu-type}
9149 @opindex mcpu
9150 A deprecated synonym for @option{-mtune}.
9152 @item -m386
9153 @itemx -m486
9154 @itemx -mpentium
9155 @itemx -mpentiumpro
9156 @opindex m386
9157 @opindex m486
9158 @opindex mpentium
9159 @opindex mpentiumpro
9160 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9161 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9162 These synonyms are deprecated.
9164 @item -mfpmath=@var{unit}
9165 @opindex march
9166 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9167 for @var{unit} are:
9169 @table @samp
9170 @item 387
9171 Use the standard 387 floating point coprocessor present majority of chips and
9172 emulated otherwise.  Code compiled with this option will run almost everywhere.
9173 The temporary results are computed in 80bit precision instead of precision
9174 specified by the type resulting in slightly different results compared to most
9175 of other chips.  See @option{-ffloat-store} for more detailed description.
9177 This is the default choice for i386 compiler.
9179 @item sse
9180 Use scalar floating point instructions present in the SSE instruction set.
9181 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9182 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9183 instruction set supports only single precision arithmetics, thus the double and
9184 extended precision arithmetics is still done using 387.  Later version, present
9185 only in Pentium4 and the future AMD x86-64 chips supports double precision
9186 arithmetics too.
9188 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9189 or @option{-msse2} switches to enable SSE extensions and make this option
9190 effective.  For the x86-64 compiler, these extensions are enabled by default.
9192 The resulting code should be considerably faster in the majority of cases and avoid
9193 the numerical instability problems of 387 code, but may break some existing
9194 code that expects temporaries to be 80bit.
9196 This is the default choice for the x86-64 compiler.
9198 @item sse,387
9199 Attempt to utilize both instruction sets at once.  This effectively double the
9200 amount of available registers and on chips with separate execution units for
9201 387 and SSE the execution resources too.  Use this option with care, as it is
9202 still experimental, because the GCC register allocator does not model separate
9203 functional units well resulting in instable performance.
9204 @end table
9206 @item -masm=@var{dialect}
9207 @opindex masm=@var{dialect}
9208 Output asm instructions using selected @var{dialect}.  Supported
9209 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9210 not support @samp{intel}.
9212 @item -mieee-fp
9213 @itemx -mno-ieee-fp
9214 @opindex mieee-fp
9215 @opindex mno-ieee-fp
9216 Control whether or not the compiler uses IEEE floating point
9217 comparisons.  These handle correctly the case where the result of a
9218 comparison is unordered.
9220 @item -msoft-float
9221 @opindex msoft-float
9222 Generate output containing library calls for floating point.
9223 @strong{Warning:} the requisite libraries are not part of GCC@.
9224 Normally the facilities of the machine's usual C compiler are used, but
9225 this can't be done directly in cross-compilation.  You must make your
9226 own arrangements to provide suitable library functions for
9227 cross-compilation.
9229 On machines where a function returns floating point results in the 80387
9230 register stack, some floating point opcodes may be emitted even if
9231 @option{-msoft-float} is used.
9233 @item -mno-fp-ret-in-387
9234 @opindex mno-fp-ret-in-387
9235 Do not use the FPU registers for return values of functions.
9237 The usual calling convention has functions return values of types
9238 @code{float} and @code{double} in an FPU register, even if there
9239 is no FPU@.  The idea is that the operating system should emulate
9240 an FPU@.
9242 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9243 in ordinary CPU registers instead.
9245 @item -mno-fancy-math-387
9246 @opindex mno-fancy-math-387
9247 Some 387 emulators do not support the @code{sin}, @code{cos} and
9248 @code{sqrt} instructions for the 387.  Specify this option to avoid
9249 generating those instructions.  This option is the default on FreeBSD,
9250 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9251 indicates that the target cpu will always have an FPU and so the
9252 instruction will not need emulation.  As of revision 2.6.1, these
9253 instructions are not generated unless you also use the
9254 @option{-funsafe-math-optimizations} switch.
9256 @item -malign-double
9257 @itemx -mno-align-double
9258 @opindex malign-double
9259 @opindex mno-align-double
9260 Control whether GCC aligns @code{double}, @code{long double}, and
9261 @code{long long} variables on a two word boundary or a one word
9262 boundary.  Aligning @code{double} variables on a two word boundary will
9263 produce code that runs somewhat faster on a @samp{Pentium} at the
9264 expense of more memory.
9266 @strong{Warning:} if you use the @option{-malign-double} switch,
9267 structures containing the above types will be aligned differently than
9268 the published application binary interface specifications for the 386
9269 and will not be binary compatible with structures in code compiled
9270 without that switch.
9272 @item -m96bit-long-double
9273 @itemx -m128bit-long-double
9274 @opindex m96bit-long-double
9275 @opindex m128bit-long-double
9276 These switches control the size of @code{long double} type.  The i386
9277 application binary interface specifies the size to be 96 bits,
9278 so @option{-m96bit-long-double} is the default in 32 bit mode.
9280 Modern architectures (Pentium and newer) would prefer @code{long double}
9281 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9282 conforming to the ABI, this would not be possible.  So specifying a
9283 @option{-m128bit-long-double} will align @code{long double}
9284 to a 16 byte boundary by padding the @code{long double} with an additional
9285 32 bit zero.
9287 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9288 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9290 Notice that neither of these options enable any extra precision over the x87
9291 standard of 80 bits for a @code{long double}.
9293 @strong{Warning:} if you override the default value for your target ABI, the
9294 structures and arrays containing @code{long double} variables will change
9295 their size as well as function calling convention for function taking
9296 @code{long double} will be modified.  Hence they will not be binary
9297 compatible with arrays or structures in code compiled without that switch.
9299 @item -mmlarge-data-threshold=@var{number}
9300 @opindex mlarge-data-threshold=@var{number}
9301 When @option{-mcmodel=medium} is specified, the data greater than
9302 @var{threshold} are placed in large data section.  This value must be the
9303 same across all object linked into the binary and defaults to 65535.
9305 @item -msvr3-shlib
9306 @itemx -mno-svr3-shlib
9307 @opindex msvr3-shlib
9308 @opindex mno-svr3-shlib
9309 Control whether GCC places uninitialized local variables into the
9310 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9311 into @code{bss}.  These options are meaningful only on System V Release 3.
9313 @item -mrtd
9314 @opindex mrtd
9315 Use a different function-calling convention, in which functions that
9316 take a fixed number of arguments return with the @code{ret} @var{num}
9317 instruction, which pops their arguments while returning.  This saves one
9318 instruction in the caller since there is no need to pop the arguments
9319 there.
9321 You can specify that an individual function is called with this calling
9322 sequence with the function attribute @samp{stdcall}.  You can also
9323 override the @option{-mrtd} option by using the function attribute
9324 @samp{cdecl}.  @xref{Function Attributes}.
9326 @strong{Warning:} this calling convention is incompatible with the one
9327 normally used on Unix, so you cannot use it if you need to call
9328 libraries compiled with the Unix compiler.
9330 Also, you must provide function prototypes for all functions that
9331 take variable numbers of arguments (including @code{printf});
9332 otherwise incorrect code will be generated for calls to those
9333 functions.
9335 In addition, seriously incorrect code will result if you call a
9336 function with too many arguments.  (Normally, extra arguments are
9337 harmlessly ignored.)
9339 @item -mregparm=@var{num}
9340 @opindex mregparm
9341 Control how many registers are used to pass integer arguments.  By
9342 default, no registers are used to pass arguments, and at most 3
9343 registers can be used.  You can control this behavior for a specific
9344 function by using the function attribute @samp{regparm}.
9345 @xref{Function Attributes}.
9347 @strong{Warning:} if you use this switch, and
9348 @var{num} is nonzero, then you must build all modules with the same
9349 value, including any libraries.  This includes the system libraries and
9350 startup modules.
9352 @item -msseregparm
9353 @opindex msseregparm
9354 Use SSE register passing conventions for float and double arguments
9355 and return values.  You can control this behavior for a specific
9356 function by using the function attribute @samp{sseregparm}.
9357 @xref{Function Attributes}.
9359 @strong{Warning:} if you use this switch then you must build all
9360 modules with the same value, including any libraries.  This includes
9361 the system libraries and startup modules.
9363 @item -mpreferred-stack-boundary=@var{num}
9364 @opindex mpreferred-stack-boundary
9365 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9366 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9367 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9368 size (@option{-Os}), in which case the default is the minimum correct
9369 alignment (4 bytes for x86, and 8 bytes for x86-64).
9371 On Pentium and PentiumPro, @code{double} and @code{long double} values
9372 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9373 suffer significant run time performance penalties.  On Pentium III, the
9374 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9375 penalties if it is not 16 byte aligned.
9377 To ensure proper alignment of this values on the stack, the stack boundary
9378 must be as aligned as that required by any value stored on the stack.
9379 Further, every function must be generated such that it keeps the stack
9380 aligned.  Thus calling a function compiled with a higher preferred
9381 stack boundary from a function compiled with a lower preferred stack
9382 boundary will most likely misalign the stack.  It is recommended that
9383 libraries that use callbacks always use the default setting.
9385 This extra alignment does consume extra stack space, and generally
9386 increases code size.  Code that is sensitive to stack space usage, such
9387 as embedded systems and operating system kernels, may want to reduce the
9388 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9390 @item -mmmx
9391 @itemx -mno-mmx
9392 @item -msse
9393 @itemx -mno-sse
9394 @item -msse2
9395 @itemx -mno-sse2
9396 @item -msse3
9397 @itemx -mno-sse3
9398 @item -m3dnow
9399 @itemx -mno-3dnow
9400 @opindex mmmx
9401 @opindex mno-mmx
9402 @opindex msse
9403 @opindex mno-sse
9404 @opindex m3dnow
9405 @opindex mno-3dnow
9406 These switches enable or disable the use of instructions in the MMX,
9407 SSE, SSE2 or 3DNow! extended instruction sets.  These extensions are
9408 also available as built-in functions: see @ref{X86 Built-in Functions},
9409 for details of the functions enabled and disabled by these switches.
9411 To have SSE/SSE2 instructions generated automatically from floating-point
9412 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9414 These options will enable GCC to use these extended instructions in
9415 generated code, even without @option{-mfpmath=sse}.  Applications which
9416 perform runtime CPU detection must compile separate files for each
9417 supported architecture, using the appropriate flags.  In particular,
9418 the file containing the CPU detection code should be compiled without
9419 these options.
9421 @item -msselibm
9422 @opindex msselibm
9423 Use special versions of certain libm routines that come with an SSE
9424 ABI and an SSE implementation.  Useful together with @option{-mfpmath=sse}
9425 to avoid moving values between SSE registers and the x87 FP stack.
9427 @item -mpush-args
9428 @itemx -mno-push-args
9429 @opindex mpush-args
9430 @opindex mno-push-args
9431 Use PUSH operations to store outgoing parameters.  This method is shorter
9432 and usually equally fast as method using SUB/MOV operations and is enabled
9433 by default.  In some cases disabling it may improve performance because of
9434 improved scheduling and reduced dependencies.
9436 @item -maccumulate-outgoing-args
9437 @opindex maccumulate-outgoing-args
9438 If enabled, the maximum amount of space required for outgoing arguments will be
9439 computed in the function prologue.  This is faster on most modern CPUs
9440 because of reduced dependencies, improved scheduling and reduced stack usage
9441 when preferred stack boundary is not equal to 2.  The drawback is a notable
9442 increase in code size.  This switch implies @option{-mno-push-args}.
9444 @item -mthreads
9445 @opindex mthreads
9446 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9447 on thread-safe exception handling must compile and link all code with the
9448 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9449 @option{-D_MT}; when linking, it links in a special thread helper library
9450 @option{-lmingwthrd} which cleans up per thread exception handling data.
9452 @item -mno-align-stringops
9453 @opindex mno-align-stringops
9454 Do not align destination of inlined string operations.  This switch reduces
9455 code size and improves performance in case the destination is already aligned,
9456 but GCC doesn't know about it.
9458 @item -minline-all-stringops
9459 @opindex minline-all-stringops
9460 By default GCC inlines string operations only when destination is known to be
9461 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9462 size, but may improve performance of code that depends on fast memcpy, strlen
9463 and memset for short lengths.
9465 @item -momit-leaf-frame-pointer
9466 @opindex momit-leaf-frame-pointer
9467 Don't keep the frame pointer in a register for leaf functions.  This
9468 avoids the instructions to save, set up and restore frame pointers and
9469 makes an extra register available in leaf functions.  The option
9470 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9471 which might make debugging harder.
9473 @item -mtls-direct-seg-refs
9474 @itemx -mno-tls-direct-seg-refs
9475 @opindex mtls-direct-seg-refs
9476 Controls whether TLS variables may be accessed with offsets from the
9477 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9478 or whether the thread base pointer must be added.  Whether or not this
9479 is legal depends on the operating system, and whether it maps the
9480 segment to cover the entire TLS area.
9482 For systems that use GNU libc, the default is on.
9483 @end table
9485 These @samp{-m} switches are supported in addition to the above
9486 on AMD x86-64 processors in 64-bit environments.
9488 @table @gcctabopt
9489 @item -m32
9490 @itemx -m64
9491 @opindex m32
9492 @opindex m64
9493 Generate code for a 32-bit or 64-bit environment.
9494 The 32-bit environment sets int, long and pointer to 32 bits and
9495 generates code that runs on any i386 system.
9496 The 64-bit environment sets int to 32 bits and long and pointer
9497 to 64 bits and generates code for AMD's x86-64 architecture.
9499 @item -mno-red-zone
9500 @opindex no-red-zone
9501 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9502 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9503 stack pointer that will not be modified by signal or interrupt handlers
9504 and therefore can be used for temporary data without adjusting the stack
9505 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9507 @item -mcmodel=small
9508 @opindex mcmodel=small
9509 Generate code for the small code model: the program and its symbols must
9510 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9511 Programs can be statically or dynamically linked.  This is the default
9512 code model.
9514 @item -mcmodel=kernel
9515 @opindex mcmodel=kernel
9516 Generate code for the kernel code model.  The kernel runs in the
9517 negative 2 GB of the address space.
9518 This model has to be used for Linux kernel code.
9520 @item -mcmodel=medium
9521 @opindex mcmodel=medium
9522 Generate code for the medium model: The program is linked in the lower 2
9523 GB of the address space but symbols can be located anywhere in the
9524 address space.  Programs can be statically or dynamically linked, but
9525 building of shared libraries are not supported with the medium model.
9527 @item -mcmodel=large
9528 @opindex mcmodel=large
9529 Generate code for the large model: This model makes no assumptions
9530 about addresses and sizes of sections.  Currently GCC does not implement
9531 this model.
9532 @end table
9534 @node IA-64 Options
9535 @subsection IA-64 Options
9536 @cindex IA-64 Options
9538 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9540 @table @gcctabopt
9541 @item -mbig-endian
9542 @opindex mbig-endian
9543 Generate code for a big endian target.  This is the default for HP-UX@.
9545 @item -mlittle-endian
9546 @opindex mlittle-endian
9547 Generate code for a little endian target.  This is the default for AIX5
9548 and GNU/Linux.
9550 @item -mgnu-as
9551 @itemx -mno-gnu-as
9552 @opindex mgnu-as
9553 @opindex mno-gnu-as
9554 Generate (or don't) code for the GNU assembler.  This is the default.
9555 @c Also, this is the default if the configure option @option{--with-gnu-as}
9556 @c is used.
9558 @item -mgnu-ld
9559 @itemx -mno-gnu-ld
9560 @opindex mgnu-ld
9561 @opindex mno-gnu-ld
9562 Generate (or don't) code for the GNU linker.  This is the default.
9563 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9564 @c is used.
9566 @item -mno-pic
9567 @opindex mno-pic
9568 Generate code that does not use a global pointer register.  The result
9569 is not position independent code, and violates the IA-64 ABI@.
9571 @item -mvolatile-asm-stop
9572 @itemx -mno-volatile-asm-stop
9573 @opindex mvolatile-asm-stop
9574 @opindex mno-volatile-asm-stop
9575 Generate (or don't) a stop bit immediately before and after volatile asm
9576 statements.
9578 @item -mregister-names
9579 @itemx -mno-register-names
9580 @opindex mregister-names
9581 @opindex mno-register-names
9582 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9583 the stacked registers.  This may make assembler output more readable.
9585 @item -mno-sdata
9586 @itemx -msdata
9587 @opindex mno-sdata
9588 @opindex msdata
9589 Disable (or enable) optimizations that use the small data section.  This may
9590 be useful for working around optimizer bugs.
9592 @item -mconstant-gp
9593 @opindex mconstant-gp
9594 Generate code that uses a single constant global pointer value.  This is
9595 useful when compiling kernel code.
9597 @item -mauto-pic
9598 @opindex mauto-pic
9599 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9600 This is useful when compiling firmware code.
9602 @item -minline-float-divide-min-latency
9603 @opindex minline-float-divide-min-latency
9604 Generate code for inline divides of floating point values
9605 using the minimum latency algorithm.
9607 @item -minline-float-divide-max-throughput
9608 @opindex minline-float-divide-max-throughput
9609 Generate code for inline divides of floating point values
9610 using the maximum throughput algorithm.
9612 @item -minline-int-divide-min-latency
9613 @opindex minline-int-divide-min-latency
9614 Generate code for inline divides of integer values
9615 using the minimum latency algorithm.
9617 @item -minline-int-divide-max-throughput
9618 @opindex minline-int-divide-max-throughput
9619 Generate code for inline divides of integer values
9620 using the maximum throughput algorithm.
9622 @item -minline-sqrt-min-latency
9623 @opindex minline-sqrt-min-latency
9624 Generate code for inline square roots
9625 using the minimum latency algorithm.
9627 @item -minline-sqrt-max-throughput
9628 @opindex minline-sqrt-max-throughput
9629 Generate code for inline square roots
9630 using the maximum throughput algorithm.
9632 @item -mno-dwarf2-asm
9633 @itemx -mdwarf2-asm
9634 @opindex mno-dwarf2-asm
9635 @opindex mdwarf2-asm
9636 Don't (or do) generate assembler code for the DWARF2 line number debugging
9637 info.  This may be useful when not using the GNU assembler.
9639 @item -mearly-stop-bits
9640 @itemx -mno-early-stop-bits
9641 @opindex mearly-stop-bits
9642 @opindex mno-early-stop-bits
9643 Allow stop bits to be placed earlier than immediately preceding the
9644 instruction that triggered the stop bit.  This can improve instruction
9645 scheduling, but does not always do so.
9647 @item -mfixed-range=@var{register-range}
9648 @opindex mfixed-range
9649 Generate code treating the given register range as fixed registers.
9650 A fixed register is one that the register allocator can not use.  This is
9651 useful when compiling kernel code.  A register range is specified as
9652 two registers separated by a dash.  Multiple register ranges can be
9653 specified separated by a comma.
9655 @item -mtls-size=@var{tls-size}
9656 @opindex mtls-size
9657 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9660 @item -mtune=@var{cpu-type}
9661 @opindex mtune
9662 Tune the instruction scheduling for a particular CPU, Valid values are
9663 itanium, itanium1, merced, itanium2, and mckinley.
9665 @item -mt
9666 @itemx -pthread
9667 @opindex mt
9668 @opindex pthread
9669 Add support for multithreading using the POSIX threads library.  This
9670 option sets flags for both the preprocessor and linker.  It does
9671 not affect the thread safety of object code produced by the compiler or
9672 that of libraries supplied with it.  These are HP-UX specific flags.
9674 @item -milp32
9675 @itemx -mlp64
9676 @opindex milp32
9677 @opindex mlp64
9678 Generate code for a 32-bit or 64-bit environment.
9679 The 32-bit environment sets int, long and pointer to 32 bits.
9680 The 64-bit environment sets int to 32 bits and long and pointer
9681 to 64 bits.  These are HP-UX specific flags.
9683 @end table
9685 @node M32C Options
9686 @subsection M32C Options
9687 @cindex M32C options
9689 @table @gcctabopt
9690 @item -mcpu=@var{name}
9691 @opindex mcpu=
9692 Select the CPU for which code is generated.  @var{name} may be one of
9693 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9694 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9695 the M32C/80 series.
9697 @item -msim
9698 @opindex msim
9699 Specifies that the program will be run on the simulator.  This causes
9700 an alternate runtime library to be linked in which supports, for
9701 example, file I/O.  You must not use this option when generating
9702 programs that will run on real hardware; you must provide your own
9703 runtime library for whatever I/O functions are needed.
9705 @item -memregs=@var{number}
9706 @opindex memregs=
9707 Specifies the number of memory-based pseudo-registers GCC will use
9708 during code generation.  These pseudo-registers will be used like real
9709 registers, so there is a tradeoff between GCC's ability to fit the
9710 code into available registers, and the performance penalty of using
9711 memory instead of registers.  Note that all modules in a program must
9712 be compiled with the same value for this option.  Because of that, you
9713 must not use this option with the default runtime libraries gcc
9714 builds.
9716 @end table
9718 @node M32R/D Options
9719 @subsection M32R/D Options
9720 @cindex M32R/D options
9722 These @option{-m} options are defined for Renesas M32R/D architectures:
9724 @table @gcctabopt
9725 @item -m32r2
9726 @opindex m32r2
9727 Generate code for the M32R/2@.
9729 @item -m32rx
9730 @opindex m32rx
9731 Generate code for the M32R/X@.
9733 @item -m32r
9734 @opindex m32r
9735 Generate code for the M32R@.  This is the default.
9737 @item -mmodel=small
9738 @opindex mmodel=small
9739 Assume all objects live in the lower 16MB of memory (so that their addresses
9740 can be loaded with the @code{ld24} instruction), and assume all subroutines
9741 are reachable with the @code{bl} instruction.
9742 This is the default.
9744 The addressability of a particular object can be set with the
9745 @code{model} attribute.
9747 @item -mmodel=medium
9748 @opindex mmodel=medium
9749 Assume objects may be anywhere in the 32-bit address space (the compiler
9750 will generate @code{seth/add3} instructions to load their addresses), and
9751 assume all subroutines are reachable with the @code{bl} instruction.
9753 @item -mmodel=large
9754 @opindex mmodel=large
9755 Assume objects may be anywhere in the 32-bit address space (the compiler
9756 will generate @code{seth/add3} instructions to load their addresses), and
9757 assume subroutines may not be reachable with the @code{bl} instruction
9758 (the compiler will generate the much slower @code{seth/add3/jl}
9759 instruction sequence).
9761 @item -msdata=none
9762 @opindex msdata=none
9763 Disable use of the small data area.  Variables will be put into
9764 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9765 @code{section} attribute has been specified).
9766 This is the default.
9768 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9769 Objects may be explicitly put in the small data area with the
9770 @code{section} attribute using one of these sections.
9772 @item -msdata=sdata
9773 @opindex msdata=sdata
9774 Put small global and static data in the small data area, but do not
9775 generate special code to reference them.
9777 @item -msdata=use
9778 @opindex msdata=use
9779 Put small global and static data in the small data area, and generate
9780 special instructions to reference them.
9782 @item -G @var{num}
9783 @opindex G
9784 @cindex smaller data references
9785 Put global and static objects less than or equal to @var{num} bytes
9786 into the small data or bss sections instead of the normal data or bss
9787 sections.  The default value of @var{num} is 8.
9788 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9789 for this option to have any effect.
9791 All modules should be compiled with the same @option{-G @var{num}} value.
9792 Compiling with different values of @var{num} may or may not work; if it
9793 doesn't the linker will give an error message---incorrect code will not be
9794 generated.
9796 @item -mdebug
9797 @opindex mdebug
9798 Makes the M32R specific code in the compiler display some statistics
9799 that might help in debugging programs.
9801 @item -malign-loops
9802 @opindex malign-loops
9803 Align all loops to a 32-byte boundary.
9805 @item -mno-align-loops
9806 @opindex mno-align-loops
9807 Do not enforce a 32-byte alignment for loops.  This is the default.
9809 @item -missue-rate=@var{number}
9810 @opindex missue-rate=@var{number}
9811 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9812 or 2.
9814 @item -mbranch-cost=@var{number}
9815 @opindex mbranch-cost=@var{number}
9816 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9817 preferred over conditional code, if it is 2, then the opposite will
9818 apply.
9820 @item -mflush-trap=@var{number}
9821 @opindex mflush-trap=@var{number}
9822 Specifies the trap number to use to flush the cache.  The default is
9823 12.  Valid numbers are between 0 and 15 inclusive.
9825 @item -mno-flush-trap
9826 @opindex mno-flush-trap
9827 Specifies that the cache cannot be flushed by using a trap.
9829 @item -mflush-func=@var{name}
9830 @opindex mflush-func=@var{name}
9831 Specifies the name of the operating system function to call to flush
9832 the cache.  The default is @emph{_flush_cache}, but a function call
9833 will only be used if a trap is not available.
9835 @item -mno-flush-func
9836 @opindex mno-flush-func
9837 Indicates that there is no OS function for flushing the cache.
9839 @end table
9841 @node M680x0 Options
9842 @subsection M680x0 Options
9843 @cindex M680x0 options
9845 These are the @samp{-m} options defined for the 68000 series.  The default
9846 values for these options depends on which style of 68000 was selected when
9847 the compiler was configured; the defaults for the most common choices are
9848 given below.
9850 @table @gcctabopt
9851 @item -m68000
9852 @itemx -mc68000
9853 @opindex m68000
9854 @opindex mc68000
9855 Generate output for a 68000.  This is the default
9856 when the compiler is configured for 68000-based systems.
9858 Use this option for microcontrollers with a 68000 or EC000 core,
9859 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9861 @item -m68020
9862 @itemx -mc68020
9863 @opindex m68020
9864 @opindex mc68020
9865 Generate output for a 68020.  This is the default
9866 when the compiler is configured for 68020-based systems.
9868 @item -m68881
9869 @opindex m68881
9870 Generate output containing 68881 instructions for floating point.
9871 This is the default for most 68020 systems unless @option{--nfp} was
9872 specified when the compiler was configured.
9874 @item -m68030
9875 @opindex m68030
9876 Generate output for a 68030.  This is the default when the compiler is
9877 configured for 68030-based systems.
9879 @item -m68040
9880 @opindex m68040
9881 Generate output for a 68040.  This is the default when the compiler is
9882 configured for 68040-based systems.
9884 This option inhibits the use of 68881/68882 instructions that have to be
9885 emulated by software on the 68040.  Use this option if your 68040 does not
9886 have code to emulate those instructions.
9888 @item -m68060
9889 @opindex m68060
9890 Generate output for a 68060.  This is the default when the compiler is
9891 configured for 68060-based systems.
9893 This option inhibits the use of 68020 and 68881/68882 instructions that
9894 have to be emulated by software on the 68060.  Use this option if your 68060
9895 does not have code to emulate those instructions.
9897 @item -mcpu32
9898 @opindex mcpu32
9899 Generate output for a CPU32.  This is the default
9900 when the compiler is configured for CPU32-based systems.
9902 Use this option for microcontrollers with a
9903 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9904 68336, 68340, 68341, 68349 and 68360.
9906 @item -m5200
9907 @opindex m5200
9908 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9909 when the compiler is configured for 520X-based systems.
9911 Use this option for microcontroller with a 5200 core, including
9912 the MCF5202, MCF5203, MCF5204 and MCF5202.
9914 @item -mcfv4e
9915 @opindex mcfv4e
9916 Generate output for a ColdFire V4e family cpu (e.g.@: 547x/548x).
9917 This includes use of hardware floating point instructions.
9919 @item -m68020-40
9920 @opindex m68020-40
9921 Generate output for a 68040, without using any of the new instructions.
9922 This results in code which can run relatively efficiently on either a
9923 68020/68881 or a 68030 or a 68040.  The generated code does use the
9924 68881 instructions that are emulated on the 68040.
9926 @item -m68020-60
9927 @opindex m68020-60
9928 Generate output for a 68060, without using any of the new instructions.
9929 This results in code which can run relatively efficiently on either a
9930 68020/68881 or a 68030 or a 68040.  The generated code does use the
9931 68881 instructions that are emulated on the 68060.
9933 @item -msoft-float
9934 @opindex msoft-float
9935 Generate output containing library calls for floating point.
9936 @strong{Warning:} the requisite libraries are not available for all m68k
9937 targets.  Normally the facilities of the machine's usual C compiler are
9938 used, but this can't be done directly in cross-compilation.  You must
9939 make your own arrangements to provide suitable library functions for
9940 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9941 @samp{m68k-*-coff} do provide software floating point support.
9943 @item -mshort
9944 @opindex mshort
9945 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9946 Additionally, parameters passed on the stack are also aligned to a
9947 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9949 @item -mnobitfield
9950 @opindex mnobitfield
9951 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9952 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9954 @item -mbitfield
9955 @opindex mbitfield
9956 Do use the bit-field instructions.  The @option{-m68020} option implies
9957 @option{-mbitfield}.  This is the default if you use a configuration
9958 designed for a 68020.
9960 @item -mrtd
9961 @opindex mrtd
9962 Use a different function-calling convention, in which functions
9963 that take a fixed number of arguments return with the @code{rtd}
9964 instruction, which pops their arguments while returning.  This
9965 saves one instruction in the caller since there is no need to pop
9966 the arguments there.
9968 This calling convention is incompatible with the one normally
9969 used on Unix, so you cannot use it if you need to call libraries
9970 compiled with the Unix compiler.
9972 Also, you must provide function prototypes for all functions that
9973 take variable numbers of arguments (including @code{printf});
9974 otherwise incorrect code will be generated for calls to those
9975 functions.
9977 In addition, seriously incorrect code will result if you call a
9978 function with too many arguments.  (Normally, extra arguments are
9979 harmlessly ignored.)
9981 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9982 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9984 @item -malign-int
9985 @itemx -mno-align-int
9986 @opindex malign-int
9987 @opindex mno-align-int
9988 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9989 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9990 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9991 Aligning variables on 32-bit boundaries produces code that runs somewhat
9992 faster on processors with 32-bit busses at the expense of more memory.
9994 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9995 align structures containing the above types  differently than
9996 most published application binary interface specifications for the m68k.
9998 @item -mpcrel
9999 @opindex mpcrel
10000 Use the pc-relative addressing mode of the 68000 directly, instead of
10001 using a global offset table.  At present, this option implies @option{-fpic},
10002 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
10003 not presently supported with @option{-mpcrel}, though this could be supported for
10004 68020 and higher processors.
10006 @item -mno-strict-align
10007 @itemx -mstrict-align
10008 @opindex mno-strict-align
10009 @opindex mstrict-align
10010 Do not (do) assume that unaligned memory references will be handled by
10011 the system.
10013 @item -msep-data
10014 Generate code that allows the data segment to be located in a different
10015 area of memory from the text segment.  This allows for execute in place in
10016 an environment without virtual memory management.  This option implies
10017 @option{-fPIC}.
10019 @item -mno-sep-data
10020 Generate code that assumes that the data segment follows the text segment.
10021 This is the default.
10023 @item -mid-shared-library
10024 Generate code that supports shared libraries via the library ID method.
10025 This allows for execute in place and shared libraries in an environment
10026 without virtual memory management.  This option implies @option{-fPIC}.
10028 @item -mno-id-shared-library
10029 Generate code that doesn't assume ID based shared libraries are being used.
10030 This is the default.
10032 @item -mshared-library-id=n
10033 Specified the identification number of the ID based shared library being
10034 compiled.  Specifying a value of 0 will generate more compact code, specifying
10035 other values will force the allocation of that number to the current
10036 library but is no more space or time efficient than omitting this option.
10038 @end table
10040 @node M68hc1x Options
10041 @subsection M68hc1x Options
10042 @cindex M68hc1x options
10044 These are the @samp{-m} options defined for the 68hc11 and 68hc12
10045 microcontrollers.  The default values for these options depends on
10046 which style of microcontroller was selected when the compiler was configured;
10047 the defaults for the most common choices are given below.
10049 @table @gcctabopt
10050 @item -m6811
10051 @itemx -m68hc11
10052 @opindex m6811
10053 @opindex m68hc11
10054 Generate output for a 68HC11.  This is the default
10055 when the compiler is configured for 68HC11-based systems.
10057 @item -m6812
10058 @itemx -m68hc12
10059 @opindex m6812
10060 @opindex m68hc12
10061 Generate output for a 68HC12.  This is the default
10062 when the compiler is configured for 68HC12-based systems.
10064 @item -m68S12
10065 @itemx -m68hcs12
10066 @opindex m68S12
10067 @opindex m68hcs12
10068 Generate output for a 68HCS12.
10070 @item -mauto-incdec
10071 @opindex mauto-incdec
10072 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10073 addressing modes.
10075 @item -minmax
10076 @itemx -nominmax
10077 @opindex minmax
10078 @opindex mnominmax
10079 Enable the use of 68HC12 min and max instructions.
10081 @item -mlong-calls
10082 @itemx -mno-long-calls
10083 @opindex mlong-calls
10084 @opindex mno-long-calls
10085 Treat all calls as being far away (near).  If calls are assumed to be
10086 far away, the compiler will use the @code{call} instruction to
10087 call a function and the @code{rtc} instruction for returning.
10089 @item -mshort
10090 @opindex mshort
10091 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10093 @item -msoft-reg-count=@var{count}
10094 @opindex msoft-reg-count
10095 Specify the number of pseudo-soft registers which are used for the
10096 code generation.  The maximum number is 32.  Using more pseudo-soft
10097 register may or may not result in better code depending on the program.
10098 The default is 4 for 68HC11 and 2 for 68HC12.
10100 @end table
10102 @node MCore Options
10103 @subsection MCore Options
10104 @cindex MCore options
10106 These are the @samp{-m} options defined for the Motorola M*Core
10107 processors.
10109 @table @gcctabopt
10111 @item -mhardlit
10112 @itemx -mno-hardlit
10113 @opindex mhardlit
10114 @opindex mno-hardlit
10115 Inline constants into the code stream if it can be done in two
10116 instructions or less.
10118 @item -mdiv
10119 @itemx -mno-div
10120 @opindex mdiv
10121 @opindex mno-div
10122 Use the divide instruction.  (Enabled by default).
10124 @item -mrelax-immediate
10125 @itemx -mno-relax-immediate
10126 @opindex mrelax-immediate
10127 @opindex mno-relax-immediate
10128 Allow arbitrary sized immediates in bit operations.
10130 @item -mwide-bitfields
10131 @itemx -mno-wide-bitfields
10132 @opindex mwide-bitfields
10133 @opindex mno-wide-bitfields
10134 Always treat bit-fields as int-sized.
10136 @item -m4byte-functions
10137 @itemx -mno-4byte-functions
10138 @opindex m4byte-functions
10139 @opindex mno-4byte-functions
10140 Force all functions to be aligned to a four byte boundary.
10142 @item -mcallgraph-data
10143 @itemx -mno-callgraph-data
10144 @opindex mcallgraph-data
10145 @opindex mno-callgraph-data
10146 Emit callgraph information.
10148 @item -mslow-bytes
10149 @itemx -mno-slow-bytes
10150 @opindex mslow-bytes
10151 @opindex mno-slow-bytes
10152 Prefer word access when reading byte quantities.
10154 @item -mlittle-endian
10155 @itemx -mbig-endian
10156 @opindex mlittle-endian
10157 @opindex mbig-endian
10158 Generate code for a little endian target.
10160 @item -m210
10161 @itemx -m340
10162 @opindex m210
10163 @opindex m340
10164 Generate code for the 210 processor.
10165 @end table
10167 @node MIPS Options
10168 @subsection MIPS Options
10169 @cindex MIPS options
10171 @table @gcctabopt
10173 @item -EB
10174 @opindex EB
10175 Generate big-endian code.
10177 @item -EL
10178 @opindex EL
10179 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10180 configurations.
10182 @item -march=@var{arch}
10183 @opindex march
10184 Generate code that will run on @var{arch}, which can be the name of a
10185 generic MIPS ISA, or the name of a particular processor.
10186 The ISA names are:
10187 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10188 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10189 The processor names are:
10190 @samp{4kc}, @samp{4km}, @samp{4kp},
10191 @samp{5kc}, @samp{5kf},
10192 @samp{20kc},
10193 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10194 @samp{m4k},
10195 @samp{orion},
10196 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10197 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10198 @samp{rm7000}, @samp{rm9000},
10199 @samp{sb1},
10200 @samp{sr71000},
10201 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10202 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10203 The special value @samp{from-abi} selects the
10204 most compatible architecture for the selected ABI (that is,
10205 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10207 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10208 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10209 @samp{vr} may be written @samp{r}.
10211 GCC defines two macros based on the value of this option.  The first
10212 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10213 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10214 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10215 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10216 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10218 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10219 above.  In other words, it will have the full prefix and will not
10220 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10221 the macro names the resolved architecture (either @samp{"mips1"} or
10222 @samp{"mips3"}).  It names the default architecture when no
10223 @option{-march} option is given.
10225 @item -mtune=@var{arch}
10226 @opindex mtune
10227 Optimize for @var{arch}.  Among other things, this option controls
10228 the way instructions are scheduled, and the perceived cost of arithmetic
10229 operations.  The list of @var{arch} values is the same as for
10230 @option{-march}.
10232 When this option is not used, GCC will optimize for the processor
10233 specified by @option{-march}.  By using @option{-march} and
10234 @option{-mtune} together, it is possible to generate code that will
10235 run on a family of processors, but optimize the code for one
10236 particular member of that family.
10238 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10239 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10240 @samp{-march} ones described above.
10242 @item -mips1
10243 @opindex mips1
10244 Equivalent to @samp{-march=mips1}.
10246 @item -mips2
10247 @opindex mips2
10248 Equivalent to @samp{-march=mips2}.
10250 @item -mips3
10251 @opindex mips3
10252 Equivalent to @samp{-march=mips3}.
10254 @item -mips4
10255 @opindex mips4
10256 Equivalent to @samp{-march=mips4}.
10258 @item -mips32
10259 @opindex mips32
10260 Equivalent to @samp{-march=mips32}.
10262 @item -mips32r2
10263 @opindex mips32r2
10264 Equivalent to @samp{-march=mips32r2}.
10266 @item -mips64
10267 @opindex mips64
10268 Equivalent to @samp{-march=mips64}.
10270 @item -mips16
10271 @itemx -mno-mips16
10272 @opindex mips16
10273 @opindex mno-mips16
10274 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10275 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10277 @item -mabi=32
10278 @itemx -mabi=o64
10279 @itemx -mabi=n32
10280 @itemx -mabi=64
10281 @itemx -mabi=eabi
10282 @opindex mabi=32
10283 @opindex mabi=o64
10284 @opindex mabi=n32
10285 @opindex mabi=64
10286 @opindex mabi=eabi
10287 Generate code for the given ABI@.
10289 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10290 generates 64-bit code when you select a 64-bit architecture, but you
10291 can use @option{-mgp32} to get 32-bit code instead.
10293 For information about the O64 ABI, see
10294 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10296 @item -mabicalls
10297 @itemx -mno-abicalls
10298 @opindex mabicalls
10299 @opindex mno-abicalls
10300 Generate (do not generate) SVR4-style position-independent code.
10301 @option{-mabicalls} is the default for SVR4-based systems.
10303 @item -mxgot
10304 @itemx -mno-xgot
10305 @opindex mxgot
10306 @opindex mno-xgot
10307 Lift (do not lift) the usual restrictions on the size of the global
10308 offset table.
10310 GCC normally uses a single instruction to load values from the GOT@.
10311 While this is relatively efficient, it will only work if the GOT
10312 is smaller than about 64k.  Anything larger will cause the linker
10313 to report an error such as:
10315 @cindex relocation truncated to fit (MIPS)
10316 @smallexample
10317 relocation truncated to fit: R_MIPS_GOT16 foobar
10318 @end smallexample
10320 If this happens, you should recompile your code with @option{-mxgot}.
10321 It should then work with very large GOTs, although it will also be
10322 less efficient, since it will take three instructions to fetch the
10323 value of a global symbol.
10325 Note that some linkers can create multiple GOTs.  If you have such a
10326 linker, you should only need to use @option{-mxgot} when a single object
10327 file accesses more than 64k's worth of GOT entries.  Very few do.
10329 These options have no effect unless GCC is generating position
10330 independent code.
10332 @item -mgp32
10333 @opindex mgp32
10334 Assume that general-purpose registers are 32 bits wide.
10336 @item -mgp64
10337 @opindex mgp64
10338 Assume that general-purpose registers are 64 bits wide.
10340 @item -mfp32
10341 @opindex mfp32
10342 Assume that floating-point registers are 32 bits wide.
10344 @item -mfp64
10345 @opindex mfp64
10346 Assume that floating-point registers are 64 bits wide.
10348 @item -mhard-float
10349 @opindex mhard-float
10350 Use floating-point coprocessor instructions.
10352 @item -msoft-float
10353 @opindex msoft-float
10354 Do not use floating-point coprocessor instructions.  Implement
10355 floating-point calculations using library calls instead.
10357 @item -msingle-float
10358 @opindex msingle-float
10359 Assume that the floating-point coprocessor only supports single-precision
10360 operations.
10362 @itemx -mdouble-float
10363 @opindex mdouble-float
10364 Assume that the floating-point coprocessor supports double-precision
10365 operations.  This is the default.
10367 @itemx -mdsp
10368 @itemx -mno-dsp
10369 @opindex mdsp
10370 @opindex mno-dsp
10371 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10373 @itemx -mpaired-single
10374 @itemx -mno-paired-single
10375 @opindex mpaired-single
10376 @opindex mno-paired-single
10377 Use (do not use) paired-single floating-point instructions.
10378 @xref{MIPS Paired-Single Support}.  This option can only be used
10379 when generating 64-bit code and requires hardware floating-point
10380 support to be enabled.
10382 @itemx -mips3d
10383 @itemx -mno-mips3d
10384 @opindex mips3d
10385 @opindex mno-mips3d
10386 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10387 The option @option{-mips3d} implies @option{-mpaired-single}.
10389 @item -mlong64
10390 @opindex mlong64
10391 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10392 an explanation of the default and the way that the pointer size is
10393 determined.
10395 @item -mlong32
10396 @opindex mlong32
10397 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10399 The default size of @code{int}s, @code{long}s and pointers depends on
10400 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10401 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10402 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10403 or the same size as integer registers, whichever is smaller.
10405 @item -msym32
10406 @itemx -mno-sym32
10407 @opindex msym32
10408 @opindex mno-sym32
10409 Assume (do not assume) that all symbols have 32-bit values, regardless
10410 of the selected ABI@.  This option is useful in combination with
10411 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10412 to generate shorter and faster references to symbolic addresses.
10414 @item -G @var{num}
10415 @opindex G
10416 @cindex smaller data references (MIPS)
10417 @cindex gp-relative references (MIPS)
10418 Put global and static items less than or equal to @var{num} bytes into
10419 the small data or bss section instead of the normal data or bss section.
10420 This allows the data to be accessed using a single instruction.
10422 All modules should be compiled with the same @option{-G @var{num}}
10423 value.
10425 @item -membedded-data
10426 @itemx -mno-embedded-data
10427 @opindex membedded-data
10428 @opindex mno-embedded-data
10429 Allocate variables to the read-only data section first if possible, then
10430 next in the small data section if possible, otherwise in data.  This gives
10431 slightly slower code than the default, but reduces the amount of RAM required
10432 when executing, and thus may be preferred for some embedded systems.
10434 @item -muninit-const-in-rodata
10435 @itemx -mno-uninit-const-in-rodata
10436 @opindex muninit-const-in-rodata
10437 @opindex mno-uninit-const-in-rodata
10438 Put uninitialized @code{const} variables in the read-only data section.
10439 This option is only meaningful in conjunction with @option{-membedded-data}.
10441 @item -msplit-addresses
10442 @itemx -mno-split-addresses
10443 @opindex msplit-addresses
10444 @opindex mno-split-addresses
10445 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10446 relocation operators.  This option has been superseded by
10447 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10449 @item -mexplicit-relocs
10450 @itemx -mno-explicit-relocs
10451 @opindex mexplicit-relocs
10452 @opindex mno-explicit-relocs
10453 Use (do not use) assembler relocation operators when dealing with symbolic
10454 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10455 is to use assembler macros instead.
10457 @option{-mexplicit-relocs} is the default if GCC was configured
10458 to use an assembler that supports relocation operators.
10460 @item -mcheck-zero-division
10461 @itemx -mno-check-zero-division
10462 @opindex mcheck-zero-division
10463 @opindex mno-check-zero-division
10464 Trap (do not trap) on integer division by zero.  The default is
10465 @option{-mcheck-zero-division}.
10467 @item -mdivide-traps
10468 @itemx -mdivide-breaks
10469 @opindex mdivide-traps
10470 @opindex mdivide-breaks
10471 MIPS systems check for division by zero by generating either a
10472 conditional trap or a break instruction.  Using traps results in
10473 smaller code, but is only supported on MIPS II and later.  Also, some
10474 versions of the Linux kernel have a bug that prevents trap from
10475 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10476 allow conditional traps on architectures that support them and
10477 @option{-mdivide-breaks} to force the use of breaks.
10479 The default is usually @option{-mdivide-traps}, but this can be
10480 overridden at configure time using @option{--with-divide=breaks}.
10481 Divide-by-zero checks can be completely disabled using
10482 @option{-mno-check-zero-division}.
10484 @item -mmemcpy
10485 @itemx -mno-memcpy
10486 @opindex mmemcpy
10487 @opindex mno-memcpy
10488 Force (do not force) the use of @code{memcpy()} for non-trivial block
10489 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10490 most constant-sized copies.
10492 @item -mlong-calls
10493 @itemx -mno-long-calls
10494 @opindex mlong-calls
10495 @opindex mno-long-calls
10496 Disable (do not disable) use of the @code{jal} instruction.  Calling
10497 functions using @code{jal} is more efficient but requires the caller
10498 and callee to be in the same 256 megabyte segment.
10500 This option has no effect on abicalls code.  The default is
10501 @option{-mno-long-calls}.
10503 @item -mmad
10504 @itemx -mno-mad
10505 @opindex mmad
10506 @opindex mno-mad
10507 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10508 instructions, as provided by the R4650 ISA@.
10510 @item -mfused-madd
10511 @itemx -mno-fused-madd
10512 @opindex mfused-madd
10513 @opindex mno-fused-madd
10514 Enable (disable) use of the floating point multiply-accumulate
10515 instructions, when they are available.  The default is
10516 @option{-mfused-madd}.
10518 When multiply-accumulate instructions are used, the intermediate
10519 product is calculated to infinite precision and is not subject to
10520 the FCSR Flush to Zero bit.  This may be undesirable in some
10521 circumstances.
10523 @item -nocpp
10524 @opindex nocpp
10525 Tell the MIPS assembler to not run its preprocessor over user
10526 assembler files (with a @samp{.s} suffix) when assembling them.
10528 @item -mfix-r4000
10529 @itemx -mno-fix-r4000
10530 @opindex mfix-r4000
10531 @opindex mno-fix-r4000
10532 Work around certain R4000 CPU errata:
10533 @itemize @minus
10534 @item
10535 A double-word or a variable shift may give an incorrect result if executed
10536 immediately after starting an integer division.
10537 @item
10538 A double-word or a variable shift may give an incorrect result if executed
10539 while an integer multiplication is in progress.
10540 @item
10541 An integer division may give an incorrect result if started in a delay slot
10542 of a taken branch or a jump.
10543 @end itemize
10545 @item -mfix-r4400
10546 @itemx -mno-fix-r4400
10547 @opindex mfix-r4400
10548 @opindex mno-fix-r4400
10549 Work around certain R4400 CPU errata:
10550 @itemize @minus
10551 @item
10552 A double-word or a variable shift may give an incorrect result if executed
10553 immediately after starting an integer division.
10554 @end itemize
10556 @item -mfix-vr4120
10557 @itemx -mno-fix-vr4120
10558 @opindex mfix-vr4120
10559 Work around certain VR4120 errata:
10560 @itemize @minus
10561 @item
10562 @code{dmultu} does not always produce the correct result.
10563 @item
10564 @code{div} and @code{ddiv} do not always produce the correct result if one
10565 of the operands is negative.
10566 @end itemize
10567 The workarounds for the division errata rely on special functions in
10568 @file{libgcc.a}.  At present, these functions are only provided by
10569 the @code{mips64vr*-elf} configurations.
10571 Other VR4120 errata require a nop to be inserted between certain pairs of
10572 instructions.  These errata are handled by the assembler, not by GCC itself.
10574 @item -mfix-vr4130
10575 @opindex mfix-vr4130
10576 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10577 workarounds are implemented by the assembler rather than by GCC,
10578 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10579 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10580 instructions are available instead.
10582 @item -mfix-sb1
10583 @itemx -mno-fix-sb1
10584 @opindex mfix-sb1
10585 Work around certain SB-1 CPU core errata.
10586 (This flag currently works around the SB-1 revision 2
10587 ``F1'' and ``F2'' floating point errata.)
10589 @item -mflush-func=@var{func}
10590 @itemx -mno-flush-func
10591 @opindex mflush-func
10592 Specifies the function to call to flush the I and D caches, or to not
10593 call any such function.  If called, the function must take the same
10594 arguments as the common @code{_flush_func()}, that is, the address of the
10595 memory range for which the cache is being flushed, the size of the
10596 memory range, and the number 3 (to flush both caches).  The default
10597 depends on the target GCC was configured for, but commonly is either
10598 @samp{_flush_func} or @samp{__cpu_flush}.
10600 @item -mbranch-likely
10601 @itemx -mno-branch-likely
10602 @opindex mbranch-likely
10603 @opindex mno-branch-likely
10604 Enable or disable use of Branch Likely instructions, regardless of the
10605 default for the selected architecture.  By default, Branch Likely
10606 instructions may be generated if they are supported by the selected
10607 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10608 and processors which implement those architectures; for those, Branch
10609 Likely instructions will not be generated by default because the MIPS32
10610 and MIPS64 architectures specifically deprecate their use.
10612 @item -mfp-exceptions
10613 @itemx -mno-fp-exceptions
10614 @opindex mfp-exceptions
10615 Specifies whether FP exceptions are enabled.  This affects how we schedule
10616 FP instructions for some processors.  The default is that FP exceptions are
10617 enabled.
10619 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10620 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10621 FP pipe.
10623 @item -mvr4130-align
10624 @itemx -mno-vr4130-align
10625 @opindex mvr4130-align
10626 The VR4130 pipeline is two-way superscalar, but can only issue two
10627 instructions together if the first one is 8-byte aligned.  When this
10628 option is enabled, GCC will align pairs of instructions that it
10629 thinks should execute in parallel.
10631 This option only has an effect when optimizing for the VR4130.
10632 It normally makes code faster, but at the expense of making it bigger.
10633 It is enabled by default at optimization level @option{-O3}.
10634 @end table
10636 @node MMIX Options
10637 @subsection MMIX Options
10638 @cindex MMIX Options
10640 These options are defined for the MMIX:
10642 @table @gcctabopt
10643 @item -mlibfuncs
10644 @itemx -mno-libfuncs
10645 @opindex mlibfuncs
10646 @opindex mno-libfuncs
10647 Specify that intrinsic library functions are being compiled, passing all
10648 values in registers, no matter the size.
10650 @item -mepsilon
10651 @itemx -mno-epsilon
10652 @opindex mepsilon
10653 @opindex mno-epsilon
10654 Generate floating-point comparison instructions that compare with respect
10655 to the @code{rE} epsilon register.
10657 @item -mabi=mmixware
10658 @itemx -mabi=gnu
10659 @opindex mabi-mmixware
10660 @opindex mabi=gnu
10661 Generate code that passes function parameters and return values that (in
10662 the called function) are seen as registers @code{$0} and up, as opposed to
10663 the GNU ABI which uses global registers @code{$231} and up.
10665 @item -mzero-extend
10666 @itemx -mno-zero-extend
10667 @opindex mzero-extend
10668 @opindex mno-zero-extend
10669 When reading data from memory in sizes shorter than 64 bits, use (do not
10670 use) zero-extending load instructions by default, rather than
10671 sign-extending ones.
10673 @item -mknuthdiv
10674 @itemx -mno-knuthdiv
10675 @opindex mknuthdiv
10676 @opindex mno-knuthdiv
10677 Make the result of a division yielding a remainder have the same sign as
10678 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10679 remainder follows the sign of the dividend.  Both methods are
10680 arithmetically valid, the latter being almost exclusively used.
10682 @item -mtoplevel-symbols
10683 @itemx -mno-toplevel-symbols
10684 @opindex mtoplevel-symbols
10685 @opindex mno-toplevel-symbols
10686 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10687 code can be used with the @code{PREFIX} assembly directive.
10689 @item -melf
10690 @opindex melf
10691 Generate an executable in the ELF format, rather than the default
10692 @samp{mmo} format used by the @command{mmix} simulator.
10694 @item -mbranch-predict
10695 @itemx -mno-branch-predict
10696 @opindex mbranch-predict
10697 @opindex mno-branch-predict
10698 Use (do not use) the probable-branch instructions, when static branch
10699 prediction indicates a probable branch.
10701 @item -mbase-addresses
10702 @itemx -mno-base-addresses
10703 @opindex mbase-addresses
10704 @opindex mno-base-addresses
10705 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10706 base address automatically generates a request (handled by the assembler
10707 and the linker) for a constant to be set up in a global register.  The
10708 register is used for one or more base address requests within the range 0
10709 to 255 from the value held in the register.  The generally leads to short
10710 and fast code, but the number of different data items that can be
10711 addressed is limited.  This means that a program that uses lots of static
10712 data may require @option{-mno-base-addresses}.
10714 @item -msingle-exit
10715 @itemx -mno-single-exit
10716 @opindex msingle-exit
10717 @opindex mno-single-exit
10718 Force (do not force) generated code to have a single exit point in each
10719 function.
10720 @end table
10722 @node MN10300 Options
10723 @subsection MN10300 Options
10724 @cindex MN10300 options
10726 These @option{-m} options are defined for Matsushita MN10300 architectures:
10728 @table @gcctabopt
10729 @item -mmult-bug
10730 @opindex mmult-bug
10731 Generate code to avoid bugs in the multiply instructions for the MN10300
10732 processors.  This is the default.
10734 @item -mno-mult-bug
10735 @opindex mno-mult-bug
10736 Do not generate code to avoid bugs in the multiply instructions for the
10737 MN10300 processors.
10739 @item -mam33
10740 @opindex mam33
10741 Generate code which uses features specific to the AM33 processor.
10743 @item -mno-am33
10744 @opindex mno-am33
10745 Do not generate code which uses features specific to the AM33 processor.  This
10746 is the default.
10748 @item -mreturn-pointer-on-d0
10749 @opindex mreturn-pointer-on-d0
10750 When generating a function which returns a pointer, return the pointer
10751 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
10752 only in a0, and attempts to call such functions without a prototype
10753 would result in errors.  Note that this option is on by default; use
10754 @option{-mno-return-pointer-on-d0} to disable it.
10756 @item -mno-crt0
10757 @opindex mno-crt0
10758 Do not link in the C run-time initialization object file.
10760 @item -mrelax
10761 @opindex mrelax
10762 Indicate to the linker that it should perform a relaxation optimization pass
10763 to shorten branches, calls and absolute memory addresses.  This option only
10764 has an effect when used on the command line for the final link step.
10766 This option makes symbolic debugging impossible.
10767 @end table
10769 @node MT Options
10770 @subsection MT Options
10771 @cindex MT options
10773 These @option{-m} options are defined for Morpho MT architectures:
10775 @table @gcctabopt
10777 @item -march=@var{cpu-type}
10778 @opindex march
10779 Generate code that will run on @var{cpu-type}, which is the name of a system
10780 representing a certain processor type.  Possible values for
10781 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
10782 @samp{ms1-16-003} and @samp{ms2}.
10784 When this option is not used, the default is @option{-march=ms1-16-002}.
10786 @item -mbacc
10787 @opindex mbacc
10788 Use byte loads and stores when generating code.
10790 @item -mno-bacc
10791 @opindex mno-bacc
10792 Do not use byte loads and stores when generating code.
10794 @item -msim
10795 @opindex msim
10796 Use simulator runtime
10798 @item -mno-crt0
10799 @opindex mno-crt0
10800 Do not link in the C run-time initialization object file
10801 @file{crti.o}.  Other run-time initialization and termination files
10802 such as @file{startup.o} and @file{exit.o} are still included on the
10803 linker command line.
10805 @end table
10807 @node PDP-11 Options
10808 @subsection PDP-11 Options
10809 @cindex PDP-11 Options
10811 These options are defined for the PDP-11:
10813 @table @gcctabopt
10814 @item -mfpu
10815 @opindex mfpu
10816 Use hardware FPP floating point.  This is the default.  (FIS floating
10817 point on the PDP-11/40 is not supported.)
10819 @item -msoft-float
10820 @opindex msoft-float
10821 Do not use hardware floating point.
10823 @item -mac0
10824 @opindex mac0
10825 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10827 @item -mno-ac0
10828 @opindex mno-ac0
10829 Return floating-point results in memory.  This is the default.
10831 @item -m40
10832 @opindex m40
10833 Generate code for a PDP-11/40.
10835 @item -m45
10836 @opindex m45
10837 Generate code for a PDP-11/45.  This is the default.
10839 @item -m10
10840 @opindex m10
10841 Generate code for a PDP-11/10.
10843 @item -mbcopy-builtin
10844 @opindex bcopy-builtin
10845 Use inline @code{movmemhi} patterns for copying memory.  This is the
10846 default.
10848 @item -mbcopy
10849 @opindex mbcopy
10850 Do not use inline @code{movmemhi} patterns for copying memory.
10852 @item -mint16
10853 @itemx -mno-int32
10854 @opindex mint16
10855 @opindex mno-int32
10856 Use 16-bit @code{int}.  This is the default.
10858 @item -mint32
10859 @itemx -mno-int16
10860 @opindex mint32
10861 @opindex mno-int16
10862 Use 32-bit @code{int}.
10864 @item -mfloat64
10865 @itemx -mno-float32
10866 @opindex mfloat64
10867 @opindex mno-float32
10868 Use 64-bit @code{float}.  This is the default.
10870 @item -mfloat32
10871 @itemx -mno-float64
10872 @opindex mfloat32
10873 @opindex mno-float64
10874 Use 32-bit @code{float}.
10876 @item -mabshi
10877 @opindex mabshi
10878 Use @code{abshi2} pattern.  This is the default.
10880 @item -mno-abshi
10881 @opindex mno-abshi
10882 Do not use @code{abshi2} pattern.
10884 @item -mbranch-expensive
10885 @opindex mbranch-expensive
10886 Pretend that branches are expensive.  This is for experimenting with
10887 code generation only.
10889 @item -mbranch-cheap
10890 @opindex mbranch-cheap
10891 Do not pretend that branches are expensive.  This is the default.
10893 @item -msplit
10894 @opindex msplit
10895 Generate code for a system with split I&D@.
10897 @item -mno-split
10898 @opindex mno-split
10899 Generate code for a system without split I&D@.  This is the default.
10901 @item -munix-asm
10902 @opindex munix-asm
10903 Use Unix assembler syntax.  This is the default when configured for
10904 @samp{pdp11-*-bsd}.
10906 @item -mdec-asm
10907 @opindex mdec-asm
10908 Use DEC assembler syntax.  This is the default when configured for any
10909 PDP-11 target other than @samp{pdp11-*-bsd}.
10910 @end table
10912 @node PowerPC Options
10913 @subsection PowerPC Options
10914 @cindex PowerPC options
10916 These are listed under @xref{RS/6000 and PowerPC Options}.
10918 @node RS/6000 and PowerPC Options
10919 @subsection IBM RS/6000 and PowerPC Options
10920 @cindex RS/6000 and PowerPC Options
10921 @cindex IBM RS/6000 and PowerPC Options
10923 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10924 @table @gcctabopt
10925 @item -mpower
10926 @itemx -mno-power
10927 @itemx -mpower2
10928 @itemx -mno-power2
10929 @itemx -mpowerpc
10930 @itemx -mno-powerpc
10931 @itemx -mpowerpc-gpopt
10932 @itemx -mno-powerpc-gpopt
10933 @itemx -mpowerpc-gfxopt
10934 @itemx -mno-powerpc-gfxopt
10935 @itemx -mpowerpc64
10936 @itemx -mno-powerpc64
10937 @itemx -mmfcrf
10938 @itemx -mno-mfcrf
10939 @itemx -mpopcntb
10940 @itemx -mno-popcntb
10941 @itemx -mfprnd
10942 @itemx -mno-fprnd
10943 @opindex mpower
10944 @opindex mno-power
10945 @opindex mpower2
10946 @opindex mno-power2
10947 @opindex mpowerpc
10948 @opindex mno-powerpc
10949 @opindex mpowerpc-gpopt
10950 @opindex mno-powerpc-gpopt
10951 @opindex mpowerpc-gfxopt
10952 @opindex mno-powerpc-gfxopt
10953 @opindex mpowerpc64
10954 @opindex mno-powerpc64
10955 @opindex mmfcrf
10956 @opindex mno-mfcrf
10957 @opindex mpopcntb
10958 @opindex mno-popcntb
10959 @opindex mfprnd
10960 @opindex mno-fprnd
10961 GCC supports two related instruction set architectures for the
10962 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10963 instructions supported by the @samp{rios} chip set used in the original
10964 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10965 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
10966 the IBM 4xx, 6xx, and follow-on microprocessors.
10968 Neither architecture is a subset of the other.  However there is a
10969 large common subset of instructions supported by both.  An MQ
10970 register is included in processors supporting the POWER architecture.
10972 You use these options to specify which instructions are available on the
10973 processor you are using.  The default value of these options is
10974 determined when configuring GCC@.  Specifying the
10975 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10976 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10977 rather than the options listed above.
10979 The @option{-mpower} option allows GCC to generate instructions that
10980 are found only in the POWER architecture and to use the MQ register.
10981 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10982 to generate instructions that are present in the POWER2 architecture but
10983 not the original POWER architecture.
10985 The @option{-mpowerpc} option allows GCC to generate instructions that
10986 are found only in the 32-bit subset of the PowerPC architecture.
10987 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10988 GCC to use the optional PowerPC architecture instructions in the
10989 General Purpose group, including floating-point square root.  Specifying
10990 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10991 use the optional PowerPC architecture instructions in the Graphics
10992 group, including floating-point select.
10994 The @option{-mmfcrf} option allows GCC to generate the move from
10995 condition register field instruction implemented on the POWER4
10996 processor and other processors that support the PowerPC V2.01
10997 architecture.
10998 The @option{-mpopcntb} option allows GCC to generate the popcount and
10999 double precision FP reciprocal estimate instruction implemented on the
11000 POWER5 processor and other processors that support the PowerPC V2.02
11001 architecture.
11002 The @option{-mfprnd} option allows GCC to generate the FP round to
11003 integer instructions implemented on the POWER5+ processor and other
11004 processors that support the PowerPC V2.03 architecture.
11006 The @option{-mpowerpc64} option allows GCC to generate the additional
11007 64-bit instructions that are found in the full PowerPC64 architecture
11008 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
11009 @option{-mno-powerpc64}.
11011 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
11012 will use only the instructions in the common subset of both
11013 architectures plus some special AIX common-mode calls, and will not use
11014 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
11015 permits GCC to use any instruction from either architecture and to
11016 allow use of the MQ register; specify this for the Motorola MPC601.
11018 @item -mnew-mnemonics
11019 @itemx -mold-mnemonics
11020 @opindex mnew-mnemonics
11021 @opindex mold-mnemonics
11022 Select which mnemonics to use in the generated assembler code.  With
11023 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
11024 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
11025 assembler mnemonics defined for the POWER architecture.  Instructions
11026 defined in only one architecture have only one mnemonic; GCC uses that
11027 mnemonic irrespective of which of these options is specified.
11029 GCC defaults to the mnemonics appropriate for the architecture in
11030 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
11031 value of these option.  Unless you are building a cross-compiler, you
11032 should normally not specify either @option{-mnew-mnemonics} or
11033 @option{-mold-mnemonics}, but should instead accept the default.
11035 @item -mcpu=@var{cpu_type}
11036 @opindex mcpu
11037 Set architecture type, register usage, choice of mnemonics, and
11038 instruction scheduling parameters for machine type @var{cpu_type}.
11039 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
11040 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
11041 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
11042 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
11043 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
11044 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
11045 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
11046 @samp{power4}, @samp{power5}, @samp{power5+},
11047 @samp{common}, @samp{powerpc}, @samp{powerpc64},
11048 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
11050 @option{-mcpu=common} selects a completely generic processor.  Code
11051 generated under this option will run on any POWER or PowerPC processor.
11052 GCC will use only the instructions in the common subset of both
11053 architectures, and will not use the MQ register.  GCC assumes a generic
11054 processor model for scheduling purposes.
11056 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11057 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11058 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11059 types, with an appropriate, generic processor model assumed for
11060 scheduling purposes.
11062 The other options specify a specific processor.  Code generated under
11063 those options will run best on that processor, and may not run at all on
11064 others.
11066 The @option{-mcpu} options automatically enable or disable the
11067 following options: @option{-maltivec}, @option{-mfprnd},
11068 @option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
11069 @option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
11070 @option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
11071 @option{-mpowerpc-gfxopt}, @option{-mstring}, @option{-mmulhw}.
11072 The particular options
11073 set for any particular CPU will vary between compiler versions,
11074 depending on what setting seems to produce optimal code for that CPU;
11075 it doesn't necessarily reflect the actual hardware's capabilities.  If
11076 you wish to set an individual option to a particular value, you may
11077 specify it after the @option{-mcpu} option, like @samp{-mcpu=970
11078 -mno-altivec}.
11080 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
11081 not enabled or disabled by the @option{-mcpu} option at present because
11082 AIX does not have full support for these options.  You may still
11083 enable or disable them individually if you're sure it'll work in your
11084 environment.
11086 @item -mtune=@var{cpu_type}
11087 @opindex mtune
11088 Set the instruction scheduling parameters for machine type
11089 @var{cpu_type}, but do not set the architecture type, register usage, or
11090 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
11091 values for @var{cpu_type} are used for @option{-mtune} as for
11092 @option{-mcpu}.  If both are specified, the code generated will use the
11093 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11094 scheduling parameters set by @option{-mtune}.
11096 @item -mswdiv
11097 @itemx -mno-swdiv
11098 @opindex mswdiv
11099 @opindex mno-swdiv
11100 Generate code to compute division as reciprocal estimate and iterative
11101 refinement, creating opportunities for increased throughput.  This
11102 feature requires: optional PowerPC Graphics instruction set for single
11103 precision and FRE instruction for double precision, assuming divides
11104 cannot generate user-visible traps, and the domain values not include
11105 Infinities, denormals or zero denominator.
11107 @item -maltivec
11108 @itemx -mno-altivec
11109 @opindex maltivec
11110 @opindex mno-altivec
11111 Generate code that uses (does not use) AltiVec instructions, and also
11112 enable the use of built-in functions that allow more direct access to
11113 the AltiVec instruction set.  You may also need to set
11114 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11115 enhancements.
11117 @item -mvrsave
11118 @item -mno-vrsave
11119 @opindex mvrsave
11120 @opindex mno-vrsave
11121 Generate VRSAVE instructions when generating AltiVec code.
11123 @item -msecure-plt
11124 @opindex msecure-plt
11125 Generate code that allows ld and ld.so to build executables and shared
11126 libraries with non-exec .plt and .got sections.  This is a PowerPC
11127 32-bit SYSV ABI option.
11129 @item -mbss-plt
11130 @opindex mbss-plt
11131 Generate code that uses a BSS .plt section that ld.so fills in, and
11132 requires .plt and .got sections that are both writable and executable.
11133 This is a PowerPC 32-bit SYSV ABI option.
11135 @item -misel
11136 @itemx -mno-isel
11137 @opindex misel
11138 @opindex mno-isel
11139 This switch enables or disables the generation of ISEL instructions.
11141 @item -misel=@var{yes/no}
11142 This switch has been deprecated.  Use @option{-misel} and
11143 @option{-mno-isel} instead.
11145 @item -mspe
11146 @itemx -mno-isel
11147 @opindex mspe
11148 @opindex mno-spe
11149 This switch enables or disables the generation of SPE simd
11150 instructions.
11152 @item -mspe=@var{yes/no}
11153 This option has been deprecated.  Use @option{-mspe} and
11154 @option{-mno-spe} instead.
11156 @item -mfloat-gprs=@var{yes/single/double/no}
11157 @itemx -mfloat-gprs
11158 @opindex mfloat-gprs
11159 This switch enables or disables the generation of floating point
11160 operations on the general purpose registers for architectures that
11161 support it.
11163 The argument @var{yes} or @var{single} enables the use of
11164 single-precision floating point operations.
11166 The argument @var{double} enables the use of single and
11167 double-precision floating point operations.
11169 The argument @var{no} disables floating point operations on the
11170 general purpose registers.
11172 This option is currently only available on the MPC854x.
11174 @item -m32
11175 @itemx -m64
11176 @opindex m32
11177 @opindex m64
11178 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11179 targets (including GNU/Linux).  The 32-bit environment sets int, long
11180 and pointer to 32 bits and generates code that runs on any PowerPC
11181 variant.  The 64-bit environment sets int to 32 bits and long and
11182 pointer to 64 bits, and generates code for PowerPC64, as for
11183 @option{-mpowerpc64}.
11185 @item -mfull-toc
11186 @itemx -mno-fp-in-toc
11187 @itemx -mno-sum-in-toc
11188 @itemx -mminimal-toc
11189 @opindex mfull-toc
11190 @opindex mno-fp-in-toc
11191 @opindex mno-sum-in-toc
11192 @opindex mminimal-toc
11193 Modify generation of the TOC (Table Of Contents), which is created for
11194 every executable file.  The @option{-mfull-toc} option is selected by
11195 default.  In that case, GCC will allocate at least one TOC entry for
11196 each unique non-automatic variable reference in your program.  GCC
11197 will also place floating-point constants in the TOC@.  However, only
11198 16,384 entries are available in the TOC@.
11200 If you receive a linker error message that saying you have overflowed
11201 the available TOC space, you can reduce the amount of TOC space used
11202 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11203 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11204 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11205 generate code to calculate the sum of an address and a constant at
11206 run-time instead of putting that sum into the TOC@.  You may specify one
11207 or both of these options.  Each causes GCC to produce very slightly
11208 slower and larger code at the expense of conserving TOC space.
11210 If you still run out of space in the TOC even when you specify both of
11211 these options, specify @option{-mminimal-toc} instead.  This option causes
11212 GCC to make only one TOC entry for every file.  When you specify this
11213 option, GCC will produce code that is slower and larger but which
11214 uses extremely little TOC space.  You may wish to use this option
11215 only on files that contain less frequently executed code.
11217 @item -maix64
11218 @itemx -maix32
11219 @opindex maix64
11220 @opindex maix32
11221 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11222 @code{long} type, and the infrastructure needed to support them.
11223 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11224 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11225 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11227 @item -mxl-compat
11228 @itemx -mno-xl-compat
11229 @opindex mxl-compat
11230 @opindex mno-xl-compat
11231 Produce code that conforms more closely to IBM XL compiler semantics
11232 when using AIX-compatible ABI.  Pass floating-point arguments to
11233 prototyped functions beyond the register save area (RSA) on the stack
11234 in addition to argument FPRs.  Do not assume that most significant
11235 double in 128-bit long double value is properly rounded when comparing
11236 values and converting to double.  Use XL symbol names for long double
11237 support routines.
11239 The AIX calling convention was extended but not initially documented to
11240 handle an obscure K&R C case of calling a function that takes the
11241 address of its arguments with fewer arguments than declared.  IBM XL
11242 compilers access floating point arguments which do not fit in the
11243 RSA from the stack when a subroutine is compiled without
11244 optimization.  Because always storing floating-point arguments on the
11245 stack is inefficient and rarely needed, this option is not enabled by
11246 default and only is necessary when calling subroutines compiled by IBM
11247 XL compilers without optimization.
11249 @item -mpe
11250 @opindex mpe
11251 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11252 application written to use message passing with special startup code to
11253 enable the application to run.  The system must have PE installed in the
11254 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11255 must be overridden with the @option{-specs=} option to specify the
11256 appropriate directory location.  The Parallel Environment does not
11257 support threads, so the @option{-mpe} option and the @option{-pthread}
11258 option are incompatible.
11260 @item -malign-natural
11261 @itemx -malign-power
11262 @opindex malign-natural
11263 @opindex malign-power
11264 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11265 @option{-malign-natural} overrides the ABI-defined alignment of larger
11266 types, such as floating-point doubles, on their natural size-based boundary.
11267 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11268 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11270 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11271 is not supported.
11273 @item -msoft-float
11274 @itemx -mhard-float
11275 @opindex msoft-float
11276 @opindex mhard-float
11277 Generate code that does not use (uses) the floating-point register set.
11278 Software floating point emulation is provided if you use the
11279 @option{-msoft-float} option, and pass the option to GCC when linking.
11281 @item -mmultiple
11282 @itemx -mno-multiple
11283 @opindex mmultiple
11284 @opindex mno-multiple
11285 Generate code that uses (does not use) the load multiple word
11286 instructions and the store multiple word instructions.  These
11287 instructions are generated by default on POWER systems, and not
11288 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11289 endian PowerPC systems, since those instructions do not work when the
11290 processor is in little endian mode.  The exceptions are PPC740 and
11291 PPC750 which permit the instructions usage in little endian mode.
11293 @item -mstring
11294 @itemx -mno-string
11295 @opindex mstring
11296 @opindex mno-string
11297 Generate code that uses (does not use) the load string instructions
11298 and the store string word instructions to save multiple registers and
11299 do small block moves.  These instructions are generated by default on
11300 POWER systems, and not generated on PowerPC systems.  Do not use
11301 @option{-mstring} on little endian PowerPC systems, since those
11302 instructions do not work when the processor is in little endian mode.
11303 The exceptions are PPC740 and PPC750 which permit the instructions
11304 usage in little endian mode.
11306 @item -mupdate
11307 @itemx -mno-update
11308 @opindex mupdate
11309 @opindex mno-update
11310 Generate code that uses (does not use) the load or store instructions
11311 that update the base register to the address of the calculated memory
11312 location.  These instructions are generated by default.  If you use
11313 @option{-mno-update}, there is a small window between the time that the
11314 stack pointer is updated and the address of the previous frame is
11315 stored, which means code that walks the stack frame across interrupts or
11316 signals may get corrupted data.
11318 @item -mfused-madd
11319 @itemx -mno-fused-madd
11320 @opindex mfused-madd
11321 @opindex mno-fused-madd
11322 Generate code that uses (does not use) the floating point multiply and
11323 accumulate instructions.  These instructions are generated by default if
11324 hardware floating is used.
11326 @item -mmulhw
11327 @itemx -mno-mulhw
11328 @opindex mmulhw
11329 @opindex mno-mulhw
11330 Generate code that uses (does not use) the half-word multiply and
11331 multiply-accumulate instructions on the IBM 405 and 440 processors.
11332 These instructions are generated by default when targetting those
11333 processors.
11335 @item -mno-bit-align
11336 @itemx -mbit-align
11337 @opindex mno-bit-align
11338 @opindex mbit-align
11339 On System V.4 and embedded PowerPC systems do not (do) force structures
11340 and unions that contain bit-fields to be aligned to the base type of the
11341 bit-field.
11343 For example, by default a structure containing nothing but 8
11344 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11345 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11346 the structure would be aligned to a 1 byte boundary and be one byte in
11347 size.
11349 @item -mno-strict-align
11350 @itemx -mstrict-align
11351 @opindex mno-strict-align
11352 @opindex mstrict-align
11353 On System V.4 and embedded PowerPC systems do not (do) assume that
11354 unaligned memory references will be handled by the system.
11356 @item -mrelocatable
11357 @itemx -mno-relocatable
11358 @opindex mrelocatable
11359 @opindex mno-relocatable
11360 On embedded PowerPC systems generate code that allows (does not allow)
11361 the program to be relocated to a different address at runtime.  If you
11362 use @option{-mrelocatable} on any module, all objects linked together must
11363 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11365 @item -mrelocatable-lib
11366 @itemx -mno-relocatable-lib
11367 @opindex mrelocatable-lib
11368 @opindex mno-relocatable-lib
11369 On embedded PowerPC systems generate code that allows (does not allow)
11370 the program to be relocated to a different address at runtime.  Modules
11371 compiled with @option{-mrelocatable-lib} can be linked with either modules
11372 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11373 with modules compiled with the @option{-mrelocatable} options.
11375 @item -mno-toc
11376 @itemx -mtoc
11377 @opindex mno-toc
11378 @opindex mtoc
11379 On System V.4 and embedded PowerPC systems do not (do) assume that
11380 register 2 contains a pointer to a global area pointing to the addresses
11381 used in the program.
11383 @item -mlittle
11384 @itemx -mlittle-endian
11385 @opindex mlittle
11386 @opindex mlittle-endian
11387 On System V.4 and embedded PowerPC systems compile code for the
11388 processor in little endian mode.  The @option{-mlittle-endian} option is
11389 the same as @option{-mlittle}.
11391 @item -mbig
11392 @itemx -mbig-endian
11393 @opindex mbig
11394 @opindex mbig-endian
11395 On System V.4 and embedded PowerPC systems compile code for the
11396 processor in big endian mode.  The @option{-mbig-endian} option is
11397 the same as @option{-mbig}.
11399 @item -mdynamic-no-pic
11400 @opindex mdynamic-no-pic
11401 On Darwin and Mac OS X systems, compile code so that it is not
11402 relocatable, but that its external references are relocatable.  The
11403 resulting code is suitable for applications, but not shared
11404 libraries.
11406 @item -mprioritize-restricted-insns=@var{priority}
11407 @opindex mprioritize-restricted-insns
11408 This option controls the priority that is assigned to
11409 dispatch-slot restricted instructions during the second scheduling
11410 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11411 @var{no/highest/second-highest} priority to dispatch slot restricted
11412 instructions.
11414 @item -msched-costly-dep=@var{dependence_type}
11415 @opindex msched-costly-dep
11416 This option controls which dependences are considered costly
11417 by the target during instruction scheduling.  The argument
11418 @var{dependence_type} takes one of the following values:
11419 @var{no}: no dependence is costly,
11420 @var{all}: all dependences are costly,
11421 @var{true_store_to_load}: a true dependence from store to load is costly,
11422 @var{store_to_load}: any dependence from store to load is costly,
11423 @var{number}: any dependence which latency >= @var{number} is costly.
11425 @item -minsert-sched-nops=@var{scheme}
11426 @opindex minsert-sched-nops
11427 This option controls which nop insertion scheme will be used during
11428 the second scheduling pass.  The argument @var{scheme} takes one of the
11429 following values:
11430 @var{no}: Don't insert nops.
11431 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11432 according to the scheduler's grouping.
11433 @var{regroup_exact}: Insert nops to force costly dependent insns into
11434 separate groups.  Insert exactly as many nops as needed to force an insn
11435 to a new group, according to the estimated processor grouping.
11436 @var{number}: Insert nops to force costly dependent insns into
11437 separate groups.  Insert @var{number} nops to force an insn to a new group.
11439 @item -mcall-sysv
11440 @opindex mcall-sysv
11441 On System V.4 and embedded PowerPC systems compile code using calling
11442 conventions that adheres to the March 1995 draft of the System V
11443 Application Binary Interface, PowerPC processor supplement.  This is the
11444 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11446 @item -mcall-sysv-eabi
11447 @opindex mcall-sysv-eabi
11448 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11450 @item -mcall-sysv-noeabi
11451 @opindex mcall-sysv-noeabi
11452 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11454 @item -mcall-solaris
11455 @opindex mcall-solaris
11456 On System V.4 and embedded PowerPC systems compile code for the Solaris
11457 operating system.
11459 @item -mcall-linux
11460 @opindex mcall-linux
11461 On System V.4 and embedded PowerPC systems compile code for the
11462 Linux-based GNU system.
11464 @item -mcall-gnu
11465 @opindex mcall-gnu
11466 On System V.4 and embedded PowerPC systems compile code for the
11467 Hurd-based GNU system.
11469 @item -mcall-netbsd
11470 @opindex mcall-netbsd
11471 On System V.4 and embedded PowerPC systems compile code for the
11472 NetBSD operating system.
11474 @item -maix-struct-return
11475 @opindex maix-struct-return
11476 Return all structures in memory (as specified by the AIX ABI)@.
11478 @item -msvr4-struct-return
11479 @opindex msvr4-struct-return
11480 Return structures smaller than 8 bytes in registers (as specified by the
11481 SVR4 ABI)@.
11483 @item -mabi=@var{abi-type}
11484 @opindex mabi
11485 Extend the current ABI with a particular extension, or remove such extension.
11486 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11487 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
11489 @item -mabi=spe
11490 @opindex mabi=spe
11491 Extend the current ABI with SPE ABI extensions.  This does not change
11492 the default ABI, instead it adds the SPE ABI extensions to the current
11493 ABI@.
11495 @item -mabi=no-spe
11496 @opindex mabi=no-spe
11497 Disable Booke SPE ABI extensions for the current ABI@.
11499 @item -mabi=ibmlongdouble
11500 @opindex mabi=ibmlongdouble
11501 Change the current ABI to use IBM extended precision long double.
11502 This is a PowerPC 32-bit SYSV ABI option.
11504 @item -mabi=ieeelongdouble
11505 @opindex mabi=ieeelongdouble
11506 Change the current ABI to use IEEE extended precision long double.
11507 This is a PowerPC 32-bit Linux ABI option.
11509 @item -mprototype
11510 @itemx -mno-prototype
11511 @opindex mprototype
11512 @opindex mno-prototype
11513 On System V.4 and embedded PowerPC systems assume that all calls to
11514 variable argument functions are properly prototyped.  Otherwise, the
11515 compiler must insert an instruction before every non prototyped call to
11516 set or clear bit 6 of the condition code register (@var{CR}) to
11517 indicate whether floating point values were passed in the floating point
11518 registers in case the function takes a variable arguments.  With
11519 @option{-mprototype}, only calls to prototyped variable argument functions
11520 will set or clear the bit.
11522 @item -msim
11523 @opindex msim
11524 On embedded PowerPC systems, assume that the startup module is called
11525 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11526 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11527 configurations.
11529 @item -mmvme
11530 @opindex mmvme
11531 On embedded PowerPC systems, assume that the startup module is called
11532 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11533 @file{libc.a}.
11535 @item -mads
11536 @opindex mads
11537 On embedded PowerPC systems, assume that the startup module is called
11538 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11539 @file{libc.a}.
11541 @item -myellowknife
11542 @opindex myellowknife
11543 On embedded PowerPC systems, assume that the startup module is called
11544 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11545 @file{libc.a}.
11547 @item -mvxworks
11548 @opindex mvxworks
11549 On System V.4 and embedded PowerPC systems, specify that you are
11550 compiling for a VxWorks system.
11552 @item -mwindiss
11553 @opindex mwindiss
11554 Specify that you are compiling for the WindISS simulation environment.
11556 @item -memb
11557 @opindex memb
11558 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11559 header to indicate that @samp{eabi} extended relocations are used.
11561 @item -meabi
11562 @itemx -mno-eabi
11563 @opindex meabi
11564 @opindex mno-eabi
11565 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11566 Embedded Applications Binary Interface (eabi) which is a set of
11567 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11568 means that the stack is aligned to an 8 byte boundary, a function
11569 @code{__eabi} is called to from @code{main} to set up the eabi
11570 environment, and the @option{-msdata} option can use both @code{r2} and
11571 @code{r13} to point to two separate small data areas.  Selecting
11572 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11573 do not call an initialization function from @code{main}, and the
11574 @option{-msdata} option will only use @code{r13} to point to a single
11575 small data area.  The @option{-meabi} option is on by default if you
11576 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11578 @item -msdata=eabi
11579 @opindex msdata=eabi
11580 On System V.4 and embedded PowerPC systems, put small initialized
11581 @code{const} global and static data in the @samp{.sdata2} section, which
11582 is pointed to by register @code{r2}.  Put small initialized
11583 non-@code{const} global and static data in the @samp{.sdata} section,
11584 which is pointed to by register @code{r13}.  Put small uninitialized
11585 global and static data in the @samp{.sbss} section, which is adjacent to
11586 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11587 incompatible with the @option{-mrelocatable} option.  The
11588 @option{-msdata=eabi} option also sets the @option{-memb} option.
11590 @item -msdata=sysv
11591 @opindex msdata=sysv
11592 On System V.4 and embedded PowerPC systems, put small global and static
11593 data in the @samp{.sdata} section, which is pointed to by register
11594 @code{r13}.  Put small uninitialized global and static data in the
11595 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11596 The @option{-msdata=sysv} option is incompatible with the
11597 @option{-mrelocatable} option.
11599 @item -msdata=default
11600 @itemx -msdata
11601 @opindex msdata=default
11602 @opindex msdata
11603 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11604 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11605 same as @option{-msdata=sysv}.
11607 @item -msdata-data
11608 @opindex msdata-data
11609 On System V.4 and embedded PowerPC systems, put small global
11610 data in the @samp{.sdata} section.  Put small uninitialized global
11611 data in the @samp{.sbss} section.  Do not use register @code{r13}
11612 to address small data however.  This is the default behavior unless
11613 other @option{-msdata} options are used.
11615 @item -msdata=none
11616 @itemx -mno-sdata
11617 @opindex msdata=none
11618 @opindex mno-sdata
11619 On embedded PowerPC systems, put all initialized global and static data
11620 in the @samp{.data} section, and all uninitialized data in the
11621 @samp{.bss} section.
11623 @item -G @var{num}
11624 @opindex G
11625 @cindex smaller data references (PowerPC)
11626 @cindex .sdata/.sdata2 references (PowerPC)
11627 On embedded PowerPC systems, put global and static items less than or
11628 equal to @var{num} bytes into the small data or bss sections instead of
11629 the normal data or bss section.  By default, @var{num} is 8.  The
11630 @option{-G @var{num}} switch is also passed to the linker.
11631 All modules should be compiled with the same @option{-G @var{num}} value.
11633 @item -mregnames
11634 @itemx -mno-regnames
11635 @opindex mregnames
11636 @opindex mno-regnames
11637 On System V.4 and embedded PowerPC systems do (do not) emit register
11638 names in the assembly language output using symbolic forms.
11640 @item -mlongcall
11641 @itemx -mno-longcall
11642 @opindex mlongcall
11643 @opindex mno-longcall
11644 Default to making all function calls indirectly, using a register, so
11645 that functions which reside further than 32 megabytes (33,554,432
11646 bytes) from the current location can be called.  This setting can be
11647 overridden by the @code{shortcall} function attribute, or by
11648 @code{#pragma longcall(0)}.
11650 Some linkers are capable of detecting out-of-range calls and generating
11651 glue code on the fly.  On these systems, long calls are unnecessary and
11652 generate slower code.  As of this writing, the AIX linker can do this,
11653 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11654 to the GNU linker for 32-bit PowerPC systems as well.
11656 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11657 callee, L42'', plus a ``branch island'' (glue code).  The two target
11658 addresses represent the callee and the ``branch island''.  The
11659 Darwin/PPC linker will prefer the first address and generate a ``bl
11660 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11661 otherwise, the linker will generate ``bl L42'' to call the ``branch
11662 island''.  The ``branch island'' is appended to the body of the
11663 calling function; it computes the full 32-bit address of the callee
11664 and jumps to it.
11666 On Mach-O (Darwin) systems, this option directs the compiler emit to
11667 the glue for every direct call, and the Darwin linker decides whether
11668 to use or discard it.
11670 In the future, we may cause GCC to ignore all longcall specifications
11671 when the linker is known to generate glue.
11673 @item -pthread
11674 @opindex pthread
11675 Adds support for multithreading with the @dfn{pthreads} library.
11676 This option sets flags for both the preprocessor and linker.
11678 @end table
11680 @node S/390 and zSeries Options
11681 @subsection S/390 and zSeries Options
11682 @cindex S/390 and zSeries Options
11684 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11686 @table @gcctabopt
11687 @item -mhard-float
11688 @itemx -msoft-float
11689 @opindex mhard-float
11690 @opindex msoft-float
11691 Use (do not use) the hardware floating-point instructions and registers
11692 for floating-point operations.  When @option{-msoft-float} is specified,
11693 functions in @file{libgcc.a} will be used to perform floating-point
11694 operations.  When @option{-mhard-float} is specified, the compiler
11695 generates IEEE floating-point instructions.  This is the default.
11697 @item -mlong-double-64
11698 @itemx -mlong-double-128
11699 @opindex mlong-double-64
11700 @opindex mlong-double-128
11701 These switches control the size of @code{long double} type. A size
11702 of 64bit makes the @code{long double} type equivalent to the @code{double}
11703 type. This is the default.
11705 @item -mbackchain
11706 @itemx -mno-backchain
11707 @opindex mbackchain
11708 @opindex mno-backchain
11709 Store (do not store) the address of the caller's frame as backchain pointer
11710 into the callee's stack frame.
11711 A backchain may be needed to allow debugging using tools that do not understand
11712 DWARF-2 call frame information.
11713 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11714 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11715 the backchain is placed into the topmost word of the 96/160 byte register
11716 save area.
11718 In general, code compiled with @option{-mbackchain} is call-compatible with
11719 code compiled with @option{-mmo-backchain}; however, use of the backchain
11720 for debugging purposes usually requires that the whole binary is built with
11721 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11722 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11723 to build a linux kernel use @option{-msoft-float}.
11725 The default is to not maintain the backchain.
11727 @item -mpacked-stack
11728 @item -mno-packed-stack
11729 @opindex mpacked-stack
11730 @opindex mno-packed-stack
11731 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11732 specified, the compiler uses the all fields of the 96/160 byte register save
11733 area only for their default purpose; unused fields still take up stack space.
11734 When @option{-mpacked-stack} is specified, register save slots are densely
11735 packed at the top of the register save area; unused space is reused for other
11736 purposes, allowing for more efficient use of the available stack space.
11737 However, when @option{-mbackchain} is also in effect, the topmost word of
11738 the save area is always used to store the backchain, and the return address
11739 register is always saved two words below the backchain.
11741 As long as the stack frame backchain is not used, code generated with
11742 @option{-mpacked-stack} is call-compatible with code generated with
11743 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11744 S/390 or zSeries generated code that uses the stack frame backchain at run
11745 time, not just for debugging purposes.  Such code is not call-compatible
11746 with code compiled with @option{-mpacked-stack}.  Also, note that the
11747 combination of @option{-mbackchain},
11748 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11749 to build a linux kernel use @option{-msoft-float}.
11751 The default is to not use the packed stack layout.
11753 @item -msmall-exec
11754 @itemx -mno-small-exec
11755 @opindex msmall-exec
11756 @opindex mno-small-exec
11757 Generate (or do not generate) code using the @code{bras} instruction
11758 to do subroutine calls.
11759 This only works reliably if the total executable size does not
11760 exceed 64k.  The default is to use the @code{basr} instruction instead,
11761 which does not have this limitation.
11763 @item -m64
11764 @itemx -m31
11765 @opindex m64
11766 @opindex m31
11767 When @option{-m31} is specified, generate code compliant to the
11768 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11769 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11770 particular to generate 64-bit instructions.  For the @samp{s390}
11771 targets, the default is @option{-m31}, while the @samp{s390x}
11772 targets default to @option{-m64}.
11774 @item -mzarch
11775 @itemx -mesa
11776 @opindex mzarch
11777 @opindex mesa
11778 When @option{-mzarch} is specified, generate code using the
11779 instructions available on z/Architecture.
11780 When @option{-mesa} is specified, generate code using the
11781 instructions available on ESA/390.  Note that @option{-mesa} is
11782 not possible with @option{-m64}.
11783 When generating code compliant to the GNU/Linux for S/390 ABI,
11784 the default is @option{-mesa}.  When generating code compliant
11785 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11787 @item -mmvcle
11788 @itemx -mno-mvcle
11789 @opindex mmvcle
11790 @opindex mno-mvcle
11791 Generate (or do not generate) code using the @code{mvcle} instruction
11792 to perform block moves.  When @option{-mno-mvcle} is specified,
11793 use a @code{mvc} loop instead.  This is the default unless optimizing for
11794 size.
11796 @item -mdebug
11797 @itemx -mno-debug
11798 @opindex mdebug
11799 @opindex mno-debug
11800 Print (or do not print) additional debug information when compiling.
11801 The default is to not print debug information.
11803 @item -march=@var{cpu-type}
11804 @opindex march
11805 Generate code that will run on @var{cpu-type}, which is the name of a system
11806 representing a certain processor type.  Possible values for
11807 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11808 When generating code using the instructions available on z/Architecture,
11809 the default is @option{-march=z900}.  Otherwise, the default is
11810 @option{-march=g5}.
11812 @item -mtune=@var{cpu-type}
11813 @opindex mtune
11814 Tune to @var{cpu-type} everything applicable about the generated code,
11815 except for the ABI and the set of available instructions.
11816 The list of @var{cpu-type} values is the same as for @option{-march}.
11817 The default is the value used for @option{-march}.
11819 @item -mtpf-trace
11820 @itemx -mno-tpf-trace
11821 @opindex mtpf-trace
11822 @opindex mno-tpf-trace
11823 Generate code that adds (does not add) in TPF OS specific branches to trace
11824 routines in the operating system.  This option is off by default, even
11825 when compiling for the TPF OS@.
11827 @item -mfused-madd
11828 @itemx -mno-fused-madd
11829 @opindex mfused-madd
11830 @opindex mno-fused-madd
11831 Generate code that uses (does not use) the floating point multiply and
11832 accumulate instructions.  These instructions are generated by default if
11833 hardware floating point is used.
11835 @item -mwarn-framesize=@var{framesize}
11836 @opindex mwarn-framesize
11837 Emit a warning if the current function exceeds the given frame size.  Because
11838 this is a compile time check it doesn't need to be a real problem when the program
11839 runs.  It is intended to identify functions which most probably cause
11840 a stack overflow.  It is useful to be used in an environment with limited stack
11841 size e.g.@: the linux kernel.
11843 @item -mwarn-dynamicstack
11844 @opindex mwarn-dynamicstack
11845 Emit a warning if the function calls alloca or uses dynamically
11846 sized arrays.  This is generally a bad idea with a limited stack size.
11848 @item -mstack-guard=@var{stack-guard}
11849 @item -mstack-size=@var{stack-size}
11850 @opindex mstack-guard
11851 @opindex mstack-size
11852 These arguments always have to be used in conjunction.  If they are present the s390
11853 back end emits additional instructions in the function prologue which trigger a trap
11854 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11855 (remember that the stack on s390 grows downward).  These options are intended to
11856 be used to help debugging stack overflow problems.  The additionally emitted code
11857 causes only little overhead and hence can also be used in production like systems
11858 without greater performance degradation.  The given values have to be exact
11859 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
11860 exceeding 64k.
11861 In order to be efficient the extra code makes the assumption that the stack starts
11862 at an address aligned to the value given by @var{stack-size}.
11863 @end table
11865 @node SH Options
11866 @subsection SH Options
11868 These @samp{-m} options are defined for the SH implementations:
11870 @table @gcctabopt
11871 @item -m1
11872 @opindex m1
11873 Generate code for the SH1.
11875 @item -m2
11876 @opindex m2
11877 Generate code for the SH2.
11879 @item -m2e
11880 Generate code for the SH2e.
11882 @item -m3
11883 @opindex m3
11884 Generate code for the SH3.
11886 @item -m3e
11887 @opindex m3e
11888 Generate code for the SH3e.
11890 @item -m4-nofpu
11891 @opindex m4-nofpu
11892 Generate code for the SH4 without a floating-point unit.
11894 @item -m4-single-only
11895 @opindex m4-single-only
11896 Generate code for the SH4 with a floating-point unit that only
11897 supports single-precision arithmetic.
11899 @item -m4-single
11900 @opindex m4-single
11901 Generate code for the SH4 assuming the floating-point unit is in
11902 single-precision mode by default.
11904 @item -m4
11905 @opindex m4
11906 Generate code for the SH4.
11908 @item -m4a-nofpu
11909 @opindex m4a-nofpu
11910 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11911 floating-point unit is not used.
11913 @item -m4a-single-only
11914 @opindex m4a-single-only
11915 Generate code for the SH4a, in such a way that no double-precision
11916 floating point operations are used.
11918 @item -m4a-single
11919 @opindex m4a-single
11920 Generate code for the SH4a assuming the floating-point unit is in
11921 single-precision mode by default.
11923 @item -m4a
11924 @opindex m4a
11925 Generate code for the SH4a.
11927 @item -m4al
11928 @opindex m4al
11929 Same as @option{-m4a-nofpu}, except that it implicitly passes
11930 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11931 instructions at the moment.
11933 @item -mb
11934 @opindex mb
11935 Compile code for the processor in big endian mode.
11937 @item -ml
11938 @opindex ml
11939 Compile code for the processor in little endian mode.
11941 @item -mdalign
11942 @opindex mdalign
11943 Align doubles at 64-bit boundaries.  Note that this changes the calling
11944 conventions, and thus some functions from the standard C library will
11945 not work unless you recompile it first with @option{-mdalign}.
11947 @item -mrelax
11948 @opindex mrelax
11949 Shorten some address references at link time, when possible; uses the
11950 linker option @option{-relax}.
11952 @item -mbigtable
11953 @opindex mbigtable
11954 Use 32-bit offsets in @code{switch} tables.  The default is to use
11955 16-bit offsets.
11957 @item -mfmovd
11958 @opindex mfmovd
11959 Enable the use of the instruction @code{fmovd}.
11961 @item -mhitachi
11962 @opindex mhitachi
11963 Comply with the calling conventions defined by Renesas.
11965 @item -mrenesas
11966 @opindex mhitachi
11967 Comply with the calling conventions defined by Renesas.
11969 @item -mno-renesas
11970 @opindex mhitachi
11971 Comply with the calling conventions defined for GCC before the Renesas
11972 conventions were available.  This option is the default for all
11973 targets of the SH toolchain except for @samp{sh-symbianelf}.
11975 @item -mnomacsave
11976 @opindex mnomacsave
11977 Mark the @code{MAC} register as call-clobbered, even if
11978 @option{-mhitachi} is given.
11980 @item -mieee
11981 @opindex mieee
11982 Increase IEEE-compliance of floating-point code.
11983 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11984 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11985 comparisons of NANs / infinities incurs extra overhead in every
11986 floating point comparison, therefore the default is set to
11987 @option{-ffinite-math-only}.
11989 @item -misize
11990 @opindex misize
11991 Dump instruction size and location in the assembly code.
11993 @item -mpadstruct
11994 @opindex mpadstruct
11995 This option is deprecated.  It pads structures to multiple of 4 bytes,
11996 which is incompatible with the SH ABI@.
11998 @item -mspace
11999 @opindex mspace
12000 Optimize for space instead of speed.  Implied by @option{-Os}.
12002 @item -mprefergot
12003 @opindex mprefergot
12004 When generating position-independent code, emit function calls using
12005 the Global Offset Table instead of the Procedure Linkage Table.
12007 @item -musermode
12008 @opindex musermode
12009 Generate a library function call to invalidate instruction cache
12010 entries, after fixing up a trampoline.  This library function call
12011 doesn't assume it can write to the whole memory address space.  This
12012 is the default when the target is @code{sh-*-linux*}.
12014 @item -multcost=@var{number}
12015 @opindex multcost=@var{number}
12016 Set the cost to assume for a multiply insn.
12018 @item -mdiv=@var{strategy}
12019 @opindex mdiv=@var{strategy}
12020 Set the division strategy to use for SHmedia code.  @var{strategy} must be
12021 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
12022 inv:call2, inv:fp .
12023 "fp" performs the operation in floating point.  This has a very high latency,
12024 but needs only a few instructions, so it might be a good choice if
12025 your code has enough easily exploitable ILP to allow the compiler to
12026 schedule the floating point instructions together with other instructions.
12027 Division by zero causes a floating point exception.
12028 "inv" uses integer operations to calculate the inverse of the divisor,
12029 and then multiplies the dividend with the inverse.  This strategy allows
12030 cse and hoisting of the inverse calculation.  Division by zero calculates
12031 an unspecified result, but does not trap.
12032 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
12033 have been found, or if the entire operation has been hoisted to the same
12034 place, the last stages of the inverse calculation are intertwined with the
12035 final multiply to reduce the overall latency, at the expense of using a few
12036 more instructions, and thus offering fewer scheduling opportunities with
12037 other code.
12038 "call" calls a library function that usually implements the inv:minlat
12039 strategy.
12040 This gives high code density for m5-*media-nofpu compilations.
12041 "call2" uses a different entry point of the same library function, where it
12042 assumes that a pointer to a lookup table has already been set up, which
12043 exposes the pointer load to cse / code hoisting optimizations.
12044 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
12045 code generation, but if the code stays unoptimized, revert to the "call",
12046 "call2", or "fp" strategies, respectively.  Note that the
12047 potentially-trapping side effect of division by zero is carried by a
12048 separate instruction, so it is possible that all the integer instructions
12049 are hoisted out, but the marker for the side effect stays where it is.
12050 A recombination to fp operations or a call is not possible in that case.
12051 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
12052 that the inverse calculation was nor separated from the multiply, they speed
12053 up division where the dividend fits into 20 bits (plus sign where applicable),
12054 by inserting a test to skip a number of operations in this case; this test
12055 slows down the case of larger dividends.  inv20u assumes the case of a such
12056 a small dividend to be unlikely, and inv20l assumes it to be likely.
12058 @item -mdivsi3_libfunc=@var{name}
12059 @opindex mdivsi3_libfunc=@var{name}
12060 Set the name of the library function used for 32 bit signed division to
12061 @var{name}.  This only affect the name used in the call and inv:call
12062 division strategies, and the compiler will still expect the same
12063 sets of input/output/clobbered registers as if this option was not present.
12065 @item -madjust-unroll
12066 @opindex madjust-unroll
12067 Throttle unrolling to avoid thrashing target registers.
12068 This option only has an effect if the gcc code base supports the
12069 TARGET_ADJUST_UNROLL_MAX target hook.
12071 @item -mindexed-addressing
12072 @opindex mindexed-addressing
12073 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12074 This is only safe if the hardware and/or OS implement 32 bit wrap-around
12075 semantics for the indexed addressing mode.  The architecture allows the
12076 implementation of processors with 64 bit MMU, which the OS could use to
12077 get 32 bit addressing, but since no current hardware implementation supports
12078 this or any other way to make the indexed addressing mode safe to use in
12079 the 32 bit ABI, the default is -mno-indexed-addressing.
12081 @item -mgettrcost=@var{number}
12082 @opindex mgettrcost=@var{number}
12083 Set the cost assumed for the gettr instruction to @var{number}.
12084 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12086 @item -mpt-fixed
12087 @opindex mpt-fixed
12088 Assume pt* instructions won't trap.  This will generally generate better
12089 scheduled code, but is unsafe on current hardware.  The current architecture
12090 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12091 This has the unintentional effect of making it unsafe to schedule ptabs /
12092 ptrel before a branch, or hoist it out of a loop.  For example,
12093 __do_global_ctors, a part of libgcc that runs constructors at program
12094 startup, calls functions in a list which is delimited by -1.  With the
12095 -mpt-fixed option, the ptabs will be done before testing against -1.
12096 That means that all the constructors will be run a bit quicker, but when
12097 the loop comes to the end of the list, the program crashes because ptabs
12098 loads -1 into a target register.  Since this option is unsafe for any
12099 hardware implementing the current architecture specification, the default
12100 is -mno-pt-fixed.  Unless the user specifies a specific cost with
12101 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12102 this deters register allocation using target registers for storing
12103 ordinary integers.
12105 @item -minvalid-symbols
12106 @opindex minvalid-symbols
12107 Assume symbols might be invalid.  Ordinary function symbols generated by
12108 the compiler will always be valid to load with movi/shori/ptabs or
12109 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12110 to generate symbols that will cause ptabs / ptrel to trap.
12111 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12112 It will then prevent cross-basic-block cse, hoisting and most scheduling
12113 of symbol loads.  The default is @option{-mno-invalid-symbols}.
12114 @end table
12116 @node SPARC Options
12117 @subsection SPARC Options
12118 @cindex SPARC options
12120 These @samp{-m} options are supported on the SPARC:
12122 @table @gcctabopt
12123 @item -mno-app-regs
12124 @itemx -mapp-regs
12125 @opindex mno-app-regs
12126 @opindex mapp-regs
12127 Specify @option{-mapp-regs} to generate output using the global registers
12128 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12129 is the default.
12131 To be fully SVR4 ABI compliant at the cost of some performance loss,
12132 specify @option{-mno-app-regs}.  You should compile libraries and system
12133 software with this option.
12135 @item -mfpu
12136 @itemx -mhard-float
12137 @opindex mfpu
12138 @opindex mhard-float
12139 Generate output containing floating point instructions.  This is the
12140 default.
12142 @item -mno-fpu
12143 @itemx -msoft-float
12144 @opindex mno-fpu
12145 @opindex msoft-float
12146 Generate output containing library calls for floating point.
12147 @strong{Warning:} the requisite libraries are not available for all SPARC
12148 targets.  Normally the facilities of the machine's usual C compiler are
12149 used, but this cannot be done directly in cross-compilation.  You must make
12150 your own arrangements to provide suitable library functions for
12151 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12152 @samp{sparclite-*-*} do provide software floating point support.
12154 @option{-msoft-float} changes the calling convention in the output file;
12155 therefore, it is only useful if you compile @emph{all} of a program with
12156 this option.  In particular, you need to compile @file{libgcc.a}, the
12157 library that comes with GCC, with @option{-msoft-float} in order for
12158 this to work.
12160 @item -mhard-quad-float
12161 @opindex mhard-quad-float
12162 Generate output containing quad-word (long double) floating point
12163 instructions.
12165 @item -msoft-quad-float
12166 @opindex msoft-quad-float
12167 Generate output containing library calls for quad-word (long double)
12168 floating point instructions.  The functions called are those specified
12169 in the SPARC ABI@.  This is the default.
12171 As of this writing, there are no SPARC implementations that have hardware
12172 support for the quad-word floating point instructions.  They all invoke
12173 a trap handler for one of these instructions, and then the trap handler
12174 emulates the effect of the instruction.  Because of the trap handler overhead,
12175 this is much slower than calling the ABI library routines.  Thus the
12176 @option{-msoft-quad-float} option is the default.
12178 @item -mno-unaligned-doubles
12179 @itemx -munaligned-doubles
12180 @opindex mno-unaligned-doubles
12181 @opindex munaligned-doubles
12182 Assume that doubles have 8 byte alignment.  This is the default.
12184 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12185 alignment only if they are contained in another type, or if they have an
12186 absolute address.  Otherwise, it assumes they have 4 byte alignment.
12187 Specifying this option avoids some rare compatibility problems with code
12188 generated by other compilers.  It is not the default because it results
12189 in a performance loss, especially for floating point code.
12191 @item -mno-faster-structs
12192 @itemx -mfaster-structs
12193 @opindex mno-faster-structs
12194 @opindex mfaster-structs
12195 With @option{-mfaster-structs}, the compiler assumes that structures
12196 should have 8 byte alignment.  This enables the use of pairs of
12197 @code{ldd} and @code{std} instructions for copies in structure
12198 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12199 However, the use of this changed alignment directly violates the SPARC
12200 ABI@.  Thus, it's intended only for use on targets where the developer
12201 acknowledges that their resulting code will not be directly in line with
12202 the rules of the ABI@.
12204 @item -mimpure-text
12205 @opindex mimpure-text
12206 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12207 the compiler to not pass @option{-z text} to the linker when linking a
12208 shared object.  Using this option, you can link position-dependent
12209 code into a shared object.
12211 @option{-mimpure-text} suppresses the ``relocations remain against
12212 allocatable but non-writable sections'' linker error message.
12213 However, the necessary relocations will trigger copy-on-write, and the
12214 shared object is not actually shared across processes.  Instead of
12215 using @option{-mimpure-text}, you should compile all source code with
12216 @option{-fpic} or @option{-fPIC}.
12218 This option is only available on SunOS and Solaris.
12220 @item -mcpu=@var{cpu_type}
12221 @opindex mcpu
12222 Set the instruction set, register set, and instruction scheduling parameters
12223 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12224 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12225 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12226 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
12227 @samp{ultrasparc3}.
12229 Default instruction scheduling parameters are used for values that select
12230 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12231 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12233 Here is a list of each supported architecture and their supported
12234 implementations.
12236 @smallexample
12237     v7:             cypress
12238     v8:             supersparc, hypersparc
12239     sparclite:      f930, f934, sparclite86x
12240     sparclet:       tsc701
12241     v9:             ultrasparc, ultrasparc3
12242 @end smallexample
12244 By default (unless configured otherwise), GCC generates code for the V7
12245 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
12246 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12247 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12248 SPARCStation 1, 2, IPX etc.
12250 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12251 architecture.  The only difference from V7 code is that the compiler emits
12252 the integer multiply and integer divide instructions which exist in SPARC-V8
12253 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12254 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12255 2000 series.
12257 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12258 the SPARC architecture.  This adds the integer multiply, integer divide step
12259 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12260 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12261 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12262 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12263 MB86934 chip, which is the more recent SPARClite with FPU@.
12265 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12266 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12267 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12268 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12269 optimizes it for the TEMIC SPARClet chip.
12271 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12272 architecture.  This adds 64-bit integer and floating-point move instructions,
12273 3 additional floating-point condition code registers and conditional move
12274 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12275 optimizes it for the Sun UltraSPARC I/II chips.  With
12276 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12277 Sun UltraSPARC III chip.
12279 @item -mtune=@var{cpu_type}
12280 @opindex mtune
12281 Set the instruction scheduling parameters for machine type
12282 @var{cpu_type}, but do not set the instruction set or register set that the
12283 option @option{-mcpu=@var{cpu_type}} would.
12285 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12286 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12287 that select a particular cpu implementation.  Those are @samp{cypress},
12288 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12289 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
12290 @samp{ultrasparc3}.
12292 @item -mv8plus
12293 @itemx -mno-v8plus
12294 @opindex mv8plus
12295 @opindex mno-v8plus
12296 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12297 difference from the V8 ABI is that the global and out registers are
12298 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12299 mode for all SPARC-V9 processors.
12301 @item -mvis
12302 @itemx -mno-vis
12303 @opindex mvis
12304 @opindex mno-vis
12305 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12306 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12307 @end table
12309 These @samp{-m} options are supported in addition to the above
12310 on SPARC-V9 processors in 64-bit environments:
12312 @table @gcctabopt
12313 @item -mlittle-endian
12314 @opindex mlittle-endian
12315 Generate code for a processor running in little-endian mode.  It is only
12316 available for a few configurations and most notably not on Solaris and Linux.
12318 @item -m32
12319 @itemx -m64
12320 @opindex m32
12321 @opindex m64
12322 Generate code for a 32-bit or 64-bit environment.
12323 The 32-bit environment sets int, long and pointer to 32 bits.
12324 The 64-bit environment sets int to 32 bits and long and pointer
12325 to 64 bits.
12327 @item -mcmodel=medlow
12328 @opindex mcmodel=medlow
12329 Generate code for the Medium/Low code model: 64-bit addresses, programs
12330 must be linked in the low 32 bits of memory.  Programs can be statically
12331 or dynamically linked.
12333 @item -mcmodel=medmid
12334 @opindex mcmodel=medmid
12335 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12336 must be linked in the low 44 bits of memory, the text and data segments must
12337 be less than 2GB in size and the data segment must be located within 2GB of
12338 the text segment.
12340 @item -mcmodel=medany
12341 @opindex mcmodel=medany
12342 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12343 may be linked anywhere in memory, the text and data segments must be less
12344 than 2GB in size and the data segment must be located within 2GB of the
12345 text segment.
12347 @item -mcmodel=embmedany
12348 @opindex mcmodel=embmedany
12349 Generate code for the Medium/Anywhere code model for embedded systems:
12350 64-bit addresses, the text and data segments must be less than 2GB in
12351 size, both starting anywhere in memory (determined at link time).  The
12352 global register %g4 points to the base of the data segment.  Programs
12353 are statically linked and PIC is not supported.
12355 @item -mstack-bias
12356 @itemx -mno-stack-bias
12357 @opindex mstack-bias
12358 @opindex mno-stack-bias
12359 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12360 frame pointer if present, are offset by @minus{}2047 which must be added back
12361 when making stack frame references.  This is the default in 64-bit mode.
12362 Otherwise, assume no such offset is present.
12363 @end table
12365 These switches are supported in addition to the above on Solaris:
12367 @table @gcctabopt
12368 @item -threads
12369 @opindex threads
12370 Add support for multithreading using the Solaris threads library.  This
12371 option sets flags for both the preprocessor and linker.  This option does
12372 not affect the thread safety of object code produced by the compiler or
12373 that of libraries supplied with it.
12375 @item -pthreads
12376 @opindex pthreads
12377 Add support for multithreading using the POSIX threads library.  This
12378 option sets flags for both the preprocessor and linker.  This option does
12379 not affect the thread safety of object code produced  by the compiler or
12380 that of libraries supplied with it.
12382 @item -pthread
12383 @opindex pthread
12384 This is a synonym for @option{-pthreads}.
12385 @end table
12387 @node System V Options
12388 @subsection Options for System V
12390 These additional options are available on System V Release 4 for
12391 compatibility with other compilers on those systems:
12393 @table @gcctabopt
12394 @item -G
12395 @opindex G
12396 Create a shared object.
12397 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12399 @item -Qy
12400 @opindex Qy
12401 Identify the versions of each tool used by the compiler, in a
12402 @code{.ident} assembler directive in the output.
12404 @item -Qn
12405 @opindex Qn
12406 Refrain from adding @code{.ident} directives to the output file (this is
12407 the default).
12409 @item -YP,@var{dirs}
12410 @opindex YP
12411 Search the directories @var{dirs}, and no others, for libraries
12412 specified with @option{-l}.
12414 @item -Ym,@var{dir}
12415 @opindex Ym
12416 Look in the directory @var{dir} to find the M4 preprocessor.
12417 The assembler uses this option.
12418 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12419 @c the generic assembler that comes with Solaris takes just -Ym.
12420 @end table
12422 @node TMS320C3x/C4x Options
12423 @subsection TMS320C3x/C4x Options
12424 @cindex TMS320C3x/C4x Options
12426 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12428 @table @gcctabopt
12430 @item -mcpu=@var{cpu_type}
12431 @opindex mcpu
12432 Set the instruction set, register set, and instruction scheduling
12433 parameters for machine type @var{cpu_type}.  Supported values for
12434 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12435 @samp{c44}.  The default is @samp{c40} to generate code for the
12436 TMS320C40.
12438 @item -mbig-memory
12439 @itemx -mbig
12440 @itemx -msmall-memory
12441 @itemx -msmall
12442 @opindex mbig-memory
12443 @opindex mbig
12444 @opindex msmall-memory
12445 @opindex msmall
12446 Generates code for the big or small memory model.  The small memory
12447 model assumed that all data fits into one 64K word page.  At run-time
12448 the data page (DP) register must be set to point to the 64K page
12449 containing the .bss and .data program sections.  The big memory model is
12450 the default and requires reloading of the DP register for every direct
12451 memory access.
12453 @item -mbk
12454 @itemx -mno-bk
12455 @opindex mbk
12456 @opindex mno-bk
12457 Allow (disallow) allocation of general integer operands into the block
12458 count register BK@.
12460 @item -mdb
12461 @itemx -mno-db
12462 @opindex mdb
12463 @opindex mno-db
12464 Enable (disable) generation of code using decrement and branch,
12465 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12466 on the safe side, this is disabled for the C3x, since the maximum
12467 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12468 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12469 that it can utilize the decrement and branch instruction, but will give
12470 up if there is more than one memory reference in the loop.  Thus a loop
12471 where the loop counter is decremented can generate slightly more
12472 efficient code, in cases where the RPTB instruction cannot be utilized.
12474 @item -mdp-isr-reload
12475 @itemx -mparanoid
12476 @opindex mdp-isr-reload
12477 @opindex mparanoid
12478 Force the DP register to be saved on entry to an interrupt service
12479 routine (ISR), reloaded to point to the data section, and restored on
12480 exit from the ISR@.  This should not be required unless someone has
12481 violated the small memory model by modifying the DP register, say within
12482 an object library.
12484 @item -mmpyi
12485 @itemx -mno-mpyi
12486 @opindex mmpyi
12487 @opindex mno-mpyi
12488 For the C3x use the 24-bit MPYI instruction for integer multiplies
12489 instead of a library call to guarantee 32-bit results.  Note that if one
12490 of the operands is a constant, then the multiplication will be performed
12491 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12492 then squaring operations are performed inline instead of a library call.
12494 @item -mfast-fix
12495 @itemx -mno-fast-fix
12496 @opindex mfast-fix
12497 @opindex mno-fast-fix
12498 The C3x/C4x FIX instruction to convert a floating point value to an
12499 integer value chooses the nearest integer less than or equal to the
12500 floating point value rather than to the nearest integer.  Thus if the
12501 floating point number is negative, the result will be incorrectly
12502 truncated an additional code is necessary to detect and correct this
12503 case.  This option can be used to disable generation of the additional
12504 code required to correct the result.
12506 @item -mrptb
12507 @itemx -mno-rptb
12508 @opindex mrptb
12509 @opindex mno-rptb
12510 Enable (disable) generation of repeat block sequences using the RPTB
12511 instruction for zero overhead looping.  The RPTB construct is only used
12512 for innermost loops that do not call functions or jump across the loop
12513 boundaries.  There is no advantage having nested RPTB loops due to the
12514 overhead required to save and restore the RC, RS, and RE registers.
12515 This is enabled by default with @option{-O2}.
12517 @item -mrpts=@var{count}
12518 @itemx -mno-rpts
12519 @opindex mrpts
12520 @opindex mno-rpts
12521 Enable (disable) the use of the single instruction repeat instruction
12522 RPTS@.  If a repeat block contains a single instruction, and the loop
12523 count can be guaranteed to be less than the value @var{count}, GCC will
12524 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12525 then a RPTS will be emitted even if the loop count cannot be determined
12526 at compile time.  Note that the repeated instruction following RPTS does
12527 not have to be reloaded from memory each iteration, thus freeing up the
12528 CPU buses for operands.  However, since interrupts are blocked by this
12529 instruction, it is disabled by default.
12531 @item -mloop-unsigned
12532 @itemx -mno-loop-unsigned
12533 @opindex mloop-unsigned
12534 @opindex mno-loop-unsigned
12535 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12536 is @math{2^{31} + 1} since these instructions test if the iteration count is
12537 negative to terminate the loop.  If the iteration count is unsigned
12538 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12539 exceeded.  This switch allows an unsigned iteration count.
12541 @item -mti
12542 @opindex mti
12543 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12544 with.  This also enforces compatibility with the API employed by the TI
12545 C3x C compiler.  For example, long doubles are passed as structures
12546 rather than in floating point registers.
12548 @item -mregparm
12549 @itemx -mmemparm
12550 @opindex mregparm
12551 @opindex mmemparm
12552 Generate code that uses registers (stack) for passing arguments to functions.
12553 By default, arguments are passed in registers where possible rather
12554 than by pushing arguments on to the stack.
12556 @item -mparallel-insns
12557 @itemx -mno-parallel-insns
12558 @opindex mparallel-insns
12559 @opindex mno-parallel-insns
12560 Allow the generation of parallel instructions.  This is enabled by
12561 default with @option{-O2}.
12563 @item -mparallel-mpy
12564 @itemx -mno-parallel-mpy
12565 @opindex mparallel-mpy
12566 @opindex mno-parallel-mpy
12567 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12568 provided @option{-mparallel-insns} is also specified.  These instructions have
12569 tight register constraints which can pessimize the code generation
12570 of large functions.
12572 @end table
12574 @node V850 Options
12575 @subsection V850 Options
12576 @cindex V850 Options
12578 These @samp{-m} options are defined for V850 implementations:
12580 @table @gcctabopt
12581 @item -mlong-calls
12582 @itemx -mno-long-calls
12583 @opindex mlong-calls
12584 @opindex mno-long-calls
12585 Treat all calls as being far away (near).  If calls are assumed to be
12586 far away, the compiler will always load the functions address up into a
12587 register, and call indirect through the pointer.
12589 @item -mno-ep
12590 @itemx -mep
12591 @opindex mno-ep
12592 @opindex mep
12593 Do not optimize (do optimize) basic blocks that use the same index
12594 pointer 4 or more times to copy pointer into the @code{ep} register, and
12595 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12596 option is on by default if you optimize.
12598 @item -mno-prolog-function
12599 @itemx -mprolog-function
12600 @opindex mno-prolog-function
12601 @opindex mprolog-function
12602 Do not use (do use) external functions to save and restore registers
12603 at the prologue and epilogue of a function.  The external functions
12604 are slower, but use less code space if more than one function saves
12605 the same number of registers.  The @option{-mprolog-function} option
12606 is on by default if you optimize.
12608 @item -mspace
12609 @opindex mspace
12610 Try to make the code as small as possible.  At present, this just turns
12611 on the @option{-mep} and @option{-mprolog-function} options.
12613 @item -mtda=@var{n}
12614 @opindex mtda
12615 Put static or global variables whose size is @var{n} bytes or less into
12616 the tiny data area that register @code{ep} points to.  The tiny data
12617 area can hold up to 256 bytes in total (128 bytes for byte references).
12619 @item -msda=@var{n}
12620 @opindex msda
12621 Put static or global variables whose size is @var{n} bytes or less into
12622 the small data area that register @code{gp} points to.  The small data
12623 area can hold up to 64 kilobytes.
12625 @item -mzda=@var{n}
12626 @opindex mzda
12627 Put static or global variables whose size is @var{n} bytes or less into
12628 the first 32 kilobytes of memory.
12630 @item -mv850
12631 @opindex mv850
12632 Specify that the target processor is the V850.
12634 @item -mbig-switch
12635 @opindex mbig-switch
12636 Generate code suitable for big switch tables.  Use this option only if
12637 the assembler/linker complain about out of range branches within a switch
12638 table.
12640 @item -mapp-regs
12641 @opindex mapp-regs
12642 This option will cause r2 and r5 to be used in the code generated by
12643 the compiler.  This setting is the default.
12645 @item -mno-app-regs
12646 @opindex mno-app-regs
12647 This option will cause r2 and r5 to be treated as fixed registers.
12649 @item -mv850e1
12650 @opindex mv850e1
12651 Specify that the target processor is the V850E1.  The preprocessor
12652 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12653 this option is used.
12655 @item -mv850e
12656 @opindex mv850e
12657 Specify that the target processor is the V850E@.  The preprocessor
12658 constant @samp{__v850e__} will be defined if this option is used.
12660 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12661 are defined then a default target processor will be chosen and the
12662 relevant @samp{__v850*__} preprocessor constant will be defined.
12664 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12665 defined, regardless of which processor variant is the target.
12667 @item -mdisable-callt
12668 @opindex mdisable-callt
12669 This option will suppress generation of the CALLT instruction for the
12670 v850e and v850e1 flavors of the v850 architecture.  The default is
12671 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12673 @end table
12675 @node VAX Options
12676 @subsection VAX Options
12677 @cindex VAX options
12679 These @samp{-m} options are defined for the VAX:
12681 @table @gcctabopt
12682 @item -munix
12683 @opindex munix
12684 Do not output certain jump instructions (@code{aobleq} and so on)
12685 that the Unix assembler for the VAX cannot handle across long
12686 ranges.
12688 @item -mgnu
12689 @opindex mgnu
12690 Do output those jump instructions, on the assumption that you
12691 will assemble with the GNU assembler.
12693 @item -mg
12694 @opindex mg
12695 Output code for g-format floating point numbers instead of d-format.
12696 @end table
12698 @node x86-64 Options
12699 @subsection x86-64 Options
12700 @cindex x86-64 options
12702 These are listed under @xref{i386 and x86-64 Options}.
12704 @node Xstormy16 Options
12705 @subsection Xstormy16 Options
12706 @cindex Xstormy16 Options
12708 These options are defined for Xstormy16:
12710 @table @gcctabopt
12711 @item -msim
12712 @opindex msim
12713 Choose startup files and linker script suitable for the simulator.
12714 @end table
12716 @node Xtensa Options
12717 @subsection Xtensa Options
12718 @cindex Xtensa Options
12720 These options are supported for Xtensa targets:
12722 @table @gcctabopt
12723 @item -mconst16
12724 @itemx -mno-const16
12725 @opindex mconst16
12726 @opindex mno-const16
12727 Enable or disable use of @code{CONST16} instructions for loading
12728 constant values.  The @code{CONST16} instruction is currently not a
12729 standard option from Tensilica.  When enabled, @code{CONST16}
12730 instructions are always used in place of the standard @code{L32R}
12731 instructions.  The use of @code{CONST16} is enabled by default only if
12732 the @code{L32R} instruction is not available.
12734 @item -mfused-madd
12735 @itemx -mno-fused-madd
12736 @opindex mfused-madd
12737 @opindex mno-fused-madd
12738 Enable or disable use of fused multiply/add and multiply/subtract
12739 instructions in the floating-point option.  This has no effect if the
12740 floating-point option is not also enabled.  Disabling fused multiply/add
12741 and multiply/subtract instructions forces the compiler to use separate
12742 instructions for the multiply and add/subtract operations.  This may be
12743 desirable in some cases where strict IEEE 754-compliant results are
12744 required: the fused multiply add/subtract instructions do not round the
12745 intermediate result, thereby producing results with @emph{more} bits of
12746 precision than specified by the IEEE standard.  Disabling fused multiply
12747 add/subtract instructions also ensures that the program output is not
12748 sensitive to the compiler's ability to combine multiply and add/subtract
12749 operations.
12751 @item -mtext-section-literals
12752 @itemx -mno-text-section-literals
12753 @opindex mtext-section-literals
12754 @opindex mno-text-section-literals
12755 Control the treatment of literal pools.  The default is
12756 @option{-mno-text-section-literals}, which places literals in a separate
12757 section in the output file.  This allows the literal pool to be placed
12758 in a data RAM/ROM, and it also allows the linker to combine literal
12759 pools from separate object files to remove redundant literals and
12760 improve code size.  With @option{-mtext-section-literals}, the literals
12761 are interspersed in the text section in order to keep them as close as
12762 possible to their references.  This may be necessary for large assembly
12763 files.
12765 @item -mtarget-align
12766 @itemx -mno-target-align
12767 @opindex mtarget-align
12768 @opindex mno-target-align
12769 When this option is enabled, GCC instructs the assembler to
12770 automatically align instructions to reduce branch penalties at the
12771 expense of some code density.  The assembler attempts to widen density
12772 instructions to align branch targets and the instructions following call
12773 instructions.  If there are not enough preceding safe density
12774 instructions to align a target, no widening will be performed.  The
12775 default is @option{-mtarget-align}.  These options do not affect the
12776 treatment of auto-aligned instructions like @code{LOOP}, which the
12777 assembler will always align, either by widening density instructions or
12778 by inserting no-op instructions.
12780 @item -mlongcalls
12781 @itemx -mno-longcalls
12782 @opindex mlongcalls
12783 @opindex mno-longcalls
12784 When this option is enabled, GCC instructs the assembler to translate
12785 direct calls to indirect calls unless it can determine that the target
12786 of a direct call is in the range allowed by the call instruction.  This
12787 translation typically occurs for calls to functions in other source
12788 files.  Specifically, the assembler translates a direct @code{CALL}
12789 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12790 The default is @option{-mno-longcalls}.  This option should be used in
12791 programs where the call target can potentially be out of range.  This
12792 option is implemented in the assembler, not the compiler, so the
12793 assembly code generated by GCC will still show direct call
12794 instructions---look at the disassembled object code to see the actual
12795 instructions.  Note that the assembler will use an indirect call for
12796 every cross-file call, not just those that really will be out of range.
12797 @end table
12799 @node zSeries Options
12800 @subsection zSeries Options
12801 @cindex zSeries options
12803 These are listed under @xref{S/390 and zSeries Options}.
12805 @node Code Gen Options
12806 @section Options for Code Generation Conventions
12807 @cindex code generation conventions
12808 @cindex options, code generation
12809 @cindex run-time options
12811 These machine-independent options control the interface conventions
12812 used in code generation.
12814 Most of them have both positive and negative forms; the negative form
12815 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12816 one of the forms is listed---the one which is not the default.  You
12817 can figure out the other form by either removing @samp{no-} or adding
12820 @table @gcctabopt
12821 @item -fbounds-check
12822 @opindex fbounds-check
12823 For front-ends that support it, generate additional code to check that
12824 indices used to access arrays are within the declared range.  This is
12825 currently only supported by the Java and Fortran 77 front-ends, where
12826 this option defaults to true and false respectively.
12828 @item -ftrapv
12829 @opindex ftrapv
12830 This option generates traps for signed overflow on addition, subtraction,
12831 multiplication operations.
12833 @item -fwrapv
12834 @opindex fwrapv
12835 This option instructs the compiler to assume that signed arithmetic
12836 overflow of addition, subtraction and multiplication wraps around
12837 using twos-complement representation.  This flag enables some optimizations
12838 and disables others.  This option is enabled by default for the Java
12839 front-end, as required by the Java language specification.
12841 @item -fexceptions
12842 @opindex fexceptions
12843 Enable exception handling.  Generates extra code needed to propagate
12844 exceptions.  For some targets, this implies GCC will generate frame
12845 unwind information for all functions, which can produce significant data
12846 size overhead, although it does not affect execution.  If you do not
12847 specify this option, GCC will enable it by default for languages like
12848 C++ which normally require exception handling, and disable it for
12849 languages like C that do not normally require it.  However, you may need
12850 to enable this option when compiling C code that needs to interoperate
12851 properly with exception handlers written in C++.  You may also wish to
12852 disable this option if you are compiling older C++ programs that don't
12853 use exception handling.
12855 @item -fnon-call-exceptions
12856 @opindex fnon-call-exceptions
12857 Generate code that allows trapping instructions to throw exceptions.
12858 Note that this requires platform-specific runtime support that does
12859 not exist everywhere.  Moreover, it only allows @emph{trapping}
12860 instructions to throw exceptions, i.e.@: memory references or floating
12861 point instructions.  It does not allow exceptions to be thrown from
12862 arbitrary signal handlers such as @code{SIGALRM}.
12864 @item -funwind-tables
12865 @opindex funwind-tables
12866 Similar to @option{-fexceptions}, except that it will just generate any needed
12867 static data, but will not affect the generated code in any other way.
12868 You will normally not enable this option; instead, a language processor
12869 that needs this handling would enable it on your behalf.
12871 @item -fasynchronous-unwind-tables
12872 @opindex fasynchronous-unwind-tables
12873 Generate unwind table in dwarf2 format, if supported by target machine.  The
12874 table is exact at each instruction boundary, so it can be used for stack
12875 unwinding from asynchronous events (such as debugger or garbage collector).
12877 @item -fpcc-struct-return
12878 @opindex fpcc-struct-return
12879 Return ``short'' @code{struct} and @code{union} values in memory like
12880 longer ones, rather than in registers.  This convention is less
12881 efficient, but it has the advantage of allowing intercallability between
12882 GCC-compiled files and files compiled with other compilers, particularly
12883 the Portable C Compiler (pcc).
12885 The precise convention for returning structures in memory depends
12886 on the target configuration macros.
12888 Short structures and unions are those whose size and alignment match
12889 that of some integer type.
12891 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12892 switch is not binary compatible with code compiled with the
12893 @option{-freg-struct-return} switch.
12894 Use it to conform to a non-default application binary interface.
12896 @item -freg-struct-return
12897 @opindex freg-struct-return
12898 Return @code{struct} and @code{union} values in registers when possible.
12899 This is more efficient for small structures than
12900 @option{-fpcc-struct-return}.
12902 If you specify neither @option{-fpcc-struct-return} nor
12903 @option{-freg-struct-return}, GCC defaults to whichever convention is
12904 standard for the target.  If there is no standard convention, GCC
12905 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12906 the principal compiler.  In those cases, we can choose the standard, and
12907 we chose the more efficient register return alternative.
12909 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12910 switch is not binary compatible with code compiled with the
12911 @option{-fpcc-struct-return} switch.
12912 Use it to conform to a non-default application binary interface.
12914 @item -fshort-enums
12915 @opindex fshort-enums
12916 Allocate to an @code{enum} type only as many bytes as it needs for the
12917 declared range of possible values.  Specifically, the @code{enum} type
12918 will be equivalent to the smallest integer type which has enough room.
12920 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12921 code that is not binary compatible with code generated without that switch.
12922 Use it to conform to a non-default application binary interface.
12924 @item -fshort-double
12925 @opindex fshort-double
12926 Use the same size for @code{double} as for @code{float}.
12928 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12929 code that is not binary compatible with code generated without that switch.
12930 Use it to conform to a non-default application binary interface.
12932 @item -fshort-wchar
12933 @opindex fshort-wchar
12934 Override the underlying type for @samp{wchar_t} to be @samp{short
12935 unsigned int} instead of the default for the target.  This option is
12936 useful for building programs to run under WINE@.
12938 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12939 code that is not binary compatible with code generated without that switch.
12940 Use it to conform to a non-default application binary interface.
12942 @item -fshared-data
12943 @opindex fshared-data
12944 Requests that the data and non-@code{const} variables of this
12945 compilation be shared data rather than private data.  The distinction
12946 makes sense only on certain operating systems, where shared data is
12947 shared between processes running the same program, while private data
12948 exists in one copy per process.
12950 @item -fno-common
12951 @opindex fno-common
12952 In C, allocate even uninitialized global variables in the data section of the
12953 object file, rather than generating them as common blocks.  This has the
12954 effect that if the same variable is declared (without @code{extern}) in
12955 two different compilations, you will get an error when you link them.
12956 The only reason this might be useful is if you wish to verify that the
12957 program will work on other systems which always work this way.
12959 @item -fno-ident
12960 @opindex fno-ident
12961 Ignore the @samp{#ident} directive.
12963 @item -finhibit-size-directive
12964 @opindex finhibit-size-directive
12965 Don't output a @code{.size} assembler directive, or anything else that
12966 would cause trouble if the function is split in the middle, and the
12967 two halves are placed at locations far apart in memory.  This option is
12968 used when compiling @file{crtstuff.c}; you should not need to use it
12969 for anything else.
12971 @item -fverbose-asm
12972 @opindex fverbose-asm
12973 Put extra commentary information in the generated assembly code to
12974 make it more readable.  This option is generally only of use to those
12975 who actually need to read the generated assembly code (perhaps while
12976 debugging the compiler itself).
12978 @option{-fno-verbose-asm}, the default, causes the
12979 extra information to be omitted and is useful when comparing two assembler
12980 files.
12982 @item -fpic
12983 @opindex fpic
12984 @cindex global offset table
12985 @cindex PIC
12986 Generate position-independent code (PIC) suitable for use in a shared
12987 library, if supported for the target machine.  Such code accesses all
12988 constant addresses through a global offset table (GOT)@.  The dynamic
12989 loader resolves the GOT entries when the program starts (the dynamic
12990 loader is not part of GCC; it is part of the operating system).  If
12991 the GOT size for the linked executable exceeds a machine-specific
12992 maximum size, you get an error message from the linker indicating that
12993 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12994 instead.  (These maximums are 8k on the SPARC and 32k
12995 on the m68k and RS/6000.  The 386 has no such limit.)
12997 Position-independent code requires special support, and therefore works
12998 only on certain machines.  For the 386, GCC supports PIC for System V
12999 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13000 position-independent.
13002 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13003 are defined to 1.
13005 @item -fPIC
13006 @opindex fPIC
13007 If supported for the target machine, emit position-independent code,
13008 suitable for dynamic linking and avoiding any limit on the size of the
13009 global offset table.  This option makes a difference on the m68k,
13010 PowerPC and SPARC@.
13012 Position-independent code requires special support, and therefore works
13013 only on certain machines.
13015 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13016 are defined to 2.
13018 @item -fpie
13019 @itemx -fPIE
13020 @opindex fpie
13021 @opindex fPIE
13022 These options are similar to @option{-fpic} and @option{-fPIC}, but
13023 generated position independent code can be only linked into executables.
13024 Usually these options are used when @option{-pie} GCC option will be
13025 used during linking.
13027 @item -fno-jump-tables
13028 @opindex fno-jump-tables
13029 Do not use jump tables for switch statements even where it would be
13030 more efficient than other code generation strategies.  This option is
13031 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13032 building code which forms part of a dynamic linker and cannot
13033 reference the address of a jump table.  On some targets, jump tables
13034 do not require a GOT and this option is not needed.
13036 @item -ffixed-@var{reg}
13037 @opindex ffixed
13038 Treat the register named @var{reg} as a fixed register; generated code
13039 should never refer to it (except perhaps as a stack pointer, frame
13040 pointer or in some other fixed role).
13042 @var{reg} must be the name of a register.  The register names accepted
13043 are machine-specific and are defined in the @code{REGISTER_NAMES}
13044 macro in the machine description macro file.
13046 This flag does not have a negative form, because it specifies a
13047 three-way choice.
13049 @item -fcall-used-@var{reg}
13050 @opindex fcall-used
13051 Treat the register named @var{reg} as an allocable register that is
13052 clobbered by function calls.  It may be allocated for temporaries or
13053 variables that do not live across a call.  Functions compiled this way
13054 will not save and restore the register @var{reg}.
13056 It is an error to used this flag with the frame pointer or stack pointer.
13057 Use of this flag for other registers that have fixed pervasive roles in
13058 the machine's execution model will produce disastrous results.
13060 This flag does not have a negative form, because it specifies a
13061 three-way choice.
13063 @item -fcall-saved-@var{reg}
13064 @opindex fcall-saved
13065 Treat the register named @var{reg} as an allocable register saved by
13066 functions.  It may be allocated even for temporaries or variables that
13067 live across a call.  Functions compiled this way will save and restore
13068 the register @var{reg} if they use it.
13070 It is an error to used this flag with the frame pointer or stack pointer.
13071 Use of this flag for other registers that have fixed pervasive roles in
13072 the machine's execution model will produce disastrous results.
13074 A different sort of disaster will result from the use of this flag for
13075 a register in which function values may be returned.
13077 This flag does not have a negative form, because it specifies a
13078 three-way choice.
13080 @item -fpack-struct[=@var{n}]
13081 @opindex fpack-struct
13082 Without a value specified, pack all structure members together without
13083 holes.  When a value is specified (which must be a small power of two), pack
13084 structure members according to this value, representing the maximum
13085 alignment (that is, objects with default alignment requirements larger than
13086 this will be output potentially unaligned at the next fitting location.
13088 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13089 code that is not binary compatible with code generated without that switch.
13090 Additionally, it makes the code suboptimal.
13091 Use it to conform to a non-default application binary interface.
13093 @item -finstrument-functions
13094 @opindex finstrument-functions
13095 Generate instrumentation calls for entry and exit to functions.  Just
13096 after function entry and just before function exit, the following
13097 profiling functions will be called with the address of the current
13098 function and its call site.  (On some platforms,
13099 @code{__builtin_return_address} does not work beyond the current
13100 function, so the call site information may not be available to the
13101 profiling functions otherwise.)
13103 @smallexample
13104 void __cyg_profile_func_enter (void *this_fn,
13105                                void *call_site);
13106 void __cyg_profile_func_exit  (void *this_fn,
13107                                void *call_site);
13108 @end smallexample
13110 The first argument is the address of the start of the current function,
13111 which may be looked up exactly in the symbol table.
13113 This instrumentation is also done for functions expanded inline in other
13114 functions.  The profiling calls will indicate where, conceptually, the
13115 inline function is entered and exited.  This means that addressable
13116 versions of such functions must be available.  If all your uses of a
13117 function are expanded inline, this may mean an additional expansion of
13118 code size.  If you use @samp{extern inline} in your C code, an
13119 addressable version of such functions must be provided.  (This is
13120 normally the case anyways, but if you get lucky and the optimizer always
13121 expands the functions inline, you might have gotten away without
13122 providing static copies.)
13124 A function may be given the attribute @code{no_instrument_function}, in
13125 which case this instrumentation will not be done.  This can be used, for
13126 example, for the profiling functions listed above, high-priority
13127 interrupt routines, and any functions from which the profiling functions
13128 cannot safely be called (perhaps signal handlers, if the profiling
13129 routines generate output or allocate memory).
13131 @item -fstack-check
13132 @opindex fstack-check
13133 Generate code to verify that you do not go beyond the boundary of the
13134 stack.  You should specify this flag if you are running in an
13135 environment with multiple threads, but only rarely need to specify it in
13136 a single-threaded environment since stack overflow is automatically
13137 detected on nearly all systems if there is only one stack.
13139 Note that this switch does not actually cause checking to be done; the
13140 operating system must do that.  The switch causes generation of code
13141 to ensure that the operating system sees the stack being extended.
13143 @item -fstack-limit-register=@var{reg}
13144 @itemx -fstack-limit-symbol=@var{sym}
13145 @itemx -fno-stack-limit
13146 @opindex fstack-limit-register
13147 @opindex fstack-limit-symbol
13148 @opindex fno-stack-limit
13149 Generate code to ensure that the stack does not grow beyond a certain value,
13150 either the value of a register or the address of a symbol.  If the stack
13151 would grow beyond the value, a signal is raised.  For most targets,
13152 the signal is raised before the stack overruns the boundary, so
13153 it is possible to catch the signal without taking special precautions.
13155 For instance, if the stack starts at absolute address @samp{0x80000000}
13156 and grows downwards, you can use the flags
13157 @option{-fstack-limit-symbol=__stack_limit} and
13158 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13159 of 128KB@.  Note that this may only work with the GNU linker.
13161 @cindex aliasing of parameters
13162 @cindex parameters, aliased
13163 @item -fargument-alias
13164 @itemx -fargument-noalias
13165 @itemx -fargument-noalias-global
13166 @opindex fargument-alias
13167 @opindex fargument-noalias
13168 @opindex fargument-noalias-global
13169 Specify the possible relationships among parameters and between
13170 parameters and global data.
13172 @option{-fargument-alias} specifies that arguments (parameters) may
13173 alias each other and may alias global storage.@*
13174 @option{-fargument-noalias} specifies that arguments do not alias
13175 each other, but may alias global storage.@*
13176 @option{-fargument-noalias-global} specifies that arguments do not
13177 alias each other and do not alias global storage.
13179 Each language will automatically use whatever option is required by
13180 the language standard.  You should not need to use these options yourself.
13182 @item -fleading-underscore
13183 @opindex fleading-underscore
13184 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13185 change the way C symbols are represented in the object file.  One use
13186 is to help link with legacy assembly code.
13188 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13189 generate code that is not binary compatible with code generated without that
13190 switch.  Use it to conform to a non-default application binary interface.
13191 Not all targets provide complete support for this switch.
13193 @item -ftls-model=@var{model}
13194 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13195 The @var{model} argument should be one of @code{global-dynamic},
13196 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13198 The default without @option{-fpic} is @code{initial-exec}; with
13199 @option{-fpic} the default is @code{global-dynamic}.
13201 @item -fvisibility=@var{default|internal|hidden|protected}
13202 @opindex fvisibility
13203 Set the default ELF image symbol visibility to the specified option---all
13204 symbols will be marked with this unless overridden within the code.
13205 Using this feature can very substantially improve linking and
13206 load times of shared object libraries, produce more optimized
13207 code, provide near-perfect API export and prevent symbol clashes.
13208 It is @strong{strongly} recommended that you use this in any shared objects
13209 you distribute.
13211 Despite the nomenclature, @code{default} always means public ie;
13212 available to be linked against from outside the shared object.
13213 @code{protected} and @code{internal} are pretty useless in real-world
13214 usage so the only other commonly used option will be @code{hidden}.
13215 The default if @option{-fvisibility} isn't specified is
13216 @code{default}, i.e., make every
13217 symbol public---this causes the same behavior as previous versions of
13218 GCC@.
13220 A good explanation of the benefits offered by ensuring ELF
13221 symbols have the correct visibility is given by ``How To Write
13222 Shared Libraries'' by Ulrich Drepper (which can be found at
13223 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13224 solution made possible by this option to marking things hidden when
13225 the default is public is to make the default hidden and mark things
13226 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13227 and @code{__attribute__ ((visibility("default")))} instead of
13228 @code{__declspec(dllexport)} you get almost identical semantics with
13229 identical syntax.  This is a great boon to those working with
13230 cross-platform projects.
13232 For those adding visibility support to existing code, you may find
13233 @samp{#pragma GCC visibility} of use.  This works by you enclosing
13234 the declarations you wish to set visibility for with (for example)
13235 @samp{#pragma GCC visibility push(hidden)} and
13236 @samp{#pragma GCC visibility pop}.
13237 Bear in mind that symbol visibility should be viewed @strong{as
13238 part of the API interface contract} and thus all new code should
13239 always specify visibility when it is not the default ie; declarations
13240 only for use within the local DSO should @strong{always} be marked explicitly
13241 as hidden as so to avoid PLT indirection overheads---making this
13242 abundantly clear also aids readability and self-documentation of the code.
13243 Note that due to ISO C++ specification requirements, operator new and
13244 operator delete must always be of default visibility.
13246 An overview of these techniques, their benefits and how to use them
13247 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13249 @end table
13251 @c man end
13253 @node Environment Variables
13254 @section Environment Variables Affecting GCC
13255 @cindex environment variables
13257 @c man begin ENVIRONMENT
13258 This section describes several environment variables that affect how GCC
13259 operates.  Some of them work by specifying directories or prefixes to use
13260 when searching for various kinds of files.  Some are used to specify other
13261 aspects of the compilation environment.
13263 Note that you can also specify places to search using options such as
13264 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13265 take precedence over places specified using environment variables, which
13266 in turn take precedence over those specified by the configuration of GCC@.
13267 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13268 GNU Compiler Collection (GCC) Internals}.
13270 @table @env
13271 @item LANG
13272 @itemx LC_CTYPE
13273 @c @itemx LC_COLLATE
13274 @itemx LC_MESSAGES
13275 @c @itemx LC_MONETARY
13276 @c @itemx LC_NUMERIC
13277 @c @itemx LC_TIME
13278 @itemx LC_ALL
13279 @findex LANG
13280 @findex LC_CTYPE
13281 @c @findex LC_COLLATE
13282 @findex LC_MESSAGES
13283 @c @findex LC_MONETARY
13284 @c @findex LC_NUMERIC
13285 @c @findex LC_TIME
13286 @findex LC_ALL
13287 @cindex locale
13288 These environment variables control the way that GCC uses
13289 localization information that allow GCC to work with different
13290 national conventions.  GCC inspects the locale categories
13291 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13292 so.  These locale categories can be set to any value supported by your
13293 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13294 Kingdom encoded in UTF-8.
13296 The @env{LC_CTYPE} environment variable specifies character
13297 classification.  GCC uses it to determine the character boundaries in
13298 a string; this is needed for some multibyte encodings that contain quote
13299 and escape characters that would otherwise be interpreted as a string
13300 end or escape.
13302 The @env{LC_MESSAGES} environment variable specifies the language to
13303 use in diagnostic messages.
13305 If the @env{LC_ALL} environment variable is set, it overrides the value
13306 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13307 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13308 environment variable.  If none of these variables are set, GCC
13309 defaults to traditional C English behavior.
13311 @item TMPDIR
13312 @findex TMPDIR
13313 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13314 files.  GCC uses temporary files to hold the output of one stage of
13315 compilation which is to be used as input to the next stage: for example,
13316 the output of the preprocessor, which is the input to the compiler
13317 proper.
13319 @item GCC_EXEC_PREFIX
13320 @findex GCC_EXEC_PREFIX
13321 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13322 names of the subprograms executed by the compiler.  No slash is added
13323 when this prefix is combined with the name of a subprogram, but you can
13324 specify a prefix that ends with a slash if you wish.
13326 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13327 an appropriate prefix to use based on the pathname it was invoked with.
13329 If GCC cannot find the subprogram using the specified prefix, it
13330 tries looking in the usual places for the subprogram.
13332 The default value of @env{GCC_EXEC_PREFIX} is
13333 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13334 of @code{prefix} when you ran the @file{configure} script.
13336 Other prefixes specified with @option{-B} take precedence over this prefix.
13338 This prefix is also used for finding files such as @file{crt0.o} that are
13339 used for linking.
13341 In addition, the prefix is used in an unusual way in finding the
13342 directories to search for header files.  For each of the standard
13343 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13344 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13345 replacing that beginning with the specified prefix to produce an
13346 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13347 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13348 These alternate directories are searched first; the standard directories
13349 come next.
13351 @item COMPILER_PATH
13352 @findex COMPILER_PATH
13353 The value of @env{COMPILER_PATH} is a colon-separated list of
13354 directories, much like @env{PATH}.  GCC tries the directories thus
13355 specified when searching for subprograms, if it can't find the
13356 subprograms using @env{GCC_EXEC_PREFIX}.
13358 @item LIBRARY_PATH
13359 @findex LIBRARY_PATH
13360 The value of @env{LIBRARY_PATH} is a colon-separated list of
13361 directories, much like @env{PATH}.  When configured as a native compiler,
13362 GCC tries the directories thus specified when searching for special
13363 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13364 using GCC also uses these directories when searching for ordinary
13365 libraries for the @option{-l} option (but directories specified with
13366 @option{-L} come first).
13368 @item LANG
13369 @findex LANG
13370 @cindex locale definition
13371 This variable is used to pass locale information to the compiler.  One way in
13372 which this information is used is to determine the character set to be used
13373 when character literals, string literals and comments are parsed in C and C++.
13374 When the compiler is configured to allow multibyte characters,
13375 the following values for @env{LANG} are recognized:
13377 @table @samp
13378 @item C-JIS
13379 Recognize JIS characters.
13380 @item C-SJIS
13381 Recognize SJIS characters.
13382 @item C-EUCJP
13383 Recognize EUCJP characters.
13384 @end table
13386 If @env{LANG} is not defined, or if it has some other value, then the
13387 compiler will use mblen and mbtowc as defined by the default locale to
13388 recognize and translate multibyte characters.
13389 @end table
13391 @noindent
13392 Some additional environments variables affect the behavior of the
13393 preprocessor.
13395 @include cppenv.texi
13397 @c man end
13399 @node Precompiled Headers
13400 @section Using Precompiled Headers
13401 @cindex precompiled headers
13402 @cindex speed of compilation
13404 Often large projects have many header files that are included in every
13405 source file.  The time the compiler takes to process these header files
13406 over and over again can account for nearly all of the time required to
13407 build the project.  To make builds faster, GCC allows users to
13408 `precompile' a header file; then, if builds can use the precompiled
13409 header file they will be much faster.
13411 To create a precompiled header file, simply compile it as you would any
13412 other file, if necessary using the @option{-x} option to make the driver
13413 treat it as a C or C++ header file.  You will probably want to use a
13414 tool like @command{make} to keep the precompiled header up-to-date when
13415 the headers it contains change.
13417 A precompiled header file will be searched for when @code{#include} is
13418 seen in the compilation.  As it searches for the included file
13419 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13420 compiler looks for a precompiled header in each directory just before it
13421 looks for the include file in that directory.  The name searched for is
13422 the name specified in the @code{#include} with @samp{.gch} appended.  If
13423 the precompiled header file can't be used, it is ignored.
13425 For instance, if you have @code{#include "all.h"}, and you have
13426 @file{all.h.gch} in the same directory as @file{all.h}, then the
13427 precompiled header file will be used if possible, and the original
13428 header will be used otherwise.
13430 Alternatively, you might decide to put the precompiled header file in a
13431 directory and use @option{-I} to ensure that directory is searched
13432 before (or instead of) the directory containing the original header.
13433 Then, if you want to check that the precompiled header file is always
13434 used, you can put a file of the same name as the original header in this
13435 directory containing an @code{#error} command.
13437 This also works with @option{-include}.  So yet another way to use
13438 precompiled headers, good for projects not designed with precompiled
13439 header files in mind, is to simply take most of the header files used by
13440 a project, include them from another header file, precompile that header
13441 file, and @option{-include} the precompiled header.  If the header files
13442 have guards against multiple inclusion, they will be skipped because
13443 they've already been included (in the precompiled header).
13445 If you need to precompile the same header file for different
13446 languages, targets, or compiler options, you can instead make a
13447 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13448 header in the directory, perhaps using @option{-o}.  It doesn't matter
13449 what you call the files in the directory, every precompiled header in
13450 the directory will be considered.  The first precompiled header
13451 encountered in the directory that is valid for this compilation will
13452 be used; they're searched in no particular order.
13454 There are many other possibilities, limited only by your imagination,
13455 good sense, and the constraints of your build system.
13457 A precompiled header file can be used only when these conditions apply:
13459 @itemize
13460 @item
13461 Only one precompiled header can be used in a particular compilation.
13463 @item
13464 A precompiled header can't be used once the first C token is seen.  You
13465 can have preprocessor directives before a precompiled header; you can
13466 even include a precompiled header from inside another header, so long as
13467 there are no C tokens before the @code{#include}.
13469 @item
13470 The precompiled header file must be produced for the same language as
13471 the current compilation.  You can't use a C precompiled header for a C++
13472 compilation.
13474 @item
13475 The precompiled header file must have been produced by the same compiler
13476 binary as the current compilation is using.
13478 @item
13479 Any macros defined before the precompiled header is included must
13480 either be defined in the same way as when the precompiled header was
13481 generated, or must not affect the precompiled header, which usually
13482 means that they don't appear in the precompiled header at all.
13484 The @option{-D} option is one way to define a macro before a
13485 precompiled header is included; using a @code{#define} can also do it.
13486 There are also some options that define macros implicitly, like
13487 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13488 defined this way.
13490 @item If debugging information is output when using the precompiled
13491 header, using @option{-g} or similar, the same kind of debugging information
13492 must have been output when building the precompiled header.  However,
13493 a precompiled header built using @option{-g} can be used in a compilation
13494 when no debugging information is being output.
13496 @item The same @option{-m} options must generally be used when building
13497 and using the precompiled header.  @xref{Submodel Options},
13498 for any cases where this rule is relaxed.
13500 @item Each of the following options must be the same when building and using
13501 the precompiled header:
13503 @gccoptlist{-fexceptions -funit-at-a-time}
13505 @item
13506 Some other command-line options starting with @option{-f},
13507 @option{-p}, or @option{-O} must be defined in the same way as when
13508 the precompiled header was generated.  At present, it's not clear
13509 which options are safe to change and which are not; the safest choice
13510 is to use exactly the same options when generating and using the
13511 precompiled header.  The following are known to be safe:
13513 @gccoptlist{-fmessage-length= -fpreprocessed
13514 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13515 -fsched-verbose=<number> -fschedule-insns -fvisibility=
13516 -pedantic-errors}
13518 @end itemize
13520 For all of these except the last, the compiler will automatically
13521 ignore the precompiled header if the conditions aren't met.  If you
13522 find an option combination that doesn't work and doesn't cause the
13523 precompiled header to be ignored, please consider filing a bug report,
13524 see @ref{Bugs}.
13526 If you do use differing options when generating and using the
13527 precompiled header, the actual behavior will be a mixture of the
13528 behavior for the options.  For instance, if you use @option{-g} to
13529 generate the precompiled header but not when using it, you may or may
13530 not get debugging information for routines in the precompiled header.
13532 @node Running Protoize
13533 @section Running Protoize
13535 The program @code{protoize} is an optional part of GCC@.  You can use
13536 it to add prototypes to a program, thus converting the program to ISO
13537 C in one respect.  The companion program @code{unprotoize} does the
13538 reverse: it removes argument types from any prototypes that are found.
13540 When you run these programs, you must specify a set of source files as
13541 command line arguments.  The conversion programs start out by compiling
13542 these files to see what functions they define.  The information gathered
13543 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13545 After scanning comes actual conversion.  The specified files are all
13546 eligible to be converted; any files they include (whether sources or
13547 just headers) are eligible as well.
13549 But not all the eligible files are converted.  By default,
13550 @code{protoize} and @code{unprotoize} convert only source and header
13551 files in the current directory.  You can specify additional directories
13552 whose files should be converted with the @option{-d @var{directory}}
13553 option.  You can also specify particular files to exclude with the
13554 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13555 directory name matches one of the specified directory names, and its
13556 name within the directory has not been excluded.
13558 Basic conversion with @code{protoize} consists of rewriting most
13559 function definitions and function declarations to specify the types of
13560 the arguments.  The only ones not rewritten are those for varargs
13561 functions.
13563 @code{protoize} optionally inserts prototype declarations at the
13564 beginning of the source file, to make them available for any calls that
13565 precede the function's definition.  Or it can insert prototype
13566 declarations with block scope in the blocks where undeclared functions
13567 are called.
13569 Basic conversion with @code{unprotoize} consists of rewriting most
13570 function declarations to remove any argument types, and rewriting
13571 function definitions to the old-style pre-ISO form.
13573 Both conversion programs print a warning for any function declaration or
13574 definition that they can't convert.  You can suppress these warnings
13575 with @option{-q}.
13577 The output from @code{protoize} or @code{unprotoize} replaces the
13578 original source file.  The original file is renamed to a name ending
13579 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13580 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13581 for DOS) file already exists, then the source file is simply discarded.
13583 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13584 scan the program and collect information about the functions it uses.
13585 So neither of these programs will work until GCC is installed.
13587 Here is a table of the options you can use with @code{protoize} and
13588 @code{unprotoize}.  Each option works with both programs unless
13589 otherwise stated.
13591 @table @code
13592 @item -B @var{directory}
13593 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13594 usual directory (normally @file{/usr/local/lib}).  This file contains
13595 prototype information about standard system functions.  This option
13596 applies only to @code{protoize}.
13598 @item -c @var{compilation-options}
13599 Use @var{compilation-options} as the options when running @command{gcc} to
13600 produce the @samp{.X} files.  The special option @option{-aux-info} is
13601 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13603 Note that the compilation options must be given as a single argument to
13604 @code{protoize} or @code{unprotoize}.  If you want to specify several
13605 @command{gcc} options, you must quote the entire set of compilation options
13606 to make them a single word in the shell.
13608 There are certain @command{gcc} arguments that you cannot use, because they
13609 would produce the wrong kind of output.  These include @option{-g},
13610 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13611 the @var{compilation-options}, they are ignored.
13613 @item -C
13614 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13615 systems) instead of @samp{.c}.  This is convenient if you are converting
13616 a C program to C++.  This option applies only to @code{protoize}.
13618 @item -g
13619 Add explicit global declarations.  This means inserting explicit
13620 declarations at the beginning of each source file for each function
13621 that is called in the file and was not declared.  These declarations
13622 precede the first function definition that contains a call to an
13623 undeclared function.  This option applies only to @code{protoize}.
13625 @item -i @var{string}
13626 Indent old-style parameter declarations with the string @var{string}.
13627 This option applies only to @code{protoize}.
13629 @code{unprotoize} converts prototyped function definitions to old-style
13630 function definitions, where the arguments are declared between the
13631 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13632 uses five spaces as the indentation.  If you want to indent with just
13633 one space instead, use @option{-i " "}.
13635 @item -k
13636 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13637 is finished.
13639 @item -l
13640 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13641 a prototype declaration for each function in each block which calls the
13642 function without any declaration.  This option applies only to
13643 @code{protoize}.
13645 @item -n
13646 Make no real changes.  This mode just prints information about the conversions
13647 that would have been done without @option{-n}.
13649 @item -N
13650 Make no @samp{.save} files.  The original files are simply deleted.
13651 Use this option with caution.
13653 @item -p @var{program}
13654 Use the program @var{program} as the compiler.  Normally, the name
13655 @file{gcc} is used.
13657 @item -q
13658 Work quietly.  Most warnings are suppressed.
13660 @item -v
13661 Print the version number, just like @option{-v} for @command{gcc}.
13662 @end table
13664 If you need special compiler options to compile one of your program's
13665 source files, then you should generate that file's @samp{.X} file
13666 specially, by running @command{gcc} on that source file with the
13667 appropriate options and the option @option{-aux-info}.  Then run
13668 @code{protoize} on the entire set of files.  @code{protoize} will use
13669 the existing @samp{.X} file because it is newer than the source file.
13670 For example:
13672 @smallexample
13673 gcc -Dfoo=bar file1.c -aux-info file1.X
13674 protoize *.c
13675 @end smallexample
13677 @noindent
13678 You need to include the special files along with the rest in the
13679 @code{protoize} command, even though their @samp{.X} files already
13680 exist, because otherwise they won't get converted.
13682 @xref{Protoize Caveats}, for more information on how to use
13683 @code{protoize} successfully.